Boolean Class Reference

Inheritance diagram for Boolean:

Public Member Functions
	__construct (\Magento\Eav\Model\ResourceModel\Entity\AttributeFactory $eavAttrEntity)
	getAllOptions ()
	getOptionArray ()
	getOptionText ($value)
	getFlatColumns ()
	getFlatIndexes ()
	getFlatUpdateSelect ($store)
	getIndexOptionText ($value)
	addValueSortToCollection ($collection, $dir=\Magento\Framework\DB\Select::SQL_ASC)
Public Member Functions inherited from AbstractSource
	setAttribute ($attribute)
	getAttribute ()
	getOptionText ($value)
	getOptionId ($value)
	addValueSortToCollection ($collection, $dir=\Magento\Framework\Data\Collection::SORT_ORDER_DESC)
	getFlatColumns ()
	getFlatIndexes ()
	getFlatUpdateSelect ($store)
	getIndexOptionText ($value)
	toOptionArray ()

Data Fields
const	VALUE_YES = 1
const	VALUE_NO = 0

Protected Attributes
	$_eavAttrEntity
Protected Attributes inherited from AbstractSource
	$_attribute
	$_options = null

Detailed Description

@api

Since

100.0.2

Definition at line 12 of file Boolean.php.

Constructor & Destructor Documentation

__construct()

__construct

(

\Magento\Eav\Model\ResourceModel\Entity\AttributeFactory

$eavAttrEntity

)

Parameters

\Magento\Eav\Model\ResourceModel\Entity\AttributeFactory

$eavAttrEntity

@codeCoverageIgnore

Definition at line 30 of file Boolean.php.

      {
        $this->_eavAttrEntity = $eavAttrEntity;
    }

Member Function Documentation

addValueSortToCollection()

addValueSortToCollection	(		$collection,
			$dir = \Magento\Framework\DB\Select::SQL_ASC
	)

Add Value Sort To Collection Select

Parameters

\Magento\Eav\Model\Entity\Collection\AbstractCollection	$collection
string	$dir

Returns

\Magento\Eav\Model\Entity\Attribute\Source\Boolean

Definition at line 157 of file Boolean.php.

    {
        $attributeCode = $this->getAttribute()->getAttributeCode();
        $attributeId = $this->getAttribute()->getId();
        $attributeTable = $this->getAttribute()->getBackend()->getTable();
        $linkField = $this->getAttribute()->getEntity()->getLinkField();

        if ($this->getAttribute()->isScopeGlobal()) {
            $tableName = $attributeCode . '_t';
            $collection->getSelect()
                ->joinLeft(
                    [$tableName => $attributeTable],
                    "e.{$linkField}={$tableName}.{$linkField}"
                    . " AND {$tableName}.attribute_id='{$attributeId}'"
                    . " AND {$tableName}.store_id='0'",
                    []
                );
            $valueExpr = $tableName . '.value';
        } else {
            $valueTable1 = $attributeCode . '_t1';
            $valueTable2 = $attributeCode . '_t2';
            $collection->getSelect()
                ->joinLeft(
                    [$valueTable1 => $attributeTable],
                    "e.{$linkField}={$valueTable1}.{$linkField}"
                    . " AND {$valueTable1}.attribute_id='{$attributeId}'"
                    . " AND {$valueTable1}.store_id='0'",
                    []
                )
                ->joinLeft(
                    [$valueTable2 => $attributeTable],
                    "e.{$linkField}={$valueTable2}.{$linkField}"
                    . " AND {$valueTable2}.attribute_id='{$attributeId}'"
                    . " AND {$valueTable2}.store_id='{$collection->getStoreId()}'",
                    []
                );
            $valueExpr = $collection->getConnection()->getCheckSql(
                $valueTable2 . '.value_id > 0',
                $valueTable2 . '.value',
                $valueTable1 . '.value'
            );
        }

        $collection->getSelect()->order($valueExpr . ' ' . $dir);
        return $this;
    }

getAllOptions()

getAllOptions

(

)

Retrieve all options array

Returns

array

Implements SourceInterface.

Definition at line 41 of file Boolean.php.

    {
        if ($this->_options === null) {
            $this->_options = [
                ['label' => __('Yes'), 'value' => self::VALUE_YES],
                ['label' => __('No'), 'value' => self::VALUE_NO],
            ];
        }
        return $this->_options;
    }

getFlatColumns()

getFlatColumns

(

)

Retrieve flat column definition

Returns

array

Definition at line 88 of file Boolean.php.

    {
        $attributeCode = $this->getAttribute()->getAttributeCode();

        return [
            $attributeCode => [
                'unsigned' => false,
                'default' => null,
                'extra' => null,
                'type' => \Magento\Framework\DB\Ddl\Table::TYPE_SMALLINT,
                'length' => 1,
                'nullable' => true,
                'comment' => $attributeCode . ' column',
            ],
        ];
    }

getFlatIndexes()

getFlatIndexes

(

)

Retrieve Indexes(s) for Flat

Returns

array

Definition at line 110 of file Boolean.php.

    {
        $indexes = [];

        $index = 'IDX_' . strtoupper($this->getAttribute()->getAttributeCode());
        $indexes[$index] = ['type' => 'index', 'fields' => [$this->getAttribute()->getAttributeCode()]];

        return $indexes;
    }

getFlatUpdateSelect()

getFlatUpdateSelect

(

$store

)

Retrieve Select For Flat Attribute update

Parameters

int

$store

Returns

\Magento\Framework\DB\Select|null

Definition at line 126 of file Boolean.php.

    {
        return $this->_eavAttrEntity->create()->getFlatUpdateSelect($this->getAttribute(), $store);
    }

getIndexOptionText()

getIndexOptionText

(

$value

)

Get a text for index option value

Parameters

string | int

$value

Returns

string|bool

Definition at line 137 of file Boolean.php.

    {
        switch ($value) {
            case self::VALUE_YES:
                return 'Yes';
            case self::VALUE_NO:
                return 'No';
        }

        return parent::getIndexOptionText($value);
    }

getOptionArray()

getOptionArray

(

)

Retrieve option array

Returns

array

Definition at line 57 of file Boolean.php.

    {
        $_options = [];
        foreach ($this->getAllOptions() as $option) {
            $_options[$option['value']] = $option['label'];
        }
        return $_options;
    }

getOptionText()

getOptionText

(

$value

)

Get a text for option value

Parameters

string | int

$value

Returns

string|false

Implements SourceInterface.

Definition at line 72 of file Boolean.php.

    {
        $options = $this->getAllOptions();
        foreach ($options as $option) {
            if ($option['value'] == $value) {
                return $option['label'];
            }
        }
        return false;
    }

Field Documentation

$_eavAttrEntity

$_eavAttrEntity

protected

Definition at line 24 of file Boolean.php.

VALUE_NO

const VALUE_NO = 0

Definition at line 19 of file Boolean.php.

VALUE_YES

const VALUE_YES = 1

Option values

Definition at line 17 of file Boolean.php.

---

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

• vendor/magento/module-eav/Model/Entity/Attribute/Source/Boolean.php