Mage_Rss_Helper_Data
extends Mage_Core_Helper_Abstract
in package
Maho
Tags
Table of Contents
Constants
- XML_PATH_RSS_ACTIVE = 'rss/config/active'
- Config path to RSS field
- XML_PATH_RSS_ADMIN_CATALOG_NOTIFYSTOCK = 'rss/admin_catalog/notifystock'
- XML_PATH_RSS_ADMIN_CATALOG_REVIEW = 'rss/admin_catalog/review'
- XML_PATH_RSS_ADMIN_ORDER_NEW = 'rss/admin_order/new'
- XML_PATH_RSS_ADMIN_ORDER_NEW_PERIOD = 'rss/admin_order/new_period'
Properties
- $_adminSession : mixed
- $_layout : Mage_Core_Model_Layout
- Layout model object
- $_moduleName : string
- Helper module name
- $_request : Mage_Core_Controller_Request_Http
- Request object
- $_rssSession : mixed
- $modulesDisabled : array<string|int, mixed>
Methods
- __() : string
- Translate
- __construct() : mixed
- authAdmin() : mixed
- Authenticate admin and check ACL
- authFailed() : mixed
- Send authenticate failed headers
- authFrontend() : mixed
- Authenticate customer on frontend
- authValidate() : array<string|int, mixed>
- Validate Authenticate
- disableFlat() : mixed
- Disable using of flat catalog and/or product model to prevent limiting results to single store. Probably won't work inside a controller.
- escapeHtml() : null|string|array<string|int, string>
- Escape html entities
- escapeScriptIdentifiers() : string
- Remove `javascript:`, `vbscript:`, `data:` words from the string.
- escapeSpecial() : string
- Remove `\t`,`\n`,`\r`,`\0`,`\x0B:` symbols from the string.
- escapeUrl() : string
- Escape html entities in url
- getLayout() : Mage_Core_Model_Layout
- Retrieve layout model object
- getRssAdminOrderNewPeriod() : int
- hasTags() : bool
- Check for tags in multidimensional arrays
- htmlEscape() : null|string|array<string|int, string>
- isModuleEnabled() : bool
- Check is module exists and enabled in global config.
- isModuleOutputEnabled() : bool
- Check whether the module output is enabled in Configuration
- isRssAdminCatalogNotifyStockEnabled() : bool
- isRssAdminCatalogReviewEnabled() : bool
- isRssAdminOrderNewEnabled() : bool
- isRssEnabled() : bool
- Check if module was activated in system configurations
- jsQuoteEscape() : string|array<string|int, string>
- Escape quotes in java script
- quoteEscape() : string
- Escape quotes inside html attributes Use $addSlashes = false for escaping js that inside html attribute (onClick, onSubmit etc)
- removeTags() : string
- Remove html tags, but leave "<" and ">" signs
- setLayout() : Mage_Core_Helper_Abstract
- Declare layout
- stripTags() : string
- Wrapper for standard strip_tags() function with extra functionality for html entities
- translateArray() : array<string|int, mixed>
- Translate array
- urlDecode() : string
- base64_decode() for URLs decoding
- urlDecodeAndEscape() : string
- base64_decode() and escape quotes in url
- urlEncode() : string
- base64_encode() for URLs encoding
- urlEscape() : string
- _cleanCache() : Mage_Core_Helper_Abstract
- Cleaning cache
- _getModuleName() : string
- Retrieve helper module name
- _getRequest() : Mage_Core_Controller_Request_Http
- Retrieve request object
- _getUrl() : string
- Retrieve url
- _loadCache() : mixed
- Loading cache data
- _removeCache() : Mage_Core_Helper_Abstract
- Removing cache
- _saveCache() : Mage_Core_Helper_Abstract
- Saving cache
Constants
XML_PATH_RSS_ACTIVE
Config path to RSS field
public
mixed
XML_PATH_RSS_ACTIVE
= 'rss/config/active'
XML_PATH_RSS_ADMIN_CATALOG_NOTIFYSTOCK
public
mixed
XML_PATH_RSS_ADMIN_CATALOG_NOTIFYSTOCK
= 'rss/admin_catalog/notifystock'
XML_PATH_RSS_ADMIN_CATALOG_REVIEW
public
mixed
XML_PATH_RSS_ADMIN_CATALOG_REVIEW
= 'rss/admin_catalog/review'
XML_PATH_RSS_ADMIN_ORDER_NEW
public
mixed
XML_PATH_RSS_ADMIN_ORDER_NEW
= 'rss/admin_order/new'
XML_PATH_RSS_ADMIN_ORDER_NEW_PERIOD
public
mixed
XML_PATH_RSS_ADMIN_ORDER_NEW_PERIOD
= 'rss/admin_order/new_period'
Properties
$_adminSession
protected
mixed
$_adminSession
$_layout
Layout model object
protected
Mage_Core_Model_Layout
$_layout
$_moduleName
Helper module name
protected
string
$_moduleName
= 'Mage_Rss'
$_request
Request object
protected
Mage_Core_Controller_Request_Http
$_request
$_rssSession
protected
mixed
$_rssSession
$modulesDisabled
protected
array<string|int, mixed>
$modulesDisabled
= []
Methods
__()
Translate
public
__() : string
Return values
string__construct()
public
__construct([array<string|int, mixed> $params = [] ]) : mixed
Parameters
- $params : array<string|int, mixed> = []
authAdmin()
Authenticate admin and check ACL
public
authAdmin(string $path) : mixed
Parameters
- $path : string
authFailed()
Send authenticate failed headers
public
authFailed() : mixed
authFrontend()
Authenticate customer on frontend
public
authFrontend() : mixed
authValidate()
Validate Authenticate
public
authValidate([array<string|int, mixed> $headers = null ]) : array<string|int, mixed>
Parameters
- $headers : array<string|int, mixed> = null
Return values
array<string|int, mixed>disableFlat()
Disable using of flat catalog and/or product model to prevent limiting results to single store. Probably won't work inside a controller.
public
disableFlat() : mixed
escapeHtml()
Escape html entities
public
escapeHtml(string|array<string|int, string> $data[, array<string|int, mixed>|null $allowedTags = null ]) : null|string|array<string|int, string>
Parameters
- $data : string|array<string|int, string>
- $allowedTags : array<string|int, mixed>|null = null
Return values
null|string|array<string|int, string>escapeScriptIdentifiers()
Remove `javascript:`, `vbscript:`, `data:` words from the string.
public
escapeScriptIdentifiers(string $data) : string
Parameters
- $data : string
Return values
stringescapeSpecial()
Remove `\t`,`\n`,`\r`,`\0`,`\x0B:` symbols from the string.
public
escapeSpecial(string $data) : string
Parameters
- $data : string
Return values
stringescapeUrl()
Escape html entities in url
public
escapeUrl(string $data) : string
Parameters
- $data : string
Return values
stringgetLayout()
Retrieve layout model object
public
getLayout() : Mage_Core_Model_Layout
Return values
Mage_Core_Model_LayoutgetRssAdminOrderNewPeriod()
public
getRssAdminOrderNewPeriod([null|string|bool|int|Mage_Core_Model_Store $store = null ]) : int
Parameters
- $store : null|string|bool|int|Mage_Core_Model_Store = null
Return values
inthasTags()
Check for tags in multidimensional arrays
public
hasTags(string|array<string|int, mixed> $data[, array<string|int, mixed> $arrayKeys = [] ][, bool $skipTags = true ]) : bool
Parameters
- $data : string|array<string|int, mixed>
- $arrayKeys : array<string|int, mixed> = []
-
keys of the array being checked that are excluded and included in the check
- $skipTags : bool = true
-
skip transferred array keys, if false then check only them
Return values
boolhtmlEscape()
public
htmlEscape(string|array<string|int, string> $data[, array<string|int, mixed>|null $allowedTags = null ]) : null|string|array<string|int, string>
after 1.4.0.0-rc1
Parameters
- $data : string|array<string|int, string>
- $allowedTags : array<string|int, mixed>|null = null
Tags
Return values
null|string|array<string|int, string>isModuleEnabled()
Check is module exists and enabled in global config.
public
isModuleEnabled([string $moduleName = null ]) : bool
Parameters
- $moduleName : string = null
-
the full module name, example Mage_Core
Return values
boolisModuleOutputEnabled()
Check whether the module output is enabled in Configuration
public
isModuleOutputEnabled([string $moduleName = null ]) : bool
Parameters
- $moduleName : string = null
-
Full module name
Return values
boolisRssAdminCatalogNotifyStockEnabled()
public
isRssAdminCatalogNotifyStockEnabled() : bool
Return values
boolisRssAdminCatalogReviewEnabled()
public
isRssAdminCatalogReviewEnabled() : bool
Return values
boolisRssAdminOrderNewEnabled()
public
isRssAdminOrderNewEnabled([null|string|bool|int|Mage_Core_Model_Store $store = null ]) : bool
Parameters
- $store : null|string|bool|int|Mage_Core_Model_Store = null
Return values
boolisRssEnabled()
Check if module was activated in system configurations
public
isRssEnabled() : bool
Return values
booljsQuoteEscape()
Escape quotes in java script
public
jsQuoteEscape(string|array<string|int, string> $data[, string $quote = ''' ]) : string|array<string|int, string>
Parameters
- $data : string|array<string|int, string>
- $quote : string = '''
Return values
string|array<string|int, string>quoteEscape()
Escape quotes inside html attributes Use $addSlashes = false for escaping js that inside html attribute (onClick, onSubmit etc)
public
quoteEscape(string $data[, bool $addSlashes = false ]) : string
Parameters
- $data : string
- $addSlashes : bool = false
Return values
stringremoveTags()
Remove html tags, but leave "<" and ">" signs
public
removeTags(string $html) : string
Parameters
- $html : string
Return values
stringsetLayout()
Declare layout
public
setLayout(Mage_Core_Model_Layout $layout) : Mage_Core_Helper_Abstract
Parameters
- $layout : Mage_Core_Model_Layout
Return values
Mage_Core_Helper_AbstractstripTags()
Wrapper for standard strip_tags() function with extra functionality for html entities
public
stripTags(string $data[, null|string|array<string|int, string> $allowableTags = null ][, bool $escape = false ]) : string
Parameters
- $data : string
- $allowableTags : null|string|array<string|int, string> = null
- $escape : bool = false
Return values
stringtranslateArray()
Translate array
public
translateArray([mixed $arr = [] ]) : array<string|int, mixed>
@param array $arr
Parameters
- $arr : mixed = []
Return values
array<string|int, mixed>urlDecode()
base64_decode() for URLs decoding
public
urlDecode(mixed $url) : string
@param string $url
Parameters
- $url : mixed
Return values
stringurlDecodeAndEscape()
base64_decode() and escape quotes in url
public
urlDecodeAndEscape(mixed $url) : string
@param string $url
Parameters
- $url : mixed
Return values
stringurlEncode()
base64_encode() for URLs encoding
public
urlEncode(mixed $url) : string
@param string $url
Parameters
- $url : mixed
Return values
stringurlEscape()
public
urlEscape(string $data) : string
after 1.4.0.0-rc1
Parameters
- $data : string
Tags
Return values
string_cleanCache()
Cleaning cache
protected
_cleanCache([array<string|int, mixed> $tags = [] ]) : Mage_Core_Helper_Abstract
Parameters
- $tags : array<string|int, mixed> = []
Return values
Mage_Core_Helper_Abstract_getModuleName()
Retrieve helper module name
protected
_getModuleName() : string
Return values
string_getRequest()
Retrieve request object
protected
_getRequest() : Mage_Core_Controller_Request_Http
Return values
Mage_Core_Controller_Request_Http_getUrl()
Retrieve url
protected
_getUrl(string $route[, array<string|int, mixed> $params = [] ]) : string
Parameters
- $route : string
- $params : array<string|int, mixed> = []
Return values
string_loadCache()
Loading cache data
protected
_loadCache(string $id) : mixed
Parameters
- $id : string
_removeCache()
Removing cache
protected
_removeCache(string $id) : Mage_Core_Helper_Abstract
Parameters
- $id : string
Return values
Mage_Core_Helper_Abstract_saveCache()
Saving cache
protected
_saveCache(mixed $data, string $id[, array<string|int, mixed> $tags = [] ][, null|false|int $lifeTime = false ]) : Mage_Core_Helper_Abstract
Parameters
- $data : mixed
- $id : string
- $tags : array<string|int, mixed> = []
- $lifeTime : null|false|int = false