AbstractSource Class Reference

Inheritance diagram for AbstractSource:

Public Member Functions
	setAttribute ($attribute)
	getAttribute ()
	getOptionText ($value)
	getOptionId ($value)
	addValueSortToCollection ($collection, $dir=\Magento\Framework\Data\Collection::SORT_ORDER_DESC)
	getFlatColumns ()
	getFlatIndexes ()
	getFlatUpdateSelect ($store)
	getIndexOptionText ($value)
	toOptionArray ()
Public Member Functions inherited from SourceInterface
	getAllOptions ()

Protected Attributes
	$_attribute
	$_options = null

Detailed Description

Entity/Attribute/Model - attribute selection source abstract

@api

Author

Magento Core Team core@.nosp@m.mage.nosp@m.ntoco.nosp@m.mmer.nosp@m.ce.co.nosp@m.m @SuppressWarnings(PHPMD.NumberOfChildren)

Since

100.0.2

Definition at line 16 of file AbstractSource.php.

Member Function Documentation

addValueSortToCollection()

addValueSortToCollection	(		$collection,
			$dir = \Magento\Framework\Data\Collection::SORT_ORDER_DESC
	)

Add Value Sort To Collection Select

Parameters

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

Returns

$this @SuppressWarnings(PHPMD.UnusedFormalParameter) @codeCoverageIgnore

Definition at line 105 of file AbstractSource.php.

    {
        return $this;
    }

getAttribute()

getAttribute

(

)

Get attribute instance

Returns

\Magento\Eav\Model\Entity\Attribute\AbstractAttribute @codeCoverageIgnore

Definition at line 53 of file AbstractSource.php.

    {
        return $this->_attribute;
    }

getFlatColumns()

getFlatColumns

(

)

Retrieve flat column definition

@codeCoverageIgnore

Returns

array

Definition at line 116 of file AbstractSource.php.

    {
        return [];
    }

getFlatIndexes()

getFlatIndexes

(

)

Retrieve Indexes(s) for Flat

Returns

array @codeCoverageIgnore

Definition at line 127 of file AbstractSource.php.

    {
        return [];
    }

getFlatUpdateSelect()

getFlatUpdateSelect

(

$store

)

Retrieve Select For Flat Attribute update

Parameters

int

$store

Returns

\Magento\Framework\DB\Select|null @SuppressWarnings(PHPMD.UnusedFormalParameter) @codeCoverageIgnore

Definition at line 140 of file AbstractSource.php.

    {
        return null;
    }

getIndexOptionText()

getIndexOptionText

(

$value

)

Get a text for index option value

Parameters

string | int

$value

Returns

string|bool @codeCoverageIgnore

Definition at line 152 of file AbstractSource.php.

    {
        return $this->getOptionText($value);
    }

getOptionId()

getOptionId

(

$value

)

Parameters

string

$value

Returns

null|string

Definition at line 86 of file AbstractSource.php.

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

getOptionText()

getOptionText

(

$value

)

Get a text for option value

Parameters

string | int

$value

Returns

string|bool

Implements SourceInterface.

Definition at line 64 of file AbstractSource.php.

    {
        $options = $this->getAllOptions();
        // Fixed for tax_class_id and custom_design
        if (sizeof($options) > 0) {
            foreach ($options as $option) {
                if (isset($option['value']) && $option['value'] == $value) {
                    return isset($option['label']) ? $option['label'] : $option['value'];
                }
            }
        }
        // End
        if (isset($options[$value])) {
            return $options[$value];
        }
        return false;
    }

setAttribute()

setAttribute

(

$attribute

)

Set attribute instance

Parameters

\Magento\Eav\Model\Entity\Attribute\AbstractAttribute

$attribute

Returns

\Magento\Eav\Model\Entity\Attribute\Frontend\AbstractFrontend @codeCoverageIgnore

Definition at line 41 of file AbstractSource.php.

    {
        $this->_attribute = $attribute;
        return $this;
    }

toOptionArray()

toOptionArray

(

)

Get options as array

Returns

array @codeCoverageIgnore

Implements OptionSourceInterface.

Definition at line 163 of file AbstractSource.php.

    {
        return $this->getAllOptions();
    }

Field Documentation

$_attribute

$_attribute

protected

Definition at line 25 of file AbstractSource.php.

$_options

$_options = null

protected

Definition at line 32 of file AbstractSource.php.

---

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

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