Magento – How to Update Layout in Observer

event-observerlayout

I'm trying to change the layout of the success page with an observer at Mage_Checkout_OnepageController::successAction() on Mage::dispatchEvent('checkout_onepage_controller_success_action', array('order_ids' => array($lastOrderId)));
This event is loaded after $this->loadLayout(); and before $this->loadLayoutUpdates();

My Observer

$update = Mage::app()->getLayout()->getUpdate();
$update->addHandle('my_personalized_handle');
$update->removeHandle('the_old_hanle');

Up to that point it works fine and on the controller I got the correct list of handles before the render. But at the render process it just ignores all what I changed even if I do $this->loadLayoutUpdates(); directly in the controller.

So at this point I'm a bit confused.

-== EDIT ==-

The other solution would be to redirect to another page than the success page, that would be to send a correct URL to Mage_Checkout_OnepageController::saveOrderAction() for $redirectUrl = $this->getOnepage()->getCheckout()->getRedirectUrl();, I'm able to change the session when they land on the checkout page, but when they validate the payment the getRedirectUrl is empty and doesn't consider my new URL.

Do I set this problem as a second post?

Best Answer

Try using the event controller_action_layout_load_before. By setting up your events to listen to this you should be able to use the action and layout that are attached to this event.

<events>
    <controller_action_layout_load_before>
        <observers>
            <layout_test>
                <class>layout_test/observer</class>
                <method>changeLayoutEvent</method>
            </layout_test>
        </observers>
    </controller_action_layout_load_before>
</events>

Then you can check the action type in your observer. For example if you wanted to replace the standard success handle and add the customer account edit handle (just an idea don't think any shop would want the edit page here) then it would look it:

$action = $observer->getEvent()->getAction();
if ($action instanceof Mage_Checkout_OnepageController && $action->getRequest()->getRequestedActionName() == 'success') {
    $observer->getEvent()->getLayout()->getUpdate()
        ->addHandle('customer_account_edit')
        ->removeHandle('checkout_onepage_success');
}

Related Solutions

Magento 1.9 Module Layout – Add Block Dynamically in Event Observer

The event checkout_onepage_controller_success_action is triggered right before the layout is rendered, so you can still manipulate it.

The observer only receives the order id as a parameter, so you have to get the layout via app model:

$layout = Mage::app()->getLayout();

Now you can do your changes programmatically, like this:

$messageBlock = $layout->createBlock('core/template', 'payment_message_block');
$messageBlock->setTemplate('payment_message.phtml');
$layout->getBlock('footer')->append($messageBlock);

If you use the controller_action_layout_load_before event, you can also load a custom layout handle like this, if on the success page:

if ($observer->getAction()->getFullActionName() === 'checkout_onepage_success') {
    $layout = $observer->getLayout();
    $layout->getUpdate()->addHandle('custom_layout_handle');
}

which you can define in XML:

<layout>
  <custom_layout_handle>
     <reference name="footer">
       <block type="core/template" name="payment_message_block" template="payment_message.phtml" />
     </reference>
  </custom_layout_handle>
</layout>

Update: The footer block is cached, so we have to make sure that a different version is fetched from the cache if the message is present. For example:

$footer = $layout->getBlock('footer');
$footer->setCacheKey(sha1($footer->getCacheKey() . '-payment-message');

how to pass genrated data to phtml file? which i am showing

Reference your block by name and use setData(). For example:

$block = $layout->getBlock('payment_message_block')->setData('messsage', 'Hello');

And in the template:

echo $this->getData('message');

Magento – How to update the layout file in observer

You're on the wrong path here. To manipulate the layout programmatically, you don't need to write XML.

This XML code

<reference name="head">
    <action method="addJs">
        <js>path/to/rahul.js</js>
    </action>
</reference>

translates to this PHP code:

Mage::app()->getLayout()->getBlock('head')->addJs('path/to/rahul.js');

(provided that loadLayout() has been called before, so that the "head" block already exists, but is not rendered yet)

Best Answer

Related Solutions

Magento 1.9 Module Layout – Add Block Dynamically in Event Observer

Magento – How to update the layout file in observer

Related Topic