class Manager

Standalone database manager for non-production use outside full application bootstrap.

Uses SimpleConnectionResolver to retain non-pooled connections, including in-memory SQLite databases, without requiring full application bootstrap.

For production Swoole applications with connection pooling, use the full Hypervel application with ConnectionResolver instead.

Traits

Properties

static protected object|null $instance

The current globally used instance.

from  CapsuleManagerTrait
protected Container $container

The container instance.

from  CapsuleManagerTrait
protected DatabaseManager $manager

The database manager instance.

Methods

void
setupContainer(Container $container)

Setup the IoC container instance.

void
setAsGlobal()

Make this capsule instance available globally.

getContainer()

Get the IoC container instance.

void
setContainer(Container $container)

Set the IoC container instance.

static void
flushState()

Flush all static state.

__construct(Container|null $container = null)

Create a new database capsule manager.

void
setupDefaultConfiguration()

Setup the default database configuration options.

void
setupManager()

Build the database manager instance.

connection(string|null $connection = null)

Get a connection instance from the global manager.

static Builder
table(Closure|Builder|Builder|Relation|Expression|UnitEnum|string $table, string|null $as = null, string|null $connection = null)

Get a fluent query builder instance.

static Builder
schema(string|null $connection = null)

Get a schema builder instance.

getConnection(string|null $name = null)

Get a registered connection instance.

void
addConnection(array $config, string $name = 'default')

Register a connection with the manager.

void
bootEloquent()

Bootstrap Eloquent so it is ready for usage.

getDatabaseManager()

Get the database manager instance.

Dispatcher|null
getEventDispatcher()

Get the current event dispatcher instance.

void
setEventDispatcher(Dispatcher $dispatcher)

Set the event dispatcher instance to be used by connections.

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

Dynamically pass methods to the default connection.

Details

protected void setupContainer(Container $container)

Setup the IoC container instance.

Parameters

Container $container

Return Value

void

void setAsGlobal()

Make this capsule instance available globally.

Boot or tests only. Swaps the global Capsule instance used by static calls; request-time use races across coroutines.

Return Value

void

Container getContainer()

Get the IoC container instance.

Return Value

Container

void setContainer(Container $container)

Set the IoC container instance.

Boot or tests only. Swaps the Capsule container used by this standalone manager; request-time use races across coroutines.

Parameters

Container $container

Return Value

void

static void flushState()

Flush all static state.

Return Value

void

at line 45
__construct(Container|null $container = null)

Create a new database capsule manager.

Parameters

Container|null $container

at line 60
protected void setupDefaultConfiguration()

Setup the default database configuration options.

Return Value

void

at line 70
protected void setupManager()

Build the database manager instance.

Return Value

void

at line 88
static ConnectionInterface connection(string|null $connection = null)

Get a connection instance from the global manager.

Parameters

string|null $connection

Return Value

ConnectionInterface

at line 96
static Builder table(Closure|Builder|Builder|Relation|Expression|UnitEnum|string $table, string|null $as = null, string|null $connection = null)

Get a fluent query builder instance.

Parameters

Closure|Builder|Builder|Relation|Expression|UnitEnum|string $table
string|null $as
string|null $connection

Return Value

Builder

at line 104
static Builder schema(string|null $connection = null)

Get a schema builder instance.

Parameters

string|null $connection

Return Value

Builder

at line 112
ConnectionInterface getConnection(string|null $name = null)

Get a registered connection instance.

Parameters

string|null $name

Return Value

ConnectionInterface

at line 120
void addConnection(array $config, string $name = 'default')

Register a connection with the manager.

Parameters

array $config
string $name

Return Value

void

at line 133
void bootEloquent()

Bootstrap Eloquent so it is ready for usage.

Return Value

void

at line 151
DatabaseManager getDatabaseManager()

Get the database manager instance.

Return Value

DatabaseManager

at line 159
Dispatcher|null getEventDispatcher()

Get the current event dispatcher instance.

Return Value

Dispatcher|null

at line 171
void setEventDispatcher(Dispatcher $dispatcher)

Set the event dispatcher instance to be used by connections.

Parameters

Dispatcher $dispatcher

Return Value

void

at line 179
static mixed __callStatic(string $method, array $parameters)

Dynamically pass methods to the default connection.

Parameters

string $method
array $parameters

Return Value

mixed