SpinOneSolutions

Magento Partial Refund Amount Correction for Authorize.net

Will Wright — Wed, 20 Jan 2010 22:04:48 +0000

The Problem:

You’ve enabled partial refunds in the Authorizenet Model, but it’s not refunding the proper amounts. This is due to, in my view, a bug in the core which I’ll show you how to patch!

The Solution:

What you need to do is overload the refund method in the Authorizenet model.

Create a new model that extends the original Authorizenet model. You’ll need to follow the general instructions for how to create a custom module if you don’t already know how to do so.

class Spinonesolutions_General_Model_Paygate_Authorizenet extends Mage_Paygate_Model_Authorizenet {
//Override Mage_Paygate_Model_Authorizenet

protected $_canRefund = true;

public function refund(Varien_Object $payment, $amount) {
  $error = false;
  if ($payment->getRefundTransactionId() && $amount>0) {
    $payment->setAnetTransType(self::REQUEST_TYPE_CREDIT);
    $request = $this->_buildRequest($payment, $amount);
    $request->setXTransId($payment->getRefundTransactionId());
    $result = $this->_postRequest($request);
    if ($result->getResponseCode()==self::RESPONSE_CODE_APPROVED) {
      $payment->setStatus(self::STATUS_SUCCESS);
    } else {
      $error = $result->getResponseReasonText();
    }
  } else {
    $error = Mage::helper('paygate')->__('Error in refunding the payment');
  }

  if ($error !== false) {
    Mage::throwException($error);
  }

  return $this;
}
}

Now all we need to do is let Magento know that we’ve got a custom model. In config.xml add



  
    
      0.0.1
    
  
  
    
      ...
      
        
          Imagistic_General_Model_Paygate_Authorizenet
        
      
      ...

That should do it! Questions and comments welcome.

Custom Magento Grid with Ambiguous Column on Filter

Will Wright — Tue, 05 Jan 2010 17:14:58 +0000

The Problem

You’ve built a custom grid and the source collection has an ambiguous column in the where clause when applying a filter.

The Solution

I recently ran into this problem while I was building a custom grid. The situation should be familiar to many of you. I have a custom table storing addresses; for the region and country I store a region_id and country_id, respectively. For display of the grid however I want to do a lookup to show the user the friendly names for both region and country. To accomplish that I do an inner join on the original collection which yields the full dataset.

However, this also introduces a douplicate column into the collection which was causeing an ambigous column error in my SQL statement whenever I applied a filter (a WHERE clause). Lets take a look at an example.

My tables:

retailer

id
street
city
postcode
country_id
region_id

directory_country_region

region_id
country_id
code
default_name

Now lets take a look at my _prepareCollection method.

protected function _prepareCollection() {
  $collection = Mage::getResourceModel('spinonesolutions_storelocator/retailer_collection');
  $collection->getSelect()
    ->join(array('dcr' => 'directory_country_region'),'dcr.region_id = main_table.region_id')
    ->reset(Zend_Db_Select::COLUMNS)
    ->columns(array('id','name','street','city','country_id'))
    ->columns(array('default_name'),'dcr');
  $this->setCollection($collection);
  return parent::_prepareCollection();
}

This will result in a collection containing all the data that I need for a friendly presentation. However, if I want to filter by country_id (which I do!) then I’m going to get an ambiguous column error in my SQL if I simply add “WHERE country_id = ?”. That’s because country_id is in both tables.

The solution is the “filter_index” property. Here’s a snippet from _prepareColumns which generates the country column and uses filter_index.

$this->addColumn('country_id', array(
  'header' => Mage::helper('spinonesolutions_storelocator')->__('Country'),
  'width' => '100px',
  'index' => 'country_id',
  'filter_index' => 'main_table.country_id',
  'type' => 'country', ));

Now when the SQL statement is generated the ambiguous column error will be fixed since I’ve provided enough specificity. Simple!

Questions and comments welcome!

Magento – Enable Paygate Refunds

Will Wright — Wed, 28 Oct 2009 21:43:26 +0000

The Problem:

You want to issue a refund, electronically, through your payment gateway from Magento.

The Solution:

By default, the community edition of Magento has refunds disabled in the Paygate Models. In order to enable them you need to create a custom Model and overwrite a protected variable. Refer to Part IV: Extending Models for more details on extending a Model.

First, lets take a look at the native Model so that you can understand what’s standing in the way. I’m going to use the Authorize.net gateway as my example.

The top portion of Mage_Paygate_Model_Authorizenet (/Mage/Paygate/Model/Authorizenet.php)

class Mage_Paygate_Model_Authorizenet extends Mage_Payment_Model_Method_Cc
{
    const CGI_URL = 'https://secure.authorize.net/gateway/transact.dll';

    const REQUEST_METHOD_CC     = 'CC';
    const REQUEST_METHOD_ECHECK = 'ECHECK';

    const REQUEST_TYPE_AUTH_CAPTURE = 'AUTH_CAPTURE';
    const REQUEST_TYPE_AUTH_ONLY    = 'AUTH_ONLY';
    const REQUEST_TYPE_CAPTURE_ONLY = 'CAPTURE_ONLY';
    const REQUEST_TYPE_CREDIT       = 'CREDIT';
    const REQUEST_TYPE_VOID         = 'VOID';
    const REQUEST_TYPE_PRIOR_AUTH_CAPTURE = 'PRIOR_AUTH_CAPTURE';

    const ECHECK_ACCT_TYPE_CHECKING = 'CHECKING';
    const ECHECK_ACCT_TYPE_BUSINESS = 'BUSINESSCHECKING';
    const ECHECK_ACCT_TYPE_SAVINGS  = 'SAVINGS';

    const ECHECK_TRANS_TYPE_CCD = 'CCD';
    const ECHECK_TRANS_TYPE_PPD = 'PPD';
    const ECHECK_TRANS_TYPE_TEL = 'TEL';
    const ECHECK_TRANS_TYPE_WEB = 'WEB';

    const RESPONSE_DELIM_CHAR = ',';

    const RESPONSE_CODE_APPROVED = 1;
    const RESPONSE_CODE_DECLINED = 2;
    const RESPONSE_CODE_ERROR    = 3;
    const RESPONSE_CODE_HELD     = 4;

    protected $_code  = 'authorizenet';

    /**
     * Availability options
     */
    protected $_isGateway               = true;
    protected $_canAuthorize            = true;
    protected $_canCapture              = true;
    protected $_canCapturePartial       = false;
    protected $_canRefund               = false;
    protected $_canVoid                 = true;
    protected $_canUseInternal          = true;
    protected $_canUseCheckout          = true;
    protected $_canUseForMultishipping  = true;
    protected $_canSaveCc = false;

    protected $_allowCurrencyCode = array('USD');

The variable that we’re interested in is _canRefund. The game plan is to create a custom Model that overrides Mage_Paygate_Model_Authorizenet and in that Model, override _canRefund. If you’re thinking, why not just change false to true right here, right now! Well my friend, you certainly could, but you’d certainly break your upgrade path too, check out Part IV: Extending Models and Part I: Custom Module.

I’m going to create the class: Spinonesolutions_Paygate_Model_Authorizenet (/local/Spineonesolutions/Paygate/Model/Authorizenet.php) and extend Mage_Paygate_Model_Authorizenet. Now I just override _canRefund and we’re halfway there.

If you read Part IV: Extending Models you’ll know that there’s one last step, and that is to modify config.xml so that our custom Model overrides the native Model.

/Spinonesolutions/Paygate/etc/config.xml


  
  ...
    
      
        Spinonesolutions_Paygate_Model_Authorizenet
      
    
  ...

That should do it! If you’ve got everything else setup correctly this should enable the Model to post refunds electronically to your gateway. Of course, if you want to enable more than one gateway, or perhaps a gateway that’s not Authorize.net you can do that by just following the same steps above with the Model for the gateway of your choice.

As always, questions and comments are welcome!

Update: From Commenter Cindy

Afer doing the above (and not forgetting to fill in app/etc/modules/MyNameSpace_All.xml to activate the new module), I still wasn’t getting authorize.net to really refund the cc.

I found that I needed to add the CC to the request, and then add the actual amount to be refunded. Now issuing a credit memo on the invoice will cause authorize.net to issue a refund to the CC.

Also, it appears that the ‘refund’ button only shows up if you click credit memo from an invoice – it doesn’t show up if you click credit memo on an order (only ‘refund offline’ shows up then).

Anyway, this is the code to make this work for me:

//
// Override Mage_Paygate_Model_Authorizenet
//    enable online refunds via credit memos
//    enable partial refunds
//
class Sbr_Paygate_Model_Authorizenet extends Mage_Paygate_Model_Authorizenet {
  protected $_canCapturePartial = true;
  protected $_canRefund = true;

  //
  // override _buildRequest to fill in the CC number as it is required yet not set peviously
  //
  protected function _buildRequest (Varien_Object $payment) {
    if (($payment->getAnetTransMethod() == self::REQUEST_METHOD_CC) &&($payment->getCcLast4()))
      $payment->setCcNumber($payment->getCcLast4());
   
      return parent::_buildRequest($payment);
  }

  // Override refund in order to fill out the amount
  //
  public function refund(Varien_Object $payment, $amount) {
    $error = false;
    if ($payment->getRefundTransactionId() && $amount>0) {
      $payment->setAnetTransType(self::REQUEST_TYPE_CREDIT);
      $request = $this->_buildRequest($payment);

      // set the amount (beginning of changes)
      $order = $payment->getOrder();
      $request->setXAmount($amount,2);
      $request->setXCurrencyCode($order->getBaseCurrencyCode());
      // (end of changes)

      $request->setXTransId($payment->getRefundTransactionId());
      $result = $this->_postRequest($request);

      if ($result->getResponseCode() == self::RESPONSE_CODE_APPROVED) {
        $payment->setStatus(self::STATUS_SUCCESS);
      } else {
        $error = $result->getResponseReasonText();
      }
    } else {
      $error = Mage::helper(’paygate’)->__(’Error in refunding the payment’);
    }

    if ($error !== false) {
      Mage::throwException($error);
    }

    return $this;
}

Magento – Part V: Data Layer

Will Wright — Wed, 28 Oct 2009 21:03:35 +0000

The Problem:

You need a custom Model to interact with a database.

The Solution:

By now you’ve read all the previous posts, right, and you want to take your custom module to the next level. You not only have business logic to perform, but you need to read and write data to a custom database table. No problem, let’s take a look at Magento’s database layer.

There’s a lot of voodoo that goes into the Database layer, most of the confusion stems from a heavy reliance on naming conventions. Once you understand these conventions you’ll have a much easier time getting data in and out of your database.

As always I’m going to use an example. Let’s say that you need to create a Widget Model that stores Widgets into a database table. We’ll need a Model to describe our Widget, a Class for the data layer, and the appropriate config files to let Magento know about our customizations.

I’m going to start with the Widget Model since it’s already been covered and should be the most familiar.

/app/code/local/Spinonesolutions/Helloworld/Model/Widget.php:

class Spinonesolutions_Helloworld_Model_Widget extends Mage_Core_Model_Abstract {
  function __construct() {
    parent::__construct();
    $this->_init("spinonesolutions_helloworld/widget");
  }

  public function save() {
    $this->setCreated(now());
    $this->setUpdated(now());

    parent::save();
    return $this;
  }
}

There are a couple of important things to make note of in the Class above. First, I’ve extended Mage_Core_Model_Abstract, this is Magento’s basic Data Layer Class and it will provide the functions that we need to interact with the database.

Second, the _init() function’s parameter should match your config.xml, as we’ll see in just a moment. Lastly, I’ve put a little bit of business logic in the save() method. As we’ll see this sets the created, and modified fields in our table to the current datetime when we call save().

/app/code/local/Spinonesolutions/etc/config.xml:



  
    
      0.1.0
    
  
  
    
       
        standard 
        
          Spinonesolutions_Helloworld 
          spinonesolutions 
        
      
    
  
  
    
       
        Spinonesolutions_Helloworld_Model 
        spinonesolutions_helloworld_mysql4 
      
       
        Spinonesolutions_Helloworld_Model_Mysql4
        
          widget 
        
      
      
        
          Imagistic_General_Model_Paygate_Authorizenet
        
      
    
    
     
       core_write
     
     
       core_read

Let’s start at the top and work our way down. Note: I’m going to skip the custom Model stuff and just focus on what’s new for this post.

 
  Spinonesolutions_Helloworld_Model 
  spinonesolutions_helloworld_mysql4

We just mapped a new resource Model (spinonesolutions_helloworld_model_mysql4) to spinonesolutions_helloworld. You’ll notice that the Model itself is defined right after this line.

 
  Spinonesolutions_Helloworld_Model_Mysql4
  
    widget

Just as we did for our custom Model before, we’ve now defined a new Model (spinonesolutions_helloworld_mysql4) and told Magento what its class is (Spinonesolutions_Helloworld_Model_Mysql4). Notice that we’ve already used this new Model as the resourceModel for spinonesolutions_helloworld.

As well as linking this Model to its Class we’ve also mapped a table to it in the entities section. Now the “widget” entity maps to the table “widget” in our magento database.

We need one more file; we’ve mapped spinonesolutions_helloworld_mysql4 to the class Spinonesolutions_Helloworld_Model_Mysql4 so we need to create a file to house this code.

/app/code/local/Spinonesolutions/Helloworld/Model/Mysql4/Widget.php:

class Spinonesolutions_Helloworld_Model_Mysql4_Widget extends Mage_Core_Model_Mysql4_Abstract {
  public function _construct() {
    $this->_init("spinonesolutions_helloworld/widget", "id");
  }
}

Throughout this tutorial I’ve been following Magento’s naming conventions for Class definitions and file names.

The first parameter passed to the _init() function is the Model that defines our table, and the second parameter is the name of the PrimaryKey field.

Last but not least we have the “resources” section of the config.xml. The read and write sections tell Magento what connection to use for read operations and write operations. As long as you keep true to the naming conventions you shouldn’t need to change these values too much.

Let’s put it all together and do a test. I’m going to create a table “widgets”:

widgets
id (int) – PK
title (varchar255)
description (varchar255)
created(datetime)
modified(datetime)

Now we’ll create a controller to manage CRUD for our new Model. I’ll call it WidgetController.

/app/code/local/Spinonesolutions/Helloworld/controllers/WidgetController.php

class Spinonesolutions_Helloworld_WidgetController extends Mage_Core_Controller_Front_Action {
  //indexAction is the default Action for any controller
  function indexAction() {
    echo "Spinonesolutions_Helloworld_WidgetController.indexAction()";
  }

  //{base}/spinonesolutions/widget/create/
  function createAction() {
    echo "Spinonesolutions_Helloworld_WidgetController.createAction()";
    $widget = Mage::getModel("spinonesolutions_helloworld/widget");
    $data = array(
      "title" => "My new title",
      "description" => "My new description"
    );

    $widget->setData($data);
    $widget->save();
  }
}

Requesting {base}/spinonesolutions/widget/create/ results in the insertion of a new record into my widget table! Let’s deconstruct what I’ve done a little bit to gain some understanding.

You’ll recognize the instantiation of the Model from my previous posts on custom Modules and Models. Magento stores all of an object’s data in an array which is stored in a private variable _data. Each of the array elements corresponds to a field in the table. All Models derived from the abstract classes have getters and setters for their variables. You can always call them by using the “get” and “set” prefix followed by camel case variable name.

So if the field in my database table is named “foo_bar”. In the object, the value will be stored in _data[“foo_bar”]. I can set the value by calling $object->setFooBar(“value”). I can get the value by calling $object->getFooBar();

That’s all for this post! I’ll go over widget CRUD in the next!

Download the source – Helloworld_v4

Magento – Part IV : Extending Models

Will Wright — Thu, 22 Oct 2009 15:09:55 +0000

The Problem:

You want to expand upon or change some functionality within Magento.

The Solution:

Extend a Model! I’m going to use a real world example here because I believe that examples are the best tools for teaching.

I was faced with a request for additional functionality in regards to the Authorize.net payment method. Basically, the customer wanted an email to be sent to an administrator if the gateway experienced an error while trying to processes a payment; a very reasonable request.

To accomplish this I extended Mage_Paygate_Model_Authorizenet, the model responsible for Authorize.net. There are two very important reasons why I went about it the way I did.

First, as I mentioned earlier, all custom code should go in the /local/ directory. If I had made my changes directly to Mage_Paygate_Model_Authorizenet (/core/Mage/Paygate/Model/Authorizenet) then the modifications would be in serious danger if the core were ever updated, essentially breaking the upgrade path.

Secondly, by extending the core class I can make reference to anything contained in the parent class. This is good OOP architecture; I’m just adorning the parent class with additional functionality, leveraging all the work that has come before and maintaining good compartmentalization.

There are two basic steps to extending a core class. Firstly, you need to create your new (custom) class in a custom Module living in /local/. I’ll continue expanding upon my previous examples and make a new Model within Spinonesolutions/Helloworld. I’m going to put the new Model in its own folder, mirroring the structure of the core.

Parent Class Path:
/Mage/Paygate/Model/Authorizenet.php

Custom Class Path:
/Spinonesolutions/Helloworld/Model/Paygate/Authorizenet.php

Naming conventions dictate that my custom Class’s name be:
Spinonesolutions_Helloworld_Model_Paygate_Authorizenet

Let’s jump right into the source and dissect what’s going on.

_order = $payment->getOrder();
    try {
      parent::capture($payment,$amount);
    } catch (Exception $error) {
      $this->_sendEmail($error);
      throw $error;
    }           
    return $this;
  }
}

The declaration is import to note because this is where we do the actual extending. Although it’s not necessary for this example I’ve included a call to the constructor, and placed a call to the parent constructor within it. This way, both the custom and parent model are instantiated correctly.

OK, onto the meat, the capture() function. To fully understand this we need to understand what we’re trying to extend. Looking at Mage_Paygate_Model_Authorizenet (/Mage/Paygate/Model/Authorizenet.php) will yield the answer.

As you can see Mage_Paygate_Model_Authorizenet contains a capture method with the exact same signature: public function capture(Varien_Object $payment, $amount). What I’m doing is overriding this method with my method. I add my additional functionality and then call the parent method at the appropriate time to drop the system back into its default workflow.

Notice that all I’m doing is wrapping the parent method call in a try catch block so that if an Exception is thrown I can catch it and send an email. I’ve successfully extended the core functionality without touching a line of the core code!

I’ve left out one small, but hugely important bit of information. In order to get this to work we have to let Magento know that there’s a custom Model which overrides this particular Model. To accomplish this we turn to the config.xml.

"1.0" encoding="UTF-8" ?>

      
            
                  0.1.0
            
      
    
        
                  
                standard 
                
                    Spinonesolutions_Helloworld  
                    spinonesolutions 
                
            
        
    
      
            
                   
                        Spinonesolutions_Helloworld_Model      
                  
              
                  
                        Spinonesolutions_Helloworld_Model_Paygate_Authorizenet

Notice line:24 and the paygate element. This is the element that is telling Magento to now look in our custom class for the Model, and not the core.

That’s all there is to it! You can now extend Magento’s core functionality to your heart’s content.

I bet you astute readers out there noticed that ALL of the models thus far have extended a core class. My first Model Spinonesolutions_Helloworld_Model_Helloworld extends Varien_Object. Even the controllers extend Mage_Core_Controller_Front_Action.

Oh Snap!

Download the source – Helloworld_v3

Magento – Part III : Controllers

Will Wright — Wed, 07 Oct 2009 16:38:05 +0000

The Problem:

I need to write Part III of the Magento series.

The Solutions:

This article… TADA!

First, let’s talk about the controller. The default controller for a module is always named IndexController.php. If you haven’t requested a specific controller (in the URL), than the system is going to look for IndexController.php and load it. Similarly, the default Magento action is indexAction().

Applying this logic to my custom Module; if I simply type {base}/spinonesolutions/ into the address bar, Magento is going to load up Spinonesolutions_Helloworld_IndexController and invoke indexAction(). Remember that “spinonesolutions” is the frontname that I defined for this module in the config.xml (See Part II : Models for source).

helloworld("helloworld");
      }
}

"1.0" encoding="UTF-8" ?>

      
            
                  0.1.0
            
      
    
        
                  
                standard 
                
                    Spinonesolutions_Helloworld  
                    spinonesolutions 
                
            
        
    
      
            
                   
                        Spinonesolutions_Helloworld_Model

Let’s start adding pieces onto our URL and explore what happens in Magento. Adding one piece yields {base}/spinonesolutions/foo/. This is asking Magento to invoke the indexAction() of the FooController, more specifically Spinonesolutions_Helloworld_FooController.

That Class doesn’t exist in our current code base so we need to create it. Following Magento’s naming conventions and our choices in config.xml the filename and path for Spinonesolutions_Helloworld_FooController must be: /Spinonesolutions/Helloworld/controllers/FooController.php.

Now we’ll take it to the next level and add another piece to the URL yielding {base}/spinonesolutions/foo/bar/. This is asking Magento to invoke the barAction() of the FooController (Spinonesolutions_Helloworld_FooController). Let’s add that action to our growing controller.

That covers the basics for controllers. Setup your route in the config.xml then follow the proper naming conventions when creating your classes and you should be all set.

Download the source – Helloworld_v2

Magento – Part II : Models

Will Wright — Fri, 02 Oct 2009 16:18:49 +0000

The Problem:

You need to work with Magento Models, how chic!

The Solution:

Well, let’s be honest… I don’t have THE solution, but I do have some useful snippets of information to pass along.

Models are the meat of an MVC application. They contain the definitions for your application’s components. Stop for a moment and think conceptually about your application. Anything that is represented by a database table is most likely going to be a Model. Anything that can be mentally packaged up and labeled could be a Model. How are Models built, used, and made use of in Magento? Let’s find out.

In the Previous post I showed you how to create a custom Module and one of the main pieces of that Module was the Model Helloworld.

Hello World! My argument is : " . $arg;
  }
}

I’m going to examine it now, in more detail, to flush out some of the intricacies of Magento.

Notice the class definition:

Spinonesolutions_Helloworld_Model_Helloworld

It’s important to maintain this naming convention since Magento uses an autoloader to load class files when they’re called for. If they’re not named correctly it will look at the wrong place in the file system for the file which SHOULD contain the class it’s looking for, but alas it will not be there, and thus; it will not find it and you will receive an error.

Deconstructing the above:

Spinonsolutions_Helloworld_Model_Helloworld
{Namespace}_{Module}_Model_{Model}.php

Let’s look at some permutations to get a deeper understanding:

Spinonesolutions_Helloworld_Model_Worldhello
\Spinonesolutions\Helloworld\Model\Worldhello.php

Spinonesolutions_Helloworld_Model_Foo_Bar
\Spinonesolutions\Helloworld\Model\Foo\Bar.php

Spinonesolutions_Helloworld_Model_Foo_Helloworld
\Spinonesolutions\Helloworld\Model\Foo\Helloworld.php

Picking up the pattern? Good!

The __consruct method is called when Magento builds an instance of this Model. My constructors always contain, at least, a call to the parent constructor and sometimes more depending on the Model.

To instantiate an instance of a Model use Mage::getModel($modelClass,$arguments) or Mage::getSingleton($modelClass,$arguments). The parameter $modelClass is a string, the construction of which is partially determined by the config.xml and partly by the Model’s class definition. Let’s look at IndexController from Part I, line 23.

helloworld("helloworld");
  }
}

The piece of $modelClass that comes before the backslash (spinonesolutions_helloworld) is defined in the config.xml file included in the etc directory of your Module.





0.1.0




 
standard 

Spinonesolutions_Helloworld 
spinonesolutions 






 
Spinonesolutions_Helloworld_Model

Notice the models element. It’s defining a label for the class (and folder) Spinonesolutions_Helloworld_Model. Said in another way; given spinonesolutions_helloworld, the models element tells Magento what class and, by naming convention, what folder to look in for the second piece; that which comes after the backslash.

The piece that comes after the backslash (helloworld) tells Magento what particular Model you’re looking for. In my example, it’s simply helloworld, so the autoloader is going to be looking for a file named Helloworld.php that contains a class definition Spinonesolutions_Helloworld_Model_Helloworld. Lets extend the permutations that we used earlier adding how to instantiate each.

Spinonesolutions_Helloworld_Model_Worldhello
\Spinonesolutions\Helloworld\Model\Worldhello.php
$objModel = Mage::getModel(‘spinonesolutions_helloworld/worldhello’);

Spinonesolutions_Helloworld_Model_Foo_Bar
\Spinonesolutions\Helloworld\Model\Foo\Bar.php
$objModel = Mage::getModel(‘spinonesolutions_helloworld/foo_bar’);

Spinonesolutions_Helloworld_Model_Foo_Helloworld
\Spinonesolutions\Helloworld\Model\Foo\Helloworld.php
$objModel = Mage::getModel(‘spinonesolutions_helloworld/foo_helloworld’);

A great way to get a handle on how the naming conventions work is to meander through the core and note of name of the file and the folder structure it’s been placed in; then compare that to the class definition contained within.

One more time; since it took me a while to figure this out!

\Spinonesolutions\Helloworld\Model\Helloworld.php

Spinonesolutions_Helloworld_Model_Helloworld

Spinonesolutions_Helloworld_Model

$objModel = Mage::getModel(‘spinonesolutions_helloworld/helloworld);

Do you see it! Do you!?

One awesome, and very useful, property of Models is that they can extend any other Model you want. This is, in general, how you extend core Models with your own functionality.

This is absolutely essential when you want to add on to the Magento code base. If you just fire up your text editor and make your changes to the core, the next time you upgrade Magento, there’s a relatively good chance you’ll lose all your work.

That’s all for Models! Not really though, I’ve just covered the basics here, read on for more as I cover extending!

Download the source – Helloworld

Magento – Part I : Custom Module

Will Wright — Wed, 02 Sep 2009 04:00:01 +0000

This article was written while using Magento v1.3.2.3.

Greetings! This is installment number one of the the exiting Magento Custom Module series. There’s basically two paths to the end of the fairytale:

Path 1: You follow this series and get down and dirty with Magento, learning a lot along the way.

Path 2: You go out and download the Module Creator (http://www.magentocommerce.com/wiki/custom_module_with_custom_database_table) and head straight to GO!

Your choice!

Note: Magento is an MVC application so I’m going to assume you have a basic understanding of MVC. Also, Magento is built (I believe) on the Zend framework, so there’s some Zend specific syntax that I’m also not going to dive into. Huzzzah!

The Problem:

You need to create a custom Module in Magento! Why…? Hell, I don’t know; you just do. That’s enough of that, let’s get down to it.

The Solution:

All of your customizations need to go into the [root]\app\code\local folder. This is where Magento expects to find them and it’s also a factor in maintaining your upgrade path. When the next version of Magento is released you’ll be able to backup your “local” folder and blow away everything else.

Before we get too far into this let’s setup our development environment, go to:
Admin -> System -> Cache Management: Cache Control – All Cache = Disable

This will save you many hours of self-torture while you’re developing.

A couple of other developer settings that I’ve found helpful:
Admin -> System -> Configuration -> Developer: Debug – Profiler = yes
Log Settings – Enabled = yes

Now open up [root]\index.php and at the very end you’ll see three lines that are commented out; un-comment them and save.

Finally, turn SEO friendly URLs on:
Admin -> System -> Configuration -> Web: Search Engine Optimization – Use Web Server Rewrites = Yes

All of the URLs that I’ll be presenting as examples below assume that SEO friendly URLs are enabled.

Magento is now correctly configured for development so let’s dive into building a custom module.

Sample file structure:
[root]\app\code\local\{Namespace}\{Modulename}
[root]\app\code\local\{Namespace}\{Modulename}\controllers
[root]\app\code\local\{Namespace}\{Modulename}\etc
[root]\app\code\local\{Namespace}\{Modulename}\etc\config.xml
[root]\app\code\local\{Namespace}\{Modulename}\Helper
[root]\app\code\local\{Namespace}\{Modulename}\Helper\Data.php
[root]\app\code\local\{Namespace}\{Modulename}\Model
[root]\app\code\local\{Namespace}\{Modulename}\{Modulename}.php

{Namespace} is a user defined variable. Basically it’s just a mechanism that allows the user to create disparate classes that would otherwise have the same names.
{Modulename} this is the name of your module.

For my examples I’m going to use “Spinonesolutions” as my namespace and “Helloworld” as my Module. I’m not entirely sure if it matters or not, but as a general rule I always capitalize the first letter and leave the rest lower case. Don’t use underscores in your names either, we’ll see why later.

controllers is where all the controllers go, crazy right? I’ll get into the controller structure in another part of this series. For now a sample will suffice.

helloworld("helloworld");
  }
}

Data.php is just a helper file for the Magento internals, I’m not exactly sure what it does but it appears to be exactly the same in every module except for its class definition.

Model holds all of the models for your module. It’s customary to name your main model after your {Modulename}. You’ll most likely have at least one model and if you browse through the Magento core you’ll notice that most modules contain many models.

Hello World! My argument is : " . $arg;
  }
}

config.xml is where you connect all your code up to Magento. There’s a lot of voodoo going on in here and I’m not entirely sure how it all works. I might even write a full post on the config.xml as a forthcoming part of this series.



 
   
   0.1.0
   
 
 
   
         
       standard    
       
         Spinonesolutions_Helloworld    
         spinonesolutions    
       
     
   
 
 
   
         
       Spinonesolutions_Helloworld_Model

That takes care of all the code needed in the module directory. There’s one more configuration file we need to create and it’s an exception to the local folder rule:
[root]\app\etc\modules\{Namespace}_{Modulename}.xml



 
   
     true
     local

This file tells Magento that there’s a new module out there that it needs to load. Alternatively, you can name your file [root]\app\etc\modules\{Namespace}_All.xml to tell Magento to load up all the modules in that namespace.

Once you have this file in place you can navigate to Admin->System -> Configuration -> Advanced and you should see your module enabled here.

You now have a functioning custom module, hurray!

Download the source – Helloworld

JavaScript reports 0 (Zero) Height and Width for hidden image

Will Wright — Thu, 09 Jul 2009 23:00:14 +0000

The Problem:

I was recently modifying an image gallery for a customer that used a pretty slick JavaScript Carousel for the presentation. The Basic idea was that the images were all outputted within an LI, hidden via CSS, and then the JavaScript carousel used that LI as the datasource to build the gallery.

Everything worked great except that the images were being re-sized and their aspect ratio was not being maintained. The solution was to obtain their original size so that the aspect ratio could be computed, and then applied during the re-sizing process.

The issue I ran into is that JavaScript (jQuery) always reported that the height and width was 0 (zero) for the images.

After some digging I found that elements marked “display:none” don’t have to load their hidden contents into the DOM and therefore there was no IMG object for JavaScript to report on!

IE Display None

Mozilla Display None

Untitled Document

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nullam hendrerit mauris quis ante mollis sit amet dapibus erat semper. Nunc vitae nisi sapien, at ultricies neque. Ut interdum eleifend iaculis. Ut a auctor turpis. Sed in neque eget nulla vestibulum porttitor. Donec urna magna, feugiat vel interdum vitae, vestibulum vel nibh. Integer pellentesque bibendum pulvinar. Praesent orci turpis, porttitor id laoreet eget, fringilla in tortor. Nam sollicitudin mi vitae odio luctus nec fringilla mauris rutrum. Aenean tristique mi felis. Fusce eget justo eros, vel rhoncus dui.

Curabitur feugiat ornare sapien, eu placerat magna aliquet placerat. Curabitur at vestibulum felis. Maecenas sagittis, lorem ac imperdiet mattis, nisi diam porta nibh, vel molestie odio turpis ut nisl. In hac habitasse platea dictumst. Quisque augue massa, tempor nec molestie id, facilisis non tortor. Pellentesque dapibus, massa a ornare placerat, erat urna blandit justo, sagittis sodales lectus odio et lacus. Suspendisse congue ipsum quis massa ornare vel vehicula sapien gravida. Mauris pretium elit ut mi malesuada pellentesque. Phasellus pulvinar nulla at sem eleifend ac sollicitudin est tincidunt. Proin lorem urna, viverra quis gravida in, scelerisque at dui.

Nullam et erat vitae lacus porttitor pharetra. Nullam tincidunt tempor fermentum. Nulla rutrum, urna ac dapibus consequat, nisl lectus commodo arcu, ultrices auctor ante elit eget enim. Etiam enim massa, volutpat in venenatis mattis, placerat id sapien. Duis vel ante sit amet neque accumsan sollicitudin ac consequat sapien. Proin dapibus rhoncus libero vitae tristique. Quisque at neque in metus sodales vestibulum. Cras lacinia eleifend sapien, a pellentesque arcu pellentesque at. In hac habitasse platea dictumst. Ut porta sodales euismod. Donec ligula arcu, aliquet sed pretium vitae, aliquam quis lorem. Morbi fermentum semper volutpat. Sed porttitor posuere augue et imperdiet. Cras gravida diam at diam accumsan accumsan. Duis turpis erat, mollis ac tempor eu, elementum faucibus mi. Fusce et urna id dui pharetra consectetur. Nulla facilisis feugiat libero, eu ullamcorper purus placerat sed. Donec nisi sem, volutpat eu pellentesque non, consequat eget nibh.

The Solution:

The solution to this issue is to alter the method in which we hide the content. Using “visibility:hidden” works; the height and width are reported correctly, but the browser allocates space for the content which “breaks” the layout.

IE Visibility Hidden

Untitled Document

Almost there. All we need to do now is get rid of the space that’s been allocated for the element. There are a number of different strategies for doing this and you’ll probably have to pick a particular one based on the other attributes of your layout. I’m just going to use “postition:absolute” because it’s an easy one liner.

IE Visibility Hidden Position Absolute

Untitled Document

All done! We now have a hidden element and jQuery is reporting the correct dimensions for the img within it!

Mozilla Strict Three Column Layout with UL

Will Wright — Wed, 24 Jun 2009 15:08:03 +0000

The Problem:

Note: This only applies to XHTML 1.0 Strict Doctypes and Mozilla.

I make this type of layout all the time! Two fixed width columns on either side of a fluid column. Recently I had to put a list of article teasers into the center (fluid) column. No problem, I marked up an unordered list, floated the thumbnail to the left and let the title and teaser paragraph do their thing. The only problem was that in order to get the box model for the “li” to fully wrap the inner content I had to apply “clearfix” to it. That’s when everything broke and I started working on a fix which I shall now share with you!

First things first. Let’s go over the three column layout:

http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr">

Untitled Document

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Curabitur at elementum mauris. In ultricies lobortis dictum. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Praesent pellentesque, tortor nec rutrum auctor, tellus velit feugiat tellus, id consectetur orci augue in lorem. Donec tempor posuere ligula a ullamcorper. Quisque aliquam lacinia convallis. Sed eget placerat nisi. Etiam dignissim gravida lorem sit amet auctor. In hac habitasse platea dictumst. Nunc blandit imperdiet rhoncus. Donec laoreet, nibh sed consectetur posuere, lacus eros adipiscing felis, eleifend eleifend purus libero ut nulla. Duis commodo felis vitae tellus accumsan non ultrices justo feugiat. Curabitur auctor dolor ut mi iaculis dapibus. Nunc posuere dolor in elit scelerisque cursus. Vestibulum libero lacus, auctor at mattis et, pretium eget massa.
Cras ac sapien ipsum. Proin orci eros, consectetur rhoncus tempus nec, ultricies sit amet metus. Vivamus condimentum tellus arcu. Mauris lorem risus, congue in tincidunt nec, tincidunt a diam. Aliquam non diam quis augue pellentesque auctor sed vel velit. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Duis ac lacus sit amet arcu imperdiet facilisis quis et turpis. Sed venenatis dignissim ligula at vestibulum. Nulla non ante elit, eu aliquet leo. Sed laoreet nulla ac justo volutpat ac facilisis nulla eleifend. Morbi nibh sapien, tincidunt ut egestas a, imperdiet eu purus. Suspendisse potenti. Sed eget sapien mi.

Yea! Hot! Now I’m going to add in my list of article teasers and we’ll see what the problem is:

http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr">

Untitled Document

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Curabitur at elementum mauris. In ultricies lobortis dictum. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Praesent pellentesque, tortor nec rutrum auctor, tellus velit feugiat tellus, id consectetur orci augue in lorem. Donec tempor posuere ligula a ullamcorper. Quisque aliquam lacinia convallis. Sed eget placerat nisi. Etiam dignissim gravida lorem sit amet auctor. In hac habitasse platea dictumst. Nunc blandit imperdiet rhoncus. Donec laoreet, nibh sed consectetur posuere, lacus eros adipiscing felis, eleifend eleifend purus libero ut nulla. Duis commodo felis vitae tellus accumsan non ultrices justo feugiat. Curabitur auctor dolor ut mi iaculis dapibus. Nunc posuere dolor in elit scelerisque cursus. Vestibulum libero lacus, auctor at mattis et, pretium eget massa.
Ut placerat tortor sed dui molestie eu fringilla risus ultricies. Phasellus faucibus turpis eu purus lacinia at blandit quam scelerisque. Etiam laoreet purus at augue varius a pellentesque diam accumsan. Nulla sodales auctor nibh, ac vehicula est bibendum a. In vitae quam vel dolor blandit sagittis. Proin ut congue lacus. Nulla facilisi. Sed viverra gravida justo, id feugiat nisl dignissim id. In hac habitasse platea dictumst. Proin faucibus congue pellentesque. Integer nec velit mauris, non ullamcorper leo. Duis sagittis rhoncus tincidunt. Phasellus erat metus, tristique vel lacinia non, tempus sit amet lacus.
All for good
Small actions add up to a big difference. All for Good helps you find and share ways to do good.
Top Birthday Wish Fundraisers on Causes
See the top birthday wish fundraisers on Causes and learn
Raise Awareness for Your Cause
Set-up a branded credit card through our partner Capital One® for your organization-with your logo.
Title/Headline
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt.

Snap yo! That list be broken. If you hit that with firebug you’ll see that the box model for that second teaser list item doesn’t wrap the image because it’s been floated to the left. Since the text for that particular item isn’t that long, it doesn’t push the box model down past the right hand edge of the image and that is what’s causing the thrid list item to stack up to the right of it.

The way I usually make the box model wrap floated elements is to apply the “clearfix” class to the parent element (the li in our case).

http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr">

Untitled Document

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Curabitur at elementum mauris. In ultricies lobortis dictum. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Praesent pellentesque, tortor nec rutrum auctor, tellus velit feugiat tellus, id consectetur orci augue in lorem. Donec tempor posuere ligula a ullamcorper. Quisque aliquam lacinia convallis. Sed eget placerat nisi. Etiam dignissim gravida lorem sit amet auctor. In hac habitasse platea dictumst. Nunc blandit imperdiet rhoncus. Donec laoreet, nibh sed consectetur posuere, lacus eros adipiscing felis, eleifend eleifend purus libero ut nulla. Duis commodo felis vitae tellus accumsan non ultrices justo feugiat. Curabitur auctor dolor ut mi iaculis dapibus. Nunc posuere dolor in elit scelerisque cursus. Vestibulum libero lacus, auctor at mattis et, pretium eget massa.
Ut placerat tortor sed dui molestie eu fringilla risus ultricies. Phasellus faucibus turpis eu purus lacinia at blandit quam scelerisque. Etiam laoreet purus at augue varius a pellentesque diam accumsan. Nulla sodales auctor nibh, ac vehicula est bibendum a. In vitae quam vel dolor blandit sagittis. Proin ut congue lacus. Nulla facilisi. Sed viverra gravida justo, id feugiat nisl dignissim id. In hac habitasse platea dictumst. Proin faucibus congue pellentesque. Integer nec velit mauris, non ullamcorper leo. Duis sagittis rhoncus tincidunt. Phasellus erat metus, tristique vel lacinia non, tempus sit amet lacus.
All for good
Small actions add up to a big difference. All for Good helps you find and share ways to do good.
Top Birthday Wish Fundraisers on Causes
See the top birthday wish fundraisers on Causes and learn
Raise Awareness for Your Cause
Set-up a branded credit card through our partner Capital One® for your organization-with your logo.
Title/Headline
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt.

Well that worked, kinda. It certainly did what it was supposed to do just not what I wanted to do.

The culprint is this line:

html[xmls] .clearfix {
display:block;
}

The Solution:

Now that we know the problem, the solution is actually pretty simple. All we have to do is write a selector to only target “clearfix” applied to “li”s that are in our three column layout.

http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr">

Untitled Document

Ut placerat tortor sed dui molestie eu fringilla risus ultricies. Phasellus faucibus turpis eu purus lacinia at blandit quam scelerisque. Etiam laoreet purus at augue varius a pellentesque diam accumsan. Nulla sodales auctor nibh, ac vehicula est bibendum a. In vitae quam vel dolor blandit sagittis. Proin ut congue lacus. Nulla facilisi. Sed viverra gravida justo, id feugiat nisl dignissim id. In hac habitasse platea dictumst. Proin faucibus congue pellentesque. Integer nec velit mauris, non ullamcorper leo. Duis sagittis rhoncus tincidunt. Phasellus erat metus, tristique vel lacinia non, tempus sit amet lacus.

All for good
Small actions add up to a big difference. All for Good helps you find and share ways to do good.

Top Birthday Wish Fundraisers on Causes
See the top birthday wish fundraisers on Causes and learn

Raise Awareness for Your Cause
Set-up a branded credit card through our partner Capital One® for your organization-with your logo.

Title/Headline
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt.

That’s it!