class DB extends Facade

Properties

static protected $app

The application instance being facaded.

from  Facade
static protected array $resolvedInstance

The resolved object instances.

from  Facade
static protected bool $cached

Indicates if the resolved instance should be cached.

from  Facade

Methods

static void
resolved(Closure $callback)

Run a Closure when the facade has been resolved.

from  Facade
static 
spy()

Convert the facade into a Mockery spy.

from  Facade
static 
partialMock()

Initiate a partial mock on the facade.

from  Facade
static 
shouldReceive()

Initiate a mock expectation on the facade.

from  Facade
static 
expects()

Initiate a mock expectation on the facade.

from  Facade
static 
createFreshMockInstance()

Create a fresh mock instance for the given class.

from  Facade
static 
createMock()

Create a fresh mock instance for the given class.

from  Facade
static bool
isMock()

Determines whether a mock is set as the instance of the facade.

from  Facade
static string|null
getMockableClass()

Get the mockable class for the bound instance.

from  Facade
static 
swap(mixed $instance)

Hotswap the underlying instance behind the facade.

from  Facade
static bool
isFake()

Determines whether a "fake" has been set as the facade instance.

from  Facade
static mixed
getFacadeRoot()

Get the root object behind the facade.

from  Facade
static string
getFacadeAccessor()

Get the registered name of the component.

static mixed
resolveFacadeInstance(string $name)

Resolve the facade root instance from the container.

from  Facade
static void
clearResolvedInstance(string|null $name = null)

Clear a resolved facade instance.

from  Facade
static void
clearResolvedInstances()

Clear all of the resolved instances.

from  Facade
static Collection
defaultAliases()

Get the application default aliases.

from  Facade
static 
getFacadeApplication()

Get the application instance behind the facade.

from  Facade
static void
setFacadeApplication(mixed $app)

Set the application instance.

from  Facade
static 
__callStatic(string $method, array $args)

Handle dynamic, static calls to the object.

from  Facade
static void
prohibitDestructiveCommands(bool $prohibit = true)

Indicate that destructive Artisan commands should be prohibited.

connection(UnitEnum|string|null $name = 'null')

No description

build(array $config)

No description

connectUsing(string $name, array $config, bool $force = 'false')

No description

static void
purge(UnitEnum|string|null $name = 'null')

No description

static void
disconnect(UnitEnum|string|null $name = 'null')

No description

static Connection
reconnect(UnitEnum|string|null $name = 'null')

No description

static mixed
usingConnection(UnitEnum|string $name, callable $callback)

No description

static string|null
getDefaultConnection()

No description

static void
setDefaultConnection(string|null $name)

No description

static string[]
supportedDrivers()

No description

static string[]
availableDrivers()

No description

static void
extend(string $name, callable $resolver)

No description

static void
forgetExtension(string $name)

No description

static void
array()

<string, \Hypervel\Database\Connection> getConnections()

static void
purgeConnections()

No description

static void
setReconnector(callable $reconnector)

No description

static DatabaseManager
setApplication(Application $app)

No description

static void
macro(string $name, callable|object $macro)

No description

static void
mixin(object $mixin, bool $replace = 'true')

No description

static bool
hasMacro(string $name)

No description

static void
flushMacros()

No description

static mixed
macroCall(string $method, array $parameters)

No description

static void
useDefaultQueryGrammar()

No description

static void
useDefaultSchemaGrammar()

No description

static void
useDefaultPostProcessor()

No description

static Builder
getSchemaBuilder()

No description

static SchemaState
getSchemaState(Filesystem|null $files = 'null', callable|null $processFactory = 'null')

No description

static Builder
table(UnitEnum|string $table, string|null $as = 'null')

No description

static Builder
query()

No description

static mixed
selectOne(string $query, array $bindings = '[]', bool $useReadPdo = 'true')

No description

static mixed
scalar(string $query, array $bindings = '[]', bool $useReadPdo = 'true')

No description

static array
selectFromWriteConnection(string $query, array $bindings = '[]')

No description

static array
select(string $query, array $bindings = '[]', bool $useReadPdo = 'true', array $fetchUsing = '[]')

No description

static array
selectResultSets(string $query, array $bindings = '[]', bool $useReadPdo = 'true')

No description

void
static()

\Generator<int, \stdClass> cursor(string $query, array $bindings = '[]', bool $useReadPdo = 'true', array $fetchUsing = '[]')

static bool
insert(string $query, array $bindings = '[]')

No description

static int
update(string $query, array $bindings = '[]')

No description

static int
delete(string $query, array $bindings = '[]')

No description

static bool
statement(string $query, array $bindings = '[]')

No description

static int
affectingStatement(string $query, array $bindings = '[]')

No description

static bool
unprepared(string $query)

No description

static int|null
threadCount()

No description

static array[]
pretend(Closure $callback)

No description

static mixed
withoutPretending(Closure $callback)

No description

static void
bindValues(PDOStatement $statement, array $bindings)

No description

static array
prepareBindings(array $bindings)

No description

static void
logQuery(string $query, array $bindings, float|null $time = 'null')

No description

static void
whenQueryingForLongerThan(CarbonInterval|int|float $threshold, callable $handler)

No description

static void
static float
totalQueryDuration()

No description

static void
resetTotalQueryDuration()

No description

static void
reconnectIfMissingConnection()

No description

static Connection
beforeStartingTransaction(Closure $callback)

No description

static Connection
beforeExecuting(Closure $callback)

No description

static void
static void
resetForPool()

No description

static int
getErrorCount()

No description

static void
listen(Closure $callback)

No description

static Expression
raw(mixed $value)

No description

static string
escape(mixed $value, bool $binary = 'false')

No description

static bool
hasModifiedRecords()

No description

static void
recordsHaveBeenModified(bool $value = 'true')

No description

static Connection
setRecordModificationState(bool $value)

No description

static void
static Connection
useWriteConnectionWhenReading(bool $value = 'true')

No description

static PDO
getPdo()

No description

static Closure|null
getRawPdo()

No description

static PDO
getReadPdo()

No description

static Closure|null
getRawReadPdo()

No description

static Connection
setPdo(Closure|null $pdo)

No description

static Connection
setReadPdo(Closure|null $pdo)

No description

static Connection
setReadPdoConfig(array $config)

No description

static string|null
getName()

No description

static mixed
getConfig(string|null $option = 'null')

No description

static string
getDriverName()

No description

static string
getDriverTitle()

No description

static Grammar
getQueryGrammar()

No description

static Connection
setQueryGrammar(Grammar $grammar)

No description

static Grammar|null
getSchemaGrammar()

No description

static Connection
setSchemaGrammar(Grammar $grammar)

No description

static Processor
getPostProcessor()

No description

static Connection
setPostProcessor(Processor $processor)

No description

static Dispatcher|null
getEventDispatcher()

No description

static Connection
setEventDispatcher(Dispatcher $events)

No description

static void
unsetEventDispatcher()

No description

static DatabaseTransactionsManager|null
getTransactionManager()

No description

static void
unsetTransactionManager()

No description

static bool
pretending()

No description

static array[]
getQueryLog()

No description

static array
getRawQueryLog()

No description

static void
flushQueryLog()

No description

static void
enableQueryLog()

No description

static void
disableQueryLog()

No description

static bool
logging()

No description

static string
getDatabaseName()

No description

static Connection
setDatabaseName(string $database)

No description

static string
getTablePrefix()

No description

static Connection
setTablePrefix(string $prefix)

No description

static mixed
withoutTablePrefix(Closure $callback)

No description

static string
getServerVersion()

No description

static void
resolverFor(string $driver, Closure $callback)

No description

static Closure|null
getResolver(string $driver)

No description

static mixed
transaction(Closure $callback, int $attempts = '1')

No description

static void
beginTransaction()

No description

static void
commit()

No description

static void
rollBack(int|null $toLevel = 'null')

No description

static int
transactionLevel()

No description

static void
afterCommit(callable $callback)

No description

static void
afterRollBack(callable $callback)

No description

Details

in Facade at line 55
static void resolved(Closure $callback)

Run a Closure when the facade has been resolved.

Boot-only. The callback is registered on the worker-global container and runs for every subsequent resolution of the facade accessor.

Parameters

Closure $callback

Return Value

void

in Facade at line 71
static spy()

Convert the facade into a Mockery spy.

in Facade at line 89
static partialMock()

Initiate a partial mock on the facade.

Tests only. Swaps the resolved facade instance for the worker lifetime.

in Facade at line 105
static shouldReceive()

Initiate a mock expectation on the facade.

Tests only. Swaps the resolved facade instance for the worker lifetime.

in Facade at line 121
static expects()

Initiate a mock expectation on the facade.

Tests only. Swaps the resolved facade instance for the worker lifetime.

in Facade at line 135
static protected createFreshMockInstance()

Create a fresh mock instance for the given class.

in Facade at line 147
static protected createMock()

Create a fresh mock instance for the given class.

in Facade at line 157
static protected bool isMock()

Determines whether a mock is set as the instance of the facade.

Return Value

bool

in Facade at line 168
static protected string|null getMockableClass()

Get the mockable class for the bound instance.

Return Value

string|null

in Facade at line 184
static swap(mixed $instance)

Hotswap the underlying instance behind the facade.

Tests only. Replaces the worker-wide resolved facade instance and container binding; runtime use races across coroutines and changes every subsequent facade call.

Parameters

mixed $instance

in Facade at line 196
static bool isFake()

Determines whether a "fake" has been set as the facade instance.

Return Value

bool

in Facade at line 207
static mixed getFacadeRoot()

Get the root object behind the facade.

Return Value

mixed

at line 146
static protected string getFacadeAccessor()

Get the registered name of the component.

Return Value

string

in Facade at line 223
static protected mixed resolveFacadeInstance(string $name)

Resolve the facade root instance from the container.

Parameters

string $name

Return Value

mixed

in Facade at line 246
static void clearResolvedInstance(string|null $name = null)

Clear a resolved facade instance.

Boot or tests only. Clears a worker-wide facade cache entry; concurrent coroutines may still hold the previous resolved instance.

Parameters

string|null $name

Return Value

void

in Facade at line 257
static void clearResolvedInstances()

Clear all of the resolved instances.

Boot or tests only. Clears the worker-wide facade cache; concurrent coroutines may still hold previously resolved instances.

Return Value

void

in Facade at line 265
static Collection defaultAliases()

Get the application default aliases.

Return Value

Collection

in Facade at line 324
static getFacadeApplication()

Get the application instance behind the facade.

in Facade at line 337
static void setFacadeApplication(mixed $app)

Set the application instance.

Tests only. Replaces the worker-wide facade application reference; runtime use races across coroutines and breaks every facade lookup.

Parameters

mixed $app

Return Value

void

in Facade at line 347
static __callStatic(string $method, array $args)

Handle dynamic, static calls to the object.

Parameters

string $method
array $args

Exceptions

RuntimeException

at line 137
static void prohibitDestructiveCommands(bool $prohibit = true)

Indicate that destructive Artisan commands should be prohibited.

Prohibits: db:wipe, migrate:fresh, migrate:refresh, migrate:reset, and migrate:rollback

Boot-only. The prohibition flags persist in static command state for the worker lifetime and affect every subsequent destructive database command.

Parameters

bool $prohibit

Return Value

void

at line 127
static ConnectionInterface connection(UnitEnum|string|null $name = 'null')

No description

Parameters

UnitEnum|string|null $name

Return Value

ConnectionInterface

at line 127
static ConnectionInterface build(array $config)

No description

Parameters

array $config

Return Value

ConnectionInterface

at line 127
static ConnectionInterface connectUsing(string $name, array $config, bool $force = 'false')

No description

Parameters

string $name
array $config
bool $force

Return Value

ConnectionInterface

at line 127
static void purge(UnitEnum|string|null $name = 'null')

No description

Parameters

UnitEnum|string|null $name

Return Value

void

at line 127
static void disconnect(UnitEnum|string|null $name = 'null')

No description

Parameters

UnitEnum|string|null $name

Return Value

void

at line 127
static Connection reconnect(UnitEnum|string|null $name = 'null')

No description

Parameters

UnitEnum|string|null $name

Return Value

Connection

at line 127
static mixed usingConnection(UnitEnum|string $name, callable $callback)

No description

Parameters

UnitEnum|string $name
callable $callback

Return Value

mixed

at line 127
static string|null getDefaultConnection()

No description

Return Value

string|null

at line 127
static void setDefaultConnection(string|null $name)

No description

Parameters

string|null $name

Return Value

void

at line 127
static string[] supportedDrivers()

No description

Return Value

string[]

at line 127
static string[] availableDrivers()

No description

Return Value

string[]

at line 127
static void extend(string $name, callable $resolver)

No description

Parameters

string $name
callable $resolver

Return Value

void

at line 127
static void forgetExtension(string $name)

No description

Parameters

string $name

Return Value

void

at line 127
static void array()

<string, \Hypervel\Database\Connection> getConnections()

Return Value

void

at line 127
static void purgeConnections()

No description

Return Value

void

at line 127
static void setReconnector(callable $reconnector)

No description

Parameters

callable $reconnector

Return Value

void

at line 127
static DatabaseManager setApplication(Application $app)

No description

Parameters

Application $app

Return Value

DatabaseManager

at line 127
static void macro(string $name, callable|object $macro)

No description

Parameters

string $name
callable|object $macro

Return Value

void

at line 127
static void mixin(object $mixin, bool $replace = 'true')

No description

Parameters

object $mixin
bool $replace

Return Value

void

at line 127
static bool hasMacro(string $name)

No description

Parameters

string $name

Return Value

bool

at line 127
static void flushMacros()

No description

Return Value

void

at line 127
static mixed macroCall(string $method, array $parameters)

No description

Parameters

string $method
array $parameters

Return Value

mixed

at line 127
static void useDefaultQueryGrammar()

No description

Return Value

void

at line 127
static void useDefaultSchemaGrammar()

No description

Return Value

void

at line 127
static void useDefaultPostProcessor()

No description

Return Value

void

at line 127
static Builder getSchemaBuilder()

No description

Return Value

Builder

at line 127
static SchemaState getSchemaState(Filesystem|null $files = 'null', callable|null $processFactory = 'null')

No description

Parameters

Filesystem|null $files
callable|null $processFactory

Return Value

SchemaState

at line 127
static Builder table(UnitEnum|string $table, string|null $as = 'null')

No description

Parameters

UnitEnum|string $table
string|null $as

Return Value

Builder

at line 127
static Builder query()

No description

Return Value

Builder

at line 127
static mixed selectOne(string $query, array $bindings = '[]', bool $useReadPdo = 'true')

No description

Parameters

string $query
array $bindings
bool $useReadPdo

Return Value

mixed

at line 127
static mixed scalar(string $query, array $bindings = '[]', bool $useReadPdo = 'true')

No description

Parameters

string $query
array $bindings
bool $useReadPdo

Return Value

mixed

at line 127
static array selectFromWriteConnection(string $query, array $bindings = '[]')

No description

Parameters

string $query
array $bindings

Return Value

array

at line 127
static array select(string $query, array $bindings = '[]', bool $useReadPdo = 'true', array $fetchUsing = '[]')

No description

Parameters

string $query
array $bindings
bool $useReadPdo
array $fetchUsing

Return Value

array

at line 127
static array selectResultSets(string $query, array $bindings = '[]', bool $useReadPdo = 'true')

No description

Parameters

string $query
array $bindings
bool $useReadPdo

Return Value

array

at line 127
void static()

\Generator<int, \stdClass> cursor(string $query, array $bindings = '[]', bool $useReadPdo = 'true', array $fetchUsing = '[]')

Return Value

void

at line 127
static bool insert(string $query, array $bindings = '[]')

No description

Parameters

string $query
array $bindings

Return Value

bool

at line 127
static int update(string $query, array $bindings = '[]')

No description

Parameters

string $query
array $bindings

Return Value

int

at line 127
static int delete(string $query, array $bindings = '[]')

No description

Parameters

string $query
array $bindings

Return Value

int

at line 127
static bool statement(string $query, array $bindings = '[]')

No description

Parameters

string $query
array $bindings

Return Value

bool

at line 127
static int affectingStatement(string $query, array $bindings = '[]')

No description

Parameters

string $query
array $bindings

Return Value

int

at line 127
static bool unprepared(string $query)

No description

Parameters

string $query

Return Value

bool

at line 127
static int|null threadCount()

No description

Return Value

int|null

at line 127
static array[] pretend(Closure $callback)

No description

Parameters

Closure $callback

Return Value

array[]

at line 127
static mixed withoutPretending(Closure $callback)

No description

Parameters

Closure $callback

Return Value

mixed

at line 127
static void bindValues(PDOStatement $statement, array $bindings)

No description

Parameters

PDOStatement $statement
array $bindings

Return Value

void

at line 127
static array prepareBindings(array $bindings)

No description

Parameters

array $bindings

Return Value

array

at line 127
static void logQuery(string $query, array $bindings, float|null $time = 'null')

No description

Parameters

string $query
array $bindings
float|null $time

Return Value

void

at line 127
static void whenQueryingForLongerThan(CarbonInterval|int|float $threshold, callable $handler)

No description

Parameters

CarbonInterval|int|float $threshold
callable $handler

Return Value

void

at line 127
static void allowQueryDurationHandlersToRunAgain()

No description

Return Value

void

at line 127
static float totalQueryDuration()

No description

Return Value

float

at line 127
static void resetTotalQueryDuration()

No description

Return Value

void

at line 127
static void reconnectIfMissingConnection()

No description

Return Value

void

at line 127
static Connection beforeStartingTransaction(Closure $callback)

No description

Parameters

Closure $callback

Return Value

Connection

at line 127
static Connection beforeExecuting(Closure $callback)

No description

Parameters

Closure $callback

Return Value

Connection

at line 127
static void clearBeforeExecutingCallbacks()

No description

Return Value

void

at line 127
static void resetForPool()

No description

Return Value

void

at line 127
static int getErrorCount()

No description

Return Value

int

at line 127
static void listen(Closure $callback)

No description

Parameters

Closure $callback

Return Value

void

at line 127
static Expression raw(mixed $value)

No description

Parameters

mixed $value

Return Value

Expression

at line 127
static string escape(mixed $value, bool $binary = 'false')

No description

Parameters

mixed $value
bool $binary

Return Value

string

at line 127
static bool hasModifiedRecords()

No description

Return Value

bool

at line 127
static void recordsHaveBeenModified(bool $value = 'true')

No description

Parameters

bool $value

Return Value

void

at line 127
static Connection setRecordModificationState(bool $value)

No description

Parameters

bool $value

Return Value

Connection

at line 127
static void forgetRecordModificationState()

No description

Return Value

void

at line 127
static Connection useWriteConnectionWhenReading(bool $value = 'true')

No description

Parameters

bool $value

Return Value

Connection

at line 127
static PDO getPdo()

No description

Return Value

PDO

at line 127
static Closure|null getRawPdo()

No description

Return Value

Closure|null

at line 127
static PDO getReadPdo()

No description

Return Value

PDO

at line 127
static Closure|null getRawReadPdo()

No description

Return Value

Closure|null

at line 127
static Connection setPdo(Closure|null $pdo)

No description

Parameters

Closure|null $pdo

Return Value

Connection

at line 127
static Connection setReadPdo(Closure|null $pdo)

No description

Parameters

Closure|null $pdo

Return Value

Connection

at line 127
static Connection setReadPdoConfig(array $config)

No description

Parameters

array $config

Return Value

Connection

at line 127
static string|null getName()

No description

Return Value

string|null

at line 127
static mixed getConfig(string|null $option = 'null')

No description

Parameters

string|null $option

Return Value

mixed

at line 127
static string getDriverName()

No description

Return Value

string

at line 127
static string getDriverTitle()

No description

Return Value

string

at line 127
static Grammar getQueryGrammar()

No description

Return Value

Grammar

at line 127
static Connection setQueryGrammar(Grammar $grammar)

No description

Parameters

Grammar $grammar

Return Value

Connection

at line 127
static Grammar|null getSchemaGrammar()

No description

Return Value

Grammar|null

at line 127
static Connection setSchemaGrammar(Grammar $grammar)

No description

Parameters

Grammar $grammar

Return Value

Connection

at line 127
static Processor getPostProcessor()

No description

Return Value

Processor

at line 127
static Connection setPostProcessor(Processor $processor)

No description

Parameters

Processor $processor

Return Value

Connection

at line 127
static Dispatcher|null getEventDispatcher()

No description

Return Value

Dispatcher|null

at line 127
static Connection setEventDispatcher(Dispatcher $events)

No description

Parameters

Dispatcher $events

Return Value

Connection

at line 127
static void unsetEventDispatcher()

No description

Return Value

void

at line 127
static Connection setTransactionManager(DatabaseTransactionsManager $manager)

No description

Parameters

DatabaseTransactionsManager $manager

Return Value

Connection

at line 127
static DatabaseTransactionsManager|null getTransactionManager()

No description

Return Value

DatabaseTransactionsManager|null

at line 127
static void unsetTransactionManager()

No description

Return Value

void

at line 127
static bool pretending()

No description

Return Value

bool

at line 127
static array[] getQueryLog()

No description

Return Value

array[]

at line 127
static array getRawQueryLog()

No description

Return Value

array

at line 127
static void flushQueryLog()

No description

Return Value

void

at line 127
static void enableQueryLog()

No description

Return Value

void

at line 127
static void disableQueryLog()

No description

Return Value

void

at line 127
static bool logging()

No description

Return Value

bool

at line 127
static string getDatabaseName()

No description

Return Value

string

at line 127
static Connection setDatabaseName(string $database)

No description

Parameters

string $database

Return Value

Connection

at line 127
static string getTablePrefix()

No description

Return Value

string

at line 127
static Connection setTablePrefix(string $prefix)

No description

Parameters

string $prefix

Return Value

Connection

at line 127
static mixed withoutTablePrefix(Closure $callback)

No description

Parameters

Closure $callback

Return Value

mixed

at line 127
static string getServerVersion()

No description

Return Value

string

at line 127
static void resolverFor(string $driver, Closure $callback)

No description

Parameters

string $driver
Closure $callback

Return Value

void

at line 127
static Closure|null getResolver(string $driver)

No description

Parameters

string $driver

Return Value

Closure|null

at line 127
static mixed transaction(Closure $callback, int $attempts = '1')

No description

Parameters

Closure $callback
int $attempts

Return Value

mixed

at line 127
static void beginTransaction()

No description

Return Value

void

at line 127
static void commit()

No description

Return Value

void

at line 127
static void rollBack(int|null $toLevel = 'null')

No description

Parameters

int|null $toLevel

Return Value

void

at line 127
static int transactionLevel()

No description

Return Value

int

at line 127
static void afterCommit(callable $callback)

No description

Parameters

callable $callback

Return Value

void

at line 127
static void afterRollBack(callable $callback)

No description

Parameters

callable $callback

Return Value

void