Class Mage_Catalog_Helper_Product

Catalog category helper

Mage_Catalog_Helper_Product

Package: Mage\Catalog
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/Catalog/Helper/Product.php

Methods summary
`public string`	# `getProductUrl( mixed $product )` Retrieve product view page url Retrieve product view page url Parameters `$product` `mixed` $product Returns `string`
`public float`	# `getPrice( Mage_Catalog_Model_Product $product )` Retrieve product price Retrieve product price Parameters `$product` `Mage_Catalog_Model_Product` $product Returns `float`
`public float`	# `getFinalPrice( Mage_Catalog_Model_Product $product )` Retrieve product final price Retrieve product final price Parameters `$product` `Mage_Catalog_Model_Product` $product Returns `float`
`public string`	# `getImageUrl( mixed $product )` Retrieve base image url Retrieve base image url Returns `string`
`public unknown`	# `getSmallImageUrl( mixed $product )` Retrieve small image url Retrieve small image url Returns `unknown`
`public unknown`	# `getThumbnailUrl( mixed $product )` Retrieve thumbnail image url Retrieve thumbnail image url Returns `unknown`
`public`	# `getEmailToFriendUrl( mixed $product )`
`public`	# `getStatuses( )`
`public boolean`	# `canShow( Mage_Catalog_Model_Product\|integer $product, mixed $where = 'catalog' )` Check if a product can be shown Check if a product can be shown Parameters `$product` `Mage_Catalog_Model_Product\|integer` $product `$where` Returns `boolean`
`public string`	# `getProductUrlSuffix( integer $storeId = null )` Retrieve product rewrite sufix for store Retrieve product rewrite sufix for store Parameters `$storeId` `integer` $storeId Returns `string`
`public boolean`	# `canUseCanonicalTag( mixed $store = null )` Check if <link rel="canonical"> can be used for product Check if <link rel="canonical"> can be used for product Parameters `$store` `mixed` $store Returns `boolean`
`public array`	# `getAttributeInputTypes( string $inputType = null )` Return information array of product attribute input types Only a small number of settings returned, so we won't break anything in current dataflow As soon as development process goes on we need to add there all possible settings Return information array of product attribute input types Only a small number of settings returned, so we won't break anything in current dataflow As soon as development process goes on we need to add there all possible settings Parameters `$inputType` `string` $inputType Returns `array`
`public string\|null`	# `getAttributeBackendModelByInputType( string $inputType )` Return default attribute backend model by input type Return default attribute backend model by input type Parameters `$inputType` `string` $inputType Returns `string\|null`
`public string\|null`	# `getAttributeSourceModelByInputType( string $inputType )` Return default attribute source model by input type Return default attribute source model by input type Parameters `$inputType` `string` $inputType Returns `string\|null`
`public false\|Mage_Catalog_Model_Product`	# `initProduct( integer $productId, Mage_Core_Controller_Front_Action $controller, Varien_Object $params = null )` Inits product to be used for product controller actions and layouts $params can have following data: 'category_id' - id of category to check and append to product as current. If empty (except FALSE) - will be guessed (e.g. from last visited) to load as current. Inits product to be used for product controller actions and layouts $params can have following data: 'category_id' - id of category to check and append to product as current. If empty (except FALSE) - will be guessed (e.g. from last visited) to load as current. Parameters `$productId` `integer` $productId `$controller` `Mage_Core_Controller_Front_Action` $controller `$params` `Varien_Object` $params Returns `false\|Mage_Catalog_Model_Product`
`public Mage_Catalog_Helper_Product`	# `prepareProductOptions( Mage_Catalog_Model_Product $product, Varien_Object $buyRequest )` Prepares product options by buyRequest: retrieves values and assigns them as default. Also parses and adds product management related values - e.g. qty Prepares product options by buyRequest: retrieves values and assigns them as default. Also parses and adds product management related values - e.g. qty Parameters `$product` `Mage_Catalog_Model_Product` $product `$buyRequest` `Varien_Object` $buyRequest Returns `Mage_Catalog_Helper_Product`
`public Varien_Object`	# `addParamsToBuyRequest( Varien_Object\|array $buyRequest, Varien_Object\|array $params )` Process $buyRequest and sets its options before saving configuration to some product item. This method is used to attach additional parameters to processed buyRequest. Process $buyRequest and sets its options before saving configuration to some product item. This method is used to attach additional parameters to processed buyRequest. $params holds parameters of what operation must be performed: 'current_config', Varien_Object or array - current buyRequest that configures product in this item, used to restore currently attached files 'files_prefix': string[a-z0-9_] - prefix that was added at frontend to names of file inputs, so they won't intersect with other submitted options Parameters `$buyRequest` `Varien_Object\|array` $buyRequest `$params` `Varien_Object\|array` $params Returns `Varien_Object`
`public Mage_Catalog_Model_Product`	# `getProduct( integer\|string $productId, integer $store, string $identifierType = null )` Return loaded product instance Return loaded product instance Parameters `$productId` `integer\|string` $productId (SKU or ID) `$store` `integer` $store `$identifierType` `string` $identifierType Returns `Mage_Catalog_Model_Product`
`public Mage_Catalog_Helper_Product`	# `setSkipSaleableCheck( boolean $skipSaleableCheck = false )` Set flag that shows if Magento has to check product to be saleable (enabled and/or inStock) Set flag that shows if Magento has to check product to be saleable (enabled and/or inStock) For instance, during order creation in the backend admin has ability to add any products to order Parameters `$skipSaleableCheck` `boolean` $skipSaleableCheck Returns `Mage_Catalog_Helper_Product`
`public boolean`	# `getSkipSaleableCheck( )` Get flag that shows if Magento has to check product to be saleable (enabled and/or inStock) Get flag that shows if Magento has to check product to be saleable (enabled and/or inStock) Returns `boolean`

Methods inherited from Mage_Core_Helper_Url
`_prepareString(), addRequestParam(), getCurrentBase64Url(), getCurrentUrl(), getEncodedUrl(), getHomeUrl(), removeRequestParam()`

Methods inherited from Mage_Core_Helper_Abstract
`__(), _cleanCache(), _getModuleName(), _getRequest(), _getUrl(), _loadCache(), _removeCache(), _saveCache(), escapeHtml(), escapeUrl(), getLayout(), isModuleEnabled(), isModuleOutputEnabled(), jsQuoteEscape(), quoteEscape(), removeTags(), setLayout(), stripTags(), translateArray(), urlDecode(), urlEncode()`

Constants summary
`string`	`XML_PATH_PRODUCT_URL_SUFFIX`	`'catalog/seo/product_url_suffix'`	#
`string`	`XML_PATH_PRODUCT_URL_USE_CATEGORY`	`'catalog/seo/product_use_categories'`	#
`string`	`XML_PATH_USE_PRODUCT_CANONICAL_TAG`	`'catalog/seo/product_canonical_tag'`	#

Properties summary
`protected boolean`	`$_skipSaleableCheck`	`false`	# Flag that shows if Magento has to check product to be saleable (enabled and/or inStock) Flag that shows if Magento has to check product to be saleable (enabled and/or inStock)
`protected array`	`$_productUrlSuffix`	`array()`	# Cache for product rewrite suffix Cache for product rewrite suffix
`protected mixed`	`$_statuses`		#
`protected mixed`	`$_priceBlock`		#

Properties inherited from Mage_Core_Helper_Abstract
`$_layout, $_moduleName, $_request`

Packages

Classes

Interfaces

Class Mage_Catalog_Helper_Product

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns