Session.php

Show:

inherited

Classes
- \Zend_Session

Table of Contents

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to [email protected] so we can send you a copy immediately.

Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Session
Since: Preview Release 0.2
Version: $Id: Session.php 25121 2012-11-13 21:51:23Z matthew $

\Zend_Session
jump to top

Package: Zend\Session

Zend_Session

Parent(s): \Zend_Session_Abstract
Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Constants

 
                _THROW_NOT_WRITABLE_MSG
                = 'Zend_Session is currently marked as read-only.'

inherited

Error message thrown when an action requires modification, but current Zend_Session has been marked as read-only.

Inherited from: \Zend_Session_Abstract::_THROW_NOT_WRITABLE_MSG

Inherited_from: \Zend_Session_Abstract::_THROW_NOT_WRITABLE_MSG

 
                _THROW_NOT_READABLE_MSG
                = 'Zend_Session is not marked as readable.'

inherited

Error message thrown when an action requires reading session data, but current Zend_Session is not marked as readable.

Inherited from: \Zend_Session_Abstract::_THROW_NOT_READABLE_MSG

Inherited_from: \Zend_Session_Abstract::_THROW_NOT_READABLE_MSG

Properties

array $_defaultOptions = array('save_path' => null, 'name' => null, 'save_handler' => null, 'gc_probability' => null, 'gc_divisor' => null, 'gc_maxlifetime' => null, 'serialize_handler' => null, 'cookie_lifetime' => null, 'cookie_path' => null, 'cookie_domain' => null, 'cookie_secure' => null, 'cookie_httponly' => null, 'use_cookies' => null, 'use_only_cookies' => 'on', 'referer_check' => null, 'entropy_file' => null, 'entropy_length' => null, 'cache_limiter' => null, 'cache_expire' => null, 'use_trans_sid' => null, 'bug_compat_42' => null, 'bug_compat_warn' => null, 'hash_function' => null, 'hash_bits_per_character' => null)

static

Private list of php's ini values for ext/session null values will default to the php.ini value, otherwise the value below will overwrite the default ini value, unless the user has set an option explicity with setOptions()

Default value

array('save_path' => null, 'name' => null, 'save_handler' => null, 'gc_probability' => null, 'gc_divisor' => null, 'gc_maxlifetime' => null, 'serialize_handler' => null, 'cookie_lifetime' => null, 'cookie_path' => null, 'cookie_domain' => null, 'cookie_secure' => null, 'cookie_httponly' => null, 'use_cookies' => null, 'use_only_cookies' => 'on', 'referer_check' => null, 'entropy_file' => null, 'entropy_length' => null, 'cache_limiter' => null, 'cache_expire' => null, 'use_trans_sid' => null, 'bug_compat_42' => null, 'bug_compat_warn' => null, 'hash_function' => null, 'hash_bits_per_character' => null)

Details

Type: array

bool $_defaultOptionsSet = false

static

Whether the default options listed in Zend_Session::$_localOptions have been set

Default valuefalseDetails

Type: bool

bool $_destroyed = false

static

Whether or not session has been destroyed via session_destroy()

Default valuefalseDetails

Type: bool

array $_expiringData = array()

staticinherited

Since expiring data is handled at startup to avoid __destruct difficulties, the data that will be expiring at end of this request is held here

Inherited from: \Zend_Session_Abstract::$$_expiringData

Default valuearray()Details

Type: array
Inherited_from: \Zend_Session_Abstract::$$_expiringData

array $_localOptions = array('strict' => '_strict', 'remember_me_seconds' => '_rememberMeSeconds', 'throw_startup_exceptions' => '_throwStartupExceptions')

static

List of options pertaining to Zend_Session that can be set by developers using Zend_Session::setOptions().

This list intentionally duplicates the individual declaration of static "class" variables by the same names.

Default value

array('strict' => '_strict', 'remember_me_seconds' => '_rememberMeSeconds', 'throw_startup_exceptions' => '_throwStartupExceptions')

Details

Type: array

bool $_readable = false

staticinherited

Whether or not session permits reading (reading data in $_SESSION[])

Inherited from: \Zend_Session_Abstract::$$_readable

Default valuefalseDetails

Type: bool
Inherited_from: \Zend_Session_Abstract::$$_readable

int $_regenerateIdState = 0

static

Whether or not the session id has been regenerated this request.

Id regeneration state <0 - regenerate requested when session is started 0 - do nothing

0 - already called session_regenerate_id()

Default value0Details

Type: int

int $_rememberMeSeconds = 1209600

static

Default number of seconds the session will be remembered for when asked to be remembered

Default value1209600Details

Type: int

\Zend_Session_SaveHandler_Interface $_saveHandler = null

static

A reference to the set session save handler

Default valuenullDetails

Type: \Zend_Session_SaveHandler_Interface

bool $_sessionCookieDeleted = false

static

Whether or not session id cookie has been deleted

Default valuefalseDetails

Type: bool

bool $_sessionStarted = false

static

Check whether or not the session was started

Default valuefalseDetails

Type: bool

bool $_strict = false

static

Whether or not session must be initiated before usage

Default valuefalseDetails

Type: bool

bool|\bitset $_throwStartupExceptions = true

static

$_throwStartupException

<p>This could also be a combiniation of error codes to catch</p>

Default valuetrueDetails

Type: bool | \bitset

bool $_writable = false

staticinherited

Whether or not session permits writing (modification of $_SESSION[])

Inherited from: \Zend_Session_Abstract::$$_writable

Default valuefalseDetails

Type: bool
Inherited_from: \Zend_Session_Abstract::$$_writable

bool $_writeClosed = false

static

Whether or not write close has been performed.

Default valuefalseDetails

Type: bool

Methods

__construct() : void

Constructor overriding - make sure that a developer cannot instantiate

_checkId(string $id) : bool

static

Perform a hash-bits check on the session ID

Parameters

Name	Type	Description
$id	string	Session ID

Returns

Type	Description
bool

_namespaceGet(string $namespace, string $name = null) : mixed

staticinherited

namespaceGet() - Get $name variable from $namespace, returning by reference.

Inherited from: \Zend_Session_Abstract::_namespaceGet()

Parameters

Name	Type	Description
$namespace	string
$name	string

Returns

Type	Description
mixed

_namespaceGetAll(string $namespace) : mixed

staticinherited

namespaceGetAll() - Get an array containing $namespace, including expiring data.

Inherited from: \Zend_Session_Abstract::_namespaceGetAll()

Parameters

Name	Type	Description
$namespace	string

Returns

Type	Description
mixed

_namespaceIsset(string $namespace, string $name = null) : bool

staticinherited

namespaceIsset() - check to see if a namespace or a variable within a namespace is set

Inherited from: \Zend_Session_Abstract::_namespaceIsset()

Parameters

Name	Type	Description
$namespace	string
$name	string

Returns

Type	Description
bool

_namespaceUnset(string $namespace, string $name = null) : void

staticinherited

namespaceUnset() - unset a namespace or a variable within a namespace

Inherited from: \Zend_Session_Abstract::_namespaceUnset()

Parameters

Name	Type	Description
$namespace	string
$name	string

Throws

Exception	Description
\Zend_Session_Exception

_processStartupMetadataGlobal() : void

static

_processGlobalMetadata() - this method initizes the sessions GLOBAL metadata, mostly global data expiration calculations.

_processValidators() : void

static

_processValidator() - internal function that is called in the existence of VALID metadata

Throws

Exception	Description
\Zend_Session_Exception

destroy(bool $remove_cookie = true, bool $readonly = true) : void

static

destroy() - This is used to destroy session data, and optionally, the session cookie itself

Parameters

Name	Type	Description
$remove_cookie	bool	OPTIONAL remove session id cookie, defaults to true (remove cookie)
$readonly	bool	OPTIONAL remove write access (i.e. throw error if Zend_Session's attempt writes)

expireSessionCookie() : void

static

expireSessionCookie() - Sends an expired session id cookie, causing the client to delete the session cookie

forgetMe() : void

static

forgetMe() - Write a volatile session cookie, removing any persistent cookie that may have existed.

The session would end upon, for example, termination of a web browser program.

getId() : string

static

getId() - get the current session id

Returns

Type	Description
string

getIterator() : \ArrayObject

static

getIterator() - return an iteratable object for use in foreach and the like, this completes the IteratorAggregate interface

Returns

Type	Description
\ArrayObject

Throws

Exception	Description
\Zend_Session_Exception

getOptions(string $optionName = null) : array | string

static

getOptions()

Parameters

Name	Type	Description
$optionName	string	OPTIONAL

Returns

Type	Description
array \| string

getSaveHandler() : \Zend_Session_SaveHandler_Interface

static

getSaveHandler() - Get the session Save Handler

Returns

Type	Description
\Zend_Session_SaveHandler_Interface

isDestroyed() : bool

static

Whether or not session has been destroyed via session_destroy()

Returns

Type	Description
bool

isReadable() : bool

static

isReadable() - returns a boolean indicating if namespaces can write (use setters)

Returns

Type	Description
bool

isRegenerated() : bool

static

isRegenerated() - convenience method to determine if session_regenerate_id() has been called during this request by Zend_Session.

Returns

Type	Description
bool

isStarted() : bool

static

isStarted() - convenience method to determine if the session is already started.

Returns

Type	Description
bool

isWritable() : bool

static

isWritable() - returns a boolean indicating if namespaces can write (use setters)

Returns

Type	Description
bool

namespaceGet(string $namespace) : array

static

namespaceGet() - get all variables in a namespace Deprecated: Use getIterator() in Zend_Session_Namespace.

Parameters

Name	Type	Description
$namespace	string

Returns

Type	Description
array

namespaceIsset(string $namespace) : bool

static

namespaceIsset() - check to see if a namespace is set

Parameters

Name	Type	Description
$namespace	string

Returns

Type	Description
bool

namespaceUnset(string $namespace) : void

static

namespaceUnset() - unset a namespace or a variable within a namespace

Parameters

Name	Type	Description
$namespace	string

Throws

Exception	Description
\Zend_Session_Exception

regenerateId() : void

static

regenerateId() - Regenerate the session id.

Best practice is to call this after session is started. If called prior to session starting, session id will be regenerated at start time.

Throws

Exception	Description
\Zend_Session_Exception

registerValidator(\Zend_Session_Validator_Interface $validator) : void

static

registerValidator() - register a validator that will attempt to validate this session for every future request

Parameters

Name	Type	Description
$validator	\Zend_Session_Validator_Interface

rememberMe(int $seconds = null) : void

static

rememberMe() - Write a persistent cookie that expires after a number of seconds in the future.

If no number of seconds is specified, then this defaults to self::$_rememberMeSeconds. Due to clock errors on end users' systems, large values are recommended to avoid undesirable expiration of session cookies.

Parameters

Name	Type	Description
$seconds	int	OPTIONAL specifies TTL for cookie in seconds from present time

rememberUntil(int $seconds = 0) : void

static

rememberUntil() - This method does the work of changing the state of the session cookie and making sure that it gets resent to the browser via regenerateId()

Parameters

Name	Type	Description
$seconds	int

sessionExists() : bool

static

sessionExists() - whether or not a session exists for the current request

Returns

Type	Description
bool

setId(string $id) : void

static

setId() - set an id to a user specified id

Parameters

Name	Type	Description
$id	string

Throws

Exception	Description
\Zend_Session_Exception

setOptions(array $userOptions = array()) : void

static

setOptions - set both the class specified

Parameters

Name	Type	Description
$userOptions	array	pass-by-keyword style array of

Throws

Exception	Description
\Zend_Session_Exception

setSaveHandler( $saveHandler) : void

static

setSaveHandler() - Session Save Handler assignment

Parameters

Name	Type	Description
$saveHandler

start(bool | array $options = false) : void

static

start() - Start the session.

Parameters

Name	Type	Description
$options	bool \| array	OPTIONAL Either user supplied options, or flag indicating if start initiated automatically

Throws

Exception	Description
\Zend_Session_Exception

stop() : void

static

stop() - Disable write access.

Optionally disable read (not implemented).

writeClose(bool $readonly = true) : void

static

writeClose() - Shutdown the sesssion, close writing and detach $_SESSION from the back-end storage mechanism.

This will complete the internal data transformation on this request.

Parameters

Name	Type	Description
$readonly	bool	OPTIONAL remove write access (i.e. throw error if Zend_Session's attempt writes)

Session.php

\Zend_Sessionjump to top

Constants

Properties

Methods

\Zend_Session
jump to top