Mage_Sales_Model_Entity_Sale_Collection Class Reference

Inheritance diagram for Mage_Sales_Model_Entity_Sale_Collection:

List of all members.

Public Member Functions
	__construct ()
	setCustomerFilter (Mage_Customer_Model_Customer $customer)
	load ($printQuery=false, $logQuery=false)
	printLogQuery ($printQuery=false, $logQuery=false, $sql=null)
	getSelect ()
	getAttribute ($attr)
	getEntity ()
	getIterator ()
	getItems ()
	getTotals ()
Protected Attributes
	$_read
	$_items = array()
	$_totals = array('lifetime' => 0, 'num_orders' => 0)
	$_entity
	$_select
	$_customer

---

Detailed Description

Definition at line 28 of file Collection.php.

---

Constructor & Destructor Documentation

__construct

(

)

Constructor

By default is looking for first argument as array and assignes it as object attributes This behaviour may change in child classes

Reimplemented from Varien_Object.

Definition at line 63 of file Collection.php.

    {
        $this->_entity = Mage::getModel('sales_entity/order');
        $this->_read = $this->_entity->getReadConnection();
    }

---

Member Function Documentation

getAttribute

(

$

attr

)

Enter description here...

Returns:

Mage_Eav_Model_Entity_Attribute_Abstract

Definition at line 159 of file Collection.php.

    {
        return $this->_entity->getAttribute($attr);
    }

getEntity

(

)

Enter description here...

Returns:

Mage_Eav_Model_Entity_Abstract

Definition at line 169 of file Collection.php.

    {
        return $this->_entity;
    }

getItems

(

)

Enter description here...

Returns:

array

Definition at line 189 of file Collection.php.

    {
        return $this->_items;
    }

getIterator

(

)

Enter description here...

Returns:

ArrayIterator

Definition at line 179 of file Collection.php.

    {
        return new ArrayIterator($this->_items);
    }

getSelect

(

)

Get zend db select instance

Returns:

Zend_Db_Select

Definition at line 149 of file Collection.php.

    {
        return $this->_select;
    }

getTotals

(

)

Enter description here...

Returns:

Varien_Object

Definition at line 199 of file Collection.php.

    {
        return new Varien_Object($this->_totals);
    }

load	(	$	printQuery = false,
		$	logQuery = false
	)

Definition at line 75 of file Collection.php.

    {
        $this->_select = $this->_read->select();
        $entityTable= $this->getEntity()->getEntityTable();
        $paidTable  = $this->getAttribute('grand_total')->getBackend()->getTable();
        $idField    = $this->getEntity()->getIdFieldName();
        $this->getSelect()
            ->from(array('sales' => $entityTable),
                array(
                    'store_id',
                    'lifetime'  => 'sum(sales.base_grand_total)',
                    'avgsale'   => 'avg(sales.base_grand_total)',
                    'num_orders'=> 'count(sales.base_grand_total)'
                )
            )
            ->where('sales.entity_type_id=?', $this->getEntity()->getTypeId())
            ->group('sales.store_id')
        ;
        if ($this->_customer instanceof Mage_Customer_Model_Customer) {
            $this->getSelect()
                ->where('sales.customer_id=?', $this->_customer->getId());
        }

        $this->printLogQuery($printQuery, $logQuery);
        try {
            $values = $this->_read->fetchAll($this->getSelect()->__toString());
        } catch (Exception $e) {
            $this->printLogQuery(true, true, $this->getSelect()->__toString());
            throw $e;
        }
        $stores = Mage::getResourceModel('core/store_collection')->setWithoutDefaultFilter()->load()->toOptionHash();
        if (! empty($values)) {
            foreach ($values as $v) {
                $obj = new Varien_Object($v);
                $storeName = isset($stores[$obj->getStoreId()]) ? $stores[$obj->getStoreId()] : null;

                $this->_items[ $v['store_id'] ] = $obj;
                $this->_items[ $v['store_id'] ]->setStoreName($storeName);
                $this->_items[ $v['store_id'] ]->setAvgNormalized($obj->getAvgsale() * $obj->getNumOrders());
                foreach ($this->_totals as $key => $value) {
                    $this->_totals[$key] += $obj->getData($key);
                }
            }
            if ($this->_totals['num_orders']) {
                $this->_totals['avgsale'] = $this->_totals['lifetime'] / $this->_totals['num_orders'];
            }
        }

        return $this;
    }

printLogQuery	(	$	printQuery = false,
		$	logQuery = false,
		$	sql = null
	)

Print and/or log query

Parameters:

	boolean	$printQuery
	boolean	$logQuery

Returns:

Mage_Sales_Model_Entity_Order_Attribute_Collection_Paid

Definition at line 133 of file Collection.php.

                                                                                       {
        if ($printQuery) {
            echo is_null($sql) ? $this->getSelect()->__toString() : $sql;
        }

        if ($logQuery){
            Mage::log(is_null($sql) ? $this->getSelect()->__toString() : $sql);
        }
        return $this;
    }

setCustomerFilter

(

Mage_Customer_Model_Customer $

customer

)

Definition at line 69 of file Collection.php.

    {
        $this->_customer = $customer;
        return $this;
    }

---

Member Data Documentation

$_customer [protected]

Definition at line 61 of file Collection.php.

$_entity [protected]

Definition at line 47 of file Collection.php.

$_items = array() [protected]

Definition at line 38 of file Collection.php.

$_read [protected]

Definition at line 36 of file Collection.php.

$_select [protected]

Definition at line 54 of file Collection.php.

$_totals = array('lifetime' => 0, 'num_orders' => 0) [protected]

Definition at line 40 of file Collection.php.

---

The documentation for this class was generated from the following file:

• app/code/core/Mage/Sales/Model/Entity/Sale/Collection.php