1. class
  2. Illuminate
  3. \
  4. Session
  5. \
  6. Middleware
  7. \
  8. StartSession

StartSession

class StartSession (View source)

Properties

protected SessionManager $manager

The session manager.
protected callable|null $cacheFactoryResolver

The callback that can resolve an instance of the cache factory.

Methods

__construct(SessionManager $manager, callable|null $cacheFactoryResolver = null)

Create a new session middleware.

mixed
handle(Request $request, Closure $next)

Handle an incoming request.

mixed
handleRequestWhileBlocking(Request $request, Session $session, Closure $next)

Handle the given request within session state.

mixed
handleStatefulRequest(Request $request, Session $session, Closure $next)

Handle the given request within session state.

Session
startSession(Request $request, Session $session)

Start the session for the given request.

Session
getSession(Request $request)

Get the session implementation from the manager.

void
collectGarbage(Session $session)

Remove the garbage from the session if necessary.

bool
configHitsLottery(array $config)

Determine if the configuration odds hit the lottery.

void
storeCurrentUrl(Request $request, Session $session)

Store the current URL for the request if necessary.

void
addCookieToResponse(Response $response, Session $session)

Add the session cookie to the application response.

void
saveSession(Request $request)

Save the session data to storage.

int
getSessionLifetimeInSeconds()

Get the session lifetime in seconds.

DateTimeInterface|int
getCookieExpirationDate()

Get the cookie lifetime in seconds.

bool
sessionConfigured()

Determine if a session driver has been configured.

bool
sessionIsPersistent(array|null $config = null)

Determine if the configured session driver is persistent.

Store
cache(string $driver)

Resolve the given cache driver.

Details

at line 37
__construct(SessionManager $manager, callable|null $cacheFactoryResolver = null)

Create a new session middleware.

Parameters

SessionManager $manager
callable|null $cacheFactoryResolver

at line 50
mixed handle(Request $request, Closure $next)

Handle an incoming request.

Parameters

Request $request
Closure $next

Return Value

mixed

at line 74
protected mixed handleRequestWhileBlocking(Request $request, Session $session, Closure $next)

Handle the given request within session state.

Parameters

Request $request
Session $session
Closure $next

Return Value

mixed

at line 109
protected mixed handleStatefulRequest(Request $request, Session $session, Closure $next)

Handle the given request within session state.

Parameters

Request $request
Session $session
Closure $next

Return Value

mixed

at line 141
protected Session startSession(Request $request, Session $session)

Start the session for the given request.

Parameters

Request $request
Session $session

Return Value

Session

at line 156
Session getSession(Request $request)

Get the session implementation from the manager.

Parameters

Request $request

Return Value

Session

at line 169
protected void collectGarbage(Session $session)

Remove the garbage from the session if necessary.

Parameters

Session $session

Return Value

void

at line 187
protected bool configHitsLottery(array $config)

Determine if the configuration odds hit the lottery.

Parameters

array $config

Return Value

bool

at line 199
protected void storeCurrentUrl(Request $request, Session $session)

Store the current URL for the request if necessary.

Parameters

Request $request
Session $session

Return Value

void

at line 217
protected void addCookieToResponse(Response $response, Session $session)

Add the session cookie to the application response.

Parameters

Response $response
Session $session

Return Value

void

at line 241
protected void saveSession(Request $request)

Save the session data to storage.

Parameters

Request $request

Return Value

void

at line 253
protected int getSessionLifetimeInSeconds()

Get the session lifetime in seconds.

Return Value

int

at line 263
protected DateTimeInterface|int getCookieExpirationDate()

Get the cookie lifetime in seconds.

Return Value

DateTimeInterface|int

at line 277
protected bool sessionConfigured()

Determine if a session driver has been configured.

Return Value

bool

at line 288
protected bool sessionIsPersistent(array|null $config = null)

Determine if the configured session driver is persistent.

Parameters

array|null $config

Return Value

bool

at line 301
protected Store cache(string $driver)

Resolve the given cache driver.

Parameters

string $driver

Return Value

Store