Class Mage_Page_Block_Html_Head

Description
Description | Descendents | Vars | Methods (details) Constants

Html page block

Located in /Page/Block/Html/Head.php (line 35) 

Varien_Object
   |
   --Mage_Core_Block_Abstract
      |
      --Mage_Core_Block_Template
         |
         --Mage_Page_Block_Html_Head
Direct descendents
Description | Descendents | Vars | Methods (details) Constants
Class Description
Mage_Adminhtml_Block_Page_Head Adminhtml header block
Method Summary
Description | Descendents | Constants Vars | Methods (details)
Mage_Page_Block_Html_Head addCss (string $name, [string $params = ""])
Mage_Page_Block_Html_Head addCssIe (string $name, [string $params = ""])
Mage_Page_Block_Html_Head addItem (string $type, string $name, [string $params = null], [string $if = null], [string $cond = null])
Mage_Page_Block_Html_Head addJs (string $name, [string $params = ""])
Mage_Page_Block_Html_Head addJsIe (string $name, [string $params = ""])
Mage_Page_Block_Html_Head addLinkRel (string $rel, string $href)
string getCharset ()
array getChunkedItems (array $items, [string $prefix = ''], [int $maxLen = 450])
string getContentType ()
string getCssJsHtml ()
string getDefaultTitle ()
string getDescription ()
string getFaviconFile ()
string getIncludes ()
string getKeywords ()
string getMediaType ()
string getRobots ()
string getTitle ()
Mage_Page_Block_Html_Head removeItem (string $type, string $name)
Mage_Page_Block_Html_Head setTitle (string $title)
void _construct ()
string _getFaviconFile ()
bool _isFile (string $filename)
string _prepareOtherHtmlHeadElements (array $items)
string &_prepareStaticAndSkinElements (string $format,  $staticItems,  $skinItems, [callback $mergeCallback = null])
void _separateOtherHtmlHeadElements (array &$lines, string $itemIf, string $itemType, string $itemParams, string $itemName, array $itemThe)
Variables
Description | Descendents | Vars (details) Constants | Methods (details)

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
Description | Descendents | Vars Constants Methods (details)
addCss (line 53)

Add CSS file to HEAD entity

  • access: public
Mage_Page_Block_Html_Head addCss (string $name, [string $params = ""])
  • string $name
  • string $params
addCssIe (line 79)

Add CSS file for Internet Explorer only to HEAD entity

  • access: public
Mage_Page_Block_Html_Head addCssIe (string $name, [string $params = ""])
  • string $name
  • string $params
addItem (line 128)

Add HEAD Item

Allowed types:

  • js
  • js_css
  • skin_js
  • skin_css
  • rss

  • access: public
Mage_Page_Block_Html_Head addItem (string $type, string $name, [string $params = null], [string $if = null], [string $cond = null])
  • string $type
  • string $name
  • string $params
  • string $if
  • string $cond
addJs (line 66)

Add JavaScript file to HEAD entity

  • access: public
Mage_Page_Block_Html_Head addJs (string $name, [string $params = ""])
  • string $name
  • string $params
addJsIe (line 92)

Add JavaScript file for Internet Explorer only to HEAD entity

  • access: public
Mage_Page_Block_Html_Head addJsIe (string $name, [string $params = ""])
  • string $name
  • string $params
addLinkRel (line 105)

Add Link element to HEAD entity

  • access: public
Mage_Page_Block_Html_Head addLinkRel (string $rel, string $href)
  • string $rel: forward link types
  • string $href: URI for linked resource
getCharset (line 374)

Retrieve Charset

  • access: public
string getCharset ()
getChunkedItems (line 328)

Retrieve Chunked Items

  • access: public
array getChunkedItems (array $items, [string $prefix = ''], [int $maxLen = 450])
  • array $items
  • string $prefix
  • int $maxLen
getContentType (line 348)

Retrieve Content Type

  • access: public
string getContentType ()
getCssJsHtml (line 162)

Get HEAD HTML with CSS/JS/RSS definitions (actually it also renders other elements, TODO: fix it up or rename this method)

  • access: public
string getCssJsHtml ()
getDefaultTitle (line 413)

Retrieve default title text

  • access: public
string getDefaultTitle ()
getDescription (line 423)

Retrieve content for description tag

  • access: public
string getDescription ()
getFaviconFile (line 475)

Getter for path to Favicon

  • access: public
string getFaviconFile ()
getIncludes (line 462)

Get miscellanious scripts/styles to be included in head before head closing tag

  • access: public
string getIncludes ()
getKeywords (line 436)

Retrieve content for keyvords tag

  • access: public
string getKeywords ()
getMediaType (line 361)

Retrieve Media Type

  • access: public
string getMediaType ()
getRobots (line 449)

Retrieve URL to robots file

  • access: public
string getRobots ()
getTitle (line 400)

Retrieve title element text (encoded)

  • access: public
string getTitle ()
removeItem (line 150)

Remove Item from HEAD entity

  • access: public
Mage_Page_Block_Html_Head removeItem (string $type, string $name)
  • string $type
  • string $name
setTitle (line 388)

Set title element text

  • access: public
Mage_Page_Block_Html_Head setTitle (string $title)
  • string $title
_construct (line 41)

Initialize template

  • access: protected
void _construct ()
Redefinition of:
Mage_Core_Block_Template::_construct()
Internal constructor, that is called from real constructor
_getFaviconFile (line 488)

Retrieve path to Favicon

  • access: protected
string _getFaviconFile ()
_isFile (line 509)

If DB file storage is on - find there, otherwise - just file_exists

  • access: protected
bool _isFile (string $filename)
  • string $filename
_prepareOtherHtmlHeadElements (line 315)

Render arbitrary HTML head items

  • see: self::getCssJsHtml()
  • access: protected
string _prepareOtherHtmlHeadElements (array $items)
  • array $items
_prepareStaticAndSkinElements (line 236)

Merge static and skin files of the same format into 1 set of HEAD directives or even into 1 directive

Will attempt to merge into 1 directive, if merging callback is provided. In this case it will generate filenames, rather than render urls. The merger callback is responsible for checking whether files exist, merging them and giving result URL

  • access: protected
string &_prepareStaticAndSkinElements (string $format,  $staticItems,  $skinItems, [callback $mergeCallback = null])
  • string $format: - HTML element format for sprintf('<element src="%s"%s />', $src, $params)
  • array $staticItems: - array of relative names of static items to be grabbed from js/ folder
  • array $skinItems: - array of relative names of skin items to be found in skins according to design config
  • callback $mergeCallback
_separateOtherHtmlHeadElements (line 292)

Classify HTML head item and queue it into "lines" array

  • see: self::getCssJsHtml()
  • access: protected
void _separateOtherHtmlHeadElements (array &$lines, string $itemIf, string $itemType, string $itemParams, string $itemName, array $itemThe)
  • array &$lines
  • string $itemIf
  • string $itemType
  • string $itemParams
  • string $itemName
  • array $itemThe

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
Description | Descendants | Constants (details) Vars | Methods (details)

Inherited Constants

Inherited from Mage_Core_Block_Abstract

Mage_Core_Block_Abstract::CACHE_GROUP

Documentation generated on Fri, 11 Feb 2011 17:06:02 +0200 by phpDocumentor 1.4.3