Zend_Session_Namespace Class Reference

Inheritance diagram for Zend_Session_Namespace:

Public Member Functions
	__construct ($namespace='Default', $singleInstance=false)
	getIterator ()
	lock ()
	unlock ()
	isLocked ()
	unsetAll ()
&	__get ($name)
	__set ($name, $value)
	apply ($callback)
	applySet ($callback)
	__isset ($name)
	__unset ($name)
	setExpirationSeconds ($seconds, $variables=null)
	setExpirationHops ($hops, $variables=null, $hopCountOnUsageOnly=false)
	getNamespace ()

Static Public Member Functions
static	resetSingleInstance ($namespaceName=null)
static	unlockAll ()

Data Fields
const	SINGLE_INSTANCE = true
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.'

Protected Attributes
	$_namespace = "Default"

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

Additional Inherited Members
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)

Detailed Description

Definition at line 44 of file Namespace.php.

Constructor & Destructor Documentation

__construct()

__construct	(		$namespace = 'Default',
			$singleInstance = false
	)

__construct() - Returns an instance object bound to a particular, isolated section of the session, identified by $namespace name (defaulting to 'Default'). The optional argument $singleInstance will prevent construction of additional instance objects acting as accessors to this $namespace.

Parameters

string	$namespace	- programmatic name of the requested namespace
bool	$singleInstance	- prevent creation of additional accessor instance objects for this namespace

Returns

void

See also

Zend_Session_Exception

Zend_Session_Exception

Zend_Session_Exception

Zend_Session_Exception

Zend_Session_Exception

Definition at line 102 of file Namespace.php.

    {
        if ($namespace === '') {
            #require_once 'Zend/Session/Exception.php';
            throw new Zend_Session_Exception('Session namespace must be a non-empty string.');
        }

        if ($namespace[0] == "_") {
            #require_once 'Zend/Session/Exception.php';
            throw new Zend_Session_Exception('Session namespace must not start with an underscore.');
        }

        if (preg_match('#(^[0-9])#i', $namespace[0])) {
            #require_once 'Zend/Session/Exception.php';
            throw new Zend_Session_Exception('Session namespace must not start with a number.');
        }

        if (isset(self::$_singleInstances[$namespace])) {
            #require_once 'Zend/Session/Exception.php';
            throw new Zend_Session_Exception("A session namespace object already exists for this namespace ('$namespace'), and no additional accessors (session namespace objects) for this namespace are permitted.");
        }

        if ($singleInstance === true) {
            self::$_singleInstances[$namespace] = true;
        }

        $this->_namespace = $namespace;

        // Process metadata specific only to this namespace.
        Zend_Session::start(true); // attempt auto-start (throws exception if strict option set)

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

        if (!isset($_SESSION['__ZF'])) {
            return; // no further processing needed
        }

        // do not allow write access to namespaces, after stop() or writeClose()
        if (parent::$_writable === true) {
            if (isset($_SESSION['__ZF'][$namespace])) {

                // Expire Namespace by Namespace Hop (ENNH)
                if (isset($_SESSION['__ZF'][$namespace]['ENNH'])) {
                    $_SESSION['__ZF'][$namespace]['ENNH']--;

                    if ($_SESSION['__ZF'][$namespace]['ENNH'] === 0) {
                        if (isset($_SESSION[$namespace])) {
                            self::$_expiringData[$namespace] = $_SESSION[$namespace];
                            unset($_SESSION[$namespace]);
                        }
                        unset($_SESSION['__ZF'][$namespace]);
                    }
                }

                // Expire Namespace Variables by Namespace Hop (ENVNH)
                if (isset($_SESSION['__ZF'][$namespace]['ENVNH'])) {
                    foreach ($_SESSION['__ZF'][$namespace]['ENVNH'] as $variable => $hops) {
                        $_SESSION['__ZF'][$namespace]['ENVNH'][$variable]--;

                        if ($_SESSION['__ZF'][$namespace]['ENVNH'][$variable] === 0) {
                            if (isset($_SESSION[$namespace][$variable])) {
                                self::$_expiringData[$namespace][$variable] = $_SESSION[$namespace][$variable];
                                unset($_SESSION[$namespace][$variable]);
                            }
                            unset($_SESSION['__ZF'][$namespace]['ENVNH'][$variable]);
                        }
                    }
                    if(empty($_SESSION['__ZF'][$namespace]['ENVNH'])) {
                        unset($_SESSION['__ZF'][$namespace]['ENVNH']);
                    }
                }
            }

            if (empty($_SESSION['__ZF'][$namespace])) {
                unset($_SESSION['__ZF'][$namespace]);
            }

            if (empty($_SESSION['__ZF'])) {
                unset($_SESSION['__ZF']);
            }
        }
    }

Member Function Documentation

__get()

& __get

(

$name

)

__get() - method to get a variable in this object's current namespace

Parameters

string

$name

- programmatic name of a key, in a <key,value> pair in the current namespace

Returns

mixed

See also

Zend_Session_Exception

Definition at line 277 of file Namespace.php.

    {
        if ($name === '') {
            #require_once 'Zend/Session/Exception.php';
            throw new Zend_Session_Exception("The '$name' key must be a non-empty string");
        }

        return parent::_namespaceGet($this->_namespace, $name);
    }

__isset()

__isset

(

$name

)

__isset() - determine if a variable in this object's namespace is set

Parameters

string

$name

- programmatic name of a key, in a <key,value> pair in the current namespace

Returns

bool

See also

Zend_Session_Exception

Definition at line 384 of file Namespace.php.

    {
        if ($name === '') {
            #require_once 'Zend/Session/Exception.php';
            throw new Zend_Session_Exception("The '$name' key must be a non-empty string");
        }

        return parent::_namespaceIsset($this->_namespace, $name);
    }

__set()

__set	(		$name,
			$value
	)

__set() - method to set a variable/value in this object's namespace

Parameters

string	$name	- programmatic name of a key, in a <key,value> pair in the current namespace
mixed	$value	- value in the <key,value> pair to assign to the $name key

Exceptions

Zend_Session_Exception

Returns

true

See also

Zend_Session_Exception

Zend_Session_Exception

Zend_Session_Exception

Definition at line 299 of file Namespace.php.

    {
        if (isset(self::$_namespaceLocks[$this->_namespace])) {
            #require_once 'Zend/Session/Exception.php';
            throw new Zend_Session_Exception('This session/namespace has been marked as read-only.');
        }

        if ($name === '') {
            #require_once 'Zend/Session/Exception.php';
            throw new Zend_Session_Exception("The '$name' key must be a non-empty string");
        }

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

        $name = (string) $name;

        $_SESSION[$this->_namespace][$name] = $value;
    }

__unset()

__unset

(

$name

)

__unset() - unset a variable in this object's namespace.

Parameters

string

$name

- programmatic name of a key, in a <key,value> pair in the current namespace

Returns

true

See also

Zend_Session_Exception

Definition at line 404 of file Namespace.php.

    {
        if ($name === '') {
            #require_once 'Zend/Session/Exception.php';
            throw new Zend_Session_Exception("The '$name' key must be a non-empty string");
        }

        return parent::_namespaceUnset($this->_namespace, $name);
    }

apply()

apply

(

$callback

)

apply() - enables applying user-selected function, such as array_merge() to the namespace Parameters following the $callback argument are passed to the callback function. Caveat: ignores members expiring now.

Example: $namespace->apply('array_merge', array('tree' => 'apple', 'fruit' => 'peach'), array('flower' => 'rose')); $namespace->apply('count');

Parameters

string | array

$callback

- callback function

Definition at line 342 of file Namespace.php.

    {
        $arg_list = func_get_args();
        $arg_list[0] = $_SESSION[$this->_namespace];
        return call_user_func_array($callback, $arg_list);
    }

applySet()

applySet

(

$callback

)

applySet() - enables applying user-selected function, and sets entire namespace to the result Result of $callback must be an array. Parameters following the $callback argument are passed to the callback function. Caveat: ignores members expiring now.

Example: $namespace->applySet('array_merge', array('tree' => 'apple', 'fruit' => 'peach'), array('flower' => 'rose'));

Parameters

string | array

$callback

- callback function

See also

Zend_Session_Exception

Definition at line 361 of file Namespace.php.

    {
        $arg_list = func_get_args();
        $arg_list[0] = $_SESSION[$this->_namespace];
        $result = call_user_func_array($callback, $arg_list);
        if (!is_array($result)) {
            #require_once 'Zend/Session/Exception.php';
            throw new Zend_Session_Exception('Result must be an array. Got: ' . gettype($result));
        }
        $_SESSION[$this->_namespace] = $result;
        return $result;
    }

getIterator()

getIterator

(

)

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

Returns

ArrayObject - iteratable container of the namespace contents

Definition at line 210 of file Namespace.php.

    {
        return new ArrayObject(parent::_namespaceGetAll($this->_namespace));
    }

getNamespace()

getNamespace

(

)

Returns the namespace name

Returns

string

Definition at line 525 of file Namespace.php.

    {
        return $this->_namespace;
    }

isLocked()

isLocked

(

)

isLocked() - return lock status, true if, and only if, read-only

Returns

bool

Definition at line 254 of file Namespace.php.

    {
        return isset(self::$_namespaceLocks[$this->_namespace]);
    }

lock()

lock

(

)

lock() - mark a session/namespace as readonly

Returns

void

Definition at line 221 of file Namespace.php.

    {
        self::$_namespaceLocks[$this->_namespace] = true;
    }

resetSingleInstance()

static resetSingleInstance (   $namespaceName = null )

static

resetSingleInstance()

Parameters

string

$namespaceName

Returns

null

Definition at line 79 of file Namespace.php.

    {
        if ($namespaceName != null) {
            if (array_key_exists($namespaceName, self::$_singleInstances)) {
                unset(self::$_singleInstances[$namespaceName]);
            }
            return;
        }

        self::$_singleInstances = array();
        return;
    }

setExpirationHops()

setExpirationHops	(		$hops,
			$variables = null,
			$hopCountOnUsageOnly = false
	)

setExpirationHops() - expire the namespace, or specific variables after a specified number of page hops

Parameters

int	$hops	- how many "hops" (number of subsequent requests) before expiring
mixed	$variables	- OPTIONAL list of variables to expire (defaults to all)
boolean	$hopCountOnUsageOnly	- OPTIONAL if set, only count a hop/request if this namespace is used

Exceptions

Zend_Session_Exception

Returns

void

See also

Zend_Session_Exception

Zend_Session_Exception

Definition at line 475 of file Namespace.php.

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

        if ($hops <= 0) {
            #require_once 'Zend/Session/Exception.php';
            throw new Zend_Session_Exception('Hops must be positive number.');
        }

        if ($variables === null) {

            // apply expiration to entire namespace
            if ($hopCountOnUsageOnly === false) {
                $_SESSION['__ZF'][$this->_namespace]['ENGH'] = $hops;
            } else {
                $_SESSION['__ZF'][$this->_namespace]['ENNH'] = $hops;
            }

        } else {

            if (is_string($variables)) {
                $variables = array($variables);
            }

            foreach ($variables as $variable) {
                if (!empty($variable)) {
                    if ($hopCountOnUsageOnly === false) {
                        $_SESSION['__ZF'][$this->_namespace]['ENVGH'][$variable] = $hops;
                    } else {
                        $_SESSION['__ZF'][$this->_namespace]['ENVNH'][$variable] = $hops;
                    }
                }
            }
        }
    }

setExpirationSeconds()

setExpirationSeconds	(		$seconds,
			$variables = null
	)

setExpirationSeconds() - expire the namespace, or specific variables after a specified number of seconds

Parameters

int	$seconds	- expires in this many seconds
mixed	$variables	- OPTIONAL list of variables to expire (defaults to all)

Exceptions

Zend_Session_Exception

Returns

void

See also

Zend_Session_Exception

Zend_Session_Exception

Definition at line 427 of file Namespace.php.

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

        if ($seconds <= 0) {
            #require_once 'Zend/Session/Exception.php';
            throw new Zend_Session_Exception('Seconds must be positive.');
        }

        if ($variables === null) {

            // apply expiration to entire namespace
            $_SESSION['__ZF'][$this->_namespace]['ENT'] = time() + $seconds;

        } else {

            if (is_string($variables)) {
                $variables = array($variables);
            }

            foreach ($variables as $variable) {
                if (!empty($variable)) {
                    $_SESSION['__ZF'][$this->_namespace]['ENVT'][$variable] = time() + $seconds;
                }
            }
        }
    }

unlock()

unlock

(

)

unlock() - unmark a session/namespace to enable read & write

Returns

void

Definition at line 232 of file Namespace.php.

    {
        unset(self::$_namespaceLocks[$this->_namespace]);
    }

unlockAll()

static unlockAll ( )

static

unlockAll() - unmark all session/namespaces to enable read & write

Returns

void

Definition at line 243 of file Namespace.php.

    {
        self::$_namespaceLocks = array();
    }

unsetAll()

unsetAll

(

)

unsetAll() - unset all variables in this namespace

Returns

true

Definition at line 265 of file Namespace.php.

    {
        return parent::_namespaceUnset($this->_namespace);
    }

Field Documentation

$_namespace

$_namespace = "Default"

protected

Definition at line 57 of file Namespace.php.

$_namespaceLocks

$_namespaceLocks = array()

staticprotected

Definition at line 64 of file Namespace.php.

$_singleInstances

$_singleInstances = array()

staticprotected

Definition at line 71 of file Namespace.php.

SINGLE_INSTANCE

const SINGLE_INSTANCE = true

used as option to constructor to prevent additional instances to the same namespace

Definition at line 50 of file Namespace.php.

---

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

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