<?php
/**
 * Magento
 *
 * NOTICE OF LICENSE
 *
 * This source file is subject to the Open Software License (OSL 3.0)
 * that is bundled with this package in the file LICENSE.txt.
 * It is also available through the world-wide-web at this URL:
 * http://opensource.org/licenses/osl-3.0.php
 * If you did not receive a copy of the license and are unable to
 * obtain it through the world-wide-web, please send an email
 * to license@magentocommerce.com so we can send you a copy immediately.
 *
 * DISCLAIMER
 *
 * Do not edit or add to this file if you wish to upgrade Magento to newer
 * versions in the future. If you wish to customize Magento for your
 * needs please refer to http://www.magentocommerce.com for more information.
 *
 * @category   Mage
 * @package    Mage_Review
 * @copyright  Copyright (c) 2008 Irubin Consulting Inc. DBA Varien (http://www.varien.com)
 * @license    http://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
 */

/**
 * Review helper
 *
 * @category   Mage
 * @package    Mage_Review
 * @author     Magento Core Team <core@magentocommerce.com>
 */
class Mage_Review_Block_Helper extends Mage_Core_Block_Template
{
    private $_availableTemplates = array(
        'default' => 'review/helper/summary.phtml',
	    'short'   => 'review/helper/summary_short.phtml'
    );

	public function getSummaryHtml($product, $templateType, $displayIfNoReviews)
	{
	    // pick template among available
	    if (empty($this->_availableTemplates[$templateType])) {
	        $templateType = 'default';
	    }
	    $this->setTemplate($this->_availableTemplates[$templateType]);

	    $this->setDisplayIfEmpty($displayIfNoReviews);

	    if (!$product->getRatingSummary()) {
	        Mage::getModel('review/review')
	           ->getEntitySummary($product, Mage::app()->getStore()->getId());
	    }
	    $this->setProduct($product);

		return $this->toHtml();
	}

	public function getRatingSummary()
	{
	    return $this->getProduct()->getRatingSummary()->getRatingSummary();
	}

	public function getReviewsCount()
	{
	    return $this->getProduct()->getRatingSummary()->getReviewsCount();
	}

	public function getReviewsUrl()
	{
	    return Mage::getUrl('review/product/list', array(
	       'id'        => $this->getProduct()->getId(),
	       'category'  => $this->getProduct()->getCategoryId()
	    ));
	}

	/**
	 * Add an available template by type
	 *
	 * It should be called before getSummaryHtml()
	 *
	 * @param string $type
	 * @param string $template
	 */
	public function addTemplate($type, $template)
	{
        $this->_availableTemplates[$type] = $template;
	}
}