class SessionManager extends Manager (View source)

Properties

protected Container $container The container instance. from  Manager
protected Container $app The container instance. from  Manager
protected Repository $config The configuration repository instance. from  Manager
protected array $customCreators The registered custom driver creators. from  Manager
protected array $drivers The array of created "drivers". from  Manager

Methods

void
__construct(Container $container)

Create a new manager instance.

from  Manager
string
getDefaultDriver()

Get the default session driver name.

mixed
driver(string|null $driver = null)

Get a driver instance.

from  Manager
mixed
createDriver(string $driver)

Create a new driver instance.

from  Manager
mixed
callCustomCreator(string $driver)

Call a custom driver creator.

$this
extend(string $driver, Closure $callback)

Register a custom driver creator Closure.

from  Manager
array
getDrivers()

Get all of the created "drivers".

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

Dynamically call the default driver instance.

from  Manager
createNullDriver()

Create an instance of the "null" session driver.

createArrayDriver()

Create an instance of the "array" session driver.

createCookieDriver()

Create an instance of the "cookie" session driver.

createFileDriver()

Create an instance of the file session driver.

createNativeDriver()

Create an instance of the file session driver.

createDatabaseDriver()

Create an instance of the database session driver.

getDatabaseConnection()

Get the database connection for the database driver.

createApcDriver()

Create an instance of the APC session driver.

createMemcachedDriver()

Create an instance of the Memcached session driver.

createRedisDriver()

Create an instance of the Redis session driver.

createDynamodbDriver()

Create an instance of the DynamoDB session driver.

createCacheBased(string $driver)

Create an instance of a cache driven driver.

createCacheHandler(string $driver)

Create the cache based session handler instance.

buildSession(SessionHandlerInterface $handler)

Build the session instance.

buildEncryptedSession(SessionHandlerInterface $handler)

Build the encrypted session instance.

bool
shouldBlock()

Determine if requests for the same session should wait for each to finish before executing.

string|null
blockDriver()

Get the name of the cache store / driver that should be used to acquire session locks.

array
getSessionConfig()

Get the session configuration.

void
setDefaultDriver(string $name)

Set the default session driver name.

Details

void __construct(Container $container)

Create a new manager instance.

Parameters

Container $container

Return Value

void

string getDefaultDriver()

Get the default session driver name.

Return Value

string

mixed driver(string|null $driver = null)

Get a driver instance.

Parameters

string|null $driver

Return Value

mixed

Exceptions

InvalidArgumentException

protected mixed createDriver(string $driver)

Create a new driver instance.

Parameters

string $driver

Return Value

mixed

Exceptions

InvalidArgumentException

protected mixed callCustomCreator(string $driver)

Call a custom driver creator.

Parameters

string $driver

Return Value

mixed

$this extend(string $driver, Closure $callback)

Register a custom driver creator Closure.

Parameters

string $driver
Closure $callback

Return Value

$this

array getDrivers()

Get all of the created "drivers".

Return Value

array

mixed __call(string $method, array $parameters)

Dynamically call the default driver instance.

Parameters

string $method
array $parameters

Return Value

mixed

protected Store createNullDriver()

Create an instance of the "null" session driver.

Return Value

Store

protected Store createArrayDriver()

Create an instance of the "array" session driver.

Return Value

Store

protected Store createCookieDriver()

Create an instance of the "cookie" session driver.

Return Value

Store

protected Store createFileDriver()

Create an instance of the file session driver.

Return Value

Store

protected Store createNativeDriver()

Create an instance of the file session driver.

Return Value

Store

protected Store createDatabaseDriver()

Create an instance of the database session driver.

Return Value

Store

protected Connection getDatabaseConnection()

Get the database connection for the database driver.

Return Value

Connection

protected Store createApcDriver()

Create an instance of the APC session driver.

Return Value

Store

protected Store createMemcachedDriver()

Create an instance of the Memcached session driver.

Return Value

Store

protected Store createRedisDriver()

Create an instance of the Redis session driver.

Return Value

Store

protected Store createDynamodbDriver()

Create an instance of the DynamoDB session driver.

Return Value

Store

protected Store createCacheBased(string $driver)

Create an instance of a cache driven driver.

Parameters

string $driver

Return Value

Store

protected CacheBasedSessionHandler createCacheHandler(string $driver)

Create the cache based session handler instance.

Parameters

string $driver

Return Value

CacheBasedSessionHandler

protected Store buildSession(SessionHandlerInterface $handler)

Build the session instance.

Parameters

SessionHandlerInterface $handler

Return Value

Store

protected EncryptedStore buildEncryptedSession(SessionHandlerInterface $handler)

Build the encrypted session instance.

Parameters

SessionHandlerInterface $handler

Return Value

EncryptedStore

bool shouldBlock()

Determine if requests for the same session should wait for each to finish before executing.

Return Value

bool

string|null blockDriver()

Get the name of the cache store / driver that should be used to acquire session locks.

Return Value

string|null

array getSessionConfig()

Get the session configuration.

Return Value

array

void setDefaultDriver(string $name)

Set the default session driver name.

Parameters

string $name

Return Value

void