Documentation

Mage_Adminhtml_Helper_Help_Mapping extends Mage_Core_Helper_Abstract
in package

AbstractYes

Table of Contents

Properties

$_layout  : Mage_Core_Model_Layout
Layout model object
$_moduleMappings  : array<string|int, mixed>
Mapping of help page urls depending on module and page route
$_moduleName  : string
Helper module name
$_request  : Mage_Core_Controller_Request_Http
Request object
$modulesDisabled  : array<string|int, mixed>

Methods

__()  : string
Translate
escapeHtml()  : ($data is array ? ?string[] : ?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
hasTags()  : bool
Check for tags in multidimensional arrays
isModuleEnabled()  : bool
Check is module exists and enabled in global config.
isModuleOutputEnabled()  : bool
Check whether the module output is enabled in Configuration
jsQuoteEscape()  : ($data is array ? string[] : 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
_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
findInMapping()  : string|bool
Compose reconstructed URL using mapping
getHelpTargetVersion()  : Mage_Core_Model_Config_Element|Element|false
Determine which version of docs should target onto

Properties

$_moduleMappings

Mapping of help page urls depending on module and page route

protected array<string|int, mixed> $_moduleMappings = ['Mage_Adminhtml' => [ /* Dashboard */ 'dashboard' => 'store-operations/reports-dashboard.html', /* Sales */ 'sales_order' => 'order-processing/order-manage.html', 'sales_invoice' => 'order-processing/order-invoice.html', 'sales_shipment' => 'order-processing/order-ship.html', 'sales_creditmemo' => 'order-processing/credit-refunds.html', 'sales_transactions' => 'order-processing/sales-transactions.html', 'sales_recurring_profile' => 'catalog/product-recurring-profile.html', 'checkout_agreement' => 'order-processing/terms-conditions.html', /* Sales → Tax */ 'tax_rule' => 'tax/tax-rules.html', 'tax_rate' => 'tax/tax-zones-rates.html', 'tax_rate/importExport' => 'tax/tax-rates-import-export.html', 'tax_class_customer' => 'tax/tax-class-customer.html', 'tax_class_product' => 'tax/tax-class-product.html', /* Catalog */ 'catalog_product' => 'catalog/product-create.html', 'catalog_category/edit' => 'catalog/category-create.html', 'urlrewrite' => 'search_seo/seo-url-redirect.html', 'catalog_search' => 'search_seo/search-terms.html', 'sitemap' => 'marketing/google-sitemap.html', /* Catalog → Attributes */ 'catalog_product_attribute' => 'catalog/attributes.html', 'catalog_product_set' => 'catalog/attribute-set.html', /* Catalog → Reviews and Ratings → Customer Reviews */ 'catalog_product_review/pending' => 'marketing/product-reviews.html', 'catalog_product_review' => 'marketing/product-reviews.html', 'rating' => 'marketing/product-reviews-ratings.html', /* Catalog → Tags */ 'tag' => 'marketing/tags.html', 'tag/pending' => 'marketing/tags-moderate.html', /* Customers */ 'customer' => 'customers/customer-account-create.html', 'customer_group' => 'customers/customer-group-create.html', 'customer_online' => 'order-processing/customers-online.html', /* Promotions */ 'promo_catalog' => 'marketing/price-rules-catalog.html', 'promo_quote' => 'marketing/price-rules-shopping-cart.html', /* Newsletter */ 'newsletter_template' => 'marketing/newsletter-templates.html', 'newsletter_queue' => 'marketing/newsletter-queue.html', 'newsletter_subscriber' => 'marketing/newsletter.html', 'newsletter_problem' => 'marketing/newsletter.html', /* CMS */ 'cms_page' => 'cms/pages.html', 'cms_block' => 'cms/blocks.html', 'poll' => 'marketing/polls.html', /* Reports → Sales */ 'report_sales/sales' => 'store-operations/reports-generating.html', 'report_sales/tax' => 'store-operations/reports-available.html', 'report_sales/invoiced' => 'store-operations/reports-available.html', 'report_sales/shipping' => 'store-operations/reports-available.html', 'report_sales/refunded' => 'store-operations/reports-available.html', 'report_sales/coupons' => 'store-operations/reports-available.html', /* Reports → Shopping Cart */ 'report_shopcart/product' => 'store-operations/reports-available.html', 'report_shopcart/abandoned' => 'store-operations/reports-available.html', /* Reports → Products */ 'report_sales/bestsellers' => 'store-operations/reports-available.html', 'report_product/sold' => 'store-operations/reports-available.html', 'report_product/viewed' => 'store-operations/reports-available.html', 'report_product/lowstock' => 'store-operations/reports-available.html', 'report_product/downloads' => 'store-operations/reports-available.html', /* Reports → Customers */ 'report_customer/accounts' => 'store-operations/reports-available.html', 'report_customer/totals' => 'store-operations/reports-available.html', 'report_customer/orders' => 'store-operations/reports-available.html', /* Reports → Tags */ 'report_tag/customer' => 'store-operations/reports-available.html', 'report_tag/product' => 'store-operations/reports-available.html', 'report_tag/popular' => 'store-operations/reports-available.html', /* Reports → Reviews */ 'report_review/customer' => 'store-operations/reports-available.html', 'report_review/product' => 'store-operations/reports-available.html', /* Search Terms */ 'report/search' => 'store-operations/reports-available.html', /* Refresh statistics */ 'report_statistics' => 'store-operations/reports-refresh.html', /* My Account */ 'system_account' => 'store-operations/admin-my-account.html', /* Notifications */ 'notification' => 'store-operations/admin-messages.html', /* Tools → Backup */ 'system_backup' => 'system-operations/server-backup-rollback.html', /* Web Services */ 'api_user' => 'system-operations/web-services.html', 'api_role' => 'system-operations/web-services.html', 'api2_role' => 'system-operations/web-services.html', /* System → Design */ 'system_design' => 'design/themes.html', /* System → Import/Export */ 'system_convert_gui' => 'store-operations/dataflow.html', 'system_convert_profile' => 'store-operations/dataflow.html', /* System → Manage Currency */ 'system_currency' => 'store-operations/currency-rates.html', 'system_currencysymbol' => 'store-operations/currency-symbols.html', /* System → Transactional emails */ 'system_email_template' => 'store-operations/email-transactional.html', /* System → Custom Variables */ 'system_variable' => 'cms/variables-custom.html', /* System → Permissions */ 'permissions_user' => 'store-operations/permissions-user-new.html', 'permissions_role' => 'store-operations/permissions-role-custom.html', /* System → Cache Management */ 'cache' => 'system-operations/cache-management.html', /* System → Stores Management */ 'system_store' => 'store-operations/store-hierarchy.html', /* System → Order statuses */ 'sales_order_status' => 'order-processing/order-status.html', /* System → Configuration */ 'system_config/edit/section/general' => 'configuration/general/general.html', 'system_config/edit/section/web' => 'configuration/general/web.html', 'system_config/edit/section/design' => 'configuration/general/design.html', 'system_config/edit/section/currency' => 'configuration/general/currency-setup.html', 'system_config/edit/section/trans_email' => 'configuration/general/store-email-addresses.html', 'system_config/edit/section/contacts' => 'configuration/general/contacts.html', 'system_config/edit/section/reports' => 'configuration/general/reports.html', 'system_config/edit/section/cms' => 'configuration/general/content-management.html', 'system_config/edit/section/catalog' => 'configuration/catalog/catalog.html', 'system_config/edit/section/configswatches' => 'configuration/catalog/configurable-swatches.html', 'system_config/edit/section/cataloginventory' => 'configuration/catalog/inventory.html', 'system_config/edit/section/sitemap' => 'configuration/catalog/google-sitemap.html', 'system_config/edit/section/rss' => 'configuration/catalog/rss-feeds.html', 'system_config/edit/section/newsletter' => 'configuration/customers/newsletter.html', 'system_config/edit/section/customer' => 'configuration/customers/customer-configuration.html', 'system_config/edit/section/wishlist' => 'configuration/customers/wishlist.html', 'system_config/edit/section/promo' => 'configuration/customers/promotions.html', 'system_config/edit/section/sales' => 'configuration/sales/sales.html', 'system_config/edit/section/sales_email' => 'configuration/sales/sales-emails.html', 'system_config/edit/section/sales_pdf' => 'configuration/sales/pdf-print-outs.html', 'system_config/edit/section/tax' => 'configuration/sales/tax.html', 'system_config/edit/section/checkout' => 'configuration/sales/checkout.html', 'system_config/edit/section/shipping' => 'configuration/sales/shipping-settings.html', 'system_config/edit/section/carriers' => 'configuration/sales/shipping-methods.html', 'system_config/edit/section/google' => 'configuration/sales/google-api.html', 'system_config/edit/section/payment' => 'configuration/sales/payment-methods.html', 'system_config/edit/section/payment_services' => 'configuration/sales/payment-services.html', 'system_config/edit/section/api' => 'configuration/services/magento-core-api.html', 'system_config/edit/section/oauth' => 'configuration/services/oauth.html', 'system_config/edit/section/admin' => 'configuration/advanced/admin.html', 'system_config/edit/section/system' => 'configuration/advanced/system.html', 'system_config/edit/section/advanced' => 'configuration/advanced/advanced.html', 'system_config/edit/section/dev' => 'configuration/advanced/developer.html', ], 'Mage_Widget_Adminhtml' => ['widget_instance' => 'cms/widgets.html'], 'Mage_Api2_Adminhtml' => ['api2_attribute' => 'system-operations/web-services.html'], 'Mage_Oauth_Adminhtml' => ['oauth_consumer' => 'system-operations/web-services.html', 'oauth_authorizedTokens' => 'system-operations/web-services.html', 'oauth_admin_token' => 'system-operations/web-services.html'], 'Mage_ImportExport_Adminhtml' => ['import' => 'store-operations/data-import.html', 'export' => 'store-operations/data-export.html'], 'Mage_Connect_Adminhtml' => ['extension_custom/edit' => 'magento/magento-connect.html'], 'Mage_Index_Adminhtml' => ['process/list' => 'system-operations/index-management.html']]

$_moduleName

Helper module name

protected string $_moduleName = 'Mage_Adminhtml'

$modulesDisabled

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

Methods

__()

Translate

public __() : string
Return values
string

escapeHtml()

Escape html entities

public escapeHtml(null|string|array<string|int, string> $data[, null|array<string|int, string> $allowedTags = null ]) : ($data is array ? ?string[] : ?string)
Parameters
$data : null|string|array<string|int, string>
$allowedTags : null|array<string|int, string> = null
Return values
($data is array ? ?string[] : ?string)

escapeScriptIdentifiers()

Remove `javascript:`, `vbscript:`, `data:` words from the string.

public escapeScriptIdentifiers(string $data) : string
Parameters
$data : string
Return values
string

escapeSpecial()

Remove `\t`,`\n`,`\r`,`\0`,`\x0B:` symbols from the string.

public escapeSpecial(string $data) : string
Parameters
$data : string
Return values
string

escapeUrl()

Escape html entities in url

public escapeUrl(string $data) : string
Parameters
$data : string
Return values
string

hasTags()

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
bool

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
bool

isModuleOutputEnabled()

Check whether the module output is enabled in Configuration

public isModuleOutputEnabled([string $moduleName = null ]) : bool
Parameters
$moduleName : string = null

Full module name

Return values
bool

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
string

removeTags()

Remove html tags, but leave "<" and ">" signs

public removeTags(string $html) : string
Parameters
$html : string
Return values
string

stripTags()

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
string

translateArray()

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
string

urlDecodeAndEscape()

base64_decode() and escape quotes in url

public urlDecodeAndEscape(mixed $url) : string

@param string $url

Parameters
$url : mixed
Return values
string

urlEncode()

base64_encode() for URLs encoding

public urlEncode(mixed $url) : string

@param string $url

Parameters
$url : mixed
Return values
string

_getModuleName()

Retrieve helper module name

protected _getModuleName() : string
Return values
string

_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

_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
Return values
Mage_Core_Helper_Abstract

findInMapping()

Compose reconstructed URL using mapping

protected findInMapping(string $frontModule, string $controllerName, string $actionName) : string|bool
Parameters
$frontModule : string
$controllerName : string
$actionName : string
Return values
string|bool
On this page

Search results