Mage_Adminhtml_Block_Sales_Order_View Class Reference

Inheritance diagram for Mage_Adminhtml_Block_Sales_Order_View:

List of all members.

Public Member Functions
	__construct ()
	getOrder ()
	getOrderId ()
	getHeaderText ()
	getUrl ($params='', $params2=array())
	getEditUrl ()
	getCancelUrl ()
	getInvoiceUrl ()
	getCreditmemoUrl ()
	getHoldUrl ()
	getUnholdUrl ()
	getShipUrl ()
	getCommentUrl ()
	getReorderUrl ()
Protected Member Functions
	_isAllowedAction ($action)

---

Detailed Description

Definition at line 34 of file View.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 Mage_Adminhtml_Block_Widget_Form_Container.

Definition at line 37 of file View.php.

    {
        $this->_objectId    = 'order_id';
        $this->_controller  = 'sales_order';
        $this->_mode        = 'view';

        parent::__construct();

        $this->_removeButton('delete');
        $this->_removeButton('reset');
        $this->_removeButton('save');
        $this->setId('sales_order_view');

        if ($this->_isAllowedAction('edit') && $this->getOrder()->canEdit()) {
            $onclickJs = 'deleteConfirm(\''
                . Mage::helper('sales')->__('Are you sure? This order will be cancelled and a new one will be created instead')
                . '\', \'' . $this->getEditUrl() . '\');';
            $this->_addButton('order_edit', array(
                'label'    => Mage::helper('sales')->__('Edit'),
                'onclick'  => $onclickJs,
            ));
            // see if order has non-editable products as items
            $nonEditableTypes = array_keys(Mage::getResourceSingleton('sales/order')->aggregateProductsByTypes(
                $this->getOrder()->getId(), array_keys(Mage::getConfig()->getNode('adminhtml/sales/order/create/available_product_types')->asArray()), false
            ));
            if ($nonEditableTypes) {
                $this->_updateButton('order_edit', 'onclick',
                    'if (!confirm(\'' . Mage::helper('sales')->__(
                        'This order contains (%s) items and therefore cannot be edited through the admin interface at this time, if you wish to continue editing the (%s) items will be removed, the order will be cancelled and a new order will be placed',
                        implode(', ', $nonEditableTypes),
                        implode(', ', $nonEditableTypes)
                    ) . '\')) return false;' . $onclickJs
                );
            }
        }

        if ($this->_isAllowedAction('cancel') && $this->getOrder()->canCancel()) {
            $message = Mage::helper('sales')->__('Are you sure you want to cancel this order?');
            $this->_addButton('order_cancel', array(
                'label'     => Mage::helper('sales')->__('Cancel'),
                'onclick'   => 'deleteConfirm(\''.$message.'\', \'' . $this->getCancelUrl() . '\')',
            ));
        }

        if ($this->_isAllowedAction('creditmemo') && $this->getOrder()->canCreditmemo()) {
            $this->_addButton('order_creditmemo', array(
                'label'     => Mage::helper('sales')->__('Credit Memo'),
                'onclick'   => 'setLocation(\'' . $this->getCreditmemoUrl() . '\')',
            ));
        }

        if ($this->_isAllowedAction('hold') && $this->getOrder()->canHold()) {
            $this->_addButton('order_hold', array(
                'label'     => Mage::helper('sales')->__('Hold'),
                'onclick'   => 'setLocation(\'' . $this->getHoldUrl() . '\')',
            ));
        }

        if ($this->_isAllowedAction('unhold') && $this->getOrder()->canUnhold()) {
            $this->_addButton('order_unhold', array(
                'label'     => Mage::helper('sales')->__('Unhold'),
                'onclick'   => 'setLocation(\'' . $this->getUnholdUrl() . '\')',
            ));
        }

        if ($this->_isAllowedAction('invoice') && $this->getOrder()->canInvoice()) {
            $_label = $this->getOrder()->getForcedDoShipmentWithInvoice()?'Invoice and Ship':'Invoice';
            $this->_addButton('order_invoice', array(
                'label'     => Mage::helper('sales')->__('%s', $_label),
                'onclick'   => 'setLocation(\'' . $this->getInvoiceUrl() . '\')',
            ));
        }

        if ($this->_isAllowedAction('ship') && $this->getOrder()->canShip()
            && !$this->getOrder()->getForcedDoShipmentWithInvoice()) {
            $this->_addButton('order_ship', array(
                'label'     => Mage::helper('sales')->__('Ship'),
                'onclick'   => 'setLocation(\'' . $this->getShipUrl() . '\')',
            ));
        }

        if ($this->_isAllowedAction('reorder') && $this->getOrder()->canReorder()) {
            $this->_addButton('order_reorder', array(
                'label'     => Mage::helper('sales')->__('Reorder'),
                'onclick'   => 'setLocation(\'' . $this->getReorderUrl() . '\')',
            ));
        }
    }

---

Member Function Documentation

_isAllowedAction

(

$

action

)

[protected]

Definition at line 212 of file View.php.

    {
        return Mage::getSingleton('admin/session')->isAllowed('sales/order/actions/' . $action);
    }

getCancelUrl

(

)

Definition at line 172 of file View.php.

    {
        return $this->getUrl('*/*/cancel');
    }

getCommentUrl

(

)

Definition at line 202 of file View.php.

    {
        return $this->getUrl('*/*/comment');
    }

getCreditmemoUrl

(

)

Definition at line 182 of file View.php.

    {
        return $this->getUrl('*/sales_order_creditmemo/start');
    }

getEditUrl

(

)

Definition at line 167 of file View.php.

    {
        return $this->getUrl('*/sales_order_edit/start');
    }

getHeaderText

(

)

Get header text

Returns:

string

Reimplemented from Mage_Adminhtml_Block_Widget_Container.

Definition at line 146 of file View.php.

    {
        if ($_extOrderId = $this->getOrder()->getExtOrderId()) {
            $_extOrderId = '[' . $_extOrderId . '] ';
        } else {
            $_extOrderId = '';
        }
        $text = Mage::helper('sales')->__('Order # %s %s| Order Date %s',
            $this->getOrder()->getRealOrderId(),
            $_extOrderId,
            $this->formatDate($this->getOrder()->getCreatedAtDate(), 'medium', true)
        );
        return $text;
    }

getHoldUrl

(

)

Definition at line 187 of file View.php.

    {
        return $this->getUrl('*/*/hold');
    }

getInvoiceUrl

(

)

Definition at line 177 of file View.php.

    {
        return $this->getUrl('*/sales_order_invoice/start');
    }

getOrder

(

)

Retrieve order model object

Returns:

Mage_Sales_Model_Order

Definition at line 131 of file View.php.

    {
        return Mage::registry('sales_order');
    }

getOrderId

(

)

Retrieve Order Identifier

Returns:

int

Definition at line 141 of file View.php.

    {
        return $this->getOrder()->getId();
    }

getReorderUrl

(

)

Definition at line 207 of file View.php.

    {
        return $this->getUrl('*/sales_order_create/reorder');
    }

getShipUrl

(

)

Definition at line 197 of file View.php.

    {
        return $this->getUrl('*/sales_order_shipment/start');
    }

getUnholdUrl

(

)

Definition at line 192 of file View.php.

    {
        return $this->getUrl('*/*/unhold');
    }

getUrl	(	$	route = '',
		$	params = array()
	)

Generate url by route and parameters

Parameters:

	string	$route
	array	$params

Returns:

string

Reimplemented from Mage_Core_Block_Abstract.

Definition at line 161 of file View.php.

    {
        $params2['order_id'] = $this->getOrderId();
        return parent::getUrl($params, $params2);
    }

---

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

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