Magento – Transactional Email: How to customize shipping address variable/html {{var order.getShippingDescription()}}

emailtemplatetransactional

How to customize this function order.getShippingDescription(), where is this function is written in Magento.

Can someone please help in it

Best Answer

When calling {{var order.getShippingDescription()}} magento will actually call $order->getShippingDescription() where $order is the current order object...the one you are sending the e-mail for.

But that method does not exist. It is called through the magic of __call. it basically returns the shipping_description field from the sales_flat_order table.

If you want to customize it, you can rewrite the Mage_Sales_Model_Order and implement the method getShippingDescription where you process the data from $this->getData('shipping_description').

But I advice against it, because that method is used in many places. You might change something you don't want changed.
Instead you care rewrite the class mentioned above and create your own method getEmailShippingDescription where you put your code, and change the e-mail template to include {{var order.getEmailShippingDescription()}}.

An other approach would be to create your own short code. Something like this:

{{shippingDescription order=$order}}

Here is an explanation on how to do that.
and in your short code directive do this:

public function shippingDescriptionDirective() {
    $params = $this->_getIncludeParameters($construction[2]);
    if (!isset($params['order'])) {
        return '';
    }
    $description = $params['order']->getShippingDescription();
    $processed = your code here to process the description
    return $processed;
}

(Learned this custom short code approach from Vinai Kopp's book Grokking Magento - ha Vinai, you said I will learn nothing new from your book).

Related Solutions

Magento 1.7 Email Templates – How to Customize Shipping Address Variable in Transactional Email

Actually the variables defined at the top of the email are 'injected' when the template is called. In this case it's the order object.

If you check out the file app/code/core/Mage/Sales/Model/Order.php you can find around the line 948 the method getShippingAddress. This is the actual function you're referencing here.

Now for the format('html') part, this is where you can actually start making some changes. And the best part is, no coding is required.

Go to your backend System > Configuration > Customer configuration > Addresslayout and look for the field HTML. By default it will look like this:

{{depend prefix}}{{var prefix}} {{/depend}}{{var firstname}} {{depend middlename}}{{var middlename}} {{/depend}}{{var lastname}}{{depend suffix}} {{var suffix}}{{/depend}}<br/>
{{depend company}}{{var company}}<br />{{/depend}}
{{if street1}}{{var street1}}{{/if}}
{{depend street2}}{{var street2}}{{/depend}}
{{depend street3}}{{var street3}}<br />{{/depend}}
{{depend street4}}{{var street4}}<br />{{/depend}}
{{if postcode}}{{var postcode}}{{/if}} {{if city}}{{var city}}  {{/if}}{{if region}}{{var region}} {{/if}}<br/>
{{var country}}<br/>
{{depend telephone}}T: {{var telephone}}{{/depend}}
{{depend fax}}<br/>F: {{var fax}}{{/depend}}
{{depend vat_id}}<br/>VAT: {{var vat_id}}{{/depend}}

As you can see removing telephone and fax altogether is just a matter of deleting the last 2 lines before the VAT line.

Magento – How to customize Magento Transactional Emails

To change Logo in admin System->Configuration->Design->Transactional Emails->Logo Image and easily pick your logo image from there.
You need to change the store name by updating your store name in admin System->Manage Stores -> Select your store and update it with your store name(Because for sending transactional mails store name is taken from here).

Best Answer

Related Solutions

Magento 1.7 Email Templates – How to Customize Shipping Address Variable in Transactional Email

Magento – How to customize Magento Transactional Emails

Related Topic