Class Mage_Sales_Model_Mysql4_Sale_Collection

Description
Description | Vars (details) | Methods (details)

Implements interfaces:

  • IteratorAggregate (internal interface)

Magento

NOTICE OF LICENSE

This source file is subject to the Open Software License (OSL 3.0) that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://opensource.org/licenses/osl-3.0.php If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to [email protected] so we can send you a copy immediately.

DISCLAIMER

Do not edit or add to this file if you wish to upgrade Magento to newer versions in the future. If you wish to customize Magento for your needs please refer to http://www.magentocommerce.com for more information.

Located in /Sales/Model/Mysql4/Sale/Collection.php (line 28) 

Varien_Object
   |
   --Mage_Sales_Model_Mysql4_Sale_Collection
Variable Summary
Description | Vars (details) | Methods (details)
Mage_Customer_Model_Customer $_customer
array $_items
string $_orderStateCondition
null|string|array $_orderStateValue
Zend_Db_Adapter_Abstract $_read
Mage_Sales_Model_Mysql4_Order $_resource
Zend_Db_Select $_select
array $_totals
Method Summary
Description | Vars (details) | Methods (details)
Mage_Sales_Model_Mysql4_Sale_Collection __construct ()
Mage_Sales_Model_Mysql4_Sale_Collection addStoreFilter (array $storeIds)
Mage_Eav_Model_Entity_Attribute_Abstract getAttribute (int|string|object  $attr)
Mage_Eav_Model_Entity_Abstract getEntity ()
array getItems ()
ArrayIterator getIterator ()
Zend_Db_Select getSelect ()
Varien_Object getTotals ()
Mage_Sales_Model_Mysql4_Sale_Collection load ([boolean $printQuery = false], [boolean $logQuery = false])
Mage_Sales_Model_Mysql4_Sale_Collection printLogQuery ([boolean $printQuery = false], [boolean $logQuery = false], [mixed $sql = null])
Mage_Sales_Model_Mysql4_Sale_Collection setCustomerFilter ( $customer)
Mage_Sales_Model_Mysql4_Sale_Collection setOrderStateFilter (string|array $state, [ $exclude = false])
Variables
Description | Vars (details) | Methods (details)
Mage_Customer_Model_Customer $_customer (line 71)

Customer model

  • access: protected
array $_items = array() (line 43)

Loaded collection items

  • access: protected
string $_orderStateCondition = null (line 85)

Order state condition

  • access: protected
null|string|array $_orderStateValue = null (line 78)

Order state value

  • access: protected
Zend_Db_Adapter_Abstract $_read (line 36)

Read connection

  • access: protected
Mage_Sales_Model_Mysql4_Order $_resource (line 57)

Entity attribute

  • access: protected
Zend_Db_Select $_select (line 64)

Collection's Zend_Db_Select object

  • access: protected
array $_totals = array('lifetime' => 0, 'base_lifetime' => 0, 'base_avgsale' => 0, 'num_orders' => 0) (line 50)

Totals data

  • access: protected
Methods
Description | Vars (details) Methods (details)
Constructor __construct (line 91)

Set sales order entity and establish read connection

  • access: public
Mage_Sales_Model_Mysql4_Sale_Collection __construct ()
addStoreFilter (line 115)

Add filter by stores

  • access: public
Mage_Sales_Model_Mysql4_Sale_Collection addStoreFilter (array $storeIds)
  • array $storeIds
getAttribute (line 232)

Retrieve attribute entity by specified parameter

  • access: public
Mage_Eav_Model_Entity_Attribute_Abstract getAttribute (int|string|object  $attr)
  • int|string|object $attr
getEntity (line 242)

Retrieve currently used entity

  • access: public
Mage_Eav_Model_Entity_Abstract getEntity ()
getItems (line 262)

Retrieve array of items

  • access: public
array getItems ()
getIterator (line 252)

Retrieve Iterator instance of items array

  • access: public
ArrayIterator getIterator ()
Implementation of:
IteratorAggregate::getIterator
getSelect (line 221)

Get zend db select instance

  • access: public
Zend_Db_Select getSelect ()
getTotals (line 272)

Retrieve totals data converted into Varien_Object

  • access: public
Varien_Object getTotals ()
load (line 141)

Load data

  • access: public
Mage_Sales_Model_Mysql4_Sale_Collection load ([boolean $printQuery = false], [boolean $logQuery = false])
  • boolean $printQuery
  • boolean $logQuery
printLogQuery (line 205)

Print and/or log query

  • access: public
Mage_Sales_Model_Mysql4_Sale_Collection printLogQuery ([boolean $printQuery = false], [boolean $logQuery = false], [mixed $sql = null])
  • boolean $printQuery
  • boolean $logQuery
  • mixed $sql
setCustomerFilter (line 103)

Set filter by customer

  • access: public
Mage_Sales_Model_Mysql4_Sale_Collection setCustomerFilter ( $customer)
setOrderStateFilter (line 127)

Set filter by order state

  • access: public
Mage_Sales_Model_Mysql4_Sale_Collection setOrderStateFilter (string|array $state, [ $exclude = false])
  • string|array $state
  • $exclude

Documentation generated on Fri, 11 Feb 2011 16:58:45 +0200 by phpDocumentor 1.4.3