Visibility Class Reference

Inheritance diagram for Visibility:

Public Member Functions
	__construct (\Magento\Eav\Model\ResourceModel\Entity\Attribute $eavEntityAttribute, array $data=[])
	getVisibleInCatalogIds ()
	getVisibleInSearchIds ()
	getVisibleInSiteIds ()
	getFlatColumns ()
	getFlatIndexes ()
	getFlatUpdateSelect ($store)
	setAttribute ($attribute)
	getAttribute ()
	addValueSortToCollection ($collection, $dir='asc')
	toOptionArray ()
Public Member Functions inherited from DataObject
	__construct (array $data=[])
	addData (array $arr)
	setData ($key, $value=null)
	unsetData ($key=null)
	getData ($key='', $index=null)
	getDataByPath ($path)
	getDataByKey ($key)
	setDataUsingMethod ($key, $args=[])
	getDataUsingMethod ($key, $args=null)
	hasData ($key='')
	toArray (array $keys=[])
	convertToArray (array $keys=[])
	toXml (array $keys=[], $rootName='item', $addOpenTag=false, $addCdata=true)
	convertToXml (array $arrAttributes=[], $rootName='item', $addOpenTag=false, $addCdata=true)
	toJson (array $keys=[])
	convertToJson (array $keys=[])
	toString ($format='')
	__call ($method, $args)
	isEmpty ()
	serialize ($keys=[], $valueSeparator='=', $fieldSeparator=' ', $quote='"')
	debug ($data=null, &$objects=[])
	offsetSet ($offset, $value)
	offsetExists ($offset)
	offsetUnset ($offset)
	offsetGet ($offset)

Static Public Member Functions
static	getOptionArray ()
static	getAllOption ()
static	getAllOptions ()
static	getOptionText ($optionId)

Data Fields
const	VISIBILITY_NOT_VISIBLE = 1
const	VISIBILITY_IN_CATALOG = 2
const	VISIBILITY_IN_SEARCH = 3
const	VISIBILITY_BOTH = 4

Protected Attributes
	$_attribute
	$_eavEntityAttribute
Protected Attributes inherited from DataObject
	$_data = []

Additional Inherited Members
Protected Member Functions inherited from DataObject
	_getData ($key)
	_underscore ($name)
Static Protected Attributes inherited from DataObject
static	$_underscoreCache = []

Detailed Description

Catalog Product visibility model and attribute source model

@api

Since

100.0.2

Definition at line 17 of file Visibility.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Eav\Model\ResourceModel\Entity\Attribute	$eavEntityAttribute,
		array	$data = []
	)

Construct

Parameters

\Magento\Eav\Model\ResourceModel\Entity\Attribute	$eavEntityAttribute
array	$data

Definition at line 47 of file Visibility.php.

      {
        $this->_eavEntityAttribute = $eavEntityAttribute;
        parent::__construct($data);
    }

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

$this

Definition at line 209 of file Visibility.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;
    }

getAllOption()

static getAllOption ( )

static

Retrieve all options

Returns

array

Definition at line 105 of file Visibility.php.

    {
        $options = self::getOptionArray();
        array_unshift($options, ['value' => '', 'label' => '']);
        return $options;
    }

getAllOptions()

static getAllOptions ( )

static

Retrieve all options

Returns

array

Definition at line 117 of file Visibility.php.

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

getAttribute()

getAttribute

(

)

Get attribute instance

Returns

\Magento\Catalog\Model\ResourceModel\Eav\Attribute

Definition at line 197 of file Visibility.php.

    {
        return $this->_attribute;
    }

getFlatColumns()

getFlatColumns

(

)

Retrieve flat column definition

Returns

array

Definition at line 143 of file Visibility.php.

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

        return [
            $attributeCode => [
                'unsigned' => true,
                'default' => null,
                'extra' => null,
                'type' => Table::TYPE_SMALLINT,
                'nullable' => true,
                'comment' => 'Catalog Product Visibility ' . $attributeCode . ' column',
            ],
        ];
    }

getFlatIndexes()

getFlatIndexes

(

)

Retrieve Indexes for Flat

Returns

array

Definition at line 164 of file Visibility.php.

    {
        return [];
    }

getFlatUpdateSelect()

getFlatUpdateSelect

(

$store

)

Retrieve Select For Flat Attribute update

Parameters

int

$store

Returns

\Magento\Framework\DB\Select|null

Definition at line 175 of file Visibility.php.

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

getOptionArray()

static getOptionArray ( )

static

Retrieve option array

Returns

array

Definition at line 90 of file Visibility.php.

    {
        return [
            self::VISIBILITY_NOT_VISIBLE => __('Not Visible Individually'),
            self::VISIBILITY_IN_CATALOG => __('Catalog'),
            self::VISIBILITY_IN_SEARCH => __('Search'),
            self::VISIBILITY_BOTH => __('Catalog, Search')
        ];
    }

getOptionText()

static getOptionText (   $optionId )

static

Retrieve option text

Parameters

int

$optionId

Returns

string

Definition at line 132 of file Visibility.php.

    {
        $options = self::getOptionArray();
        return isset($options[$optionId]) ? $options[$optionId] : null;
    }

getVisibleInCatalogIds()

getVisibleInCatalogIds

(

)

Retrieve visible in catalog ids array

Returns

string[]

Definition at line 60 of file Visibility.php.

    {
        return [self::VISIBILITY_IN_CATALOG, self::VISIBILITY_BOTH];
    }

getVisibleInSearchIds()

getVisibleInSearchIds

(

)

Retrieve visible in search ids array

Returns

string[]

Definition at line 70 of file Visibility.php.

    {
        return [self::VISIBILITY_IN_SEARCH, self::VISIBILITY_BOTH];
    }

getVisibleInSiteIds()

getVisibleInSiteIds

(

)

Retrieve visible in site ids array

Returns

string[]

Definition at line 80 of file Visibility.php.

    {
        return [self::VISIBILITY_IN_SEARCH, self::VISIBILITY_IN_CATALOG, self::VISIBILITY_BOTH];
    }

setAttribute()

setAttribute

(

$attribute

)

Set attribute instance

Parameters

\Magento\Catalog\Model\ResourceModel\Eav\Attribute

$attribute

Returns

$this

Definition at line 186 of file Visibility.php.

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

toOptionArray()

toOptionArray

(

)

{Return array of options as value-label pairs

Returns

array Format: array(array('value' => '

', 'label' => '<label>'), ...)}

Implements OptionSourceInterface.

Definition at line 256 of file Visibility.php.

    {
        return $this->getAllOptions();
    }

Field Documentation

$_attribute

$_attribute

protected

Definition at line 32 of file Visibility.php.

$_eavEntityAttribute

$_eavEntityAttribute

protected

Definition at line 39 of file Visibility.php.

VISIBILITY_BOTH

const VISIBILITY_BOTH = 4

Definition at line 25 of file Visibility.php.

VISIBILITY_IN_CATALOG

const VISIBILITY_IN_CATALOG = 2

Definition at line 21 of file Visibility.php.

VISIBILITY_IN_SEARCH

const VISIBILITY_IN_SEARCH = 3

Definition at line 23 of file Visibility.php.

VISIBILITY_NOT_VISIBLE

const VISIBILITY_NOT_VISIBLE = 1

Definition at line 19 of file Visibility.php.

---

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

• vendor/magento/module-catalog/Model/Product/Visibility.php