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

array
$_defaultOptions= 'array(
'save_path' => null'
Private list of php's ini values for ext/session null values will default to the php.ini value, otherwise the value below will overwrite the default ini value, unless the user has set an option explicity with setOptions()
array(
'save_path' => null
Details
bool
$_defaultOptionsSet= 'false'
Whether the default options listed in Zend_Session::$_localOptions have been set
false
Details
bool
$_destroyed= 'false'
Whether or not session has been destroyed via session_destroy()
false
Details
array
$_localOptions= 'array(
'strict' => '_strict''
List of options pertaining to Zend_Session that can be set by developers using Zend_Session::setOptions(). This list intentionally duplicates the individual declaration of static "class" variables by the same names.
array(
'strict' => '_strict'
Details
int
$_regenerateIdState= '0'
Whether or not the session id has been regenerated this request.
Id regeneration state <0 - regenerate requested when session is started 0 - do nothing
0 - already called session_regenerate_id()
0
Details
int
$_rememberMeSeconds= '1209600'
Default number of seconds the session will be remembered for when asked to be remembered
1209600
Details
\Zend_Session_SaveHandler_Interface
$_saveHandler= 'null'
A reference to the set session save handler

bool
$_sessionCookieDeleted= 'false'
Whether or not session id cookie has been deleted
false
Details
bool
$_sessionStarted= 'false'
Check whether or not the session was started
false
Details
bool
$_strict= 'false'
Whether or not session must be initiated before usage
false
Details
bool|\bitset
$_throwStartupExceptions= 'true'
$_throwStartupException
This could also be a combiniation of error codes to catchtrue
Details
_processStartupMetadataGlobal(
)
:
void
_processGlobalMetadata() - this method initizes the sessions GLOBAL metadata, mostly global data expiration calculations.

_processValidators(
)
:
void
_processValidator() - internal function that is called in the existence of VALID metadata
Exception | Description |
---|---|
\Zend_Session_Exception |

destroy(
bool $remove_cookie
=
true, bool $readonly
=
true
)
:
void
destroy() - This is used to destroy session data, and optionally, the session cookie itself
Name | Type | Description |
---|---|---|
$remove_cookie | bool |
|
$readonly | bool |
|

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

forgetMe(
)
:
void
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.

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

getOptions(
string $optionName
=
null
)
:
array|string
getOptions()
Name | Type | Description |
---|---|---|
$optionName | string | OPTIONAL |
Type | Description |
---|---|
array|string |

getSaveHandler(
)
:
\Zend_Session_SaveHandler_Interface
getSaveHandler() - Get the session Save Handler
Type | Description |
---|---|
\Zend_Session_SaveHandler_Interface |

isDestroyed(
)
:
bool
Whether or not session has been destroyed via session_destroy()
Type | Description |
---|---|
bool |

isReadable(
)
:
bool
isReadable() - returns a boolean indicating if namespaces can write (use setters)
Type | Description |
---|---|
bool |

isRegenerated(
)
:
bool
isRegenerated() - convenience method to determine if session_regenerate_id() has been called during this request by Zend_Session.
Type | Description |
---|---|
bool |

isStarted(
)
:
bool
isStarted() - convenience method to determine if the session is already started.
Type | Description |
---|---|
bool |

isWritable(
)
:
bool
isWritable() - returns a boolean indicating if namespaces can write (use setters)
Type | Description |
---|---|
bool |

namespaceGet(
string $namespace
)
:
array
namespaceGet() - get all variables in a namespace Deprecated: Use getIterator() in Zend_Session_Namespace.
Name | Type | Description |
---|---|---|
$namespace | string |
Type | Description |
---|---|
array |

namespaceIsset(
string $namespace
)
:
bool
namespaceIsset() - check to see if a namespace is set
Name | Type | Description |
---|---|---|
$namespace | string |
Type | Description |
---|---|
bool |

namespaceUnset(
string $namespace
)
:
void
namespaceUnset() - unset a namespace or a variable within a namespace
Name | Type | Description |
---|---|---|
$namespace | string |
Exception | Description |
---|---|
\Zend_Session_Exception |

regenerateId(
)
:
void
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.
Exception | Description |
---|---|
\Zend_Session_Exception |

registerValidator(
\Zend_Session_Validator_Interface $validator
)
:
void
registerValidator() - register a validator that will attempt to validate this session for every future request
Name | Type | Description |
---|---|---|
$validator | \Zend_Session_Validator_Interface |

rememberMe(
int $seconds
=
null
)
:
void
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.
Name | Type | Description |
---|---|---|
$seconds | int | OPTIONAL specifies TTL for cookie in seconds from present time |

rememberUntil(
int $seconds
=
0
)
:
void
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()
Name | Type | Description |
---|---|---|
$seconds | int |

sessionExists(
)
:
bool
sessionExists() - whether or not a session exists for the current request
Type | Description |
---|---|
bool |

setOptions(
array $userOptions
=
array()
)
:
void
setOptions - set both the class specified
Name | Type | Description |
---|---|---|
$userOptions | array |
|
Exception | Description |
---|---|
\Zend_Session_Exception |

setSaveHandler(
$saveHandler
)
:
void
setSaveHandler() - Session Save Handler assignment
Name | Type | Description |
---|---|---|
$saveHandler |

start(
bool|array $options
=
false
)
:
void
start() - Start the session.
Name | Type | Description |
---|---|---|
$options | bool|array | OPTIONAL Either user supplied options, or flag indicating if start initiated automatically |
Exception | Description |
---|---|
\Zend_Session_Exception |

writeClose(
bool $readonly
=
true
)
:
void
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.
Name | Type | Description |
---|---|---|
$readonly | bool |
|