Magento: app/code/core/Mage/Catalog/Helper/Product/Flat.php Source File

00001 <?php
00002 /**
00003  * Magento
00004  *
00005  * NOTICE OF LICENSE
00006  *
00007  * This source file is subject to the Open Software License (OSL 3.0)
00008  * that is bundled with this package in the file LICENSE.txt.
00009  * It is also available through the world-wide-web at this URL:
00010  * http://opensource.org/licenses/osl-3.0.php
00011  * If you did not receive a copy of the license and are unable to
00012  * obtain it through the world-wide-web, please send an email
00013  * to license@magentocommerce.com so we can send you a copy immediately.
00014  *
00015  * DISCLAIMER
00016  *
00017  * Do not edit or add to this file if you wish to upgrade Magento to newer
00018  * versions in the future. If you wish to customize Magento for your
00019  * needs please refer to http://www.magentocommerce.com for more information.
00020  *
00021  * @category   Mage
00022  * @package    Mage_Catalog
00023  * @copyright  Copyright (c) 2009 Irubin Consulting Inc. DBA Varien (http://www.varien.com)
00024  * @license    http://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
00025  */
00026 
00027 
00028 /**
00029  * Catalog Product Flat Helper
00030  *
00031  * @category   Mage
00032  * @package    Mage_Catalog
00033  * @author     Magento Core Team <core@magentocommerce.com>
00034  */
00035 class Mage_Catalog_Helper_Product_Flat extends Mage_Core_Helper_Abstract
00036 {
00037     const XML_PATH_USE_PRODUCT_FLAT          = 'catalog/frontend/flat_catalog_product';
00038     const XML_NODE_ADD_FILTERABLE_ATTRIBUTES = 'global/catalog/product/flat/add_filterable_attributes';
00039     const XML_NODE_ADD_CHILD_DATA            = 'global/catalog/product/flat/add_child_data';
00040 
00041     /**
00042      * Catalog Product Flat Flag object
00043      *
00044      * @var Mage_Catalog_Model_Product_Flat_Flag
00045      */
00046     protected $_flagObject;
00047 
00048     /**
00049      * Retrieve Catalog Product Flat Flag object
00050      *
00051      * @return Mage_Catalog_Model_Product_Flat_Flag
00052      */
00053     public function getFlag()
00054     {
00055         if (is_null($this->_flagObject)) {
00056             $this->_flagObject = Mage::getSingleton('catalog/product_flat_flag')
00057                 ->loadSelf();
00058         }
00059         return $this->_flagObject;
00060     }
00061 
00062     /**
00063      * Check is builded Catalog Product Flat Data
00064      *
00065      * @return bool
00066      */
00067     public function isBuilt()
00068     {
00069         return $this->getFlag()->getIsBuilt();
00070     }
00071 
00072     /**
00073      * Check is enable catalog product for store
00074      *
00075      * @param mixed $store
00076      * @return bool
00077      */
00078     public function isEnabled($store = null)
00079     {
00080         if (Mage::app()->getStore($store)->isAdmin()) {
00081             return false;
00082         }
00083         return Mage::getStoreConfigFlag(self::XML_PATH_USE_PRODUCT_FLAT, $store);
00084     }
00085 
00086     /**
00087      * Is add filterable attributes to Flat table
00088      *
00089      * @return int
00090      */
00091     public function isAddFilterableAttributes()
00092     {
00093         return intval(Mage::getConfig()->getNode(self::XML_NODE_ADD_FILTERABLE_ATTRIBUTES));
00094     }
00095 
00096     /**
00097      * Is add child data to Flat
00098      *
00099      * @return int
00100      */
00101     public function isAddChildData()
00102     {
00103         return intval(Mage::getConfig()->getNode(self::XML_NODE_ADD_CHILD_DATA));
00104     }
00105 }