Mage_Eav_Model_Mysql4_Entity_Attribute_Collection Class Reference

Inheritance diagram for Mage_Eav_Model_Mysql4_Entity_Attribute_Collection:

List of all members.

Public Member Functions
	_construct ()
	useLoadDataFields ()
	setEntityTypeFilter ($typeId)
	setAttributeSetFilter ($setId)
	setAttributeSetsFilter (array $setIds)
	setInAllAttributeSetsFilter (array $setIds)
	setAttributeSetExcludeFilter ($setId)
	setAttributesExcludeFilter ($attributes)
	setAttributeGroupFilter ($groupId)
	addAttributeGrouping ()
	addVisibleFilter ()
	addIsFilterableFilter ()
	addIsFilterableInSearchFilter ()
	addIsUniqueFilter ()
	addIsNotUniqueFilter ()
	addIsSearchableFilter ()
	addHasOptionsFilter ()
	addDisplayInAdvancedSearchFilter ()
	setFrontendInputTypeFilter ($frontendInputType)
	addSetInfo ($flag=true)
	checkConfigurableProducts ()
	setCodeFilter ($code)
Protected Member Functions
	_addSetInfo ()
	_afterLoadData ()
Protected Attributes
	$_addSetInfoFlag = false

---

Detailed Description

Definition at line 34 of file Collection.php.

---

Member Function Documentation

_addSetInfo

(

)

[protected]

Ad information about attribute sets to collection result data

Returns:

Mage_Eav_Model_Mysql4_Entity_Attribute_Collection

Definition at line 321 of file Collection.php.

    {
        if ($this->_addSetInfoFlag) {
            $attributeIds = array();
            foreach ($this->_data as &$dataItem) {
                $attributeIds[] = $dataItem['attribute_id'];
            }
            $attributeToSetInfo = array();

            if (count($attributeIds) > 0) {
                $select = $this->getConnection()->select()
                    ->from(
                        array('entity' => $this->getTable('entity_attribute')),
                        array('attribute_id','attribute_set_id', 'attribute_group_id', 'sort_order')
                    )
                    ->joinLeft(
                        array('group' => $this->getTable('attribute_group')),
                        'entity.attribute_group_id=group.attribute_group_id',
                        array('group_sort_order' => 'sort_order')
                    )
                    ->where('attribute_id IN (?)', $attributeIds);
                $result = $this->getConnection()->fetchAll($select);

                foreach ($result as $row) {
                    $data = array(
                        'group_id'      => $row['attribute_group_id'],
                        'group_sort'    => $row['group_sort_order'],
                        'sort'          => $row['sort_order']
                    );
                    $attributeToSetInfo[$row['attribute_id']][$row['attribute_set_id']] = $data;
                }
            }

            foreach ($this->_data as &$attributeData) {
                if (isset($attributeToSetInfo[$attributeData['attribute_id']])) {
                    $setInfo = $attributeToSetInfo[$attributeData['attribute_id']];
                } else {
                    $setInfo = array();
                }

                $attributeData['attribute_set_info'] = $setInfo;
            }

            unset($attributeToSetInfo);
            unset($attributeIds);
        }
        return $this;
    }

_afterLoadData

(

)

[protected]

Proces loaded collection data

Returns:

Varien_Data_Collection_Db

Reimplemented from Varien_Data_Collection_Db.

Definition at line 370 of file Collection.php.

    {
        $this->_addSetInfo();
        return parent::_afterLoadData();
    }

_construct

(

)

Resource model initialization

Reimplemented from Mage_Core_Model_Mysql4_Collection_Abstract.

Definition at line 46 of file Collection.php.

    {
        $this->_init('eav/entity_attribute');
    }

addAttributeGrouping

(

)

Declare group by attribute id condition for collection select

Returns:

Mage_Eav_Model_Mysql4_Entity_Attribute_Collection

Definition at line 190 of file Collection.php.

    {
        $this->getSelect()->group('entity_attribute.attribute_id');
        return $this;
    }

addDisplayInAdvancedSearchFilter

(

)

Specify "is_visible_in_advanced_search" filter

Returns:

Mage_Eav_Model_Mysql4_Entity_Attribute_Collection

Definition at line 284 of file Collection.php.

                                                      {
        $this->getSelect()
            ->where('main_table.is_visible_in_advanced_search = ?', 1);

        return $this;
    }

addHasOptionsFilter

(

)

Specify filter to select just attributes with options

Returns:

Mage_Eav_Model_Mysql4_Entity_Attribute_Collection

Definition at line 267 of file Collection.php.

    {
        $this->getSelect()
            ->joinLeft(
                array('ao'=>$this->getTable('eav/attribute_option')), 'ao.attribute_id = main_table.attribute_id', 'option_id'
            )
            ->group('main_table.attribute_id')
            ->where('(main_table.frontend_input = ? and option_id > 0) or (main_table.frontend_input <> ?) or (main_table.is_user_defined = 0)', 'select', 'select');

        return $this;
    }

addIsFilterableFilter

(

)

Specify "is_filterable" filter

Returns:

Mage_Eav_Model_Mysql4_Entity_Attribute_Collection

Definition at line 212 of file Collection.php.

    {
        $this->getSelect()->where('main_table.is_filterable>0');
        return $this;
    }

addIsFilterableInSearchFilter

(

)

Add filterable in search filter

Returns:

Mage_Eav_Model_Mysql4_Entity_Attribute_Collection

Definition at line 223 of file Collection.php.

    {
        $this->getSelect()->where('main_table.is_filterable_in_search>0');
        return $this;
    }

addIsNotUniqueFilter

(

)

Specify "is_unique" filter as false

Returns:

Mage_Eav_Model_Mysql4_Entity_Attribute_Collection

Definition at line 245 of file Collection.php.

    {
        $this->getSelect()->where('main_table.is_unique=0');
        return $this;
    }

addIsSearchableFilter

(

)

Specify "is_searchable" filter

Returns:

Mage_Eav_Model_Mysql4_Entity_Attribute_Collection

Definition at line 256 of file Collection.php.

    {
        $this->getSelect()->where('main_table.is_searchable=1');
        return $this;
    }

addIsUniqueFilter

(

)

Specify "is_unique" filter as true

Returns:

Mage_Eav_Model_Mysql4_Entity_Attribute_Collection

Definition at line 234 of file Collection.php.

    {
        $this->getSelect()->where('main_table.is_unique>0');
        return $this;
    }

addSetInfo

(

$

flag = true

)

Flag for adding information about attributes sets to result

Parameters:

bool

$flag

Returns:

Mage_Eav_Model_Mysql4_Entity_Attribute_Collection

Definition at line 310 of file Collection.php.

    {
        $this->_addSetInfoFlag = $flag;
        return $this;
    }

addVisibleFilter

(

)

Specify filter by "is_visible" field

Returns:

Mage_Eav_Model_Mysql4_Entity_Attribute_Collection

Definition at line 201 of file Collection.php.

    {
        $this->getSelect()->where('main_table.is_visible=?', 1);
        return $this;
    }

checkConfigurableProducts

(

)

TODO: issue #5126

Returns:

unknown

Definition at line 381 of file Collection.php.

    {
// was:
/*
SELECT `main_table`.*, `entity_attribute`.*
FROM `eav_attribute` AS `main_table`
    INNER JOIN `eav_entity_attribute` AS `entity_attribute` ON entity_attribute.attribute_id=main_table.attribute_id
WHERE (entity_attribute.attribute_group_id='46') AND (main_table.is_visible=1)
*/
// to be done: left join catalog_product_super_attribute and count appropriate lines
/*
SELECT `main_table`.*, `entity_attribute`.*, COUNT(`super`.attribute_id) AS `is_used_in_configurable`
FROM `eav_attribute` AS `main_table`
    INNER JOIN `eav_entity_attribute` AS `entity_attribute` ON entity_attribute.attribute_id=main_table.attribute_id
    LEFT JOIN `catalog_product_super_attribute` AS `super` ON `main_table`.attribute_id=`super`.attribute_id
WHERE (entity_attribute.attribute_group_id='46') AND (main_table.is_visible=1)
GROUP BY `main_table`.attribute_id
*/
        return $this;
    }

setAttributeGroupFilter

(

$

groupId

)

Filter by attribute group id

Parameters:

int

$groupId

Returns:

Mage_Eav_Model_Mysql4_Entity_Attribute_Collection

Definition at line 177 of file Collection.php.

    {
        $this->join('entity_attribute', 'entity_attribute.attribute_id=main_table.attribute_id', '*');
        $this->getSelect()->where('entity_attribute.attribute_group_id=?', $groupId);
        $this->setOrder('sort_order', 'asc');
        return $this;
    }

setAttributeSetExcludeFilter

(

$

setId

)

Add filter which exclude attributes assigned to attribute set

Parameters:

int

$setId

Returns:

Mage_Eav_Model_Mysql4_Entity_Attribute_Collection

Definition at line 151 of file Collection.php.

    {
        $this->join('entity_attribute', 'entity_attribute.attribute_id=main_table.attribute_id', '*');
        $this->getSelect()->where('entity_attribute.attribute_set_id != ?', $setId);
        $this->setOrder('sort_order', 'asc');
        return $this;
    }

setAttributeSetFilter

(

$

setId

)

Specify attribute set filter

Parameters:

int

$setId

Returns:

Mage_Eav_Model_Mysql4_Entity_Attribute_Collection

Definition at line 92 of file Collection.php.

    {
        if (is_array($setId)) {
            if (!empty($setId)) {
                $this->join('entity_attribute', 'entity_attribute.attribute_id=main_table.attribute_id', 'attribute_id');
                $this->getSelect()->where('entity_attribute.attribute_set_id IN(?)', $setId);
            }
        }
        elseif($setId) {
            $this->join('entity_attribute', 'entity_attribute.attribute_id=main_table.attribute_id', '*');
            $this->getSelect()->where('entity_attribute.attribute_set_id=?', $setId);
            $this->setOrder('sort_order', 'asc');
        }
        return $this;
    }

setAttributeSetsFilter

(

array $

setIds

)

Specify multiple attribute sets filter Result will be ordered by sort_order

Parameters:

array

$setIds

Returns:

Mage_Eav_Model_Mysql4_Entity_Attribute_Collection

Definition at line 115 of file Collection.php.

    {
        $this->join('entity_attribute', 'entity_attribute.attribute_id=main_table.attribute_id', 'attribute_id');
        $this->getSelect()->distinct(true);
        $this->getSelect()->where('entity_attribute.attribute_set_id IN(?)', $setIds);
        $this->setOrder('sort_order', 'asc');
        return $this;
    }

setAttributesExcludeFilter

(

$

attributes

)

Exclude attributes filter

Parameters:

array

$attributes

Returns:

Mage_Eav_Model_Mysql4_Entity_Attribute_Collection

Definition at line 165 of file Collection.php.

    {
        $this->getSelect()->where('main_table.attribute_id NOT IN(?)', $attributes);
        return $this;
    }

setCodeFilter

(

$

code

)

Specify collection attribute codes filter

Parameters:

string

|| array $code

Returns:

Mage_Eav_Model_Mysql4_Entity_Attribute_Collection

Definition at line 408 of file Collection.php.

    {
        if (empty($code)) {
            return $this;
        }
        if (!is_array($code)) {
            $code = array($code);
        }
        $this->getSelect()->where('main_table.attribute_code IN(?)', $code);
        return $this;
    }

setEntityTypeFilter

(

$

typeId

)

Specify attribute entity type filter

Parameters:

int

$typeId

Returns:

Mage_Eav_Model_Mysql4_Entity_Attribute_Collection

Definition at line 80 of file Collection.php.

    {
        $this->getSelect()->where('main_table.entity_type_id=?', $typeId);
        return $this;
    }

setFrontendInputTypeFilter

(

$

frontendInputType

)

Apply filter by attribute frontend input type

Parameters:

string

$frontendInputType

Returns:

Mage_Eav_Model_Mysql4_Entity_Attribute_Collection

Definition at line 297 of file Collection.php.

    {
        $this->getSelect()
            ->where('main_table.frontend_input = ?', $frontendInputType);
        return $this;
    }

setInAllAttributeSetsFilter

(

array $

setIds

)

Filter for selecting of attributes that is in all sets

Parameters:

array

$setIds

Returns:

Mage_Eav_Model_Mysql4_Entity_Attribute_Collection

Definition at line 130 of file Collection.php.

    {
        foreach ($setIds as $setId) {
            $setId = (int) $setId;
            if (!$setId) {
                continue;
            }
            $this->getSelect()->join(array('entity_attribute_'.$setId=>$this->getTable('entity_attribute')), 'entity_attribute_' . $setId . '.attribute_id=main_table.attribute_id and entity_attribute_' . $setId . '.attribute_set_id=' . $setId, 'attribute_id');
        }

        $this->getSelect()->distinct(true);
        $this->setOrder('is_user_defined', 'asc');
        return $this;
    }

useLoadDataFields

(

)

Specify select columns which are used for load arrtibute values

Returns:

Mage_Eav_Model_Mysql4_Entity_Attribute_Collection

Definition at line 56 of file Collection.php.

    {
        $this->getSelect()->reset(Zend_Db_Select::COLUMNS);
        $this->getSelect()->columns(array(
            'attribute_id',
            'entity_type_id',
            'attribute_code',
            'attribute_model',
            'backend_model',
            'backend_type',
            'backend_table',
            'frontend_input',
            'source_model',
            'is_global'
        ));
        return $this;
    }

---

Member Data Documentation

$_addSetInfoFlag = false [protected]

Definition at line 41 of file Collection.php.

---

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

• app/code/core/Mage/Eav/Model/Mysql4/Entity/Attribute/Collection.php