class ApcHandler extends AbstractHandler (View source)

APC session storage handler for PHP

Methods

__construct(array $options)

Constructor

mixed
register()

register

static boolean
isSupported()

Test to see if the SessionHandler is available.

string
read(string $id)

Read the data for a particular session identifier from the SessionHandler backend.

bool
write(string $id, string $session_data)

Write session data to the SessionHandler backend.

bool
destroy(int $id)

Destroy the data for a particular session identifier in the SessionHandler backend.

bool
gc(int $maxlifetime)

PHP >= 5.4.0
Cleanup old sessions

bool
open(string $savePath, string $sessionName)

Re-initializes existing session, or creates a new one.

bool
close()

Closes the current session.

Details

at line line 28
__construct(array $options)

Constructor

Parameters

array $options

Exceptions

RuntimeException

mixed register()

register

Return Value

mixed

at line line 45
static boolean isSupported()

Test to see if the SessionHandler is available.

Return Value

boolean

at line line 60
string read(string $id)

Read the data for a particular session identifier from the SessionHandler backend.

Parameters

string $id The session id to read data for.

Return Value

string Returns an encoded string of the read data. If nothing was read, it must return an empty string. Note this value is returned internally to PHP for processing.

at line line 75
bool write(string $id, string $session_data)

Write session data to the SessionHandler backend.

Parameters

string $id The session id.
string $session_data The session data.

Return Value

bool The return value (usually TRUE on success, FALSE on failure). Note this value is returned internally to PHP for processing.

at line line 89
bool destroy(int $id)

Destroy the data for a particular session identifier in the SessionHandler backend.

Parameters

int $id The session ID being destroyed.

Return Value

bool The return value (usually TRUE on success, FALSE on failure). Note this value is returned internally to PHP for processing.

at line line 110
bool gc(int $maxlifetime)

PHP >= 5.4.0
Cleanup old sessions

Parameters

int $maxlifetime Sessions that have not updated for the last maxlifetime seconds will be removed.

Return Value

bool The return value (usually TRUE on success, FALSE on failure). Note this value is returned internally to PHP for processing.

at line line 125
bool open(string $savePath, string $sessionName)

Re-initializes existing session, or creates a new one.

Parameters

string $savePath The path where to store/retrieve the session.
string $sessionName Session name, see http://php.net/function.session-name.php

Return Value

bool The return value (usually TRUE on success, FALSE on failure). Note this value is returned internally to PHP for processing.

See also

http://php.net/sessionhandlerinterface.open

at line line 137
bool close()

Closes the current session.

Return Value

bool The return value (usually TRUE on success, FALSE on failure). Note this value is returned internally to PHP for processing.

See also

http://php.net/sessionhandlerinterface.close