Mage_Sales_OrderController Class Reference

Inheritance diagram for Mage_Sales_OrderController:

List of all members.

Public Member Functions
	preDispatch ()
	historyAction ()
	viewAction ()
	viewOldAction ()
	invoiceAction ()
	shipmentAction ()
	creditmemoAction ()
	reorderAction ()
	printAction ()
	printInvoiceAction ()
	printShipmentAction ()
	printCreditmemoAction ()
Protected Member Functions
	_canViewOrder ($order)
	_viewAction ()
	_loadValidOrder ($orderId=null)
	_canViewOscommerceOrder ($order)

---

Detailed Description

Definition at line 35 of file OrderController.php.

---

Member Function Documentation

_canViewOrder

(

$

order

)

[protected]

Check order view availability

Parameters:

Mage_Sales_Model_Order

$order

Returns:

bool

Definition at line 76 of file OrderController.php.

    {
        $customerId = Mage::getSingleton('customer/session')->getCustomerId();
        $availableStates = Mage::getSingleton('sales/order_config')->getVisibleOnFrontStates();
        if ($order->getId() && $order->getCustomerId() && ($order->getCustomerId() == $customerId)
            && in_array($order->getState(), $availableStates, $strict = true)
            ) {
            return true;
        }
        return false;
    }

_canViewOscommerceOrder

(

$

order

)

[protected]

Check osCommerce order view availability

Parameters:

array

$order

Returns:

bool

Definition at line 145 of file OrderController.php.

    {
        $customerId = Mage::getSingleton('customer/session')->getCustomerId();
        if (isset($order['osc_magento_id']) && isset($order['magento_customers_id']) && $order['magento_customers_id'] == $customerId) {
            return true;
        }
        return false;
    }

_loadValidOrder

(

$

orderId = null

)

[protected]

Try to load valid order by order_id and register it

Parameters:

int

$orderId

Returns:

bool

Definition at line 109 of file OrderController.php.

    {
        if (null === $orderId) {
            $orderId = (int) $this->getRequest()->getParam('order_id');
        }
        if (!$orderId) {
            $this->_forward('noRoute');
            return false;
        }

        $order = Mage::getModel('sales/order')->load($orderId);

        if ($this->_canViewOrder($order)) {
            Mage::register('current_order', $order);
            return true;
        }
        else {
            $this->_redirect('*/*/history');
        }
        return false;
    }

_viewAction

(

)

[protected]

Definition at line 88 of file OrderController.php.

    {
        if (!$this->_loadValidOrder()) {
            return;
        }

        $this->loadLayout();
        $this->_initLayoutMessages('catalog/session');

        if ($navigationBlock = $this->getLayout()->getBlock('customer_account_navigation')) {
            $navigationBlock->setActive('sales/order/history');
        }
        $this->renderLayout();
    }

creditmemoAction

(

)

Definition at line 192 of file OrderController.php.

    {
        $this->_viewAction();
    }

historyAction

(

)

Customer order history

Definition at line 57 of file OrderController.php.

    {
        $this->loadLayout();
        $this->_initLayoutMessages('catalog/session');

        $this->getLayout()->getBlock('head')->setTitle($this->__('My Orders'));

        if ($block = $this->getLayout()->getBlock('customer.account.link.back')) {
            $block->setRefererUrl($this->_getRefererUrl());
        }
        $this->renderLayout();
    }

invoiceAction

(

)

Definition at line 182 of file OrderController.php.

    {
        $this->_viewAction();
    }

preDispatch

(

)

Action predispatch

Check customer authentication for some actions

Reimplemented from Mage_Core_Controller_Front_Action.

Definition at line 43 of file OrderController.php.

    {
        parent::preDispatch();
        $action = $this->getRequest()->getActionName();
        $loginUrl = Mage::helper('customer')->getLoginUrl();

        if (!Mage::getSingleton('customer/session')->authenticate($this, $loginUrl)) {
            $this->setFlag('', self::FLAG_NO_DISPATCH, true);
        }
    }

printAction

(

)

Definition at line 232 of file OrderController.php.

    {
        if (!$this->_loadValidOrder()) {
            return;
        }
        $this->loadLayout('print');
        $this->renderLayout();
    }

printCreditmemoAction

(

)

Definition at line 286 of file OrderController.php.

    {
        $creditmemoId = (int) $this->getRequest()->getParam('creditmemo_id');
        if ($creditmemoId) {
            $creditmemo = Mage::getModel('sales/order_creditmemo')->load($creditmemoId);
            $order = $creditmemo->getOrder();
        } else {
            $orderId = (int) $this->getRequest()->getParam('order_id');
            $order = Mage::getModel('sales/order')->load($orderId);
        }

        if ($this->_canViewOrder($order)) {
            Mage::register('current_order', $order);
            if (isset($creditmemo)) {
                Mage::register('current_creditmemo', $creditmemo);
            }
            $this->loadLayout('print');
            $this->renderLayout();
        } else {
            $this->_redirect('*/*/history');
        }
    }

printInvoiceAction

(

)

Definition at line 241 of file OrderController.php.

    {
        $invoiceId = (int) $this->getRequest()->getParam('invoice_id');
        if ($invoiceId) {
            $invoice = Mage::getModel('sales/order_invoice')->load($invoiceId);
            $order = $invoice->getOrder();
        } else {
            $orderId = (int) $this->getRequest()->getParam('order_id');
            $order = Mage::getModel('sales/order')->load($orderId);
        }

        if ($this->_canViewOrder($order)) {
            Mage::register('current_order', $order);
            if (isset($invoice)) {
                Mage::register('current_invoice', $invoice);
            }
            $this->loadLayout('print');
            $this->renderLayout();
        } else {
            $this->_redirect('*/*/history');
        }
    }

printShipmentAction

(

)

Definition at line 264 of file OrderController.php.

    {
        $shipmentId = (int) $this->getRequest()->getParam('shipment_id');
        if ($shipmentId) {
            $shipment = Mage::getModel('sales/order_shipment')->load($shipmentId);
            $order = $shipment->getOrder();
        } else {
            $orderId = (int) $this->getRequest()->getParam('order_id');
            $order = Mage::getModel('sales/order')->load($orderId);
        }
        if ($this->_canViewOrder($order)) {
            Mage::register('current_order', $order);
            if (isset($shipment)) {
                Mage::register('current_shipment', $shipment);
            }
            $this->loadLayout('print');
            $this->renderLayout();
        } else {
            $this->_redirect('*/*/history');
        }
    }

reorderAction

(

)

Definition at line 197 of file OrderController.php.

    {
        if (!$this->_loadValidOrder()) {
            return;
        }
        $order = Mage::registry('current_order');

        $cart = Mage::getSingleton('checkout/cart');
        $cartTruncated = false;
        /* @var $cart Mage_Checkout_Model_Cart */

        $items = $order->getItemsCollection();
        foreach ($items as $item) {
            try {
                $cart->addOrderItem($item);
            } catch (Mage_Core_Exception $e){
                if (Mage::getSingleton('checkout/session')->getUseNotice(true)) {
                    Mage::getSingleton('checkout/session')->addNotice($e->getMessage());
                }
                else {
                    Mage::getSingleton('checkout/session')->addError($e->getMessage());
                }
                $this->_redirect('*/*/history');
            } catch (Exception $e) {
                Mage::getSingleton('checkout/session')->addException($e,
                    Mage::helper('checkout')->__('Can not add item to shopping cart')
                );
                $this->_redirect('checkout/cart');
            }
        }

        $cart->save();
        $this->_redirect('checkout/cart');
    }

shipmentAction

(

)

Definition at line 187 of file OrderController.php.

    {
        $this->_viewAction();
    }

viewAction

(

)

Order view page

Definition at line 134 of file OrderController.php.

    {
        $this->_viewAction();
    }

viewOldAction

(

)

osCommerce Order view page

Definition at line 157 of file OrderController.php.

    {

        $orderId = (int) $this->getRequest()->getParam('order_id');
        if (!$orderId) {
            $this->_forward('noRoute');
            return;
        }

        $order = Mage::getModel('oscommerce/oscommerce')->loadOrderById($orderId);
        if ($this->_canViewOscommerceOrder($order['order'])) {
            Mage::register('current_oscommerce_order', $order);
           $this->loadLayout();
            if ($navigationBlock = $this->getLayout()->getBlock('customer_account_navigation')) {
                $navigationBlock->setActive('sales/order/history');
            }

            $this->renderLayout();
        }
        else {
            $this->_redirect('*/*/history');
        }

    }

---

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

• app/code/core/Mage/Sales/controllers/OrderController.php