SessionHandlerProxy
extends AbstractProxy
in package
implements
SessionHandlerInterface, SessionUpdateTimestampHandlerInterface
Tags
Interfaces, Classes and Traits
- SessionHandlerInterface
- SessionUpdateTimestampHandlerInterface
Table of Contents
- $handler : mixed
- $saveHandlerName : string
- $wrapper : bool
- Flag if handler wraps an internal PHP session handler (using \SessionHandler).
- __construct() : mixed
- close() : mixed
- {@inheritdoc}
- destroy() : mixed
- {@inheritdoc}
- gc() : bool
- getHandler() : SessionHandlerInterface
- getId() : string
- Gets the session ID.
- getName() : string
- Gets the session name.
- getSaveHandlerName() : string|null
- Gets the session.save_handler name.
- isActive() : bool
- Has a session started?
- isSessionHandlerInterface() : bool
- Is this proxy handler and instance of \SessionHandlerInterface.
- isWrapper() : bool
- Returns true if this handler wraps an internal PHP session save handler using \SessionHandler.
- open() : mixed
- {@inheritdoc}
- read() : mixed
- {@inheritdoc}
- setId() : mixed
- Sets the session ID.
- setName() : mixed
- Sets the session name.
- updateTimestamp() : bool
- Updates the timestamp of a session when its data didn't change.
- validateId() : bool
- Checks if a session identifier already exists or not.
- write() : mixed
- {@inheritdoc}
Properties
$handler
protected
mixed
$handler
$saveHandlerName
protected
string
$saveHandlerName
$wrapper
Flag if handler wraps an internal PHP session handler (using \SessionHandler).
protected
bool
$wrapper
= false
Methods
__construct()
public
__construct(SessionHandlerInterface $handler) : mixed
Parameters
- $handler : SessionHandlerInterface
Return values
mixed —close()
{@inheritdoc}
public
close() : mixed
Return values
mixed —destroy()
{@inheritdoc}
public
destroy(mixed $sessionId) : mixed
Parameters
- $sessionId : mixed
Return values
mixed —gc()
public
gc(mixed $maxlifetime) : bool
Parameters
- $maxlifetime : mixed
Return values
bool —getHandler()
public
getHandler() : SessionHandlerInterface
Return values
SessionHandlerInterface —getId()
Gets the session ID.
public
getId() : string
Return values
string —getName()
Gets the session name.
public
getName() : string
Return values
string —getSaveHandlerName()
Gets the session.save_handler name.
public
getSaveHandlerName() : string|null
Return values
string|null —isActive()
Has a session started?
public
isActive() : bool
Return values
bool —isSessionHandlerInterface()
Is this proxy handler and instance of \SessionHandlerInterface.
public
isSessionHandlerInterface() : bool
Return values
bool —isWrapper()
Returns true if this handler wraps an internal PHP session save handler using \SessionHandler.
public
isWrapper() : bool
Return values
bool —open()
{@inheritdoc}
public
open(mixed $savePath, mixed $sessionName) : mixed
Parameters
- $savePath : mixed
- $sessionName : mixed
Return values
mixed —read()
{@inheritdoc}
public
read(mixed $sessionId) : mixed
Parameters
- $sessionId : mixed
Return values
mixed —setId()
Sets the session ID.
public
setId(string $id) : mixed
Parameters
- $id : string
Tags
Return values
mixed —setName()
Sets the session name.
public
setName(string $name) : mixed
Parameters
- $name : string
Tags
Return values
mixed —updateTimestamp()
Updates the timestamp of a session when its data didn't change.
public
updateTimestamp(mixed $sessionId, mixed $data) : bool
Parameters
- $sessionId : mixed
- $data : mixed
Return values
bool —validateId()
Checks if a session identifier already exists or not.
public
validateId(mixed $sessionId) : bool
Parameters
- $sessionId : mixed
Return values
bool —write()
{@inheritdoc}
public
write(mixed $sessionId, mixed $data) : mixed
Parameters
- $sessionId : mixed
- $data : mixed