PHP Класс AppserverIo\Appserver\ServletEngine\Session\AbstractSessionHandler

См. ссылку: https://github.com/appserver-io/appserver
См. ссылку: http://www.appserver.io
Автор: Tim Wagner ([email protected])
Наследование: implements AppserverIo\Appserver\ServletEngine\Session\SessionHandlerInterface
Показать файл Открыть проект

Защищенные свойства (Protected)

Свойство Тип Описание
$sessionMarshaller AppserverIo\Appserver\ServletEngine\SessionMarshallerInterface The session marshaller instance.
$sessionSettings AppserverIo\Appserver\ServletEngine\SessionSettingsInterface The settings for the session handling.

Открытые методы

Метод Описание
__construct ( string $sessionMarshallerType = FilesystemSessionHandler::DEFAULT_SESSION_MARSHALLER_TYPE ) Initializes the session handler with the configured params.
getSessionMarshaller ( ) : AppserverIo\Appserver\ServletEngine\SessionMarshallerInterface Returns the session marshaller.
getSessionSettings ( ) : AppserverIo\Appserver\ServletEngine\SessionSettingsInterface Returns the session settings.
injectSessionMarshaller ( AppserverIo\Appserver\ServletEngine\SessionMarshallerInterface $sessionMarshaller ) : void Injects the session marshaller.
injectSessionSettings ( AppserverIo\Appserver\ServletEngine\SessionSettingsInterface $sessionSettings ) : void Injects the session settings.

Защищенные методы

Метод Описание
marshall ( AppserverIo\Psr\Servlet\ServletSessionInterface $servletSession ) : string Transforms the passed session instance into a JSON encoded string. If the data contains objects, each of them will be serialized before store them to the persistence layer.
unmarshall ( string $marshalled ) : AppserverIo\Psr\Servlet\ServletSessionInterface Initializes the session instance from the passed JSON string. If the encoded data contains objects, they will be unserialized before reattached to the session instance.

Описание методов

__construct() публичный Метод

Initializes the session handler with the configured params.
public __construct ( string $sessionMarshallerType = FilesystemSessionHandler::DEFAULT_SESSION_MARSHALLER_TYPE )
$sessionMarshallerType string The session marshaller type to use

getSessionMarshaller() публичный Метод

Returns the session marshaller.
public getSessionMarshaller ( ) : AppserverIo\Appserver\ServletEngine\SessionMarshallerInterface
Результат AppserverIo\Appserver\ServletEngine\SessionMarshallerInterface The session marshaller

getSessionSettings() публичный Метод

Returns the session settings.
public getSessionSettings ( ) : AppserverIo\Appserver\ServletEngine\SessionSettingsInterface
Результат AppserverIo\Appserver\ServletEngine\SessionSettingsInterface The session settings

injectSessionMarshaller() публичный Метод

Injects the session marshaller.
public injectSessionMarshaller ( AppserverIo\Appserver\ServletEngine\SessionMarshallerInterface $sessionMarshaller ) : void
$sessionMarshaller AppserverIo\Appserver\ServletEngine\SessionMarshallerInterface The session marshaller instance
Результат void

injectSessionSettings() публичный Метод

Injects the session settings.
public injectSessionSettings ( AppserverIo\Appserver\ServletEngine\SessionSettingsInterface $sessionSettings ) : void
$sessionSettings AppserverIo\Appserver\ServletEngine\SessionSettingsInterface Settings for the session handling
Результат void

marshall() защищенный Метод

Transforms the passed session instance into a JSON encoded string. If the data contains objects, each of them will be serialized before store them to the persistence layer.
protected marshall ( AppserverIo\Psr\Servlet\ServletSessionInterface $servletSession ) : string
$servletSession AppserverIo\Psr\Servlet\ServletSessionInterface The servlet session to be transformed
Результат string The marshalled servlet session representation

unmarshall() защищенный Метод

Initializes the session instance from the passed JSON string. If the encoded data contains objects, they will be unserialized before reattached to the session instance.
protected unmarshall ( string $marshalled ) : AppserverIo\Psr\Servlet\ServletSessionInterface
$marshalled string The marshaled session representation
Результат AppserverIo\Psr\Servlet\ServletSessionInterface The un-marshaled servlet session instance

Описание свойств

$sessionMarshaller защищенное свойство

The session marshaller instance.
protected SessionMarshallerInterface,AppserverIo\Appserver\ServletEngine $sessionMarshaller
Результат AppserverIo\Appserver\ServletEngine\SessionMarshallerInterface

$sessionSettings защищенное свойство

The settings for the session handling.
protected SessionSettingsInterface,AppserverIo\Appserver\ServletEngine $sessionSettings
Результат AppserverIo\Appserver\ServletEngine\SessionSettingsInterface