JSessionStorageWincache

Extends \JSessionStorage

WINCACHE session storage handler for PHP

This class allows for simple but smart objects with get and set methods and an internal error 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) 
inherited
since

11.1

Arguments

$properties

mixedEither 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
inherited deprecated
since

11.1

deprecated

12.3 Classes should provide their own __toString() implementation.

Response

stringThe classname.

close

Close the SessionHandler backend.

close() : boolean
inherited
since

11.1

Response

booleanTrue on success, false otherwise.

def

Sets a default value if not alreay assigned

def(string $property, mixed $default = null) : mixed
inherited
since

11.1

Arguments

$property

stringThe name of the property.

$default

mixedThe default value.

Response

mixed

destroy

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

destroy(string $id) : boolean
inherited
since

11.1

Arguments

$id

stringThe session identifier.

Response

booleanTrue on success, false otherwise.

gc

Garbage collect stale sessions from the SessionHandler backend.

gc(integer $maxlifetime = null) : boolean
inherited
since

11.1

Arguments

$maxlifetime

integerThe maximum age of a session.

Response

booleanTrue 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
inherited
since

11.1

see \JObject::getProperties()

Arguments

$property

stringThe name of the property.

$default

mixedThe default value.

Response

mixedThe value of the property.

getError

Get the most recent error message.

getError(integer $i = null, boolean $toString = true) : string
inherited deprecated
since

11.1

see \JError
deprecated

12.3 JError has been deprecated

Arguments

$i

integerOption error index.

$toString

booleanIndicates if JError objects should return their error message.

Response

stringError message

getErrors

Return all errors, if any.

getErrors() : array
inherited deprecated
since

11.1

see \JError
deprecated

12.3 JError has been deprecated

Response

arrayArray 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
inherited static
since

11.1

Arguments

$name

stringThe session store to instantiate

$options

arrayArray of options

Response

\JSessionStorage

getProperties

Returns an associative array of object properties.

getProperties(boolean $public = true) : array
inherited
since

11.1

see \JObject::get()

Arguments

$public

booleanIf true, returns only the public properties.

Response

array

open

Open the SessionHandler backend.

open(string $save_path, string $session_name) : boolean
inherited
since

11.1

Arguments

$save_path

stringThe path to the session object.

$session_name

stringThe name of the session.

Response

booleanTrue on success, false otherwise.

read

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

read(string $id) : string
inherited
since

11.1

Arguments

$id

stringThe session identifier.

Response

stringThe session data.

register

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

register() : void
inherited
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
inherited
since

11.1

Arguments

$property

stringThe name of the property.

$value

mixedThe value of the property to set.

Response

mixedPrevious value of the property.

setError

Add an error message.

setError(string $error) : void
inherited deprecated
since

11.1

see \JError
deprecated

12.3 JError has been deprecated

Arguments

$error

stringError message.

setProperties

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

setProperties(mixed $properties) : boolean
inherited
since

11.1

see \JObject::set()

Arguments

$properties

mixedEither an associative array or another object.

Response

boolean

test

Test to see if the SessionHandler is available.

test() : boolean
inherited static
since

11.1

Response

booleanTrue on success, false otherwise.

toString

Converts the object to a string (the class name).

toString() : string
inherited deprecated
since

11.1

deprecated

12.1 Use magic method __toString()

see \JObject::__toString()

Response

string

write

Write session data to the SessionHandler backend.

write(string $id, string $session_data) : boolean
inherited
since

11.1

Arguments

$id

stringThe session identifier.

$session_data

stringThe session data.

Response

booleanTrue on success, false otherwise.

Properties

instances

JSessionStorage instances container.

inherited static
since

11.3

Type(s)

array

_errors

An array of error messages or Exception objects.

inherited deprecated
since

11.1

see \JError
deprecated

12.3 JError has been deprecated

Type(s)

array