Zend_Session Class Reference

Inheritance diagram for Zend_Session:

Static Public Member Functions
static	setOptions (array $userOptions=array())
static	getOptions ($optionName=null)
static	setSaveHandler (Zend_Session_SaveHandler_Interface $saveHandler)
static	getSaveHandler ()
static	regenerateId ()
static	rememberMe ($seconds=null)
static	forgetMe ()
static	rememberUntil ($seconds=0)
static	sessionExists ()
static	isDestroyed ()
static	start ($options=false)
static	isStarted ()
static	isRegenerated ()
static	getId ()
static	setId ($id)
static	registerValidator (Zend_Session_Validator_Interface $validator)
static	stop ()
static	writeClose ($readonly=true)
static	destroy ($remove_cookie=true, $readonly=true)
static	expireSessionCookie ()
static	namespaceIsset ($namespace)
static	namespaceUnset ($namespace)
static	namespaceGet ($namespace)
static	getIterator ()
static	isWritable ()
static	isReadable ()

Static Public Attributes
static	$_unitTestEnabled = false

Protected Member Functions
	__construct ()

Static Protected Member Functions
static	_checkId ($id)
Static Protected Member Functions inherited from Zend_Session_Abstract
static	_namespaceIsset ($namespace, $name=null)
static	_namespaceUnset ($namespace, $name=null)
static &	_namespaceGet ($namespace, $name=null)
static	_namespaceGetAll ($namespace)

Static Protected Attributes
static	$_throwStartupExceptions = true
Static Protected Attributes inherited from Zend_Session_Abstract
static	$_writable = false
static	$_readable = false
static	$_expiringData = array()

Additional Inherited Members
Data Fields inherited from Zend_Session_Abstract
const	_THROW_NOT_WRITABLE_MSG = 'Zend_Session is currently marked as read-only.'
const	_THROW_NOT_READABLE_MSG = 'Zend_Session is not marked as readable.'

Detailed Description

Definition at line 49 of file Session.php.

Constructor & Destructor Documentation

__construct()

__construct ( )

protected

Constructor overriding - make sure that a developer cannot instantiate

Definition at line 187 of file Session.php.

    {
    }

Member Function Documentation

_checkId()

static _checkId (   $id )

staticprotected

Perform a hash-bits check on the session ID

Parameters

string

$id

Session ID

Returns

bool

Definition at line 521 of file Session.php.

    {
        $saveHandler = ini_get('session.save_handler');
        if ($saveHandler == 'cluster') { // Zend Server SC, validate only after last dash
            $dashPos = strrpos($id, '-');
            if ($dashPos) {
                $id = substr($id, $dashPos + 1);
            }
        }

        $hashBitsPerChar = ini_get('session.hash_bits_per_character');
        if (!$hashBitsPerChar) {
            $hashBitsPerChar = 5; // the default value
        }
        switch($hashBitsPerChar) {
            case 4: $pattern = '^[0-9a-f]*$'; break;
            case 5: $pattern = '^[0-9a-v]*$'; break;
            case 6: $pattern = '^[0-9a-zA-Z-,]*$'; break;
        }
        return preg_match('#'.$pattern.'#', $id);
    }

destroy()

static destroy (   $remove_cookie = true,   $readonly = true  )

static

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

Parameters

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

Returns

void

Definition at line 744 of file Session.php.

    {
        if (self::$_unitTestEnabled) {
            return;
        }

        if (self::$_destroyed) {
            return;
        }

        if ($readonly) {
            parent::$_writable = false;
        }

        session_destroy();
        self::$_destroyed = true;

        if ($remove_cookie) {
            self::expireSessionCookie();
        }
    }

expireSessionCookie()

static expireSessionCookie ( )

static

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

Returns

void

Definition at line 772 of file Session.php.

    {
        if (self::$_unitTestEnabled) {
            return;
        }

        if (self::$_sessionCookieDeleted) {
            return;
        }

        self::$_sessionCookieDeleted = true;

        if (isset($_COOKIE[session_name()])) {
            $cookie_params = session_get_cookie_params();

            setcookie(
                session_name(),
                false,
                315554400, // strtotime('1980-01-01'),
                $cookie_params['path'],
                $cookie_params['domain'],
                $cookie_params['secure']
                );
        }
    }

forgetMe()

static forgetMe ( )

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.

Returns

void

Definition at line 350 of file Session.php.

    {
        self::rememberUntil(0);
    }

getId()

static getId ( )

static

getId() - get the current session id

Returns

string

Definition at line 649 of file Session.php.

    {
        return session_id();
    }

getIterator()

static getIterator ( )

static

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

Exceptions

Zend_Session_Exception

Returns

ArrayObject

See also

Zend_Session_Exception

Definition at line 868 of file Session.php.

    {
        if (parent::$_readable === false) {
            #require_once 'Zend/Session/Exception.php';
            throw new Zend_Session_Exception(parent::_THROW_NOT_READABLE_MSG);
        }

        $spaces  = array();
        if (isset($_SESSION)) {
            $spaces = array_keys($_SESSION);
            foreach($spaces as $key => $space) {
                if (!strncmp($space, '__', 2) || !is_array($_SESSION[$space])) {
                    unset($spaces[$key]);
                }
            }
        }

        return new ArrayObject(array_merge($spaces, array_keys(parent::$_expiringData)));
    }

getOptions()

static getOptions (   $optionName = null )

static

getOptions()

Parameters

string

$optionName

OPTIONAL

Returns

array|string

Definition at line 238 of file Session.php.

    {
        $options = array();
        foreach (ini_get_all('session') as $sysOptionName => $sysOptionValues) {
            $options[substr($sysOptionName, 8)] = $sysOptionValues['local_value'];
        }
        foreach (self::$_localOptions as $localOptionName => $localOptionMemberName) {
            $options[$localOptionName] = self::${$localOptionMemberName};
        }

        if ($optionName) {
            if (array_key_exists($optionName, $options)) {
                return $options[$optionName];
            }
            return null;
        }

        return $options;
    }

getSaveHandler()

static getSaveHandler ( )

static

getSaveHandler() - Get the session Save Handler

Returns

Zend_Session_SaveHandler_Interface

Definition at line 293 of file Session.php.

    {
        return self::$_saveHandler;
    }

isDestroyed()

static isDestroyed ( )

static

Whether or not session has been destroyed via session_destroy()

Returns

bool

Definition at line 408 of file Session.php.

    {
        return self::$_destroyed;
    }

isReadable()

static isReadable ( )

static

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

Returns

bool

Definition at line 906 of file Session.php.

    {
        return parent::$_readable;
    }

isRegenerated()

static isRegenerated ( )

static

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

Returns

bool

Definition at line 638 of file Session.php.

    {
        return ( (self::$_regenerateIdState > 0) ? true : false );
    }

isStarted()

static isStarted ( )

static

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

Returns

bool

Definition at line 626 of file Session.php.

    {
        return self::$_sessionStarted;
    }

isWritable()

static isWritable ( )

static

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

Returns

bool

Definition at line 895 of file Session.php.

    {
        return parent::$_writable;
    }

namespaceGet()

static namespaceGet (   $namespace )

static

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

Parameters

string

$namespace

Returns

array

Definition at line 855 of file Session.php.

    {
        return parent::_namespaceGetAll($namespace);
    }

namespaceIsset()

static namespaceIsset (   $namespace )

static

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

Parameters

string

$namespace

Returns

bool

Definition at line 828 of file Session.php.

    {
        return parent::_namespaceIsset($namespace);
    }

namespaceUnset()

static namespaceUnset (   $namespace )

static

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

Parameters

string

$namespace

Exceptions

Zend_Session_Exception

Returns

void

Definition at line 841 of file Session.php.

    {
        parent::_namespaceUnset($namespace);
        Zend_Session_Namespace::resetSingleInstance($namespace);
    }

regenerateId()

static regenerateId ( )

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.

Exceptions

Zend_Session_Exception

Returns

void

See also

Zend_Session_Exception

Definition at line 307 of file Session.php.

    {
        if (!self::$_unitTestEnabled && headers_sent($filename, $linenum)) {
            #require_once 'Zend/Session/Exception.php';
            throw new Zend_Session_Exception("You must call " . __CLASS__ . '::' . __FUNCTION__ .
                "() before any output has been sent to the browser; output started in {$filename}/{$linenum}");
        }

        if ( !self::$_sessionStarted ) {
            self::$_regenerateIdState = -1;
        } else {
            if (!self::$_unitTestEnabled) {
                session_regenerate_id(true);
            }
            self::$_regenerateIdState = 1;
        }
    }

registerValidator()

static registerValidator ( Zend_Session_Validator_Interface  $validator )

static

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

Parameters

Zend_Session_Validator_Interface

$validator

Returns

void

Definition at line 694 of file Session.php.

    {
        $validator->setup();
    }

rememberMe()

static rememberMe (   $seconds = null )

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

int

$seconds

OPTIONAL specifies TTL for cookie in seconds from present time

Returns

void

Definition at line 335 of file Session.php.

    {
        $seconds = (int) $seconds;
        $seconds = ($seconds > 0) ? $seconds : self::$_rememberMeSeconds;

        self::rememberUntil($seconds);
    }

rememberUntil()

static rememberUntil (   $seconds = 0 )

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

int

$seconds

Returns

void

Definition at line 363 of file Session.php.

    {
        if (self::$_unitTestEnabled) {
            self::regenerateId();
            return;
        }

        $cookieParams = session_get_cookie_params();

        session_set_cookie_params(
            $seconds,
            $cookieParams['path'],
            $cookieParams['domain'],
            $cookieParams['secure']
            );

        // normally "rememberMe()" represents a security context change, so should use new session id
        self::regenerateId();
    }

sessionExists()

static sessionExists ( )

static

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

Returns

bool

Definition at line 389 of file Session.php.

    {
        if ((bool)ini_get('session.use_cookies') == true && isset($_COOKIE[session_name()])) {
            return true;
        } elseif ((bool)ini_get('session.use_only_cookies') == false && isset($_REQUEST[session_name()])) {
            return true;
        } elseif (self::$_unitTestEnabled) {
            return true;
        }

        return false;
    }

setId()

static setId (   $id )

static

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

Exceptions

Zend_Session_Exception

Parameters

string

$id

Returns

void

See also

Zend_Session_Exception

Zend_Session_Exception

Zend_Session_Exception

Definition at line 662 of file Session.php.

    {
        if (!self::$_unitTestEnabled && defined('SID')) {
            #require_once 'Zend/Session/Exception.php';
            throw new Zend_Session_Exception('The session has already been started.  The session id must be set first.');
        }

        if (!self::$_unitTestEnabled && headers_sent($filename, $linenum)) {
            #require_once 'Zend/Session/Exception.php';
            throw new Zend_Session_Exception("You must call ".__CLASS__.'::'.__FUNCTION__.
                "() before any output has been sent to the browser; output started in {$filename}/{$linenum}");
        }

        if (!is_string($id) || $id === '') {
            #require_once 'Zend/Session/Exception.php';
            throw new Zend_Session_Exception('You must provide a non-empty string as a session identifier.');
        }

        session_id($id);
    }

setOptions()

static setOptions ( array  $userOptions = array() )

static

setOptions - set both the class specified

Parameters

array

$userOptions

- pass-by-keyword style array of <option name, option value> pairs

Exceptions

Zend_Session_Exception

Returns

void

See also

Zend_Session_Exception

Definition at line 199 of file Session.php.

    {
        // set default options on first run only (before applying user settings)
        if (!self::$_defaultOptionsSet) {
            foreach (self::$_defaultOptions as $defaultOptionName => $defaultOptionValue) {
                if (isset(self::$_defaultOptions[$defaultOptionName])) {
                    ini_set("session.$defaultOptionName", $defaultOptionValue);
                }
            }

            self::$_defaultOptionsSet = true;
        }

        // set the options the user has requested to set
        foreach ($userOptions as $userOptionName => $userOptionValue) {

            $userOptionName = strtolower($userOptionName);

            // set the ini based values
            if (array_key_exists($userOptionName, self::$_defaultOptions)) {
                ini_set("session.$userOptionName", $userOptionValue);
            }
            elseif (isset(self::$_localOptions[$userOptionName])) {
                self::${self::$_localOptions[$userOptionName]} = $userOptionValue;
            }
            else {
                #require_once 'Zend/Session/Exception.php';
                throw new Zend_Session_Exception("Unknown option: $userOptionName = $userOptionValue");
            }
        }
    }

setSaveHandler()

static setSaveHandler ( Zend_Session_SaveHandler_Interface  $saveHandler )

static

setSaveHandler() - Session Save Handler assignment

Parameters

Zend_Session_SaveHandler_Interface

$interface

Exceptions

Zend_Session_Exception

When the session_set_save_handler call fails

Returns

void

Definition at line 265 of file Session.php.

    {
        self::$_saveHandler = $saveHandler;

        if (self::$_unitTestEnabled) {
            return;
        }

        $result = session_set_save_handler(
            array(&$saveHandler, 'open'),
            array(&$saveHandler, 'close'),
            array(&$saveHandler, 'read'),
            array(&$saveHandler, 'write'),
            array(&$saveHandler, 'destroy'),
            array(&$saveHandler, 'gc')
            );

        if (!$result) {
            throw new Zend_Session_Exception('Unable to set session handler');
        }
    }

start()

static start (   $options = false )

static

start() - Start the session.

Parameters

bool | array

$options

OPTIONAL Either user supplied options, or flag indicating if start initiated automatically

Exceptions

Zend_Session_Exception

Returns

void

See also

Zend_Session_Exception

Zend_Session_Exception

Zend_Session_Exception

Hack to throw exceptions on start instead of php errors

See also

http://framework.zend.com/issues/browse/ZF-1325

Zend_Session_Exception

Definition at line 421 of file Session.php.

    {
        // Check to see if we've been passed an invalid session ID
        if ( self::getId() && !self::_checkId(self::getId()) ) {
            // Generate a valid, temporary replacement
            self::setId(md5(self::getId()));
            // Force a regenerate after session is started
            self::$_regenerateIdState = -1;
        }

        if (self::$_sessionStarted && self::$_destroyed) {
            #require_once 'Zend/Session/Exception.php';
            throw new Zend_Session_Exception('The session was explicitly destroyed during this request, attempting to re-start is not allowed.');
        }

        if (self::$_sessionStarted) {
            return; // already started
        }

        // make sure our default options (at the least) have been set
        if (!self::$_defaultOptionsSet) {
            self::setOptions(is_array($options) ? $options : array());
        }

        // In strict mode, do not allow auto-starting Zend_Session, such as via "new Zend_Session_Namespace()"
        if (self::$_strict && $options === true) {
            #require_once 'Zend/Session/Exception.php';
            throw new Zend_Session_Exception('You must explicitly start the session with Zend_Session::start() when session options are set to strict.');
        }

        $filename = $linenum = null;
        if (!self::$_unitTestEnabled && headers_sent($filename, $linenum)) {
            #require_once 'Zend/Session/Exception.php';
            throw new Zend_Session_Exception("Session must be started before any output has been sent to the browser;"
               . " output started in {$filename}/{$linenum}");
        }

        // See http://www.php.net/manual/en/ref.session.php for explanation
        if (!self::$_unitTestEnabled && defined('SID')) {
            #require_once 'Zend/Session/Exception.php';
            throw new Zend_Session_Exception('session has already been started by session.auto-start or session_start()');
        }

        $errorLevel = (is_int(self::$_throwStartupExceptions)) ? self::$_throwStartupExceptions : E_ALL;

        if (!self::$_unitTestEnabled) {

            if (self::$_throwStartupExceptions) {
                #require_once 'Zend/Session/Exception.php';
                set_error_handler(array('Zend_Session_Exception', 'handleSessionStartError'), $errorLevel);
            }

            $startedCleanly = session_start();

            if (self::$_throwStartupExceptions) {
                restore_error_handler();
            }

            if (!$startedCleanly || Zend_Session_Exception::$sessionStartError != null) {
                if (self::$_throwStartupExceptions) {
                    set_error_handler(array('Zend_Session_Exception', 'handleSilentWriteClose'), $errorLevel);
                }
                session_write_close();
                if (self::$_throwStartupExceptions) {
                    restore_error_handler();
                    throw new Zend_Session_Exception(__CLASS__ . '::' . __FUNCTION__ . '() - ' . Zend_Session_Exception::$sessionStartError);
                }
            }
        }

        parent::$_readable = true;
        parent::$_writable = true;
        self::$_sessionStarted = true;
        if (self::$_regenerateIdState === -1) {
            self::regenerateId();
        }

        // run validators if they exist
        if (isset($_SESSION['__ZF']['VALID'])) {
            self::_processValidators();
        }

        self::_processStartupMetadataGlobal();
    }

stop()

static stop ( )

static

stop() - Disable write access. Optionally disable read (not implemented).

Returns

void

Definition at line 705 of file Session.php.

    {
        parent::$_writable = false;
    }

writeClose()

static writeClose (   $readonly = true )

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

bool

$readonly

- OPTIONAL remove write access (i.e. throw error if Zend_Session's attempt writes)

Returns

void

Definition at line 718 of file Session.php.

    {
        if (self::$_unitTestEnabled) {
            return;
        }

        if (self::$_writeClosed) {
            return;
        }

        if ($readonly) {
            parent::$_writable = false;
        }

        session_write_close();
        self::$_writeClosed = true;
    }

Field Documentation

$_throwStartupExceptions

$_throwStartupExceptions = true

staticprotected

Definition at line 64 of file Session.php.

$_unitTestEnabled

$_unitTestEnabled = false

static

Whether or not Zend_Session is being used with unit tests

Definition at line 57 of file Session.php.

---

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

• vendor/magento/zendframework1/library/Zend/Session.php