core\session\memcached Class Reference

Inheritance diagram for core\session\memcached:

Public Member Functions
	__construct ()
	Create new instance of handler.
	abort ()
	Release lock on the session without writing it.
	add_session (int $userid)
	Insert new empty session record.
	destroy (string $id)
	Destroy a specific session and delete this session record for this session id.
	destroy_all ()
	Destroy all sessions, and delete all the session data.
	destroy_by_auth_plugin (string $pluginname)
	Destroy all sessions for a given plugin.
	gc (int $max_lifetime=0)
	Periodic timed-out session cleanup.
	get_all_sessions ()
	Returns all session records.
	get_session_by_sid (string $sid)
	Returns a single session record for this session id.
	get_sessions_by_userid (int $userid)
	Returns all the session records for this user id.
	init ()
	Init session handler.
	requires_write_lock ()
	Has this session been opened with a writelock?
	session_exists ($sid)
	Check the backend contains data for this session id.
	set_requires_write_lock ($requireswritelock)
	This is called after init() and before start() to indicate whether the session opened should be writable or not.
	start ()
	Start the session.
	update_session (stdClass $record)
	Update a session record.
	write_close ()
	Write the session and release lock.

Protected Member Functions
	destroy_all_expired_sessions (int $purgebefore)
	Clean up all expired sessions.
	destroy_expired_user_sessions (int $purgebefore, int $userid)
	Clean up expired sessions.

Static Protected Member Functions
static	connection_string_to_memcache_servers (string $str)
	Convert a connection string to an array of servers.

Protected Attributes
int	$acquiretimeout = 120
	$acquiretimeout how long to wait for session lock
int	$lockexpire = 7200
	$lockexpire how long to wait before expiring the lock so that other requests may continue execution, ignored if PECL memcached is below version 2.2.0.
integer	$lockretrysleep = 150
	$lockretrysleep Used for memcached 3.x (PHP7), the amount of time to sleep between attempts to acquire the session lock.
string	$prefix
	$prefix session key prefix
boolean	$requireswritelock = false
	$requireswritelock does the session need and/or have a lock?
string	$savepath
	$savepath save_path string
array	$servers
	$servers list of servers parsed from save_path

Member Function Documentation

abort()

core\session\handler::abort ( )

inherited

Release lock on the session without writing it.

May not be possible in older versions of PHP. If so, session may be written anyway so that any locks are released.

add_session()

core\session\handler::add_session ( int $userid )

inherited

Insert new empty session record.

Parameters

int

$userid

Return values

stdClass

the new record

Reimplemented in core\session\redis.

connection_string_to_memcache_servers()

static core\session\memcached::connection_string_to_memcache_servers ( string $str )

staticprotected

Convert a connection string to an array of servers.

"abc:123, xyz:789" to [ ['abc', '123'], ['xyz', '789'], ]

Parameters

string

$str

save_path value containing memcached connection string

Return values

array[]

destroy()

core\session\memcached::destroy

(

string

$id

)

Destroy a specific session and delete this session record for this session id.

Parameters

string

$id

session id

Return values

bool

Reimplemented from core\session\handler.

destroy_all()

core\session\memcached::destroy_all

(

)

Destroy all sessions, and delete all the session data.

Return values

bool

Reimplemented from core\session\handler.

destroy_all_expired_sessions()

core\session\handler::destroy_all_expired_sessions ( int $purgebefore )

protectedinherited

Clean up all expired sessions.

Parameters

int

$purgebefore

destroy_by_auth_plugin()

core\session\handler::destroy_by_auth_plugin ( string $pluginname )

inherited

Destroy all sessions for a given plugin.

Typically used when a plugin is disabled or uninstalled, so all sessions (users) for that plugin are logged out.

Parameters

string

$pluginname

Auth plugin name.

destroy_expired_user_sessions()

core\session\handler::destroy_expired_user_sessions ( int $purgebefore, int $userid )

protectedinherited

Clean up expired sessions.

Parameters

int	$purgebefore	Sessions that have not updated for the last purgebefore timestamp will be removed.
int	$userid

gc()

core\session\handler::gc ( int $max_lifetime = 0 )

inherited

Periodic timed-out session cleanup.

Parameters

int

$max_lifetime

Sessions that have not updated for the last max_lifetime seconds will be removed.

Return values

int|false

Number of deleted sessions or false if an error occurred.

Reimplemented in core\session\redis.

get_all_sessions()

core\session\handler::get_all_sessions ( )

inherited

Returns all session records.

Return values

Iterator

Reimplemented in core\session\redis, and core\tests\session\mock_handler.

get_session_by_sid()

core\session\handler::get_session_by_sid ( string $sid )

inherited

Returns a single session record for this session id.

Parameters

string

$sid

Return values

stdClass

Reimplemented in core\session\redis.

get_sessions_by_userid()

core\session\handler::get_sessions_by_userid ( int $userid )

inherited

Returns all the session records for this user id.

Parameters

int

$userid

Return values

array

Reimplemented in core\session\redis.

init()

core\session\memcached::init

(

)

Init session handler.

Reimplemented from core\session\handler.

requires_write_lock()

core\session\handler::requires_write_lock ( )

inherited

Has this session been opened with a writelock?

Your handler should call this during start() if you support read-only sessions.

Return values

bool	true if session is intended to have a write lock.

session_exists()

core\session\memcached::session_exists

(

$sid

)

Check the backend contains data for this session id.

Note: this is intended to be called from manager::session_exists() only.

Parameters

string

$sid

Return values

bool	true if session found.

Reimplemented from core\session\handler.

set_requires_write_lock()

core\session\handler::set_requires_write_lock ( $requireswritelock )

inherited

This is called after init() and before start() to indicate whether the session opened should be writable or not.

This is intentionally captured even if your handler doesn't support non-locking sessions, so that behavior (upon session close) matches closely between handlers.

Parameters

bool

$requireswritelock

true if needs to be open for writing

start()

core\session\memcached::start

(

)

Start the session.

Return values

bool

success

Reimplemented from core\session\handler.

update_session()

core\session\handler::update_session ( stdClass $record )

inherited

Update a session record.

Parameters

stdClass

$record

Return values

bool

write_close()

core\session\handler::write_close ( )

inherited

Write the session and release lock.

If the session was not intentionally opened with a write lock, then we will abort the session instead if able.

Member Data Documentation

$lockretrysleep

integer core\session\memcached::$lockretrysleep = 150

protected

$lockretrysleep Used for memcached 3.x (PHP7), the amount of time to sleep between attempts to acquire the session lock.

Mimics the deprecated config memcached.sess_lock_wait.

---

The documentation for this class was generated from the following file:

• lib/classes/session/memcached.php