class JSessionStorageWincache extends JSessionStorage


Located at : UKNOWVA_ROOT/libraries/joomla/session/storage/wincache.php

WINCACHE session storage handler for PHP

Methods

__construct(array $options = array())

Constructor

string
__toString()

Magic method to convert the object to a string gracefully.

from JObject
mixed
def(string $property, mixed $default = null)

Sets a default value if not alreay assigned

from JObject
mixed
get(string $property, mixed $default = null)

Returns a property of the object or the default value if the property is not set.

from JObject
array
getProperties(boolean $public = true)

Returns an associative array of object properties.

from JObject
string
getError(integer $i = null, boolean $toString = true)

Get the most recent error message.

from JObject
array
getErrors()

Return all errors, if any.

from JObject
mixed
set(string $property, mixed $value = null)

Modifies a property of the object, creating it if it does not already exist.

from JObject
boolean
setProperties(mixed $properties)

Set the object properties based on a named array/hash.

from JObject
void
setError(string $error)

Add an error message.

from JObject
string
toString() deprecated

No description

from JObject
static JSessionStorage
getInstance(name $name = 'none', array $options = array())

Returns a session storage handler object, only creating it if it doesn't already exist.

void
register(array $options = array())

Register the functions of this class with PHP's session handler

boolean
open(string $save_path, string $session_name)

Open the SessionHandler backend.

boolean
close()

Close the SessionHandler backend.

string
read(string $id)

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

boolean
write(string $id, string $session_data)

Write session data to the SessionHandler backend.

boolean
destroy(string $id)

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

boolean
gc(integer $maxlifetime = null)

Garbage collect stale sessions from the SessionHandler backend.

static boolean
test()

Test to see if the SessionHandler is available.

Details

at line 27
JObject __construct(array $options = array())

Constructor

Parameters

array $options Optional parameters.

Return Value

JObject

in JObject at line 56
string __toString()

Magic method to convert the object to a string gracefully.

Return Value

string The classname.

in JObject at line 70
mixed def(string $property, mixed $default = null)

Sets a default value if not alreay assigned

Parameters

string $property The name of the property.
mixed $default The default value.

Return Value

mixed

in JObject at line 88
mixed get(string $property, mixed $default = null)

Returns a property of the object or the default value if the property is not set.

Parameters

string $property The name of the property.
mixed $default The default value.

Return Value

mixed The value of the property.

See also

getProperties()

in JObject at line 107
array getProperties(boolean $public = true)

Returns an associative array of object properties.

Parameters

boolean $public If true, returns only the public properties.

Return Value

array

See also

get()

in JObject at line 133
string getError(integer $i = null, boolean $toString = true)

Get the most recent error message.

Parameters

integer $i Option error index.
boolean $toString Indicates if JError objects should return their error message.

Return Value

string Error message

in JObject at line 165
array getErrors()

Return all errors, if any.

Return Value

array Array of error messages or JErrors.

in JObject at line 180
mixed set(string $property, mixed $value = null)

Modifies a property of the object, creating it if it does not already exist.

Parameters

string $property The name of the property.
mixed $value The value of the property to set.

Return Value

mixed Previous value of the property.

in JObject at line 198
boolean setProperties(mixed $properties)

Set the object properties based on a named array/hash.

Parameters

mixed $properties Either an associative array or another object.

Return Value

boolean

See also

set()

in JObject at line 222
void setError(string $error)

Add an error message.

Parameters

string $error Error message.

Return Value

void

in JObject at line 235
string toString() deprecated

deprecated 12.1 Use magic method __toString()

Return Value

string

See also

__toString()

in JSessionStorage at line 47
static JSessionStorage getInstance(name $name = 'none', array $options = array())

Returns a session storage handler object, only creating it if it doesn't already exist.

Parameters

name $name The session store to instantiate
array $options Array of options

Return Value

JSessionStorage object

in JSessionStorage at line 86
void register(array $options = array())

Register the functions of this class with PHP's session handler

Parameters

array $options optional parameters

Return Value

void

at line 44
boolean open(string $save_path, string $session_name)

Open the SessionHandler backend.

Parameters

string $save_path The path to the session object.
string $session_name The name of the session.

Return Value

boolean True on success, false otherwise.

at line 54
boolean close()

Close the SessionHandler backend.

Return Value

boolean True on success, false otherwise.

at line 67
string read(string $id)

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

Parameters

string $id The session identifier.

Return Value

string The session data.

at line 81
boolean write(string $id, string $session_data)

Write session data to the SessionHandler backend.

Parameters

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

Return Value

boolean True on success, false otherwise.

at line 95
boolean destroy(string $id)

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

Parameters

string $id The session identifier.

Return Value

boolean True on success, false otherwise.

at line 108
boolean gc(integer $maxlifetime = null)

Garbage collect stale sessions from the SessionHandler backend.

Parameters

integer $maxlifetime The maximum age of a session.

Return Value

boolean True on success, false otherwise.

at line 118
static boolean test()

Test to see if the SessionHandler is available.

Return Value

boolean True on success, false otherwise.