Create Custom Helper Class in Magento Module – How to

helpermagento-1.7module

I've made a new module called test_helper and I want to create a helper class in this module so that I can add custom functions to be called all over my site.

I can't however seem to find any examples of just how to go about doing this. I assume I have to create some extra xml in config and ad another file somewhere that extends a base helper but I've not had any luck finding an example to build upon.

Best Answer

Your module naming convention is quite confusing - you're calling the module itself helper? For the purpose of explaining, I'm choosing to call your module myname_mymodule

In your module ./app/code/community/MyName/MyModule/etc/config.xml, within the <global> tags

<helpers>
  <mymodule>
      <class>MyName_MyModule_Helper</class>
  </mymodule>
</helpers>

Then create the file ./app/code/community/MyName/MyModule/Helper/Data.php

<?php

class MyName_MyModule_Helper_Data extends Mage_Core_Helper_Abstract{

}

Then to call that module, you would use

$helper = Mage::helper('mymodule');

Related Solutions

Magento – checkout Helper Url overload not working

I'm on my phone so I can't search for you, but you need to determine if the class is being invoked directly i.e. new Mage_Checkout_Helper_Url or if another class is extending it. That's the only way this rewrite won't work.

Magento Helper – Referencing a Helper Class in Magento

You can create as many helpers as you want in your module.
Let's say your module name is Namespace_Module.
The config.xml of your module should contain this inside the <global> tag:

<helpers>
    <module>
       <class>Namespace_Module_Helper</class>
    </module>
</helpers>

Now let's say you want to create a helper called Something.
You should place the code in Namespace/Module/Helper/Something.php:

<?php 
class Namespace_Module_Helper_Something extends Mage_Core_Helper_Abstract { //or any other helper

    public function doSomething(){
        ....
    }
}

You can call your new helper anywhere like this:

Mage::helper('module/something')->doSomething();

Basically Mage::helper('module'); is the same thing as Mage::helper('module/data');

Best Answer

Related Solutions

Magento – checkout Helper Url overload not working

Magento Helper – Referencing a Helper Class in Magento

Related Topic