Docs For Class Mage_Core_Model

Description

Core cookie model

author: Magento Core Team <[email protected]>

Located in /Core/Model/Cookie.php (line 35)

Class Constant Summary

XML_PATH_COOKIE_DOMAIN = 'web/cookie/cookie_domain'

XML_PATH_COOKIE_HTTPONLY = 'web/cookie/cookie_httponly'

XML_PATH_COOKIE_LIFETIME = 'web/cookie/cookie_lifetime'

XML_PATH_COOKIE_PATH = 'web/cookie/cookie_path'

Variable Summary

mixed $_lifetime

Mage_Core_Model_Store $_store

Method Summary

Mage_Core_Model_Cookie delete (string $name, [string $path = null], [string $domain = null], [int|bool $secure = null], [int|bool $httponly = null])

mixed get ([ $name = null], string $neme)

string getConfigDomain ()

string getDomain ()

bool getHttponly ()

int getLifetime ()

string getPath ()

Mage_Core_Model_Store getStore ()

bool isSecure ()

Mage_Core_Model_Cookie renew (string $name, [int $period = null], [string $path = null], [string $domain = null], [int|bool $secure = null], [ $httponly = null])

Mage_Core_Model_Cookie set (string $name, string $value, [int $period = null], [string $path = null], [string $domain = null], [int|bool $secure = null], [ $httponly = null])

Mage_Core_Model_Cookie setLifetime (int $lifetime)

Mage_Core_Model_Cookie setStore (mixed $store)

Mage_Core_Controller_Request_Http _getRequest ()

Mage_Core_Controller_Response_Http _getResponse ()

Variables

mixed $_lifetime (line 42)

access: protected

Mage_Core_Model_Store $_store (line 49)

Store object

access: protected

Methods

delete (line 285)

Delete cookie

access: public

Mage_Core_Model_Cookie delete (string $name, [string $path = null], [string $domain = null], [int|bool $secure = null], [int|bool $httponly = null])

string $name
string $path
string $domain
int|bool $secure
int|bool $httponly

get (line 270)

Retrieve cookie or false if not exists

access: public

mixed get ([ $name = null], string $neme)

string $neme: The cookie name
$name

getConfigDomain (line 115)

Retrieve Config Domain for cookie

access: public

string getConfigDomain ()

getDomain (line 101)

Retrieve Domain for cookie

access: public

string getDomain ()

getHttponly (line 169)

Retrieve use HTTP only flag

access: public

bool getHttponly ()

getLifetime (line 139)

Retrieve cookie lifetime

access: public

int getLifetime ()

getPath (line 125)

Retrieve Path for cookie

access: public

string getPath ()

getStore (line 68)

Retrieve Store object

access: public

Mage_Core_Model_Store getStore ()

isSecure (line 184)

Is https secure request Use secure on adminhtml only

access: public

bool isSecure ()

renew (line 252)

Postpone cookie expiration time if cookie value defined

access: public

Mage_Core_Model_Cookie renew (string $name, [int $period = null], [string $path = null], [string $domain = null], [int|bool $secure = null], [ $httponly = null])

string $name: The cookie name
int $period: Lifetime period
string $path
string $domain
int|bool $secure
$httponly

set (line 203)

Set cookie

access: public

Mage_Core_Model_Cookie set (string $name, string $value, [int $period = null], [string $path = null], [string $domain = null], [int|bool $secure = null], [ $httponly = null])

string $name: The cookie name
string $value: The cookie value
int $period: Lifetime period
string $path
string $domain
int|bool $secure
$httponly

setLifetime (line 158)

Set cookie lifetime

access: public

Mage_Core_Model_Cookie setLifetime (int $lifetime)

int $lifetime

setStore (line 57)

Set Store object

access: public

Mage_Core_Model_Cookie setStore (mixed $store)

mixed $store

_getRequest (line 81)

Retrieve Request object

access: protected

Mage_Core_Controller_Request_Http _getRequest ()

_getResponse (line 91)

Retrieve Response object

access: protected

Mage_Core_Controller_Response_Http _getResponse ()

Class Constants

XML_PATH_COOKIE_DOMAIN = 'web/cookie/cookie_domain' (line 37)

XML_PATH_COOKIE_HTTPONLY = 'web/cookie/cookie_httponly' (line 40)

XML_PATH_COOKIE_LIFETIME = 'web/cookie/cookie_lifetime' (line 39)

XML_PATH_COOKIE_PATH = 'web/cookie/cookie_path' (line 38)

Class Mage_Core_Model_Cookie