Mage_Eav_Block_Adminhtml_Attribute_Edit_Js
extends Mage_Adminhtml_Block_Template
in package
Maho
Tags
Table of Contents
Constants
- CACHE_GROUP = 'block_html'
- Cache group Tag
- CACHE_KEY_PREFIX = 'BLOCK_'
- Prefix for cache key
- CACHE_TAGS_DATA_KEY = 'cache_tags'
- Cache tags data key
- XML_PATH_DEBUG_TEMPLATE_HINTS = 'dev/debug/template_hints'
- XML_PATH_DEBUG_TEMPLATE_HINTS_ADMIN = 'dev/debug/template_hints_admin'
- XML_PATH_DEBUG_TEMPLATE_HINTS_BLOCKS = 'dev/debug/template_hints_blocks'
- XML_PATH_DEBUG_TEMPLATE_HINTS_BLOCKS_ADMIN = 'dev/debug/template_hints_blocks_admin'
- XML_PATH_TEMPLATE_ALLOW_SYMLINK = 'dev/template/allow_symlink'
Properties
- $_alias : string
- Short alias of this block that was referred from parent
- $_anonSuffix : string
- Suffix for name of anonymous block
- $_app : Mage_Core_Model_App|null
- Application instance
- $_baseUrl : mixed
- $_childGroups : array<string|int, mixed>
- Arbitrary groups of child blocks
- $_children : array<string|int, Mage_Core_Block_Abstract>
- Contains references to child block objects
- $_childrenHtmlCache : array<string|int, mixed>
- Children blocks HTML cache array
- $_data : array<string|int, mixed>|null
- Object attributes
- $_dirty : array<string|int, mixed>
- $_factory : Mage_Core_Model_Factory|null
- Factory instance
- $_frameCloseTag : string
- Block html frame close tag
- $_frameOpenTag : string
- Block html frame open tag
- $_hasDataChanges : bool
- Data changes flag (true after setData|unsetData call)
- $_idFieldName : string
- Name of object id field
- $_isAnonymous : bool
- Whether this block was not explicitly named
- $_isDeleted : bool
- Object delete flag
- $_jsUrl : mixed
- $_layout : Mage_Core_Model_Layout
- Parent layout of the block
- $_messagesBlock : Mage_Core_Block_Messages|null
- Messages block instance
- $_nameInLayout : string
- Block name in layout
- $_oldFieldsMap : array<string|int, mixed>
- Map short fields names to its full names
- $_parent : Mage_Core_Block_Abstract
- Parent block
- $_parentBlock : Mage_Core_Block_Abstract
- Parent block
- $_request : Zend_Controller_Request_Http
- Request object
- $_showTemplateHints : mixed
- $_showTemplateHintsAdmin : mixed
- $_showTemplateHintsBlocks : mixed
- $_showTemplateHintsBlocksAdmin : mixed
- $_sortedChildren : array<string|int, mixed>
- Sorted children list
- $_sortInstructions : array<string|int, mixed>
- Array of block sort priority instructions
- $_syncFieldsMap : mixed
- Map of fields to sync to other fields upon changing their data
- $_template : string
- Path to template file in theme.
- $_translationHelper : Mage_Core_Helper_Abstract|null
- Translation helper instance
- $_underscoreCache : array<string|int, mixed>
- Setter/Getter underscore transformation cache
- $_urlModel : Mage_Core_Model_Url
- Url object
- $_viewDir : string
- View scripts directory
- $_viewVars : array<string|int, mixed>
- Assigned variables for view
- $_transportObject : Varien_Object
Methods
- __() : string
- Translate block sentence
- __call() : mixed
- Set/Get attribute wrapper
- __construct() : mixed
- Initialize factory instance
- __get() : mixed
- Attribute getter (deprecated)
- __set() : mixed
- Attribute setter (deprecated)
- __toArray() : array<string|int, mixed>
- Convert object attributes to array
- addCacheTag() : $this
- Add tag to block
- addData() : $this
- Add data to the object.
- addModelTags() : $this
- Add tags from specified model to current block
- addToChildGroup() : mixed
- Make sure specified block will be registered in the specified child groups
- addToParentGroup() : $this
- Add self to the specified group of parent block
- append() : $this
- Append child block
- assign() : $this
- Assign variable
- countChildren() : int
- Get children blocks count
- debug() : string|array<string|int, mixed>
- Present object data as string in debug mode
- escapeHtml() : null|string|array<string|int, string>
- Escape html entities
- escapeHtmlArrayAsObject() : array<string|int, Mage_Core_Model_Security_HtmlEscapedString>
- Wrapper for escapeHtml() function with keeping original value
- escapeHtmlAsObject() : Mage_Core_Model_Security_HtmlEscapedString
- Wrapper for escapeHtml() function with keeping original value
- escapeUrl() : string
- Escape html entities in url
- fetchView() : string
- Retrieve block view from file (template)
- flagDirty() : $this
- formatDate() : string
- Retrieve formatting date
- formatTime() : string
- Retrieve formatting time
- formatTimezoneDate() : string
- Retrieve formatting timezone date
- getAction() : Mage_Core_Controller_Varien_Action
- Retrieve current action object
- getAnonSuffix() : string
- Returns anonymous block suffix
- getArea() : string
- Get design area
- getBaseUrl() : string
- Get base url of the application
- getBlockAlias() : string
- Returns block alias
- getBlockHtml() : string
- Retrieve block html
- getCacheKey() : string
- Get Key for caching block content
- getCacheKeyInfo() : array<string|int, mixed>
- Get cache key informative items Provide string array key to share specific info item with FPC placeholder
- getCacheLifetime() : int|null
- Get block cache lifetime
- getCacheTags() : array<string|int, mixed>
- Get tags array for saving cache
- getChild() : mixed
- Retrieve child block by name
- getChildChildHtml() : string
- getChildData() : mixed|void
- Get a value from child block by specified key
- getChildGroup() : array<string|int, mixed>
- Get a group of child blocks
- getChildHtml() : string
- Retrieve child block HTML
- getData() : mixed
- Object data getter
- 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
- getDirectOutput() : bool
- Check if direct output is allowed for block
- getFormKey() : string
- Retrieve Session Form Key
- getHelper() : Mage_Core_Block_Abstract
- Return block helper
- getIconDataUrl() : string
- getIconSvg() : string
- getId() : mixed
- Retrieve object id
- getIdFieldName() : string
- Retrieve name of object id field
- getIsAnonymous() : bool
- Check if block is using auto generated (Anonymous) name
- getItemsTags() : array<string|int, mixed>
- Collect and retrieve items tags.
- getJsUrl() : string
- Get url of base javascript file
- getLayout() : Mage_Core_Model_Layout
- Retrieve layout object
- getMessagesBlock() : Mage_Core_Block_Messages
- Retrieve messages block
- getModuleName() : string
- Retrieve module name of block
- getNameInLayout() : string
- Alias for getName method.
- getObjectData() : mixed
- Get data from specified object
- getParentBlock() : $this
- Retrieve parent block
- getPosition() : string
- getRequest() : Mage_Core_Controller_Request_Http
- Retrieve request object
- getShowTemplateHints() : bool
- getShowTemplateHintsAdmin() : bool
- getSkinUrl() : string
- Retrieve url of skins file
- getSortedChildBlocks() : array<string|int, Mage_Core_Block_Abstract>
- Obtain sorted child blocks
- getSortedChildren() : array<string|int, mixed>
- Retrieve sorted list of children.
- getTemplate() : string
- Get relevant path to template
- getTemplateFile() : string
- Get absolute path to template
- getTranslationHelper() : Mage_Core_Helper_Abstract
- Helper getter for translations
- getUrl() : string
- Generate url by route and parameters
- getUrlBase64() : string
- Generate base64-encoded url by route and parameters
- getUrlEncoded() : string
- Generate url-encoded url by route and parameters
- getUrlSecure() : string
- Generate security url by route and parameters (add form key if "Add Secret Key to URLs" disabled)
- 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
- hasWrapperMustBeVisible() : bool
- helper() : Mage_Core_Helper_Abstract
- Returns helper object
- htmlEscape() : string
- insert() : object
- Insert child block
- 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
- isModuleEnabled() : bool
- isModuleOutputEnabled() : bool
- Check whether the module output is enabled
- isOutputEnabled() : bool
- jsonDecode() : mixed
- Decodes the given $encodedValue string which is encoded in the JSON format
- jsonEncode() : string
- Encode the mixed $valueToEncode into the JSON format
- jsQuoteEscape() : mixed
- Escape quotes in java scripts
- maliciousCodeFilter() : string
- Deleting script tags from string
- offsetExists() : bool
- Implementation of ArrayAccess::offsetExists()
- offsetGet() : mixed
- Implementation of ArrayAccess::offsetGet()
- offsetSet() : void
- Implementation of ArrayAccess::offsetSet()
- offsetUnset() : void
- Implementation of ArrayAccess::offsetUnset()
- quoteEscape() : string
- Escape quotes inside html attributes Use $addSlashes = false for escaping js that inside html attribute (onClick, onSubmit etc)
- renderView() : string
- Render block
- serialize() : string
- serialize object attributes
- setAdditionalHtml() : $this
- setAnonSuffix() : $this
- Set anonymous suffix for current block
- setAttribute() : $this
- Set block attribute value
- setBlockAlias() : $this
- Set block alias
- setBlockParams() : $this
- setCacheKey() : $this
- setCacheLifetime() : $this
- setCacheTags() : $this
- setChild() : $this
- Set child block
- setClass() : $this
- setContentHeading() : $this
- setData() : $this
- Overwrite data in the object.
- setDataChanges() : $this
- Clears data changes status
- setDataUsingMethod() : $this
- Set object data with calling setter method
- setDestElementId() : $this
- setDisabled() : $this
- setDisplayMinimalPrice() : $this
- setFormAction() : $this
- setFrameTags() : $this
- Specify block output frame tags
- setId() : $this
- Set object id field value
- setIdFieldName() : $this
- set name of object id field
- setIdSuffix() : $this
- setIsAnonymous() : $this
- Set the anonymous flag
- setLabel() : $this
- setLayout() : $this
- Set layout object
- setMessagesBlock() : $this
- Set messages block
- setNameInLayout() : $this
- Set block's name in layout and unsets previous link if such exists.
- setOnclick() : $this
- setParentBlock() : $this
- Set parent block
- setProduct() : $this
- setScriptPath() : $this
- Set template location directory
- setTemplate() : $this
- Set path to template used for generating block's output.
- setTemplate() : $this
- setTranslationHelper() : $this
- Helper setter for translations
- setType() : $this
- sortChildren() : $this
- Sort block's children
- stripTags() : string
- Wrapper for standard strip_tags() function with extra functionality for html entities
- toArray() : array<string|int, mixed>
- Public wrapper for __toArray
- toHtml() : string
- Produce and return block's html output
- toJson() : string
- Public wrapper for __toJson
- toString() : string
- Public wrapper for __toString
- toXml() : string
- Public wrapper for __toXml
- unsetCallChild() : $this
- Call a child and unset it, if callback matched result
- unsetChild() : $this
- Unset child block
- unsetChildren() : $this
- Unset all children blocks
- unsetData() : $this
- Unset data from the object.
- unsetOldData() : $this
- Unset old fields data from the object.
- urlEscape() : string
- __toJson() : string
- Convert object attributes to JSON
- __toXml() : string
- Convert object attributes to XML
- _addFullNames() : mixed
- _afterCacheUrl() : string
- Replace URLs from cache
- _afterToHtml() : string
- Processing block html after rendering
- _beforeCacheUrl() : $this
- Prepare url for save to cache
- _beforeChildToHtml() : mixed
- Prepare child block before generate html
- _beforeToHtml() : $this
- Before rendering html, but after trying to load cache
- _camelize() : string
- _construct() : void
- Internal constructor, that is called from real constructor
- _getAllowSymlinks() : bool
- Get is allowed symlinks flag
- _getApp() : Mage_Core_Model_App
- Retrieve application instance
- _getChildHtml() : string
- Retrieve child block HTML
- _getData() : mixed
- Get value from _data array without parse key
- _getFactory() : Mage_Core_Model_Factory
- Retrieve factory instance
- _getSidPlaceholder() : string
- Get SID placeholder for cache
- _getTagsCacheKey() : string
- Get cache key for tags
- _getUrlModel() : Mage_Core_Model_Url
- Create and return url object
- _getUrlModelClass() : string
- Returns url model class name
- _initOldFieldsMap() : mixed
- Inits mapping array of object's previously used fields to new fields.
- _isSecure() : bool
- Checks is request Url is secure
- _loadCache() : string|false
- Load block html from cache storage
- _prepareArray() : array<string|int, mixed>
- Set required array elements
- _prepareLayout() : $this
- Preparing global layout
- _prepareSyncFieldsMap() : $this
- Called after old fields are inited. Forms synchronization map to sync old fields and new fields between each other.
- _saveCache() : $this|false
- Save block content to cache storage
- _toHtml() : string
- Prepare html output
- _underscore() : string
- Converts field names for setters and getters
- _getCacheHintStatusColor() : string
- Retrieve block cache status
Constants
CACHE_GROUP
Cache group Tag
public
mixed
CACHE_GROUP
= 'block_html'
CACHE_KEY_PREFIX
Prefix for cache key
public
mixed
CACHE_KEY_PREFIX
= 'BLOCK_'
CACHE_TAGS_DATA_KEY
Cache tags data key
public
mixed
CACHE_TAGS_DATA_KEY
= 'cache_tags'
XML_PATH_DEBUG_TEMPLATE_HINTS
public
mixed
XML_PATH_DEBUG_TEMPLATE_HINTS
= 'dev/debug/template_hints'
XML_PATH_DEBUG_TEMPLATE_HINTS_ADMIN
public
mixed
XML_PATH_DEBUG_TEMPLATE_HINTS_ADMIN
= 'dev/debug/template_hints_admin'
XML_PATH_DEBUG_TEMPLATE_HINTS_BLOCKS
public
mixed
XML_PATH_DEBUG_TEMPLATE_HINTS_BLOCKS
= 'dev/debug/template_hints_blocks'
XML_PATH_DEBUG_TEMPLATE_HINTS_BLOCKS_ADMIN
public
mixed
XML_PATH_DEBUG_TEMPLATE_HINTS_BLOCKS_ADMIN
= 'dev/debug/template_hints_blocks_admin'
XML_PATH_TEMPLATE_ALLOW_SYMLINK
public
mixed
XML_PATH_TEMPLATE_ALLOW_SYMLINK
= 'dev/template/allow_symlink'
Properties
$_alias
Short alias of this block that was referred from parent
protected
string
$_alias
$_anonSuffix
Suffix for name of anonymous block
protected
string
$_anonSuffix
$_app
Application instance
protected
Mage_Core_Model_App|null
$_app
$_baseUrl
protected
mixed
$_baseUrl
$_childGroups
Arbitrary groups of child blocks
protected
array<string|int, mixed>
$_childGroups
= []
$_children
Contains references to child block objects
protected
array<string|int, Mage_Core_Block_Abstract>
$_children
= []
$_childrenHtmlCache
Children blocks HTML cache array
protected
array<string|int, mixed>
$_childrenHtmlCache
= []
$_data
Object attributes
protected
array<string|int, mixed>|null
$_data
= []
$_dirty
protected
array<string|int, mixed>
$_dirty
$_factory
Factory instance
protected
Mage_Core_Model_Factory|null
$_factory
$_frameCloseTag
Block html frame close tag
protected
string
$_frameCloseTag
$_frameOpenTag
Block html frame open tag
protected
string
$_frameOpenTag
$_hasDataChanges
Data changes flag (true after setData|unsetData call)
protected
bool
$_hasDataChanges
= \false
$_idFieldName
Name of object id field
protected
string
$_idFieldName
= \null
$_isAnonymous
Whether this block was not explicitly named
protected
bool
$_isAnonymous
= \false
$_isDeleted
Object delete flag
protected
bool
$_isDeleted
= \false
$_jsUrl
protected
mixed
$_jsUrl
$_layout
Parent layout of the block
protected
Mage_Core_Model_Layout
$_layout
$_messagesBlock
Messages block instance
protected
Mage_Core_Block_Messages|null
$_messagesBlock
= \null
$_nameInLayout
Block name in layout
protected
string
$_nameInLayout
$_oldFieldsMap
Map short fields names to its full names
protected
array<string|int, mixed>
$_oldFieldsMap
= []
$_parent
Parent block
protected
Mage_Core_Block_Abstract
$_parent
$_parentBlock
Parent block
protected
Mage_Core_Block_Abstract
$_parentBlock
$_request
Request object
protected
Zend_Controller_Request_Http
$_request
$_showTemplateHints
protected
static mixed
$_showTemplateHints
$_showTemplateHintsAdmin
protected
static mixed
$_showTemplateHintsAdmin
$_showTemplateHintsBlocks
protected
static mixed
$_showTemplateHintsBlocks
$_showTemplateHintsBlocksAdmin
protected
static mixed
$_showTemplateHintsBlocksAdmin
$_sortedChildren
Sorted children list
protected
array<string|int, mixed>
$_sortedChildren
= []
$_sortInstructions
Array of block sort priority instructions
protected
array<string|int, mixed>
$_sortInstructions
= []
$_syncFieldsMap
Map of fields to sync to other fields upon changing their data
protected
mixed
$_syncFieldsMap
= []
$_template
Path to template file in theme.
protected
string
$_template
= ''
$_translationHelper
Translation helper instance
protected
Mage_Core_Helper_Abstract|null
$_translationHelper
= \null
$_underscoreCache
Setter/Getter underscore transformation cache
protected
static array<string|int, mixed>
$_underscoreCache
= []
$_urlModel
Url object
protected
static Mage_Core_Model_Url
$_urlModel
$_viewDir
View scripts directory
protected
string
$_viewDir
= ''
$_viewVars
Assigned variables for view
protected
array<string|int, mixed>
$_viewVars
= []
$_transportObject
private
static Varien_Object
$_transportObject
Methods
__()
Translate block sentence
public
__() : string
Return values
string__call()
Set/Get attribute wrapper
public
__call(string $method, array<string|int, mixed> $args) : mixed
Parameters
- $method : string
- $args : array<string|int, mixed>
__construct()
Initialize factory instance
public
__construct() : mixed
__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>addCacheTag()
Add tag to block
public
addCacheTag(string|array<string|int, mixed> $tag) : $this
Parameters
- $tag : string|array<string|int, mixed>
Return values
$thisaddData()
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
$thisaddModelTags()
Add tags from specified model to current block
public
addModelTags(Mage_Core_Model_Abstract $model) : $this
Parameters
- $model : Mage_Core_Model_Abstract
Return values
$thisaddToChildGroup()
Make sure specified block will be registered in the specified child groups
public
addToChildGroup(string $groupName, Mage_Core_Block_Abstract $child) : mixed
Parameters
- $groupName : string
- $child : Mage_Core_Block_Abstract
addToParentGroup()
Add self to the specified group of parent block
public
addToParentGroup(string $groupName) : $this
Parameters
- $groupName : string
Return values
$thisappend()
Append child block
public
append(Mage_Core_Block_Abstract|string $block[, string $alias = '' ]) : $this
Parameters
- $block : Mage_Core_Block_Abstract|string
- $alias : string = ''
Return values
$thisassign()
Assign variable
public
assign(string|array<string|int, mixed> $key[, mixed $value = null ]) : $this
Parameters
- $key : string|array<string|int, mixed>
- $value : mixed = null
Return values
$thiscountChildren()
Get children blocks count
public
countChildren() : int
Return values
intdebug()
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>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>escapeHtmlArrayAsObject()
Wrapper for escapeHtml() function with keeping original value
public
escapeHtmlArrayAsObject(array<string|int, string> $data[, array<string|int, string>|null $allowedTags = null ]) : array<string|int, Mage_Core_Model_Security_HtmlEscapedString>
Parameters
- $data : array<string|int, string>
- $allowedTags : array<string|int, string>|null = null
Return values
array<string|int, Mage_Core_Model_Security_HtmlEscapedString> —@see Mage_Core_Model_Security_HtmlEscapedString::getUnescapedValue()
escapeHtmlAsObject()
Wrapper for escapeHtml() function with keeping original value
public
escapeHtmlAsObject(string $data[, array<string|int, string>|null $allowedTags = null ]) : Mage_Core_Model_Security_HtmlEscapedString
Parameters
- $data : string
- $allowedTags : array<string|int, string>|null = null
Tags
Return values
Mage_Core_Model_Security_HtmlEscapedStringescapeUrl()
Escape html entities in url
public
escapeUrl(string $data) : string
Parameters
- $data : string
Return values
stringfetchView()
Retrieve block view from file (template)
public
fetchView(string $fileName) : string
Parameters
- $fileName : string
Return values
stringflagDirty()
public
flagDirty(string $field[, bool $flag = true ]) : $this
Parameters
- $field : string
- $flag : bool = true
Return values
$thisformatDate()
Retrieve formatting date
public
formatDate([string|int|Zend_Date|null $date = null ][, string $format = Mage_Core_Model_Locale::FORMAT_TYPE_SHORT ][, bool $showTime = false ]) : string
Parameters
- $date : string|int|Zend_Date|null = null
- $format : string = Mage_Core_Model_Locale::FORMAT_TYPE_SHORT
- $showTime : bool = false
Return values
stringformatTime()
Retrieve formatting time
public
formatTime([string $time = null ][, string $format = Mage_Core_Model_Locale::FORMAT_TYPE_SHORT ][, bool $showDate = false ]) : string
Parameters
- $time : string = null
- $format : string = Mage_Core_Model_Locale::FORMAT_TYPE_SHORT
- $showDate : bool = false
Return values
stringformatTimezoneDate()
Retrieve formatting timezone date
public
formatTimezoneDate([string|int|Zend_Date|null $date = null ][, string $format = Mage_Core_Model_Locale::FORMAT_TYPE_SHORT ][, bool $showTime = false ][, bool $useTimezone = true ]) : string
Parameters
- $date : string|int|Zend_Date|null = null
- $format : string = Mage_Core_Model_Locale::FORMAT_TYPE_SHORT
- $showTime : bool = false
- $useTimezone : bool = true
Return values
stringgetAction()
Retrieve current action object
public
getAction() : Mage_Core_Controller_Varien_Action
Return values
Mage_Core_Controller_Varien_ActiongetAnonSuffix()
Returns anonymous block suffix
public
getAnonSuffix() : string
Return values
stringgetArea()
Get design area
public
getArea() : string
Return values
stringgetBaseUrl()
Get base url of the application
public
getBaseUrl() : string
Return values
stringgetBlockAlias()
Returns block alias
public
getBlockAlias() : string
Return values
stringgetBlockHtml()
Retrieve block html
public
getBlockHtml(string $name) : string
Parameters
- $name : string
Return values
stringgetCacheKey()
Get Key for caching block content
public
getCacheKey() : string
Return values
stringgetCacheKeyInfo()
Get cache key informative items Provide string array key to share specific info item with FPC placeholder
public
getCacheKeyInfo() : array<string|int, mixed>
Attributes
- #[Override]
Return values
array<string|int, mixed>getCacheLifetime()
Get block cache lifetime
public
getCacheLifetime() : int|null
Return values
int|nullgetCacheTags()
Get tags array for saving cache
public
getCacheTags() : array<string|int, mixed>
Return values
array<string|int, mixed>getChild()
Retrieve child block by name
public
getChild([string $name = '' ]) : mixed
Parameters
- $name : string = ''
getChildChildHtml()
public
getChildChildHtml(string $name[, string $childName = '' ][, bool $useCache = true ][, bool $sorted = false ]) : string
Parameters
- $name : string
-
Parent block name
- $childName : string = ''
-
OPTIONAL Child block name
- $useCache : bool = true
-
OPTIONAL Use cache flag
- $sorted : bool = false
-
OPTIONAL @see getChildHtml()
Return values
stringgetChildData()
Get a value from child block by specified key
public
getChildData(string $alias[, string $key = '' ]) : mixed|void
Parameters
- $alias : string
- $key : string = ''
Return values
mixed|voidgetChildGroup()
Get a group of child blocks
public
getChildGroup(string $groupName[, string $callback = null ][, bool $skipEmptyResults = true ]) : array<string|int, mixed>
Returns an array of
Parameters
- $groupName : string
- $callback : string = null
- $skipEmptyResults : bool = true
Return values
array<string|int, mixed>getChildHtml()
Retrieve child block HTML
public
getChildHtml([string $name = '' ][, bool $useCache = true ][, bool $sorted = false ]) : string
Parameters
- $name : string = ''
- $useCache : bool = true
- $sorted : bool = false
Return values
stringgetData()
Object data getter
public
getData([string $key = '' ][, string|int $index = null ]) : mixed
If $key is not defined will return all the data as an array. Otherwise, it will return value of the element specified by $key. It is possible to use keys like a/b/c for access nested array data
If $index is specified it will assume that attribute data is an array and retrieve corresponding member. If data is the string - it will be explode by new line character and converted to array.
Parameters
- $key : string = ''
- $index : string|int = null
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
getDirectOutput()
Check if direct output is allowed for block
public
getDirectOutput() : bool
Return values
boolgetFormKey()
Retrieve Session Form Key
public
getFormKey() : string
Attributes
- #[Override]
Return values
stringgetHelper()
Return block helper
public
getHelper(string $type) : Mage_Core_Block_Abstract
Parameters
- $type : string
Return values
Mage_Core_Block_AbstractgetIconDataUrl()
public
getIconDataUrl(string $name[, string $variant = 'outline' ][, array<string|int, mixed> $attributes = [] ]) : string
Parameters
- $name : string
- $variant : string = 'outline'
- $attributes : array<string|int, mixed> = []
Return values
stringgetIconSvg()
public
getIconSvg(string $name[, string $variant = 'outline' ]) : string
Parameters
- $name : string
- $variant : string = 'outline'
Return values
stringgetId()
Retrieve object id
public
getId() : mixed
getIdFieldName()
Retrieve name of object id field
public
getIdFieldName() : string
Return values
stringgetIsAnonymous()
Check if block is using auto generated (Anonymous) name
public
getIsAnonymous() : bool
Return values
boolgetItemsTags()
Collect and retrieve items tags.
public
getItemsTags(array<string|int, mixed>|Varien_Data_Collection $items) : array<string|int, mixed>
Item should implement Mage_Core_Model_Abstract::getCacheIdTags method
Parameters
- $items : array<string|int, mixed>|Varien_Data_Collection
Return values
array<string|int, mixed>getJsUrl()
Get url of base javascript file
public
getJsUrl([string $fileName = '' ]) : string
To get url of skin javascript file use getSkinUrl()
Parameters
- $fileName : string = ''
Return values
stringgetLayout()
Retrieve layout object
public
getLayout() : Mage_Core_Model_Layout
Return values
Mage_Core_Model_LayoutgetMessagesBlock()
Retrieve messages block
public
getMessagesBlock() : Mage_Core_Block_Messages
Return values
Mage_Core_Block_MessagesgetModuleName()
Retrieve module name of block
public
getModuleName() : string
Return values
stringgetNameInLayout()
Alias for getName method.
public
getNameInLayout() : string
Return values
stringgetObjectData()
Get data from specified object
public
getObjectData(Varien_Object $object, string $key) : mixed
Parameters
- $object : Varien_Object
- $key : string
getParentBlock()
Retrieve parent block
public
getParentBlock() : $this
Return values
$thisgetPosition()
public
getPosition() : string
Return values
stringgetRequest()
Retrieve request object
public
getRequest() : Mage_Core_Controller_Request_Http
Tags
Return values
Mage_Core_Controller_Request_HttpgetShowTemplateHints()
public
getShowTemplateHints() : bool
Return values
boolgetShowTemplateHintsAdmin()
public
getShowTemplateHintsAdmin() : bool
Return values
boolgetSkinUrl()
Retrieve url of skins file
public
getSkinUrl([string $file = null ][, array<string|int, mixed> $params = [] ]) : string
Parameters
- $file : string = null
-
path to file in skin
- $params : array<string|int, mixed> = []
Return values
stringgetSortedChildBlocks()
Obtain sorted child blocks
public
getSortedChildBlocks() : array<string|int, Mage_Core_Block_Abstract>
Return values
array<string|int, Mage_Core_Block_Abstract>getSortedChildren()
Retrieve sorted list of children.
public
getSortedChildren() : array<string|int, mixed>
Return values
array<string|int, mixed>getTemplate()
Get relevant path to template
public
getTemplate() : string
Return values
stringgetTemplateFile()
Get absolute path to template
public
getTemplateFile() : string
Return values
stringgetTranslationHelper()
Helper getter for translations
public
getTranslationHelper() : Mage_Core_Helper_Abstract
Return values
Mage_Core_Helper_AbstractgetUrl()
Generate url by route and parameters
public
getUrl([string $route = '' ][, array<string|int, mixed> $params = [] ]) : string
Parameters
- $route : string = ''
- $params : array<string|int, mixed> = []
Return values
stringgetUrlBase64()
Generate base64-encoded url by route and parameters
public
getUrlBase64([string $route = '' ][, array<string|int, mixed> $params = [] ]) : string
Parameters
- $route : string = ''
- $params : array<string|int, mixed> = []
Return values
stringgetUrlEncoded()
Generate url-encoded url by route and parameters
public
getUrlEncoded([string $route = '' ][, array<string|int, mixed> $params = [] ]) : string
Parameters
- $route : string = ''
- $params : array<string|int, mixed> = []
Return values
stringgetUrlSecure()
Generate security url by route and parameters (add form key if "Add Secret Key to URLs" disabled)
public
getUrlSecure([string $route = '' ][, array<string|int, mixed> $params = [] ]) : string
Parameters
- $route : string = ''
- $params : array<string|int, mixed> = []
Return values
stringhasData()
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
boolhasDataChanges()
Get data change status
public
hasDataChanges() : bool
Return values
boolhasWrapperMustBeVisible()
public
hasWrapperMustBeVisible() : bool
Return values
boolhelper()
Returns helper object
public
helper(string $name) : Mage_Core_Helper_Abstract
Parameters
- $name : string
Return values
Mage_Core_Helper_AbstracthtmlEscape()
public
htmlEscape(string|array<string|int, mixed> $data[, array<string|int, mixed> $allowedTags = null ]) : string
after 1.4.0.0-rc1
Parameters
- $data : string|array<string|int, mixed>
- $allowedTags : array<string|int, mixed> = null
Tags
Return values
stringinsert()
Insert child block
public
insert(Mage_Core_Block_Abstract|string $block[, string $siblingName = '' ][, bool $after = false ][, string $alias = '' ]) : object
Parameters
- $block : Mage_Core_Block_Abstract|string
- $siblingName : string = ''
- $after : bool = false
- $alias : string = ''
Return values
object —$this
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
boolisDirty()
public
isDirty([string $field = null ]) : bool
Parameters
- $field : string = null
Return values
boolisEmpty()
checks whether the object is empty
public
isEmpty() : bool
Return values
boolisModuleEnabled()
public
isModuleEnabled([string|null $moduleName = null ][, string $helperAlias = 'core' ]) : bool
Parameters
- $moduleName : string|null = null
- $helperAlias : string = 'core'
Return values
boolisModuleOutputEnabled()
Check whether the module output is enabled
public
isModuleOutputEnabled([string|null $moduleName = null ][, string $helperAlias = 'core' ]) : bool
Because many module blocks belong to Adminhtml module, the feature "Disable module output" doesn't cover Admin area
Parameters
- $moduleName : string|null = null
- $helperAlias : string = 'core'
Return values
boolisOutputEnabled()
public
isOutputEnabled([string $moduleName = null ]) : bool
Parameters
- $moduleName : string = null
-
Full module name
Tags
Return values
booljsonDecode()
Decodes the given $encodedValue string which is encoded in the JSON format
public
jsonDecode(string $encodedValue[, int $objectDecodeType = Zend_Json::TYPE_ARRAY ]) : mixed
Parameters
- $encodedValue : string
- $objectDecodeType : int = Zend_Json::TYPE_ARRAY
Tags
jsonEncode()
Encode the mixed $valueToEncode into the JSON format
public
jsonEncode(mixed $valueToEncode[, bool $cycleCheck = false ][, array<string|int, mixed> $options = [] ]) : string
Parameters
- $valueToEncode : mixed
- $cycleCheck : bool = false
- $options : array<string|int, mixed> = []
Tags
Return values
stringjsQuoteEscape()
Escape quotes in java scripts
public
jsQuoteEscape(mixed $data[, string $quote = ''' ]) : mixed
Parameters
- $data : mixed
- $quote : string = '''
maliciousCodeFilter()
Deleting script tags from string
public
maliciousCodeFilter(string $html) : string
Parameters
- $html : string
Return values
stringoffsetExists()
Implementation of ArrayAccess::offsetExists()
public
offsetExists(string $offset) : bool
Parameters
- $offset : string
Tags
Attributes
- #[Override]
Return values
booloffsetGet()
Implementation of ArrayAccess::offsetGet()
public
offsetGet(string $offset) : mixed
Parameters
- $offset : string
Tags
Attributes
- #[Override]
- #[ReturnTypeWillChange]
offsetSet()
Implementation of ArrayAccess::offsetSet()
public
offsetSet(string $offset, mixed $value) : void
Parameters
- $offset : string
- $value : mixed
Tags
Attributes
- #[Override]
offsetUnset()
Implementation of ArrayAccess::offsetUnset()
public
offsetUnset(string $offset) : void
Parameters
- $offset : string
Tags
Attributes
- #[Override]
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
stringrenderView()
Render block
public
renderView() : string
Return values
stringserialize()
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
stringsetAdditionalHtml()
public
setAdditionalHtml(string $value) : $this
Parameters
- $value : string
Return values
$thissetAnonSuffix()
Set anonymous suffix for current block
public
setAnonSuffix(string $suffix) : $this
Parameters
- $suffix : string
Return values
$thissetAttribute()
Set block attribute value
public
setAttribute(array<string|int, mixed>|string $name[, mixed $value = null ]) : $this
Wrapper for method "setData"
Parameters
- $name : array<string|int, mixed>|string
- $value : mixed = null
Return values
$thissetBlockAlias()
Set block alias
public
setBlockAlias(string $alias) : $this
Parameters
- $alias : string
Return values
$thissetBlockParams()
public
setBlockParams(array<string|int, mixed> $value) : $this
Parameters
- $value : array<string|int, mixed>
Return values
$thissetCacheKey()
public
setCacheKey(string $value) : $this
Parameters
- $value : string
Return values
$thissetCacheLifetime()
public
setCacheLifetime(int|false $value) : $this
Parameters
- $value : int|false
Return values
$thissetCacheTags()
public
setCacheTags(array<string|int, mixed> $value) : $this
Parameters
- $value : array<string|int, mixed>
Return values
$thissetChild()
Set child block
public
setChild(string $alias, Mage_Core_Block_Abstract $block) : $this
Parameters
- $alias : string
- $block : Mage_Core_Block_Abstract
Return values
$thissetClass()
public
setClass(string $value) : $this
Parameters
- $value : string
Return values
$thissetContentHeading()
public
setContentHeading(string $value) : $this
Parameters
- $value : string
Return values
$thissetData()
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
$thissetDataChanges()
Clears data changes status
public
setDataChanges(bool $value) : $this
Parameters
- $value : bool
Return values
$thissetDataUsingMethod()
Set object data with calling setter method
public
setDataUsingMethod(string $key[, mixed $args = [] ]) : $this
Parameters
- $key : string
- $args : mixed = []
Return values
$thissetDestElementId()
public
setDestElementId(string $value) : $this
Parameters
- $value : string
Return values
$thissetDisabled()
public
setDisabled(bool $value) : $this
Parameters
- $value : bool
Return values
$thissetDisplayMinimalPrice()
public
setDisplayMinimalPrice(bool $value) : $this
Parameters
- $value : bool
Return values
$thissetFormAction()
public
setFormAction(string $value) : $this
Parameters
- $value : string
Return values
$thissetFrameTags()
Specify block output frame tags
public
setFrameTags(string $openTag[, string $closeTag = null ]) : $this
Parameters
- $openTag : string
- $closeTag : string = null
Return values
$thissetId()
Set object id field value
public
setId(mixed $value) : $this
Parameters
- $value : mixed
Return values
$thissetIdFieldName()
set name of object id field
public
setIdFieldName(string $name) : $this
Parameters
- $name : string
Return values
$thissetIdSuffix()
public
setIdSuffix(string $value) : $this
Parameters
- $value : string
Return values
$thissetIsAnonymous()
Set the anonymous flag
public
setIsAnonymous(bool $flag) : $this
Parameters
- $flag : bool
Return values
$thissetLabel()
public
setLabel(string $value) : $this
Parameters
- $value : string
Return values
$thissetLayout()
Set layout object
public
setLayout(Mage_Core_Model_Layout $layout) : $this
Parameters
- $layout : Mage_Core_Model_Layout
Return values
$thissetMessagesBlock()
Set messages block
public
setMessagesBlock(Mage_Core_Block_Messages $block) : $this
Parameters
- $block : Mage_Core_Block_Messages
Return values
$thissetNameInLayout()
Set block's name in layout and unsets previous link if such exists.
public
setNameInLayout(string $name) : $this
Parameters
- $name : string
Return values
$thissetOnclick()
public
setOnclick(string $value) : $this
Parameters
- $value : string
Return values
$thissetParentBlock()
Set parent block
public
setParentBlock(Mage_Core_Block_Abstract $block) : $this
Parameters
- $block : Mage_Core_Block_Abstract
Return values
$thissetProduct()
public
setProduct(Mage_Catalog_Model_Product $value) : $this
Parameters
- $value : Mage_Catalog_Model_Product
Return values
$thissetScriptPath()
Set template location directory
public
setScriptPath(string $dir) : $this
Parameters
- $dir : string
Return values
$thissetTemplate()
Set path to template used for generating block's output.
public
setTemplate(string $template) : $this
Parameters
- $template : string
Return values
$thissetTemplate()
public
setTemplate(string $value) : $this
Parameters
- $value : string
Return values
$thissetTranslationHelper()
Helper setter for translations
public
setTranslationHelper(Mage_Core_Helper_Abstract $helper) : $this
Parameters
- $helper : Mage_Core_Helper_Abstract
Return values
$thissetType()
public
setType(string $value) : $this
Parameters
- $value : string
Return values
$thissortChildren()
Sort block's children
public
sortChildren([bool $force = false ]) : $this
Parameters
- $force : bool = false
-
force re-sort all children
Return values
$thisstripTags()
Wrapper for standard strip_tags() function with extra functionality for html entities
public
stripTags(string $data[, string $allowableTags = null ][, bool $allowHtmlEntities = false ]) : string
Parameters
- $data : string
- $allowableTags : string = null
- $allowHtmlEntities : bool = false
Return values
stringtoArray()
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>toHtml()
Produce and return block's html output
public
final toHtml() : string
It is a final method, but you can override _toHtml() method in descendants if needed.
Return values
stringtoJson()
Public wrapper for __toJson
public
toJson([array<string|int, mixed> $arrAttributes = [] ]) : string
Parameters
- $arrAttributes : array<string|int, mixed> = []
Return values
stringtoString()
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
stringtoXml()
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
stringunsetCallChild()
Call a child and unset it, if callback matched result
public
unsetCallChild(string $alias, string $callback, mixed $result, array<string|int, mixed> $params) : $this
$params will pass to child callback
$params may be array, if called from layout with elements with same name, for example:
...
Or, if called like this:
...
- then it will be $params1, $params2, $params3
It is no difference anyway, because they will be transformed in appropriate way.
Parameters
- $alias : string
- $callback : string
- $result : mixed
- $params : array<string|int, mixed>
Return values
$thisunsetChild()
Unset child block
public
unsetChild(string $alias) : $this
Parameters
- $alias : string
Return values
$thisunsetChildren()
Unset all children blocks
public
unsetChildren() : $this
Return values
$thisunsetData()
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
$thisunsetOldData()
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
$thisurlEscape()
public
urlEscape(string $data) : string
after 1.4.0.0-rc1
Parameters
- $data : string
Tags
Return values
string__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
_afterCacheUrl()
Replace URLs from cache
protected
_afterCacheUrl(string $html) : string
Parameters
- $html : string
Return values
string_afterToHtml()
Processing block html after rendering
protected
_afterToHtml(string $html) : string
Parameters
- $html : string
Return values
string_beforeCacheUrl()
Prepare url for save to cache
protected
_beforeCacheUrl() : $this
Return values
$this_beforeChildToHtml()
Prepare child block before generate html
protected
_beforeChildToHtml(string $name, Mage_Core_Block_Abstract $child) : mixed
Parameters
- $name : string
- $child : Mage_Core_Block_Abstract
_beforeToHtml()
Before rendering html, but after trying to load cache
protected
_beforeToHtml() : $this
Return values
$this_camelize()
protected
_camelize(string $name) : string
Parameters
- $name : string
Return values
string_construct()
Internal constructor, that is called from real constructor
protected
_construct() : void
Attributes
- #[Override]
_getAllowSymlinks()
Get is allowed symlinks flag
protected
_getAllowSymlinks() : bool
Return values
bool_getApp()
Retrieve application instance
protected
_getApp() : Mage_Core_Model_App
Return values
Mage_Core_Model_App_getChildHtml()
Retrieve child block HTML
protected
_getChildHtml(string $name[, bool $useCache = true ]) : string
Parameters
- $name : string
- $useCache : bool = true
Return values
string_getData()
Get value from _data array without parse key
protected
_getData(string $key) : mixed
Parameters
- $key : string
_getFactory()
Retrieve factory instance
protected
_getFactory() : Mage_Core_Model_Factory
Return values
Mage_Core_Model_Factory_getSidPlaceholder()
Get SID placeholder for cache
protected
_getSidPlaceholder([null|string $cacheKey = null ]) : string
Parameters
- $cacheKey : null|string = null
Return values
string_getTagsCacheKey()
Get cache key for tags
protected
_getTagsCacheKey([string $cacheKey = null ]) : string
Parameters
- $cacheKey : string = null
Return values
string_getUrlModel()
Create and return url object
protected
_getUrlModel() : Mage_Core_Model_Url
Return values
Mage_Core_Model_Url_getUrlModelClass()
Returns url model class name
protected
_getUrlModelClass() : string
Attributes
- #[Override]
Return values
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.
_isSecure()
Checks is request Url is secure
protected
_isSecure() : bool
Return values
bool_loadCache()
Load block html from cache storage
protected
_loadCache() : string|false
Return values
string|false_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>_prepareLayout()
Preparing global layout
protected
_prepareLayout() : $this
You can redefine this method in child classes for changing layout
Return values
$this_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_saveCache()
Save block content to cache storage
protected
_saveCache(string $data) : $this|false
Parameters
- $data : string
Return values
$this|false_toHtml()
Prepare html output
protected
_toHtml() : string
Attributes
- #[Override]
Return values
string_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_getCacheHintStatusColor()
Retrieve block cache status
private
_getCacheHintStatusColor() : string