Session/Namespace.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Session
since: Preview Release 0.2
version: $Id: Namespace.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes: Zend_Session_Namespace

Description

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 license@zend.com so we can send you a copy immediately.

Zend_Session_Namespace
jump to top

Extends from: Zend_Session_Abstract
Implements
category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Session
Constants: SINGLE_INSTANCE
Properties: $_namespace; $_namespaceLocks; $_singleInstances
Methods: resetSingleInstance; __construct; getIterator; lock; unlock; unlockAll; isLocked; unsetAll; __get; __set; apply; applySet; __isset; __unset; setExpirationSeconds; setExpirationHops; getNamespace

Description

Zend_Session_Namespace

Constants

SINGLE_INSTANCE
jump to class

 SINGLE_INSTANCE = 'true'

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

Details

value: true

Properties

$_namespace
jump to class

string $_namespace = 'Default'

Namespace - which namespace this instance of zend-session is saving-to/getting-from

Details

$_namespace: string
visibility: protected
default: Default
final: false
static: false

$_namespaceLocks
jump to class

array $_namespaceLocks = 'array'

Namespace locking mechanism

Details

$_namespaceLocks: array
visibility: protected
default: array
final: false
static: true

$_singleInstances
jump to class

array $_singleInstances = 'array'

Single instance namespace array to ensure data security.

Details

$_singleInstances: array
visibility: protected
default: array
final: false
static: true

Methods

__construct
jump to class

__construct(
          string $namespace
              =
              Default, bool $singleInstance
              =
              false
          )
        
        :
        void

__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.

Arguments

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

Details

visibility: public
final: false
static: false

__get
jump to class

__get(
          string $name
          )
        
        :
        mixed

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

Arguments

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

Output

mixed

Details

visibility: public
final: false
static: false

__isset
jump to class

__isset(
          string $name
          )
        
        :
        bool

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

Arguments

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

Output

bool

Details

visibility: public
final: false
static: false

__set
jump to class

__set(
          string $name, mixed $value
          )
        
        :
        true

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

Arguments

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

Output

true

Details

visibility: public
final: false
static: false
throws

__unset
jump to class

__unset(
          string $name
          )
        
        :
        true

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

Arguments

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

Output

true

Details

visibility: public
final: false
static: false

apply
jump to class

apply(
          string|array $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');

Arguments

$callback: stringarray
- callback function

Details

visibility: public
final: false
static: false

applySet
jump to class

applySet(
          string|array $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'));

Arguments

$callback: stringarray
- callback function

Details

visibility: public
final: false
static: false

getIterator
jump to class

getIterator(
          
          )
        
        :
        ArrayObject

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

Output

ArrayObject: - iteratable container of the namespace contents

Details

visibility: public
final: false
static: false

getNamespace
jump to class

getNamespace(
          
          )
        
        :
        string

Returns the namespace name

Output

string

Details

visibility: public
final: false
static: false

isLocked
jump to class

isLocked(
          
          )
        
        :
        bool

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

Output

bool

Details

visibility: public
final: false
static: false

lock
jump to class

lock() - mark a session/namespace as readonly

Details

visibility: public
final: false
static: false

resetSingleInstance
jump to class

resetSingleInstance(
          string $namespaceName
              =
              null
          )
        
        :
        null

resetSingleInstance()

Arguments

$namespaceName: string

Output

null

Details

visibility: public
final: false
static: true

setExpirationHops
jump to class

setExpirationHops(
          int $hops, mixed $variables
              =
              null, boolean $hopCountOnUsageOnly
              =
              false
          )
        
        :
        void

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

Arguments

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

Details

visibility: public
final: false
static: false
throws

setExpirationSeconds
jump to class

setExpirationSeconds(
          int $seconds, mixed $variables
              =
              null
          )
        
        :
        void

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

Arguments

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

Details

visibility: public
final: false
static: false
throws

unlock
jump to class

unlock(
          
          )
        
        :
        void

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

Details

visibility: public
final: false
static: false

unlockAll
jump to class

unlockAll(
          
          )
        
        :
        void

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

Details

visibility: public
final: false
static: true

unsetAll
jump to class

unsetAll(
          
          )
        
        :
        true

unsetAll() - unset all variables in this namespace

Output

true

Details

visibility: public
final: false
static: false

API Documentation

Session/Namespace.php

Description

Zend_Session_Namespacejump to top

Description

Constants

SINGLE_INSTANCEjump to class

Details

Properties

$_namespacejump to class

Details

$_namespaceLocksjump to class

Details

$_singleInstancesjump to class

Details

Methods

__constructjump to class

Arguments

Details

__getjump to class

Arguments

Output

Details

__issetjump to class

Arguments

Output

Details

__setjump to class

Arguments

Output

Details

__unsetjump to class

Arguments

Output

Details

applyjump to class

Arguments

Details

applySetjump to class

Arguments

Details

getIteratorjump to class

Output

Details

getNamespacejump to class

Output

Details

isLockedjump to class

Output

Details

lockjump to class

Details

resetSingleInstancejump to class

Arguments

Output

Details

setExpirationHopsjump to class

Arguments

Details

setExpirationSecondsjump to class

Arguments

Details

unlockjump to class

Details

unlockAlljump to class

Details

unsetAlljump to class

Output

Details

Zend_Session_Namespace
jump to top

SINGLE_INSTANCE
jump to class

$_namespace
jump to class

$_namespaceLocks
jump to class

$_singleInstances
jump to class

__construct
jump to class

__get
jump to class

__isset
jump to class

__set
jump to class

__unset
jump to class

apply
jump to class

applySet
jump to class

getIterator
jump to class

getNamespace
jump to class

isLocked
jump to class

lock
jump to class

resetSingleInstance
jump to class

setExpirationHops
jump to class

setExpirationSeconds
jump to class

unlock
jump to class

unlockAll
jump to class

unsetAll
jump to class