Docs For Class Mage_Page_Block_Template

Description

Simple links list block

author: Magento Core Team <[email protected]>

Located in /Page/Block/Template/Links.php (line 35)

Varien_Object
   |
   --Mage_Core_Block_Abstract
      |
      --Mage_Core_Block_Template
         |
         --Mage_Page_Block_Template_Links

Variable Summary

array $_links

Method Summary

Mage_Page_Block_Template_Links addLink (string $label, [string $url = ''], [string $title = ''], [boolean $prepare = false], [array $urlParams = array()], [int $position = null], [string|array $liParams = null], [string|array $aParams = null], [string $beforeText = ''], [string $afterText = ''])

Mage_Page_Block_Template_Links addLinkBlock (string $blockName)

array getCacheKeyInfo ()

array getLinks ()

Mage_Page_Block_Template_Links removeLinkByUrl (string $url)

Mage_Page_Block_Template_Links _beforeToHtml ()

void _construct ()

int _getNewPosition ([int $position = 0])

string _prepareParams (string|array $params)

Variables

array $_links = array() (line 43)

All links

access: protected

Inherited Variables

Inherited from Mage_Core_Block_Template

Mage_Core_Block_Template::$_baseUrl
Mage_Core_Block_Template::$_jsUrl
Mage_Core_Block_Template::$_showTemplateHints
Mage_Core_Block_Template::$_showTemplateHintsBlocks
Mage_Core_Block_Template::$_template
Mage_Core_Block_Template::$_viewDir
Mage_Core_Block_Template::$_viewVars

Inherited from Mage_Core_Block_Abstract

Mage_Core_Block_Abstract::$_alias
Mage_Core_Block_Abstract::$_anonSuffix
Mage_Core_Block_Abstract::$_childGroups
Mage_Core_Block_Abstract::$_children
Mage_Core_Block_Abstract::$_childrenHtmlCache
Mage_Core_Block_Abstract::$_frameCloseTag
Mage_Core_Block_Abstract::$_frameOpenTag
Mage_Core_Block_Abstract::$_isAnonymous
Mage_Core_Block_Abstract::$_layout
Mage_Core_Block_Abstract::$_messagesBlock
Mage_Core_Block_Abstract::$_nameInLayout
Mage_Core_Block_Abstract::$_parent
Mage_Core_Block_Abstract::$_parentBlock
Mage_Core_Block_Abstract::$_request
Mage_Core_Block_Abstract::$_sortedChildren
Mage_Core_Block_Abstract::$_urlModel

Methods

addLink (line 79)

Add link to the list

access: public

Mage_Page_Block_Template_Links addLink (string $label, [string $url = ''], [string $title = ''], [boolean $prepare = false], [array $urlParams = array()], [int $position = null], [string|array $liParams = null], [string|array $aParams = null], [string $beforeText = ''], [string $afterText = ''])

string $label
string $url
string $title
boolean $prepare
array $urlParams
int $position
string|array $liParams
string|array $aParams
string $beforeText
string $afterText

addLinkBlock (line 109)

Add block to link list

access: public

Mage_Page_Block_Template_Links addLinkBlock (string $blockName)

string $blockName

getCacheKeyInfo (line 139)

Get cache key informative items Provide string array key to share specific info item with FPC placeholder

access: public

array getCacheKeyInfo ()

Redefinition of:

Mage_Core_Block_Template::getCacheKeyInfo(): Get cache key informative items

getLinks (line 59)

Get all links

access: public

array getLinks ()

removeLinkByUrl (line 122)

Removes link by url

access: public

Mage_Page_Block_Template_Links removeLinkByUrl (string $url)

string $url

_beforeToHtml (line 180)

Set first/last

access: protected

Mage_Page_Block_Template_Links _beforeToHtml ()

Redefinition of:

Mage_Core_Block_Abstract::_beforeToHtml(): Before rendering html, but after trying to load cache

_construct (line 49)

Set default template

access: protected

void _construct ()

Redefinition of:

Mage_Core_Block_Template::_construct(): Internal constructor, that is called from real constructor

_getNewPosition (line 197)

Return new link position in list

access: protected

int _getNewPosition ([int $position = 0])

int $position

_prepareParams (line 161)

Prepare tag attributes

access: protected

string _prepareParams (string|array $params)

string|array $params

Inherited Methods

Inherited From Mage_Core_Block_Template

Mage_Core_Block_Template::assign()
Mage_Core_Block_Template::fetchView()
Mage_Core_Block_Template::getArea()
Mage_Core_Block_Template::getBaseUrl()
Mage_Core_Block_Template::getCacheKeyInfo()
Mage_Core_Block_Template::getDirectOutput()
Mage_Core_Block_Template::getJsUrl()
Mage_Core_Block_Template::getObjectData()
Mage_Core_Block_Template::getShowTemplateHints()
Mage_Core_Block_Template::getTemplate()
Mage_Core_Block_Template::getTemplateFile()
Mage_Core_Block_Template::renderView()
Mage_Core_Block_Template::setScriptPath()
Mage_Core_Block_Template::setTemplate()
Mage_Core_Block_Template::_construct()
Mage_Core_Block_Template::_toHtml()

Inherited From Mage_Core_Block_Abstract

Mage_Core_Block_Abstract::addToChildGroup()
Mage_Core_Block_Abstract::addToParentGroup()
Mage_Core_Block_Abstract::append()
Mage_Core_Block_Abstract::countChildren()
Mage_Core_Block_Abstract::escapeHtml()
Mage_Core_Block_Abstract::escapeUrl()
Mage_Core_Block_Abstract::formatDate()
Mage_Core_Block_Abstract::formatTime()
Mage_Core_Block_Abstract::getAction()
Mage_Core_Block_Abstract::getAnonSuffix()
Mage_Core_Block_Abstract::getBlockAlias()
Mage_Core_Block_Abstract::getBlockHtml()
Mage_Core_Block_Abstract::getCacheKey()
Mage_Core_Block_Abstract::getCacheKeyInfo()
Mage_Core_Block_Abstract::getCacheLifetime()
Mage_Core_Block_Abstract::getCacheTags()
Mage_Core_Block_Abstract::getChild()
Mage_Core_Block_Abstract::getChildChildHtml()
Mage_Core_Block_Abstract::getChildData()
Mage_Core_Block_Abstract::getChildGroup()
Mage_Core_Block_Abstract::getChildHtml()
Mage_Core_Block_Abstract::getHelper()
Mage_Core_Block_Abstract::getIsAnonymous()
Mage_Core_Block_Abstract::getLayout()
Mage_Core_Block_Abstract::getMessagesBlock()
Mage_Core_Block_Abstract::getModuleName()
Mage_Core_Block_Abstract::getNameInLayout()
Mage_Core_Block_Abstract::getParentBlock()
Mage_Core_Block_Abstract::getRequest()
Mage_Core_Block_Abstract::getSkinUrl()
Mage_Core_Block_Abstract::getSortedChildBlocks()
Mage_Core_Block_Abstract::getSortedChildren()
Mage_Core_Block_Abstract::getUrl()
Mage_Core_Block_Abstract::getUrlBase64()
Mage_Core_Block_Abstract::getUrlEncoded()
Mage_Core_Block_Abstract::helper()
Mage_Core_Block_Abstract::htmlEscape()
Mage_Core_Block_Abstract::insert()
Mage_Core_Block_Abstract::jsQuoteEscape()
Mage_Core_Block_Abstract::setAnonSuffix()
Mage_Core_Block_Abstract::setAttribute()
Mage_Core_Block_Abstract::setBlockAlias()
Mage_Core_Block_Abstract::setChild()
Mage_Core_Block_Abstract::setFrameTags()
Mage_Core_Block_Abstract::setIsAnonymous()
Mage_Core_Block_Abstract::setLayout()
Mage_Core_Block_Abstract::setMessagesBlock()
Mage_Core_Block_Abstract::setNameInLayout()
Mage_Core_Block_Abstract::setParentBlock()
Mage_Core_Block_Abstract::stripTags()
Mage_Core_Block_Abstract::toHtml()
Mage_Core_Block_Abstract::unsetCallChild()
Mage_Core_Block_Abstract::unsetChild()
Mage_Core_Block_Abstract::unsetChildren()
Mage_Core_Block_Abstract::urlEscape()
Mage_Core_Block_Abstract::_afterCacheUrl()
Mage_Core_Block_Abstract::_afterToHtml()
Mage_Core_Block_Abstract::_beforeCacheUrl()
Mage_Core_Block_Abstract::_beforeChildToHtml()
Mage_Core_Block_Abstract::_beforeToHtml()
Mage_Core_Block_Abstract::_construct()
Mage_Core_Block_Abstract::_getChildHtml()
Mage_Core_Block_Abstract::_getUrlModel()
Mage_Core_Block_Abstract::_getUrlModelClass()
Mage_Core_Block_Abstract::_loadCache()
Mage_Core_Block_Abstract::_prepareLayout()
Mage_Core_Block_Abstract::_saveCache()
Mage_Core_Block_Abstract::_toHtml()
Mage_Core_Block_Abstract::__()

Class Constants

Inherited Constants

Inherited from Mage_Core_Block_Abstract

Mage_Core_Block_Abstract::CACHE_GROUP

Class Mage_Page_Block_Template_Links

Inherited Variables

Inherited Methods

Inherited Constants