Mage_Adminhtml_Block_Sales_Order_View_Giftmessage Class Reference

Inheritance diagram for Mage_Adminhtml_Block_Sales_Order_View_Giftmessage:

List of all members.

Public Member Functions
	getSaveButtonHtml ()
	setEntity (Varien_Object $entity)
	getEntity ()
	getDefaultSender ()
	getDefaultRecipient ()
	getFieldName ($name)
	getFieldId ($id)
	getFieldIdPrefix ()
	getMessage ()
	getSaveUrl ()
	getHtmlId ()
	canDisplayGiftmessage ()
Protected Member Functions
	_beforeToHtml ()
	_prepareLayout ()
	_initMessage ()
Protected Attributes
	$_entity
	$_giftMessage

---

Detailed Description

Definition at line 34 of file Giftmessage.php.

---

Member Function Documentation

_beforeToHtml

(

)

[protected]

Before rendering html, but after trying to load cache

Returns:

Mage_Core_Block_Abstract

Reimplemented from Mage_Core_Block_Abstract.

Definition at line 50 of file Giftmessage.php.

    {
        if ($this->getParentBlock() && ($order = $this->getParentBlock()->getOrder())) {
            $this->setEntity($order);
        }
        parent::_beforeToHtml();
    }

_initMessage

(

)

[protected]

Initialize gift message for entity

Returns:

Mage_Adminhtml_Block_Sales_Order_View_Giftmessage

Definition at line 199 of file Giftmessage.php.

    {
        $this->_giftMessage = $this->helper('giftmessage/message')->getGiftMessage(
                                   $this->getEntity()->getGiftMessageId()
                              );

        // init default values for giftmessage form
        if(!$this->getMessage()->getSender()) {
            $this->getMessage()->setSender($this->getDefaultSender());
        }
        if(!$this->getMessage()->getRecipient()) {
            $this->getMessage()->setRecipient($this->getDefaultRecipient());
        }

        return $this;
    }

_prepareLayout

(

)

[protected]

Prepares layout of block

Returns:

Mage_Adminhtml_Block_Sales_Order_View_Giftmessage

Reimplemented from Mage_Core_Block_Abstract.

Definition at line 63 of file Giftmessage.php.

    {
        $this->setChild('save_button',
            $this->getLayout()->createBlock('adminhtml/widget_button')
                ->setData(array(
                    'label'   => Mage::helper('giftmessage')->__('Save Gift Message'),
                    'class'   => 'save'
                ))
        );

        return $this;
    }

canDisplayGiftmessage

(

)

Indicates that block can display giftmessages form

Returns:

boolean

Definition at line 256 of file Giftmessage.php.

    {
        return $this->helper('giftmessage/message')->getIsMessagesAvailable(
            'order', $this->getEntity(), $this->getEntity()->getStoreId()
        );
    }

getDefaultRecipient

(

)

Retrive default value for giftmessage recipient

Returns:

string

Definition at line 139 of file Giftmessage.php.

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

        if($this->getEntity()->getOrder()) {
            if ($this->getEntity()->getOrder()->getShippingAddress()) {
                return $this->getEntity()->getOrder()->getShippingAddress()->getName();
            } else if ($this->getEntity()->getOrder()->getBillingAddress()) {
                return $this->getEntity()->getOrder()->getBillingAddress()->getName();
            }
        }

        if ($this->getEntity()->getShippingAddress()) {
            return $this->getEntity()->getShippingAddress()->getName();
        } else if ($this->getEntity()->getBillingAddress()) {
            return $this->getEntity()->getBillingAddress()->getName();
        }

        return '';
    }

getDefaultSender

(

)

Retrive default value for giftmessage sender

Returns:

string

Definition at line 121 of file Giftmessage.php.

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

        if($this->getEntity()->getOrder()) {
            return $this->getEntity()->getOrder()->getCustomerName();
        }

        return $this->getEntity()->getCustomerName();
    }

getEntity

(

)

Retrive entity for form

Returns:

Varien_Object

Definition at line 107 of file Giftmessage.php.

    {
        if(is_null($this->_entity)) {
            $this->setEntity(Mage::getModel('giftmessage/message')->getEntityModelByType('order'));
            $this->getEntity()->load($this->getRequest()->getParam('entity'));
        }
        return $this->_entity;
    }

getFieldId

(

$

id

)

Retrive real html id for field

Parameters:

string

$name

Returns:

string

Definition at line 179 of file Giftmessage.php.

    {
        return $this->getFieldIdPrefix() . $id;
    }

getFieldIdPrefix

(

)

Retrive field html id prefix

Returns:

string

Definition at line 189 of file Giftmessage.php.

    {
        return 'giftmessage_order_' . $this->getEntity()->getId() . '_';
    }

getFieldName

(

$

name

)

Retrive real name for field

Parameters:

string

$name

Returns:

string

Definition at line 168 of file Giftmessage.php.

    {
        return 'giftmessage[' . $this->getEntity()->getId() . '][' . $name . ']';
    }

getHtmlId

(

)

Retrive block html id

Returns:

string

Reimplemented from Mage_Adminhtml_Block_Widget.

Definition at line 246 of file Giftmessage.php.

    {
        return substr($this->getFieldIdPrefix(), 0, -1);
    }

getMessage

(

)

Retrive gift message for entity

Returns:

Mage_GiftMessage_Model_Message

Definition at line 221 of file Giftmessage.php.

    {
        if(is_null($this->_giftMessage)) {
            $this->_initMessage();
        }

        return $this->_giftMessage;
    }

getSaveButtonHtml

(

)

Retrive save button html

Returns:

string

Definition at line 81 of file Giftmessage.php.

    {
        $this->getChild('save_button')->setOnclick(
            'giftMessagesController.saveGiftMessage(\''. $this->getHtmlId() .'\')'
        );

        return $this->getChildHtml('save_button');
    }

getSaveUrl

(

)

Definition at line 230 of file Giftmessage.php.

    {
        return $this->getUrl('*/sales_order_view_giftmessage/save',
            array(
                'entity'=>$this->getEntity()->getId(),
                'type'  =>'order',
                'reload' => 1
            )
        );
    }

setEntity

(

Varien_Object $

entity

)

Set entity for form

Parameters:

Varien_Object

$entity

Returns:

Mage_Adminhtml_Block_Sales_Order_View_Giftmessage

Definition at line 96 of file Giftmessage.php.

    {
        $this->_entity  = $entity;
        return $this;
    }

---

Member Data Documentation

$_entity [protected]

Definition at line 41 of file Giftmessage.php.

$_giftMessage [protected]

Definition at line 48 of file Giftmessage.php.

---

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

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