Mage_Catalog_Model_Config Class Reference

Inheritance diagram for Mage_Catalog_Model_Config:

List of all members.

Public Member Functions
	loadAttributeSets ()
	getAttributeSetName ($entityTypeId, $id)
	getAttributeSetId ($entityTypeId, $name)
	loadAttributeGroups ()
	getAttributeGroupName ($attributeSetId, $id)
	getAttributeGroupId ($attributeSetId, $name)
	loadProductTypes ()
	getProductTypeId ($name)
	getProductTypeName ($id)
	getSourceOptionId ($source, $value)
	getProductAttributes ()
	getProductCollectionAttributes ()
	getAttributesUsedInProductListing ()
	getAttributesUsedForSortBy ()
	getAttributeUsedForSortByArray ()
	getProductListDefaultSortBy ($store=null)
Public Attributes
const	XML_PATH_LIST_DEFAULT_SORT_BY = 'catalog/frontend/default_sort_by'
const	XML_PATH_PRODUCT_COLLECTION_ATTRIBUTES = 'frontend/product/collection/attributes'
Protected Member Functions
	_construct ()
	_getResource ()
Protected Attributes
	$_attributeSetsById
	$_attributeSetsByName
	$_attributeGroupsById
	$_attributeGroupsByName
	$_productTypesById
	$_productAttributes
	$_usedInProductListing
	$_usedForSortBy

---

Detailed Description

Definition at line 28 of file Config.php.

---

Member Function Documentation

_construct

(

)

[protected]

Initialize resource model

Definition at line 67 of file Config.php.

    {
        $this->_init('catalog/config');
    }

_getResource

(

)

[protected]

Retrieve resource model

Returns:

Mage_Catalog_Model_Resource_Eav_Mysql4_Config

Definition at line 256 of file Config.php.

    {
        return Mage::getResourceModel('catalog/config');
    }

getAttributeGroupId	(	$	attributeSetId,
		$	name
	)

Definition at line 153 of file Config.php.

    {
        if (is_numeric($name)) {
            return $name;
        }

        $this->loadAttributeGroups();

        if (!is_numeric($attributeSetId)) {
            $attributeSetId = $this->getAttributeSetId($attributeSetId);
        }
        $name = strtolower($name);
        return isset($this->_attributeGroupsById[$attributeSetId][$name]) ? $this->_attributeGroupsById[$attributeSetId][$name] : false;
    }

getAttributeGroupName	(	$	attributeSetId,
		$	id
	)

Definition at line 139 of file Config.php.

    {
        if (!is_numeric($id)) {
            return $id;
        }

        $this->loadAttributeGroups();

        if (!is_numeric($attributeSetId)) {
            $attributeSetId = $this->getAttributeSetId($attributeSetId);
        }
        return isset($this->_attributeGroupsById[$attributeSetId][$id]) ? $this->_attributeGroupsById[$attributeSetId][$id] : false;
    }

getAttributeSetId	(	$	entityTypeId,
		$	name
	)

Definition at line 105 of file Config.php.

    {
        if (is_numeric($name)) {
            return $name;
        }
        $this->loadAttributeSets();

        if (!is_numeric($entityTypeId)) {
            $entityTypeId = $this->getEntityType($entityTypeId)->getId();
        }
        $name = strtolower($name);
        return isset($this->_attributeSetsByName[$entityTypeId][$name]) ? $this->_attributeSetsByName[$entityTypeId][$name] : false;
    }

getAttributeSetName	(	$	entityTypeId,
		$	id
	)

Definition at line 92 of file Config.php.

    {
        if (!is_numeric($id)) {
            return $id;
        }
        $this->loadAttributeSets();

        if (!is_numeric($entityTypeId)) {
            $entityTypeId = $this->getEntityType($entityTypeId)->getId();
        }
        return isset($this->_attributeSetsById[$entityTypeId][$id]) ? $this->_attributeSetsById[$entityTypeId][$id] : false;
    }

getAttributesUsedForSortBy

(

)

Retrieve Attributes array used for sort by

Returns:

array

Definition at line 288 of file Config.php.

                                                 {
        if (is_null($this->_usedForSortBy)) {
            $this->_usedForSortBy = array();
            $entityType     = 'catalog_product';
            $attributesData = $this->_getResource()
                ->getAttributesUsedForSortBy();
            Mage::getSingleton('eav/config')
                ->importAttributesData($entityType, $attributesData);
            foreach ($attributesData as $attributeData) {
                $attributeCode = $attributeData['attribute_code'];
                $this->_usedForSortBy[$attributeCode] = Mage::getSingleton('eav/config')
                    ->getAttribute($entityType, $attributeCode);
            }
        }
        return $this->_usedForSortBy;
    }

getAttributesUsedInProductListing

(

)

Retrieve Attributes used in product listing

Returns:

array

Definition at line 266 of file Config.php.

                                                        {
        if (is_null($this->_usedInProductListing)) {
            $this->_usedInProductListing = array();
            $entityType = 'catalog_product';
            $attributesData = $this->_getResource()
                ->getAttributesUsedInListing();
            Mage::getSingleton('eav/config')
                ->importAttributesData($entityType, $attributesData);
            foreach ($attributesData as $attributeData) {
                $attributeCode = $attributeData['attribute_code'];
                $this->_usedInProductListing[$attributeCode] = Mage::getSingleton('eav/config')
                    ->getAttribute($entityType, $attributeCode);
            }
        }
        return $this->_usedInProductListing;
    }

getAttributeUsedForSortByArray

(

)

Retrieve Attributes Used for Sort by as array key = code, value = name

Returns:

array

Definition at line 311 of file Config.php.

    {
        $options = array(
            'position'  => Mage::helper('catalog')->__('Position')
        );
        foreach ($this->getAttributesUsedForSortBy() as $attribute) {
            /* @var $attribute Mage_Eav_Model_Entity_Attribute_Abstract */
            $options[$attribute->getAttributeCode()] = Mage::helper('catalog')->__($attribute->getFrontendLabel());
        }

        return $options;
    }

getProductAttributes

(

)

Load Product attributes

Returns:

array

Definition at line 230 of file Config.php.

    {
        if (is_null($this->_productAttributes)) {
            $this->_productAttributes = array_keys($this->getAttributesUsedInProductListing());
        }
        return $this->_productAttributes;
    }

getProductCollectionAttributes

(

)

Retrieve Product Collection Attributes from XML config file Used only for install/upgrade

Returns:

array

Definition at line 244 of file Config.php.

                                                     {
        $attributes = Mage::getConfig()
            ->getNode(self::XML_PATH_PRODUCT_COLLECTION_ATTRIBUTES)
            ->asArray();
        return array_keys($attributes);;
    }

getProductListDefaultSortBy

(

$

store = null

)

Retrieve Product List Default Sort By

Parameters:

mixed

$store

Returns:

string

Definition at line 330 of file Config.php.

                                                               {
        return Mage::getStoreConfig(self::XML_PATH_LIST_DEFAULT_SORT_BY, $store);
    }

getProductTypeId

(

$

name

)

Definition at line 192 of file Config.php.

    {
        if (is_numeric($name)) {
            return $name;
        }

        $this->loadProductTypes();

        $name = strtolower($name);
        return isset($this->_productTypesByName[$name]) ? $this->_productTypesByName[$name] : false;
    }

getProductTypeName

(

$

id

)

Definition at line 204 of file Config.php.

    {
        if (!is_numeric($id)) {
            return $id;
        }

        $this->loadProductTypes();

        return isset($this->_productTypesById[$id]) ? $this->_productTypesById[$id] : false;
    }

getSourceOptionId	(	$	source,
		$	value
	)

Definition at line 215 of file Config.php.

    {
        foreach ($source->getAllOptions() as $option) {
            if (strcasecmp($option['label'], $value)==0 || $option['value'] == $value) {
                return $option['value'];
            }
        }
        return null;
    }

loadAttributeGroups

(

)

Definition at line 119 of file Config.php.

    {
        if ($this->_attributeGroupsById) {
            return $this;
        }

        $attributeSetCollection = Mage::getResourceModel('eav/entity_attribute_group_collection')
            ->load();

        $this->_attributeGroupsById = array();
        $this->_attributeGroupsByName = array();
        foreach ($attributeSetCollection as $id=>$attributeGroup) {
            $attributeSetId = $attributeGroup->getAttributeSetId();
            $name = $attributeGroup->getAttributeGroupName();
            $this->_attributeGroupsById[$attributeSetId][$id] = $name;
            $this->_attributeGroupsByName[$attributeSetId][strtolower($name)] = $id;
        }
        return $this;
    }

loadAttributeSets

(

)

Definition at line 72 of file Config.php.

    {
        if ($this->_attributeSetsById) {
            return $this;
        }

        $attributeSetCollection = Mage::getResourceModel('eav/entity_attribute_set_collection')
            ->load();

        $this->_attributeSetsById = array();
        $this->_attributeSetsByName = array();
        foreach ($attributeSetCollection as $id=>$attributeSet) {
            $entityTypeId = $attributeSet->getEntityTypeId();
            $name = $attributeSet->getAttributeSetName();
            $this->_attributeSetsById[$entityTypeId][$id] = $name;
            $this->_attributeSetsByName[$entityTypeId][strtolower($name)] = $id;
        }
        return $this;
    }

loadProductTypes

(

)

Definition at line 168 of file Config.php.

    {
        if ($this->_productTypesById) {
            return $this;
        }

        /*
        $productTypeCollection = Mage::getResourceModel('catalog/product_type_collection')
            ->load();
        */
        $productTypeCollection = Mage::getModel('catalog/product_type')
            ->getOptionArray();

        $this->_productTypesById = array();
        $this->_productTypesByName = array();
        foreach ($productTypeCollection as $id=>$type) {
            //$name = $type->getCode();
            $name = $type;
            $this->_productTypesById[$id] = $name;
            $this->_productTypesByName[strtolower($name)] = $id;
        }
        return $this;
    }

---

Member Data Documentation

$_attributeGroupsById [protected]

Definition at line 35 of file Config.php.

$_attributeGroupsByName [protected]

Definition at line 36 of file Config.php.

$_attributeSetsById [protected]

Definition at line 32 of file Config.php.

$_attributeSetsByName [protected]

Definition at line 33 of file Config.php.

$_productAttributes [protected]

Definition at line 45 of file Config.php.

$_productTypesById [protected]

Definition at line 38 of file Config.php.

$_usedForSortBy [protected]

Definition at line 59 of file Config.php.

$_usedInProductListing [protected]

Definition at line 52 of file Config.php.

const XML_PATH_LIST_DEFAULT_SORT_BY = 'catalog/frontend/default_sort_by'

Definition at line 30 of file Config.php.

const XML_PATH_PRODUCT_COLLECTION_ATTRIBUTES = 'frontend/product/collection/attributes'

Definition at line 61 of file Config.php.

---

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

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