Docs For Class Mage_Core_Helper

Description

Core Http Helper

author: Magento Core Team <[email protected]>

Located in /Core/Helper/Http.php (line 34)

Mage_Core_Helper_Abstract
   |
   --Mage_Core_Helper_Http

Class Constant Summary

XML_NODE_REMOTE_ADDR_HEADERS = 'global/remote_addr_headers'

Variable Summary

string $_remoteAddr

Method Summary

void authFailed ()

array authValidate ([ $headers = null])

string getHttpAcceptCharset ([boolean $clean = true])

string getHttpAcceptLanguage ([boolean $clean = true])

string getHttpHost ([boolean $clean = true])

string getHttpReferer ([boolean $clean = true])

string getHttpUserAgent ([boolean $clean = true])

string getRemoteAddr ([bool $ipToLong = false])

array getRemoteAddrHeaders ()

string getRequestUri ([boolean $clean = false])

string getServerAddr ([bool $ipToLong = false])

boolean validateIpAddr (string $address)

string _getHttpCleanValue (string $var, [boolean $clean = true])

Variables

string $_remoteAddr (line 43)

Remote address cache

access: protected

Inherited Variables

Inherited from Mage_Core_Helper_Abstract

Mage_Core_Helper_Abstract::$_layout
Mage_Core_Helper_Abstract::$_moduleName
Mage_Core_Helper_Abstract::$_request

Methods

authFailed (line 95)

Send auth failed Headers and exit

access: public

void authFailed ()

authValidate (line 50)

Validate and retrieve user and password from HTTP

access: public

array authValidate ([ $headers = null])

$headers

getHttpAcceptCharset (line 223)

Retrieve HTTP ACCEPT CHARSET

access: public

string getHttpAcceptCharset ([boolean $clean = true])

boolean $clean: clean non UTF-8 characters

getHttpAcceptLanguage (line 212)

Retrieve HTTP ACCEPT LANGUAGE

access: public

string getHttpAcceptLanguage ([boolean $clean = true])

boolean $clean: clean non UTF-8 characters

getHttpHost (line 190)

Retrieve HTTP HOST

access: public

string getHttpHost ([boolean $clean = true])

boolean $clean: clean non UTF-8 characters

getHttpReferer (line 234)

Retrieve HTTP REFERER

access: public

string getHttpReferer ([boolean $clean = true])

boolean $clean: clean non UTF-8 characters

getHttpUserAgent (line 201)

Retrieve HTTP USER AGENT

access: public

string getHttpUserAgent ([boolean $clean = true])

boolean $clean: clean non UTF-8 characters

getRemoteAddr (line 129)

Retrieve Client Remote Address

return: IPv4|long
access: public

string getRemoteAddr ([bool $ipToLong = false])

bool $ipToLong: converting IP to long format

getRemoteAddrHeaders (line 110)

Retrieve Remote Addresses Additional check Headers

access: public

array getRemoteAddrHeaders ()

getRequestUri (line 246)

Returns the REQUEST_URI taking into account platform differences between Apache and IIS

access: public

string getRequestUri ([boolean $clean = false])

boolean $clean: clean non UTF-8 characters

getServerAddr (line 158)

Retrieve Server IP address

return: IPv4|long
access: public

string getServerAddr ([bool $ipToLong = false])

bool $ipToLong: converting IP to long format

validateIpAddr (line 261)

Validate IP address

access: public

boolean validateIpAddr (string $address)

string $address

_getHttpCleanValue (line 174)

Retrieve HTTP "clean" value

access: protected

string _getHttpCleanValue (string $var, [boolean $clean = true])

string $var
boolean $clean: clean non UTF-8 characters

Inherited Methods

Inherited From Mage_Core_Helper_Abstract

Mage_Core_Helper_Abstract::escapeHtml()
Mage_Core_Helper_Abstract::escapeUrl()
Mage_Core_Helper_Abstract::getLayout()
Mage_Core_Helper_Abstract::htmlEscape()
Mage_Core_Helper_Abstract::isModuleEnabled()
Mage_Core_Helper_Abstract::isModuleOutputEnabled()
Mage_Core_Helper_Abstract::jsQuoteEscape()
Mage_Core_Helper_Abstract::setLayout()
Mage_Core_Helper_Abstract::stripTags()
Mage_Core_Helper_Abstract::translateArray()
Mage_Core_Helper_Abstract::urlDecode()
Mage_Core_Helper_Abstract::urlEncode()
Mage_Core_Helper_Abstract::urlEscape()
Mage_Core_Helper_Abstract::_cleanCache()
Mage_Core_Helper_Abstract::_getModuleName()
Mage_Core_Helper_Abstract::_getRequest()
Mage_Core_Helper_Abstract::_getUrl()
Mage_Core_Helper_Abstract::_loadCache()
Mage_Core_Helper_Abstract::_removeCache()
Mage_Core_Helper_Abstract::_saveCache()
Mage_Core_Helper_Abstract::__()

Class Constants

XML_NODE_REMOTE_ADDR_HEADERS = 'global/remote_addr_headers' (line 36)

Class Mage_Core_Helper_Http

Inherited Variables

Inherited Methods