Manager

class Manager (View source)

Traits

CapsuleManagerTrait

Properties

static protected object $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.

 from CapsuleManagerTrait
void setAsGlobal()

Make this capsule instance available globally.

 from CapsuleManagerTrait
Container getContainer()

Get the IoC container instance.

 from CapsuleManagerTrait
void setContainer(Container $container)

Set the IoC container instance.

 from CapsuleManagerTrait
void __construct(Container $container = null)

Create a new database capsule manager.
void setupDefaultConfiguration()

Setup the default database configuration options.
void setupManager()

Build the database manager instance.
static Connection connection(string|null $connection = null)

Get a connection instance from the global manager.
static Builder table(Closure|Builder|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.
Connection 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.
$this setFetchMode(int $fetchMode)

Set the fetch mode for the database connections.
DatabaseManager 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.

Return Value

void

Container getContainer()

Get the IoC container instance.

Return Value

Container

void setContainer(Container $container)

Set the IoC container instance.

Parameters

Container $container

Return Value

void

void __construct(Container $container = null)

Create a new database capsule manager.

Parameters

Container $container

Return Value

void

protected void setupDefaultConfiguration()

Setup the default database configuration options.

Return Value

void

protected void setupManager()

Build the database manager instance.

Return Value

void

static Connection connection(string|null $connection = null)

Get a connection instance from the global manager.

Parameters

string|null $connection

Return Value

Connection

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

Get a fluent query builder instance.

Parameters

Closure|Builder|string $table
string|null $as
string|null $connection

Return Value

Builder

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

Get a schema builder instance.

Parameters

string|null $connection

Return Value

Builder

Connection getConnection(string|null $name = null)

Get a registered connection instance.

Parameters

string|null $name

Return Value

Connection

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

Register a connection with the manager.

Parameters

array $config
string $name

Return Value

void

void bootEloquent()

Bootstrap Eloquent so it is ready for usage.

Return Value

void

$this setFetchMode(int $fetchMode)

Set the fetch mode for the database connections.

Parameters

int $fetchMode

Return Value

$this

DatabaseManager getDatabaseManager()

Get the database manager instance.

Return Value

DatabaseManager

Dispatcher|null getEventDispatcher()

Get the current event dispatcher instance.

Return Value

Dispatcher|null

void setEventDispatcher(Dispatcher $dispatcher)

Set the event dispatcher instance to be used by connections.

Parameters

Dispatcher $dispatcher

Return Value

void

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

Dynamically pass methods to the default connection.

Parameters

string $method
array $parameters

Return Value

mixed

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/8.x/Illuminate/Database/Capsule/Manager.html