Inheritance diagram for AbstractCollection:

Public Member Functions
	__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 ()

	_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
	$_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

Abstract Resource Collection

@api @SuppressWarnings(PHPMD.NumberOfChildren)

Since: 100.0.2

Definition at line 19 of file AbstractCollection.php.

Constructor & Destructor Documentation

◆ __construct()

__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`
	)

Parameters

\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
\Magento\Framework\Model\ResourceModel\Db\AbstractDb	$resource

Definition at line 113 of file AbstractCollection.php.

       {
         $this->_eventManager = $eventManager;
         parent::__construct($entityFactory, $logger, $fetchStrategy, $connection);
         $this->_construct();
         $this->_resource = $resource;
         $this->setConnection($this->getResource()->getConnection());
         $this->_initSelect();
     }

Member Function Documentation

◆ __sleep()

__sleep ( )

Since: 100.0.11

Definition at line 603 of file AbstractCollection.php.

     {
         return array_diff(
             parent::__sleep(),
             ['_resource', '_eventManager']
         );
     }

◆ __wakeup()

__wakeup ( )

Since: 100.0.11

Definition at line 615 of file AbstractCollection.php.

     {
         parent::__wakeup();
         $objectManager = \Magento\Framework\App\ObjectManager::getInstance();
         $this->_eventManager = $objectManager->get(\Magento\Framework\Event\ManagerInterface::class);
     }

◆ _afterLoad()

_afterLoad ( )

protected

Redeclare after load method for specifying collection items original data

Returns: $this

Definition at line 570 of file AbstractCollection.php.

     {
         parent::_afterLoad();
         foreach ($this->_items as $item) {
             $item->setOrigData();
             if ($this->_resetItemsDataChanged && ($item instanceof \Magento\Framework\Model\AbstractModel)) {
                 $item->setDataChanges(false);
             }
         }
         $this->_eventManager->dispatch('core_collection_abstract_load_after', ['collection' => $this]);
         if ($this->_eventPrefix && $this->_eventObject) {
             $this->_eventManager->dispatch($this->_eventPrefix . '_load_after', [$this->_eventObject => $this]);
         }
         return $this;
     }

◆ _beforeLoad()

_beforeLoad ( )

protected

Redeclare before load method for adding event

Returns: $this

Definition at line 529 of file AbstractCollection.php.

     {
         parent::_beforeLoad();
         $this->_eventManager->dispatch('core_collection_abstract_load_before', ['collection' => $this]);
         if ($this->_eventPrefix && $this->_eventObject) {
             $this->_eventManager->dispatch($this->_eventPrefix . '_load_before', [$this->_eventObject => $this]);
         }
         return $this;
     }

◆ _construct()

_construct ( )

protected

Initialization here

Returns: void

Definition at line 134 of file AbstractCollection.php.

135 {

136 }

◆ _getInitialFieldsToSelect()

_getInitialFieldsToSelect ( )

protected

Retrieve initial fields to select like id field

Returns: array

Definition at line 264 of file AbstractCollection.php.

     {
         if ($this->_initialFieldsToSelect === null) {
             $this->_initialFieldsToSelect = [];
             $this->_initInitialFieldsToSelect();
         }
 
         return $this->_initialFieldsToSelect;
     }

◆ _init()

_init	(	$model,
		$resourceModel
	)

protected

Standard resource collection initialization

Parameters

string	$model
string	$resourceModel

Returns: $this

Definition at line 401 of file AbstractCollection.php.

     {
         $this->setModel($model);
         $this->setResourceModel($resourceModel);
         return $this;
     }

◆ _initInitialFieldsToSelect()

_initInitialFieldsToSelect ( )

protected

Initialize initial fields to select like id field

Returns: $this

Definition at line 279 of file AbstractCollection.php.

     {
         $idFieldName = $this->getResource()->getIdFieldName();
         if ($idFieldName) {
             $this->_initialFieldsToSelect[] = $idFieldName;
         }
         return $this;
     }

◆ _initSelect()

_initSelect ( )

protected

{}

Definition at line 176 of file AbstractCollection.php.

     {
         $this->getSelect()->from(['main_table' => $this->getMainTable()]);
         return $this;
     }

◆ _initSelectFields()

_initSelectFields ( )

protected

Init fields for select

Returns: $this @SuppressWarnings(PHPMD.CyclomaticComplexity) @SuppressWarnings(PHPMD.NPathComplexity)

Definition at line 203 of file AbstractCollection.php.

     {
         $columns = $this->_select->getPart(\Magento\Framework\DB\Select::COLUMNS);
         $columnsToSelect = [];
         foreach ($columns as $columnEntry) {
             list($correlationName, $column, $alias) = $columnEntry;
             if ($correlationName !== 'main_table') {
                 // Add joined fields to select
                 if ($column instanceof \Zend_Db_Expr) {
                     $column = $column->__toString();
                 }
                 $key = $alias !== null ? $alias : $column;
                 $columnsToSelect[$key] = $columnEntry;
             }
         }
 
         $columns = $columnsToSelect;
 
         $columnsToSelect = array_keys($columnsToSelect);
 
         if ($this->_fieldsToSelect !== null) {
             $insertIndex = 0;
             foreach ($this->_fieldsToSelect as $alias => $field) {
                 if (!is_string($alias)) {
                     $alias = null;
                 }
 
                 if ($field instanceof \Zend_Db_Expr) {
                     $column = $field->__toString();
                 } else {
                     $column = $field;
                 }
 
                 if ($alias !== null &&
                     in_array($alias, $columnsToSelect) ||
                     // If field already joined from another table
                     $alias === null &&
                     isset($alias, $columnsToSelect)
                 ) {
                     continue;
                 }
 
                 $columnEntry = ['main_table', $field, $alias];
                 array_splice($columns, $insertIndex, 0, [$columnEntry]);
                 // Insert column
                 $insertIndex++;
             }
         } else {
             array_unshift($columns, ['main_table', '*', null]);
         }
 
         $this->_select->setPart(\Magento\Framework\DB\Select::COLUMNS, $columns);
 
         return $this;
     }

◆ addExpressionFieldToSelect()

addExpressionFieldToSelect	(	$alias,
		$expression,
		$fields
	)

Add attribute expression (SUM, COUNT, etc) Example: ('sub_total', 'SUM({{attribute}})', 'revenue') Example: ('sub_total', 'SUM({{revenue}})', 'revenue') For some functions like SUM use groupByAttribute.

Parameters

string	$alias
string	$expression
array \| string	$fields

Returns: $this

Definition at line 338 of file AbstractCollection.php.

     {
         // validate alias
         if (!is_array($fields)) {
             $fields = [$fields => $fields];
         }
 
         $fullExpression = $expression;
         foreach ($fields as $fieldKey => $fieldItem) {
             $fullExpression = str_replace('{{' . $fieldKey . '}}', $fieldItem, $fullExpression);
         }
 
         $this->getSelect()->columns([$alias => $fullExpression]);
 
         return $this;
     }

◆ addFieldToSelect()

addFieldToSelect	(	$field,
		$alias = `null`
	)

Add field to select

Parameters

string \| array	$field
string \| null	$alias

Returns: $this

Implements SourceProviderInterface.

Definition at line 295 of file AbstractCollection.php.

     {
         if ($field === '*') {
             // If we will select all fields
             $this->_fieldsToSelect = null;
             $this->_fieldsToSelectChanged = true;
             return $this;
         }
 
         if (is_array($field)) {
             if ($this->_fieldsToSelect === null) {
                 $this->_fieldsToSelect = $this->_getInitialFieldsToSelect();
             }
 
             foreach ($field as $key => $value) {
                 $this->addFieldToSelect($value, is_string($key) ? $key : null);
             }
 
             $this->_fieldsToSelectChanged = true;
             return $this;
         }
 
         if ($alias === null) {
             $this->_fieldsToSelect[] = $field;
         } else {
             $this->_fieldsToSelect[$alias] = $field;
         }
 
         $this->_fieldsToSelectChanged = true;
         return $this;
     }

◆ getAllIds()

getAllIds ( )

Retrieve all ids for collection

Returns: array

Definition at line 485 of file AbstractCollection.php.

     {
         $idsSelect = clone $this->getSelect();
         $idsSelect->reset(\Magento\Framework\DB\Select::ORDER);
         $idsSelect->reset(\Magento\Framework\DB\Select::LIMIT_COUNT);
         $idsSelect->reset(\Magento\Framework\DB\Select::LIMIT_OFFSET);
         $idsSelect->reset(\Magento\Framework\DB\Select::COLUMNS);
 
         $idsSelect->columns($this->getResource()->getIdFieldName(), 'main_table');
         return $this->getConnection()->fetchCol($idsSelect, $this->_bindParams);
     }

◆ getMainTable()

getMainTable ( )

Retrieve main table

Returns: string

Implements SourceProviderInterface.

Definition at line 143 of file AbstractCollection.php.

     {
         if ($this->_mainTable === null) {
             $this->setMainTable($this->getResource()->getMainTable());
         }
 
         return $this->_mainTable;
     }

◆ getModelName()

getModelName ( )

Get model instance

Returns: string

Definition at line 428 of file AbstractCollection.php.

     {
         return $this->_model;
     }

◆ getResource()

getResource ( )

Get resource instance

Returns: \Magento\Framework\Model\ResourceModel\Db\AbstractDb

Definition at line 459 of file AbstractCollection.php.

     {
         if (empty($this->_resource)) {
             $this->_resource = \Magento\Framework\App\ObjectManager::getInstance()->create(
                 $this->getResourceModelName()
             );
         }
         return $this->_resource;
     }

◆ getResourceModelName()

getResourceModelName ( )

Retrieve resource model name

Returns: string

Definition at line 449 of file AbstractCollection.php.

     {
         return $this->_resourceModel;
     }

◆ getSelect()

getSelect ( )

Get \Magento\Framework\DB\Select instance and applies fields to select if needed

Returns: \Magento\Framework\DB\Select

Implements SourceProviderInterface.

Definition at line 187 of file AbstractCollection.php.

     {
         if ($this->_select && $this->_fieldsToSelectChanged) {
             $this->_fieldsToSelectChanged = false;
             $this->_initSelectFields();
         }
         return parent::getSelect();
     }

◆ getTable()

getTable ( $table )

Retrieve table name

Parameters

string $table

Returns: string

Definition at line 475 of file AbstractCollection.php.

     {
         return $this->getResource()->getTable($table);
     }

◆ join()

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

Join table to collection select

Parameters

string \| array	$table
string	$cond
string \| array	$cols

Returns: $this

Definition at line 505 of file AbstractCollection.php.

     {
         if (is_array($table)) {
             foreach ($table as $k => $v) {
                 $alias = $k;
                 $table = $v;
                 break;
             }
         } else {
             $alias = $table;
         }
 
         if (!isset($this->_joinedTables[$alias])) {
             $this->getSelect()->join([$alias => $this->getTable($table)], $cond, $cols);
             $this->_joinedTables[$alias] = true;
         }
         return $this;
     }

◆ removeAllFieldsFromSelect()

removeAllFieldsFromSelect ( )

Removes all fields from select

Returns: $this

Definition at line 387 of file AbstractCollection.php.

     {
         $this->_fieldsToSelect = $this->_getInitialFieldsToSelect();
         $this->_fieldsToSelectChanged = true;
         return $this;
     }

◆ removeFieldFromSelect()

removeFieldFromSelect	(	$field,
		$isAlias = `false`
	)

Removes field from select

Parameters

string \| null	$field
bool	$isAlias	Alias identifier

Returns: $this

Definition at line 362 of file AbstractCollection.php.

     {
         if ($isAlias) {
             if (isset($this->_fieldsToSelect[$field])) {
                 unset($this->_fieldsToSelect[$field]);
                 $this->_fieldsToSelectChanged = true;
             }
         } else {
             foreach ($this->_fieldsToSelect as $key => $value) {
                 if ($value === $field) {
                     unset($this->_fieldsToSelect[$key]);
                     $this->_fieldsToSelectChanged = true;
                     break;
                 }
             }
         }
 
         return $this;
     }

◆ resetItemsDataChanged()

resetItemsDataChanged ( )

Set flag data has changed to all collection items

Returns: $this

Definition at line 556 of file AbstractCollection.php.

     {
         foreach ($this->_items as $item) {
             $item->setDataChanges(false);
         }
 
         return $this;
     }

◆ save()

save ( )

Save all the entities in the collection

Returns: $this

Definition at line 591 of file AbstractCollection.php.

     {
         foreach ($this->getItems() as $item) {
             $item->save();
         }
         return $this;
     }

◆ setMainTable()

setMainTable ( $table )

Set main collection table

Parameters

string $table

Returns: $this

Definition at line 158 of file AbstractCollection.php.

     {
         $table = $this->getTable($table);
         if ($this->_mainTable !== null && $table !== $this->_mainTable && $this->getSelect() !== null) {
             $from = $this->getSelect()->getPart(\Magento\Framework\DB\Select::FROM);
             if (isset($from['main_table'])) {
                 $from['main_table']['tableName'] = $table;
             }
             $this->getSelect()->setPart(\Magento\Framework\DB\Select::FROM, $from);
         }
 
         $this->_mainTable = $table;
         return $this;
     }

◆ setModel()

setModel ( $model )

Set model name for collection items

Parameters

string $model

Returns: $this

Definition at line 414 of file AbstractCollection.php.

     {
         if (is_string($model)) {
             $this->_model = $model;
             $this->setItemObjectClass($model);
         }
         return $this;
     }

◆ setResetItemsDataChanged()

setResetItemsDataChanged ( $flag )

Set reset items data changed flag

Parameters

bool $flag

Returns: $this

Definition at line 545 of file AbstractCollection.php.

     {
         $this->_resetItemsDataChanged = (bool)$flag;
         return $this;
     }

◆ setResourceModel()

setResourceModel ( $model )

Set resource model name for collection items

Parameters

string $model

Returns: void

Definition at line 439 of file AbstractCollection.php.

     {
         $this->_resourceModel = $model;
     }

Field Documentation

◆ $_eventManager

$_eventManager = null

protected

Definition at line 103 of file AbstractCollection.php.

◆ $_eventObject

$_eventObject = ''

protected

Definition at line 96 of file AbstractCollection.php.

◆ $_eventPrefix

$_eventPrefix = ''

protected

Definition at line 89 of file AbstractCollection.php.

◆ $_fieldsToSelect

$_fieldsToSelect = null

protected

Definition at line 47 of file AbstractCollection.php.

◆ $_fieldsToSelectChanged

$_fieldsToSelectChanged = false

protected

Definition at line 61 of file AbstractCollection.php.

◆ $_initialFieldsToSelect

$_initialFieldsToSelect = null

protected

Definition at line 54 of file AbstractCollection.php.

◆ $_joinedTables

$_joinedTables = []

protected

Definition at line 68 of file AbstractCollection.php.

◆ $_mainTable

$_mainTable = null

protected

Definition at line 75 of file AbstractCollection.php.

◆ $_model

$_model

protected

Definition at line 26 of file AbstractCollection.php.

◆ $_resetItemsDataChanged

$_resetItemsDataChanged = false

protected

Definition at line 82 of file AbstractCollection.php.

◆ $_resource

$_resource

protected

Definition at line 40 of file AbstractCollection.php.

◆ $_resourceModel

$_resourceModel

protected

Definition at line 33 of file AbstractCollection.php.

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

vendor/magento/framework/Model/ResourceModel/Db/Collection/AbstractCollection.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __sleep()

◆ __wakeup()

◆ _afterLoad()

◆ _beforeLoad()

◆ _construct()

◆ _getInitialFieldsToSelect()

◆ _init()

◆ _initInitialFieldsToSelect()

◆ _initSelect()

◆ _initSelectFields()

◆ addExpressionFieldToSelect()

◆ addFieldToSelect()

◆ getAllIds()

◆ getMainTable()

◆ getModelName()

◆ getResource()

◆ getResourceModelName()

◆ getSelect()

◆ getTable()

◆ join()

◆ removeAllFieldsFromSelect()

◆ removeFieldFromSelect()

◆ resetItemsDataChanged()

◆ save()

◆ setMainTable()

◆ setModel()

◆ setResetItemsDataChanged()

◆ setResourceModel()

Field Documentation

◆ $_eventManager

◆ $_eventObject

◆ $_eventPrefix

◆ $_fieldsToSelect

◆ $_fieldsToSelectChanged

◆ $_initialFieldsToSelect

◆ $_joinedTables

◆ $_mainTable

◆ $_model

◆ $_resetItemsDataChanged

◆ $_resource

◆ $_resourceModel