Elgg\Http\NativeSessionStorage Class Reference

Inheritance diagram for Elgg\Http\NativeSessionStorage:

Public Member Functions
	__construct (array $options=array(), \Elgg\Http\SessionHandler $handler=null)
	Constructor. More...
	start ()
	{Starts the session. Returns boolean True if started. Exceptions } More...
	regenerate ($destroy=false, $lifetime=null)
	{Regenerates id that represents this storage.This method must invoke session_regenerate_id($destroy) unless this interface is used for a storage object designed for unit or functional testing where a real PHP session would interfere with testing.Note regenerate+destroy should not clear the session data in memory only delete the session data from persistent storage. Parameters boolean $destroy Destroy session when regenerating? integer $lifetime Sets the cookie lifetime for the session cookie. A null value will leave the system settings unchanged, 0 sets the cookie to expire with browser session. Time is in seconds, and is not a Unix timestamp. Returns boolean True if session regenerated, false if error Exceptions } More...
	save ()
	{Force the session to be saved and closed.This method must invoke session_write_close() unless this interface is used for a storage object design for unit or functional testing where a real PHP session would interfere with testing, in which case it it should actually persist the session data if required. Returns void Exceptions } More...
	isStarted ()
	{Checks if the session is started. Returns boolean True if started, false otherwise. } More...
	getId ()
	{Returns the session ID. Returns string The session ID or empty. } More...
	setId ($id)
	{Sets the session ID. Parameters string $id Session string Returns void } More...
	getName ()
	{Returns the session name. Returns string The session name. } More...
	setName ($name)
	{Sets the session name. Parameters string $name Session name. Returns void } More...
	has ($name)
	{Checks if an attribute is defined. Parameters string $name The attribute name Returns boolean } More...
	get ($name, $default=null)
	{Returns an attribute. Parameters string $name The attribute name mixed $default The default value if not found. Returns mixed } More...
	set ($name, $value)
	{Sets an attribute. Parameters string $name Attribute name mixed $value Attribute value Returns void } More...
	all ()
	{Returns all attributes. Returns array Attributes } More...
	replace (array $attributes)
	{Replaces all attributes. Parameters array $attributes Attributes Returns void } More...
	remove ($name)
	{Removes an attribute. Parameters string $name Attribute name Returns mixed The removed value } More...
	clear ()
	{Clears all attributes. Returns void } More...

Protected Member Functions
	setOptions (array $options)
	Sets session. More...
	setHandler ($handler)
	Set the session handler class with PHP. More...

Protected Attributes
	$started = false
	$closed = false

Detailed Description

Definition at line 36 of file NativeSessionStorage.php.

Constructor & Destructor Documentation

__construct()

Elgg\Http\NativeSessionStorage::__construct	(	array	$options = array(),
		\Elgg\Http\SessionHandler	$handler = null
	)

Constructor.

List of options for $options array with their defaults.

See also

http://php.net/session.configuration for options but we omit 'session.' from the beginning of the keys for convenience.

("auto_start", is not supported as it tells PHP to start a session before PHP starts to execute user-land code. Setting during runtime has no effect).

cache_limiter, "nocache" (use "0" to prevent headers from being sent entirely). cookie_domain, "" cookie_httponly, "" cookie_lifetime, "0" cookie_path, "/" cookie_secure, "" entropy_file, "" entropy_length, "0" gc_divisor, "100" gc_maxlifetime, "1440" gc_probability, "1" hash_bits_per_character, "4" hash_function, "0" referer_check, "" serialize_handler, "php" use_cookies, "1" use_only_cookies, "1" use_trans_sid, "0" upload_progress.enabled, "1" upload_progress.cleanup, "1" upload_progress.prefix, "upload_progress_" upload_progress.name, "PHP_SESSION_UPLOAD_PROGRESS" upload_progress.freq, "1%" upload_progress.min-freq, "1"

Parameters

array	$options	Session config options
\Elgg\Http\SessionHandler	$handler	Session handler

Definition at line 82 of file NativeSessionStorage.php.

Member Function Documentation

all()

Elgg\Http\NativeSessionStorage::all

(

)

{Returns all attributes.

Returns

array Attributes

}

Implements Elgg\Http\SessionStorage.

Definition at line 202 of file NativeSessionStorage.php.

clear()

Elgg\Http\NativeSessionStorage::clear

(

)

{Clears all attributes.

Returns

void

}

Implements Elgg\Http\SessionStorage.

Definition at line 241 of file NativeSessionStorage.php.

get()

Elgg\Http\NativeSessionStorage::get	(		$name,
			$default = null
	)

{Returns an attribute.

Parameters

string	$name	The attribute name
mixed	$default	The default value if not found.

Returns

mixed

}

Implements Elgg\Http\SessionStorage.

Definition at line 182 of file NativeSessionStorage.php.

getId()

Elgg\Http\NativeSessionStorage::getId

(

)

{Returns the session ID.

Returns

string The session ID or empty.

}

Implements Elgg\Http\SessionStorage.

Definition at line 135 of file NativeSessionStorage.php.

getName()

Elgg\Http\NativeSessionStorage::getName

(

)

{Returns the session name.

Returns

string The session name.

}

Implements Elgg\Http\SessionStorage.

Definition at line 157 of file NativeSessionStorage.php.

has()

Elgg\Http\NativeSessionStorage::has

(

$name

)

{Checks if an attribute is defined.

Parameters

string

$name

The attribute name

Returns

boolean

}

Implements Elgg\Http\SessionStorage.

Definition at line 171 of file NativeSessionStorage.php.

isStarted()

Elgg\Http\NativeSessionStorage::isStarted

(

)

{Checks if the session is started.

Returns

boolean True if started, false otherwise.

}

Implements Elgg\Http\SessionStorage.

Definition at line 128 of file NativeSessionStorage.php.

regenerate()

Elgg\Http\NativeSessionStorage::regenerate	(		$destroy = false,
			$lifetime = null
	)

{Regenerates id that represents this storage.This method must invoke session_regenerate_id($destroy) unless this interface is used for a storage object designed for unit or functional testing where a real PHP session would interfere with testing.Note regenerate+destroy should not clear the session data in memory only delete the session data from persistent storage.

Parameters

boolean	$destroy	Destroy session when regenerating?
integer	$lifetime	Sets the cookie lifetime for the session cookie. A null value will leave the system settings unchanged, 0 sets the cookie to expire with browser session. Time is in seconds, and is not a Unix timestamp.

Returns

boolean True if session regenerated, false if error

Exceptions

}

Implements Elgg\Http\SessionStorage.

Definition at line 108 of file NativeSessionStorage.php.

remove()

Elgg\Http\NativeSessionStorage::remove

(

$name

)

{Removes an attribute.

Parameters

string

$name

Attribute name

Returns

mixed The removed value

}

Implements Elgg\Http\SessionStorage.

Definition at line 225 of file NativeSessionStorage.php.

replace()

Elgg\Http\NativeSessionStorage::replace

(

array

$attributes

)

{Replaces all attributes.

Parameters

array

$attributes

Attributes

Returns

void

}

Implements Elgg\Http\SessionStorage.

Definition at line 212 of file NativeSessionStorage.php.

save()

Elgg\Http\NativeSessionStorage::save

(

)

{Force the session to be saved and closed.This method must invoke session_write_close() unless this interface is used for a storage object design for unit or functional testing where a real PHP session would interfere with testing, in which case it it should actually persist the session data if required.

Returns

void

Exceptions

}

Implements Elgg\Http\SessionStorage.

Definition at line 119 of file NativeSessionStorage.php.

set()

Elgg\Http\NativeSessionStorage::set	(		$name,
			$value
	)

{Sets an attribute.

Parameters

string	$name	Attribute name
mixed	$value	Attribute value

Returns

void

}

Implements Elgg\Http\SessionStorage.

Definition at line 192 of file NativeSessionStorage.php.

setHandler()

Elgg\Http\NativeSessionStorage::setHandler (   $handler )

protected

Set the session handler class with PHP.

Parameters

\Elgg\Http\SessionHandler

$handler

Handler object

Returns

void

Definition at line 284 of file NativeSessionStorage.php.

setId()

Elgg\Http\NativeSessionStorage::setId

(

$id

)

{Sets the session ID.

Parameters

string

$id

Session string

Returns

void

}

Implements Elgg\Http\SessionStorage.

Definition at line 146 of file NativeSessionStorage.php.

setName()

Elgg\Http\NativeSessionStorage::setName

(

$name

)

{Sets the session name.

Parameters

string

$name

Session name.

Returns

void

}

Implements Elgg\Http\SessionStorage.

Definition at line 164 of file NativeSessionStorage.php.

setOptions()

Elgg\Http\NativeSessionStorage::setOptions ( array  $options )

protected

Sets session.

• ini variables.

For convenience we omit 'session.' from the beginning of the keys. Explicitly ignores other ini keys.

Parameters

array

$options

Session ini directives array(key => value).

Returns

void

See also

http://php.net/session.configuration

Definition at line 258 of file NativeSessionStorage.php.

start()

Elgg\Http\NativeSessionStorage::start

(

)

{Starts the session.

Returns

boolean True if started.

Exceptions

}

Implements Elgg\Http\SessionStorage.

Definition at line 90 of file NativeSessionStorage.php.

Member Data Documentation

$closed

Elgg\Http\NativeSessionStorage::$closed = false

protected

Definition at line 42 of file NativeSessionStorage.php.

$started

Elgg\Http\NativeSessionStorage::$started = false

protected

Definition at line 39 of file NativeSessionStorage.php.

---

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

• engine/classes/Elgg/Http/NativeSessionStorage.php