Class Mage_Core_Block_Template

Description

Base html block

Located in /Core/Block/Template.php (line 35)

Varien_Object
   |
   --Mage_Core_Block_Abstract
      |
      --Mage_Core_Block_Template
Direct descendents
Class Description
Mage_Directory_Block_Data Directory data block
Mage_Directory_Block_Currency Currency dropdown block
Mage_Paypal_Block_Logo PayPal online logo with additional options
Mage_Paypal_Block_Express_Shortcut Paypal expess checkout shortcut link
Mage_Paypal_Block_Express_Review Paypal Express Onepage checkout block
Mage_CatalogInventory_Block_Qtyincrements Product qty increments block
Mage_CatalogInventory_Block_Stockqty_Abstract Product stock qty abstarct block
Mage_Adminhtml_Block_Abstract Adminhtml abstract block
Mage_Adminhtml_Block_Catalog_Product_Edit_Tab_Ajax_Serializer
Mage_Adminhtml_Block_Catalog_Product_Composite_Fieldset_Qty Adminhtml block for fieldset of product custom options
Mage_Adminhtml_Block_Catalog_Product_Composite_Update_Result Adminhtml block for result of catalog product composite update Forms response for a popup window for a case when form is directly submitted for single item
Mage_Adminhtml_Block_Catalog_Product_Composite_Error Adminhtml block for showing product options fieldsets
Mage_Adminhtml_Block_Urlrewrite_Selector Modes selector for Urlrewrites modes
Mage_Adminhtml_Block_Sales_Order_Create_Load Adminhtml sales order create newsletter block
Mage_Adminhtml_Block_Template Adminhtml abstract block
Mage_Adminhtml_Block_Tax_Rate_Title Tax Rate Titles Renderer
Mage_Adminhtml_Block_Widget_Grid_Serializer
Mage_GiftMessage_Block_Message_Inline Gift message inline edit form
Mage_GiftMessage_Block_Message_Helper
Mage_GiftMessage_Block_Message_Form
Mage_Cms_Block_Widget_Block Cms Static Block Widget
Mage_GoogleOptimizer_Block_Code Google Optimizer Scripts Block
Mage_ProductAlert_Block_Price
Mage_ProductAlert_Block_Stock
Mage_ProductAlert_Block_Product_View Product view price and stock alerts
Mage_ProductAlert_Block_Email_Abstract Product Alert Abstract Email Block
Mage_CatalogSearch_Block_Advanced_Result Advanced search result
Mage_CatalogSearch_Block_Advanced_Form Advanced search form
Mage_CatalogSearch_Block_Result Product search result block
Mage_CatalogSearch_Block_Term Catalogsearch term block
Mage_Catalog_Block_Seo_Sitemap_Abstract Site Map category block
Mage_Catalog_Block_Breadcrumbs Catalog breadcrumbs
Mage_Catalog_Block_Category_View Category View block
Mage_Catalog_Block_Product_Price Product price block
Mage_Catalog_Block_Product_Abstract Catalog Product Abstract Block
Mage_Catalog_Block_Product_Gallery Product gallery
Mage_Catalog_Block_Product_View_Description Product description block
Mage_Catalog_Block_Product_View_Tabs Product information tabs
Mage_Catalog_Block_Product_View_Price Catalog product price block
Mage_Catalog_Block_Product_View_Options Product options block
Mage_Catalog_Block_Product_View_Options_Abstract Product options abstract type block
Mage_Catalog_Block_Product_View_Attributes Product description block
Mage_Catalog_Block_Product_View_Additional Product additional info block
Mage_Catalog_Block_Product_List_Toolbar Product list toolbar
Mage_Catalog_Block_Product Magento
Mage_Catalog_Block_Layer_State Layered navigation state
Mage_Catalog_Block_Layer_View Catalog layered navigation view block
Mage_Catalog_Block_Layer_Filter_Abstract Catalog layer filter abstract
Mage_Catalog_Block_Navigation Catalog navigation
Mage_Payment_Block_Form_Container Base container block for payment methods forms
Mage_Payment_Block_Info Base payment iformation block
Mage_Payment_Block_Catalog_Product_View_Profile Recurring profile info/options product view block
Mage_Payment_Block_Info_Container Payment information container block
Mage_Payment_Block_Form Payment method form base block
Mage_Customer_Block_Form_Login Customer login form block
Mage_Customer_Block_Account Customer login block
Mage_Customer_Block_Address_Book Customer address book block
Mage_Customer_Block_Account_Dashboard_Hello Magento
Mage_Customer_Block_Account_Dashboard_Info Dashboard Customer Info
Mage_Customer_Block_Account_Dashboard_Sidebar Account dashboard sidebar
Mage_Customer_Block_Account_Dashboard_Block Magento
Mage_Customer_Block_Account_Dashboard_Newsletter Dashboard neswletter info
Mage_Customer_Block_Account_Dashboard_Address Customer dashboard addresses section
Mage_Customer_Block_Account_Forgotpassword Customer account navigation sidebar
Mage_Customer_Block_Account_Dashboard Customer dashboard block
Mage_Customer_Block_Account_Navigation Customer account navigation sidebar
Mage_Customer_Block_Widget_Abstract Magento
Mage_Tag_Block_All All tags block
Mage_Tag_Block_Customer_Recent Tags Customer Reviews Block
Mage_Tag_Block_Customer_Edit Customer's tags edit block This functionality was removed
Mage_Tag_Block_Popular Popular tags block
Mage_Tag_Block_Product_List Magento
Mage_Newsletter_Block_Subscribe Newsletter subscribe block
Mage_Sales_Block_Billing_Agreement_View Customer account billing agreement view block
Mage_Sales_Block_Billing_Agreements Customer account billing agreements block
Mage_Sales_Block_Items_Abstract Abstract block for display sales (quote/order/invoice etc.) items
Mage_Sales_Block_Recurring_Profiles Recurring profiles listing
Mage_Sales_Block_Recurring_Profile_View Recurring profile view
Mage_Sales_Block_Reorder_Sidebar Sales order view block
Mage_Sales_Block_Order_History Sales order history block
Mage_Sales_Block_Order_Info Invoice view comments form
Mage_Sales_Block_Order_Item_Renderer_Default Order item render block
Mage_Sales_Block_Order_Recent Sales order history block
Mage_Sales_Block_Order_Totals Magento
Mage_Sales_Block_Order_Tax Sales order view tax block
Mage_Sales_Block_Order_Details Sales order details block
Mage_Sales_Block_Order_Comments Magento
Mage_Sales_Block_Order_Email_Items_Default Sales Order Email items default renderer
Mage_Sales_Block_Order_Email_Items_Order_Default Sales Order Email items default renderer
Mage_Sales_Block_Order_View Sales order view block
Mage_Sales_Block_Order_Shipment Sales order view block
Mage_Wishlist_Block_Item_Configure Wishlist Item Configure block Serves for configuring item on product view page
Mage_Wishlist_Block_Customer_Sharing Wishlist customer sharing block
Mage_Wishlist_Block_Render_Item_Price Wishlist block for rendering price of item with product
Mage_Wishlist_Block_Share_Email_Rss Wishlist RSS URL to Email Block
Mage_Shipping_Block_Tracking_Ajax Magento
Mage_Shipping_Block_Tracking_Popup Magento
Mage_Checkout_Block_Cart_Abstract Shopping cart abstract block
Mage_Checkout_Block_Cart_Item_Renderer Shopping cart item render block
Mage_Checkout_Block_Cart_Item_Configure Cart Item Configure block Updates templates and blocks to show 'Update Cart' button and set right form submit url
Mage_Checkout_Block_Links Links block
Mage_Checkout_Block_Onepage_Abstract One page common functionality block
Mage_Checkout_Block_Onepage_Link One page checkout cart link
Mage_Checkout_Block_Onepage_Failure Magento
Mage_Checkout_Block_Onepage_Success One page checkout success page
Mage_Checkout_Block_Agreements Magento
Mage_Checkout_Block_Multishipping_Abstract Mustishipping checkout base abstract block
Mage_Checkout_Block_Multishipping_Link Multishipping cart link
Mage_Checkout_Block_Multishipping_State Multishipping checkout state
Mage_Checkout_Block_Success Magento
Mage_Page_Block_Redirect Customer Redirect Page
Mage_Page_Block_Switch Store and language switcher block
Mage_Page_Block_Html Html page block
Mage_Page_Block_Js_Translate Js translation block
Mage_Page_Block_Js_Cookie Magento
Mage_Page_Block_Template_Links Simple links list block
Mage_Page_Block_Template_Links_Block Simple links list block
Mage_Page_Block_Template_Container Abstract container block with header
Mage_Page_Block_Html_Header Html page block
Mage_Page_Block_Html_Notices Html notices block
Mage_Page_Block_Html_Breadcrumbs Html page block
Mage_Page_Block_Html_Footer Html page block
Mage_Page_Block_Html_Head Html page block
Mage_Page_Block_Html_Toplinks
Mage_Page_Block_Html_Welcome Html page block
Mage_Page_Block_Html_Pager Html page block
Mage_Poll_Block_ActivePoll Poll block
Mage_Poll_Block_Poll Poll block
Mage_Sendfriend_Block_Send Email to a Friend Block
Mage_Downloadable_Block_Customer_Products_List Block to display downloadable links bought by customer
Mage_Review_Block_Customer_Recent Recent Customer Reviews Block
Mage_Review_Block_Helper Review helper
Mage_Review_Block_Form Review form block
Mage_Centinel_Block_Authentication Centinel validation frame
Mage_Centinel_Block_Logo Centinel payment form logo block
Mage_Centinel_Block_Authentication_Start Authentication start/redirect form
Mage_Centinel_Block_Authentication_Complete Centinel validation form lookup
Mage_Rating_Block_Entity_Detailed Entity rating block
Mage_XmlConnect_Block_Adminhtml_Mobile_Edit_Tab_Design_Theme Magento
Mage_XmlConnect_Block_Customer_Address_List Customer address book xml renderer
Mage_XmlConnect_Block_Customer_Address_Form Customer address form xml renderer
Mage_XmlConnect_Block_Customer_Order_List Customer orders history xml renderer
Mage_XmlConnect_Block_Customer_Form Customer form xml renderer
Mage_XmlConnect_Block_Catalog Magento
Mage_XmlConnect_Block_Checkout_Address_Form Customer address form xml renderer for onepage checkout
Mage_XmlConnect_Block_Configuration Application configuration renderer
Mage_Rss_Block_Abstract Magento
Mage_Rss_Block_List Review form block
Mage_Rss_Block_Order_New Review form block
Mage_Rss_Block_Order_Status Review form block
Mage_Rss_Block_Order_Details Magento
Mage_Core_Block_Store_Switcher Store switcher block
Mage_Core_Block_Messages Messages block
Mage_Core_Block_Template_Smarty Magento
Mage_Core_Block_Template_Facade Block, that can get data from layout or from registry.
Mage_Core_Block_Template_Zend Zend html block
Mage_Core_Block_Html_Link HTML anchor element block
Mage_Core_Block_Html_Calendar Calendar block for page header Prepares localization data for calendar
Mage_Core_Block_Html_Date HTML select element block
Mage_Tax_Block_Sales_Order_Tax Tax totals modification block. Can be used just as subblock of Mage_Sales_Block_Order_Totals
Mage_Authorizenet_Block_Directpost_Iframe DirectPost iframe block
Mage_GoogleCheckout_Block_Link Google Checkout shortcut link
Mage_Install_Block_Abstract Abstract installation block
Mage_Install_Block_State Install state block
Variable Summary
static mixed $_showTemplateHints
mixed $_baseUrl
mixed $_jsUrl
string $_template
string $_viewDir
array $_viewVars
Method Summary
Mage_Core_Block_Template assign (string|array $key, [mixed $value = null])
string fetchView (string $fileName)
string getArea ()
string getBaseUrl ()
array getCacheKeyInfo ()
bool getDirectOutput ()
string getJsUrl ([string $fileName = ''])
mixed getObjectData ( $object, string $key)
string getTemplate ()
string getTemplateFile ()
string renderView ()
void _construct ()
string _toHtml ()
Variables
static mixed $_showTemplateHints (line 56)
  • access: protected
static mixed $_showTemplateHintsBlocks (line 57)
  • access: protected
mixed $_baseUrl (line 52)
  • access: protected
mixed $_jsUrl (line 54)
  • access: protected
string $_viewDir = '' (line 43)

View scripts directory

  • access: protected
array $_viewVars = array() (line 50)

Assigned variables for view

  • access: protected

Inherited Variables

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
assign (line 139)

Assign variable

  • access: public
Mage_Core_Block_Template assign (string|array $key, [mixed $value = null])
  • string|array $key
  • mixed $value

Redefined in descendants as:
fetchView (line 193)

Retrieve block view from file (template)

  • access: public
string fetchView (string $fileName)
  • string $fileName

Redefined in descendants as:
getArea (line 127)

Get design area

  • access: public
string getArea ()

Redefined in descendants as:
getBaseUrl (line 270)

Get base url of the application

  • access: public
string getBaseUrl ()

Redefined in descendants as:
getCacheKeyInfo (line 311)

Get cache key informative items

  • access: public
array getCacheKeyInfo ()

Redefinition of:
Mage_Core_Block_Abstract::getCacheKeyInfo()
Get cache key informative items Provide string array key to share specific info item with FPC placeholder

Redefined in descendants as:
getDirectOutput (line 168)

Check if dirrect output is allowed for block

  • access: public
bool getDirectOutput ()
getJsUrl (line 286)

Get url of base javascript file

To get url of skin javascript file use getSkinUrl()

  • access: public
string getJsUrl ([string $fileName = ''])
  • string $fileName
getObjectData (line 301)

Get data from specified object

  • access: public
mixed getObjectData ( $object, string $key)
  • Varien_Object $object
  • string $key
getShowTemplateHints (line 176)
  • access: public
void getShowTemplateHints ()
getTemplate (line 90)

Get relevant path to template

  • access: public
string getTemplate ()
getTemplateFile (line 112)

Get absolute path to template

  • access: public
string getTemplateFile ()
renderView (line 244)

Render block

  • access: public
string renderView ()
setScriptPath (line 158)

Set template location dire

  • access: public
Mage_Core_Block_Template setScriptPath (string $dir)
  • string $dir

Redefined in descendants as:
setTemplate (line 101)

Set path to template used for generating block's output.

  • access: public
Mage_Core_Block_Template setTemplate (string $template)
  • string $template

Redefined in descendants as:
_construct (line 70)

Internal constructor, that is called from real constructor

  • access: protected
void _construct ()

Redefinition of:
Mage_Core_Block_Abstract::_construct()
Internal constructor, that is called from real constructor

Redefined in descendants as:
_toHtml (line 256)

Render block HTML

  • access: protected
string _toHtml ()

Redefinition of:
Mage_Core_Block_Abstract::_toHtml()
Override this method in descendants to produce html

Redefined in descendants as:

Inherited Methods

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

Documentation generated on Fri, 11 Feb 2011 17:14:34 +0200 by phpDocumentor 1.4.3