[Zend_Session] element index

Package indexes

All elements
a c d e f g h i l n o r s u v w z _
_
top
Variable $_expiringData
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
Variable $_namespace
Namespace - which namespace this instance of zend-session is saving-to/getting-from
Variable $_namespaceLocks
Namespace locking mechanism
Variable $_readable
Whether or not session permits reading (reading data in $_SESSION[])
Variable $_singleInstances
Single instance namespace array to ensure data security.
Variable $_writable
Whether or not session permits writing (modification of $_SESSION[])
Method _namespaceGet
namespaceGet() - Get $name variable from $namespace, returning by reference.
Method _namespaceGetAll
namespaceGetAll() - Get an array containing $namespace, including expiring data.
Method _namespaceIsset
namespaceIsset() - check to see if a namespace or a variable within a namespace is set
Method _namespaceUnset
namespaceUnset() - unset a namespace or a variable within a namespace
Class Constant _THROW_NOT_READABLE_MSG
Error message thrown when an action requires reading session data, but current Zend_Session is not marked as readable.
Class Constant _THROW_NOT_WRITABLE_MSG
Error message thrown when an action requires modification, but current Zend_Session has been marked as read-only.
Method __construct
__construct() - Returns an instance object bound to a particular, isolated section of the session, identified by $namespace name (defaulting to 'Default').
Method __get
__get() - method to get a variable in this object's current namespace
Method __isset
__isset() - determine if a variable in this object's namespace is set
Method __set
__set() - method to set a variable/value in this object's namespace
Method __unset
__unset() - unset a variable in this object's namespace.
a
top
Method apply
apply() - enables applying user-selected function, such as array_merge() to the namespace Caveat: ignores members expiring now.
Method applySet
applySet() - enables applying user-selected function, and sets entire namespace to the result Result of $callback must be an array. Caveat: ignores members expiring now.
Page Abstract.php
Abstract.php in Abstract.php
Page Abstract.php
Abstract.php in Abstract.php
c
top
Method close
Close Session - free resources
d
top
Method destroy
destroy() - This is used to destroy session data, and optionally, the session cookie itself
Method destroy
Destroy Session - remove data from resource for given session id
e
top
Method expireSessionCookie
expireSessionCookie() - Sends an expired session id cookie, causing the client to delete the session cookie
Page Exception.php
Exception.php in Exception.php
f
top
Method forgetMe
forgetMe() - The exact opposite of rememberMe(), a session cookie is ensured to be 'session based'
g
top
Method getId
Zend_Session::getId() in Session.php
getId() - get the current session id
Method getIterator
getIterator() - return an iteratable object for use in foreach and the like, this completes the IteratorAggregate interface
Method getIterator
getIterator() - return an iteratable object for use in foreach and the like, this completes the IteratorAggregate interface
Method getValidData
GetValidData() - This method should be used to retrieve the environment variables that will be needed to 'validate' a session.
Method gc
Garbage Collection - remove old session data older than $maxlifetime (in seconds)
h
top
Method handleSessionStartError
handleSessionStartError() - interface for set_error_handler()
Method handleSilentWriteClose
handleSilentWriteClose() - interface for set_error_handler()
Page HttpUserAgent.php
HttpUserAgent.php in HttpUserAgent.php
i
top
Method isLocked
isLocked() - return lock status, true if, and only if, read-only
Method isReadable
isReadable() - returns a boolean indicating if namespaces can write (use setters)
Method isRegenerated
isRegenerated() - convenience method to determine if session_regenerate_id() has been called during this request by Zend_Session.
Method isStarted
isStarted() - convenience method to determine if the session is already started.
Method isWritable
isWritable() - returns a boolean indicating if namespaces can write (use setters)
Page Interface.php
Interface.php in Interface.php
Page Interface.php
Interface.php in Interface.php
l
top
Method lock
lock() - mark a session/namespace as readonly
n
top
Method namespaceGet
namespaceGet() - get all variables in a namespace Deprecated: Use getIterator() in Zend_Session_Namespace.
Method namespaceIsset
namespaceIsset() - check to see if a namespace is set
Method namespaceUnset
namespaceUnset() - unset a namespace or a variable within a namespace
Page Namespace.php
Namespace.php in Namespace.php
o
top
Method open
Open Session - retrieve resources
r
top
Method regenerateId
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.
Method registerValidator
registerValidator() - register a validator that will attempt to validate this session for every future request
Method rememberMe
rememberMe() - Replace the session cookie with one that will expire after a number of seconds in the future (not when the browser closes). Seconds are determined by self::$_rememberMeSeconds.
Method rememberUntil
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()
Method read
Read session data
s
top
Variable $sessionStartError
sessionStartError
Page Session.php
Session.php in Session.php
Method sessionExists
sessionExists() - whether or not a session exists for the current request
Method setExpirationHops
setExpirationHops() - expire the namespace, or specific variables after a specified number of page hops
Method setExpirationSeconds
setExpirationSeconds() - expire the namespace, or specific variables after a specified number of seconds
Method setId
Zend_Session::setId() in Session.php
setId() - set an id to a user specified id
Method setOptions
setOptions - set both the class specified
Method setSaveHandler
setSaveHandler() - Session Save Handler assignment
Method setValidData
SetValidData() - This method should be used to store the environment variables that will be needed in order to validate the session later in the validate() method.
Class Constant SINGLE_INSTANCE
used as option to constructor to prevent additional instances to the same namespace
Method start
Zend_Session::start() in Session.php
start() - Start the session.
Method stop
Zend_Session::stop() in Session.php
stop() - Disable write access. Optionally disable read (not implemented).
Method setup
Setup() - this method will store the environment variables nessissary to be able to validate against in future requests.
Method setup
Setup() - this method will get the current user agent and store it in the session
u
top
Method unlock
unlock() - unmark a session/namespace to enable read & write
Method unlockAll
unlockAll() - unmark all session/namespaces to enable read & write
Method unsetAll
unsetAll() - unset all variables in this namespace
v
top
Method validate
Validate() - this method will be called at the beginning of every session to determine if the current environment matches that which was store in the setup() procedure.
Method validate
Validate() - this method will determine if the current user agent matches the user agent we stored when we initialized this variable.
w
top
Method writeClose
writeClose() - Shutdown the sesssion, close writing and detach $_SESSION from the back-end storage mechanism.
Method write
Write Session - commit data to resource
z
top
Class Zend_Session
Zend_Session in Session.php
Zend_Session
Class Zend_Session_Abstract
Zend_Session_Abstract in Abstract.php
Zend_Session_Abstract
Class Zend_Session_Exception
Zend_Session_Exception in Exception.php
Zend_Session_Exception
Class Zend_Session_Namespace
Zend_Session_Namespace in Namespace.php
Zend_Session_Namespace
Class Zend_Session_Validator_Abstract
Zend_Session_Validator_Abstract
Class Zend_Session_SaveHandler_Interface
Zend_Session_SaveHandler_Interface
Class Zend_Session_Validator_HttpUserAgent
Zend_Session_Validator_HttpUserAgent
Class Zend_Session_Validator_Interface
Zend_Session_Validator_Interface
a c d e f g h i l n o r s u v w z _