Class Mage_Page_Block_Template_Links

Simple links list block

Varien_Object

Mage_Page_Block_Template_Links

Package: Mage\Core
Category: Mage
Copyright: Copyright (c) 2012 Magento Inc. (http://www.magentocommerce.com)
License: Open Software License (OSL 3.0)
Author: Magento Core Team <core@magentocommerce.com>
Located at code/core/Mage/Page/Block/Template/Links.php

Methods summary
`protected`	# `_construct( )` Set default template Set default template Overrides `Mage_Core_Block_Template::_construct()`
`public array`	# `getLinks( )` Get all links Get all links Returns `array`
`public Mage_Page_Block_Template_Links`	# `addLink( string $label, string $url = '', string $title = '', boolean $prepare = false, array $urlParams = array(), integer $position = null, string\|array $liParams = null, string\|array $aParams = null, string $beforeText = '', string $afterText = '' )` Add link to the list Add link to the list Parameters `$label` `string` $label `$url` `string` $url `$title` `string` $title `$prepare` `boolean` $prepare `$urlParams` `array` $urlParams `$position` `integer` $position `$liParams` `string\|array` $liParams `$aParams` `string\|array` $aParams `$beforeText` `string` $beforeText `$afterText` `string` $afterText Returns `Mage_Page_Block_Template_Links`
`public Mage_Page_Block_Template_Links`	# `addLinkBlock( string $blockName )` Add block to link list Add block to link list Parameters `$blockName` `string` $blockName Returns `Mage_Page_Block_Template_Links`
`public Mage_Page_Block_Template_Links`	# `removeLinkBlock( string $blockName )` Remove Link block by blockName Remove Link block by blockName Parameters `$blockName` `string` $blockName Returns `Mage_Page_Block_Template_Links`
`public Mage_Page_Block_Template_Links`	# `removeLinkByUrl( string $url )` Removes link by url Removes link by url Parameters `$url` `string` $url Returns `Mage_Page_Block_Template_Links`
`public array`	# `getCacheKeyInfo( )` Get cache key informative items Provide string array key to share specific info item with FPC placeholder Get cache key informative items Provide string array key to share specific info item with FPC placeholder Returns `array` Overrides `Mage_Core_Block_Template::getCacheKeyInfo()`
`protected string`	# `_prepareParams( string\|array $params )` Prepare tag attributes Prepare tag attributes Parameters `$params` `string\|array` $params Returns `string`
`protected Mage_Page_Block_Template_Links`	# `_beforeToHtml( )` Set first/last Set first/last Returns `Mage_Page_Block_Template_Links` Overrides `Mage_Core_Block_Abstract::_beforeToHtml()`
`protected integer`	# `_getNewPosition( integer $position = 0 )` Return new link position in list Return new link position in list Parameters `$position` `integer` $position Returns `integer`

Methods inherited from Mage_Core_Block_Template
`_getAllowSymlinks(), _toHtml(), assign(), fetchView(), getArea(), getBaseUrl(), getDirectOutput(), getJsUrl(), getObjectData(), getShowTemplateHints(), getTemplate(), getTemplateFile(), renderView(), setScriptPath(), setTemplate()`

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

Constants inherited from Mage_Core_Block_Template
`XML_PATH_DEBUG_TEMPLATE_HINTS, XML_PATH_DEBUG_TEMPLATE_HINTS_BLOCKS, XML_PATH_TEMPLATE_ALLOW_SYMLINK`

Constants inherited from Mage_Core_Block_Abstract
`CACHE_GROUP`

Properties summary
`protected array`	`$_links`	`array()`	# All links All links
`protected null\|array`	`$_cacheKeyInfo`	`null`	# Cache key info Cache key info

Properties inherited from Mage_Core_Block_Template
`$_allowSymlinks, $_baseUrl, $_jsUrl, $_showTemplateHints, $_showTemplateHintsBlocks, $_template, $_viewDir, $_viewVars`

Properties inherited from Mage_Core_Block_Abstract
`$_alias, $_anonSuffix, $_childGroups, $_children, $_childrenHtmlCache, $_frameCloseTag, $_frameOpenTag, $_isAnonymous, $_layout, $_messagesBlock, $_nameInLayout, $_parent, $_parentBlock, $_request, $_sortInstructions, $_sortedChildren, $_urlModel`

Packages

Classes

Exceptions

Functions

Class Mage_Page_Block_Template_Links

Overrides

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Overrides

Parameters

Returns

Returns

Overrides

Parameters

Returns