What is a Helper ?

Create your own Helper

As you are now used to, it starts by declaring it in the config.xml of your plugin, do that in <global> and after </blocks>


<helpers>
    <test>
        <class>Pfay_Test_Helper</class>
    </test>
</helpers>

What is a Helper

As the name implies a « helper » is something that is right for you ! It is an object that will contain practical functions for you and you can call it from anywhere, you just load your helper to use it. For example:

$helper = Mage::helper(‘monhelper’);

Note that this call is actually equivalent to:

$helper = Mage::helper(‘monhelper/data’);
Indeed, it is the default helper « data » which is called.

Call helper of custom module

$helper = Mage::helper(‘modulename/helpername’);

Create your own Helper

As you are now used to, it starts by declaring it in the config.xml of your plugin, do that in <global> and after </blocks>


<helpers>
    <test>
        <class>Pfay_Test_Helper</class>
    </test>
</helpers>

Then creates the folder and the file app/code/local/Pfay/Test/Helper/data.php function wich will contains the function bytwo($ nbr) with a number as an argument and returns that number multiplied by two. A helper is an object that extends the core class Mage_Core_Helper_Abstract.

class Pfay_Test_Helper_Data extends Mage_Core_Helper_Abstract{
public function bytwo($nbr){
return $nbr*2;
}
}

Now in/app/code/local/Pfay/Test/Block/monblock.php we change the function by:

</div>
class Pfay_Test_Block_Monblock extends Mage_Core_Block_Template
{
public function methodblock()
{
$helper = Mage::helper('test');
return '2*2 = '.$helper->bytwo(2);
}
}

Now when we go on yoursite.com/index.php/test/index/, we see that it works!

Here we are ! you understand how to create a helper on magento, I invite you to practice, the only way to improve yourself ;) If you have any questions, feel free to leave a comment.

You want to help me? Share this article on twitter, do an article on this series of tutorials on your blog, tell your friends, participate in the comments and return to this site;)

Magento: Programmatically Updating SKUs in Bulk

Magento does not make it easy to change SKUs in bulk. Try to do it via the import/export or dataflow profiles and you run into all kinds of problems. There is, however, a fairly easy way to do it and it simply involves adding a php script to your server and a CSV file of before and after SKUs. Here’s the step-by-step;

Note: Be sure to test this with only one or two product SKUs before doing it with all your SKUs. Also, be sure to backup your database before attempting this.

1. Create a CSV File with Before and After SKUs

In the first column, list your current SKUs and in the second column list the new SKUs.

Do not include headings in your CSV file.

Be sure this file is saved as a CSV file in the UTF-8 or ANSI encoding. You might run into problems with this if you create the file using Excel.

2. Put the CSV File on Your Server

Upload the CSV file to the var/export directory on your Magento server so that it’s path is /var/export/sku2sku.csv.

3. Create the PHP Script

On your server, in your Magento installation directory (the one where you see the app, var, skin, media, js and other directories), create a new file, save it, and name it “updateskus.php”.

Paste the following php code into updateskus.php and save the file.

</pre>
<?php
include_once './app/Mage.php';
Mage::app();
$updates_file="./var/export/sku2sku.csv";
$sku_entry=array();
$updates_handle=fopen($updates_file, 'r');
if($updates_handle) {
       while($sku_entry=fgetcsv($updates_handle, 1000, ",")) {
            $old_sku=$sku_entry[0];
            $new_sku=$sku_entry[1];
            echo "<br>Updating ".$old_sku." to ".$new_sku." - ";
            try {
                   $get_item = Mage::getModel('catalog/product')
                               ->loadByAttribute('sku', $old_sku);
                   if ($get_item) {
                          $get_item->setSku($new_sku)->save();
                          echo "successful";
                    } else {
                          echo "item not found";
                    }
                } catch (Exception $e) {
                    echo "Cannot retrieve products from Magento: ".$e->getMessage()."<br>";
                    return;
                }
        }
}
fclose($updates_handle);
?>

4. Run the Script

To run the script simply use your internet browser and navigate to http://yoursite.com/updateskus.php. If you have a multi-site setup use the master or primary site as set by your hosting provider.

When the page opens you should see confirmation messages that your SKUs were updated. Your SKUs should now be successfully updated.

If you’re finished updating the SKUs, remove the CSV and PHP files that you added to the server.

5. Errors

If you run into the following error, don’t worry too much. Just re-run the script and see if more SKUs get updated.

Cannot retrieve products from Magento: SQLSTATE[40001]: Serialization failure: 1213 Deadlock found when trying to get lock; try restarting transaction

If you have a lot of SKUs to update you can expect the script to take several minutes at least, to complete.

This method was tested on a multi-site Magento Community 1.6.1 installation.

Magento get total quantity of product sold

$id = 123; // enter your product ID here
$_productCollection = Mage::getResourceModel('reports/product_collection')
    ->addOrderedQty()
    ->addAttributeToFilter('id', $id)
    ->setOrder('ordered_qty', 'desc')
    ->getFirstItem();
$product = $_productCollection;

echo 'Already Bought '.(int)$product->ordered_qty;

How to get product rating and review in magento


/**
* Getting reviews collection object
*/

$productId = $product->getId();
$reviews = Mage::getModel('review/review')
->getResourceCollection()
->addStoreFilter(Mage::app()->getStore()->getId()) 
->addEntityFilter('product', $productId)
->addStatusFilter(Mage_Review_Model_Review::STATUS_APPROVED)
->setDateOrder()
->addRateVotes();


/**
* Getting average of ratings/reviews
*/

$avg = 0;
$ratings = array();
if (count($reviews) > 0) {
foreach ($reviews->getItems() as $review) {
foreach( $review->getRatingVotes() as $vote ) {
$ratings[] = $vote->getPercent();
}
}
$avg = array_sum($ratings)/count($ratings);
}

Magento More View Image Switcher On MouseOver Product Page

Step1. open file on location given below
app/design/frontend/default/default/template/catalog/product/view/media.phtml

Step2. Search the code in media.phtml file
<a href=”#” onclick=”popWin(‘<?php echo $this->getGalleryUrl($_image) ?>’, ‘gallery’, ‘width=300,height=300,left=50,top=50,location=no,status=yes,scrollbars=yes,resizable=yes’); return false;”>
<!–nested img tag stays the same–>
</a>

Step 3. Replace searched code with code below.
<a href=”<?php echo $this->helper(‘catalog/image’)->init($this->getProduct(), ‘image’, $_image->getFile()); ?>” title=”<?php echo $_product->getName();?>” onmouseover=”$(‘image’).src = this.href; return false;”>
<!–nested img tag stays the same–>
</a>

Magento Product and Category Related Functions

Magneto Product Collection

$collection = Mage::getModel(‘catalog/product’)->getCollection()->addAttributeToSelect(‘*’);

Get product of particular category

$products = Mage::getModel(‘catalog/category’)->load(category_id); //put your category id here
$productslist = $products->getProductCollection()->addAttributeToSelect(‘*’);

Product details from Product ID.

$productid=1234;
$model = Mage::getModel(‘catalog/product’) //getting product model
$_product = $model->load($productid); //getting product object for particular product id
echo $_product->getShortDescription(); //product’s short description
echo $_product->getDescription(); // product’s long description
echo $_product->getName(); //product name
echo $_product->getPrice(); //product’s regular Price
echo $_product->getSpecialPrice(); //product’s special Price
echo $_product->getProductUrl(); //product url
echo $_product->getImageUrl(); //product’s image url
echo $_product->getSmallImageUrl(); //product’s small image url
echo $_product->getThumbnailUrl(); //product’s thumbnail image url

product collection from the category and then refine it down from there.

$products = Mage::getModel(‘catalog/category’)->load(410)
->getProductCollection()
->addAttributeToSelect(‘*’)
->addAttributeToFilter(‘status’, 1)
->addAttributeToFilter(‘visibility’, 4)
->addAttributeToFilter(‘special_price’, array(‘neq’ => “”))
->addAttributeToFilter(‘discontinued’, array(‘neq’ => 1))
->setOrder(‘price’, ‘ASC’);

Get Current product category id

$_helper = $this->helper(‘catalog/output’);
$_category_detail=Mage::registry(‘current_category’);
echo $_category_detail->getName(); //gives current category name
echo $_category_detail->getId(); //gives current category id

Display all categories in magento

function get_categories(){
$category = Mage::getModel(‘catalog/category’);
$tree = $category->getTreeModel();
$tree->load();
$ids = $tree->getCollection()->getAllIds();
$arr = array();
if ($ids){
foreach ($ids as $id){
$cat = Mage::getModel(‘catalog/category’);
$cat->load($id);
$arr[$id] = $cat->getName();
}
}
return $arr;
}
$arr = get_categories();
$arr = array_flip($arr);

Get Parent Category of current category

echo $cat_idd = $this->getCurrentCategory()->getParentCategory()->getId();

Get the category ID by product id

$productObj = Mage::getModel(‘catalog/product’)->load($product_id);
$categoryIds = $productObj->getCategoryIds();

To find the parent ID of current category

$_cat = new Mage_Catalog_Block_Navigation();
$curent_cat = $_cat->getCurrentCategory();
$curent_cat_id = $curent_cat->getId();

Get all categories for a product in Magento

$product = Mage::getModel(‘catalog/product’)->load($productId);
$cats = $product->getCategoryIds();
foreach ($cats as $category_id) {
$_cat = Mage::getModel(‘catalog/category’)->load($category_id) ;
echo $_cat->getName();
}

Basic Magento Functions to get Product Information


Load product by id

<?php

$ productid =1234;

$_product = Mage::getModel('catalog/product')->load(1234); //product object is loaded

$_product->getData();//get data of loaded product

?>

Load product by Attribute

<?php

$_product = Mage::getModel('catalog/product')->loadByAttribute('sku','1234');?>//product object is loaded by attribute

$_product->getData();//get data of loaded product

?>

Get Product id by Product SKU

<?php

$sku = 1234;

$productid = Mage::getModel('catalog/product')->getIdBySku($sku);

?>

Get Parent Product from Child (Simple) Products

<?php

$ childId =1234;

For configurable products:

$parent_ids = Mage::getModel('catalog/product_type_configurable')->getParentIdsByChild($childId);

For bundle products:

$parent_ids = Mage::getModel('bundle/product_type')->getParentIdsByChild($childId);

?>

Get Configurable product's Child products

<?php

// input is $_product and result is iterating child products

$childProducts = Mage::getModel('catalog/product_type_configurable')->getUsedProducts(null, $product);

?>

Get Configurable product's Children's (simple product) custom attributes

<?php

// input is $_product and result is iterating child products

$conf = Mage::getModel('catalog/product_type_configurable')->setProduct($_product);

$col = $conf->getUsedProductCollection()->addAttributeToSelect('*')->addFilterByRequiredOptions();

foreach($col as $simple_product){

var_dump($simple_product->getId());

}

?>

Call Static Block

<?php echo $this->getLayout()->createBlock('cms/block')->setBlockId('block-name')->toHtml(); ?>

Get methods of an object

First, use get_class to get the name of an object's class.
<?php $class_name = get_class($object); ?>
Then, pass that get_class_methods to get a list of all the callable methods on an object
<?php
$class_name = get_class($object);
$methods = get_class_methods($class_name);
foreach($methods as $method)
{
var_dump($method);
}
?>

Is product purchasable?
<?php if($_product->isSaleable()) { // do stuff } ?>

Get associated products

In /app/design/frontend/default/site/template/catalog/product/view/type/

<?php $_helper = $this->helper('catalog/output'); ?>

<?php $_associatedProducts = $this->getAllowProducts() ?>

<?php //var_dump($_associatedProducts); ?>

<?php if (count($_associatedProducts)): ?>

<?php foreach ($_associatedProducts as $_item): ?>

<a href="<?php echo $_item->getProductUrl() ?>"><?php echo $_helper->productAttribute($_item, $_item->getName(), 'name') ?> | <?php echo $_item-

>getName() ?> | <?php echo $_item->getPrice() ?></a>

<?php endforeach; ?>

<?php endif; ?>