Mage_Adminhtml_Block_Sales_Order_Creditmemo_View Class Reference

Inheritance diagram for Mage_Adminhtml_Block_Sales_Order_Creditmemo_View:

List of all members.

Public Member Functions
	__construct ()
	getCreditmemo ()
	getHeaderText ()
	getBackUrl ()
	getCaptureUrl ()
	getVoidUrl ()
	getCancelUrl ()
	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 37 of file View.php.

    {
        $this->_objectId    = 'creditmemo_id';
        $this->_controller  = 'sales_order_creditmemo';
        $this->_mode        = 'view';

        parent::__construct();

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

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

        if ($this->getCreditmemo()->canRefund()) {
            $this->_addButton('refund', array(
                'label'     => Mage::helper('sales')->__('Refund'),
                'class'     => 'save',
                'onclick'   => 'setLocation(\''.$this->getRefundUrl().'\')'
                )
            );
        }

        if ($this->getCreditmemo()->canVoid()) {
            $this->_addButton('void', array(
                'label'     => Mage::helper('sales')->__('Void'),
                'class'     => 'save',
                'onclick'   => 'setLocation(\''.$this->getVoidUrl().'\')'
                )
            );
        }
        
        if ($this->getCreditmemo()->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 114 of file View.php.

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

getCancelUrl

(

)

Definition at line 134 of file View.php.

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

getCaptureUrl

(

)

Definition at line 124 of file View.php.

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

getCreditmemo

(

)

Retrieve creditmemo model instance

Returns:

Mage_Sales_Model_Order_Creditmemo

Definition at line 91 of file View.php.

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

getHeaderText

(

)

Get header text

Returns:

string

Reimplemented from Mage_Adminhtml_Block_Widget_Container.

Definition at line 96 of file View.php.

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

        $header = Mage::helper('sales')->__('Credit Memo #%s | Date %s | Status %s (%s)',
            $this->getCreditmemo()->getIncrementId(),
            $this->formatDate($this->getCreditmemo()->getCreatedAtDate(), 'medium', true),
            $this->getCreditmemo()->getStateName(),
            $emailSent
        );
        return $header;
    }

getPrintUrl

(

)

Definition at line 139 of file View.php.

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

getVoidUrl

(

)

Definition at line 129 of file View.php.

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

updateBackButtonUrl

(

$

flag

)

Definition at line 146 of file View.php.

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

---

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

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