Documentation

Mage_Adminhtml_Model_Session extends Mage_Core_Model_Session_Abstract
in package

Auth session model

Table of Contents

Constants

REGISTRY_KEY  : mixed = 'symfony_session'
SECURE_COOKIE_CHECK_KEY  : mixed = '_secure_cookie_check'
VALIDATOR_HTTP_USER_AGENT_KEY  : mixed = 'http_user_agent'
VALIDATOR_HTTP_VIA_KEY  : mixed = 'http_via'
VALIDATOR_HTTP_X_FORVARDED_FOR_KEY  : mixed = 'http_x_forwarded_for'
VALIDATOR_KEY  : mixed = '_session_validator_data'
VALIDATOR_PASSWORD_CREATE_TIMESTAMP  : mixed = 'password_create_timestamp'
VALIDATOR_REMOTE_ADDR_KEY  : mixed = 'remote_addr'
XML_NODE_SESSION_SAVE  : mixed = 'global/session_save'
XML_NODE_SESSION_SAVE_PATH  : mixed = 'global/session_save_path'
XML_NODE_USET_AGENT_SKIP  : mixed = 'global/session/validation/http_user_agent_skip'
XML_PATH_ADMIN_LIFETIME  : mixed = 'admin/security/session_cookie_lifetime'
XML_PATH_COOKIE_DOMAIN  : mixed = 'web/cookie/cookie_domain'
XML_PATH_COOKIE_LIFETIME  : mixed = 'web/cookie/cookie_lifetime'
XML_PATH_COOKIE_PATH  : mixed = 'web/cookie/cookie_path'
XML_PATH_REMEMBER_ENABLED  : mixed = 'web/cookie/remember_enabled'
XML_PATH_REMEMBER_LIFETIME  : mixed = 'web/cookie/remember_cookie_lifetime'
XML_PATH_USE_HTTP_VIA  : mixed = 'web/session/use_http_via'
XML_PATH_USE_REMOTE_ADDR  : mixed = 'web/session/use_remote_addr'
XML_PATH_USE_USER_AGENT  : mixed = 'web/session/use_http_user_agent'
XML_PATH_USE_X_FORWARDED  : mixed = 'web/session/use_http_x_forwarded_for'

Properties

$_data  : array<string|int, mixed>|null
Object attributes
$_dirty  : array<string|int, mixed>
$_hasDataChanges  : bool
Data changes flag (true after setData|unsetData call)
$_idFieldName  : string
Name of object id field
$_isDeleted  : bool
Object delete flag
$_oldFieldsMap  : array<string|int, mixed>
Map short fields names to its full names
$_sessionHosts  : array<string|int, mixed>
Map of session enabled hosts
$_syncFieldsMap  : mixed
Map of fields to sync to other fields upon changing their data
$_underscoreCache  : array<string|int, mixed>
Setter/Getter underscore transformation cache
$isValidated  : bool
$sessionLifetime  : int|null
Declared explicitly so the DataObject magic setter cannot bind it into $_SESSION

Methods

__call()  : mixed
Set/Get attribute wrapper
__construct()  : mixed
Constructor
__get()  : mixed
Attribute getter (deprecated)
__set()  : mixed
Attribute setter (deprecated)
__toArray()  : array<string|int, mixed>
Convert object attributes to array
addData()  : $this
Add data to the object.
addError()  : self
Adding new error message
addException()  : self
Not Mage exception handling
addHost()  : self
Add hostname to session
addMessage()  : self
Adding new message to message collection
addMessages()  : self
Adding messages array to message collection
addNotice()  : self
Adding new notice message
addSuccess()  : self
Adding new success message
addUniqueMessages()  : $this
Adds messages array to message collection, but doesn't add duplicates to it
addWarning()  : self
Adding new warning message
clear()  : self
Alias for unsetAll
debug()  : string|array<string|int, mixed>
Present object data as string in debug mode
flagDirty()  : $this
getCookie()  : Mage_Core_Model_Cookie
Retrieve cookie object
getCookieDomain()  : string
getCookieLifetime()  : int
getCookiePath()  : string
getData()  : mixed
Additional get data with clear mode
getDataByKey()  : mixed
Get object data by particular key
getDataByPath()  : mixed
Get object data by path
getDataSetDefault()  : mixed
Fast get data or set default if value is not available
getDataUsingMethod()  : mixed
Get object data by key with calling getter method
getErrorMessage()  : string
getId()  : mixed
Retrieve object id
getIdFieldName()  : string
Retrieve name of object id field
getMessages()  : Mage_Core_Model_Message_Collection
Retrieve messages from session
getProductIds()  : array<string|int, mixed>|string
getSessionHosts()  : array<string|int, mixed>
getSessionId()  : false|string
getSessionName()  : string
getSessionSaveMethod()  : string
Retrieve session save method Default files
getSessionSavePath()  : string
getSessionValidatorData()  : array<string|int, mixed>
getSkipEmptySessionCheck()  : bool|null
getSuccessMessage()  : string
getValidateHttpUserAgentSkip()  : array<string|int, mixed>
Retrieve User Agent strings exempted from session validation
getValidatorData()  : array<string|int, mixed>
Retrieve unique user data for validator
hasData()  : bool
If $key is empty, checks whether there's any data in the object Otherwise checks if the specified attribute is set.
hasDataChanges()  : bool
Get data change status
init()  : self
Init session with namespace
isDeleted()  : bool
Set _isDeleted flag value (if $isDeleted param is defined) and return current flag value
isDirty()  : bool
isEmpty()  : bool
checks whether the object is empty
jsonSerialize()  : array<string|int, mixed>
Implementation of JsonSerializable::jsonSerialize()
offsetExists()  : bool
Implementation of ArrayAccess::offsetExists()
offsetGet()  : mixed
Implementation of ArrayAccess::offsetGet()
offsetSet()  : void
Implementation of ArrayAccess::offsetSet()
offsetUnset()  : void
Implementation of ArrayAccess::offsetUnset()
regenerateSessionId()  : self
renewSession()  : self
Renew session id and update session cookie
resolveConfiguredSessionLifetime()  : int
Remember Me lives inside the session, so only the observer can pass it
serialize()  : string
serialize object attributes
setData()  : $this
Overwrite data in the object.
setDataChanges()  : $this
Clears data changes status
setDataUsingMethod()  : $this
Set object data with calling setter method
setErrorMessage()  : $this
setId()  : $this
Set object id field value
setIdFieldName()  : $this
set name of object id field
setMessages()  : $this
setProductIds()  : $this
setSessionCookie()  : self
setSessionHosts()  : self
setSessionId()  : self
Set custom session id
setSessionName()  : self
setSkipEmptySessionCheck()  : $this
setSuccessMessage()  : $this
setValidatorSessionRenewTimestamp()  : void
Update the session's last legitimate renewal time (call when customer password is updated to avoid being logged out)
start()  : self
Configure and start session
toArray()  : array<string|int, mixed>
Public wrapper for __toArray
toJson()  : string
Public wrapper for __toJson
toString()  : string
Public wrapper for __toString
toXml()  : string
Public wrapper for __toXml
unsErrorMessage()  : $this
unsetAll()  : self
Unset all data
unsetData()  : $this
Unset data from the object.
unsetOldData()  : $this
Unset old fields data from the object.
unsSuccessMessage()  : $this
useValidateHttpUserAgent()  : bool
Use HTTP_USER_AGENT in validator key
useValidateHttpVia()  : bool
Use HTTP_VIA in validator key
useValidateHttpXForwardedFor()  : bool
Use HTTP_X_FORWARDED_FOR in validator key
useValidateRemoteAddr()  : bool
Use REMOTE_ADDR in validator key
useValidateSessionPasswordTimestamp()  : bool
Password creation timestamp must not be newer than last session renewal.
validate()  : self
Validate session
__toJson()  : string
Convert object attributes to JSON
__toXml()  : string
Convert object attributes to XML
_addFullNames()  : mixed
_camelize()  : string
_construct()  : void
Internal constructor not depended on params. Can be used for object initialization
_getData()  : mixed
Get value from _data array without parse key
_initOldFieldsMap()  : mixed
Inits mapping array of object's previously used fields to new fields.
_prepareArray()  : array<string|int, mixed>
Set required array elements
_prepareSyncFieldsMap()  : $this
Called after old fields are inited. Forms synchronization map to sync old fields and new fields between each other.
_underscore()  : string
Converts field names for setters and getters
_validate()  : bool
Validate data
getLongestConfiguredSessionLifetime()  : int
Longest lifetime a store can hand out, for callers that cannot know which policy applies

Constants

REGISTRY_KEY

public mixed REGISTRY_KEY = 'symfony_session'

SECURE_COOKIE_CHECK_KEY

public mixed SECURE_COOKIE_CHECK_KEY = '_secure_cookie_check'

VALIDATOR_HTTP_USER_AGENT_KEY

public mixed VALIDATOR_HTTP_USER_AGENT_KEY = 'http_user_agent'

VALIDATOR_HTTP_VIA_KEY

public mixed VALIDATOR_HTTP_VIA_KEY = 'http_via'

VALIDATOR_HTTP_X_FORVARDED_FOR_KEY

public mixed VALIDATOR_HTTP_X_FORVARDED_FOR_KEY = 'http_x_forwarded_for'

VALIDATOR_KEY

public mixed VALIDATOR_KEY = '_session_validator_data'

VALIDATOR_PASSWORD_CREATE_TIMESTAMP

public mixed VALIDATOR_PASSWORD_CREATE_TIMESTAMP = 'password_create_timestamp'

VALIDATOR_REMOTE_ADDR_KEY

public mixed VALIDATOR_REMOTE_ADDR_KEY = 'remote_addr'

XML_NODE_SESSION_SAVE

public mixed XML_NODE_SESSION_SAVE = 'global/session_save'

XML_NODE_SESSION_SAVE_PATH

public mixed XML_NODE_SESSION_SAVE_PATH = 'global/session_save_path'

XML_NODE_USET_AGENT_SKIP

public mixed XML_NODE_USET_AGENT_SKIP = 'global/session/validation/http_user_agent_skip'

XML_PATH_ADMIN_LIFETIME

public mixed XML_PATH_ADMIN_LIFETIME = 'admin/security/session_cookie_lifetime'

XML_PATH_COOKIE_DOMAIN

public mixed XML_PATH_COOKIE_DOMAIN = 'web/cookie/cookie_domain'

XML_PATH_COOKIE_LIFETIME

public mixed XML_PATH_COOKIE_LIFETIME = 'web/cookie/cookie_lifetime'

XML_PATH_COOKIE_PATH

public mixed XML_PATH_COOKIE_PATH = 'web/cookie/cookie_path'

XML_PATH_REMEMBER_ENABLED

public mixed XML_PATH_REMEMBER_ENABLED = 'web/cookie/remember_enabled'

XML_PATH_REMEMBER_LIFETIME

public mixed XML_PATH_REMEMBER_LIFETIME = 'web/cookie/remember_cookie_lifetime'

XML_PATH_USE_HTTP_VIA

public mixed XML_PATH_USE_HTTP_VIA = 'web/session/use_http_via'

XML_PATH_USE_REMOTE_ADDR

public mixed XML_PATH_USE_REMOTE_ADDR = 'web/session/use_remote_addr'

XML_PATH_USE_USER_AGENT

public mixed XML_PATH_USE_USER_AGENT = 'web/session/use_http_user_agent'

XML_PATH_USE_X_FORWARDED

public mixed XML_PATH_USE_X_FORWARDED = 'web/session/use_http_x_forwarded_for'

Properties

$_data

Object attributes

protected array<string|int, mixed>|null $_data = []

$_dirty

protected array<string|int, mixed> $_dirty

$_hasDataChanges

Data changes flag (true after setData|unsetData call)

protected bool $_hasDataChanges = false

$_idFieldName

Name of object id field

protected string $_idFieldName = null

$_isDeleted

Object delete flag

protected bool $_isDeleted = false

$_oldFieldsMap

Map short fields names to its full names

protected array<string|int, mixed> $_oldFieldsMap = []

$_sessionHosts

Map of session enabled hosts

protected array<string|int, mixed> $_sessionHosts = []
Tags
example

['host.name' => true]

$_syncFieldsMap

Map of fields to sync to other fields upon changing their data

protected mixed $_syncFieldsMap = []

$_underscoreCache

Setter/Getter underscore transformation cache

protected static array<string|int, mixed> $_underscoreCache = []

$isValidated

protected static bool $isValidated = \false

Flag true if session validator data has already been evaluated

$sessionLifetime

Declared explicitly so the DataObject magic setter cannot bind it into $_SESSION

protected int|null $sessionLifetime = \null

Methods

__call()

Set/Get attribute wrapper

public __call(string $method, array<string|int, mixed> $args) : mixed
Parameters
$method : string
$args : array<string|int, mixed>

__construct()

Constructor

public __construct() : mixed

By default, is looking for first argument as array and assigns it as object attributes This behaviour may change in child classes

__get()

Attribute getter (deprecated)

public __get(string $var) : mixed
Parameters
$var : string

__set()

Attribute setter (deprecated)

public __set(string $var, mixed $value) : mixed
Parameters
$var : string
$value : mixed

__toArray()

Convert object attributes to array

public __toArray([array<string|int, mixed> $arrAttributes = [] ]) : array<string|int, mixed>
Parameters
$arrAttributes : array<string|int, mixed> = []

array of required attributes

Return values
array<string|int, mixed>

addData()

Add data to the object.

public addData(array<string|int, mixed> $arr) : $this

Retains previous data in the object.

Parameters
$arr : array<string|int, mixed>
Return values
$this

addError()

Adding new error message

public addError(string $message) : self
Parameters
$message : string
Return values
self

addException()

Not Mage exception handling

public addException(Exception $exception, string $alternativeText) : self
Parameters
$exception : Exception
$alternativeText : string
Return values
self

addHost()

Add hostname to session

public addHost(string|true $host) : self
Parameters
$host : string|true
Return values
self

addMessages()

Adding messages array to message collection

public addMessages(array<string|int, mixed> $messages) : self
Parameters
$messages : array<string|int, mixed>
Return values
self

addNotice()

Adding new notice message

public addNotice(string $message) : self
Parameters
$message : string
Return values
self

addSuccess()

Adding new success message

public addSuccess(string $message) : self
Parameters
$message : string
Return values
self

addWarning()

Adding new warning message

public addWarning(string $message) : self
Parameters
$message : string
Return values
self

clear()

Alias for unsetAll

public clear() : self
Return values
self

debug()

Present object data as string in debug mode

public debug([mixed $data = null ][, array<string|int, mixed> &$objects = [] ]) : string|array<string|int, mixed>
Parameters
$data : mixed = null
$objects : array<string|int, mixed> = []
Return values
string|array<string|int, mixed>

flagDirty()

public flagDirty(string $field[, bool $flag = true ]) : $this
Parameters
$field : string
$flag : bool = true
Return values
$this

getCookieDomain()

public getCookieDomain() : string
Return values
string

getCookieLifetime()

public getCookieLifetime() : int
Return values
int

getCookiePath()

public getCookiePath() : string
Return values
string

getData()

Additional get data with clear mode

public getData([string $key = '' ][, mixed $index = null ]) : mixed
Parameters
$key : string = ''
$index : mixed = null

For compatibility with parent; when bool, acts as clear flag

Attributes
#[Override]

getDataByKey()

Get object data by particular key

public getDataByKey(string $key) : mixed
Parameters
$key : string

getDataByPath()

Get object data by path

public getDataByPath(string $path) : mixed

Method consider the path as chain of keys: a/b/c => ['a']['b']['c']

Parameters
$path : string

getDataSetDefault()

Fast get data or set default if value is not available

public getDataSetDefault(string $key, mixed $default) : mixed
Parameters
$key : string
$default : mixed

getDataUsingMethod()

Get object data by key with calling getter method

public getDataUsingMethod(string $key[, mixed $args = null ]) : mixed
Parameters
$key : string
$args : mixed = null

getErrorMessage()

public getErrorMessage() : string
Return values
string

getId()

Retrieve object id

public getId() : mixed

getIdFieldName()

Retrieve name of object id field

public getIdFieldName() : string
Return values
string

getProductIds()

public getProductIds() : array<string|int, mixed>|string
Return values
array<string|int, mixed>|string

getSessionHosts()

public getSessionHosts() : array<string|int, mixed>
Return values
array<string|int, mixed>

getSessionId()

public getSessionId() : false|string
Return values
false|string

getSessionName()

public getSessionName() : string
Return values
string

getSessionSaveMethod()

Retrieve session save method Default files

public getSessionSaveMethod() : string
Return values
string

getSessionSavePath()

public getSessionSavePath() : string
Return values
string

getSessionValidatorData()

public getSessionValidatorData() : array<string|int, mixed>
Return values
array<string|int, mixed>

getSkipEmptySessionCheck()

public getSkipEmptySessionCheck() : bool|null
Return values
bool|null

getSuccessMessage()

public getSuccessMessage() : string
Return values
string

getValidateHttpUserAgentSkip()

Retrieve User Agent strings exempted from session validation

public getValidateHttpUserAgentSkip() : array<string|int, mixed>
Return values
array<string|int, mixed>

getValidatorData()

Retrieve unique user data for validator

public getValidatorData() : array<string|int, mixed>
Return values
array<string|int, mixed>

hasData()

If $key is empty, checks whether there's any data in the object Otherwise checks if the specified attribute is set.

public hasData([string $key = '' ]) : bool
Parameters
$key : string = ''
Return values
bool

hasDataChanges()

Get data change status

public hasDataChanges() : bool
Return values
bool

init()

Init session with namespace

public init(string $namespace[, string|null $sessionName = null ]) : self
Parameters
$namespace : string
$sessionName : string|null = null
Return values
self

isDeleted()

Set _isDeleted flag value (if $isDeleted param is defined) and return current flag value

public isDeleted([bool $isDeleted = null ]) : bool
Parameters
$isDeleted : bool = null
Return values
bool

isDirty()

public isDirty([string $field = null ]) : bool
Parameters
$field : string = null
Return values
bool

isEmpty()

checks whether the object is empty

public isEmpty() : bool
Return values
bool

jsonSerialize()

Implementation of JsonSerializable::jsonSerialize()

public jsonSerialize() : array<string|int, mixed>

Prepares the object data for JSON serialization. Returns all object data as an array, with special handling for nested DataObject instances:

  • If a nested DataObject has a custom jsonSerialize() implementation, it's preserved as-is
  • If a nested DataObject has a custom toJson() method, it's converted to JSON string
  • If a nested DataObject uses only the base implementations, it's excluded from output

This prevents infinite recursion and circular references when serializing object hierarchies.

Attributes
#[Override]
Return values
array<string|int, mixed>

regenerateSessionId()

public regenerateSessionId() : self
Return values
self

renewSession()

Renew session id and update session cookie

public renewSession() : self
Return values
self

resolveConfiguredSessionLifetime()

Remember Me lives inside the session, so only the observer can pass it

public static resolveConfiguredSessionLifetime(string $sessionName[, bool $rememberMe = false ][, int|string|Mage_Core_Model_Store|null $store = null ]) : int
Parameters
$sessionName : string
$rememberMe : bool = false
$store : int|string|Mage_Core_Model_Store|null = null
Return values
int

serialize()

serialize object attributes

public serialize([array<string|int, mixed> $attributes = [] ][, string $valueSeparator = '=' ][, string $fieldSeparator = ' ' ][, string $quote = '"' ]) : string
Parameters
$attributes : array<string|int, mixed> = []
$valueSeparator : string = '='
$fieldSeparator : string = ' '
$quote : string = '"'
Return values
string

setData()

Overwrite data in the object.

public setData(string|array<string|int, mixed> $key[, mixed $value = null ]) : $this

$key can be string or array. If $key is string, the attribute value will be overwritten by $value

If $key is an array, it will overwrite all the data in the object.

Parameters
$key : string|array<string|int, mixed>
$value : mixed = null
Return values
$this

setDataChanges()

Clears data changes status

public setDataChanges(bool $value) : $this
Parameters
$value : bool
Return values
$this

setDataUsingMethod()

Set object data with calling setter method

public setDataUsingMethod(string $key[, mixed $args = [] ]) : $this
Parameters
$key : string
$args : mixed = []
Return values
$this

setErrorMessage()

public setErrorMessage(string $value) : $this
Parameters
$value : string
Return values
$this

setId()

Set object id field value

public setId(mixed $value) : $this
Parameters
$value : mixed
Return values
$this

setIdFieldName()

set name of object id field

public setIdFieldName(string $name) : $this
Parameters
$name : string
Return values
$this

setProductIds()

public setProductIds(array<string|int, mixed>|string $value) : $this
Parameters
$value : array<string|int, mixed>|string
Return values
$this

setSessionCookie()

public setSessionCookie() : self
Return values
self

setSessionHosts()

public setSessionHosts(array<string|int, mixed> $hosts) : self
Parameters
$hosts : array<string|int, mixed>
Return values
self

setSessionId()

Set custom session id

public setSessionId([string|null $id = null ]) : self
Parameters
$id : string|null = null
Return values
self

setSessionName()

public setSessionName(string $name) : self
Parameters
$name : string
Return values
self

setSkipEmptySessionCheck()

public setSkipEmptySessionCheck(bool $flag) : $this
Parameters
$flag : bool
Return values
$this

setSuccessMessage()

public setSuccessMessage(string $value) : $this
Parameters
$value : string
Return values
$this

setValidatorSessionRenewTimestamp()

Update the session's last legitimate renewal time (call when customer password is updated to avoid being logged out)

public setValidatorSessionRenewTimestamp([int|null $timestamp = null ]) : void
Parameters
$timestamp : int|null = null

start()

Configure and start session

public start([string|null $sessionName = null ]) : self
Parameters
$sessionName : string|null = null
Tags
throws
Mage_Core_Model_Store_Exception
Return values
self

toArray()

Public wrapper for __toArray

public toArray([array<string|int, mixed> $arrAttributes = [] ]) : array<string|int, mixed>
Parameters
$arrAttributes : array<string|int, mixed> = []
Return values
array<string|int, mixed>

toJson()

Public wrapper for __toJson

public toJson([array<string|int, mixed> $arrAttributes = [] ]) : string
Parameters
$arrAttributes : array<string|int, mixed> = []
Return values
string

toString()

Public wrapper for __toString

public toString([string $format = '' ]) : string

Will use $format as an template and substitute {{key}} for attributes

Parameters
$format : string = ''
Return values
string

toXml()

Public wrapper for __toXml

public toXml([array<string|int, mixed> $arrAttributes = [] ][, string $rootName = 'item' ][, bool $addOpenTag = false ][, bool $addCdata = true ]) : string
Parameters
$arrAttributes : array<string|int, mixed> = []
$rootName : string = 'item'
$addOpenTag : bool = false
$addCdata : bool = true
Return values
string

unsErrorMessage()

public unsErrorMessage() : $this
Return values
$this

unsetAll()

Unset all data

public unsetAll() : self
Return values
self

unsetData()

Unset data from the object.

public unsetData([string $key = null ]) : $this

$key can be a string only. Array will be ignored.

Parameters
$key : string = null
Return values
$this

unsetOldData()

Unset old fields data from the object.

public unsetOldData([string $key = null ]) : $this

$key can be a string only. Array will be ignored.

Parameters
$key : string = null
Return values
$this

unsSuccessMessage()

public unsSuccessMessage() : $this
Return values
$this

useValidateHttpUserAgent()

Use HTTP_USER_AGENT in validator key

public useValidateHttpUserAgent() : bool
Return values
bool

useValidateHttpVia()

Use HTTP_VIA in validator key

public useValidateHttpVia() : bool
Return values
bool

useValidateHttpXForwardedFor()

Use HTTP_X_FORWARDED_FOR in validator key

public useValidateHttpXForwardedFor() : bool
Return values
bool

useValidateRemoteAddr()

Use REMOTE_ADDR in validator key

public useValidateRemoteAddr() : bool
Return values
bool

useValidateSessionPasswordTimestamp()

Password creation timestamp must not be newer than last session renewal.

public useValidateSessionPasswordTimestamp() : bool

Classes that extend from this may turn that off if they need to not check this. Like some sort of API session that doesn't use passwords and so sessions shouldn't expire.

Return values
bool

__toJson()

Convert object attributes to JSON

protected __toJson([array<string|int, mixed> $arrAttributes = [] ]) : string
Parameters
$arrAttributes : array<string|int, mixed> = []

array of required attributes

Return values
string

__toXml()

Convert object attributes to XML

protected __toXml([array<string|int, mixed> $arrAttributes = [] ][, string $rootName = 'item' ][, bool $addOpenTag = false ][, bool $addCdata = true ]) : string
Parameters
$arrAttributes : array<string|int, mixed> = []

array of required attributes

$rootName : string = 'item'

name of the root element

$addOpenTag : bool = false
$addCdata : bool = true
Return values
string

_addFullNames()

protected _addFullNames() : mixed

_camelize()

protected _camelize(string $name) : string
Parameters
$name : string
Return values
string

_construct()

Internal constructor not depended on params. Can be used for object initialization

protected _construct() : void

_getData()

Get value from _data array without parse key

protected _getData(string $key) : mixed
Parameters
$key : string

_initOldFieldsMap()

Inits mapping array of object's previously used fields to new fields.

protected _initOldFieldsMap() : mixed

Must be overloaded by descendants to set concrete fields map.

_prepareArray()

Set required array elements

protected _prepareArray(array<string|int, mixed> &$arr[, array<string|int, mixed> $elements = [] ]) : array<string|int, mixed>
Parameters
$arr : array<string|int, mixed>
$elements : array<string|int, mixed> = []
Return values
array<string|int, mixed>

_prepareSyncFieldsMap()

Called after old fields are inited. Forms synchronization map to sync old fields and new fields between each other.

protected _prepareSyncFieldsMap() : $this
Return values
$this

_underscore()

Converts field names for setters and getters

protected _underscore(string $name) : string

$this->setMyField($value) === $this->setData('my_field', $value) Uses cache to eliminate unnecessary preg_replace

Parameters
$name : string
Return values
string

_validate()

Validate data

protected _validate() : bool
Return values
bool

getLongestConfiguredSessionLifetime()

Longest lifetime a store can hand out, for callers that cannot know which policy applies

protected static getLongestConfiguredSessionLifetime([int|string|Mage_Core_Model_Store|null $store = null ]) : int
Parameters
$store : int|string|Mage_Core_Model_Store|null = null
Return values
int
On this page

Search results