Class Mage_Catalog_Model_Resource_Product_Collection

Product collection

Varien_Data_Collection_Db

Mage_Eav_Model_Entity_Collection_Abstract

Mage_Catalog_Model_Resource_Collection_Abstract

Mage_Catalog_Model_Resource_Product_Collection

Direct known subclasses

Mage_Bundle_Model_Resource_Selection_Collection, Mage_Catalog_Model_Resource_Eav_Mysql4_Product_Collection, Mage_Reports_Model_Resource_Product_Index_Collection_Abstract, Mage_Reports_Model_Resource_Review_Product_Collection, Mage_Review_Model_Resource_Review_Product_Collection, Mage_Tag_Model_Resource_Product_Collection, Mage_Catalog_Model_Resource_Product_Compare_Item_Collection, Mage_Catalog_Model_Resource_Product_Link_Product_Collection, Mage_Catalog_Model_Resource_Product_Type_Configurable_Product_Collection, Mage_CatalogSearch_Model_Resource_Advanced_Collection, Mage_CatalogSearch_Model_Resource_Fulltext_Collection, Mage_CatalogSearch_Model_Resource_Search_Collection, Mage_Reports_Model_Resource_Product_Collection, Mage_Reports_Model_Resource_Product_Downloads_Collection

Indirect known subclasses

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

Methods inherited from Mage_Catalog_Model_Resource_Collection_Abstract
`_addLoadAttributesSelectValues(), _getLoadAttributesSelect(), _joinAttributeToSelect(), getDefaultStoreId(), getStoreId(), setStoreId()`

Methods inherited from Mage_Eav_Model_Entity_Collection_Abstract
__construct(), _addAttributeJoin(), _getAllIdsSelect(), _getAttributeConditionSql(), _getAttributeFieldName(), _getAttributeTableAlias(), _loadEntities(), _prepareOrderExpression(), _prepareSelect(), _renderOrders(), _reset(), _setItemAttributeValue(), addEntityTypeToSelect(), addExpressionAttributeToSelect(), addFieldToFilter(), addItem(), addStaticField(), delete(), exportToArray(), getAllIdsSql(), getAttribute(), getEntity(), getLoadedIds(), getResource(), getRowIdFieldName(), getTable(), groupByAttribute(), importFromArray(), joinAttribute(), joinField(), joinTable(), load(), removeAttributeToSelect(), save(), setObject(), setPage(), setRowIdFieldName(), toArray()

Constants summary
`string`	`INDEX_TABLE_ALIAS`	`'price_index'`	# Alias for index table Alias for index table
`string`	`MAIN_TABLE_ALIAS`	`'e'`	# Alias for main table Alias for main table

Properties summary
`protected array`	`$_flatEnabled`	`array()`	# Catalog Product Flat is enabled cache per store Catalog Product Flat is enabled cache per store
`protected string`	`$_productWebsiteTable`		# Product websites table name Product websites table name
`protected string`	`$_productCategoryTable`		# Product categories table name Product categories table name
`protected boolean`	`$_addUrlRewrite`	`false`	# Is add URL rewrites to collection flag Is add URL rewrites to collection flag
`protected integer`	`$_urlRewriteCategory`	`''`	# Add URL rewrite for category Add URL rewrite for category
`protected boolean`	`$_addMinimalPrice`	`false`	# Is add minimal price to product collection flag Is add minimal price to product collection flag
`protected unknown_type`	`$_addFinalPrice`	`false`	# Is add final price to product collection flag Is add final price to product collection flag
`protected array`	`$_allIdsCache`	`null`	# Cache for all ids Cache for all ids
`protected boolean`	`$_addTaxPercents`	`false`	# Is add tax percents to product collection flag Is add tax percents to product collection flag
`protected array`	`$_productLimitationFilters`	`array()`	# Product limitation filters Allowed filters store_id int; category_id int; category_is_anchor int; visibility array\|int; website_ids array\|int; store_table string; use_price_index bool; join price index table flag customer_group_id int; required for price; customer group limitation for price website_id int; required for price; website limitation for price Product limitation filters Allowed filters store_id int; category_id int; category_is_anchor int; visibility array\|int; website_ids array\|int; store_table string; use_price_index bool; join price index table flag customer_group_id int; required for price; customer group limitation for price website_id int; required for price; website limitation for price
`protected Zend_Db_Select`	`$_productCountSelect`	`null`	# Category product count select Category product count select
`protected boolean`	`$_isWebsiteFilter`	`false`	# Enter description here ... Enter description here ...
`protected array`	`$_priceDataFieldFilters`	`array()`	# Additional field filters, applied in _productLimitationJoinPrice() Additional field filters, applied in _productLimitationJoinPrice()
`protected array`	`$_map`	`array('fields' => array( 'price' => 'price_index.price', 'final_price' => 'price_index.final_price', 'min_price' => 'price_index.min_price', 'max_price' => 'price_index.max_price', 'tier_price' => 'price_index.tier_price', 'special_price' => 'price_index.special_price', ))`	# Map of price fields Map of price fields
`protected string\|null`	`$_priceExpression`		# Price expression sql Price expression sql
`protected string\|null`	`$_additionalPriceExpression`		# Additional price expression sql part Additional price expression sql part
`protected float`	`$_maxPrice`		# Max prise (statistics data) Max prise (statistics data)
`protected float`	`$_minPrice`		# Min prise (statistics data) Min prise (statistics data)
`protected float`	`$_priceStandardDeviation`		# Prise standard deviation (statistics data) Prise standard deviation (statistics data)
`protected integer`	`$_pricesCount`	`null`	# Prises count (statistics data) Prises count (statistics data)
`protected Varien_Db_Select`	`$_catalogPreparePriceSelect`	`null`	# Cloned Select after dispatching 'catalog_prepare_price_select' event Cloned Select after dispatching 'catalog_prepare_price_select' event

Properties inherited from Mage_Catalog_Model_Resource_Collection_Abstract
`$_storeId`

Properties inherited from Mage_Eav_Model_Entity_Collection_Abstract
`$_castToIntMap, $_entity, $_filterAttributes, $_itemsById, $_joinAttributes, $_joinEntities, $_joinFields, $_selectAttributes, $_selectEntityTypes, $_staticFields, $_useAnalyticFunction`

Methods summary
`public Varien_Db_Select`	# `getCatalogPreparedSelect( )` Get cloned Select after dispatching 'catalog_prepare_price_select' event Get cloned Select after dispatching 'catalog_prepare_price_select' event Returns `Varien_Db_Select`
`protected Mage_Catalog_Model_Resource_Product_Collection`	# `_preparePriceExpressionParameters( Varien_Db_Select $select )` Prepare additional price expression sql part Prepare additional price expression sql part Parameters `$select` `Varien_Db_Select` $select Returns `Mage_Catalog_Model_Resource_Product_Collection`
`public string`	# `getPriceExpression( Varien_Db_Select $select )` Get price expression sql part Get price expression sql part Parameters `$select` `Varien_Db_Select` $select Returns `string`
`public string`	# `getAdditionalPriceExpression( Varien_Db_Select $select )` Get additional price expression sql part Get additional price expression sql part Parameters `$select` `Varien_Db_Select` $select Returns `string`
`public float`	# `getCurrencyRate( )` Get currency rate Get currency rate Returns `float`
`public Mage_Catalog_Helper_Product_Flat`	# `getFlatHelper( )` Retrieve Catalog Product Flat Helper object Retrieve Catalog Product Flat Helper object Returns `Mage_Catalog_Helper_Product_Flat`
`public boolean`	# `isEnabledFlat( )` Retrieve is flat enabled flag Return alvays false if magento run admin Retrieve is flat enabled flag Return alvays false if magento run admin Returns `boolean`
`protected`	# `_construct( )` Initialize resources Initialize resources Overrides `Mage_Eav_Model_Entity_Collection_Abstract::_construct()`
`protected`	# `_initTables( )` Define product website and category product tables Define product website and category product tables
`protected Mage_Catalog_Model_Resource_Product_Collection`	# `_init( string $model, unknown_type $entityModel = null )` Standard resource collection initalization Standard resource collection initalization Parameters `$model` `string` $model `$entityModel` `unknown_type` $entityModel Returns `Mage_Catalog_Model_Resource_Product_Collection` Overrides `Mage_Eav_Model_Entity_Collection_Abstract::_init()`
`protected Mage_Catalog_Model_Resource_Product_Collection`	# `_prepareStaticFields( )` Prepare static entity fields Prepare static entity fields Returns `Mage_Catalog_Model_Resource_Product_Collection` Overrides `Mage_Eav_Model_Entity_Collection_Abstract::_prepareStaticFields()`
`public Varien_Object`	# `getNewEmptyItem( )` Retrieve collection empty item Redeclared for specifying id field name without getting resource model inside model Retrieve collection empty item Redeclared for specifying id field name without getting resource model inside model Returns `Varien_Object`
`public Mage_Catalog_Model_Resource_Product_Collection`	# `setEntity( Mage_Eav_Model_Entity_Abstract $entity )` Set entity to use for attributes Set entity to use for attributes Parameters `$entity` `Mage_Eav_Model_Entity_Abstract` $entity Returns `Mage_Catalog_Model_Resource_Product_Collection` Throws `Mage_Eav_Exception` Overrides `Mage_Eav_Model_Entity_Collection_Abstract::setEntity()`
`public Mage_Catalog_Model_Resource_Product_Collection`	# `setStore( mixed $store )` Set Store scope for collection Set Store scope for collection Parameters `$store` `mixed` $store Returns `Mage_Catalog_Model_Resource_Product_Collection` Overrides `Mage_Catalog_Model_Resource_Collection_Abstract::setStore()`
`protected Mage_Catalog_Model_Resource_Product_Collection`	# `_initSelect( )` Initialize collection select Redeclared for remove entity_type_id condition in catalog_product_entity we store just products Initialize collection select Redeclared for remove entity_type_id condition in catalog_product_entity we store just products Returns `Mage_Catalog_Model_Resource_Product_Collection` Overrides `Mage_Eav_Model_Entity_Collection_Abstract::_initSelect()`
`public Mage_Catalog_Model_Resource_Product_Collection`	# `_loadAttributes( boolean $printQuery = false, boolean $logQuery = false )` Load attributes into loaded entities Load attributes into loaded entities Parameters `$printQuery` `boolean` $printQuery `$logQuery` `boolean` $logQuery Returns `Mage_Catalog_Model_Resource_Product_Collection` Throws `Exception` Overrides `Mage_Eav_Model_Entity_Collection_Abstract::_loadAttributes()`
`public Mage_Catalog_Model_Resource_Product_Collection`	# `addAttributeToSelect( array\|string\|integer\|Mage_Core_Model_Config_Element $attribute, false\|string $joinType = false )` Add attribute to entities in collection If $attribute=='' select all attributes Add attribute to entities in collection If $attribute=='' select all attributes Parameters `$attribute` `array\|string\|integer\|Mage_Core_Model_Config_Element` $attribute `$joinType` `false\|string` $joinType Returns `Mage_Catalog_Model_Resource_Product_Collection` Overrides `Mage_Eav_Model_Entity_Collection_Abstract::addAttributeToSelect()`
`protected Mage_Catalog_Model_Resource_Product_Collection`	# `_beforeLoad( )` Add tax class id attribute to select and join price rules data if needed Add tax class id attribute to select and join price rules data if needed Returns `Mage_Catalog_Model_Resource_Product_Collection`
`protected Mage_Catalog_Model_Resource_Product_Collection`	# `_afterLoad( )` Processing collection items after loading Adding url rewrites, minimal prices, final prices, tax percents Processing collection items after loading Adding url rewrites, minimal prices, final prices, tax percents Returns `Mage_Catalog_Model_Resource_Product_Collection` Overrides `Mage_Eav_Model_Entity_Collection_Abstract::_afterLoad()`
`protected Mage_Catalog_Model_Resource_Product_Collection`	# `_prepareUrlDataObject( )` Prepare Url Data object Prepare Url Data object Returns `Mage_Catalog_Model_Resource_Product_Collection`
`public Mage_Catalog_Model_Resource_Product_Collection`	# `addIdFilter( mixed $productId, boolean $exclude = false )` Add collection filters by identifiers Add collection filters by identifiers Parameters `$productId` `mixed` $productId `$exclude` `boolean` $exclude Returns `Mage_Catalog_Model_Resource_Product_Collection`
`public Mage_Catalog_Model_Resource_Product_Collection`	# `addWebsiteNamesToResult( )` Adding product website names to result collection Add for each product websites information Adding product website names to result collection Add for each product websites information Returns `Mage_Catalog_Model_Resource_Product_Collection`
`public Mage_Catalog_Model_Resource_Product_Collection`	# `addStoreFilter( mixed $store = null )` Add store availability filter. Include availability product for store website Add store availability filter. Include availability product for store website Parameters `$store` `mixed` $store Returns `Mage_Catalog_Model_Resource_Product_Collection`
`public Mage_Catalog_Model_Resource_Product_Collection`	# `addWebsiteFilter( unknown_type $websites = null )` Add website filter to collection Add website filter to collection Parameters `$websites` `unknown_type` $websites Returns `Mage_Catalog_Model_Resource_Product_Collection`
`public array`	# `getLimitationFilters( )` Get filters applied to collection Get filters applied to collection Returns `array`
`public Mage_Catalog_Model_Resource_Product_Collection`	# `addCategoryFilter( Mage_Catalog_Model_Category $category )` Specify category filter for product collection Specify category filter for product collection Parameters `$category` `Mage_Catalog_Model_Category` $category Returns `Mage_Catalog_Model_Resource_Product_Collection`
`public Mage_Catalog_Model_Resource_Product_Collection`	# `joinMinimalPrice( )` Join minimal price attribute to result Join minimal price attribute to result Returns `Mage_Catalog_Model_Resource_Product_Collection`
`public mixed`	# `getMaxAttributeValue( string $attribute )` Retrieve max value by attribute Retrieve max value by attribute Parameters `$attribute` `string` $attribute Returns `mixed`
`public array`	# `getAttributeValueCountByRange( string $attribute, integer $range )` Retrieve ranging product count for arrtibute range Retrieve ranging product count for arrtibute range Parameters `$attribute` `string` $attribute `$range` `integer` $range Returns `array`
`public array($value=>$count)`	# `getAttributeValueCount( string $attribute )` Retrieve product count by some value of attribute Retrieve product count by some value of attribute Parameters `$attribute` `string` $attribute Returns `array($value=>$count)` $value=>$count)
`public array`	# `getAllAttributeValues( string $attribute )` Return all attribute values as array in form: array( [entity_id₁] => array( [store_id₁] => store_value₁, [store_id₂] => store_value₂, ... [store_id_n] => store_value_n ), ... ) Return all attribute values as array in form: array( [entity_id₁] => array( [store_id₁] => store_value₁, [store_id₂] => store_value₂, ... [store_id_n] => store_value_n ), ... ) Parameters `$attribute` `string` $attribute attribute code Returns `array`
`public Varien_Db_Select`	# `getSelectCountSql( )` Get SQL for get record count without left JOINs Get SQL for get record count without left JOINs Returns `Varien_Db_Select`
`protected Varien_Db_Select`	# `_getSelectCountSql( boolean $select = null, mixed $resetLeftJoins = true )` Get SQL for get record count Get SQL for get record count Parameters `$select` `boolean` $resetLeftJoins `$resetLeftJoins` Returns `Varien_Db_Select`
`protected Mage_Catalog_Model_Resource_Product_Collection`	# `_prepareStatisticsData( )` Prepare statistics data Prepare statistics data Returns `Mage_Catalog_Model_Resource_Product_Collection`
`protected Varien_Db_Select`	# `_getClearSelect( )` Retreive clear select Retreive clear select Returns `Varien_Db_Select`
`protected Varien_Db_Select`	# `_buildClearSelect( Varien_Db_Select $select = null )` Build clear select Build clear select Parameters `$select` `Varien_Db_Select` $select Returns `Varien_Db_Select`
`public array`	# `getAllIds( unknown_type $limit = null, unknown_type $offset = null )` Retrive all ids for collection Retrive all ids for collection Parameters `$limit` `unknown_type` $limit `$offset` `unknown_type` $offset Returns `array` Overrides `Mage_Eav_Model_Entity_Collection_Abstract::getAllIds()`
`public Varien_Db_Select`	# `getProductCountSelect( )` Retreive product count select for categories Retreive product count select for categories Returns `Varien_Db_Select`
`public Mage_Catalog_Model_Resource_Product_Collection`	# `unsProductCountSelect( )` Destruct product count select Destruct product count select Returns `Mage_Catalog_Model_Resource_Product_Collection`
`public Mage_Catalog_Model_Resource_Product_Collection`	# `addCountToCategories( Mage_Eav_Model_Entity_Collection_Abstract $categoryCollection )` Adding product count to categories collection Adding product count to categories collection Parameters `$categoryCollection` `Mage_Eav_Model_Entity_Collection_Abstract` $categoryCollection Returns `Mage_Catalog_Model_Resource_Product_Collection`

Packages

Classes

Interfaces

Class Mage_Catalog_Model_Resource_Product_Collection

Direct known subclasses

Indirect known subclasses

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Returns

Overrides

Parameters

Returns

Overrides

Returns

Overrides

Returns

Parameters

Returns

Throws

Overrides

Parameters

Returns

Overrides

Returns

Overrides

Parameters

Returns

Throws

Overrides

Parameters

Returns

Overrides

Returns

Returns

Overrides

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Overrides

Returns

Returns

Parameters

Returns

Returns

Returns

Returns

Parameters