Tips for Twits» howto

Howto: Repackageable custom extension development in Magento – Part 9 – Frontend – List

gaweee — Mon, 22 Jun 2009 07:47:13 +0000

Download the source for this entire series here!

Frontend – List

Let us revisit our frontend controller. Surely by now you’ve gotten a better grasp of the controller and models. So we’ll be revisiting those concepts here. So lets say you want to allow users to view you current Twits as well as create a new Tip.

Some new file structure loving

app/
  design/
    frontend/
      base/
        default/
          template/
            twits/
              - tip_list.phtml
  etc/
    modules/
      - SavantDegrees_All.xml (Or what ever your company name might be)
  code/
    local/
      SavantDegrees/ (Or what ever your company name might be)
        Twits/ (Or whatever your module name might be)
          Block/
            Admin/
              - Main.php
              Main/
                - Grid.php
              - Edit.php
              Edit/
                - Form.php
              - New.php
              New/
                - Form.php
            - HelloWorld.php
            - Index.php
          controllers/
            - AdminController.php
            - IndexController.php
          etc/
            - config.xml
          Helper/
            - Data.php
          Model/
            - Tip.php
            Mysql4/
              - Tip.php
              Tip/
                - Collection.php
          sql/
            twits_setup/
              - mysql4-install-0.2.0.php
              - mysql4-upgrade-0.1.0-0.2.0.php

We’ve added a whole nasty branch of subdirectories under app/designs. Read on to understand what its all for…

Let us return to our IndexController.php


class SavantDegrees_Twits_IndexController extends Mage_Core_Controller_Front_Action
{
 
    public function indexAction()
    {
		$this->loadLayout();
		$this->getLayout()->getBlock('content')->append(
			$this->getLayout()->createBlock('twits/index')
    	);
        $this->renderLayout();
    }
}

Hold your horses, this code is EXACTLY the same as the Part 1. Its just a revision. However, that being said, we see that in Part 1, we made the system create a Block called index. That’s an opening…

So let us modify our Index.php block:
```
class SavantDegrees_Twits_Block_Index extends Mage_Core_Block_Template
{
    public function __construct()
    {
        parent::__construct();
        $this->setTemplate('twits/tip_list.phtml');
    }
 
    public function getTips()
    {
    	$model = Mage::getModel('twits/tip');
    	$collection = $model
    	    	->getCollection()
    	    	->load();
 
        return $collection->getItems();
    }
}
```
What the difference here? We made the block load the template from twits/tip_list.phtml. We can create/find this file in /app/design/frontend/default/default/template/twits/tip_list.phtml. Some explanation is due here:
- When you say setTemplate in the block, it means, use this file as the presentation/view
- This file exists in the some subdirectory of /app/design/frontend/default/default/template. That is the path to your default template. Even though you may have other templates, this is the default 1. So when Magento cant find your template file in the other template directories, it always reverts back to this folder. Its a directory form of inheritance/ancestory/precedence.
Lastly, the tip_list.phtml file:
```
getTips();
if ($_tips) {
	$count = 0;
	foreach ($_tips as $i=>$tip) {
?>
		
			getTitle() ?>
			getAuthor() ?>
			getContents() ?>
		
```
Since the whole purpose of tip_list.phtml is to prepare the view for the list of tips, it obviously needs to get the data from somewhere. It turns out, the Template is the extension of the Block. So by calling $this->getTips(), we’re calling the Block's getTips() method.
There you have it! check your tips list at http://127.0.0.1/magento/index.php/twits

If it works for you, leave a comment! =)

JQuery Progress Bar 2.0

gaweee — Mon, 22 Jun 2009 02:39:49 +0000

Hi all its us again, In the past few months we’ve been asked many a times to help improve the progressbar code. We’ve also been referenced by several websites as THE progressbar to use. In all, we felt we owed it to you guys to make it better.

So here we are, after all those emails and bug reports, we finally got down to it. Always good to take a couple of months to have a fresh prespective of things. We ripped out the old code and made it much better and more extensible than its predecessors. So much that we decided it was enough to qualify as a major revision.

Let see whats been done…

Cleaned up the code, yes its lighter, cleaner faster. (Still lacks documentation though)
Callbacks! Everyone’s favourite
Max values, you can now set it to be 150/2000 instead of just a percentage
Text formats. Show 75/100 or 75% by toggling the textFormat accordingly
Steps, how many steps to get to your target value
Step Duration, how long each step lasts
Webkit (Chrome/Safari) compatibility. More like, Webkit Hacks

Once again, many a thanks for all those who have so generously provided the feature requests as well as bug fixes every now and then. And thanks for all your patience in waiting for this new release.
If its working for you, drop us a comment and tell us where we can see your stuff!

Download the new jQuery progressbar here: jQuery progressbar
or view the demo here

Google Maps Helper

gaweee — Sun, 14 Jun 2009 13:51:15 +0000

In our work we like to create Google Maps links for our client’s (offices, stores, etc). However, the larger our clients presence, the more random links there are bound to be. When it comes to using Google Map’s javascript API to control the map, thats still perfectly fine. But how do I create a google maps link that only shows 1 entry? Turns out, there are several ways to do this:

Manipulate the request such that it only shows your entryHow? For example, searching for “Holland, Singapore” will lead us to about 1,356 results. See here. So lets tweak it a little:
- Append &mrt=yp to the url – That returns us all the business listings. (852 results)
- Append &start=16 to the url – That skips the first 16 results (Shows results 17-26 of 852)
- Append &num=2 to the url – That returns us only 2 results (Only shows 2 results)
For a more complete listing of Google Maps Parameters, consult mapki.com. Kudos to those guys for compiling that list. Really useful stuff
So there you have it, a simple way to link your business such that its the only entry there. However this method is relatively dangerous. Why? Cause you’ve got no idea of the exact ordering that Google maps may return. Today you could be entry 17, surely not in a year (hopefully for the better). As such, this is not the recommended solution.
Use the address with your long/lat coordinates to generate your entry.
- First get your GPS coordinates, there are a number of ways to do this. Check our this link
- Then create your link via the following structure: http://www.google.com/maps?&ie=UTF8&hl=en&q=[urlescaped address]&ll=[GPS lat,long]&z=[Zoom]&iwloc=A
- Still too troublesome? We’ve created a simple tool for our clients to use. Save yourself some time. Try it!

Once again, if you’d rather embed Google maps directly into your site via the JS, then your options are much more open.
Good luck! Let us know if it works for you, of if you find a better way of doing things!

HOWTO: Controlling your presentation with your phone

gaweee — Mon, 13 Apr 2009 13:41:57 +0000

Yeah i just love seeing the awe on my student’s faces when i use my phone and my geek geeky geekiest green laser pointer to teach a class. The software is really simple. After trying out Phonepoint and Wireless Presenter (comes preinstalled in my Nokia E66), I’ve come to pick out Phonepoint as the winner!

Its really simple. Bluetooth connect, open the software on ur PC, open the app on your mobile. Hey ho presto! you’re ready to go! Try it! its free to try but $19.99 for a license. I’d say thats worth the money if i get to walk the room looking good.

Howto: Repackageable custom extension development in Magento – Part 8 – CRUD – Update

gaweee — Tue, 31 Mar 2009 08:27:45 +0000

Download the source for this entire series here!

CRUD – Update

Very similar to the Create phase, this phase basically requires the Form and Form Container blocks, and the controller to save them. Thats all!

Repeat the file structure goodness:

app/
  etc/
    modules/
      - SavantDegrees_All.xml (Or what ever your company name might be)
  code/
    local/
      SavantDegrees/ (Or what ever your company name might be)
        Twits/ (Or whatever your module name might be)
          Block/
            Admin/
              - Main.php
              Main/
                - Grid.php
              - Edit.php
              Edit/
                - Form.php
              - New.php
              New/
                - Form.php
            - HelloWorld.php
          controllers/
            - AdminController.php
            - IndexController.php
          etc/
            - config.xml
          Helper/
            - Data.php
          Model/
            - Tip.php
            Mysql4/
              - Tip.php
              Tip/
                - Collection.php
          sql/
            twits_setup/
              - mysql4-install-0.2.0.php
              - mysql4-upgrade-0.1.0-0.2.0.php

Here we’ve added the block for the Edit container and Form

Looking at the Edit.php code:


class SavantDegrees_Twits_Block_Admin_Edit extends Mage_Adminhtml_Block_Widget_Form_Container
{
    public function __construct()
    {
        parent::__construct();
 
        $this->_blockGroup = 'twits';
        $this->_mode = 'edit';
        $this->_controller = 'admin';
 
        if( $this->getRequest()->getParam($this->_objectId) ) {
            $tip = Mage::getModel('twits/tip')
                ->load($this->getRequest()->getParam($this->_objectId));
            Mage::register('frozen_tip', $tip);
        }
    }
 
    public function getHeaderText()
    {
        return Mage::helper('twits')->__("Edit Tip'%s'", $this->htmlEscape(Mage::registry('frozen_tip')->getName()));
    }
}

The additional code loads the right Tip data based on the Request parameter, then stores that data in the Mage registry. We’ll be using that data on the Form page again later to populate the form.
Notice that the saving code is Mage::register and the retrieving code is Mage::registry

Then the accompanying Edit/Form.php code


class SavantDegrees_Twits_Block_Admin_Edit_Form extends Mage_Adminhtml_Block_Widget_Form
{
	protected function _prepareForm()
    {
        $form = new Varien_Data_Form();
 
        $fieldset = $form->addFieldset('edit_tip', array('legend' => Mage::helper('twits')->__('Tip Details')));
 
        $fieldset->addField('title', 'text', array(
            'name'      => 'title',
            'title'     => Mage::helper('twits')->__('Title'),
            'label'     => Mage::helper('twits')->__('Title'),
            'maxlength' => '250',
            'required'  => true,
        ));
 
        $fieldset->addField('author', 'text', array(
            'name'      => 'author',
            'title'     => Mage::helper('twits')->__('Author'),
            'label'     => Mage::helper('twits')->__('Author'),
            'maxlength' => '250',
            'required'  => true,
        ));
 
        $fieldset->addField('contents', 'textarea', array(
            'name'      => 'contents',
            'title'     => Mage::helper('twits')->__('Contents'),
            'label'     => Mage::helper('twits')->__('Contents'),
            'style'     => 'width: 98%; height: 200px;',
            'required'  => true,
        ));
 
 		$form->setMethod('post');
        $form->setUseContainer(true);
        $form->setId('edit_form');
        $form->setAction($this->getUrl('*/*/save'));
        $form->setValues(Mage::registry('frozen_tip')->getData());
 
        $this->setForm($form);
    }
}

Then lastly the adminController with its editAction and saveAction to load and save the form respectively


class SavantDegrees_Twits_AdminController extends Mage_Adminhtml_Controller_Action
{
	public function indexAction()
    {
		$this->loadLayout()
			->_addContent($this->getLayout()->createBlock('twits/admin_main'))
			->renderLayout();
    }
 
	public function deleteAction()
    {
        $tipId = $this->getRequest()->getParam('id', false);
 
        try {
            Mage::getModel('twits/tip')->setId($tipId)->delete();
            Mage::getSingleton('adminhtml/session')->addSuccess(Mage::helper('twits')->__('Tip successfully deleted'));
            $this->getResponse()->setRedirect($this->getUrl('*/*/'));
 
            return;
        } catch (Exception $e){
            Mage::getSingleton('adminhtml/session')->addError($e->getMessage());
        }
 
        $this->_redirectReferer();
    }
 
    public function newAction()
    {
        $this->loadLayout()
        ->_addContent($this->getLayout()->createBlock('twits/admin_new'))
        ->renderLayout();
    }
 
    public function postAction()
    {
        if ($data = $this->getRequest()->getPost()) {
            $tip = Mage::getModel('twits/tip')->setData($data);
            try {
                $tip->save();
                Mage::getSingleton('adminhtml/session')->addSuccess(Mage::helper('twits')->__('Tip successfully saved'));
                $this->getResponse()->setRedirect($this->getUrl('*/*/'));
                return;
            } catch (Exception $e){
                Mage::getSingleton('adminhtml/session')->addError($e->getMessage());
            }
        }
        $this->getResponse()->setRedirect($this->getUrl('*/*/'));
        return;
    }
 
    public function editAction()
    {
        $this->loadLayout();
        $this->_addContent($this->getLayout()->createBlock('twits/admin_edit'));
        $this->renderLayout();
    }
 
    public function saveAction()
    {
        $tipId = $this->getRequest()->getParam('id', false);
        if ($data = $this->getRequest()->getPost()) {
            $tip = Mage::getModel('twits/tip')->load($tipId)->addData($data);
            try {
                $tip ->setId($tipId)->save();
 
                Mage::getSingleton('adminhtml/session')->addSuccess(Mage::helper('twits')->__('Tip successfully saved'));
                $this->getResponse()->setRedirect($this->getUrl('*/*/'));
                return;
            } catch (Exception $e){
                Mage::getSingleton('adminhtml/session')->addError($e->getMessage());
            }
        }
        $this->_redirectReferer();
    }
}

Ok i admit the code is a tad inefficient. We have 2 separate functions that both does save. In fact, postAction and saveAction only differ that saveAction loads the right record via the ->load($tipId) function. Thats separates a CREATE from an UPDATE request.

And we’re finally finally finally done! To test out the edit function, simply click on any row from the Grid! Thats assuming of course that you actually have some data.

» For frontend stuff, carry on … Fontend – List

Otherwise, if it works for you, leave a comment! =)

Howto: Repackageable custom extension development in Magento – Part 7 – CRUD – Create

gaweee — Tue, 31 Mar 2009 08:27:36 +0000

Download the source for this entire series here!

CRUD – Create

More file structure goodness:

app/
  etc/
    modules/
      - SavantDegrees_All.xml (Or what ever your company name might be)
  code/
    local/
      SavantDegrees/ (Or what ever your company name might be)
        Twits/ (Or whatever your module name might be)
          Block/
            Admin/
              - Main.php
              Main/
                - Grid.php
              - New.php
              New/
                - Form.php
            - HelloWorld.php
          controllers/
            - AdminController.php
            - IndexController.php
          etc/
            - config.xml
          Helper/
            - Data.php
          Model/
            - Tip.php
            Mysql4/
              - Tip.php
              Tip/
                - Collection.php
          sql/
            twits_setup/
              - mysql4-install-0.2.0.php
              - mysql4-upgrade-0.1.0-0.2.0.php

Here we’ve added the block for the New container and Form

Looking at the New.php code:


class SavantDegrees_Twits_Block_Admin_New extends Mage_Adminhtml_Block_Widget_Form_Container
{
    public function __construct()
    {
        parent::__construct();
 
        $this->_blockGroup = 'twits';
        $this->_mode = 'new';
        $this->_controller = 'admin';
    }
 
    public function getHeaderText()
    {
        return Mage::helper('twits')->__('Add New Tip');
    }
}

Then the New/Form.php code


class SavantDegrees_Twits_Block_Admin_New_Form extends Mage_Adminhtml_Block_Widget_Form
{
    protected function _prepareForm()
    {
        $form = new Varien_Data_Form();
 
        $fieldset = $form->addFieldset('new_tip', array('legend' => Mage::helper('twits')->__('Tip Details')));
 
        $fieldset->addField('title', 'text', array(
            'name'      => 'title',
            'title'     => Mage::helper('twits')->__('Title'),
            'label'     => Mage::helper('twits')->__('Title'),
            'maxlength' => '250',
            'required'  => true,
        ));
 
        $fieldset->addField('author', 'text', array(
            'name'      => 'author',
            'title'     => Mage::helper('twits')->__('Author'),
            'label'     => Mage::helper('twits')->__('Author'),
            'maxlength' => '250',
            'required'  => true,
        ));
 
        $fieldset->addField('contents', 'textarea', array(
            'name'      => 'contents',
            'title'     => Mage::helper('twits')->__('Contents'),
            'label'     => Mage::helper('twits')->__('Contents'),
            'style'     => 'width: 98%; height: 200px;',
            'required'  => true,
        ));
 
        $form->setMethod('post');
        $form->setUseContainer(true);
        $form->setId('edit_form');
        $form->setAction($this->getUrl('*/*/post'));
 
        $this->setForm($form);
    }
}

Just like your listings/grid page, the New.php and Form.php classes are the Form Container and Form respectively. So the Form Container automagically creates the form. Did I mention why containers are good? They come with nice pretty buttons! (Save and Back).

Then lastly the adminController with its newAction and postAction to load and save the form respectively


class SavantDegrees_Twits_AdminController extends Mage_Adminhtml_Controller_Action
{
	public function indexAction()
    {
		$this->loadLayout()
			->_addContent($this->getLayout()->createBlock('twits/admin_main'))
			->renderLayout();
    }
 
	public function deleteAction()
    {
        $tipId = $this->getRequest()->getParam('id', false);
 
        try {
            Mage::getModel('twits/tip')->setId($tipId)->delete();
            Mage::getSingleton('adminhtml/session')->addSuccess(Mage::helper('twits')->__('Tip successfully deleted'));
            $this->getResponse()->setRedirect($this->getUrl('*/*/'));
 
            return;
        } catch (Exception $e){
            Mage::getSingleton('adminhtml/session')->addError($e->getMessage());
        }
 
        $this->_redirectReferer();
    }
 
    public function newAction()
    {
        $this->loadLayout()
        ->_addContent($this->getLayout()->createBlock('twits/admin_new'))
        ->renderLayout();
    }
 
    public function postAction()
    {
        if ($data = $this->getRequest()->getPost()) {
            $tip = Mage::getModel('twits/tip')->setData($data);
            try {
                $tip->save();
                Mage::getSingleton('adminhtml/session')->addSuccess(Mage::helper('twits')->__('Tip was successfully saved'));
                $this->getResponse()->setRedirect($this->getUrl('*/*/'));
                return;
            } catch (Exception $e){
                Mage::getSingleton('adminhtml/session')->addError($e->getMessage());
            }
        }
        $this->getResponse()->setRedirect($this->getUrl('*/*/'));
        return;
    }
}

Reward yourself for your lightning fast copy-and-paste kung foo! Whats happening though?
When the script receives a call newAction, it’ll show the form to enter data. The data is posted to the postAction method. That method creates an instance of the model, sets the post data into the model, saves it then redirects it back to the indexAction. Did i mention automagically? Yes, thats why we had to learn so much of the Magento code just to write this simple tutorial. The sql is automagically generated and run and the form is automagically created! *sheds a tear*

Again, your well deserved create form can be found by clicking on the “Add New Tip” button from the Grid!

» Just 1 more … CRUD – Update

Howto: Repackageable custom extension development in Magento – Part 6 – CRUD – Delete

gaweee — Tue, 31 Mar 2009 08:22:25 +0000

Download the source for this entire series here!

CRUD – Delete

The simplest step thus far, add a new function to your AdminController.php


class SavantDegrees_Twits_AdminController extends Mage_Adminhtml_Controller_Action
{
    public function indexAction()
    {
		$this->loadLayout()
			->_addContent($this->getLayout()->createBlock('twits/admin_main'))
			->renderLayout();
    }
 
    public function deleteAction()
    {
        $tipId = $this->getRequest()->getParam('id', false);
 
        try {
            Mage::getModel('twits/tip')->setId($tipId)->delete();
            Mage::getSingleton('adminhtml/session')->addSuccess(Mage::helper('twits')->__('Tip successfully deleted'));
            $this->getResponse()->setRedirect($this->getUrl('*/*/'));
 
            return;
        } catch (Exception $e){
            Mage::getSingleton('adminhtml/session')->addError($e->getMessage());
        }
 
        $this->_redirectReferer();
    }
}

» Almost there … CRUD – Create

Howto: Repackageable custom extension development in Magento – Part 5 – CRUD – Retrieve

gaweee — Tue, 31 Mar 2009 08:18:54 +0000

Download the source for this entire series here!

CRUD – Retrieve

Lets add a new block to the file structure

app/
  etc/
    modules/
      - SavantDegrees_All.xml (Or what ever your company name might be)
  code/
    local/
      SavantDegrees/ (Or what ever your company name might be)
        Twits/ (Or whatever your module name might be)
          Block/
            Admin/
              - Main.php
              Main/
                - Grid.php
            - HelloWorld.php
          controllers/
            - AdminController.php
            - IndexController.php
          etc/
            - config.xml
          Helper/
            - Data.php
          Model/
            - Tip.php
            Mysql4/
              - Tip.php
              Tip/
                - Collection.php
          sql/
            twits_setup/
              - mysql4-install-0.2.0.php
              - mysql4-upgrade-0.1.0-0.2.0.php

We’ll create folder called Admin to store all the admin related blocks. Inside we’ll have a Main.php file that contains the Grid Container. Why do we need a grid container? To put the title and Create button!

The Main.php code


class SavantDegrees_Twits_Block_Admin_Main extends Mage_Adminhtml_Block_Widget_Grid_Container
{
    public function __construct()
    {
        $this->_addButtonLabel = Mage::helper('twits')->__('Add New Tip');
        parent::__construct();
 
        $this->_blockGroup = 'twits';
        $this->_controller = 'admin_main';
        $this->_headerText = Mage::helper('twits')->__('Tips(s)');
    }
}

Here you see a first use of the helper, which will assist in translation

The Grid.php itself


class SavantDegrees_Twits_Block_Admin_Main_Grid extends Mage_Adminhtml_Block_Widget_Grid
{
 
    public function __construct()
    {
        parent::__construct();
        $this->setId('tipsGrid');
        $this->_controller = 'twits';
    }
 
    protected function _prepareCollection()
    {
        $model = Mage::getModel('twits/tip');
        $collection = $model->getCollection();
		$this->setCollection($collection);
 
        return parent::_prepareCollection();
    }
 
 
 
    protected function _prepareColumns()
    {
 
        $this->addColumn('tip_id', array(
            'header'        => Mage::helper('twits')->__('ID'),
            'align'         => 'right',
            'width'         => '50px',
            'filter_index'  => 'dt.tip_id',
            'index'         => 'tip_id',
        ));
 
        $this->addColumn('name', array(
            'header'        => Mage::helper('twits')->__('Title'),
            'align'         => 'left',
            'width'         => '150px',
            'filter_index'  => 'dt.title',
            'index'         => 'title',
            'type'          => 'text',
            'truncate'      => 50,
            'escape'        => true,
        ));
 
        $this->addColumn('tags', array(
            'header'    	=> Mage::helper('twits')->__('Author'),
            'align'         => 'left',
            'filter_index'  => 'dt.author',
            'index'    	 	=> 'author',
            'type'     	 	=> 'text',
            'escape'		=> true,
        ));
 
        $this->addColumn('summary', array(
            'header'        => Mage::helper('twits')->__('Contents'),
            'align'         => 'left',
            'filter_index'  => 'dt.contents',
            'index'         => 'contents',
            'type'          => 'text',
            'escape'        => false,
        ));
 
        $this->addColumn('action',
            array(
                'header'    => Mage::helper('twits')->__('Action'),
                'width'     => '150px',
                'type'      => 'action',
                'getter'	=> 'getTipId',
                'actions'   => array(
                    array(
                        'caption' => Mage::helper('twits')->__('Edit'),
                        'url'     => array(
                            'base'=>'*/*/edit'
                         ),
                         'field'   => 'id'
                    ),
                    array(
                        'caption' => Mage::helper('twits')->__('Delete'),
                        'url'     => array(
                            'base'=>'*/*/delete'
                         ),
                         'field'   => 'id'
                    )
                ),
                'filter'    => false,
                'sortable'  => false
        ));
 
        return parent::_prepareColumns();
    }
 
    public function getRowUrl($row)
    {
        return $this->getUrl('*/*/edit', array(
            'id' => $row->getTipId(),
        ));
    }
}

If you scrutinize the code (which i’d advise against), you’ll see most of the code is geared towards the setup of the grid columns and the edit/delete urls i’ll eventually call to perform the other CRUD functions.
But whats going on? Where do we use this code? The main code (being a Grid_Container automatically adds the child Grid code associated to it. By child we’re talking about the Grid.php file in the Main folder. The folder’s name follows the file. So if you changed the folder’s name to Main2, it wouldnt work. That being said, you can just put any block code in the folder and expect it to run. The reason why this all works now is cause the geniuses at Magento already did alot of work to call the Grid child to run. They have no super time travel powers to tell what else you’re gonna put in there. So, it simply wont work (yet).

Now lets make our adminController.php use that block instead of Hello world.

class SavantDegrees_Twits_AdminController extends Mage_Adminhtml_Controller_Action
{
    public function indexAction()
    {
		$this->loadLayout()
			->_addContent($this->getLayout()->createBlock('twits/admin_main'))
			->renderLayout();
    }
}

Well it says createBlock doesnt it? What do you think it does? twits/admin_main as always refers to the twits namespace and the admin/main.php block file.

Viola! Your very very very hard earned grid!

» Anytime now … Part 6 – CRUD – Delete

Howto: Repackageable custom extension development in Magento – Part 4 – Model

gaweee — Tue, 31 Mar 2009 08:14:39 +0000

Download the source for this entire series here!

Prepare the model

Back to the file structure drawing board

app/
  etc/
    modules/
      - SavantDegrees_All.xml (Or what ever your company name might be)
  code/
    local/
      SavantDegrees/ (Or what ever your company name might be)
        Twits/ (Or whatever your module name might be)
          Block/
            - HelloWorld.php
          controllers/
            - AdminController.php
            - IndexController.php
          etc/
            - config.xml
          Helper/
            - Data.php
          Model/
            - Tip.php
            Mysql4/
              - Tip.php
              Tip/
                - Collection.php
          sql/
            Twits_setup/
              - mysql4-install-0.2.0.php
              - mysql4-upgrade-0.1.0-0.2.0.php

Notice the new folder Model and the associated files inside. Lets clarify:
Model/Tip.php is the logical model that holds code regarding business logic and relations.
Model/Mysql4/Tip.php is the data implementation model that associates the model with the table and its primary key.
Model/Mysql4/Tip/Collection.php is the data implementation model of a collection of Tip. Similar to a recordset/resultset in .Net/Java. This will be used with a Grid later.

Even more config.xml magic. Yay! More hairloss!

 version="1.0"?>
>
    >
        >
            >0.2.0>
        >
    >
    >
        >
            >
                >SavantDegrees_Twits_Model>
                >twits_mysql4>
            >
            >
                >SavantDegrees_Twits_Model_Mysql4>
                >
                    >
                        >tips>
                    >
                >
            >
        >
	>
            >
                >SavantDegrees_Twits_Block>
            >
        >
         >
            >>SavantDegrees_Twits_Helper>>
        >
        >
            >
                >
                    >SavantDegrees_Twits>
                >
                >
                    >core_setup>
                >
            >
            >
                >
                    >core_write>
                >
            >
            >
                >
                    >core_read>
                >
            >
        >
    >
    >
        >
             translate="title" module="twits">
                >Twits>
                >100>
                >twits/admin>
            >
        >
    >
    >
        >
            >
                >standard>
                >
                    >SavantDegrees_Twits>
                    >twits>
                >
            >
        >
    >
>

The global > models fragment define the tips table, the tip model and its resourceModel that we will be using shortly.

Now for the model/Tip.php code:
```
class SavantDegrees_Twits_Model_Tip extends Mage_Core_Model_Abstract
{
 
    protected function _construct()
    {
        $this->_init('twits/tip');
    }
}
```
Whats the point you ask!? The code does nothing but binds the model to the Twits namespace under the model twits. In Java that line would have been package Twits;. *i assume/think/foretold*
(quickly moving on…)
Then Model/Mysql4/Tip.php
```
class SavantDegrees_Twits_Model_Mysql4_Tip extends Mage_Core_Model_Mysql4_Abstract
{
    protected function _construct()
    {
        $this->_init('twits/tip', 'tip_id');
    }
}
```
The code above tells Magento to hunt for the twits application’s twits table in the configuration. Yes i know the names are confusing now. Lets say instead of twits/tip it is twits/foo. In that case the system will find the configuration file associated with twits (which is our app/code/local/SavantDegrees/Twits/etc/config.xml), and look under config > global > models > twits_mysql4 > entities > foo to figure out its configuration instructions. You’ll see next that we’ll request for the table from that same configuration file. Capiche?
As a resourceModel, the code binds the model to a underlying Mysql4 table.

Lastly, Model/Mysql4/Tip/Collection.php


class SavantDegrees_Twits_Model_Mysql4_Tip_Collection extends Varien_Data_Collection_Db
{
    protected $_tipTable;
 
    public function __construct()
    {
        $resources = Mage::getSingleton('core/resource');
        parent::__construct($resources->getConnection('twits_read'));
        $this->_tipTable= $resources->getTableName('twits/tip');
 
        $this->_select->from(
        		array('tip'=>$this->_tipTable),
 		       	array('*')
        		);
        $this->setItemObjectClass(Mage::getConfig()->getModelClassName('twits/tip'));
    }
}

Basically the model files created at this phase are simply trying to tie the model (singular and collection) to the underlying Mysql resource. The entire mechanism is half tied in the config.xml table declaration, the model individual instructions (from identifying the namespace to actually declaring the primary key of the table)

Viola. Models are ready

» Arent we there yet? Part 5 – CRUD – Retrieve

Howto: Repackageable custom extension development in Magento – Part 3 – Database

gaweee — Tue, 31 Mar 2009 08:12:18 +0000

Download the source for this entire series here!

Prepare the database

Next we’ll create the installation script that installs the twits table into the database.

Once again, we begin with updating the file structure

app/
  etc/
    modules/
      - SavantDegrees_All.xml (Or what ever your company name might be)
  code/
    local/
      SavantDegrees/ (Or what ever your company name might be)
        Twits/ (Or whatever your module name might be)
          Block/
            - HelloWorld.php
          controllers/
            - AdminController.php
            - IndexController.php
          etc/
            - config.xml
          Helper/
            - Data.php
          sql/
            twits_setup/
              - mysql4-install-0.2.0.php
              - mysql4-upgrade-0.1.0-0.2.0.php

We simply included a sql folder that will house the eventual table creation sql code.

Next up, updating the config.xml again. This time to add the setup declarations.

 version="1.0"?>
>
    >
        >
            >0.2.0>
        >
    >
    >
	>
            >
                >SavantDegrees_Twits_Block>
            >
        >
         >
            >>SavantDegrees_Twits_Helper>>
        >
        >
            >
                >
                    >SavantDegrees_Twits>
                >
                >
                    >core_setup>
                >
            >
            >
                >
                    >core_write>
                >
            >
            >
                >
                    >core_read>
                >
            >
        >
    >
    >
        >
             translate="title" module="twits">
                >Twits>
                >100>
                >twits/admin>
            >
        >
    >
    >
        >
            >
                >standard>
                >
                    >SavantDegrees_Twits>
                    >twits>
                >
            >
        >
    >
>

Here we’ve added a global > resources section that tells the setup script the folder for installation. We’ve also changed the version number to 0.2.0. When the page is initiated and Magento detects that the version has been upgraded, it will run the appropriate install script.

Lastly the install script itself: mysql4-install-0.2.0.php


$installer = $this;
$installer->startSetup();
 
$installer->run("
CREATE TABLE {$this->getTable('tips')} (
  `tip_id` int(10) unsigned NOT NULL auto_increment,
  `title` varchar(250) NOT NULL default '',
  `author` varchar(250) default NULL,
  `contents` text,
  PRIMARY KEY  (`tip_id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;
  ");
 
$installer->endSetup();

Copy the same file contents to mysql4-upgrade-0.1.0-0.2.0.php. Why? because the code above is correct. But since this HOWTO is going through the phases in version 0.1, 0.2, and etc. Magento has already a record of twit_setup in its core_resource table bound to the previous version of 0.1 (its first run). So what we need now is a upgrading script instead of an installer. But if/when you do package your extension, you shouldn’t need the upgrade code. Just install straight to version 0.2 (or higher)
Once again, wake up the Magento installer by logging into the admin backend, System > Configuration > Advanced. Click on Save Config. Clear your cache at /var/cache too just to be sure.
Check to see if your table is created.
Once your table is created, you can delete the mysql4-upgrade-0.1.0-0.2.0.php file. As explained above, you dont need it anymore!

» More Intangibles! … Part 4 – Model