Inheritance diagram for Collection:

Public Member Functions
	setLoadDefault ($loadDefault)

	getLoadDefault ()

	setWithoutDefaultFilter ()

	addGroupFilter ($groupId)

	addStatusFilter ($status)

	addIdFilter ($store)

	addWebsiteFilter ($website)

	addCategoryFilter ($category)

	toOptionArray ()

	toOptionHash ()

	load ($printQuery=false, $logQuery=false)

	loadByCategoryIds (array $categories)

	addRootCategoryIdAttribute ()

Public Member Functions inherited from AbstractCollection
	__construct (\Magento\Framework\Data\Collection\EntityFactoryInterface $entityFactory, \Psr\Log\LoggerInterface $logger, \Magento\Framework\Data\Collection\Db\FetchStrategyInterface $fetchStrategy, \Magento\Framework\Event\ManagerInterface $eventManager, \Magento\Framework\DB\Adapter\AdapterInterface $connection=null, \Magento\Framework\Model\ResourceModel\Db\AbstractDb $resource=null)

	getMainTable ()

	setMainTable ($table)

	getSelect ()

	addFieldToSelect ($field, $alias=null)

	addExpressionFieldToSelect ($alias, $expression, $fields)

	removeFieldFromSelect ($field, $isAlias=false)

	removeAllFieldsFromSelect ()

	setModel ($model)

	getModelName ()

	setResourceModel ($model)

	getResourceModelName ()

	getResource ()

	getTable ($table)

	getAllIds ()

	join ($table, $cond, $cols=' *')

	setResetItemsDataChanged ($flag)

	resetItemsDataChanged ()

	save ()

	__sleep ()

	__wakeup ()

Public Member Functions inherited from AbstractDb
	__construct (EntityFactoryInterface $entityFactory, Logger $logger, FetchStrategyInterface $fetchStrategy, \Magento\Framework\DB\Adapter\AdapterInterface $connection=null)

	getResource ()

	addBindParam ($name, $value)

	getIdFieldName ()

	setConnection (\Magento\Framework\DB\Adapter\AdapterInterface $conn)

	getSelect ()

	getConnection ()

	getSize ()

	getSelectCountSql ()

	getSelectSql ($stringMode=false)

	setOrder ($field, $direction=self::SORT_ORDER_DESC)

	addOrder ($field, $direction=self::SORT_ORDER_DESC)

	unshiftOrder ($field, $direction=self::SORT_ORDER_DESC)

	addFieldToFilter ($field, $condition=null)

	distinct ($flag)

	load ($printQuery=false, $logQuery=false)

	loadWithFilter ($printQuery=false, $logQuery=false)

	fetchItem ()

	getData ()

	resetData ()

	loadData ($printQuery=false, $logQuery=false)

	printLogQuery ($printQuery=false, $logQuery=false, $sql=null)

	addFilterToMap ($filter, $alias, $group='fields')

	__clone ()

	joinExtensionAttribute (JoinDataInterface $join, JoinProcessorInterface $extensionAttributesJoinProcessor)

	getItemObjectClass ()

	__sleep ()

	__wakeup ()

Public Member Functions inherited from Collection
	__construct (EntityFactoryInterface $entityFactory)

	addFilter ($field, $value, $type='and')

	addFieldToFilter ($field, $condition)

	getFilter ($field)

	isLoaded ()

	getCurPage ($displacement=0)

	getLastPageNumber ()

	getPageSize ()

	getSize ()

	getFirstItem ()

	getLastItem ()

	getItems ()

	getColumnValues ($colName)

	getItemsByColumnValue ($column, $value)

	getItemByColumnValue ($column, $value)

	addItem (\Magento\Framework\DataObject $item)

	getAllIds ()

	removeItemByKey ($key)

	removeAllItems ()

	clear ()

	walk ($callback, array $args=[])

	each ($objMethod, $args=[])

	setDataToAll ($key, $value=null)

	setCurPage ($page)

	setPageSize ($size)

	setOrder ($field, $direction=self::SORT_ORDER_DESC)

	setItemObjectClass ($className)

	getNewEmptyItem ()

	distinct ($flag)

	loadData ($printQuery=false, $logQuery=false)

	load ($printQuery=false, $logQuery=false)

	loadWithFilter ($printQuery=false, $logQuery=false)

	toXml ()

	toArray ($arrRequiredFields=[])

	toOptionArray ()

	toOptionHash ()

	getItemById ($idValue)

	getIterator ()

	count ()

	getFlag ($flag)

	setFlag ($flag, $value=null)

	hasFlag ($flag)

	__sleep ()

	__wakeup ()

Public Member Functions inherited from SourceProviderInterface
	getIdFieldName ()

	addFieldToFilter ($attribute, $condition=null)

Protected Member Functions
	_construct ()

Protected Member Functions inherited from AbstractCollection
	_construct ()

	_initSelect ()

	_initSelectFields ()

	_getInitialFieldsToSelect ()

	_initInitialFieldsToSelect ()

	_init ($model, $resourceModel)

	_beforeLoad ()

	_afterLoad ()

Protected Member Functions inherited from AbstractDb
	_setIdFieldName ($fieldName)

	_getItemId (\Magento\Framework\DataObject $item)

	_renderFilters ()

	_renderFiltersBefore ()

	_translateCondition ($field, $condition)

	_getMappedField ($field)

	_getMapper ()

	_getConditionSql ($fieldName, $condition)

	_getConditionFieldName ($fieldName)

	_renderOrders ()

	_renderLimit ()

	_beforeLoad ()

	beforeAddLoadedItem (\Magento\Framework\DataObject $item)

	_toOptionArray ($valueField=null, $labelField='name', $additional=[])

	_toOptionHash ($valueField=null, $labelField='name')

	_afterLoadData ()

	_afterLoad ()

	_logQuery ($sql)

	_reset ()

	_fetchAll (Select $select)

	_initSelect ()

Protected Member Functions inherited from Collection
	_setIsLoaded ($flag=true)

	_addItem ($item)

	_getItemId (\Magento\Framework\DataObject $item)

	_renderFilters ()

	_renderOrders ()

	_renderLimit ()

	_toOptionArray ($valueField='id', $labelField='name', $additional=[])

	_toOptionHash ($valueField='id', $labelField='name')

Protected Attributes
	$_eventPrefix = 'store_collection'

	$_eventObject = 'store_collection'

Protected Attributes inherited from AbstractCollection
	$_model

	$_resourceModel

	$_resource

	$_fieldsToSelect = null

	$_initialFieldsToSelect = null

	$_fieldsToSelectChanged = false

	$_joinedTables = []

	$_mainTable = null

	$_resetItemsDataChanged = false

	$_eventPrefix = ''

	$_eventObject = ''

	$_eventManager = null

Protected Attributes inherited from AbstractDb
	$_conn

	$_select

	$_idFieldName

	$_bindParams = []

	$_data = null

	$_map = null

	$_fetchStmt = null

	$_isOrdersRendered = false

	$_logger

	$extensionAttributesJoinProcessor

Protected Attributes inherited from Collection
	$_items = []

	$_itemObjectClass = \Magento\Framework\DataObject::class

	$_orders = []

	$_filters = []

	$_isFiltersRendered = false

	$_curPage = 1

	$_pageSize = false

	$_totalRecords

	$_isCollectionLoaded

	$_flags = []

	$_entityFactory

Additional Inherited Members
Data Fields inherited from Collection
const	SORT_ORDER_ASC = 'ASC'

const	SORT_ORDER_DESC = 'DESC'

Detailed Description

Stores collection

@api

Since: 100.0.2

Definition at line 14 of file Collection.php.

Member Function Documentation

◆ _construct()

_construct ( )

protected

Define resource model

Returns: void

Definition at line 35 of file Collection.php.

     {
         $this->setFlag('load_default_store', false);
         $this->_init(\Magento\Store\Model\Store::class, \Magento\Store\Model\ResourceModel\Store::class);
     }

◆ addCategoryFilter()

addCategoryFilter ( $category )

Add root category id filter to store collection

Parameters

int | array $category

Returns: $this

Definition at line 127 of file Collection.php.

     {
         if (!is_array($category)) {
             $category = [$category];
         }
         return $this->loadByCategoryIds($category);
     }

◆ addGroupFilter()

addGroupFilter ( $groupId )

Add filter by group id. Group id can be passed as one single value or array of values.

Parameters

int | array $groupId

Returns: $this

Definition at line 82 of file Collection.php.

     {
         return $this->addFieldToFilter('main_table.group_id', ['in' => $groupId]);
     }

◆ addIdFilter()

addIdFilter ( $store )

Add store id(s) filter to collection

Parameters

int | array $store

Returns: $this

Definition at line 105 of file Collection.php.

     {
         return $this->addFieldToFilter('main_table.store_id', ['in' => $store]);
     }

◆ addRootCategoryIdAttribute()

addRootCategoryIdAttribute ( )

Add store root category data to collection

Returns: $this

Definition at line 202 of file Collection.php.

     {
         if (!$this->getFlag('store_group_table_joined')) {
             $this->getSelect()->join(
                 ['group_table' => $this->getTable('store_group')],
                 'main_table.group_id = group_table.group_id',
                 ['root_category_id']
             );
             $this->setFlag('store_group_table_joined', true);
         }
 
         return $this;
     }

◆ addStatusFilter()

addStatusFilter ( $status )

Add filter by status to collection

Parameters

int $status

Returns: $this

Since: 100.1.0

Definition at line 94 of file Collection.php.

     {
         return $this->addFieldToFilter('main_table.is_active', ['eq' => $status]);
     }

◆ addWebsiteFilter()

addWebsiteFilter ( $website )

Add filter by website to collection

Parameters

int | array $website

Returns: $this

Definition at line 116 of file Collection.php.

     {
         return $this->addFieldToFilter('main_table.website_id', ['in' => $website]);
     }

◆ getLoadDefault()

getLoadDefault ( )

Is load default (admin) store

Returns: bool @SuppressWarnings(PHPMD.BooleanGetMethodName)

Definition at line 59 of file Collection.php.

     {
         return $this->getFlag('load_default_store');
     }

◆ load()

load	(	$printQuery = `false`,
		$logQuery = `false`
	)

Load collection data

Parameters

bool	$printQuery
bool	$logQuery

Returns: $this

Definition at line 162 of file Collection.php.

     {
         if (!$this->getLoadDefault()) {
             $this->setWithoutDefaultFilter();
         }
 
         if (!$this->isLoaded()) {
             $this->addOrder(
                 'CASE WHEN main_table.store_id = 0 THEN 0 ELSE 1 END',
                 \Magento\Framework\DB\Select::SQL_ASC
             )->addOrder(
                 'main_table.sort_order',
                 \Magento\Framework\DB\Select::SQL_ASC
             )->addOrder(
                 'main_table.name',
                 \Magento\Framework\DB\Select::SQL_ASC
             );
         }
         return parent::load($printQuery, $logQuery);
     }

◆ loadByCategoryIds()

loadByCategoryIds ( array $categories )

Add root category id filter to store collection

Parameters

array $categories

Returns: $this

Definition at line 189 of file Collection.php.

     {
         $this->addRootCategoryIdAttribute();
         $this->addFieldToFilter('group_table.root_category_id', ['in' => $categories]);
 
         return $this;
     }

◆ setLoadDefault()

setLoadDefault ( $loadDefault )

Set flag for load default (admin) store

Parameters

bool $loadDefault

Returns: $this

Definition at line 47 of file Collection.php.

     {
         $this->setFlag('load_default_store', (bool)$loadDefault);
         return $this;
     }

◆ setWithoutDefaultFilter()

setWithoutDefaultFilter ( )

Add disable default store filter to collection

Returns: $this

Definition at line 69 of file Collection.php.

     {
         $this->addFieldToFilter('main_table.store_id', ['gt' => 0]);
         return $this;
     }

◆ toOptionArray()

toOptionArray ( )

Convert items array to array for select options

Returns: array

Implements OptionSourceInterface.

Definition at line 140 of file Collection.php.

     {
         return $this->_toOptionArray('store_id', 'name');
     }

◆ toOptionHash()

toOptionHash ( )

Convert items array to hash for select options

Returns: array

Definition at line 150 of file Collection.php.

     {
         return $this->_toOptionHash('store_id', 'name');
     }

Field Documentation

◆ $_eventObject

$_eventObject = 'store_collection'

protected

Definition at line 28 of file Collection.php.

◆ $_eventPrefix

$_eventPrefix = 'store_collection'

protected

Definition at line 21 of file Collection.php.

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

vendor/magento/module-store/Model/ResourceModel/Store/Collection.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ _construct()

◆ addCategoryFilter()

◆ addGroupFilter()

◆ addIdFilter()

◆ addRootCategoryIdAttribute()

◆ addStatusFilter()

◆ addWebsiteFilter()

◆ getLoadDefault()

◆ load()

◆ loadByCategoryIds()

◆ setLoadDefault()

◆ setWithoutDefaultFilter()

◆ toOptionArray()

◆ toOptionHash()

Field Documentation

◆ $_eventObject

◆ $_eventPrefix