SessionManager
extends Manager
in package
Table of Contents
- $app : Application
- The application instance.
- $customCreators : array<string|int, mixed>
- The registered custom driver creators.
- $drivers : array<string|int, mixed>
- The array of created "drivers".
- __call() : mixed
- Dynamically call the default driver instance.
- __construct() : void
- Create a new manager instance.
- driver() : mixed
- Get a driver instance.
- extend() : $this
- Register a custom driver creator Closure.
- getDefaultDriver() : string
- Get the default session driver name.
- getDrivers() : array<string|int, mixed>
- Get all of the created "drivers".
- getSessionConfig() : array<string|int, mixed>
- Get the session configuration.
- setDefaultDriver() : void
- Set the default session driver name.
- buildEncryptedSession() : EncryptedStore
- Build the encrypted session instance.
- buildSession() : Store
- Build the session instance.
- callCustomCreator() : mixed
- Call a custom driver creator.
- createApcDriver() : Store
- Create an instance of the APC session driver.
- createArrayDriver() : Store
- Create an instance of the "array" session driver.
- createCacheBased() : Store
- Create an instance of a cache driven driver.
- createCacheHandler() : CacheBasedSessionHandler
- Create the cache based session handler instance.
- createCookieDriver() : Store
- Create an instance of the "cookie" session driver.
- createDatabaseDriver() : Store
- Create an instance of the database session driver.
- createDriver() : mixed
- Create a new driver instance.
- createFileDriver() : Store
- Create an instance of the file session driver.
- createMemcachedDriver() : Store
- Create an instance of the Memcached session driver.
- createNativeDriver() : Store
- Create an instance of the file session driver.
- createRedisDriver() : Store
- Create an instance of the Redis session driver.
- getDatabaseConnection() : Connection
- Get the database connection for the database driver.
Properties
$app
The application instance.
protected
Application
$app
$customCreators
The registered custom driver creators.
protected
array<string|int, mixed>
$customCreators
= []
$drivers
The array of created "drivers".
protected
array<string|int, mixed>
$drivers
= []
Methods
__call()
Dynamically call the default driver instance.
public
__call(string $method, array<string|int, mixed> $parameters) : mixed
Parameters
- $method : string
- $parameters : array<string|int, mixed>
Return values
mixed —__construct()
Create a new manager instance.
public
__construct(Application $app) : void
Parameters
- $app : Application
Return values
void —driver()
Get a driver instance.
public
driver([string $driver = null ]) : mixed
Parameters
- $driver : string = null
Return values
mixed —extend()
Register a custom driver creator Closure.
public
extend(string $driver, Closure $callback) : $this
Parameters
- $driver : string
- $callback : Closure
Return values
$this —getDefaultDriver()
Get the default session driver name.
public
getDefaultDriver() : string
Return values
string —getDrivers()
Get all of the created "drivers".
public
getDrivers() : array<string|int, mixed>
Return values
array<string|int, mixed> —getSessionConfig()
Get the session configuration.
public
getSessionConfig() : array<string|int, mixed>
Return values
array<string|int, mixed> —setDefaultDriver()
Set the default session driver name.
public
setDefaultDriver(string $name) : void
Parameters
- $name : string
Return values
void —buildEncryptedSession()
Build the encrypted session instance.
protected
buildEncryptedSession(SessionHandlerInterface $handler) : EncryptedStore
Parameters
- $handler : SessionHandlerInterface
Return values
EncryptedStore —buildSession()
Build the session instance.
protected
buildSession(SessionHandlerInterface $handler) : Store
Parameters
- $handler : SessionHandlerInterface
Return values
Store —callCustomCreator()
Call a custom driver creator.
protected
callCustomCreator(string $driver) : mixed
Parameters
- $driver : string
Return values
mixed —createApcDriver()
Create an instance of the APC session driver.
protected
createApcDriver() : Store
Return values
Store —createArrayDriver()
Create an instance of the "array" session driver.
protected
createArrayDriver() : Store
Return values
Store —createCacheBased()
Create an instance of a cache driven driver.
protected
createCacheBased(string $driver) : Store
Parameters
- $driver : string
Return values
Store —createCacheHandler()
Create the cache based session handler instance.
protected
createCacheHandler(string $driver) : CacheBasedSessionHandler
Parameters
- $driver : string
Return values
CacheBasedSessionHandler —createCookieDriver()
Create an instance of the "cookie" session driver.
protected
createCookieDriver() : Store
Return values
Store —createDatabaseDriver()
Create an instance of the database session driver.
protected
createDatabaseDriver() : Store
Return values
Store —createDriver()
Create a new driver instance.
protected
createDriver(string $driver) : mixed
Parameters
- $driver : string
Tags
Return values
mixed —createFileDriver()
Create an instance of the file session driver.
protected
createFileDriver() : Store
Return values
Store —createMemcachedDriver()
Create an instance of the Memcached session driver.
protected
createMemcachedDriver() : Store
Return values
Store —createNativeDriver()
Create an instance of the file session driver.
protected
createNativeDriver() : Store
Return values
Store —createRedisDriver()
Create an instance of the Redis session driver.
protected
createRedisDriver() : Store
Return values
Store —getDatabaseConnection()
Get the database connection for the database driver.
protected
getDatabaseConnection() : Connection