class StartSession implements TerminableMiddleware (View source)

Properties

protected SessionManager $manager The session manager.
protected bool $sessionHandled Indicates if the session was handled for the current request.

Methods

void
__construct(SessionManager $manager)

Create a new session middleware.

mixed
handle(Request $request, Closure $next)

Handle an incoming request.

void
terminate(Request $request, Response $response)

Perform any final actions for the request lifecycle.

startSession(Request $request)

Start the session for the given request.

getSession(Request $request)

Get the session implementation from the manager.

void
storeCurrentUrl(Request $request, SessionInterface $session)

Store the current URL for the request if necessary.

void
collectGarbage(SessionInterface $session)

Remove the garbage from the session if necessary.

bool
configHitsLottery(array $config)

Determine if the configuration odds hit the lottery.

void
addCookieToResponse(Response $response, SessionInterface $session)

Add the session cookie to the application response.

int
getSessionLifetimeInSeconds()

Get the session lifetime in seconds.

int
getCookieExpirationDate()

Get the cookie lifetime in seconds.

bool
sessionConfigured()

Determine if a session driver has been configured.

bool
sessionIsPersistent(array $config = null)

Determine if the configured session driver is persistent.

bool
usingCookieSessions()

Determine if the session is using cookie sessions.

Details

void __construct(SessionManager $manager)

Create a new session middleware.

Parameters

SessionManager $manager

Return Value

void

mixed handle(Request $request, Closure $next)

Handle an incoming request.

Parameters

Request $request
Closure $next

Return Value

mixed

void terminate(Request $request, Response $response)

Perform any final actions for the request lifecycle.

Parameters

Request $request
Response $response

Return Value

void

protected SessionInterface startSession(Request $request)

Start the session for the given request.

Parameters

Request $request

Return Value

SessionInterface

SessionInterface getSession(Request $request)

Get the session implementation from the manager.

Parameters

Request $request

Return Value

SessionInterface

protected void storeCurrentUrl(Request $request, SessionInterface $session)

Store the current URL for the request if necessary.

Parameters

Request $request
SessionInterface $session

Return Value

void

protected void collectGarbage(SessionInterface $session)

Remove the garbage from the session if necessary.

Parameters

SessionInterface $session

Return Value

void

protected bool configHitsLottery(array $config)

Determine if the configuration odds hit the lottery.

Parameters

array $config

Return Value

bool

protected void addCookieToResponse(Response $response, SessionInterface $session)

Add the session cookie to the application response.

Parameters

Response $response
SessionInterface $session

Return Value

void

protected int getSessionLifetimeInSeconds()

Get the session lifetime in seconds.

Return Value

int

protected int getCookieExpirationDate()

Get the cookie lifetime in seconds.

Return Value

int

protected bool sessionConfigured()

Determine if a session driver has been configured.

Return Value

bool

protected bool sessionIsPersistent(array $config = null)

Determine if the configured session driver is persistent.

Parameters

array $config

Return Value

bool

protected bool usingCookieSessions()

Determine if the session is using cookie sessions.

Return Value

bool