Class Mage_Core_Model_Session_Abstract

Core Session Abstract model

Varien_Object

Mage_Core_Model_Session_Abstract

Direct known subclasses

Package: Mage\Core
Category: Mage
Copyright: Copyright (c) 2012 Magento Inc. (http://www.magentocommerce.com)
License: Open Software License (OSL 3.0)
Author: Magento Core Team <core@magentocommerce.com>
Located at code/core/Mage/Core/Model/Session/Abstract.php

Methods summary
`public Mage_Core_Model_Session_Abstract`	# `init( string $namespace, string $sessionName = null )` Init session Init session Parameters `$namespace` `string` $namespace `$sessionName` `string` $sessionName Returns `Mage_Core_Model_Session_Abstract` Overrides `Mage_Core_Model_Session_Abstract_Varien::init()`
`public string`	# `getCookieDomain( )` Retrieve Cookie domain Retrieve Cookie domain Returns `string`
`public string`	# `getCookiePath( )` Retrieve cookie path Retrieve cookie path Returns `string`
`public integer`	# `getCookieLifetime( )` Retrieve cookie lifetime Retrieve cookie lifetime Returns `integer`
`public boolean`	# `useValidateRemoteAddr( )` Use REMOTE_ADDR in validator key Use REMOTE_ADDR in validator key Returns `boolean` Overrides `Mage_Core_Model_Session_Abstract_Varien::useValidateRemoteAddr()`
`public boolean`	# `useValidateHttpVia( )` Use HTTP_VIA in validator key Use HTTP_VIA in validator key Returns `boolean` Overrides `Mage_Core_Model_Session_Abstract_Varien::useValidateHttpVia()`
`public boolean`	# `useValidateHttpXForwardedFor( )` Use HTTP_X_FORWARDED_FOR in validator key Use HTTP_X_FORWARDED_FOR in validator key Returns `boolean` Overrides `Mage_Core_Model_Session_Abstract_Varien::useValidateHttpXForwardedFor()`
`public boolean`	# `useValidateHttpUserAgent( )` Use HTTP_USER_AGENT in validator key Use HTTP_USER_AGENT in validator key Returns `boolean` Overrides `Mage_Core_Model_Session_Abstract_Varien::useValidateHttpUserAgent()`
`public boolean`	# `useSid( )` Check whether SID can be used for session initialization Admin area will always have this feature enabled Check whether SID can be used for session initialization Admin area will always have this feature enabled Returns `boolean`
`public array`	# `getValidateHttpUserAgentSkip( )` Retrieve skip User Agent validation strings (Flash etc) Retrieve skip User Agent validation strings (Flash etc) Returns `array` Overrides `Mage_Core_Model_Session_Abstract_Varien::getValidateHttpUserAgentSkip()`
`public Mage_Core_Model_Message_Collection`	# `getMessages( boolean $clear = false )` Retrieve messages from session Retrieve messages from session Parameters `$clear` `boolean` $clear Returns `Mage_Core_Model_Message_Collection`
`public Mage_Core_Model_Session_Abstract`	# `addException( Exception $exception, string $alternativeText )` Not Mage exception handling Not Mage exception handling Parameters `$exception` `Exception` $exception `$alternativeText` `string` $alternativeText Returns `Mage_Core_Model_Session_Abstract`
`public Mage_Core_Model_Session_Abstract`	# `addMessage( Mage_Core_Model_Message_Abstract $message )` Adding new message to message collection Adding new message to message collection Parameters `$message` `Mage_Core_Model_Message_Abstract` $message Returns `Mage_Core_Model_Session_Abstract`
`public Mage_Core_Model_Session_Abstract`	# `addError( string $message )` Adding new error message Adding new error message Parameters `$message` `string` $message Returns `Mage_Core_Model_Session_Abstract`
`public Mage_Core_Model_Session_Abstract`	# `addWarning( string $message )` Adding new warning message Adding new warning message Parameters `$message` `string` $message Returns `Mage_Core_Model_Session_Abstract`
`public Mage_Core_Model_Session_Abstract`	# `addNotice( string $message )` Adding new notice message Adding new notice message Parameters `$message` `string` $message Returns `Mage_Core_Model_Session_Abstract`
`public Mage_Core_Model_Session_Abstract`	# `addSuccess( string $message )` Adding new success message Adding new success message Parameters `$message` `string` $message Returns `Mage_Core_Model_Session_Abstract`
`public Mage_Core_Model_Session_Abstract`	# `addMessages( array $messages )` Adding messages array to message collection Adding messages array to message collection Parameters `$messages` `array` $messages Returns `Mage_Core_Model_Session_Abstract`
`public Mage_Core_Model_Session_Abstract`	# `addUniqueMessages( array\|string\|Mage_Core_Model_Message_Abstract $messages )` Adds messages array to message collection, but doesn't add duplicates to it Adds messages array to message collection, but doesn't add duplicates to it Parameters `$messages` `array\|string\|Mage_Core_Model_Message_Abstract` $messages Returns `Mage_Core_Model_Session_Abstract`
`public Mage_Core_Model_Session_Abstract`	# `setSessionId( string\|null $id = null )` Specify session identifier Specify session identifier Parameters `$id` `string\|null` $id Returns `Mage_Core_Model_Session_Abstract` Overrides `Mage_Core_Model_Session_Abstract_Varien::setSessionId()`
`public string`	# `getEncryptedSessionId( )` Get encrypted session identifier. No reason use crypt key for session id encryption, we can use session identifier as is. Get encrypted session identifier. No reason use crypt key for session id encryption, we can use session identifier as is. Returns `string`
`public`	# `getSessionIdQueryParam( )`
`public Mage_Core_Model_Session_Abstract`	# `setSkipSessionIdFlag( boolean $flag )` Set skip flag if need skip generating of _GET session_id_key param Set skip flag if need skip generating of _GET session_id_key param Parameters `$flag` `boolean` $flag Returns `Mage_Core_Model_Session_Abstract`
`public boolean`	# `getSkipSessionIdFlag( )` Retrieve session id skip flag Retrieve session id skip flag Returns `boolean`
`public string`	# `getSessionIdForHost( string $urlHost )` If session cookie is not applicable due to host or path mismatch - add session id to query If session cookie is not applicable due to host or path mismatch - add session id to query Parameters `$urlHost` `string` $urlHost can be host or url Returns `string` {session_id_key}={session_id_encrypted}
`public boolean`	# `isValidForHost( string $host )` Check if session is valid for given hostname Check if session is valid for given hostname Parameters `$host` `string` $host Returns `boolean`
`public boolean`	# `isValidForPath( string $path )` Check if session is valid for given path Check if session is valid for given path Parameters `$path` `string` $path Returns `boolean`
`public Mage_Core_Model_Session_Abstract`	# `addHost( string $host )` Add hostname to session Add hostname to session Parameters `$host` `string` $host Returns `Mage_Core_Model_Session_Abstract`
`public array`	# `getSessionHosts( )` Retrieve session hostnames Retrieve session hostnames Returns `array`
`public string`	# `getSessionSaveMethod( )` Retrieve session save method Retrieve session save method Returns `string` Overrides `Mage_Core_Model_Session_Abstract_Varien::getSessionSaveMethod()`
`public string`	# `getSessionSavePath( )` Get session save path Get session save path Returns `string` Overrides `Mage_Core_Model_Session_Abstract_Varien::getSessionSavePath()`
`public Mage_Core_Model_Session_Abstract`	# `renewSession( )` Renew session id and update session cookie Renew session id and update session cookie Returns `Mage_Core_Model_Session_Abstract`

Methods inherited from Mage_Core_Model_Session_Abstract_Varien
`_validate(), clear(), getCookie(), getData(), getSessionId(), getSessionName(), getValidatorData(), regenerateSessionId(), setSessionName(), start(), unsetAll(), validate()`

Constants summary
`string`	`XML_PATH_COOKIE_DOMAIN`	`'web/cookie/cookie_domain'`	#
`string`	`XML_PATH_COOKIE_PATH`	`'web/cookie/cookie_path'`	#
`string`	`XML_PATH_COOKIE_LIFETIME`	`'web/cookie/cookie_lifetime'`	#
`string`	`XML_NODE_SESSION_SAVE`	`'global/session_save'`	#
`string`	`XML_NODE_SESSION_SAVE_PATH`	`'global/session_save_path'`	#
`string`	`XML_PATH_USE_REMOTE_ADDR`	`'web/session/use_remote_addr'`	#
`string`	`XML_PATH_USE_HTTP_VIA`	`'web/session/use_http_via'`	#
`string`	`XML_PATH_USE_X_FORWARDED`	`'web/session/use_http_x_forwarded_for'`	#
`string`	`XML_PATH_USE_USER_AGENT`	`'web/session/use_http_user_agent'`	#
`string`	`XML_PATH_USE_FRONTEND_SID`	`'web/session/use_frontend_sid'`	#
`string`	`XML_NODE_USET_AGENT_SKIP`	`'global/session/validation/http_user_agent_skip'`	#
`string`	`XML_PATH_LOG_EXCEPTION_FILE`	`'dev/log/exception_file'`	#
`string`	`SESSION_ID_QUERY_PARAM`	`'SID'`	#

Constants inherited from Mage_Core_Model_Session_Abstract_Varien
`VALIDATOR_HTTP_USER_AGENT_KEY, VALIDATOR_HTTP_VIA_KEY, VALIDATOR_HTTP_X_FORVARDED_FOR_KEY, VALIDATOR_KEY, VALIDATOR_REMOTE_ADDR_KEY`

Properties summary
`protected static array`	`$_urlHostCache`	`array()`	# URL host cache URL host cache
`protected static string`	`$_encryptedSessionId`		# Encrypted session id cache Encrypted session id cache
`protected boolean`	`$_skipSessionIdFlag`	`false`	# Skip session id flag Skip session id flag

Packages

Classes

Exceptions

Functions

Class Mage_Core_Model_Session_Abstract

Direct known subclasses

Parameters

Returns

Overrides

Returns

Returns

Returns

Returns

Overrides

Returns

Overrides

Returns

Overrides

Returns

Overrides

Returns

Returns

Overrides

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Overrides

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Overrides

Returns

Overrides

Returns