Class Mage_Catalog_Block_Product_Abstract

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

Catalog Product Abstract Block

Located in /Catalog/Block/Product/Abstract.php (line 35) 

Varien_Object
   |
   --Mage_Core_Block_Abstract
      |
      --Mage_Core_Block_Template
         |
         --Mage_Catalog_Block_Product_Abstract
Direct descendents
Description | Descendents | Vars (details) | Methods (details) Constants
Class Description
Mage_Bundle_Block_Catalog_Product_List_Partof Catalog product related items block
Mage_Catalog_Block_Product_List Product list
Mage_Catalog_Block_Product_New New products block
Mage_Catalog_Block_Product_View_Abstract Product view abstract block
Mage_Catalog_Block_Product_List_Upsell Catalog product related items block
Mage_Catalog_Block_Product_List_Related Catalog product related items block
Mage_Catalog_Block_Product_List_Crosssell Catalog product related items block
Mage_Catalog_Block_Product_Send Product send to friend block
Mage_Catalog_Block_Product_View Product View block
Mage_Catalog_Block_Product_Compare_Abstract Catalog Compare Products Abstract Block
Mage_Tag_Block_Customer_View List of products tagged by customer Block
Mage_Tag_Block_Product_Result List of tagged products
Mage_Wishlist_Block_Abstract Wishlist Product Items abstract Block
Mage_Checkout_Block_Cart_Crosssell Cart crosssell list
Mage_Downloadable_Block_Catalog_Product_Links Downloadable Product Links part block
Mage_Downloadable_Block_Catalog_Product_Samples Downloadable Product Samples part block
Mage_Review_Block_Customer_View Customer Review detailed view block
Mage_Review_Block_View Review detailed view block
Mage_Reports_Block_Product_Abstract Reports Recently Products Abstract Block
Variable Summary
Description | Descendents | Vars (details) | Methods (details) Constants
string $_block
array $_columnCountLayoutDepend
int $_defaultColumnCount
mixed $_priceBlock
mixed $_priceBlockDefaultTemplate
mixed $_priceBlockTypes
mixed $_reviewsHelperBlock
mixed $_tierPriceDefaultTemplate
bool $_useLinkForAsLowAs
Method Summary
Description | Descendents | Constants Vars (details) | Methods (details)
Mage_Catalog_Block_Product_List addColumnCountLayoutDepend (string $pageLayout,  $columnCount, int $rowSize)
void addPriceBlockType (string $type, [string $block = ''], [string $template = ''])
void addReviewSummaryTemplate (string $type, string $template)
string getAddToCartUrl (Mage_Catalog_Model_Product $product, [array $additional = array()])
string getAddToCompareUrl (Mage_Catalog_Model_Product $product)
string getAddToWishlistUrl (Mage_Catalog_Model_Product $product)
bool getCanShowProductPrice (Mage_Catalog_Model_Product $product)
int getColumnCount ()
int|boolean getColumnCountLayoutDepend (string $pageLayout)
string getImageLabel ([Mage_Catalog_Model_Product $product = null], [string $mediaAttributeCode = 'image'])
void getMinimalQty ( $product)
Varien_Object getPageLayout ()
string getPriceHtml (Mage_Catalog_Model_Product $product, [boolean $displayMinimalPrice = false], [string $idSuffix = ''])
Mage_Catalog_Model_Product getProduct ()
string getProductUrl (Mage_Catalog_Model_Product $product, [array $additional = array()])
string getReviewsSummaryHtml (Mage_Catalog_Model_Product $product, [bool $templateType = false], [bool $displayIfNoReviews = false])
string getSubmitUrl (Mage_Catalog_Model_Product $product, [array $additional = array()])
void getTierPriceHtml ([Mage_Catalog_Model_Product $product = null])
array getTierPrices ([Mage_Catalog_Model_Product $product = null])
void getTierPriceTemplate ()
bool hasProductUrl (Mage_Catalog_Model_Product $product)
Mage_Catalog_Block_Product_List removeColumnCountLayoutDepend (string $pageLayout)
Mage_Catalog_Model_Resource_Eav_Mysql4_Product_Collection _addProductAttributesAndPrices (Mage_Catalog_Model_Resource_Eav_Mysql4_Product_Collection $collection)
void _getPriceBlock ( $productTypeId)
void _getPriceBlockTemplate ( $productTypeId)
void _initReviewsHelperBlock ()
Mage_Catalog_Block_Product_Abstract _prepareLayout ()
Mage_Core_Block_Template _preparePriceRenderer (string $productType)
Variables
Description | Descendents | Vars (details) Constants | Methods (details)
string $_block = 'catalog/product_price' (line 44)

Default price block

  • access: protected
array $_columnCountLayoutDepend = array() (line 73)

Product amount per row depending on custom page layout of category

  • access: protected
int $_defaultColumnCount = 3 (line 66)

Default product amount per row

  • access: protected
mixed $_priceBlock = array() (line 37)
  • access: protected
mixed $_priceBlockDefaultTemplate = 'catalog/product/price.phtml' (line 46)
  • access: protected
mixed $_priceBlockTypes = array() (line 50)
  • access: protected
mixed $_reviewsHelperBlock (line 59)
  • access: protected
mixed $_tierPriceDefaultTemplate = 'catalog/product/view/tierprices.phtml' (line 48)
  • access: protected
bool $_useLinkForAsLowAs = true (line 57)

Flag which allow/disallow to use link for as low as price

  • access: protected
Redefined in descendants as:

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 (details) Constants Methods (details)
addColumnCountLayoutDepend (line 445)

Add row size depends on page layout

  • access: public
Mage_Catalog_Block_Product_List addColumnCountLayoutDepend (string $pageLayout,  $columnCount, int $rowSize)
  • string $pageLayout
  • int $rowSize
  • $columnCount
addPriceBlockType (line 213)

Adding customized price template for product type

  • access: public
void addPriceBlockType (string $type, [string $block = ''], [string $template = ''])
  • string $type
  • string $block
  • string $template
addReviewSummaryTemplate (line 243)

Add/replace reviews summary template by type

  • access: public
void addReviewSummaryTemplate (string $type, string $template)
  • string $type
  • string $template
getAddToCartUrl (line 83)

Retrieve url for add product to cart Will return product view page URL if product has required options

  • access: public
string getAddToCartUrl (Mage_Catalog_Model_Product $product, [array $additional = array()])
Redefined in descendants as:
getAddToCompareUrl (line 138)

Retrieve Add Product to Compare Products List URL

  • access: public
string getAddToCompareUrl (Mage_Catalog_Model_Product $product)
getAddToWishlistUrl (line 127)

Enter description here...

  • access: public
string getAddToWishlistUrl (Mage_Catalog_Model_Product $product)
Redefined in descendants as:
getCanShowProductPrice (line 497)

Check whether the price can be shown for the specified product

  • access: public
bool getCanShowProductPrice (Mage_Catalog_Model_Product $product)
Redefined in descendants as:
getColumnCount (line 421)

Retrieve product amount per row

  • access: public
int getColumnCount ()
Redefined in descendants as:
getColumnCountLayoutDepend (line 472)

Retrieve row size depends on page layout

  • access: public
int|boolean getColumnCountLayoutDepend (string $pageLayout)
  • string $pageLayout
getImageLabel (line 363)

Retrieve given media attribute label or product name if no label

  • access: public
string getImageLabel ([Mage_Catalog_Model_Product $product = null], [string $mediaAttributeCode = 'image'])
getMinimalQty (line 143)
  • access: public
void getMinimalQty ( $product)
  • $product
getPageLayout (line 486)

Retrieve current page layout

  • access: public
Varien_Object getPageLayout ()
getPriceHtml (line 197)

Returns product price block html

  • access: public
string getPriceHtml (Mage_Catalog_Model_Product $product, [boolean $displayMinimalPrice = false], [string $idSuffix = ''])
Redefined in descendants as:
getProduct (line 265)

Retrieve currently viewed product object

  • access: public
Mage_Catalog_Model_Product getProduct ()
Redefined in descendants as:
getProductUrl (line 384)

Retrieve Product URL using UrlDataObject

  • access: public
string getProductUrl (Mage_Catalog_Model_Product $product, [array $additional = array()])
Redefined in descendants as:
getReviewsSummaryHtml (line 231)

Get product reviews summary

  • access: public
string getReviewsSummaryHtml (Mage_Catalog_Model_Product $product, [bool $templateType = false], [bool $displayIfNoReviews = false])
Redefined in descendants as:
getSubmitUrl (line 108)

Retrieves url for form submitting: some objects can use setSubmitRouteData() to set route and params for form submitting, otherwise default url will be used

  • access: public
string getSubmitUrl (Mage_Catalog_Model_Product $product, [array $additional = array()])
getTierPriceHtml (line 286)

Returns product tierprice block html

  • access: public
void getTierPriceHtml ([Mage_Catalog_Model_Product $product = null])
getTierPrices (line 304)

Get tier prices (formatted)

  • access: public
array getTierPrices ([Mage_Catalog_Model_Product $product = null])
Redefined in descendants as:
getTierPriceTemplate (line 273)
  • access: public
void getTierPriceTemplate ()
hasProductUrl (line 402)

Check Product has URL

  • access: public
bool hasProductUrl (Mage_Catalog_Model_Product $product)
removeColumnCountLayoutDepend (line 457)

Remove row size depends on page layout

  • access: public
Mage_Catalog_Block_Product_List removeColumnCountLayoutDepend (string $pageLayout)
  • string $pageLayout
_addProductAttributesAndPrices (line 345)

Add all attributes and apply pricing logic to products collection to get correct values in different products lists.

E.g. crosssells, upsells, new products, recently viewed

  • access: protected
Mage_Catalog_Model_Resource_Eav_Mysql4_Product_Collection _addProductAttributesAndPrices (Mage_Catalog_Model_Resource_Eav_Mysql4_Product_Collection $collection)
_getPriceBlock (line 151)
  • access: protected
void _getPriceBlock ( $productTypeId)
  • $productTypeId
_getPriceBlockTemplate (line 165)
  • access: protected
void _getPriceBlockTemplate ( $productTypeId)
  • $productTypeId
_initReviewsHelperBlock (line 253)

Create reviews summary helper block once

  • access: protected
void _initReviewsHelperBlock ()
_prepareLayout (line 507)

If exists price template block, retrieve price blocks from it

  • access: protected
Mage_Catalog_Block_Product_Abstract _prepareLayout ()
Redefinition of:
Mage_Core_Block_Abstract::_prepareLayout()
Preparing global layout
Redefined in descendants as:
_preparePriceRenderer (line 182)

Prepares and returns block to render some product type

  • access: public
Mage_Core_Block_Template _preparePriceRenderer (string $productType)
  • string $productType

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 (details) | Methods (details)

Inherited Constants

Inherited from Mage_Core_Block_Abstract

Mage_Core_Block_Abstract::CACHE_GROUP

Documentation generated on Fri, 11 Feb 2011 16:55:18 +0200 by phpDocumentor 1.4.3