1. class
  2. Illuminate
  3. \
  4. Concurrency
  5. \
  6. ConcurrencyManager

ConcurrencyManager

class ConcurrencyManager extends MultipleInstanceManager mixin Driver (View source)

Properties

protected Application $app

The application instance.

 from  MultipleInstanceManager
protected Repository $config

The configuration repository instance.

 from  MultipleInstanceManager
protected array $instances

The array of resolved instances.

 from  MultipleInstanceManager
protected array $customCreators

The registered custom instance creators.

 from  MultipleInstanceManager
protected string $driverKey

The key name of the "driver" equivalent configuration option.

 from  MultipleInstanceManager

Methods

__construct(Application $app)

Create a new manager instance.

from  MultipleInstanceManager
string
getDefaultInstance()

Get the default instance name.

void
setDefaultInstance(string $name)

Set the default instance name.

array
getInstanceConfig(string $name)

Get the instance specific configuration.

mixed
instance(string|null $name = null)

Get an instance by name.

from  MultipleInstanceManager
mixed
get(string $name)

Attempt to get an instance from the local cache.

from  MultipleInstanceManager
mixed
resolve(string $name)

Resolve the given instance.

from  MultipleInstanceManager
mixed
callCustomCreator(array $config)

Call a custom instance creator.

from  MultipleInstanceManager
$this
forgetInstance(array|string|null $name = null)

Unset the given instances.

from  MultipleInstanceManager
void
purge(string|null $name = null)

Disconnect the given instance and remove from local cache.

from  MultipleInstanceManager
$this
extend(string $name, Closure $callback)

Register a custom instance creator Closure.

from  MultipleInstanceManager
$this
setApplication(Application $app)

Set the application instance used by the manager.

from  MultipleInstanceManager
mixed
__call(string $method, array $parameters)

Dynamically call the default instance.

from  MultipleInstanceManager
mixed
driver(string|null $name = null)

Get a driver instance by name.

ProcessDriver
createProcessDriver(array $config)

Create an instance of the process concurrency driver.

ForkDriver
createForkDriver(array $config)

Create an instance of the fork concurrency driver.

SyncDriver
createSyncDriver(array $config)

Create an instance of the sync concurrency driver.

Details

in MultipleInstanceManager at line 51
__construct(Application $app)

Create a new manager instance.

Parameters

Application $app

at line 74
string getDefaultInstance()

Get the default instance name.

Return Value

string

at line 87
void setDefaultInstance(string $name)

Set the default instance name.

Parameters

string $name

Return Value

void

at line 99
array getInstanceConfig(string $name)

Get the instance specific configuration.

Parameters

string $name

Return Value

array

in MultipleInstanceManager at line 86
mixed instance(string|null $name = null)

Get an instance by name.

Parameters

string|null $name

Return Value

mixed

in MultipleInstanceManager at line 99
protected mixed get(string $name)

Attempt to get an instance from the local cache.

Parameters

string $name

Return Value

mixed

in MultipleInstanceManager at line 113
protected mixed resolve(string $name)

Resolve the given instance.

Parameters

string $name

Return Value

mixed

Exceptions

InvalidArgumentException
RuntimeException

in MultipleInstanceManager at line 152
protected mixed callCustomCreator(array $config)

Call a custom instance creator.

Parameters

array $config

Return Value

mixed

in MultipleInstanceManager at line 163
$this forgetInstance(array|string|null $name = null)

Unset the given instances.

Parameters

array|string|null $name

Return Value

$this

in MultipleInstanceManager at line 182
void purge(string|null $name = null)

Disconnect the given instance and remove from local cache.

Parameters

string|null $name

Return Value

void

in MultipleInstanceManager at line 199
$this extend(string $name, Closure $callback)

Register a custom instance creator Closure.

Parameters

string $name
Closure $callback

Return Value

$this

in MultipleInstanceManager at line 212
$this setApplication(Application $app)

Set the application instance used by the manager.

Parameters

Application $app

Return Value

$this

in MultipleInstanceManager at line 226
mixed __call(string $method, array $parameters)

Dynamically call the default instance.

Parameters

string $method
array $parameters

Return Value

mixed

at line 21
mixed driver(string|null $name = null)

Get a driver instance by name.

Parameters

string|null $name

Return Value

mixed

at line 32
ProcessDriver createProcessDriver(array $config)

Create an instance of the process concurrency driver.

Parameters

array $config

Return Value

ProcessDriver

at line 45
ForkDriver createForkDriver(array $config)

Create an instance of the fork concurrency driver.

Parameters

array $config

Return Value

ForkDriver

Exceptions

RuntimeException

at line 64
SyncDriver createSyncDriver(array $config)

Create an instance of the sync concurrency driver.

Parameters

array $config

Return Value

SyncDriver