1. class
  2. Hypervel
  3. \
  4. Session
  5. \
  6. SessionManager

SessionManager

class SessionManager extends Manager mixin Store

Traits

RebindsCallbacksToSelf

Properties

protected Repository $config

The configuration repository instance.

 from  Manager
protected Closure> $customCreators

The registered custom driver creators.

 from  Manager
protected array<array-key, mixed> $drivers

The array of created "drivers".

 from  Manager

Methods

Closure|null
bindCallbackToSelf(Closure $callback)

Bind the provided callback to the class instance.

from  RebindsCallbacksToSelf
__construct(Container $container)

Create a new manager instance.

from  Manager
string|null
getDefaultDriver()

Get the default session driver name.

mixed
driver(UnitEnum|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.

Manager
extend(string $driver, Closure $callback)

Register a custom driver creator Closure.

from  Manager
array
getDrivers()

Get all of the created "drivers".

from  Manager
Container
getContainer()

Get the container instance used by the manager.

from  Manager
Manager
setContainer(Container $container)

Set the container instance used by the manager.

from  Manager
Manager
forgetDrivers()

Forget all of the resolved driver instances.

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

Dynamically call the default driver instance.

from  Manager
Store
createNullDriver()

Create an instance of the "null" session driver.

Store
createArrayDriver()

Create an instance of the "array" session driver.

Store
createCookieDriver()

Create an instance of the "cookie" session driver.

Store
createFileDriver()

Create an instance of the file session driver.

Store
createNativeDriver()

Create an instance of the file session driver.

Store
createDatabaseDriver()

Create an instance of the database session driver.

Store
createRedisDriver()

Create an instance of the Redis session driver.

Store
buildSession(SessionHandlerInterface $handler)

Build the session instance.

EncryptedStore
buildEncryptedSession(SessionHandlerInterface $handler)

Build the encrypted session instance.

bool
supportsUserSessionManagement()

Determine if the configured driver supports user session management.

UserSessions
forUser(Authenticatable|int|string $user, UnitEnum|string|null $guard = null)

Get a user-scoped session repository.

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.

int
defaultRouteBlockLockSeconds()

Get the maximum number of seconds the session lock should be held for.

int
defaultRouteBlockWaitSeconds()

Get the maximum number of seconds to wait while attempting to acquire a route block session lock.

array
getSessionConfig()

Get the session configuration.

void
setDefaultDriver(UnitEnum|string $name)

Set the default session driver name.

Details

in RebindsCallbacksToSelf at line 18
protected Closure|null bindCallbackToSelf(Closure $callback)

Bind the provided callback to the class instance.

Parameters

Closure $callback

Return Value

Closure|null

Exceptions

ReflectionException

in Manager at line 41
__construct(Container $container)

Create a new manager instance.

Parameters

Container $container

at line 283
string|null getDefaultDriver()

Get the default session driver name.

Return Value

string|null

in Manager at line 57
mixed driver(UnitEnum|string|null $driver = null)

Get a driver instance.

Parameters

UnitEnum|string|null $driver

Return Value

mixed

Exceptions

InvalidArgumentException

in Manager at line 89
protected mixed createDriver(string $driver)

Create a new driver instance.

Parameters

string $driver

Return Value

mixed

Exceptions

InvalidArgumentException

at line 28
protected mixed callCustomCreator(string $driver)

Call a custom driver creator.

Parameters

string $driver

Return Value

mixed

in Manager at line 126
Manager extend(string $driver, Closure $callback)

Register a custom driver creator Closure.

Anonymous closures run in this manager's class scope; non-static closures also receive the manager as $this.

Boot-only. The callback persists in the singleton's customCreators array for the worker lifetime and applies to every subsequent driver resolution.

Parameters

string $driver
Closure $callback

Return Value

Manager

in Manager at line 145
array getDrivers()

Get all of the created "drivers".

Return Value

array

in Manager at line 153
Container getContainer()

Get the container instance used by the manager.

Return Value

Container

in Manager at line 167
Manager setContainer(Container $container)

Set the container instance used by the manager.

Tests only. Swaps the singleton's container and configuration references; per-request use races across coroutines and breaks every concurrent driver resolution through this manager.

Parameters

Container $container

Return Value

Manager

in Manager at line 184
Manager forgetDrivers()

Forget all of the resolved driver instances.

Boot or tests only. Clears the singleton's driver cache; concurrent coroutines may already hold references that next resolution will not share.

Return Value

Manager

in Manager at line 194
mixed __call(string $method, array $parameters)

Dynamically call the default driver instance.

Parameters

string $method
array $parameters

Return Value

mixed

at line 36
protected Store createNullDriver()

Create an instance of the "null" session driver.

Return Value

Store

at line 44
protected Store createArrayDriver()

Create an instance of the "array" session driver.

Return Value

Store

at line 54
protected Store createCookieDriver()

Create an instance of the "cookie" session driver.

Return Value

Store

at line 66
protected Store createFileDriver()

Create an instance of the file session driver.

Return Value

Store

at line 74
protected Store createNativeDriver()

Create an instance of the file session driver.

Return Value

Store

at line 88
protected Store createDatabaseDriver()

Create an instance of the database session driver.

Return Value

Store

at line 110
protected Store createRedisDriver()

Create an instance of the Redis session driver.

Return Value

Store

at line 134
protected Store buildSession(SessionHandlerInterface $handler)

Build the session instance.

Parameters

SessionHandlerInterface $handler

Return Value

Store

at line 149
protected EncryptedStore buildEncryptedSession(SessionHandlerInterface $handler)

Build the encrypted session instance.

Parameters

SessionHandlerInterface $handler

Return Value

EncryptedStore

at line 163
bool supportsUserSessionManagement()

Determine if the configured driver supports user session management.

Return Value

bool

at line 176
UserSessions forUser(Authenticatable|int|string $user, UnitEnum|string|null $guard = null)

Get a user-scoped session repository.

Parameters

Authenticatable|int|string $user
UnitEnum|string|null $guard

Return Value

UserSessions

at line 243
bool shouldBlock()

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

Return Value

bool

at line 251
string|null blockDriver()

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

Return Value

string|null

at line 259
int defaultRouteBlockLockSeconds()

Get the maximum number of seconds the session lock should be held for.

Return Value

int

at line 267
int defaultRouteBlockWaitSeconds()

Get the maximum number of seconds to wait while attempting to acquire a route block session lock.

Return Value

int

at line 275
array getSessionConfig()

Get the session configuration.

Return Value

array

at line 293
void setDefaultDriver(UnitEnum|string $name)

Set the default session driver name.

Boot-only. Mutates process-global config; per-request use races across coroutines.

Parameters

UnitEnum|string $name

Return Value

void