Creating Custom Module for Magento 2

March 30, 2017 Md. Khasru Miah 1 Comment

Prerequisites

To start with a Magento 2 module development, we want to give emphasis on two things:

1. Disable Magento cache
Firstly, to avoid manually flush the cache every time you make changes to your code, you should disable Magento cache during development.
The process is as usual: Admin → System → Cache Management → select all cache types and disable them.

2. Put Magento into a developer mode
Secondly, developer mode needs to be on to make sure that you catch all the errors Magento throws during the development.
From Magento 2 root. and through terminal, you should run the following command to begin the developer mode on:


    php bin/magento deploy:mode:set developer

php bin/magento deploy:mode:set developer

Creating the module files and folders:

Download full module from our github

Module setup
In Magento 2 files are not distributed through the folders and have a modular structure. Here the modules are grouped by namespace and placed directly in the app/code folder. You can forget about code pools.
So our first step is to create the module folder and necessary files required to register a Magento module:

Create the following folders


    app/code/Scriptlodge
    app/code/Scriptlodge/Helloworld

app/code/Scriptlodge

app/code/Scriptlodge/Helloworld

Here, the Scriptlodge folder is the module’s namespace, and Helloworld is the module’s name.
Note: You will have to create it manually if you don’t have the code folder in your app directory.

Creating module.xml
Now in the module folder, we need to create a module.xml file in the app/code/Scriptlodge/Helloworld/etc folder with the following code:


    <?xml version="1.0"?>
    <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Module/etc/module.xsd">
        <module name="Scriptlodge_Helloworld" setup_version="1.0.0">
        </module>
    </config>

<?xml version="1.0"?>

</module>

</config>

Creating registration.php
With the following code you need create a registration.php file in the app/code/Scriptlodge/Helloworld folder to register the module:


    <?php
    \Magento\Framework\Component\ComponentRegistrar::register(
    \Magento\Framework\Component\ComponentRegistrar::MODULE, 'Scriptlodge_Helloworld', __DIR__
    );
    ?>

<?php

\Magento\Framework\Component\ComponentRegistrar::register(

\Magento\Framework\Component\ComponentRegistrar::MODULE, 'Scriptlodge_Helloworld', __DIR__

);

At this stage, you need to clear Magento cache from admin, or through terminal from Magento 2 root with the following command:


   php bin/magento setup:upgrade

php bin/magento setup:upgrade

Now the extension is supposed to start working. The presence of the module can be checked from Admin → Stores → Configuration → Advanced → Advanced
or you can open app/etc/config.php and check the array for the ‘Scriptlodge_Helloworld’ key, whose value should be set to 1:

Creating router:

Basically two routers are needed to create, one for frontend and other for beckend/admin part.
The following routes.xml file is created for frontName and id setting to define queries for the extension.

1. Frontend router

The app/code/Scriptlodge/Helloworld/etc/frontend folder contains the following code for front-end:


    <?xml version="1.0"?> 
        <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:App/etc/routes.xsd">
            <router id="standard">
                <route id="helloworld" frontName="helloworld">
                    <module name="Scriptlodge_Helloworld" />
                </route>
            </router>
        </config>

<?xml version="1.0"?>

</route>

</router>

</config>

Look the frontend router and route is defined with an id “helloworld”.

2. Backend/admin router
Similarly, the app/code/Scriptlodge/Helloworld/etc/adminhtml folder is used for backend:


<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../../../../lib/internal/Magento/Framework/App/etc/routes.xsd">
        <router id="admin">
            <route id="scriptlodge_helloworld" frontName="scriptlodge_helloworld">
                <module name="Scriptlodge_Helloworld" />
            </route>
        </router>
    </config>

</route>

</router>

</config>

Here the backend router and route is defined with an id “scriptlodge_helloworld”.

Creating a controller

The first part of the URL is generated from the frontName attribute.

Here you can see how the URLs are constructed in Magento 2:


 <frontName>/<controler_folder_name>/<controller_class_name>

So, the final URL will emerge in the following way:
helloworld/index/index

Now the Index.php controller file in the app/code/Scriptlodge/Helloworld/Controller/Index folder will have the following code:


namespace Scriptlodge\Helloworld\Controller\Index;
use Magento\Framework\App\Action\Context;
class Index extends \Magento\Framework\App\Action\Action {
   protected $_resultPageFactory;
    public function __construct(Context $context, \Magento\Framework\View\Result\PageFactory $resultPageFactory) {
        $this->_resultPageFactory = $resultPageFactory;
        parent::__construct($context);
    }

    public function execute() {
        $resultPage = $this->_resultPageFactory->create();       
        return $resultPage;
    }

}

namespace Scriptlodge\Helloworld\Controller\Index;

use Magento\Framework\App\Action\Context;

class Index extends \Magento\Framework\App\Action\Action {

protected $_resultPageFactory;

public function __construct(Context $context, \Magento\Framework\View\Result\PageFactory $resultPageFactory) {

$this->_resultPageFactory = $resultPageFactory;

parent::__construct($context);

}

public function execute() {

$resultPage = $this->_resultPageFactory->create();

return $resultPage;

}

Though in Magento 1 each controller can have multiple actions, in Magento 2 every action has its own class to implement the execute() method.

Creating a block:

To show something on the frontend, let’s create a block and a template for it.

Firstly, a Helloworld.php file in the app/code/Scriptlodge/Helloworld/Block folder with the following code will inherit from Magento class \Magento\Framework\View\Element\Template:


namespace Scriptlodge\Helloworld\Block;

class Helloworld extends \Magento\Framework\View\Element\Template {

    public function __construct(\Magento\Framework\View\Element\Template\Context $context, array $data = [] ) {
        parent::__construct($context, $data);    
    }

    public function getHelloText() {
        return 'Hello World!';
    }    

}

namespace Scriptlodge\Helloworld\Block;

class Helloworld extends \Magento\Framework\View\Element\Template {

public function __construct(\Magento\Framework\View\Element\Template\Context $context, array $data = [] ) {

parent::__construct($context, $data);

}

public function getHelloText() {

return 'Hello World!';

}

Creating a layout and template files:

Templates and layout files reside in view folder inside the module. So, we find three sub-folders under view:
a. adminhtml,
b. frontend,
c. base
And the above folders serve the following purposes respectively – adminhtml folder is used for admin, the frontend folder is used for frontend and the base folder is used for both, admin & frontend files.

Layout
First we will create a helloworld_index_index.xml file in the app/code/Scriptlodge/Helloworld/view/frontend/layout folder with the following code:


<page xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:View/Layout/etc/page_configuration.xsd" layout="1column">
    <head>
        <css src="Scriptlodge_HelloWorld/css/hello.css"/>
    </head>
    <body>
        <referenceContainer name="content">
            <block class="Scriptlodge\Helloworld\Block\Helloworld" name="helloworld" template="helloworld.phtml" />
        </referenceContainer>
    </body>
</page>

<head>

</head>

<body>

</referenceContainer>

</body>

</page>

A block has been added to the content container in the layout and set the template of our block to helloworld.phtml, and the styles file to use when showing on frontend. The template and styles file has the following address:

Template
A helloworld.phtml file in the app/code/Scriptlodge/Helloworld/view/frontend/templates folder will have the following code:


<h1><?php echo $this->getHelloText(); ?></h1>

<h1><?php echo $this->getHelloText(); ?></h1>

Styles, Js and Images
And a hello.css file in the Scriptlodge\HelloWorld\view\frontend\web\css\hello.css.
In the same way, the images and js folders will reside into web folder.

Create admin settings:

To create some settings for the new extension it will be needed to add adminhtml folder to Scriptlodge\HelloWorld\etc folder. It will contain configuration files for backend.

Here, a routes.xml is needed for frontName and id setting, which is used to define queries for the extension. It was created in our previous section (Creating router).

The xml markup is slightly different in Magento 2 but in the previous version, they’re located in the system.xml file.

Here comes the two most popular settings as an example: a text setting and a yes/no setting.
Looking at the config file contents you can know what it actually means:


    <?xml version="1.0"?>
    <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../../Magento/Config/etc/system_file.xsd">
        <system>
            <tab id="scriptlodge" translate="label" sortOrder="500">
                <label>Scriptlodge</label>
            </tab>

            <section id="scriptlodge_helloworld" translate="label" type="text" sortOrder="10" showInDefault="1" showInWebsite="1" showInStore="1">
                <label>HelloWorld</label>
                <tab>scriptlodge</tab>
                <resource>Scriptlodge_HelloWorld::scriptlodge_helloworld</resource>
                <group id="general" translate="label" type="text" sortOrder="10" showInDefault="1" showInWebsite="0" showInStore="0">
                    <label>Scriptlodge HelloWorld Settings</label>
                    <field id="enable" translate="label comment" type="select" sortOrder="10" showInDefault="1" showInWebsite="1" showInStore="1">
                        <label>Enable Hello World</label>
                        <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
                        <comment>
                            Comment for `Enable Hello World` setting.
                        </comment>
                    </field>
                    <field id="block_label" translate="label" type="text" sortOrder="20" showInDefault="1" showInWebsite="1" showInStore="1">
                        <label>Welcome Text</label>
                    </field>                
                </group>
            </section>
        </system>
    </config>

<?xml version="1.0"?>

<label>Scriptlodge</label>

</tab>

<label>HelloWorld</label>

<tab>scriptlodge</tab>

<resource>Scriptlodge_HelloWorld::scriptlodge_helloworld</resource>

<label>Scriptlodge HelloWorld Settings</label>

<label>Enable Hello World</label>

<source_model>Magento\Config\Model\Config\Source\Yesno</source_model>

Comment for `Enable Hello World` setting.

</comment>

</field>

<label>Welcome Text</label>

</field>

</group>

</section>

</system>

</config>

Add a new section to the settings block using . Set the unique ID and the name of the settings section inside. It is done because we have a very high possibility of using several apps from the same vendor on a single site.

Add the new


<section id="scriptlodge_helloworld">

again, with the unique ID, and set the necessary parameters, such as type, translation fields, order, label, the block for which the section is added, and so on. And then add the settings just inside the section. They will be divided into groups (one group in our case). The groups are defined by , and the fields are set by . We have already created three settings and pointed out types, labels, visibility, translation, comments and the data model.

Let’s check the result. Open your Magento 2 backend, go to Stores – Configuration, we can see the settings!

Creating Helper:

Now we create the helper in the following path:


Scriptlodge\HelloWorld\Helper\Data.php

Scriptlodge\HelloWorld\Helper\Data.php

And we add \Magento\Framework\App\Config\ScopeConfigInterface interface object initialization to the helper, it works to receive the data from configuration.
Now the file looks like this:


namespace Scriptlodge\HelloWorld\Helper;
class Data extends \Magento\Framework\App\Helper\AbstractHelper {
    protected $_scopeConfig;
    CONST ENABLE = 'scriptlodge_helloworld/general/enable';
    CONST BLOCK_LABEL = 'scriptlodge_helloworld/general/block_label';  
    /* *
     *  @var \Magento\Framework\App\Config\ScopeConfigInterfac 
     */

    public function __construct(\Magento\Framework\App\Helper\Context $context, \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig) {
        parent::__construct($context);
        $this->_scopeConfig = $scopeConfig;
    }

    public function getEnable() {
        return $this->_scopeConfig->getValue(self::ENABLE);
    }

    public function getBlockLabel() {
        return $this->_scopeConfig->getValue(self::BLOCK_LABEL);
    } 
}

namespace Scriptlodge\HelloWorld\Helper;

class Data extends \Magento\Framework\App\Helper\AbstractHelper {

protected $_scopeConfig;

CONST ENABLE = 'scriptlodge_helloworld/general/enable';

CONST BLOCK_LABEL = 'scriptlodge_helloworld/general/block_label';

/* *

* @var \Magento\Framework\App\Config\ScopeConfigInterfac

public function __construct(\Magento\Framework\App\Helper\Context $context, \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig) {

parent::__construct($context);

$this->_scopeConfig = $scopeConfig;

}

public function getEnable() {

return $this->_scopeConfig->getValue(self::ENABLE);

}

public function getBlockLabel() {

return $this->_scopeConfig->getValue(self::BLOCK_LABEL);

}

Let’s use these functions in the block and the template, so we need to change block function and template:

Block file:


namespace Scriptlodge\Helloworld\Block;
class Helloworld extends \Magento\Framework\View\Element\Template {
    protected $_helper;
    public function __construct(\Magento\Framework\View\Element\Template\Context $context, array $data = [], \Scriptlodge\HelloWorld\Helper\Data $helper) {
        parent::__construct($context, $data);
        $this->_helper = $helper;
        
    }

    public function getHelloText() {
        return 'Hello World!';
    }

    public function getBlockLabel() {
        return $this->_helper->getBlockLabel();
    }

    protected function _toHtml() {
        if ($this->_helper->getEnable()) {
            return parent::_toHtml();
        } else {
            return '';
        }
    }
}

namespace Scriptlodge\Helloworld\Block;

class Helloworld extends \Magento\Framework\View\Element\Template {

protected $_helper;

public function __construct(\Magento\Framework\View\Element\Template\Context $context, array $data = [], \Scriptlodge\HelloWorld\Helper\Data $helper) {

parent::__construct($context, $data);

$this->_helper = $helper;

}

public function getHelloText() {

return 'Hello World!';

}

public function getBlockLabel() {

return $this->_helper->getBlockLabel();

}

protected function _toHtml() {

if ($this->_helper->getEnable()) {

return parent::_toHtml();

} else {

return '';

}

Template file:


    <div class="helloworld-block" style="text-align: center;">
        <h1><?php echo $this->getBlockLabel() ?></h1>     
    </div>

<h1><?php echo $this->getBlockLabel() ?></h1>

</div>

Creating Model files:

Create installation script/Schema setup scripts
As in the 1.x versions of Magento, we need to create the installation file to use our own table.

In magento 2 schema setup scripts change database schema, they create or change needed database tables. If module is installing, Setup\InstallSchema::install() is executed.
The file should be created here: Scriptlodge\HelloWorld\Setup\InstallSchema.php


    namespace Scriptlodge\Helloworld\Setup;

    use Magento\Framework\Setup\InstallSchemaInterface;
    use Magento\Framework\Setup\SchemaSetupInterface;
    use Magento\Framework\Setup\ModuleContextInterface;

    class InstallSchema implements InstallSchemaInterface {

        public function install(SchemaSetupInterface $setup, ModuleContextInterface $context) {
            $installer = $setup;

            $installer->startSetup();
            $table = $installer->getConnection()
                    ->newTable($installer->getTable('scriptlodge_helloworld'))
                    ->addColumn(
                            'id', \Magento\Framework\DB\Ddl\Table::TYPE_INTEGER, null, ['identity' => true, 'unsigned' => true, 'nullable' => false, 'primary' => true], 'Id'
                    )
                    ->addColumn(
                            'name', \Magento\Framework\DB\Ddl\Table::TYPE_TEXT, null, ['default' => null, 'nullable' => false], 'Name'
                    )
                    ->addColumn(
                            'address', \Magento\Framework\DB\Ddl\Table::TYPE_TEXT, null, ['default' => null, 'nullable' => false], 'Address'
                    )
                    ->addColumn(
                            'city', \Magento\Framework\DB\Ddl\Table::TYPE_TEXT, null, ['default' => null, 'nullable' => false], 'City'
                    )
                    ->addColumn(
                    'country', \Magento\Framework\DB\Ddl\Table::TYPE_TEXT, null, ['default' => null, 'nullable' => false], 'Country'
            );
            $installer->getConnection()->createTable($table);
            $installer->endSetup();
        }

     }

namespace Scriptlodge\Helloworld\Setup;

use Magento\Framework\Setup\InstallSchemaInterface;

use Magento\Framework\Setup\SchemaSetupInterface;

use Magento\Framework\Setup\ModuleContextInterface;

class InstallSchema implements InstallSchemaInterface {

public function install(SchemaSetupInterface $setup, ModuleContextInterface $context) {

$installer = $setup;

$installer->startSetup();

$table = $installer->getConnection()

->newTable($installer->getTable('scriptlodge_helloworld'))

->addColumn(

'id', \Magento\Framework\DB\Ddl\Table::TYPE_INTEGER, null, ['identity' => true, 'unsigned' => true, 'nullable' => false, 'primary' => true], 'Id'

)

->addColumn(

'name', \Magento\Framework\DB\Ddl\Table::TYPE_TEXT, null, ['default' => null, 'nullable' => false], 'Name'

)

->addColumn(

'address', \Magento\Framework\DB\Ddl\Table::TYPE_TEXT, null, ['default' => null, 'nullable' => false], 'Address'

)

->addColumn(

'city', \Magento\Framework\DB\Ddl\Table::TYPE_TEXT, null, ['default' => null, 'nullable' => false], 'City'

)

->addColumn(

'country', \Magento\Framework\DB\Ddl\Table::TYPE_TEXT, null, ['default' => null, 'nullable' => false], 'Country'

);

$installer->getConnection()->createTable($table);

$installer->endSetup();

}

We can see that we are creating a “scriptlodge_helloworld” table with one field of integer type and four fields of text type.
Current module version is saved in setup_module table, which is equivalent of core_resource in Magento 1. Magento regulates what needs setup by comparing module versions with what it sees in that table.

Create Model

As in the Magento 1.x version, we need to create three classes to work with the model: the model itself, the resource model and the collection.

Let’s create a Scriptlodge\HelloWorld\Model\HelloWorld.php file and use the following initialization:


namespace Scriptlodge\HelloWorld\Model;
class HelloWorld extends \Magento\Framework\Model\AbstractModel
{
    /**
     * Constructor
     *
     * @return void
     */
    protected function _construct()
    {
        parent::_construct();
        $this->_init('Scriptlodge\HelloWorld\Model\ResourceModel\HelloWorld');
    }
}

namespace Scriptlodge\HelloWorld\Model;

class HelloWorld extends \Magento\Framework\Model\AbstractModel

{

/**

* Constructor

* @return void

protected function _construct()

{

parent::_construct();

$this->_init('Scriptlodge\HelloWorld\Model\ResourceModel\HelloWorld');

}

Create a Scriptlodge\HelloWorld\Model\ResourceModel\HelloWorld.php file and use the following initialization:


namespace Scriptlodge\HelloWorld\Model\ResourceModel;
class HelloWorld extends \Magento\Framework\Model\ResourceModel\Db\AbstractDb {
    /**
     * Model Initialization
     *
     * @return void
     */
    protected function _construct() {
        $this->_init('scriptlodge_helloworld', 'id');
    }
}

namespace Scriptlodge\HelloWorld\Model\ResourceModel;

class HelloWorld extends \Magento\Framework\Model\ResourceModel\Db\AbstractDb {

/**

* Model Initialization

* @return void

protected function _construct() {

$this->_init('scriptlodge_helloworld', 'id');

}

Create a Scriptlodge\HelloWorld\Model\ResourceModel\HelloWorld\Collection.php file and use the following initialization:


namespace Scriptlodge\HelloWorld\Model\ResourceModel\HelloWorld;

class Collection extends \Magento\Framework\Model\ResourceModel\Db\Collection\AbstractCollection
{
    /**
     * Define resource model
     *
     * @return void
     */
    protected function _construct()
    {
        $this->_init('Scriptlodge\HelloWorld\Model\HelloWorld', 'Scriptlodge\HelloWorld\Model\ResourceModel\HelloWorld');
    }
}

namespace Scriptlodge\HelloWorld\Model\ResourceModel\HelloWorld;

class Collection extends \Magento\Framework\Model\ResourceModel\Db\Collection\AbstractCollection

{

/**

* Define resource model

* @return void

protected function _construct()

{

$this->_init('Scriptlodge\HelloWorld\Model\HelloWorld', 'Scriptlodge\HelloWorld\Model\ResourceModel\HelloWorld');

}

We just set the constructor for the model here. In fact, there is no great difference from the Magento1.x versions on this step.

Now we are going to check if the created model actually works. Create a simple function in the block we’re working with:


     public function getCollection() {
        $model = $this->_objectManager->create('Scriptlodge\HelloWorld\Model\HelloWorld');
        $collection = $model->getCollection();
        return $collection;
    }

public function getCollection() {

$model = $this->_objectManager->create('Scriptlodge\HelloWorld\Model\HelloWorld');

$collection = $model->getCollection();

return $collection;

}

And also update Block __construct function,


    protected $_helper;
    protected $_objectManager;
    public function __construct(\Magento\Framework\View\Element\Template\Context $context, array $data = [], \Scriptlodge\HelloWorld\Helper\Data $helper, \Magento\Framework\ObjectManagerInterface $objectManager) {
        parent::__construct($context, $data);
        $this->_helper = $helper;
        $this->_objectManager = $objectManager;
    }

protected $_helper;

protected $_objectManager;

public function __construct(\Magento\Framework\View\Element\Template\Context $context, array $data = [], \Scriptlodge\HelloWorld\Helper\Data $helper, \Magento\Framework\ObjectManagerInterface $objectManager) {

parent::__construct($context, $data);

$this->_helper = $helper;

$this->_objectManager = $objectManager;

}

Finally use these functions in the block and change the template file:


    <div class="helloworld-block" style="text-align: center;">
<!--<h1><?php //echo $this->getHelloText();  ?></h1>--> 
    <h1><?php echo $this->getBlockLabel() ?></h1> 
    <?php if (count($this->getCollection()) > 0) { ?>
        <div class="customer-list">
            <h3 class="label">Example Customer List</h3>
            <ul>
                <?php foreach ($this->getCollection() as $item): ?>
                    <li>
                        <label><?php echo $item->getName() . ' --    ' . $item->getAddress() . ', ' . $item->getCity() . ', ' . $item->getCountry(); ?></label>
                    </li>
                <?php endforeach; ?>
            </ul>
        </div>
    <?php } ?>
</div>

<h1><?php echo $this->getBlockLabel() ?></h1>

<?php if (count($this->getCollection()) > 0) { ?>

<h3 class="label">Example Customer List</h3>

<ul>

<?php foreach ($this->getCollection() as $item): ?>

<li>

<label><?php echo $item->getName() . ' -- ' . $item->getAddress() . ', ' . $item->getCity() . ', ' . $item->getCountry(); ?></label>

</li>

<?php endforeach; ?>

</ul>

</div>

<?php } ?>

</div>

Finally deploy the module


    php bin/magento setup:static-content:deploy  en_US

php bin/magento setup:static-content:deploy en_US

1 Comment

Magento: Create or Update CMS Page & Static Block, Core Configuration, Product and Category information via Upgrade Scripts.

November 28, 2016 Md. Khasru Miah 2 Comments

Why are upgrade scripts helpful

Running the upgrade scripts will automatically update the database when deploying your site to staging and production servers by hitting the url. This can help you to avoid manual setup changes in admin panel when releasing sites to different servers. It also helps us to keep track of all the changes we trigger in admin panel.

To run upgrade script, you need to create a custom module. Download full module from our github

In your module you create a file data-install-0.1.0.php

Update System Configuration:


$installer = $this;
$installer->startSetup();  

$store = Mage::app()->getStore('default');      

$conf = new Mage_Core_Model_Config();
$address = 'Address Text Here';
$conf->saveConfig('general/store_information/address', $address, 'default', 0);

$installer->endSetup();

$installer = $this;

$installer->startSetup();

$store = Mage::app()->getStore('default');

$conf = new Mage_Core_Model_Config();

$address = 'Address Text Here';

$conf->saveConfig('general/store_information/address', $address, 'default', 0);

$installer->endSetup();

CMS Static Blocks create or upgrade:


$store = Mage::app()->getStore('default');         
$data = array(
    'title' => 'Header Banner',
    'identifier' => 'header-banner-id',
    'stores' => array(0), // Array with store ID's
    'content' => '<p>Some HTML content for banner</p>',
    'is_active' => 1
);

// Check if static block already exists, if yes then update content
$block = Mage::getModel('cms/block')->load($data['identifier']);
if ($block->isObjectNew()) {
    //Create static block
    Mage::getModel('cms/block')->setData($data)->save();
}else{
    //Update Content
    $block->setData('content', $data['content'])->save();
}

$store = Mage::app()->getStore('default');

$data = array(

'title' => 'Header Banner',

'identifier' => 'header-banner-id',

'stores' => array(0), // Array with store ID's

'content' => '<p>Some HTML content for banner</p>',

'is_active' => 1

);

// Check if static block already exists, if yes then update content

$block = Mage::getModel('cms/block')->load($data['identifier']);

if ($block->isObjectNew()) {

//Create static block

Mage::getModel('cms/block')->setData($data)->save();

}else{

//Update Content

$block->setData('content', $data['content'])->save();

}

CMS Page Create or Upgrade:


$store = Mage::app()->getStore('default');         
$page = Mage::getModel('cms/page');
$page->setStoreId($store->getId());
$page->load('home', 'identifier');

$content=<<<EOT
    <div>page content here</div>
EOT;

$cmsPage = Array(
    'title' => 'Home Title',
    'identifier' => 'home',
    'content' => $content,
    'is_active' => 1,
    'stores' => array($store->getId())
);
if ($page->getId()) {
    $page->setContent($cmsPage ['content']);
    $page->setTitle($cmsPage ['title']);
    $page->save();
} else {
    Mage::getModel('cms/page')->setData($cmsPage)->save();
}

$store = Mage::app()->getStore('default');

$page = Mage::getModel('cms/page');

$page->setStoreId($store->getId());

$page->load('home', 'identifier');

$content=<<<EOT

<div>page content here</div>

EOT;

$cmsPage = Array(

'title' => 'Home Title',

'identifier' => 'home',

'content' => $content,

'is_active' => 1,

'stores' => array($store->getId())

);

if ($page->getId()) {

$page->setContent($cmsPage ['content']);

$page->setTitle($cmsPage ['title']);

$page->save();

} else {

Mage::getModel('cms/page')->setData($cmsPage)->save();

}

Product Attributes Create or Upgrade:


$model =  new Mage_Catalog_Model_Resource_Setup();
$model->addAttribute(Mage_Catalog_Model_Product::ENTITY, 'my_custom_attribute_code', array(
    'group' => 'Prices',
    'type' => 'text',
    'attribute_set' =>  'Default', // Your custom Attribute set
    'backend' => '',
    'frontend' => '',
    'label' => 'My Custom Attribute',
    'input' => 'text',
    'global' => Mage_Catalog_Model_Resource_Eav_Attribute::SCOPE_GLOBAL,
    'visible' => true,
    'required' => false,
    'user_defined' => true,
    'default' => '1',
    'searchable' => false,
    'filterable' => true,
    'comparable' => false,
    'visible_on_front' => true,
    'visible_in_advanced_search' => true,
    'used_in_product_listing' => true,
    'unique' => false,
    'apply_to' => 'simple',  // Apply to simple product type
));

//Custom Attribute for dropdown
$model->addAttribute(Mage_Catalog_Model_Product::ENTITY, 'colors', array(
    'group' => 'General',
    'type' => 'text',
    'attribute_set' =>  'Default', // Your custom Attribute set
    'backend' => '',
    'frontend' => '',
    'label' => 'Colors',
    'input' => 'select',
    'global' => Mage_Catalog_Model_Resource_Eav_Attribute::SCOPE_GLOBAL,
    'visible' => true,
    'required' => false,
    'user_defined' => true,
    'default' => 0,
    'searchable' => false,
    'filterable' => true,
    'comparable' => true,
    'visible_on_front' => true,
    'visible_in_advanced_search' => true,
    'used_in_product_listing' => true,
    'unique' => false,
    'option' =>array (
        'values' =>
            array (
                0 => 'Red',
                1 => 'Black',
                2 => 'Green',
                3 => 'Grey',
                4 => 'White',
                5 => 'Yellow'
            )
    ),
));

//Enable wysiwyg  
$installer->addAttribute(Mage_Catalog_Model_Category::ENTITY, 'description2', array(
    'group' => 'General Information',
    'input' => 'textarea',
    'type' => 'text',
    'label' => 'Description2',
    'backend'       => '',
    'visible'       => true,    
    'required' => false,
    'wysiwyg_enabled' => true,
    'visible_on_front' => true,
    'is_html_allowed_on_front' => true,
    'default' => '',
    'global' => Mage_Catalog_Model_Resource_Eav_Attribute::SCOPE_STORE,
));

$installer->updateAttribute(Mage_Catalog_Model_Category::ENTITY, 'bottom_description', 'is_wysiwyg_enabled', 1);
$installer->updateAttribute(Mage_Catalog_Model_Category::ENTITY, 'bottom_description', 'is_html_allowed_on_front', 1);

$model = new Mage_Catalog_Model_Resource_Setup();

$model->addAttribute(Mage_Catalog_Model_Product::ENTITY, 'my_custom_attribute_code', array(

'group' => 'Prices',

'type' => 'text',

'attribute_set' => 'Default', // Your custom Attribute set

'backend' => '',

'frontend' => '',

'label' => 'My Custom Attribute',

'input' => 'text',

'global' => Mage_Catalog_Model_Resource_Eav_Attribute::SCOPE_GLOBAL,

'visible' => true,

'required' => false,

'user_defined' => true,

'default' => '1',

'searchable' => false,

'filterable' => true,

'comparable' => false,

'visible_on_front' => true,

'visible_in_advanced_search' => true,

'used_in_product_listing' => true,

'unique' => false,

'apply_to' => 'simple', // Apply to simple product type

));

//Custom Attribute for dropdown

$model->addAttribute(Mage_Catalog_Model_Product::ENTITY, 'colors', array(

'group' => 'General',

'type' => 'text',

'attribute_set' => 'Default', // Your custom Attribute set

'backend' => '',

'frontend' => '',

'label' => 'Colors',

'input' => 'select',

'global' => Mage_Catalog_Model_Resource_Eav_Attribute::SCOPE_GLOBAL,

'visible' => true,

'required' => false,

'user_defined' => true,

'default' => 0,

'searchable' => false,

'filterable' => true,

'comparable' => true,

'visible_on_front' => true,

'visible_in_advanced_search' => true,

'used_in_product_listing' => true,

'unique' => false,

'option' =>array (

'values' =>

array (

0 => 'Red',

1 => 'Black',

2 => 'Green',

3 => 'Grey',

4 => 'White',

5 => 'Yellow'

)

));

//Enable wysiwyg

$installer->addAttribute(Mage_Catalog_Model_Category::ENTITY, 'description2', array(

'group' => 'General Information',

'input' => 'textarea',

'type' => 'text',

'label' => 'Description2',

'backend' => '',

'visible' => true,

'required' => false,

'wysiwyg_enabled' => true,

'visible_on_front' => true,

'is_html_allowed_on_front' => true,

'default' => '',

'global' => Mage_Catalog_Model_Resource_Eav_Attribute::SCOPE_STORE,

));

$installer->updateAttribute(Mage_Catalog_Model_Category::ENTITY, 'bottom_description', 'is_wysiwyg_enabled', 1);

$installer->updateAttribute(Mage_Catalog_Model_Category::ENTITY, 'bottom_description', 'is_html_allowed_on_front', 1);

Category Upgrade:


Mage::app()->getStore()->setId(0);
$category = Mage::getModel('catalog/category')->load($category_id); // enter category id
$category->setDescription('Sample Category description'); // Update category description
$category->setIsAnchor(1); // set category "Is Anchor" yes
$category->save();

Mage::app()->getStore()->setId(0);

$category = Mage::getModel('catalog/category')->load($category_id); // enter category id

$category->setDescription('Sample Category description'); // Update category description

$category->setIsAnchor(1); // set category "Is Anchor" yes

$category->save();

Update All Category and Run Indexing:


$storeIds = Mage::getModel('core/store')->getCollection()->getAllIds();
$category = Mage::getModel('catalog/category');
$tree = $category->getTreeModel();
$tree->load();
$ids = $tree->getCollection()->getAllIds();
asort($ids);
$categories = array();
$storeId = 0;
$resource = Mage::getResourceModel('catalog/category');
if ($ids) {
    foreach ($ids as $id) {
        $cat = $category->load($id);
        if ($cat->getId() && $cat->getLevel() > 1) {
            $cat->setData('is_anchor', 1);
            //$cat->save();
            $resource->saveAttribute($cat, 'is_anchor');
            unset($cat);
        }
    }
}
$process = Mage::getSingleton('index/indexer')->getProcessByCode('catalog_category_flat');
$process->reindexEverything();

$storeIds = Mage::getModel('core/store')->getCollection()->getAllIds();

$category = Mage::getModel('catalog/category');

$tree = $category->getTreeModel();

$tree->load();

$ids = $tree->getCollection()->getAllIds();

asort($ids);

$categories = array();

$storeId = 0;

$resource = Mage::getResourceModel('catalog/category');

if ($ids) {

foreach ($ids as $id) {

$cat = $category->load($id);

if ($cat->getId() && $cat->getLevel() > 1) {

$cat->setData('is_anchor', 1);

//$cat->save();

$resource->saveAttribute($cat, 'is_anchor');

unset($cat);

}

$process = Mage::getSingleton('index/indexer')->getProcessByCode('catalog_category_flat');

$process->reindexEverything();

Product Upgrade:


Mage::app()->getStore()->setId(0);
$descriptions = <<<EOT
<p>Product description here</p>
EOT;

$product_id = 344;
$product = Mage::getModel('catalog/product')->load($product_id);
$product->setDescription($descriptions);
$product->save();

Mage::app()->getStore()->setId(0);

$descriptions = <<<EOT

<p>Product description here</p>

EOT;

$product_id = 344;

$product = Mage::getModel('catalog/product')->load($product_id);

$product->setDescription($descriptions);

$product->save();

Email Template Upgrade:


$template_code = "Email - Header";
$templateText = <<<EOT
Template Content here
EOT;

$emailTemplate = Mage::getModel('core/email_template');
$emailTemplate->loadByCode($template_code);
if ($emailTemplate->getTemplateId()) {
    $emailTemplate->setTemplateText($templateText);
    $emailTemplate->save();
}

$template_code = "Email - Header";

$templateText = <<<EOT

Template Content here

EOT;

$emailTemplate = Mage::getModel('core/email_template');

$emailTemplate->loadByCode($template_code);

if ($emailTemplate->getTemplateId()) {

$emailTemplate->setTemplateText($templateText);

$emailTemplate->save();

}

Drop table:


$command = "DROP TABLE IF EXISTS `custome_table`;";
$installer->run($command);

$command = "DROP TABLE IF EXISTS `custome_table`;";

$installer->run($command);

Leave a comment

Magento: Wrong count in admin Grid when using GROUP BY clause

November 23, 2016 Md. Khasru Miah 1 Comment

In Magento 1.x when you use GROUP BY clause in any Grid.php file in admin, the count always display wrong. Many times it displays 1 even if there are many records. Due to this your pagination also doesn’t work. This is a bug in Magento. Your getSize() always returns wrong count whereas total records in grid are proper.

To fix this, you need to edit one of your core file. As it’s not a good practice to edit core file, we will here override the core file. Overriding LIB module.

Copy Db.php file from magento / lib / Varien / Data / Collection / Db.php

Paste it to your local directory so the resultant folder structure would look like this:

magento / app / code / local / Varien / Data / Collection / Db.php

Now open this file to edit and replace getSelectCountSql function with below one


    public function getSelectCountSql()
    {   
        $this->_renderFilters();
        $countSelect = clone $this->getSelect();
        $countSelect->reset(Zend_Db_Select::ORDER);
        $countSelect->reset(Zend_Db_Select::LIMIT_COUNT);
        $countSelect->reset(Zend_Db_Select::LIMIT_OFFSET);
        $countSelect->reset(Zend_Db_Select::COLUMNS);

        // Count doesn't work with group by columns keep the group by 
        if(count($this->getSelect()->getPart(Zend_Db_Select::GROUP)) > 0) {
            $countSelect->reset(Zend_Db_Select::GROUP);
            $countSelect->distinct(true);
            $group = $this->getSelect()->getPart(Zend_Db_Select::GROUP);
            $countSelect->columns("COUNT(DISTINCT ".implode(", ", $group).")");
        } else {
            $countSelect->columns('COUNT(*)');
        }
        return $countSelect;
    }

public function getSelectCountSql()

{

$this->_renderFilters();

$countSelect = clone $this->getSelect();

$countSelect->reset(Zend_Db_Select::ORDER);

$countSelect->reset(Zend_Db_Select::LIMIT_COUNT);

$countSelect->reset(Zend_Db_Select::LIMIT_OFFSET);

$countSelect->reset(Zend_Db_Select::COLUMNS);

// Count doesn't work with group by columns keep the group by

if(count($this->getSelect()->getPart(Zend_Db_Select::GROUP)) > 0) {

$countSelect->reset(Zend_Db_Select::GROUP);

$countSelect->distinct(true);

$group = $this->getSelect()->getPart(Zend_Db_Select::GROUP);

$countSelect->columns("COUNT(DISTINCT ".implode(", ", $group).")");

} else {

$countSelect->columns('COUNT(*)');

}

return $countSelect;

}

1 Comment

Difference between getsingleton() , getmodel() and getResourceModel() In Magento.

December 8, 2015 Md. Khasru Miah 3 Comments

Mage::getSingleton()

Mage::getSingleton() will first check if the same class instance exists or not in the memory. If the instance exists then it will return the same object from the memory otherwise it load the model, save into Mage Register and return it. So Mage::getSingleton() is faster than Mage::getModel().

Example:


$product1 = Mage::getSingleton('catalog/product');
$product2 = Mage::getSingleton('catalog/product');

$product1 = Mage::getSingleton('catalog/product');

$product2 = Mage::getSingleton('catalog/product');

$product1 and $product2 both will share same memory of OS and return only one instance each time.

Now take a look at the getSingleton Method in Mage.php :


public static function getSingleton($modelClass='', array $arguments=array())
    {
        $registryKey = '_singleton/'.$modelClass;
        if (!self::registry($registryKey)) {
            self::register($registryKey, self::getModel($modelClass, $arguments));
        }
        return self::registry($registryKey);
    }

public static function getSingleton($modelClass='', array $arguments=array())

{

$registryKey = '_singleton/'.$modelClass;

if (!self::registry($registryKey)) {

self::register($registryKey, self::getModel($modelClass, $arguments));

}

return self::registry($registryKey);

}

Mage::getModel()

Mage::getModel() will create a new instance of an object each time even such object exists in configuration.

Example


$product1 = Mage::getModel('catalog/product');
$product2 = Mage::getModel('catalog/product');

$product1 = Mage::getModel('catalog/product');

$product2 = Mage::getModel('catalog/product');

$product1 and $product2 both have different instant of same object and also occupy different memory.

Now take a look at the getModel Method in Mage.php:


public static function getModel($modelClass = '', $arguments = array())
    {
        return self::getConfig()->getModelInstance($modelClass, $arguments);
    }

public static function getModel($modelClass = '', $arguments = array())

{

return self::getConfig()->getModelInstance($modelClass, $arguments);

}

Mage::getResourceModel()

All collections in Magento are resource models. They are instantiated by Mage::getResourceModel() or Mage::getModel()->getCollection(). It doesn’t really matter which function you use; the latter one simply calls the first one. The Magento team simply chose to make collections part of the resource, probably because collections need to query the database a lot. Usually, you will not have to call Mage::getResourceModel() for anything else than collections.

Leave a comment

jQuery validationEngine Not Work with Bootstrap Select plugin

June 29, 2014 Md. Khasru Miah Leave a comment

When bootstrap-select creates a cloned element, it uses an addClass call that copies the validate[.*] class into the new div element, and validationEngine tries to validate that.

I got a solution without modifying the core js file. For this we need to use validationEngine
“prettySelect”,”usePrefix” options, and we need to add “id” to cloned element and also need to removed the “validate[required]” class from this element. The full code look likes this.


var prefix = "selectBox_";
jQuery(document).ready(function() {     
    // for remove bootstrap-select validation and adding id to the element with prefix
    $('select').each(function() {
        $(this).next('div.bootstrap-select').attr("id", prefix + this.id).removeClass("validate[required]");
    });
  
    jQuery("#registration").validationEngine('attach',{
            promptPosition: "bottomLeft",
            autoHidePrompt:true,            
            prettySelect : true,
            usePrefix: prefix         
        });
});

var prefix = "selectBox_";

jQuery(document).ready(function() {

// for remove bootstrap-select validation and adding id to the element with prefix

$('select').each(function() {

$(this).next('div.bootstrap-select').attr("id", prefix + this.id).removeClass("validate[required]");

});

jQuery("#registration").validationEngine('attach',{

promptPosition: "bottomLeft",

autoHidePrompt:true,

prettySelect : true,

usePrefix: prefix

});

It works for me. DEMO HERE : http://www.scriptlodge.com/code_demos/validationEngine/

Leave a comment

How To Reset Admin Password in Magento ?

June 4, 2014 Md. Khasru Miah 3 Comments

In this blog, I am showing how you can reset magento admin password if you lost it and cannot recover using Forgot Password option. I assume that you have the server access of magento i.e Database and FTP access.

For this you have to create a file named reseradminpass.php and paste the bellow code into this file and upload it in your magento root directory.


<?php
require_once 'app/Mage.php';
umask(0);
/* not Mage::run(); */
Mage::app('default');

## For magento1.7 or Earlier var
//$_HASH_SALT_LENGTH = 2;
## For magento1.8 and magento1.9
$_HASH_SALT_LENGTH = 32;

#Generate admin password 
$password = "admin1234";
echo $adminPass = Mage::helper('core')->getHash($password, $_HASH_SALT_LENGTH);
## And reset password field in "admin_user" table
 
?>

<?php

require_once 'app/Mage.php';

umask(0);

/* not Mage::run(); */

Mage::app('default');

## For magento1.7 or Earlier var

//$_HASH_SALT_LENGTH = 2;

## For magento1.8 and magento1.9

$_HASH_SALT_LENGTH = 32;

#Generate admin password

$password = "admin1234";

echo $adminPass = Mage::helper('core')->getHash($password, $_HASH_SALT_LENGTH);

## And reset password field in "admin_user" table

Here the variable $_HASH_SALT_LENGTH is for salting the password (set 32 for magento1.8 and magento1.9 and set 2 if your magento var is 1.7 or earlier).
Now browse the file as www.yourwebsite.com/reseradminpass.php. Hence, you can see the new password. So, copy it and replace the password field in “admin_user” table.

And that’s it, now you are able to login from admin using by this given password.

Leave a comment

How do I add a static or dynamic block in Magento?

May 29, 2014 Md. Khasru Miah 6 Comments

Magento provides an easy way to add blocks with using Layout-XML file and also call directly from the phtml file and added to any category page with no programming at all.

Adding Magento Static block:

from XML:


<block type="cms/block" name="your_block_name" before="-">
      <action method="setBlockId"><block_id>your_block_id</block_id></action>
</block>

<action method="setBlockId"><block_id>your_block_id</block_id></action>

</block>

From phtml/php :


$this->getLayout()->createBlock('cms/block')->setBlockId('my_static_block_id')->toHtml() ;

$this->getLayout()->createBlock('cms/block')->setBlockId('my_static_block_id')->toHtml() ;

From the CMS page content/Shortcode way:


{{block type="cms/block" block_id="your_block_id"}}

Adding Magento dynamic block:

From XML:


<reference name="content">
   <block type="catalog/product_list" name="mobileproduct" template="catalog/product/list.phtml">
    <action method="setCategoryId"><category_id>2</category_id></action>
</block>
</reference>

</block>

</reference>

From the CMS page content/shortcode way:


{{block type="catalog/product_list" category_id="2"  template="catalog/product/list.phtml"}}

{{block type="catalog/product_list" category_id="2" template="catalog/product/list.phtml"}}

From phtml/php:


<?php

echo $this->getLayout()->createBlock('catalog/product_list')->setTemplate('catalog/product/home-list.phtml')->setCategoryId('2')->toHtml();
?>

<?php

echo $this->getLayout()->createBlock('catalog/product_list')->setTemplate('catalog/product/home-list.phtml')->setCategoryId('2')->toHtml();

or if the block is already existing in the layout you can get it by name:


<?php
echo $this->getLayout()->getBlock('blockname')->setTemplate('catalog/product/home-list.phtml')->setCategoryId('2')->toHtml();
?>

<?php

echo $this->getLayout()->getBlock('blockname')->setTemplate('catalog/product/home-list.phtml')->setCategoryId('2')->toHtml();

Note that all functions available to you within the layout XML via are also available to call on any block in our code. For example, if we instantiated a new block to be added / appended to the head, we could execute something similar to this:


<?php
$block = $this->getLayout()->createBlock('yourmodule/block', 'blockname',array('template' => 'demac/doubleclick/example.phtml') );

$this->getLayout()->getBlock('head')->append($block);
?>

<?php

$block = $this->getLayout()->createBlock('yourmodule/block', 'blockname',array('template' => 'demac/doubleclick/example.phtml') );

$this->getLayout()->getBlock('head')->append($block);

Call Magento Block method/function:

There are two syntax to call block method/function as below.


<?php
$_blockData = $this->getLayout()->getBlockSingleton('yourmodule/blockname')->getFunctionName();
?>

<?php

$_blockData = $this->getLayout()->getBlockSingleton('yourmodule/blockname')->getFunctionName();


<?php
$_blockData = $this->getLayout()->createBlock('yourmodule/blockname')->getFunctionName();
?>

<?php

$_blockData = $this->getLayout()->createBlock('yourmodule/blockname')->getFunctionName();

Example :


<?php
$_blockData = $this-&gt;getLayout()-&gt;getBlockSingleton('catalog/navigation')-&gt;renderCategoriesMenuHtml(0,'level-top');
?>

<?php

$_blockData = $this->getLayout()->getBlockSingleton('catalog/navigation')->renderCategoriesMenuHtml(0,'level-top');

It shows the category menu.
or,


<?php
$_blockData = $this->getLayout()->getBlockSingleton('catalog/navigation')->getCurrentChildCategories();
?>

<?php

$_blockData = $this->getLayout()->getBlockSingleton('catalog/navigation')->getCurrentChildCategories();

Adding Magento Content Blocks:
Add Handle in your local.xml/custommodule.xml so it looks like the following


<helloworld_index_index>
    <block type="page/html" name="root" output="toHtml" template="helloworld/simple_page.phtml">
        <block type="customer/form_register" name="customer_form_register" template="customer/form/register.phtml"/>
    </block>
</helloworld_index_index>

<helloworld_index_index>

</block>

</helloworld_index_index>

We’re adding a new Block nested within our root. This is a Block that’s distributed with Magento, and will display a customer registration form. By nesting this Block within our root Block, we’ve made it available to be pulled into our simple_page.html Template. Next, we’ll use the Block’s getChildHtml method in our simple_page.phtml file.
Edit simple_page.html so it looks like this


<?php 
echo $this->getChildHtml('customer_form_register'); 
?>

<?php

echo $this->getChildHtml('customer_form_register');

Clear your Magento cache and reload the page and you should see the customer registration form.

Leave a comment

Creating Custom Module in Magento

May 28, 2014 Md. Khasru Miah 2 Comments

The first step is creating custom module in Magento 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.
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:

Where to put our module?

All Magento modules are located in /app/code/ folder and are split into three groups, called code pools: core, community, local.


/app/code
   - /core/
   - /community/
   - /local/

/app/code

- /core/

- /community/

- /local/

core – All original Magento modules are placed here. They provide base functionality of system and prototypes of blocks, models, helpers, controllers for further extending. The standard modules are: Mage_Core, Mage_Adminhtml, Mage_Catalog, Mage_Customer, Mage_Sales, Mage_Payment, Mage_Shipping etc. As you have probably noticed, all of them have prefix “Mage_”, we will talk about this a bit later. Unless you are sure about what you are doing (and even afterwards) never edit the code in the core modules.

community – As you can see from the name, this group dedicated for modules that are provided by 3rd party developers (i.e. not by Magento team). When you install this modules throught built-in installer (Magento Connect Manager) all of them will be put into the folder /app/code/community/.

local – This folder is created empty on a Magento installation. Or it can be absent in last versions 1.7.x of CMS, in this case you’ll have to create it manually. Folder /app/code/local/ is used for your custom modules. All development, generally, is performed here.
Except logical splitting modules into groups, this architecture allows us to override any module or separate class in “local” folder without editing original files, which is important for further update of Magento. If we look to the file /app/Mage.php, we’ll see this code:


$paths = array();
$paths[] = BP . DS . 'app' . DS . 'code' . DS . 'local';
$paths[] = BP . DS . 'app' . DS . 'code' . DS . 'community';
$paths[] = BP . DS . 'app' . DS . 'code' . DS . 'core';
$paths[] = BP . DS . 'lib';
$appPath = implode(PS, $paths);
set_include_path($appPath . PS . Mage::registry('original_include_path'));

$paths = array();

$paths[] = BP . DS . 'app' . DS . 'code' . DS . 'local';

$paths[] = BP . DS . 'app' . DS . 'code' . DS . 'community';

$paths[] = BP . DS . 'app' . DS . 'code' . DS . 'core';

$paths[] = BP . DS . 'lib';

$appPath = implode(PS, $paths);

set_include_path($appPath . PS . Mage::registry('original_include_path'));

So, if we have two files with the same name but in different code pools (for example, /core/Mage/Core/Model/Config.php and /local/Mage/Core/Model/Config.php), then file from local pool will be loaded.

Declare Your Magento Custom Module

Create app/etc/modules/Namespace_Module.xml and write below code.


<?xml version = "1.0" ?>
<config>
    <modules>
	<!-- declare CompanyName_NewModule module -->
	<Sl_Photogallery>
            <!-- this is an active module -->
            <active>true</active>
            <!-- this module will be located in app/code/local code pool. code pools are core/community/local -->
            <codePool>local</codePool>
            <!-- specify dependencies for correct module loading order -->
            <depends>
                <Mage_Core />
            </depends>
        </Sl_Photogallery>
    </modules>
</config>

<?xml version = "1.0" ?>

<Sl_Photogallery>

<codePool>local</codePool>

<Mage_Core />

</depends>

</Sl_Photogallery>

</modules>

</config>

Module Configuration:

Before that, we’ll need to setup a directory structure for the module. You won’t need all these directories, but there’s no harm in setting them all up now.

app/code/local/ CompanyName / ModuleName
app/code/local/ CompanyName / ModuleName/etc
app/code/local/ CompanyName / ModuleName/Block
app/code/local/ CompanyName / ModuleName/controllers
app/code/local/ CompanyName / ModuleName/Model
app/code/local/ CompanyName / ModuleName/Helper
app/code/local/ CompanyName / ModuleName/sql

Next, we will begin to configure our module. The configuration files belong inside our module in a directory named etc, so let’s create that along with a new XML file: app/code/local/ CompanyName /ModuleName /etc/config.xml. This XML file will inform Magento of the location of the files in our module, as well as many other things, such as version number and events to observe. For now, we will create a simple config.xml file, which contains comments that explain the meaning of each section.


<?xml version = "1.0"?>
<config>
    <modules>
        <Sl_Photogallery>
            <version>0.0.1</version>
        </Sl_Photogallery>
    </modules>

    <!-- Configure our module's behavior in the global scope -->
    <global>
        <blocks>
            <photogallery>
                <class>Sl_Photogallery_Block</class>
            </photogallery>
        </blocks>
        <helpers>
            <photogallery>
                <class>Sl_Photogallery_Helper</class>
            </photogallery>
        </helpers>
        <models>
            <photogallery>
                <class>Sl_Photogallery_Model</class>
                <resourceModel>photogallery_resource</resourceModel>
            </photogallery>
        </models>
    </global>
    
    <!-- This node contains parameters, available on frontend -->
    <frontend>
        <routers>
            <!-- This node"s name should be the same as our alias -->
            <photogallery>
                <use>standard</use>
                <!-- router arguments block -->
                <args>
              <!-- This parameter specifies the full name of out module -->
                    <module>Sl_Photogallery</module>
                    <!-- This parameter sets module alias -->
                    <frontName>photogallery</frontName>
                </args>
            </photogallery>
        </routers>
        <!-- This node contains module layout configuration -->
        <layout>
            <updates>
                <sl_photogallery>
                    <!-- Module xml File -->
                    <file>sl_photogallery.xml</file>
                </photogallery>
            </updates>
        </layout>
    </frontend>

    <default>
        <photogallery>
            <photogallery>
                <breadcrumbs>1</breadcrumbs>
            </photogallery>
        </photogallery>
    </default>
</config>

<?xml version = "1.0"?>

<Sl_Photogallery>

</Sl_Photogallery>

</modules>

<class>Sl_Photogallery_Block</class>

</photogallery>

</blocks>

<class>Sl_Photogallery_Helper</class>

</photogallery>

</helpers>

<class>Sl_Photogallery_Model</class>

<resourceModel>photogallery_resource</resourceModel>

</photogallery>

</models>

</global>

<use>standard</use>

<args>

<module>Sl_Photogallery</module>

<frontName>photogallery</frontName>

</args>

</photogallery>

</routers>

<sl_photogallery>

<file>sl_photogallery.xml</file>

</photogallery>

</updates>

</layout>

</frontend>

</photogallery>

</default>

</config>

Create Module Controller:

Now we will create controller app/code/local/Sl/Photogallery/controllers/IndexController.php


<?php

class Sl_Photogallery_IndexController extends Mage_Core_Controller_Front_Action {
        
    public function indexAction() {
        ## Initialization of Mage_Core_Model_Layout model  
        $this->loadLayout();
        ## Adding breadcrumbs
        if (Mage::helper('photogallery/photogallery')->getUseBreadcrumbs()) {
            if ($breadcrumbBlock = $this->getLayout()->getBlock('breadcrumbs')) {
                $breadcrumbBlock->addCrumb('home', array(
                    'label' => Mage::helper('photogallery')->__('Home'),
                    'link' => Mage::getUrl(),
                        )
                );
                $breadcrumbBlock->addCrumb('photogallerys', array(
                    'label' => Mage::helper('photogallery')->__('Photogallerys'),
                    'link' => '',
                        )
                );
            }
        }
         ## Building page according to layout confuration  
        $this->renderLayout();
    }

}
?>

<?php

class Sl_Photogallery_IndexController extends Mage_Core_Controller_Front_Action {

public function indexAction() {

## Initialization of Mage_Core_Model_Layout model

$this->loadLayout();

## Adding breadcrumbs

if (Mage::helper('photogallery/photogallery')->getUseBreadcrumbs()) {

if ($breadcrumbBlock = $this->getLayout()->getBlock('breadcrumbs')) {

$breadcrumbBlock->addCrumb('home', array(

'label' => Mage::helper('photogallery')->__('Home'),

'link' => Mage::getUrl(),

)

);

$breadcrumbBlock->addCrumb('photogallerys', array(

'label' => Mage::helper('photogallery')->__('Photogallerys'),

'link' => '',

)

);

}

## Building page according to layout confuration

$this->renderLayout();

}

IndexController is called by default if we don’t call any other controller, as well as indexAction will be called by default if we don’t call any other action. As we can see, indexAction call only two methods ($this->loadLayout(),$this->renderLayout()) , that initialize and render website page.

Create Module Block:

Now we Create a Block class – app/code/local/Sl/Photogallery/Block/Photogallery.php


<?php

## Block class has to be inherited from Mage_Core_Block_Template 

class Sl_Photogallery_Block_Photogallery extends Mage_Core_Block_Template{
    ##necessary methods
    public function getWelcome()
     {
         return "Welcome to our magento Photogallery!" ;
     }
}
?>

<?php

## Block class has to be inherited from Mage_Core_Block_Template

class Sl_Photogallery_Block_Photogallery extends Mage_Core_Block_Template{

##necessary methods

public function getWelcome()

{

return "Welcome to our magento Photogallery!" ;

}

Frontend Layout configuration:

All templates and layout files are located in /app/design folder. Magento uses two design areas: “frontend” for public section and “adminhtml£ for backend.


/app/design
  -- /adminhtml
  -- /frontend

/app/design

-- /adminhtml

-- /frontend

Also there can be “install” area, which is used for installation pages. Themes are split into packages. By default there are two theme packages (base and default) in /app/design/frontend. If theme is not set in Magento configuration, default/default theme will be used by default. We are going to work with this theme.
Usually Magento theme consists of two main folders: “layout”, where layout configuration files are stored, and “template”, where all “.phtml” files are located. At first we need to create layout file /app/design/frontend/default/default/layout/photogallery.xml


<?xml version="1.0"?>
<layout>
    <photogallery_index_index translate="label" module="photogallery">
        <label>Photogallerys list</label>
        <reference name="root">
            <action method="setTemplate"><template>page/1column.phtml</template></action>
        </reference>		
        <reference name="content">
            <block type="photogallery/photogallery" name="photogallery" template="photogallery/photogallery/list.phtml" />
        </reference>
    </photogallery_index_index>	
</layout>

<?xml version="1.0"?>

<photogallery_index_index translate="label" module="photogallery">

<label>Photogallerys list</label>

<action method="setTemplate"><template>page/1column.phtml</template></action>

</reference>

</reference>

</photogallery_index_index>

</layout>

Creating Model:

These are the initial steps that you need to follow when creating a model:

Create Model constructor class
Create Resource Model class
Create Model Collection class
Create Database table for model

To start with, within your node we need to declare the module version so that later we can create install/upgrade scripts.


<modules>
      <Sl_Photogallery>
          <version>0.0.1</version>
       </Sl_Photogallery>
</modules>

<Sl_Photogallery>

</Sl_Photogallery>

</modules>

Next we declare our model name within the node, which in this case be ‘Photogallery. Inside this we put our model class name which is simply the directory path to your model folder. We also specify our resource model name. After this we use our newly defined resource model name inside a self-titled node where we declare its class (again the file path), and database table name (which we’ll look at later).


<models>
    <photogallery>
        <class>Sl_Photogallery_Model</class>
        <resourceModel>photogallery_resource</resourceModel>
    </photogallery>
</models>

<class>Sl_Photogallery_Model</class>

<resourceModel>photogallery_resource</resourceModel>

</photogallery>

</models>

The final bit of configuration we need to do is again in our node. When working with models, everything is pretty much scoped globally. We just need to make Magento aware if our install/upgrade scripts.


<resources>
        <sl_photogallery_setup>
            <!-- specify that this resource is a setup resource and used for upgrades -->
            <setup>
                <!-- which module to look for install/upgrade files in -->
                <module>Sl_Photogallery</module>
                <class>Sl_Photogallery_Model_Resource_Setup</class>
            </setup>
        </sl_photogallery_setup>
    </resources>
    <models>
        <photogallery>
            <class>Sl_Photogallery_Model</class>
            <resourceModel>photogallery_resource</resourceModel>
        </photogallery>
        <photogallery_resource>
            <class>Sl_Photogallery_Model_Resource</class>
            <entities>
                <photogallery>
                    <table>photogallery</table>
                </photogallery>
                <photogallery_store>
                    <table>photogallery_store</table>
                </photogallery_store>                
            </entities>
        </photogallery_resource>
    </models>

<sl_photogallery_setup>

<setup>

<module>Sl_Photogallery</module>

<class>Sl_Photogallery_Model_Resource_Setup</class>

</setup>

</sl_photogallery_setup>

</resources>

<class>Sl_Photogallery_Model</class>

<resourceModel>photogallery_resource</resourceModel>

</photogallery>

<photogallery_resource>

<class>Sl_Photogallery_Model_Resource</class>

<table>photogallery</table>

</photogallery>

<photogallery_store>

<table>photogallery_store</table>

</photogallery_store>

</entities>

</photogallery_resource>

</models>

Creating Model/Photogallery.php class

This model initialisation class is as simple as it looks. From this point onwards we have a model type called ‘photogallery/photogallery’. Always extends the – Mage_Core_Model_Abstract class.


<?php

class Sl_Photogallery_Model_Photogallery extends Mage_Core_Model_Abstract {

    public function _construct() {
        parent::_construct();
        $this->_init('photogallery/photogallery');
    }

}
?>

<?php

class Sl_Photogallery_Model_Photogallery extends Mage_Core_Model_Abstract {

public function _construct() {

parent::_construct();

$this->_init('photogallery/photogallery');

}

Creating Model/Resource/Photogallery.php class

We have now initialised our resource model, allowing our model to interact with the database. We simply pass in the model name and the database table primary key (which we haven’t created yet).


<?php
class Sl_Photogallery_Model_Resource_Photogallery extends Mage_Core_Model_Resource_Db_Abstract {

    /**
     * constructor
     * @access public
     * @return void	
     */
    public function _construct() {
        $this->_init('photogallery/photogallery', 'entity_id');
    }

}
?>

<?php

class Sl_Photogallery_Model_Resource_Photogallery extends Mage_Core_Model_Resource_Db_Abstract {

/**

* constructor

* @access public

* @return void

public function _construct() {

$this->_init('photogallery/photogallery', 'entity_id');

}

Creating Model/Resource/Photogallery/Collection.php class

We can now use our resource model to create the ability to grab a collection of our models, which we can do by simply initialising our collection class.


<?php

class Sl_Photogallery_Model_Resource_Photogallery_Collection extends Mage_Core_Model_Resource_Db_Collection_Abstract{
	
	public function _construct(){
		parent::_construct();
		$this->_init('photogallery/photogallery');

	}
}

?>

<?php

class Sl_Photogallery_Model_Resource_Photogallery_Collection extends Mage_Core_Model_Resource_Db_Collection_Abstract{

public function _construct(){

parent::_construct();

$this->_init('photogallery/photogallery');

}

Creating Model/Resource/Setup.php Class

We start by creating a setup class so we can create an instance of the install object. We don’t need to change anything in the original core setup class so you can leave it blank.


<?php
class Sl_Photogallery_Model_Resource_Setup extends Mage_Core_Model_Resource_Setup{
	
}
?>

<?php

class Sl_Photogallery_Model_Resource_Setup extends Mage_Core_Model_Resource_Setup{

}

Create installer file:

sql/photogallery_setup/install-0.1.0.php

Remember it’s good Magento practice to alias $this object to $installer. I’m gonna create a pretty basic table to demonstrate how it works.


<?php

$installer = $this;
$installer->startSetup();

$table = $installer->getConnection()->newTable($installer->getTable('photogallery'))
        ->addColumn('entity_id', Varien_Db_Ddl_Table::TYPE_INTEGER, null, array(
            'unsigned' => true,
            'nullable' => false,
            'primary' => true,
            'identity' => true,
                ), 'ID')
        ->addColumn('title', Varien_Db_Ddl_Table::TYPE_TEXT, null, array(
            'nullable' => false,
                ), 'Title')
        ->addColumn('photo', Varien_Db_Ddl_Table::TYPE_TEXT, null, array(
            'nullable' => true,
                ), 'Photo Path')
        ->addColumn('createtime', Varien_Db_Ddl_Table::TYPE_TIMESTAMP, null, array(
    'nullable' => false,
        ), 'Timestamp');

$installer->getConnection()->createTable($table);
$installer->endSetup();
?>

<?php

$installer = $this;

$installer->startSetup();

$table = $installer->getConnection()->newTable($installer->getTable('photogallery'))

->addColumn('entity_id', Varien_Db_Ddl_Table::TYPE_INTEGER, null, array(

'unsigned' => true,

'nullable' => false,

'primary' => true,

'identity' => true,

), 'ID')

->addColumn('title', Varien_Db_Ddl_Table::TYPE_TEXT, null, array(

'nullable' => false,

), 'Title')

->addColumn('photo', Varien_Db_Ddl_Table::TYPE_TEXT, null, array(

'nullable' => true,

), 'Photo Path')

->addColumn('createtime', Varien_Db_Ddl_Table::TYPE_TIMESTAMP, null, array(

'nullable' => false,

), 'Timestamp');

$installer->getConnection()->createTable($table);

$installer->endSetup();

Event Observer:

Event observers are extremely powerful and are one of the cleanest ways to extend Magento’s functionality without having to rewrite or override any core methods or classes. We want to observe the event that Magento dispatches just before the order is saved, so the code for the event we are interested in sales_order_place_before.

How do I find what events exist in Magento?

Figuring out how to find these events is relatively simple. We first need to know how Magento fires events and that is done like this:
Mage::dispatchEvent(‘event_name’, array(‘data’ => $data));

With that we can simply do a search in all of our files to return all the events. You can run this command on Linux/Mac:
grep -r “dispatchEvent(” /path/to/magento/install/)

We now need to modify our config.xml to include the event observer definition:


<events>
  <sales_order_place_before>
     <observers>
        <addsomething_sales_order_place_before>
              <type>singleton</type>
              <class>Sl_Photogallery_Model_Observer</class>
              <method>addsomethingtoorder</method>
         </addsomething_sales_order_place_before>      
      </observers>
  </sales_order_place_before> 
</events>

<sales_order_place_before>

<addsomething_sales_order_place_before>

<type>singleton</type>

<class>Sl_Photogallery_Model_Observer</class>

<method>addsomethingtoorder</method>

</addsomething_sales_order_place_before>

</observers>

</sales_order_place_before>

</events>

The above code is our basic config for our model. If you stick to similar naming conventions you’ll get on by fine here.
The main code I’d like to highlight here is contained between the tags. The first tag in represents our event we decided to use earlier on sales_order_place_before, so within here we are defining what to do when that event is fired. Within the tag we have the set up for our Observer. The value within represents the class name of our Observer, and then the value in is the method (or function) we will run when that event is fired.

Creating our Observer.php

Now we can create our Observer and place our code inside our method we will create. To do this create a file named Observer.php in app/code/local/Sl/Photogallery/Model and place the following code:


<?php
class Sl_Photogallery_Model_Observer {

    public function addsomethingtoorder(Varien_Event_Observer $observer)
    {
        $order = $observer->getEvent()->getOrder(); 
            Mage::getModel('solvingmagento_orderexport/export')
              ->exportOrder($order); 
          return true; 
    }
}
?>

<?php

class Sl_Photogallery_Model_Observer {

public function addsomethingtoorder(Varien_Event_Observer $observer)

{

$order = $observer->getEvent()->getOrder();

Mage::getModel('solvingmagento_orderexport/export')

->exportOrder($order);

return true;

}

Cron Job:

Magento allows you to schedule custom tasks in an XML configuration, in a similar manner to the UNIX crontab style. Here we now need to modify our config.xml to include the crontab:


<crontab>  
   <jobs>
      <notify_new_photos>      
        <schedule><cron_expr>0 1 * * *</cron_expr></schedule>
        <run><model>photogallery/observer::notifynewPhotos</model></run>
      </notify_new_photos>
   </jobs>
</crontab>

<jobs>

<notify_new_photos>

<run><model>photogallery/observer::notifynewPhotos</model></run>

</notify_new_photos>

</jobs>

</crontab>

This example will run Sl_Photogallery_Model_Observer::notifynewPhotos method every day at 01:00am (0 1 * * *).
You can find detail about cron here

Finally our config.xml file looks like:


<?xml version = "1.0"?>
<config>
    <modules>
        <Sl_Photogallery>
            <version>0.0.1</version>
        </Sl_Photogallery>
    </modules>
 
    <!-- Configure our module's behavior in the global scope -->
    <global>
        <resources>
            <sl_photogallery_setup>
                <setup>
                    <module>Sl_Photogallery</module>
                    <class>Sl_Photogallery_Model_Resource_Setup</class>
                </setup>
            </sl_photogallery_setup>
        </resources>
        <blocks>
            <photogallery>
                <class>Sl_Photogallery_Block</class>
            </photogallery>
        </blocks>
        <helpers>
            <photogallery>
                <class>Sl_Photogallery_Helper</class>
            </photogallery>
        </helpers>
        <models>
            <photogallery>
                <class>Sl_Photogallery_Model</class>
                <resourceModel>photogallery_resource</resourceModel>
            </photogallery>
            <photogallery_resource>
                <class>Sl_Photogallery_Model_Resource</class>
                <entities>
                    <photogallery>
                        <table>photogallery_photogallery</table>
                    </photogallery>
                    <photogallery_store>
                        <table>photogallery_photogallery_store</table>
                    </photogallery_store>
                    <photogallery_product>
                        <table>photogallery_photogallery_product</table>
                    </photogallery_product>
                </entities>
            </photogallery_resource>
        </models>
        <events>
            <sales_order_place_before>
                <observers>
                    <addsomething_sales_order_place_before>
                        <type>singleton</type>
                        <class>Sl_Photogallery_Model_Observer</class>
                        <method>addsomethingtoorder</method>
                    </addsomething_sales_order_place_before>      
                </observers>
            </sales_order_place_before>
        </events>
    </global>
    
    <!-- This node contains parameters, available on frontend -->
    <frontend>
        <routers>
            <!-- This node"s name should be the same as our alias -->
            <photogallery>
                <use>standard</use>
                <!-- router arguments block -->
                <args>
              <!-- This parameter specifies the full name of out module -->
                    <module>Sl_Photogallery</module>
                    <!-- This parameter sets module alias -->
                    <frontName>photogallery</frontName>
                </args>
            </photogallery>
        </routers>
        <!-- This node contains module layout configuration -->
        <layout>
            <updates>
                <sl_photogallery>
                    <!-- Module xml File -->
                    <file>sl_photogallery.xml</file>
                </photogallery>
            </updates>
        </layout>
    </frontend>
    <crontab>  
        <jobs>
            <notify_new_photos>      
                <schedule><cron_expr>0 1 * * *</cron_expr></schedule>
                <run><model>photogallery/observer::notifynewPhotos</model></run>
            </notify_new_photos>
        </jobs>
    </crontab> 
    <default>
        <photogallery>
            <photogallery>
                <breadcrumbs>1</breadcrumbs>
            </photogallery>
        </photogallery>
    </default>
</config>

100

101

102

103

104

<?xml version = "1.0"?>

<Sl_Photogallery>

</Sl_Photogallery>

</modules>

<sl_photogallery_setup>

<setup>

<module>Sl_Photogallery</module>

<class>Sl_Photogallery_Model_Resource_Setup</class>

</setup>

</sl_photogallery_setup>

</resources>

<class>Sl_Photogallery_Block</class>

</photogallery>

</blocks>

<class>Sl_Photogallery_Helper</class>

</photogallery>

</helpers>

<class>Sl_Photogallery_Model</class>

<resourceModel>photogallery_resource</resourceModel>

</photogallery>

<photogallery_resource>

<class>Sl_Photogallery_Model_Resource</class>

<table>photogallery_photogallery</table>

</photogallery>

<photogallery_store>

<table>photogallery_photogallery_store</table>

</photogallery_store>

<photogallery_product>

<table>photogallery_photogallery_product</table>

</photogallery_product>

</entities>

</photogallery_resource>

</models>

<sales_order_place_before>

<addsomething_sales_order_place_before>

<type>singleton</type>

<class>Sl_Photogallery_Model_Observer</class>

<method>addsomethingtoorder</method>

</addsomething_sales_order_place_before>

</observers>

</sales_order_place_before>

</events>

</global>

<use>standard</use>

<args>

<module>Sl_Photogallery</module>

<frontName>photogallery</frontName>

</args>

</photogallery>

</routers>

<sl_photogallery>

<file>sl_photogallery.xml</file>

</photogallery>

</updates>

</layout>

</frontend>

<jobs>

<notify_new_photos>

<run><model>photogallery/observer::notifynewPhotos</model></run>

</notify_new_photos>

</jobs>

</crontab>

</photogallery>

</default>

</config>

That’s it!!

Leave a comment