Mage_Catalog_Model_Design Class Reference

Inheritance diagram for Mage_Catalog_Model_Design:

List of all members.

Public Member Functions
	applyDesign ($object, $calledFrom=0)
Public Attributes
const	APPLY_FOR_PRODUCT = 1
const	APPLY_FOR_CATEGORY = 2
const	CATEGORY_APPLY_CATEGORY_AND_PRODUCT_RECURSIVE = 1
const	CATEGORY_APPLY_CATEGORY_ONLY = 2
const	CATEGORY_APPLY_CATEGORY_AND_PRODUCT_ONLY = 3
const	CATEGORY_APPLY_CATEGORY_RECURSIVE = 4
Protected Member Functions
	_apply ($package, $theme)
	_isApplyFor ($applyForObject, $applyTo, $pass=0)
	_isApplyDesign ($design, array $date)
	_applyDesignRecursively ($object, $calledFrom=0, $pass=0)
	_applyDesign ($designUpdateData, $calledFrom=0, $loaded=false, $pass=0)

---

Detailed Description

Definition at line 35 of file Design.php.

---

Member Function Documentation

_apply	(	$	package,
		$	theme
	)			[protected]

Apply package and theme

Parameters:

	string	$package
	string	$theme

Definition at line 77 of file Design.php.

    {
        Mage::getSingleton('core/design_package')
            ->setPackageName($package)
            ->setTheme($theme);
    }

_applyDesign	(	$	designUpdateData,
		$	calledFrom = 0,
		$	loaded = false,
		$	pass = 0
	)			[protected]

Apply design (if using Flat Category)

Parameters:

	Varien_Object|array	$designUpdateData
	int	$calledFrom
	bool	$loaded

Returns:

Mage_Catalog_Model_Design

Definition at line 215 of file Design.php.

    {
        $objects = array();
        if (is_object($designUpdateData)) {
            $objects = array($designUpdateData);
        } elseif (is_array($designUpdateData)) {
            $objects = &$designUpdateData;
        }
        foreach ($objects as $object) {
            $design     = $object->getCustomDesign();
            $date       = $object->getCustomDesignDate();
            $applyTo    = $object->getCustomDesignApply();

            $checkAndApply = $this->_isApplyFor($calledFrom, $applyTo, $pass)
                && $this->_isApplyDesign($design, $date);
            if ($checkAndApply) {
                return $this;
            }
        }

        $pass ++;

        if (false === $loaded && is_object($designUpdateData)) {
            $_designUpdateData = array();
            if ($designUpdateData instanceof Mage_Catalog_Model_Product) {
                $_category = $designUpdateData->getCategory();
                $_designUpdateData = array_merge(
                    $_designUpdateData, array($_category)
                );
                $pass --;
            } elseif ($designUpdateData instanceof Mage_Catalog_Model_Category) {
                $_category = &$designUpdateData;
            }
            if ($_category && $_category->getId()) {
                $_designUpdateData = array_merge(
                    $_designUpdateData,
                    $_category->getResource()->getDesignUpdateData($_category)
                );
                $this->_applyDesign($_designUpdateData, $calledFrom, true, $pass);
            }
        }
        return $this;
    }

_applyDesignRecursively	(	$	object,
		$	calledFrom = 0,
		$	pass = 0
	)			[protected]

Apply design recursively (if using EAV)

Parameters:

	Varien_Object	$object
	int	$calledFrom

Returns:

Mage_Catalog_Model_Design

Definition at line 177 of file Design.php.

    {
        $design     = $object->getCustomDesign();
        $date       = $object->getCustomDesignDate();
        $applyTo    = $object->getCustomDesignApply();

        $checkAndApply = $this->_isApplyFor($calledFrom, $applyTo, $pass)
            && $this->_isApplyDesign($design, $date);
        if ($checkAndApply) {
            return $this;
        }

        $pass ++;

        $category = null;
        if ($object instanceof Mage_Catalog_Model_Product) {
            $category = $object->getCategory();
            $pass --;
        }
        elseif ($object instanceof Mage_Catalog_Model_Category) {
            $category = $object->getParentCategory();
        }

        if ($category && $category->getId()){
            $this->_applyDesignRecursively($category, $calledFrom, $pass);
        }

        return $this;
    }

_isApplyDesign	(	$	design,
		array $	date
	)			[protected]

Check and apply design

Parameters:

	string	$design
	array	$date

Definition at line 146 of file Design.php.

    {
        if (!array_key_exists('from', $date) || !array_key_exists('to', $date)) {
            return false;
        }

        $designInfo = explode("/", $design);
        if (count($designInfo) != 2) {
            return false;
        }

        // define package and theme
        $package    = $designInfo[0];
        $theme      = $designInfo[1];

        // compare dates
        if (Mage::app()->getLocale()->IsStoreDateInInterval(null, $date['from'], $date['to'])) {
            $this->_apply($package, $theme);
            return true;
        }

        return false;
    }

_isApplyFor	(	$	applyForObject,
		$	applyTo,
		$	pass = 0
	)			[protected]

Check is allow apply for

Parameters:

	int	$applyForObject
	int	$applyTo
	int	$pass

Returns:

bool

Definition at line 92 of file Design.php.

    {
        $hasError = false;
        if ($pass == 0) {
            switch ($applyForObject) {
                case self::APPLY_FOR_CATEGORY:
                    break;
                case self::APPLY_FOR_PRODUCT:
                    $validApplyTo = array(
                        self::CATEGORY_APPLY_CATEGORY_AND_PRODUCT_RECURSIVE,
                        self::CATEGORY_APPLY_CATEGORY_AND_PRODUCT_ONLY
                    );
                    if ($applyTo && !in_array($applyTo, $validApplyTo)) {
                        $hasError = true;
                    }
                    break;
                default:
                    $hasError = true;
                    break;
            }
        }
        else {
            switch ($applyForObject) {
                case self::APPLY_FOR_CATEGORY:
                    $validApplyTo = array(
                        self::CATEGORY_APPLY_CATEGORY_AND_PRODUCT_RECURSIVE,
                        self::CATEGORY_APPLY_CATEGORY_RECURSIVE
                    );
                    if ($applyTo && !in_array($applyTo, $validApplyTo)) {
                        $hasError = true;
                    }
                    break;
                case self::APPLY_FOR_PRODUCT:
                    $validApplyTo = array(
                        self::CATEGORY_APPLY_CATEGORY_AND_PRODUCT_RECURSIVE
                    );
                    if ($applyTo && !in_array($applyTo, $validApplyTo)) {
                        $hasError = true;
                    }
                    break;
                default:
                    $hasError = true;
                    break;
            }
        }
        return !$hasError;
    }

applyDesign	(	$	object,
		$	calledFrom = 0
	)

Apply design from catalog object

Parameters:

	array|Mage_Catalog_Model_Category|Mage_Catalog_Model_Product	$object
	int	$calledFrom

Returns:

Mage_Catalog_Model_Design

Definition at line 56 of file Design.php.

    {
        if ($calledFrom != self::APPLY_FOR_CATEGORY && $calledFrom != self::APPLY_FOR_PRODUCT) {
            return $this;
        }

        if (Mage::helper('catalog/category_flat')->isEnabled()) {
            $this->_applyDesign($object, $calledFrom);
        } else {
            $this->_applyDesignRecursively($object, $calledFrom);
        }

        return $this;
    }

---

Member Data Documentation

const APPLY_FOR_CATEGORY = 2

Definition at line 38 of file Design.php.

const APPLY_FOR_PRODUCT = 1

Definition at line 37 of file Design.php.

const CATEGORY_APPLY_CATEGORY_AND_PRODUCT_ONLY = 3

Definition at line 46 of file Design.php.

const CATEGORY_APPLY_CATEGORY_AND_PRODUCT_RECURSIVE = 1

Category / Custom Design / Apply To constants

Definition at line 44 of file Design.php.

const CATEGORY_APPLY_CATEGORY_ONLY = 2

Definition at line 45 of file Design.php.

const CATEGORY_APPLY_CATEGORY_RECURSIVE = 4

Definition at line 47 of file Design.php.

---

The documentation for this class was generated from the following file:

• app/code/core/Mage/Catalog/Model/Design.php