Class Mage_Core_Model_Resource_Db_Collection_Abstract

Abstract Core Resource Collection

Varien_Data_Collection_Db

Mage_Core_Model_Resource_Db_Collection_Abstract

Direct known subclasses

Indirect known subclasses

Abstract
Package: Mage\Core
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/Core/Model/Resource/Db/Collection/Abstract.php

Methods summary
`public`	# `__construct( Mage_Core_Model_Resource_Db_Abstract $resource = null )` Collection constructor Collection constructor Parameters `$resource` `Mage_Core_Model_Resource_Db_Abstract` $resource
`protected`	# `_construct( )` Initialization here Initialization here
`public string`	# `getMainTable( )` Retrieve main table Retrieve main table Returns `string`
`public Mage_Core_Model_Resource_Db_Collection_Abstract`	# `setMainTable( string $table )` Set main collection table Set main collection table Parameters `$table` `string` $table Returns `Mage_Core_Model_Resource_Db_Collection_Abstract`
`protected Mage_Core_Model_Resource_Db_Collection_Abstract`	# `_initSelect( )` Init collection select Init collection select Returns `Mage_Core_Model_Resource_Db_Collection_Abstract`
`public Varien_Db_Select`	# `getSelect( )` Get Zend_Db_Select instance and applies fields to select if needed Get Zend_Db_Select instance and applies fields to select if needed Returns `Varien_Db_Select`
`protected Mage_Core_Model_Resource_Db_Collection_Abstract`	# `_initSelectFields( )` Init fields for select Init fields for select Returns `Mage_Core_Model_Resource_Db_Collection_Abstract`
`protected array`	# `_getInitialFieldsToSelect( )` Retrieve initial fields to select like id field Retrieve initial fields to select like id field Returns `array`
`protected Mage_Core_Model_Resource_Db_Collection_Abstract`	# `_initInitialFieldsToSelect( )` Initialize initial fields to select like id field Initialize initial fields to select like id field Returns `Mage_Core_Model_Resource_Db_Collection_Abstract`
`public Mage_Core_Model_Resource_Db_Collection_Abstract`	# `addFieldToSelect( string\|array $field, string\|null $alias = null )` Add field to select Add field to select Parameters `$field` `string\|array` $field `$alias` `string\|null` $alias Returns `Mage_Core_Model_Resource_Db_Collection_Abstract`
`public Mage_Core_Model_Resource_Db_Collection_Abstract`	# `addExpressionFieldToSelect( string $alias, string $expression, array $fields )` Add attribute expression (SUM, COUNT, etc) Example: ('sub_total', 'SUM({{attribute}})', 'revenue') Example: ('sub_total', 'SUM({{revenue}})', 'revenue') For some functions like SUM use groupByAttribute. Add attribute expression (SUM, COUNT, etc) Example: ('sub_total', 'SUM({{attribute}})', 'revenue') Example: ('sub_total', 'SUM({{revenue}})', 'revenue') For some functions like SUM use groupByAttribute. Parameters `$alias` `string` $alias `$expression` `string` $expression `$fields` `array` $fields Returns `Mage_Core_Model_Resource_Db_Collection_Abstract`
`public Mage_Core_Model_Resource_Db_Collection_Abstract`	# `removeFieldFromSelect( string\|null $field, boolean $isAlias = false )` Removes field from select Removes field from select Parameters `$field` `string\|null` $field `$isAlias` `boolean` $isAlias Alias identifier Returns `Mage_Core_Model_Resource_Db_Collection_Abstract`
`public Mage_Core_Model_Resource_Db_Collection_Abstract`	# `removeAllFieldsFromSelect( )` Removes all fields from select Removes all fields from select Returns `Mage_Core_Model_Resource_Db_Collection_Abstract`
`protected Mage_Core_Model_Resource_Db_Collection_Abstract`	# `_init( string $model, Mage_Core_Model_Resource_Db_Abstract $resourceModel = null )` Standard resource collection initialization Standard resource collection initialization Parameters `$model` `string` $model `$resourceModel` `Mage_Core_Model_Resource_Db_Abstract` $resourceModel Returns `Mage_Core_Model_Resource_Db_Collection_Abstract`
`public Mage_Core_Model_Resource_Db_Collection_Abstract`	# `setModel( string $model )` Set model name for collection items Set model name for collection items Parameters `$model` `string` $model Returns `Mage_Core_Model_Resource_Db_Collection_Abstract`
`public Varien_Object`	# `getModelName( array $args = array() )` Get model instance Get model instance Parameters `$args` `array` $args Returns `Varien_Object`
`public`	# `setResourceModel( string $model )` Set resource model name for collection items Set resource model name for collection items Parameters `$model` `string` $model
`public string`	# `getResourceModelName( )` Retrieve resource model name Retrieve resource model name Returns `string`
`public Mage_Core_Model_Resource_Db_Abstract`	# `getResource( )` Get resource instance Get resource instance Returns `Mage_Core_Model_Resource_Db_Abstract`
`public string`	# `getTable( string $table )` Retrieve table name Retrieve table name Parameters `$table` `string` $table Returns `string`
`public array`	# `getAllIds( )` Retrieve all ids for collection Retrieve all ids for collection Returns `array`
`public`	# `getData( )`
`protected string`	# `_prepareSelect( Varien_Db_Select $select )` Prepare select for load Prepare select for load Returns `string`
`public Mage_Core_Model_Resource_Db_Collection_Abstract`	# `join( string $table, string $cond, string $cols = '*' )` Join table to collection select Join table to collection select Parameters `$table` `string` $table `$cond` `string` $cond `$cols` `string` $cols Returns `Mage_Core_Model_Resource_Db_Collection_Abstract`
`protected Mage_Core_Model_Resource_Db_Collection_Abstract`	# `_beforeLoad( )` Redeclare before load method for adding event Redeclare before load method for adding event Returns `Mage_Core_Model_Resource_Db_Collection_Abstract`
`public Mage_Core_Model_Resource_Db_Collection_Abstract`	# `setResetItemsDataChanged( boolean $flag )` Set reset items data changed flag Set reset items data changed flag Parameters `$flag` `boolean` $flag Returns `Mage_Core_Model_Resource_Db_Collection_Abstract`
`public Mage_Core_Model_Mysql4_Collection_Abstract`	# `resetItemsDataChanged( )` Set flag data has changed to all collection items Set flag data has changed to all collection items Returns `Mage_Core_Model_Mysql4_Collection_Abstract`
`protected Mage_Core_Model_Resource_Db_Collection_Abstract`	# `_afterLoad( )` Redeclare after load method for specifying collection items original data Redeclare after load method for specifying collection items original data Returns `Mage_Core_Model_Resource_Db_Collection_Abstract`
`public Mage_Core_Model_Resource_Db_Collection_Abstract`	# `save( )` Save all the entities in the collection Save all the entities in the collection Returns `Mage_Core_Model_Resource_Db_Collection_Abstract`
`protected boolean`	# `_canUseCache( )` Check if cache can be used for collection Check if cache can be used for collection Returns `boolean`
`protected string`	# `_loadCache( Zend_Db_Select $select )` Load cached data for select Load cached data for select Parameters `$select` `Zend_Db_Select` $select Returns `string` \| false
`protected Mage_Core_Model_Resource_Db_Collection_Abstract`	# `_saveCache( array $data, Zend_Db_Select $select )` Save collection data to cache Save collection data to cache Parameters `$data` `array` $data `$select` `Zend_Db_Select` $select Returns `Mage_Core_Model_Resource_Db_Collection_Abstract`
`protected array`	# `_getCacheTags( )` Redeclared for processing cache tags throw application object Redeclared for processing cache tags throw application object Returns `array`
`public string`	# `formatDate( integer\|string\|Zend_Date $date, boolean $includeTime = true )` Format Date to internal database date format Format Date to internal database date format Parameters `$date` `integer\|string\|Zend_Date` $date `$includeTime` `boolean` $includeTime Returns `string`

Constants summary
`string`	`CACHE_TAG`	`'COLLECTION_DATA'`	#

Properties summary
`protected string`	`$_model`		# Model name Model name
`protected string`	`$_resourceModel`		# Resource model name Resource model name
`protected Mage_Core_Model_Resource_Db_Abstract`	`$_resource`		# Resource instance Resource instance
`protected array\|null`	`$_fieldsToSelect`	`null`	# Fields to select in query Fields to select in query
`protected array\|null`	`$_initialFieldsToSelect`	`null`	# Fields initial fields to select like id_field Fields initial fields to select like id_field
`protected booleam`	`$_fieldsToSelectChanged`	`false`	# Fields to select changed flag Fields to select changed flag
`protected array`	`$_joinedTables`	`array()`	# Store joined tables here Store joined tables here
`protected string`	`$_mainTable`	`null`	# Collection main table Collection main table
`protected boolean`	`$_resetItemsDataChanged`	`false`	# Reset items data changed flag Reset items data changed flag
`protected string`	`$_eventPrefix`	`''`	# Name prefix of events that are dispatched by model Name prefix of events that are dispatched by model
`protected string`	`$_eventObject`	`''`	# Name of event parameter Name of event parameter
`protected boolean`	`$_useAnalyticFunction`	`false`	# Use analytic function flag If true - allows to prepare final select with analytic function Use analytic function flag If true - allows to prepare final select with analytic function

Packages

Classes

Exceptions

Functions

Class Mage_Core_Model_Resource_Db_Collection_Abstract

Direct known subclasses

Indirect known subclasses

Parameters

Returns

Parameters

Returns

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns