Zend_Session_Abstract Class Reference

Inheritance diagram for Zend_Session_Abstract:

Data Fields
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.'

Static Protected Member Functions
static	_namespaceIsset ($namespace, $name=null)
static	_namespaceUnset ($namespace, $name=null)
static &	_namespaceGet ($namespace, $name=null)
static	_namespaceGetAll ($namespace)

Static Protected Attributes
static	$_writable = false
static	$_readable = false
static	$_expiringData = array()

Detailed Description

Definition at line 33 of file Abstract.php.

Member Function Documentation

_namespaceGet()

static& _namespaceGet (   $namespace,   $name = null  )

staticprotected

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

Parameters

string	$namespace
string	$name

Returns

mixed

See also

Zend_Session_Exception

Definition at line 140 of file Abstract.php.

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

        if ($name === null) {
            if (isset($_SESSION[$namespace])) { // check session first for data requested
                return $_SESSION[$namespace];
            } elseif (isset(self::$_expiringData[$namespace])) { // check expiring data for data reqeusted
                return self::$_expiringData[$namespace];
            } else {
                return $_SESSION[$namespace]; // satisfy return by reference
            }
        } else {
            if (isset($_SESSION[$namespace][$name])) { // check session first
                return $_SESSION[$namespace][$name];
            } elseif (isset(self::$_expiringData[$namespace][$name])) { // check expiring data
                return self::$_expiringData[$namespace][$name];
            } else {
                return $_SESSION[$namespace][$name]; // satisfy return by reference
            }
        }
    }

_namespaceGetAll()

static _namespaceGetAll (   $namespace )

staticprotected

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

Parameters

string	$namespace
string	$name

Returns

mixed

Definition at line 177 of file Abstract.php.

    {
        $currentData  = (isset($_SESSION[$namespace]) && is_array($_SESSION[$namespace])) ?
            $_SESSION[$namespace] : array();
        $expiringData = (isset(self::$_expiringData[$namespace]) && is_array(self::$_expiringData[$namespace])) ?
            self::$_expiringData[$namespace] : array();
        return array_merge($currentData, $expiringData);
    }

_namespaceIsset()

static _namespaceIsset (   $namespace,   $name = null  )

staticprotected

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

Parameters

string	$namespace
string	$name

Returns

bool

See also

Zend_Session_Exception

Definition at line 79 of file Abstract.php.

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

        if ($name === null) {
            return ( isset($_SESSION[$namespace]) || isset(self::$_expiringData[$namespace]) );
        } else {
            return ( isset($_SESSION[$namespace][$name]) || isset(self::$_expiringData[$namespace][$name]) );
        }
    }

_namespaceUnset()

static _namespaceUnset (   $namespace,   $name = null  )

staticprotected

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

Parameters

string	$namespace
string	$name

Exceptions

Zend_Session_Exception

Returns

void

See also

Zend_Session_Exception

Definition at line 105 of file Abstract.php.

    {
        if (self::$_writable === false) {
            #require_once 'Zend/Session/Exception.php';
            throw new Zend_Session_Exception(self::_THROW_NOT_WRITABLE_MSG);
        }

        $name = (string) $name;

        // check to see if the api wanted to remove a var from a namespace or a namespace
        if ($name === '') {
            unset($_SESSION[$namespace]);
            unset(self::$_expiringData[$namespace]);
        } else {
            unset($_SESSION[$namespace][$name]);
            unset(self::$_expiringData[$namespace][$name]);
        }

        // if we remove the last value, remove namespace.
        if (empty($_SESSION[$namespace])) {
            unset($_SESSION[$namespace]);
        }
    }

Field Documentation

$_expiringData

$_expiringData = array()

staticprotected

Definition at line 55 of file Abstract.php.

$_readable

$_readable = false

staticprotected

Definition at line 47 of file Abstract.php.

$_writable

$_writable = false

staticprotected

Definition at line 40 of file Abstract.php.

_THROW_NOT_READABLE_MSG

const _THROW_NOT_READABLE_MSG = 'Zend_Session is not marked as readable.'

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

Definition at line 69 of file Abstract.php.

_THROW_NOT_WRITABLE_MSG

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

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

Definition at line 62 of file Abstract.php.

---

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

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