PHP Класс AppserverIo\Appserver\ServletEngine\Http\SessionWrapper

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

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

Свойство Тип Описание
$request AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface The request instance we're working on.

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

Метод Описание
close ( ) : void Explicitly writes and closes the session
destroy ( string $reason ) : void Explicitly destroys all session data and adds a cookie to the response that invalidates the session in the browser.
getRequest ( ) : AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface Returns the request instance we're working on.
getResponse ( ) : AppserverIo\Psr\Servlet\Http\HttpServletResponseInterface Returns the response instance we're working on.
injectRequest ( AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface $request ) : void Injects the request instance.
removeData ( string $key ) : void Removes the session data entry $key from the session.
renewId ( ) : string Generates and propagates a new session ID and transfers all existing data to the new session.
shutdownObject ( ) : void Shuts down this session
start ( ) : void Creates and returns the session cookie to be added to the response.

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

close() публичный метод

Explicitly writes and closes the session
public close ( ) : void
Результат void

destroy() публичный метод

Explicitly destroys all session data and adds a cookie to the response that invalidates the session in the browser.
public destroy ( string $reason ) : void
$reason string The reason why the session has been destroyed
Результат void

getRequest() публичный метод

Returns the request instance we're working on.
public getRequest ( ) : AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface
Результат AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface

getResponse() публичный метод

Returns the response instance we're working on.
public getResponse ( ) : AppserverIo\Psr\Servlet\Http\HttpServletResponseInterface
Результат AppserverIo\Psr\Servlet\Http\HttpServletResponseInterface

injectRequest() публичный метод

Injects the request instance.
public injectRequest ( AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface $request ) : void
$request AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface The request instance we're working on
Результат void

removeData() публичный метод

Removes the session data entry $key from the session.
public removeData ( string $key ) : void
$key string Entry identifier of the session data to remove
Результат void

renewId() публичный метод

Generates and propagates a new session ID and transfers all existing data to the new session.
public renewId ( ) : string
Результат string The new session ID

shutdownObject() публичный метод

This method must not be called manually – it is invoked by Flow's object management.
public shutdownObject ( ) : void
Результат void

start() публичный метод

Creates and returns the session cookie to be added to the response.
public start ( ) : void
Результат void

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

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

The request instance we're working on.
protected HttpServletRequestInterface,AppserverIo\Psr\Servlet\Http $request
Результат AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface