Status Class Reference

Inheritance diagram for Status:

Public Member Functions
	getVisibleStatusIds ()
	getSaleableStatusIds ()
	getAllOptions ()
	getOptionText ($optionId)
	addValueSortToCollection ($collection, $dir='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 ()

Static Public Member Functions
static	getOptionArray ()

Data Fields
const	STATUS_ENABLED = 1
const	STATUS_DISABLED = 2

Additional Inherited Members
Protected Attributes inherited from AbstractSource
	$_attribute
	$_options = null

Detailed Description

Product status functionality model

@api

Since

100.0.2

Definition at line 18 of file Status.php.

Member Function Documentation

addValueSortToCollection()

addValueSortToCollection	(		$collection,
			$dir = 'asc'
	)

Add Value Sort To Collection Select

Parameters

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

Returns

AbstractSource

Definition at line 96 of file Status.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 option array with empty value

Returns

string[]

Implements SourceInterface.

Definition at line 65 of file Status.php.

    {
        $result = [];

        foreach (self::getOptionArray() as $index => $value) {
            $result[] = ['value' => $index, 'label' => $value];
        }

        return $result;
    }

getOptionArray()

static getOptionArray ( )

static

Retrieve option array

Returns

string[]

Definition at line 55 of file Status.php.

    {
        return [self::STATUS_ENABLED => __('Enabled'), self::STATUS_DISABLED => __('Disabled')];
    }

getOptionText()

getOptionText

(

$optionId

)

Retrieve option text by option value

Parameters

string

$optionId

Returns

string

Implements SourceInterface.

Definition at line 82 of file Status.php.

    {
        $options = self::getOptionArray();

        return isset($options[$optionId]) ? $options[$optionId] : null;
    }

getSaleableStatusIds()

getSaleableStatusIds

(

)

Retrieve Saleable Status Ids Default Product Enable status

Returns

int[]

Definition at line 45 of file Status.php.

    {
        return [self::STATUS_ENABLED];
    }

getVisibleStatusIds()

getVisibleStatusIds

(

)

#- Retrieve Visible Status Ids

Returns

int[]

Definition at line 34 of file Status.php.

    {
        return [self::STATUS_ENABLED];
    }

Field Documentation

STATUS_DISABLED

const STATUS_DISABLED = 2

Definition at line 25 of file Status.php.

STATUS_ENABLED

const STATUS_ENABLED = 1

#+ Product Status values

Definition at line 23 of file Status.php.

---

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

• vendor/magento/module-catalog/Model/Product/Attribute/Source/Status.php