Docs For Class Zend_Session_Core

## Class Zend_Session_Core

Description

Zend_Session_Core

- license: none
- copyright: none applied yet

Located in /Zend/Session/Core.php (line 20)

Variable Summary
static bool $debug_mode
static array $_default_options
static unknown_type $_default_options_set
static array $_expiring_data
static Zend_Session_Core $_instance
static bool $_log_level
static unknown_type $_remember_me_seconds
static bool $_session_started
static bool $_singleton
static bool $_strict
static bool $_write_closed
Method Summary
static void forgetMe ()
static string getId ()
static Zend_Session_Core getInstance ([boolean $instance_must_exist = false])
static bool isStarted ()
static void regenerateId ()
static void registerValidator ( $validator)
static void rememberMe ()
static void removeInstance ()
static bool sessionExists ()
static void setId (string $id)
static void setOptions ([ $user_options = array()])
static void setSaveHandler ( $interface)
static void shutdown ()
static void start ()
static void stop ()
static void writeClose ()
static void _processRememberMe ()
static void _processStartupMetadataGlobal ()
static void _processStartupMetadataNamespace (string $namespace)
static void _processValidators ()
void __construct (string $namespace)
mixed namespaceGet (string $namespace, [string $name = null])
bool namespaceIsset (string $namespace, [string $name = null])
void namespaceSet (string $namespace, string $name, mixed $value)
void namespaceSetExpirationHops (string $namespace, int $hops, [mixed $variables = null], [bool $hop_count_on_usage_only = false])
void namespaceSetExpirationSeconds (string $namespace, int $seconds, [mixed $variables = null])
void namespaceUnset (string $namespace, [string $name = null])
void _startNamespace (string $namespace)
void __clone ()
Variables
static bool $debug_mode = false (line 132)

Debug mode: primary use for this will be in unit tests where the environment is command line and no headers are exchanged.

- access: public

static array $_default_options = array(
"save_path" => null,
"name" => 'ZFSESSION',
"save_handler" => null,
"auto_start" => null,
"gc_probability" => null,
"gc_divisor" => null,
"gc_maxlifetime" => null,
"serialize_handler" => null,
"cookie_lifetime" => null,
"cookie_path" => null,
"cookie_domain" => null,
"cookie_secure" => null,
"use_cookies" => null,
"use_only_cookies" => 'on',
"referer_check" => null,
"entropy_file" => null,
"entropy_length" => null,
"cache_limiter" => null,
"cache_expire" => null,
"use_trans_sid" => null,
"bug_compat_42" => null,
"bug_compat_warn" => null,
"hash_function" => null,
"hash_bits_per_character" => null
) (line 52)

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()

- access: protected

static unknown_type $_default_options_set = false (line 116)

Wether the default options have been set.

- access: protected

static array $_expiring_data = array() (line 124)

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

- access: protected

static Zend_Session_Core $_instance (line 35)

Instance of Zend_Session_Core

- access: protected

static bool $_log_level = 0 (line 95)

The Logging level of Zend_Session, requires Zend_Log

1. = off
2. = errors
3. = set/get/isset/unset
4. = startup/shutdown values

- access: protected

static unknown_type $_remember_me_seconds = 1209600 (line 109)

Default number of seconds the session will be remembered for when asked to be remembered

- access: protected

static bool $_session_started = false (line 28)

Check wether or not the session was started

- access: protected

static bool $_singleton = false (line 42)

The Singleton enforcer

- access: protected

static bool $_strict = false (line 102)

Wether or not session must be initiated before usage

- access: protected

static bool $_write_closed = false (line 84)

Whether or not write close has been performed.

- access: protected

Methods
static method forgetMe (line 291)

ForgetMe() - This will make sure to kill the session cookie on the users browser.

- access: public

static void forgetMe ()
static method getId (line 386)

GetId() - get the current session id

- access: public

static string getId ()
static method getInstance (line 223)

GetInstance() - Enfore the Singleton of the core.

- access: public

static Zend_Session_Core getInstance ([boolean $instance_must_exist = false])

- boolean $instance_must_exist

static method isStarted (line 375)

IsStarted() - convenience methods to determine if the session is already started.

- access: public

static bool isStarted ()
static method regenerateId (line 255)

RegenerateId() - Regenerate the session id.

- access: public

static void regenerateId ()
static method registerValidator (line 417)

RegisterValidator() - register a validator that will attempt to validate this session for every future request

- access: public

static void registerValidator ( $validator)

- Zend_Session_Validator_Interface $validator

static method rememberMe (line 273)

RememberMe() - Send the remember me cookie, which will (on next request) force the session to resend the session cookie that will expire after a number of seconds in the future (not when the browser closes) Seconds are determined by self::$_remember_me_seconds.

- access: public

static void rememberMe ()
static method removeInstance (line 243)

RemoveInstance() - Remove the instance.

- access: public

static void removeInstance ()
static method sessionExists (line 310)

SessionExists() - wether or not a session exist for the current request.

- access: public

static bool sessionExists ()
static method setId (line 397)

SetId() - set an id to a user specified id

- access: public

static void setId (string $id)

- string $id

static method setOptions (line 140)

SetOptions - set both the class specified

- access: public

static void setOptions ([ $user_options = array()])

- array $user_options

static method setSaveHandler (line 202)

Session Save Handler assignment

- access: public

static void setSaveHandler ( $interface)

- Zend_Session_SaveHandlerInterface $interface

static method shutdown (line 457)

Shutdown() - Shutdown the sesssion, close writing and remove the instance

- access: public

static void shutdown ()
static method start (line 327)

Start() - Start the session.

- access: public

static void start ()
static method stop (line 429)

Stop() - Convienance method, links to shutdown

- access: public

static void stop ()
static method writeClose (line 441)

WriteClose() - this will complete the internal data transformation on this request.

- access: public

static void writeClose ()
static method _processRememberMe (line 595)

_processRememberMe() - this method handles the process of making the current session cookie extend past the closing of the browser. The session based cookie will become a time based cookie, expiration will be set into the future (the value specified by self::$_remember_me_seconds).

- access: protected

static void _processRememberMe ()
static method _processStartupMetadataGlobal (line 471)

_processGlobalMetadata() - this method initizes the sessions GLOBAL metadata, mostly global data expiration calculations.

- access: protected

static void _processStartupMetadataGlobal ()
static method _processStartupMetadataNamespace (line 543)

_processStartupMetadataNamespace() - this method processes the metadata specific only to a given namespace. This is typically run at the instantiation of a Zend_Session object.

- access: public

static void _processStartupMetadataNamespace (string $namespace)

- string $namespace

static method _processValidators (line 625)

_processValidator() - internal function that is called in the existence of VALID metadata

- access: protected

static void _processValidators ()
Constructor __construct (line 651)

Constructor

- access: public

void __construct (string $namespace)

- string $namespace

namespaceGet (line 772)

NamespaceGet() - get a variable from a namespace.

- access: public

mixed namespaceGet (string $namespace, [string $name = null])

- string $namespace
- string $name

namespaceIsset (line 699)

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

- access: public

bool namespaceIsset (string $namespace, [string $name = null])

- string $namespace
- string $name

namespaceSet (line 754)

namespaceSet() - set a variable within a namespace.

- access: public

void namespaceSet (string $namespace, string $name, mixed $value)

- string $namespace
- string $name
- mixed $value

namespaceSetExpirationHops (line 850)

NamespaceSetExpirationHops() -

- access: public

void namespaceSetExpirationHops (string $namespace, int $hops, [mixed $variables = null], [bool $hop_count_on_usage_only = false])

- string $namespace
- int $hops
- mixed $variables
- bool $hop_count_on_usage_only

namespaceSetExpirationSeconds (line 811)

NamespaceSetExpirationSeconds() - exprire a namespace, or data within after a specified number of seconds.

- access: public

void namespaceSetExpirationSeconds (string $namespace, int $seconds, [mixed $variables = null])

- string $namespace
- int $seconds
- mixed $variables

namespaceUnset (line 722)

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

- access: public

void namespaceUnset (string $namespace, [string $name = null])

- string $namespace
- string $name

_startNamespace (line 686)

_startNamespace() - while this method is public, its really only intended use is by the constructor of Zend_Session object. This method initializes the session namespace.

- access: public

void _startNamespace (string $namespace)

- string $namespace

__clone (line 674)

Clone overriding - make sure that a developer cannot clone the core instance

- access: public
- throws: Zend_Session_Exception

void __clone ()

Documentation generated on Sun, 29 Oct 2006 21:27:53 -0600 by phpDocumentor 1.3.0RC6