Overview

Packages

  • currencysymbol
  • MAbout
  • Mage
    • Admin
    • Adminhtml
    • AdminNotification
    • Api
    • Api2
    • Authorizenet
    • Backup
    • Bundle
    • Captcha
    • Catalog
    • CatalogIndex
    • CatalogInventory
    • CatalogRule
    • CatalogSearch
    • Centinel
    • Checkout
    • Cms
    • Compiler
    • Connect
    • Contacts
    • Core
    • Cron
    • CurrencySymbol
    • Customer
    • Dataflow
    • Directory
    • DirtectPost
    • Downloadable
    • Eav
    • GiftMessage
    • GoogleAnalytics
    • GoogleBase
    • GoogleCheckout
    • ImportExport
    • Index
    • Install
    • Log
    • Media
    • Newsletter
    • Oauth
    • Page
    • PageCache
    • Paygate
    • Payment
    • Paypal
    • PaypalUk
    • Persistent
    • Poll
    • ProductAlert
    • Rating
    • Reports
    • Review
    • Rss
    • Rule
    • Sales
    • SalesRule
    • Sedfriend
    • Sendfriend
    • Shipping
    • Sitemap
    • Tag
    • Tax
    • Usa
    • Weee
    • Widget
    • Wishlist
    • XmlConnect
  • None
  • Phoenix
    • Moneybookers
  • PHP
  • Zend
    • Date
    • Mime
    • XmlRpc

Classes

  • Mage_Catalog_Block_Seo_Sitemap_Tree_Pager
  • Mage_Page_Block_Html
  • Mage_Page_Block_Html_Breadcrumbs
  • Mage_Page_Block_Html_Footer
  • Mage_Page_Block_Html_Head
  • Mage_Page_Block_Html_Header
  • Mage_Page_Block_Html_Notices
  • Mage_Page_Block_Html_Pager
  • Mage_Page_Block_Html_Topmenu
  • Mage_Page_Block_Html_Welcome
  • Mage_Page_Block_Html_Wrapper
  • Mage_Page_Block_Js_Cookie
  • Mage_Page_Block_Redirect
  • Mage_Page_Helper_Data
  • Mage_Page_Helper_Html
  • Mage_Page_Helper_Layout
  • Mage_Page_Model_Config
  • Mage_Page_Model_Source_Layout
  • Overview
  • Package
  • Class
  • Tree

Class Mage_Page_Block_Html_Head

Html page block

Varien_Object
Extended by Mage_Core_Block_Abstract
Extended by Mage_Core_Block_Template
Extended by Mage_Page_Block_Html_Head

Direct known subclasses

Mage_Adminhtml_Block_Page_Head
Package: Mage\Page
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/Html/Head.php
Methods summary
protected
# _construct( )

Initialize template

Initialize template

Overrides

Mage_Core_Block_Template::_construct()
public Mage_Page_Block_Html_Head
# addCss( string $name, string $params = "" )

Add CSS file to HEAD entity

Add CSS file to HEAD entity

Parameters

$name
string
$name
$params
string
$params

Returns

Mage_Page_Block_Html_Head
public Mage_Page_Block_Html_Head
# addJs( string $name, string $params = "" )

Add JavaScript file to HEAD entity

Add JavaScript file to HEAD entity

Parameters

$name
string
$name
$params
string
$params

Returns

Mage_Page_Block_Html_Head
public Mage_Page_Block_Html_Head
# addCssIe( string $name, string $params = "" )

Add CSS file for Internet Explorer only to HEAD entity

Add CSS file for Internet Explorer only to HEAD entity

Parameters

$name
string
$name
$params
string
$params

Returns

Mage_Page_Block_Html_Head
public Mage_Page_Block_Html_Head
# addJsIe( string $name, string $params = "" )

Add JavaScript file for Internet Explorer only to HEAD entity

Add JavaScript file for Internet Explorer only to HEAD entity

Parameters

$name
string
$name
$params
string
$params

Returns

Mage_Page_Block_Html_Head
public Mage_Page_Block_Html_Head
# addLinkRel( string $rel, string $href )

Add Link element to HEAD entity

Add Link element to HEAD entity

Parameters

$rel
string
$rel forward link types
$href
string
$href URI for linked resource

Returns

Mage_Page_Block_Html_Head
public Mage_Page_Block_Html_Head
# addItem( string $type, string $name, string $params = null, string $if = null, string $cond = null )

Add HEAD Item

Add HEAD Item

Allowed types: - js - js_css - skin_js - skin_css - rss

Parameters

$type
string
$type
$name
string
$name
$params
string
$params
$if
string
$if
$cond
string
$cond

Returns

Mage_Page_Block_Html_Head
public Mage_Page_Block_Html_Head
# removeItem( string $type, string $name )

Remove Item from HEAD entity

Remove Item from HEAD entity

Parameters

$type
string
$type
$name
string
$name

Returns

Mage_Page_Block_Html_Head
public string
# getCssJsHtml( )

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

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

Returns

string
protected string &
# _prepareStaticAndSkinElements( string $format, array $staticItems, array $skinItems, callable $mergeCallback = null )

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

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

Parameters

$format
string
$format - HTML element format for sprintf('<element src="%s"%s />', $src, $params)
$staticItems
array
$staticItems - array of relative names of static items to be grabbed from js/ folder
$skinItems
array
$skinItems - array of relative names of skin items to be found in skins according to design config
$mergeCallback
callable
$mergeCallback

Returns

string
protected
# _separateOtherHtmlHeadElements( array & $lines, string $itemIf, string $itemType, string $itemParams, string $itemName, array $itemThe )

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

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

Parameters

$lines
array
&$lines
$itemIf
string
$itemIf
$itemType
string
$itemType
$itemParams
string
$itemParams
$itemName
string
$itemName
$itemThe
array
$itemThe

See

Mage_Page_Block_Html_Head::getCssJsHtml()
protected string
# _prepareOtherHtmlHeadElements( array $items )

Render arbitrary HTML head items

Render arbitrary HTML head items

Parameters

$items
array
$items

Returns

string

See

Mage_Page_Block_Html_Head::getCssJsHtml()
public array
# getChunkedItems( array $items, string $prefix = '', integer $maxLen = 450 )

Retrieve Chunked Items

Retrieve Chunked Items

Parameters

$items
array
$items
$prefix
string
$prefix
$maxLen
integer
$maxLen

Returns

array
public string
# getContentType( )

Retrieve Content Type

Retrieve Content Type

Returns

string
public string
# getMediaType( )

Retrieve Media Type

Retrieve Media Type

Returns

string
public string
# getCharset( )

Retrieve Charset

Retrieve Charset

Returns

string
public Mage_Page_Block_Html_Head
# setTitle( string $title )

Set title element text

Set title element text

Parameters

$title
string
$title

Returns

Mage_Page_Block_Html_Head
public string
# getTitle( )

Retrieve title element text (encoded)

Retrieve title element text (encoded)

Returns

string
public string
# getDefaultTitle( )

Retrieve default title text

Retrieve default title text

Returns

string
public string
# getDescription( )

Retrieve content for description tag

Retrieve content for description tag

Returns

string
public string
# getKeywords( )

Retrieve content for keyvords tag

Retrieve content for keyvords tag

Returns

string
public string
# getRobots( )

Retrieve URL to robots file

Retrieve URL to robots file

Returns

string
public string
# getIncludes( )

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

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

Returns

string
public string
# getFaviconFile( )

Getter for path to Favicon

Getter for path to Favicon

Returns

string
protected string
# _getFaviconFile( )

Retrieve path to Favicon

Retrieve path to Favicon

Returns

string
protected boolean
# _isFile( string $filename )

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

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

Parameters

$filename
string
$filename

Returns

boolean
Methods inherited from Mage_Core_Block_Template
_getAllowSymlinks(), _toHtml(), assign(), fetchView(), getArea(), getBaseUrl(), getCacheKeyInfo(), getDirectOutput(), getJsUrl(), getObjectData(), getShowTemplateHints(), getTemplate(), getTemplateFile(), renderView(), setScriptPath(), setTemplate()
Methods inherited from Mage_Core_Block_Abstract
__(), _afterCacheUrl(), _afterToHtml(), _beforeCacheUrl(), _beforeChildToHtml(), _beforeToHtml(), _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 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
Magento 1.7.0.2 API documentation generated by ApiGen 2.8.0