PHP Class AppserverIo\Appserver\ServletEngine\Session\FilesystemSessionHandler

Author: Tim Wagner ([email protected])

Inheritance: extends AbstractSessionHandler

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.
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	Description
getSessionSavePath ( string $toAppend = null ) : string	Returns the default path to persist sessions.
removeSessionFile ( string $pathname ) : boolean	Removes the session file with the passed name containing session data.
sessionFileExists ( string $pathname ) : boolean	Checks if a file with the passed name containing session data exists.
unpersist ( string $pathname ) : AppserverIo\Psr\Servlet\Http\HttpSessionInterface	Tries to load the session data from the passed filename.

Collects the garbage by deleting expired sessions.

public collectGarbage ( ) : integer
return	integer	The number of removed sessions

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

Returns the default path to persist sessions.

protected getSessionSavePath ( string $toAppend = null ) : string
$toAppend	string	A relative path to append to the session save path
return	string	The default path to persist session

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

Removes the session file with the passed name containing session data.

protected removeSessionFile ( string $pathname ) : boolean
$pathname	string	The path of the file to remove
return	boolean	TRUE if the file has successfully been removed, else FALSE

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

Checks if a file with the passed name containing session data exists.

protected sessionFileExists ( string $pathname ) : boolean
$pathname	string	The path of the file to check
return	boolean	TRUE if the file exists, else FALSE

Tries to load the session data from the passed filename.

protected unpersist ( string $pathname ) : AppserverIo\Psr\Servlet\Http\HttpSessionInterface
$pathname	string	The path of the file to load the session data from
return	AppserverIo\Psr\Servlet\Http\HttpSessionInterface	The unmarshalled session