Magento – Load phtml layout for custom module

adminlayoutmagento-1.9module

As with many previous questions, I am unable to load my custom layout as a page. Sorry if I made some noob mistake, but as you may know, as the frustration grows, less accurate the code gets… So, besides a code analysis, I ask from you a clean explanation on what defines the layout magento will use to render a specific page. What are the conventions? Where common mistakes take place? What I did wrong? Thanks in advance for any insight on my problem!

Code:

app\etc\modules\Joaobeno_MarketplaceImporter.xml

<config>
    <modules>
        <Joaobeno_MarketplaceImporter>
            <active>true</active>
            <codePool>local</codePool>
            <depends>
                <Mage_Core />
             </depends>
        </Joaobeno_MarketplaceImporter>
    </modules>
</config>

app\design\adminhtml\default\default\layout\joaobeno_marketplaceimporter.xml

<layout>
<adminhtml_marketplaceimporter_index>
    <reference name="content">
        <block type="joaobeno_marketplaceimporter/adminhtml_marketplaceimporter_index" name="templateBlock" template="marketplaceimporter/advancedimporterbackend.phtml"/>
    </reference>
</adminhtml_marketplaceimporter_index>
</layout>

app\code\local\Joaobeno\MarketplaceImporter\etc\adminhtml.xml

<config>
    <menu>
        <joaobeno_marketplaceimporter translate="title" module="joaobeno_marketplaceimporter">
            <title>Importador</title>
            <sort_order>700</sort_order>
            <children>
                <etd translate="title" module="joaobeno_marketplaceimporter">
                    <title>Importar</title>
                    <action>adminhtml/marketplaceimporter_index</action>
                    <sort_order>0</sort_order>
                </etd>
            </children>
        </joaobeno_marketplaceimporter>
    </menu>
</config>

app\code\local\Joaobeno\MarketplaceImporter\etc\config.xml

<config>
    <modules>
        <Joaobeno_MarketplaceImporter>
            <version>1.0.0</version>
        </Joaobeno_MarketplaceImporter>
    </modules>
    <global>
        <resources>
            <joaobeno_marketplaceimporter_setup>
                <setup>
                    <module>Joaobeno_MarketplaceImporter</module>
                    <class>Joaobeno_MarketplaceImporter_Model_Resource_Setup</class>
                </setup>
            </joaobeno_marketplaceimporter_setup>
        </resources>
        <blocks>
            <joaobeno_marketplaceimporter>
                <class>Joaobeno_MarketplaceImporter_Block</class>
            </joaobeno_marketplaceimporter>
        </blocks>
        <helpers>
            <joaobeno_marketplaceimporter>
                <class>Joaobeno_MarketplaceImporter_Helper</class>
            </joaobeno_marketplaceimporter>
        </helpers>
        <models>
            <joaobeno_marketplaceimporter>
                <class>Joaobeno_MarketplaceImporter_Model</class>
                <resourceModel>joaobeno_marketplaceimporter_resource</resourceModel>
            </joaobeno_marketplaceimporter>
            <joaobeno_marketplaceimporter_resource>
                <class>Joaobeno_MarketplaceImporter_Model_Resource</class>
                <entities>
                    <etd>
                        <table>joaobeno_marketplaceimporter_etd</table>
                    </etd>
                    <etd_store>
                        <table>joaobeno_marketplaceimporter_etd_store</table>
                    </etd_store>
                </entities>
            </joaobeno_marketplaceimporter_resource>
        </models>
    </global>
    <adminhtml>
        <layout>
            <updates>
                <joaobeno_marketplaceimporter>
                    <file>joaobeno_marketplaceimporter.xml</file>
                </joaobeno_marketplaceimporter>
            </updates>
        </layout>
        <translate>
            <modules>
                <Joaobeno_MarketplaceImporter>
                    <files>
                        <default>Joaobeno_MarketplaceImporter.csv</default>
                    </files>
                </Joaobeno_MarketplaceImporter>
            </modules>
        </translate>
    </adminhtml>
    <admin>
        <routers>
            <adminhtml>
                <args>
                    <modules>
                        <Joaobeno_MarketplaceImporter before="Mage_Adminhtml">Joaobeno_MarketplaceImporter_Adminhtml</Joaobeno_MarketplaceImporter>
                    </modules>
                </args>
            </adminhtml>
        </routers>
    </admin>
</config>

UPDATE

Sorry for forgeting this!

app\code\local\Joaobeno\MarketplaceImporter\controllers\Adminhtml\Marketplaceimporter\IndexController.php

class Joaobeno_MarketplaceImporter_Adminhtml_Marketplaceimporter_IndexController extends Mage_Adminhtml_Controller_Action
{
    public function indexAction()
    {
        $this->loadLayout();
        $this->renderLayout();
    }
}

Best Answer

I assume it's a case issue. Magento Controller Class Matching would match your marketplaceimporter_index against .../Marketplaceimporter/IndexController.php

A common mistake is then to name the Directory like the module MarketplaceImporter (with a capital I).

The easiest way would be to just rename the Controller Directory. I think it's also possible to use CamelCase in the Controllers Full Action Name

should be something like this:

<layout>
<adminhtml_marketplaceImporter_index>
    <reference name="content">
        <block type="joaobeno_marketplaceimporter/adminhtml_marketplaceimporter_index" name="templateBlock" template="marketplaceimporter/advancedimporterbackend.phtml"/>
    </reference>
</adminhtml_marketplaceImporter_index>
</layout>

You can also dump the Full Action Name to use in the Layout in your Controller with $this->getFullActionName() or get the css class from the body Tag and replace the - with _

If this does not help, we might need some Controller and Block Code to help you further.

===UPDATE===

Turns out it wasn't the case issue, but the full action name was missing an _index at the end.

The Full Action Name is built from the module, that the controller belongs to, the Class Path under the controllers directory + the actual Controller Name and Action Name.

1. Module (adminhtml_marketplaceimporter_index_index):

In your case, the module beeing responsible is the adminhtml module (defined in your config.xml routers config - first tag under routers).

This is the first Part of the full action name: adminhtml_marketplaceimporter_index_index

2. Class Path or Subdirectory (adminhtml_marketplaceimporter_index_index)

The next part can be found under the Class Path, that is defined in your routers config (Joaobeno_MarketplaceImporter_Adminhtml) defined in your config.xml.

The first part identifies your Module Joaobeno_MarketplaceImporter_Adminhtml.

Since it is a controller, Magento will look for it in the controllers Subdirectory.

The _Adminhtml then identifies the Subdirectory under controllers. So now you know, that the controller lies under Joaobeno/MarketplaceImporter/controllers/Adminhtml and the class Name starts with Joaobeno_MarketplaceImporter_Adminhtml

From here, I think it is up to you how to proceed. A common practice is then to use your Module Namespace and Name as Directory Structure to not accidently overwrite other modules controllers under adminhtml. This would result in the Directory (with the case problem in Mind): Joaobeno/MarketplaceImporter/controllers/Adminhtml/Joaobeno/Marketplaceimporter

or in your case only using the module name: Joaobeno/MarketplaceImporter/controllers/Adminhtml/Marketplaceimporter

This Directory Structure defines the next part from the Full Action Name: adminhtml_marketplaceimporter_index_index

3. Controller Name and Action Name (adminhtml_marketplaceimporter_index_index)

The next Part is defined by the controller name (IndexController) adminhtml_marketplaceimporter_index_index

and the last part is defined by the action name (indexAction) adminhtml_marketplaceimporter_index_index

The layout.xml in your case should then be like this I think:

<layout>
<adminhtml_marketplaceimporter_index_index>
    <reference name="content">
        <block type="joaobeno_marketplaceimporter/adminhtml_marketplaceimporter_index" name="templateBlock" template="marketplaceimporter/advancedimporterbackend.phtml"/>
    </reference>
</adminhtml_marketplaceimporter_index_index>
</layout>

Related Solutions

Add Custom Layouts for CMS and Category – Magento 1.7 Guide

In order to make it appear in the layout dropdown you need to create a custom module (you can also add something in a core file but please don't do that). Let's name the extension Easylife_Layout. For this you need to create the following files: app/etc/modules/Easylife_Layout.xml - the declaration file

<?xml version="1.0"?>
<config>
    <modules>
        <Easylife_Layout>
            <active>true</active>
            <codePool>local</codePool>
            <depends>
                <Mage_Page />
            </depends>
        </Easylife_Layout>
    </modules>
</config>

app/code/local/Easylife/Layout/etc/config.xml - the configuration file

<?xml version="1.0"?> 
<config>
    <modules>
        <Easylife_Layout>
            <version>0.0.1</version>
        </Easylife_Layout>
    </modules>
    <global>
        <page>
            <layouts> 
                <lookbook module="page" translate="label">
                    <label>Lookbook</label>
                    <template>page/1column-lookbook.phtml</template>
                    <layout_handle>lookbook</layout_handle>
                </lookbook> 
            </layouts>
        </page>
    </global>
    <frontend>
        <layout>
            <updates>
                <easylife_layout>
                    <file>easylife_layout.xml</file>
                </easylife_layout>
            </updates>
        </layout>
    </frontend>
</config>

app/design/frontend/{interface}/{theme}/layout/easylife_layout.xml - the layout file

<?xml version="1.0"?> 
<layout>
    <lookbook translate="label">
        <label>Lookbook</label>
        <reference name="root">
            <action method="setTemplate"><template>page/1column-lookbook.phtml</template></action>
            <action method="setIsHandle"><applied>1</applied></action>
        </reference>
    </lookbook> 
</layout>

The last one is necessary in case you want to be able to reference your custom layout in layout files. Something like:

<update hande="lookbook" />

Clear the cache and...that's it. Le tme know if it works for you.

Admin Grid View Not Working in Magento – Custom Module Fix

I cant see any menu codes here. So provide us with adminhtml.xml if any.

However I will give you my random thoughts here. Your admin route is setup like this.

 <routers>
    <pets>
        <use>admin</use>
        <args>
            <module>Ffriends_Pets</module>
            <frontName>pets</frontName>
        </args>
    </pets>
</routers>

What this do is setuping an admin router for your module. It has no problem as of now. But this will leads all of your module's url (admin side) looks like this

  www.domain.com/pets/controller/method

But if you have a look on all of admin urls, it follows this convention

  www.domain.com/admin/controller/method

If you need the same effect, then you need to change your admin router setup like this.

<admin>
    <routers>
        <adminhtml>
            <args>
                <modules>
                    <ffriends_pets before="Mage_Adminhtml">Ffriends_Pets_Adminhtml</ffriends_pets >
                </modules>
            </args>
        </adminhtml>
    </routers>
</admin>

Second point comes in layout xml file. As per your current configuration, your layout xml file looks good. However if you adopt the method that I put forward, then there is slight change comes in layout xml file. Layout handle that you are currently using pets_adminhtml_pets_index will change to adminhtml_pets_index. This is because instead of pets router configuration now we are using adminhtml router configuration which is defined inside the core module Mage_Adminhtml.

Now as per the layout xml and configuration, there should be a controller present in your module. It would be

File : app/code/local/Ffriends/Pets/controllers/Adminhtml/PetsController.php

<?php
class Ffriends_Pets_Adminhtml_PetsController extends Mage_Adminhtml_Controller_Action
{
     public function indexAction()
     {
         $this->loadLayout();
         $this->renderLayout();
     }
}

Without this controller, nothing is going to show in admin side.

Side Note :- In order to have a custom menu, you need additional configurations. It will be normally do in adminhtml.xml file. There are plenty of tutorials available outside for set uping a menu. So google it.

Best Answer

Related Solutions

Add Custom Layouts for CMS and Category – Magento 1.7 Guide

Admin Grid View Not Working in Magento – Custom Module Fix

Related Topic