JSessionStorageMemcached
Extends \JSessionStorageMemcached session storage handler for PHP
-- Inspired in both design and implementation by the Horde memcached handler --
package |
Joomla.Platform |
---|---|
subpackage |
Session |
see |
http://www.php.net/manual/en/function.session-set-save-handler.php |
since |
11.1 |
Methods
__construct
Class constructor, overridden in descendant classes.
__construct(mixed $properties = null)
since |
11.1 |
---|
Arguments
- $properties
mixed
Either and associative array or another object to set the initial properties of the object.
__toString
Magic method to convert the object to a string gracefully.
__toString() : string
since |
11.1 |
---|---|
deprecated |
12.3 Classes should provide their own __toString() implementation. |
Response
string
The classname.
_setExpire
Set expire time on each call since memcached sets it on cache creation.
_setExpire(string $key) : void
since |
11.1 |
---|
Arguments
- $key
string
Cache key to expire.
close
Close the SessionHandler backend.
close() : boolean
since |
11.1 |
---|
Response
boolean
True on success, false otherwise.
def
Sets a default value if not alreay assigned
def(string $property, mixed $default = null) : mixed
since |
11.1 |
---|
Arguments
- $property
string
The name of the property.- $default
mixed
The default value.
Response
mixed
destroy
Destroy the data for a particular session identifier in the SessionHandler backend.
destroy(string $id) : boolean
since |
11.1 |
---|
Arguments
- $id
string
The session identifier.
Response
boolean
True on success, false otherwise.
gc
Garbage collect stale sessions from the SessionHandler backend.
gc(integer $maxlifetime = null) : boolean
since |
11.1 |
---|
Arguments
- $maxlifetime
integer
The maximum age of a session.
Response
boolean
True on success, false otherwise.
get
Returns a property of the object or the default value if the property is not set.
get(string $property, mixed $default = null) : mixed
since |
11.1 |
---|---|
see | \JObject::getProperties() |
Arguments
- $property
string
The name of the property.- $default
mixed
The default value.
Response
mixed
The value of the property.
getError
Get the most recent error message.
getError(integer $i = null, boolean $toString = true) : string
since |
11.1 |
---|---|
see | \JError |
deprecated |
12.3 JError has been deprecated |
Arguments
- $i
integer
Option error index.- $toString
boolean
Indicates if JError objects should return their error message.
Response
string
Error message
getErrors
Return all errors, if any.
getErrors() : array
since |
11.1 |
---|---|
see | \JError |
deprecated |
12.3 JError has been deprecated |
Response
array
Array of error messages or JErrors.
getInstance
Returns a session storage handler object, only creating it if it doesn't already exist.
getInstance(string $name = 'none', array $options = array()) : \JSessionStorage
since |
11.1 |
---|
Arguments
- $name
string
The session store to instantiate- $options
array
Array of options
Response
getProperties
Returns an associative array of object properties.
getProperties(boolean $public = true) : array
since |
11.1 |
---|---|
see | \JObject::get() |
Arguments
- $public
boolean
If true, returns only the public properties.
Response
array
open
Open the SessionHandler backend.
open(string $save_path, string $session_name) : boolean
since |
11.1 |
---|
Arguments
- $save_path
string
The path to the session object.- $session_name
string
The name of the session.
Response
boolean
True on success, false otherwise.
read
Read the data for a particular session identifier from the SessionHandler backend.
read(string $id) : string
since |
11.1 |
---|
Arguments
- $id
string
The session identifier.
Response
string
The session data.
register
Register the functions of this class with PHP's session handler
register() : void
since |
11.1 |
---|
set
Modifies a property of the object, creating it if it does not already exist.
set(string $property, mixed $value = null) : mixed
since |
11.1 |
---|
Arguments
- $property
string
The name of the property.- $value
mixed
The value of the property to set.
Response
mixed
Previous value of the property.
setError
Add an error message.
setError(string $error) : void
since |
11.1 |
---|---|
see | \JError |
deprecated |
12.3 JError has been deprecated |
Arguments
- $error
string
Error message.
setProperties
Set the object properties based on a named array/hash.
setProperties(mixed $properties) : boolean
since |
11.1 |
---|---|
see | \JObject::set() |
Arguments
- $properties
mixed
Either an associative array or another object.
Response
boolean
test
Test to see if the SessionHandler is available.
test() : boolean
since |
11.1 |
---|
Response
boolean
True on success, false otherwise.
toString
Converts the object to a string (the class name).
toString() : string
write
Write session data to the SessionHandler backend.
write(string $id, string $session_data) : boolean
since |
11.1 |
---|
Arguments
- $id
string
The session identifier.- $session_data
string
The session data.
Response
boolean
True on success, false otherwise.
Properties
_db
Resource for the current memcached connection.
since |
11.1 |
---|
Type(s)
resource
_compress
Use compression?
since |
11.1 |
---|
Type(s)
integer
_persistent
Use persistent connections
since |
11.1 |
---|
Type(s)
boolean
instances
JSessionStorage instances container.
since |
11.3 |
---|
Type(s)
array
_errors
An array of error messages or Exception objects.