PHP Class AppserverIo\Appserver\ServletEngine\Http\SessionWrapper

Author: Tim Wagner ([email protected])

Inheritance: extends AppserverIo\Psr\Servlet\Http\HttpSessionWrapper

Protected Properties

Property	Type	Description
$request	AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface	The request instance we're working on.

Method	Description
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.

Explicitly writes and closes the session

public close ( ) : void
return	void

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
return	void

Returns the request instance we're working on.

public getRequest ( ) : AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface
return	AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface

Returns the response instance we're working on.

public getResponse ( ) : AppserverIo\Psr\Servlet\Http\HttpServletResponseInterface
return	AppserverIo\Psr\Servlet\Http\HttpServletResponseInterface

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
return	void

Removes the session data entry $key from the session.

public removeData ( string $key ) : void
$key	string	Entry identifier of the session data to remove
return	void

Generates and propagates a new session ID and transfers all existing data to the new session.

public renewId ( ) : string
return	string	The new session ID

This method must not be called manually – it is invoked by Flow's object management.

public shutdownObject ( ) : void
return	void

Creates and returns the session cookie to be added to the response.

public start ( ) : void
return	void

The request instance we're working on.

protected HttpServletRequestInterface,AppserverIo\Psr\Servlet\Http $request
return	AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface