Mage_Adminhtml_Block_Sales_Order_Grid Class Reference

Inheritance diagram for Mage_Adminhtml_Block_Sales_Order_Grid:

List of all members.

Public Member Functions
	__construct ()
	getRowUrl ($row)
	getGridUrl ()
Protected Member Functions
	_prepareCollection ()
	_prepareColumns ()
	_prepareMassaction ()

---

Detailed Description

Definition at line 34 of file Grid.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 37 of file Grid.php.

    {
        parent::__construct();
        $this->setId('sales_order_grid');
        $this->setUseAjax(true);
        $this->setDefaultSort('created_at');
        $this->setDefaultDir('DESC');
        $this->setSaveParametersInSession(true);
    }

---

Member Function Documentation

_prepareCollection

(

)

[protected]

Prepare grid collection object

Returns:

this

Reimplemented from Mage_Adminhtml_Block_Widget_Grid.

Definition at line 47 of file Grid.php.

    {
        //TODO: add full name logic
        $collection = Mage::getResourceModel('sales/order_collection')
            ->addAttributeToSelect('*')
            ->joinAttribute('billing_firstname', 'order_address/firstname', 'billing_address_id', null, 'left')
            ->joinAttribute('billing_lastname', 'order_address/lastname', 'billing_address_id', null, 'left')
            ->joinAttribute('shipping_firstname', 'order_address/firstname', 'shipping_address_id', null, 'left')
            ->joinAttribute('shipping_lastname', 'order_address/lastname', 'shipping_address_id', null, 'left')
            ->addExpressionAttributeToSelect('billing_name',
                'CONCAT({{billing_firstname}}, " ", {{billing_lastname}})',
                array('billing_firstname', 'billing_lastname'))
            ->addExpressionAttributeToSelect('shipping_name',
                'CONCAT({{shipping_firstname}}, " ", {{shipping_lastname}})',
                array('shipping_firstname', 'shipping_lastname'));
        $this->setCollection($collection);
        return parent::_prepareCollection();
    }

_prepareColumns

(

)

[protected]

Reimplemented from Mage_Adminhtml_Block_Widget_Grid.

Definition at line 66 of file Grid.php.

    {

        $this->addColumn('real_order_id', array(
            'header'=> Mage::helper('sales')->__('Order #'),
            'width' => '80px',
            'type'  => 'text',
            'index' => 'increment_id',
        ));

        if (!Mage::app()->isSingleStoreMode()) {
            $this->addColumn('store_id', array(
                'header'    => Mage::helper('sales')->__('Purchased from (store)'),
                'index'     => 'store_id',
                'type'      => 'store',
                'store_view'=> true,
                'display_deleted' => true,
            ));
        }

        $this->addColumn('created_at', array(
            'header' => Mage::helper('sales')->__('Purchased On'),
            'index' => 'created_at',
            'type' => 'datetime',
            'width' => '100px',
        ));

        /*$this->addColumn('billing_firstname', array(
            'header' => Mage::helper('sales')->__('Bill to First name'),
            'index' => 'billing_firstname',
        ));

        $this->addColumn('billing_lastname', array(
            'header' => Mage::helper('sales')->__('Bill to Last name'),
            'index' => 'billing_lastname',
        ));*/
        $this->addColumn('billing_name', array(
            'header' => Mage::helper('sales')->__('Bill to Name'),
            'index' => 'billing_name',
        ));

        /*$this->addColumn('shipping_firstname', array(
            'header' => Mage::helper('sales')->__('Ship to First name'),
            'index' => 'shipping_firstname',
        ));

        $this->addColumn('shipping_lastname', array(
            'header' => Mage::helper('sales')->__('Ship to Last name'),
            'index' => 'shipping_lastname',
        ));*/
        $this->addColumn('shipping_name', array(
            'header' => Mage::helper('sales')->__('Ship to Name'),
            'index' => 'shipping_name',
        ));

        $this->addColumn('base_grand_total', array(
            'header' => Mage::helper('sales')->__('G.T. (Base)'),
            'index' => 'base_grand_total',
            'type'  => 'currency',
            'currency' => 'base_currency_code',
        ));

        $this->addColumn('grand_total', array(
            'header' => Mage::helper('sales')->__('G.T. (Purchased)'),
            'index' => 'grand_total',
            'type'  => 'currency',
            'currency' => 'order_currency_code',
        ));

        $this->addColumn('status', array(
            'header' => Mage::helper('sales')->__('Status'),
            'index' => 'status',
            'type'  => 'options',
            'width' => '70px',
            'options' => Mage::getSingleton('sales/order_config')->getStatuses(),
        ));

        if (Mage::getSingleton('admin/session')->isAllowed('sales/order/actions/view')) {
            $this->addColumn('action',
                array(
                    'header'    => Mage::helper('sales')->__('Action'),
                    'width'     => '50px',
                    'type'      => 'action',
                    'getter'     => 'getId',
                    'actions'   => array(
                        array(
                            'caption' => Mage::helper('sales')->__('View'),
                            'url'     => array('base'=>'*/*/view'),
                            'field'   => 'order_id'
                        )
                    ),
                    'filter'    => false,
                    'sortable'  => false,
                    'index'     => 'stores',
                    'is_system' => true,
            ));
        }
        $this->addRssList('rss/order/new', Mage::helper('sales')->__('New Order RSS'));

        return parent::_prepareColumns();
    }

_prepareMassaction

(

)

[protected]

Prepare grid massaction actions

Returns:

Mage_Adminhtml_Block_Widget_Grid

Reimplemented from Mage_Adminhtml_Block_Widget_Grid.

Definition at line 168 of file Grid.php.

    {
        $this->setMassactionIdField('entity_id');
        $this->getMassactionBlock()->setFormFieldName('order_ids');

        $this->getMassactionBlock()->addItem('cancel_order', array(
             'label'=> Mage::helper('sales')->__('Cancel'),
             'url'  => $this->getUrl('*/*/massCancel'),
        ));

        $this->getMassactionBlock()->addItem('hold_order', array(
             'label'=> Mage::helper('sales')->__('Hold'),
             'url'  => $this->getUrl('*/*/massHold'),
        ));

        $this->getMassactionBlock()->addItem('unhold_order', array(
             'label'=> Mage::helper('sales')->__('Unhold'),
             'url'  => $this->getUrl('*/*/massUnhold'),
        ));

        $this->getMassactionBlock()->addItem('pdfinvoices_order', array(
             'label'=> Mage::helper('sales')->__('Print Invoices'),
             'url'  => $this->getUrl('*/*/pdfinvoices'),
        ));

        $this->getMassactionBlock()->addItem('pdfshipments_order', array(
             'label'=> Mage::helper('sales')->__('Print Packingslips'),
             'url'  => $this->getUrl('*/*/pdfshipments'),
        ));

        $this->getMassactionBlock()->addItem('pdfcreditmemos_order', array(
             'label'=> Mage::helper('sales')->__('Print Credit Memos'),
             'url'  => $this->getUrl('*/*/pdfcreditmemos'),
        ));

        $this->getMassactionBlock()->addItem('pdfdocs_order', array(
             'label'=> Mage::helper('sales')->__('Print All'),
             'url'  => $this->getUrl('*/*/pdfdocs'),
        ));

//        $statuses = Mage::getSingleton('sales/order_config')->getStatuses();
//        array_unshift($statuses, array('value'=>'', 'label'=>''));
//        $this->getMassactionBlock()->addItem('change_status', array(
//             'label'=> Mage::helper('sales')->__('Change Status'),
//             'url'  => $this->getUrl('*/*/massStatus'),
//             'additional' => array(
//                    'visibility' => array(
//                             'name' => 'status',
//                             'type' => 'select',
//                             'class' => 'required-entry',
//                             'label' => Mage::helper('sales')->__('New Status'),
//                             'values' => $statuses
//                         )
//             )
//        ));

//        $prints = array(
//            'empty'     => array('value'=>'', 'label'=>''),
//            'order'    => Mage::helper('sales')->__('Orders'),
//            'invoice'  => Mage::helper('sales')->__('Invoices'),
//            'shipment' => Mage::helper('sales')->__('Shipments'),
//        );
//        $this->getMassactionBlock()->addItem('print', array(
//             'label'=> Mage::helper('sales')->__('Print'),
//             'url'  => $this->getUrl('*/*/massPrint'),
//             'additional' => array(
//                    'visibility' => array(
//                             'name' => 'document',
//                             'type' => 'select',
//                             'class' => 'required-entry',
//                             'label' => Mage::helper('sales')->__('Document'),
//                             'values' => $prints
//                         )
//             )
//        ));

        return $this;
    }

getGridUrl

(

)

Reimplemented from Mage_Adminhtml_Block_Widget_Grid.

Definition at line 255 of file Grid.php.

    {
        return $this->getUrl('*/*/grid', array('_current'=>true));
    }

getRowUrl

(

$

row

)

Definition at line 247 of file Grid.php.

    {
        if (Mage::getSingleton('admin/session')->isAllowed('sales/order/actions/view')) {
            return $this->getUrl('*/*/view', array('order_id' => $row->getId()));
        }
        return false;
    }

---

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

• app/code/core/Mage/Adminhtml/Block/Sales/Order/Grid.php