PHP Interface AppserverIo\Appserver\ServletEngine\Session\SessionHandlerInterface

See link: https://github.com/appserver-io/appserver
See link: http://www.appserver.io
Author: Tim Wagner ([email protected])
Show file Open project: appserver-io/appserver

Public Methods

Method Description
collectGarbage ( ) : integer Collects the garbage by deleting expired sessions.
delete ( string $id ) : void Deletes the session with the passed ID from the persistence layer.
getSessionMarshaller ( ) : AppserverIo\Appserver\ServletEngine\SessionMarshallerInterface Returns the session marshaller.
getSessionSettings ( ) : AppserverIo\Appserver\ServletEngine\SessionSettingsInterface Returns the session settings.
load ( string $id ) : AppserverIo\Psr\Servlet\ServletSessionInterface Loads the session with the passed ID from the persistence layer and returns it.
save ( AppserverIo\Psr\Servlet\ServletSessionInterface $session ) : void Saves the passed session to the persistence layer.

Method Details

collectGarbage() public method

Collects the garbage by deleting expired sessions.
public collectGarbage ( ) : integer
return integer The number of removed sessions

delete() public method

Deletes the session with the passed ID from the persistence layer.
public delete ( string $id ) : void
$id string The ID of the session we want to delete
return void

getSessionMarshaller() public method

Returns the session marshaller.
public getSessionMarshaller ( ) : AppserverIo\Appserver\ServletEngine\SessionMarshallerInterface
return AppserverIo\Appserver\ServletEngine\SessionMarshallerInterface The session marshaller

getSessionSettings() public method

Returns the session settings.
public getSessionSettings ( ) : AppserverIo\Appserver\ServletEngine\SessionSettingsInterface
return AppserverIo\Appserver\ServletEngine\SessionSettingsInterface The session settings

load() public method

Loads the session with the passed ID from the persistence layer and returns it.
public load ( string $id ) : AppserverIo\Psr\Servlet\ServletSessionInterface
$id string The ID of the session we want to unpersist
return AppserverIo\Psr\Servlet\ServletSessionInterface The unpersisted session

save() public method

Saves the passed session to the persistence layer.
public save ( AppserverIo\Psr\Servlet\ServletSessionInterface $session ) : void
$session AppserverIo\Psr\Servlet\ServletSessionInterface The session to save
return void