Magento how to create a Custom Plugin/ Module / example / tutorial

December 25, 2009
Filed under: eCommerce, Featured, Magento Cart, PHP, Shopping Carts, Zend 

Module Creator

Thanks to member Danieln for creating this PHP script to automatically create a base module given a Namespace and Module.

Credits: Danieln (creator), Alistek (contributor), Damián Culotta (contributor), Somesid (contributor), Ahsan Shahzad (contributor)

Download Module Creator (v0.0.9.1) or Install it as an Extension (beta)

modcreator0.0.9.0_small.jpg

Updated: 25/08/2008 – 0.0.9.1 Release Notes

#NOTE: v0.0.9.1 holds a bug that do not allow to ACL to manage module’s user level access. I am currently working on it to fix.

#ADDED: The module is now created with an upload field for example.

#ADDED: Code in the frontend controller shows how to get an object by param and by custom query .

#FIXED: You can now use blocks to get data on the frontend (see http://www.magentocommerce.com/boards/viewreply/54110/ for more details) .

#NOTE: Wiki post has yet to be updated with new code and explanations.

Updated: 07/04/2008 – 04:00AM CST – 0.0.9.0 Release Notes

#NEW FEATURE: Now with module uninstaller and better look&feel.

#NEW FEATURE: Point to your Magento Install Directory to get you module copied to the right places right away.

#NOTE: Thanks to Barbanet the below problem should be alleviated with entering in your interface and theme at module creation time.

#NOTE: A common problem with the Module Creator has been the confusion over the use of ‘interface’ and ‘theme’.

The directories:

  1. /new/app/design/adminhtml/interface/theme/
  2. /new/app/design/frontend/interface/theme/

In a new Magento installation correspond to:

  1. /app/design/adminhtml/default/default/
  2. /app/design/frontend/default/default/

Please make sure to put your <module>.xml files in the correct ‘layout’ directories as these will determine whether your module is shown or not.

Installing the Module Creator

To install the Module Creator, you can use the Magento Connect Manager with the extension key, or install it manually as follows. Note that if you install via the Connect Manager the path it uses is /moduleCreator.

Copy the index.php file and the Blank folder to your webserver. You may want to put it in it’s own folder so that the index file does not conflict with other index files. Example: mysite.com/module_creator/

Go to the module creator index page in your web browser, and fill in the desired module information. If you enter your Magento directory, the module creator will attempt to install the module directly into Magento, though file permissions must be set correctly for this to happen. If your file permissions are incorrect, or you do not want the module installed right away, you can leave the Magento Directory blank, and the module creator will create the module in a folder called [i]new[/i], and place it in the module creator’s folder.

Please note that if you enter in your magento directory to install to you must have the correct path. Let’s say that you have Magento installed here:

  1. http://www.my_site.com/magento/

And you have the Module Creator installed here:

  1. http://www.my_site.com/module_creator/

This means that the path that you would need to enter in the Module Creator is this:

  1. ../magento

The ‘..’ signifies one directory up.

Document Conventions

I am going to use a few common conventions here that should make it easier to figure out what you need to replace as I am making this as generic as possible.

Anything in angled brackets (including the angled brackets): < >, needs to replaced with the appropriate text.

Anything in square brackets (including the square brackets): [ ], needs to replaced with the appropriate text.

The reason I am using two different conventions here are that XML files already use angled brackets so you will only see the square brackets in use in XML files.

NOTE: All directory, file, class names are Case Sensitive unless otherwise noted.

Create Directories

Magento Modules follow a common naming scheme, Namespace_Module. This is very important to remember as you need to be careful about how you name your classes. Every custom module will be created in the directory:

/app/code/local

The first step in creating your custom module is determining the namespace and module name. The namespace is simply an extra division that you can create you module in. This means that you can have two modules named the same thing if they are in two different namespaces. One way to use namespaces is to use your company name or initials for all of your modules. If my company name is Acme and I am creating a module called News the full module name would be Acme_News. Magento uses the namespace Mage. There is nothing stopping you from using that namespace under local, i.e. you could create Mage_News and that would work just fine.

Note : You can not use underscore within your module name

Note2: It seems that currently, if you use upper case characters in module names (expecting to show word starts since neither – nor _ is allowed)… the install will fail or rather the module will not work. Suggestion: use a single upper case character, at the beginning of the name.

Let’s setup our directory structure:

/app/code/local/<Namespace>/<Module>/

  1. Block/
  2. controllers/
  3. etc/
  4. Model/
  5. Mysql4/
  6. <Module>/
  7. sql/
  8. <module>_setup/

/app/design/frontend/<interface>/<theme>/

  1. template/
  2. <module>/

Activate Module

Magento requires there to be an XML file that tells Magento to look for and use your custom module.

/app/etc/modules/<Namespace>_<Module>.xml

<?xml version="1.0"?>

<config>

<modules>

<[Namespace]_[Module]>

<active>true</active>

<codePool>local</codePool>

</[Namespace]_[Module]>

</modules>

</config>

Also you can disable your module in the Configuration menu on the backend via the Advanced tab.

NOTE: Due to a bug in Magento, whitespace is not treated correctly. This means that if you leave space in the values between node names (anything in angled brackets <> is a node), Magento will break.

As an explanation of the above code you will see that all you are changing is the [Namespace]_[Module] text and leaving everything else the same. Please note the capital P in codePool. If this is lowercase this module will not be active.

Create Controller

/app/code/local/<Namespace>/<Module>/controllers/IndexController.php

<?php

class <Namespace>_<Module>_IndexController extends Mage_Core_Controller_Front_Action

{

public function indexAction()

{

$this->loadLayout();

$this->renderLayout();

}

}

NOTE: You may notice that there is no closing, ?>, PHP tag in the code. This is a common coding style that Magento core classes use. Magento Coding Standard is similar (with some exceptions) to Zend Framework PHP Coding Standard and you can find the detailed explanations of this rule in Zend Framework Documentation

Create Configuration XML




/app/code/local/<Namespace>/<Module>/etc/config.xml

    <?xml version="1.0"?>		

      <config>		

      <modules>		

      <[Namespace]_[Module]>		

      <version>0.1.0</version>		

      </[Namespace]_[Module]>		

      </modules>		

      <frontend>		

      <routers>		

      <[module]>		

      <use>standard</use>		

      <args>		

      <module>[Namespace]_[Module]</module>		

      <frontName>[module]</frontName>		

      </args>		

      </[module]>		

      </routers>		

      <layout>		

      <updates>		

      <[module]>		

      <file>[module].xml</file>		

      </[module]>		

      </updates>		

      </layout>		

      </frontend>		

      <global>		

      <models>		

      <[module]>		

      <class>[Namespace]_[Module]_Model</class>		

      <resourceModel>[module]_mysql4</resourceModel>		

      </[module]>		

      <[module]_mysql4>		

      <class>[Namespace]_[Module]_Model_Mysql4</class>		

      <entities>		

      <[module]>		

      <table>[module]</table>		

      </[module]>		

      </entities>		

      </[module]_mysql4>		

      </models>		

      <resources>		

      <[module]_setup>		  <items module="[module]">
		 <title>Manage Items</title>
      <setup>
		  <sort_order>0</sort_order>
      <module>[Namespace]_[Module]</module>		

      </setup>		

      <connection>		

      <use>core_setup</use>		

      </connection>		

      </[module]_setup>		

      <[module]_write>		

      <connection>		

      <use>core_write</use>		

      </connection>		

      </[module]_write>		

      <[module]_read>		

      <connection>		

      <use>core_read</use>		

      </connection>		

      </[module]_read>		

      </resources>		

      <blocks>		

      <[module]>		

      <class>[Namespace]_[Module]_Block</class>		

      </[module]>		

      </blocks>		

      <helpers>		

      <[module]>		

      <class>[Namespace]_[Module]_Helper</class>		

      </[module]>		

      </helpers>		

      </global>		

      </config>

Create Helper

/app/code/local/<Namespace>/<Module>/Helper/Data.php

<?php

class <Namespace>_<Module>_Helper_Data extends Mage_Core_Helper_Abstract

{

}


Create Models

/app/code/local/<Namespace>/<Module>/Model/<Module>.php

<?php

class <Namespace>_<Module>_Model_<Module> extends Mage_Core_Model_Abstract

{

public function _construct()

{

parent::_construct();

$this->_init('<module>/<module>');

}

}

/app/code/local/<Namespace>/<Module>/Model/Mysql4/<Module>.php

<?php

class <Namespace>_<Module>_Model_Mysql4_<Module> extends Mage_Core_Model_Mysql4_Abstract

{

public function _construct()

{

$this->_init('<module>/<module>', '<module>_id');

}

}

NOTE: The ‘<module>_id’ refers to the PRIMARY KEY in your database table.

/app/code/local/<Namespace>/<Module>/Model/Mysql4/<Module>/Collection.php

<?php

class <Namespace>_<Module>_Model_Mysql4_<Module>_Collection extends Mage_Core_Model_Mysql4_Collection_Abstract

{

public function _construct()

{

//parent::__construct();

$this->_init('<module>/<module>');

}

}


SQL Setup

/app/code/local/<Namespace>/<Module>/sql/<module>_setup/mysql4-install-0.1.0.php

<?php

$installer = $this;

$installer->startSetup();

$installer->run("

-- DROP TABLE IF EXISTS {$this->getTable('<module>')};

CREATE TABLE {$this->getTable('<module>')} (

`<module>_id` int(11) unsigned NOT NULL auto_increment,

`title` varchar(255) NOT NULL default '',

`content` text NOT NULL default '',

`status` smallint(6) NOT NULL default '0',

`created_time` datetime NULL,

`update_time` datetime NULL,

PRIMARY KEY (`<module>_id`)

) ENGINE=InnoDB DEFAULT CHARSET=utf8;

");

$installer->endSetup();

NOTE: Please note the <module> text that needs to be replaced. This SQL structure is up to you, this is merely a starting point.

Template Design

/app/design/frontend/<interface>/<theme>/layout/<module>.xml

<?xml version="1.0"?>

<layout version="0.1.0">

<[module]_index_index>

<reference name="content">

<block type="[module]/[module]" name="[module]" />

</reference>

</[module]_index_index>

</layout>

NOTE: The block type will automatically figure out what template file to use based on the second [module] declaration.

As an alternate way of declaring what template file to use you can use this: /app/design/frontend/<interface>/<theme>/layout/<module>.xml

<?xml version="1.0"?>

<layout version="0.1.0">

<[module]_index_index>

<reference name="content">

<block type="core/template" name="[module]" template="[module]/[module].phtml" />

</reference>

</[module]_index_index>

</layout>

/app/design/frontend/<interface>/<theme>/template/<Module>/<module>.phtml

<?php echo $this->__('Module List') ?>

<?php

/*

This will load one record from your database table.

load(<module>_id) will load whatever ID number you give it.

*/

/*

$news = Mage::getModel('<module>/<module>')->load(1);

echo $news->get<Module>Id();

echo $news->getTitle();

echo $news->getContent();

echo $news->getStatus();

*/

/*

This block of code loads all of the records in the database table.

It will iterate through the collection and the first thing it will do

is set the Title to the current value of $i which is incremented each

iteration and then echo that value back out.  At the very end it will

save the entire collection.

*/

/*

$i = 0;

$collection = Mage::getModel('<module>/<module>')->getCollection();

$collection->setPageSize(5);

$collection->setCurPage(2);

$size = $collection->getSize();

$cnt = count($collection);

foreach ($collection as $item) {

$i = $i+1;

$item->setTitle($i);

echo $item->getTitle();

}

$collection->walk('save');

*/

/*

This shows how to load one value, change something and save it.

*/

/*

$object = Mage::getModel('<module>/<module>')->load(1);

$object->setTitle('This is a changed title');

$object->save();

*/

?>

NOTE: Uncomment anything that you would like to use and this is just a starting point and some common methods for you to try and pull the data out.

In this section I am utilizing the built-in Grid Widgets and form capabilities to create a form to allow editing and creating new items for your custom database.

Directory Additions

Here is the revised directory setup due to the additions and changes we need for the backend module.

/app/code/local/<Namespace>/<Module>/

  1. Block/
  2. Adminhtml/
  3. <Module>/
  4. Edit/
  5. Tab/
  6. controllers/
  7. Adminhtml/
  8. etc/
  9. Helper/
  10. Model/
  11. Mysql4/
  12. <Module>/
  13. sql/
  14. <module>_setup/

Blocks

These control the setup and appearance of your grids and the options that they display.

NOTE: Please note the fact that Block comes before Adminhtml in the class declaration. In any of the Magento modules in Adminhtml it is the opposite. For your module to work it has to be Block_Adminhtml otherwise you will get a ‘Cannot redeclare module…’ error.

/app/code/local/<Namespace>/<Module>/Block/Adminhtml/<Module>.php

<?php

class <Namespace>_<Module>_Block_Adminhtml_<Module> extends Mage_Adminhtml_Block_Widget_Grid_Container

{

public function __construct()

{

$this->_controller = 'adminhtml_<module>';

$this->_blockGroup = '<module>';

$this->_headerText = Mage::helper('<module>')->__('Item Manager');

$this->_addButtonLabel = Mage::helper('<module>')->__('Add Item');

parent::__construct();

}

}

/app/code/local/<Namespace>/<Module>/Block/Adminhtml/<Module>/Edit.php

<?php

class <Namespace>_<Module>_Block_Adminhtml_<Module>_Edit extends Mage_Adminhtml_Block_Widget_Form_Container

{

public function __construct()

{

parent::__construct();

$this->_objectId = 'id';

$this->_blockGroup = '<module>';

$this->_controller = 'adminhtml_<module>';

$this->_updateButton('save', 'label', Mage::helper('<module>')->__('Save Item'));

$this->_updateButton('delete', 'label', Mage::helper('<module>')->__('Delete Item'));

}

public function getHeaderText()

{

if( Mage::registry('<module>_data') && Mage::registry('<module>_data')->getId() ) {

return Mage::helper('<module>')->__("Edit Item '%s'", $this->htmlEscape(Mage::registry('<module>_data')->getTitle()));

} else {

return Mage::helper('<module>')->__('Add Item');

}

}

}

/app/code/local/<Namespace>/<Module>/Block/Adminhtml/<Module>/Grid.php

<?php

class <Namespace>_<Module>_Block_Adminhtml_<Module>_Grid extends Mage_Adminhtml_Block_Widget_Grid

{

public function __construct()

{

parent::__construct();

$this->setId('<module>Grid');

// This is the primary key of the database

$this->setDefaultSort('<module>_id');

$this->setDefaultDir('ASC');

$this->setSaveParametersInSession(true);

}

protected function _prepareCollection()

{

$collection = Mage::getModel('<module>/<module>')->getCollection();

$this->setCollection($collection);

return parent::_prepareCollection();

}

protected function _prepareColumns()

{

$this->addColumn('<module>_id', array(

'header' => Mage::helper('<module>')->__('ID'),

'align' =>'right',

'width' => '50px',

'index' => '<module>_id',

));

$this->addColumn('title', array(

'header' => Mage::helper('<module>')->__('Title'),

'align' =>'left',

'index' => 'title',

));

/*

$this->addColumn('content', array(

'header'    => Mage::helper('<module>')->__('Item Content'),

'width'     => '150px',

'index'     => 'content',

));

*/

$this->addColumn('created_time', array(

'header' => Mage::helper('<module>')->__('Creation Time'),

'align' => 'left',

'width' => '120px',

'type' => 'date',

'default' => '--',

'index' => 'created_time',

));

$this->addColumn('update_time', array(

'header' => Mage::helper('<module>')->__('Update Time'),

'align' => 'left',

'width' => '120px',

'type' => 'date',

'default' => '--',

'index' => 'update_time',

));

$this->addColumn('status', array(

'header' => Mage::helper('<module>')->__('Status'),

'align' => 'left',

'width' => '80px',

'index' => 'status',

'type' => 'options',

'options' => array(

1 => 'Active',

0 => 'Inactive',

),

));

return parent::_prepareColumns();

}

public function getRowUrl($row)

{

return $this->getUrl('*/*/edit', array('id' => $row->getId()));

}

}

/app/code/local/<Namespace>/<Module>/Block/Adminhtml/<Module>/Edit/Form.php

<?php

class <Namespace>_<Module>_Block_Adminhtml_<Module>_Edit_Form extends Mage_Adminhtml_Block_Widget_Form

{

protected function _prepareForm()

{

$form = new Varien_Data_Form(array(

'id' => 'edit_form',

'action' => $this->getUrl('*/*/save', array('id' => $this->getRequest()->getParam('id'))),

'method' => 'post',

)

);

$form->setUseContainer(true);

$this->setForm($form);

return parent::_prepareForm();

}

}

/app/code/local/<Namespace>/<Module>/Block/Adminhtml/<Module>/Edit/Tabs.php

<?php

class <Namespace>_<Module>_Block_Adminhtml_<Module>_Edit_Tabs extends Mage_Adminhtml_Block_Widget_Tabs

{

public function __construct()

{

parent::__construct();

$this->setId('<module>_tabs');

$this->setDestElementId('edit_form');

$this->setTitle(Mage::helper('<module>')->__('News Information'));

}

protected function _beforeToHtml()

{

$this->addTab('form_section', array(

'label' => Mage::helper('<module>')->__('Item Information'),

'title' => Mage::helper('<module>')->__('Item Information'),

'content' => $this->getLayout()->createBlock('<module>/adminhtml_<module>_edit_tab_form')->toHtml(),

));

return parent::_beforeToHtml();

}

}

/app/code/local/<Namespace>/<Module>/Block/Adminhtml/<Module>/Edit/Tab/Form.php

<?php

class <Namespace>_<Module>_Block_Adminhtml_<Module>_Edit_Tab_Form extends Mage_Adminhtml_Block_Widget_Form

{

protected function _prepareForm()

{

$form = new Varien_Data_Form();

$this->setForm($form);

$fieldset = $form->addFieldset('<module>_form', array('legend'=>Mage::helper('<module>')->__('Item information')));

$fieldset->addField('title', 'text', array(

'label' => Mage::helper('<module>')->__('Title'),

'class' => 'required-entry',

'required' => true,

'name' => 'title',

));

$fieldset->addField('status', 'select', array(

'label' => Mage::helper('<module>')->__('Status'),

'name' => 'status',

'values' => array(

array(

'value' => 1,

'label' => Mage::helper('<module>')->__('Active'),

),

array(

'value' => 0,

'label' => Mage::helper('<module>')->__('Inactive'),

),

),

));

$fieldset->addField('content', 'editor', array(

'name' => 'content',

'label' => Mage::helper('<module>')->__('Content'),

'title' => Mage::helper('<module>')->__('Content'),

'style' => 'width:98%; height:400px;',

'wysiwyg' => false,

'required' => true,

));

if ( Mage::getSingleton('adminhtml/session')->get<Module>Data() )

{

$form->setValues(Mage::getSingleton('adminhtml/session')->get<Module>Data());

Mage::getSingleton('adminhtml/session')->set<Module>Data(null);

} elseif ( Mage::registry('<module>_data') ) {

$form->setValues(Mage::registry('<module>_data')->getData());

}

return parent::_prepareForm();

}

}

Part II : creating controllers

Comments

12 Comments on Magento how to create a Custom Plugin/ Module / example / tutorial

  1. uberVU - social comments on Fri, 25th Dec 2009 8:43 pm
  2. Social comments and analytics for this post…

    This post was mentioned on Twitter by opensourceprod: Magento how to create a Custom Plugin/ Module / example / tutorial: Module Creator

    Thanks to member Danieln f… http://bit.ly/4WOJxb

  3. super cialis on Tue, 13th Apr 2010 2:14 pm
  4. great info

  5. fisting on Mon, 3rd May 2010 1:48 pm
  6. Thanks great website

  7. Evia Banos on Wed, 5th May 2010 4:24 am
  8. Thanks for your wonderful post, it must have used precious time to build with good info.

  9. Blogs on Fri, 4th Jun 2010 11:07 am
  10. thanks !! very helpful post!

  11. Charles Burlage on Mon, 14th Jun 2010 7:22 am
  12. Much like normal you have offered some great specifics. Been a lurker on the site for a little bit and needed to give thanks to you for finding the time to post it.

  13. things to know to care the diamonid ring on Thu, 6th Jan 2011 6:49 am
  14. very very help full post

  15. Magento Flash Player on Thu, 17th Feb 2011 2:01 am
  16. Awesome tutorial on magento plugin! Thanks for the code reference……………

  17. one page checkout ecommerce on Wed, 21st Sep 2011 5:44 am
  18. i do like this post, a lot really useful things on magento plugin!!

  19. Magento Facebook App on Sat, 1st Oct 2011 9:19 am
  20. This is the good guide to start with.I was successful in creating the above tutorial. Hey Thanks.

  21. Pierre FAY on Wed, 16th Nov 2011 6:03 am
  22. This is helpfull 😉 you can learn to make your own plugin in this tutorial set too :

    http://www.about-magento.com

Tell me what you're thinking...
and oh, if you want a pic to show with your comment, go get a gravatar!





*
To prove you're a person (not a spam script), type the security word shown in the picture. Click on the picture to hear an audio file of the word.
Anti-spam image