Magento – Layout update handle per storeview

layout-updatestore-viewxml

I'd like to change the title of certain blocks per storeview in my local.xml, however, I've tried numerous things and it doesn't seem to pick up on my changes, not even when I 'unset' the data, and then add nothing.

This is what I have so far:

  <reference name="content">
        <block type="catalog/product_list" name="product_list_bars"  template="catalog/product/list_custom.phtml">
            <action method="setData">
                <name>category_custom_id</name>
                <value>18</value>
            </action>
            <action method="setData">
                <name>category_custom_title</name>
                <value>German</value>
            </action>
        </block>

This is what sets the default block title. This works for the default storeview. But then, I want to change the title to English for the English storeview as follows:

  <STORE_english_eu>
    <reference name="product_list_bars">
        <action method="unsetData">
            <name>category_custom_title</name>
        </action>
    </reference>
</STORE_english_eu>

So to test it, I'm trying to unset it first, and then set it. That doesn't seem to work. What am I missing?

Best Answer

Everything at first glance looks good on the coding side of things.

Make sure your store code is correct. english_eu.

Instead of unsetting the data, did you try just overwriting the data? the setData() method updates the data whether or not it is already set.

Try this:

<layout>
    <default>
       <reference name="content">
        <block type="catalog/product_list" name="product_list_bars"  template="catalog/product/list_custom.phtml">
            <action method="setData">
                <name>category_custom_id</name>
                <value>18</value>
            </action>
            <action method="setData">
                <name>category_custom_title</name>
                <value>German</value>
            </action>
        </block>
    </default>
    <STORE_english_eu>
        <reference name="product_list_bars">
            <action method="setData">
                <key>category_custom_title</key>
                <value>English EU Title</value>
            </action>
        </reference>
    </STORE_english_eu>
</layout>

If this does not work, please paste your entire local.xml into your question, so we can catch any other areas that may be affecting it.

Related Solutions

Magento – Layout Update XML – Update Handle

You can't do that. Specifically, you can't use the <update/> tag in a CMS page's Layout Update XML field.

Magento processes the <update/> nodes when it is initially loading the layout update files, and layout updates from the core_layout_update table. This is done with the fetchRecursiveUpdates function.

#File: app/code/core/Mage/Core/Model/Layout/Update.php

public function fetchPackageLayoutUpdates($handle)
{
    //...
        $this->fetchRecursiveUpdates($updateXml);
    //...

    return true;
}

public function fetchDbLayoutUpdates($handle)
{
    //...
    $this->fetchRecursiveUpdates($updateXml);        
    //...        
}

//...
public function fetchRecursiveUpdates($updateXml)
{
    foreach ($updateXml->children() as $child) {
        if (strtolower($child->getName())=='update' && isset($child['handle'])) {
            $this->merge((string)$child['handle']);
            // Adding merged layout handle to the list of applied hanles
            $this->addHandle((string)$child['handle']);
        }
    }
    return $this;
}

A CMS page, however, is rendered later on via a helper method. The rendering of a CMS page includes this code

#File: app/code/core/Mage/Cms/Helper/Page.php

$action->loadLayoutUpdates();
$layoutUpdate = ($page->getCustomLayoutUpdateXml() && $inRange)
    ? $page->getCustomLayoutUpdateXml() : $page->getLayoutUpdateXml();
$action->getLayout()->getUpdate()->addUpdate($layoutUpdate);
$action->generateLayoutXml()->generateLayoutBlocks();

The loadLayoutUpdates call is the standard loading of the layout, including the fetchRecursiveUpdates mentioned above.

Then, Magento looks for a custom layout XML update set on the CMS page object

$layoutUpdate = ($page->getCustomLayoutUpdateXml() && $inRange)
    ? $page->getCustomLayoutUpdateXml() : $page->getLayoutUpdateXml();

and adds it directly to the list of updates to apply

$action->getLayout()->getUpdate()->addUpdate($layoutUpdate);

This means the scanning for the update tag is never done.

If I was trying to implement something like this, I'd add a new block in the CMS page's layout update XML, and then add the shared layout items programmatically in the blocks _prepareLayout method. (not sure off the top of my head if that would work w/r/t to timing, but that'd be where I'd start)

Magento Layout XML – Difference Between and Handle

Reference

This is used to make a reference to an current existing block in the layout xml. Say you want to change a template of a block you would first reference it and then call set template. Or if you wanted to add some new javascript to the header.

<reference name="head">
    <action method="addJs">
        <script>something/new.js</script>
    </action>
</reference>

Update

This is used to add a complete layout handle inside another one. For example if you had the layout handle test_handle and wanted to include the handle catalog_product_view you would do the following.

<test_handle>
    <update name="catalog_product_view" />
</test_handle>

In this case the test_handle and the catalog_product_view handle would be exactly the same and include the same blocks.

Best Answer

Related Solutions

Magento – Layout Update XML – Update Handle

Magento Layout XML – Difference Between and Handle

Related Topic