Mage_Adminhtml_Block_Sales_Order_Invoice_View Class Reference

Inheritance diagram for Mage_Adminhtml_Block_Sales_Order_Invoice_View:

List of all members.

Public Member Functions
	__construct ()
	getInvoice ()
	getHeaderText ()
	getBackUrl ()
	getCaptureUrl ()
	getVoidUrl ()
	getCancelUrl ()
	getCreditMemoUrl ()
	getPrintUrl ()
	updateBackButtonUrl ($flag)

---

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 36 of file View.php.

    {
        $this->_objectId    = 'invoice_id';
        $this->_controller  = 'sales_order_invoice';
        $this->_mode        = 'view';

        parent::__construct();

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

        if ($this->getInvoice()->canCancel()) {
            $this->_addButton('cancel', array(
                'label'     => Mage::helper('sales')->__('Cancel'),
                'class'     => 'delete',
                'onclick'   => 'setLocation(\''.$this->getCancelUrl().'\')'
                )
            );
        }

        if ($this->getInvoice()->getOrder()->canCreditmemo()) {
            if ($this->getInvoice()->getOrder()->getPayment()->canRefundPartialPerInvoice()
                || !$this->getInvoice()->getIsUsedForRefund())
            {
                $this->_addButton('capture', array(
                    'label'     => Mage::helper('sales')->__('Credit Memo'),
                    'class'     => 'save',
                    'onclick'   => 'setLocation(\''.$this->getCreditMemoUrl().'\')'
                    )
                );
            }
        }

        if (Mage::getSingleton('admin/session')->isAllowed('sales/order/actions/capture')
            && $this->getInvoice()->canCapture()) {
            $this->_addButton('capture', array(
                'label'     => Mage::helper('sales')->__('Capture'),
                'class'     => 'save',
                'onclick'   => 'setLocation(\''.$this->getCaptureUrl().'\')'
                )
            );
        }

        if ($this->getInvoice()->canVoid()) {
            $this->_addButton('void', array(
                'label'     => Mage::helper('sales')->__('Void'),
                'class'     => 'save',
                'onclick'   => 'setLocation(\''.$this->getVoidUrl().'\')'
                )
            );
        }

        if ($this->getInvoice()->getId()) {
            $this->_addButton('print', array(
                'label'     => Mage::helper('sales')->__('Print'),
                'class'     => 'save',
                'onclick'   => 'setLocation(\''.$this->getPrintUrl().'\')'
                )
            );
        }
    }

---

Member Function Documentation

getBackUrl

(

)

Get URL for back (reset) button

Returns:

string

Reimplemented from Mage_Adminhtml_Block_Widget_Form_Container.

Definition at line 131 of file View.php.

    {
        return $this->getUrl(
            '*/sales_order/view',
            array(
                'order_id'  => $this->getInvoice()->getOrderId(),
                'active_tab'=> 'order_invoices'
            ));
    }

getCancelUrl

(

)

Definition at line 151 of file View.php.

    {
        return $this->getUrl('*/*/cancel', array('invoice_id'=>$this->getInvoice()->getId()));
    }

getCaptureUrl

(

)

Definition at line 141 of file View.php.

    {
        return $this->getUrl('*/*/capture', array('invoice_id'=>$this->getInvoice()->getId()));
    }

getCreditMemoUrl

(

)

Definition at line 156 of file View.php.

    {
        return $this->getUrl('*/sales_order_creditmemo/start', array(
            'order_id'  => $this->getInvoice()->getOrder()->getId(),
            'invoice_id'=> $this->getInvoice()->getId(),
        ));
    }

getHeaderText

(

)

Get header text

Returns:

string

Reimplemented from Mage_Adminhtml_Block_Widget_Container.

Definition at line 109 of file View.php.

    {
        if ($this->getInvoice()->getEmailSent()) {
            $emailSent = Mage::helper('sales')->__('Invoice email sent');
        }
        else {
            $emailSent = Mage::helper('sales')->__('Invoice email not sent');
        }

        $header = Mage::helper('sales')->__('Invoice #%s | %s (%s)',
            $this->getInvoice()->getIncrementId(),
            $this->getInvoice()->getStateName(),
            $emailSent
        );
        /*$header = Mage::helper('sales')->__('Invoice #%s | Order Date: %s | Customer Name: %s',
            $this->getInvoice()->getIncrementId(),
            $this->formatDate($this->getInvoice()->getOrder()->getCreatedAt(), 'medium', true),
            $this->getInvoice()->getOrder()->getCustomerName()
        );*/
        return $header;
    }

getInvoice

(

)

Retrieve invoice model instance

Returns:

Mage_Sales_Model_Order_Invoice

Definition at line 104 of file View.php.

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

getPrintUrl

(

)

Definition at line 164 of file View.php.

    {
        return $this->getUrl('*/*/print', array(
            'invoice_id' => $this->getInvoice()->getId()
        ));
    }

getVoidUrl

(

)

Definition at line 146 of file View.php.

    {
        return $this->getUrl('*/*/void', array('invoice_id'=>$this->getInvoice()->getId()));
    }

updateBackButtonUrl

(

$

flag

)

Definition at line 171 of file View.php.

    {
        if ($flag) {
            return $this->_updateButton('back', 'onclick', 'setLocation(\'' . $this->getUrl('*/sales_invoice/') . '\')');
        }
        return $this;
    }

---

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

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