Inheritance diagram for AbstractCollection:

Public Member Functions
	setSelectCountSql (\Magento\Framework\DB\Select $countSelect)

	getSelectCountSql ()

	addAttributeToSelect ($attribute)

	addAttributeToFilter ($attribute, $condition=null)

	addAttributeToSort ($attribute, $dir='asc')

	setPage ($pageNum, $pageSize)

	getAllIds ($limit=null, $offset=null)

	getSearchCriteria ()

	setSearchCriteria (\Magento\Framework\Api\SearchCriteriaInterface $searchCriteria=null)

	getTotalCount ()

	setTotalCount ($totalCount)

	setItems (array $items=null)

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

	fetchItem ()

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
	_attributeToField ($attribute)

	_getAllIdsSelect ($limit=null, $offset=null)

Protected Member Functions inherited from Collection
	beforeAddLoadedItem (\Magento\Framework\DataObject $item)

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

	$searchCriteria

Protected Attributes inherited from Collection
	$entitySnapshot

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

Flat sales abstract collection

@api @SuppressWarnings(PHPMD.CouplingBetweenObjects)

Since: 100.0.2

Definition at line 15 of file AbstractCollection.php.

Member Function Documentation

◆ _attributeToField()

_attributeToField ( $attribute )

protected

Check if $attribute is \Magento\Eav\Model\Entity\Attribute and convert to string field name

Parameters

string | \Magento\Eav\Model\Entity\Attribute $attribute

Returns: string

Exceptions

Definition at line 59 of file AbstractCollection.php.

     {
         $field = false;
         if (is_string($attribute)) {
             $field = $attribute;
         } elseif ($attribute instanceof \Magento\Eav\Model\Entity\Attribute) {
             $field = $attribute->getAttributeCode();
         }
         if (!$field) {
             throw new \Magento\Framework\Exception\LocalizedException(__('We cannot determine the field name.'));
         }
         return $field;
     }

◆ _getAllIdsSelect()

_getAllIdsSelect	(	$limit = `null`,
		$offset = `null`
	)

protected

Create all ids retrieving select with limitation Backward compatibility with EAV collection

Parameters

int	$limit
int	$offset

Returns: \Magento\Eav\Model\Entity\Collection\AbstractCollection

Definition at line 136 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');
         $idsSelect->limit($limit, $offset);
         return $idsSelect;
     }

◆ addAttributeToFilter()

addAttributeToFilter	(	$attribute,
		$condition = `null`
	)

Specify collection select filter by attribute value Backward compatibility with EAV collection

Parameters

string \| \Magento\Eav\Model\Entity\Attribute	$attribute
array \| int \| string \| null	$condition

Returns: $this

Definition at line 94 of file AbstractCollection.php.

     {
         $this->addFieldToFilter($this->_attributeToField($attribute), $condition);
         return $this;
     }

◆ addAttributeToSelect()

addAttributeToSelect ( $attribute )

Add attribute to select result set. Backward compatibility with EAV collection

Parameters

string $attribute

Returns: $this

Definition at line 80 of file AbstractCollection.php.

     {
         $this->addFieldToSelect($this->_attributeToField($attribute));
         return $this;
     }

◆ addAttributeToSort()

addAttributeToSort	(	$attribute,
		$dir = `'asc'`
	)

Specify collection select order by attribute value Backward compatibility with EAV collection

Parameters

string	$attribute
string	$dir

Returns: $this

Definition at line 108 of file AbstractCollection.php.

     {
         $this->addOrder($this->_attributeToField($attribute), $dir);
         return $this;
     }

◆ getAllIds()

getAllIds	(	$limit = `null`,
		$offset = `null`
	)

Retrieve all ids for collection Backward compatibility with EAV collection

Parameters

int	$limit
int	$offset

Returns: array

Definition at line 156 of file AbstractCollection.php.

     {
         return $this->getConnection()->fetchCol($this->_getAllIdsSelect($limit, $offset), $this->_bindParams);
     }

◆ getSearchCriteria()

getSearchCriteria ( )

Get search criteria.

Returns: \Magento\Framework\Api\SearchCriteriaInterface|null

Definition at line 166 of file AbstractCollection.php.

     {
         return $this->searchCriteria;
     }

◆ getSelectCountSql()

getSelectCountSql ( )

get select count sql

Returns: \Magento\Framework\DB\Select

Definition at line 44 of file AbstractCollection.php.

     {
         if (!$this->_countSelect instanceof \Magento\Framework\DB\Select) {
             $this->setSelectCountSql(parent::getSelectCountSql());
         }
         return $this->_countSelect;
     }

◆ getTotalCount()

getTotalCount ( )

Get total count.

Returns: int

Definition at line 189 of file AbstractCollection.php.

     {
         return $this->getSize();
     }

◆ setItems()

setItems ( array $items = null )

Set items list.

Parameters

Definition at line 212 of file AbstractCollection.php.

     {
         if (!$items) {
             return $this;
         }
         foreach ($items as $item) {
             $this->addItem($item);
         }
         return $this;
     }

◆ setPage()

setPage	(	$pageNum,
		$pageSize
	)

Set collection page start and records to show Backward compatibility with EAV collection

Parameters

int	$pageNum
int	$pageSize

Returns: $this

Definition at line 122 of file AbstractCollection.php.

     {
         $this->setCurPage($pageNum)->setPageSize($pageSize);
         return $this;
     }

◆ setSearchCriteria()

setSearchCriteria ( \Magento\Framework\Api\SearchCriteriaInterface $searchCriteria = null )

Set search criteria.

Parameters

\Magento\Framework\Api\SearchCriteriaInterface $searchCriteria

Returns: $this @SuppressWarnings(PHPMD.UnusedFormalParameter)

Definition at line 178 of file AbstractCollection.php.

     {
         $this->searchCriteria = $searchCriteria;
         return $this;
     }

◆ setSelectCountSql()

setSelectCountSql ( \Magento\Framework\DB\Select $countSelect )

Set select count sql

Parameters

\Magento\Framework\DB\Select $countSelect

Returns: $this

Definition at line 33 of file AbstractCollection.php.

     {
         $this->_countSelect = $countSelect;
         return $this;
     }

◆ setTotalCount()

setTotalCount ( $totalCount )

Set total count.

Parameters

int $totalCount

Returns: $this @SuppressWarnings(PHPMD.UnusedFormalParameter)

Definition at line 201 of file AbstractCollection.php.

     {
         return $this;
     }

Field Documentation

◆ $_countSelect

$_countSelect

protected

Definition at line 20 of file AbstractCollection.php.

◆ $searchCriteria

$searchCriteria

protected

Definition at line 25 of file AbstractCollection.php.

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

vendor/magento/module-sales/Model/ResourceModel/Collection/AbstractCollection.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ _attributeToField()

◆ _getAllIdsSelect()

◆ addAttributeToFilter()

◆ addAttributeToSelect()

◆ addAttributeToSort()

◆ getAllIds()

◆ getSearchCriteria()

◆ getSelectCountSql()

◆ getTotalCount()

◆ setItems()

◆ setPage()

◆ setSearchCriteria()

◆ setSelectCountSql()

◆ setTotalCount()

Field Documentation

◆ $_countSelect

◆ $searchCriteria