Building a Magento Admin Module

Have you ever wanted to build a custom module for the Magento admin panel? Today I am going to share this information hoping you will find this post useful!

Creating the Module Folder Structure

Lets start by creating the following folders:

app/code/community/Toto/ImportXml/etc
app/code/community/Toto/ImportXml/controllers
app/code/community/Toto/ImportXml/Helper

Building the Module

Within the ‘etc’ folder create a file called config.xml and paste in the following code:

configxml

Next create a file called adminhtml.xml within the ‘etc’ folder and paste in the following:

adminhtml

We need to tell Magento to load our module and to do this we need to create a file within /app/etc/modules. I called my file Toto_ImportXml.xml and it contained the below XML code:

xml

Now if you refresh your Magento admin panel, you should notice a new tab called ‘Tofu & Tomato Commerce’. However, if you click on it you will be given a PHP error saying that Magento can’t find a helper class. This is because within adminhtml.xml we told Magento that the tab is associated with the module ‘importxml’ and by default Magento looks for a helper file called Data.php.

module=”importxml”

In the config file we also declared the helper class within the global node.

globalhelper

To fix this problem we need to create a file called Data.php with the Helper folder (/app/code/community/ Toto/ImportXml/ Helper/Data.php). This will be an empty class for the time being but it will fix the warning we are currently getting. Paste the following into Data.php:

helper

Note: The class name needs to be file path structure to Helper/Data.php.

The final stage is to add the controller. This will route the user to the method specified within adminhtml.xml. For example lets take the following:

<action>greenmodule/index/index</action>

Magento will look in the module ‘Greenmodule’ for an index controller with the method called indexAction. So lets create a php file called ‘IndexController.php’ within the controllers folder (/app/code/community/Toto/ImportXml/controllers/ IndexController.php). Paste in the below PHP code:

controller

The above method simply creates a block with a the heading ‘Tofu & Tomato Commerce’ by using Magento factory methods. Refresh your browser and you click on the custom menu tab – you should now see a brand new page with the h1 tag.

Note: You may have to clear your magento cache or log out and log back in for the new page to show. This has caught me out many times.

tofu&tomato-commerce

Enjoy!

Magento print errors: exception printing is disabled by default for security reasons

To print the errors on screen rename the local.xml.sample file in magento_root/errors/ to local.xml

These settings allow for errors to be printed onscreen.print-errors

[Tofu And Tomato] How to add CSS classes to Magento top links.

Ever wonder or ever hit your head on the wall what bloody template file controls the site link, footer link in Magento and how to add a class to it? That’s right, it’s thepage/template/links.phtml.

The template file generates ‘first’ and ‘last’ class in li tag, but sometimes we need more styling in each individual link list and we want to add a class either in li or anchor tag without hacking the core file or extend a class in Magento core, how do we do that?

The answer is in the xml file

magento-top-links

LET’S HAVE A LOOK AT MY CODE:Screen Shot 2014-10-18 at 11.38.48 AM