Inheritance diagram for AbstractCollection:

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

	addOrderStatusFilter ($orderStatus)

Public Member Functions inherited from AbstractCollection
	setAggregatedColumns (array $columns)

	getAggregatedColumns ()

	setDateRange ($from=null, $to=null)

	setPeriod ($period)

	addStoreFilter ($storeIds)

	isTotals ($flag=null)

	isSubTotals ()

	setIsSubTotals ($flag)

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
	_applyOrderStatusFilter ()

	_applyCustomFilter ()

Protected Member Functions inherited from AbstractCollection
	_applyAggregatedTable ()

	_applyDateRangeFilter ()

	_applyStoresFilterToSelect (\Magento\Framework\DB\Select $select)

	_applyStoresFilter ()

	_applyCustomFilter ()

	_initSelect ()

	_beforeLoad ()

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
	$_orderStatus = null

Protected Attributes inherited from AbstractCollection
	$_from = null

	$_to = null

	$_period = null

	$_storesIds = 0

	$_isTotals = false

	$_isSubTotals = false

	$_aggregatedColumns = []

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

Report collection abstract model

Author: Magento Core Team core@.nosp@m.mage.nosp@m.ntoco.nosp@m.mmer.nosp@m.ce.co.nosp@m.m

Definition at line 13 of file AbstractCollection.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	\Magento\Framework\Data\Collection\EntityFactory	$entityFactory,
		\Psr\Log\LoggerInterface	$logger,
		\Magento\Framework\Data\Collection\Db\FetchStrategyInterface	$fetchStrategy,
		\Magento\Framework\Event\ManagerInterface	$eventManager,
		\Magento\Sales\Model\ResourceModel\Report	$resource,
		\Magento\Framework\DB\Adapter\AdapterInterface	$connection = `null`
	)

Parameters

\Magento\Framework\Data\Collection\EntityFactory	$entityFactory
\Psr\Log\LoggerInterface	$logger
\Magento\Framework\Data\Collection\Db\FetchStrategyInterface	$fetchStrategy
\Magento\Framework\Event\ManagerInterface	$eventManager
\Magento\Sales\Model\ResourceModel\Report	$resource
null	$connection

Definition at line 30 of file AbstractCollection.php.

       {
         parent::__construct($entityFactory, $logger, $fetchStrategy, $eventManager, $connection, $resource);
         $this->setModel(\Magento\Reports\Model\Item::class);
     }

Member Function Documentation

◆ _applyCustomFilter()

_applyCustomFilter ( )

protected

Order status filter is custom for this collection

Returns: $this

Definition at line 77 of file AbstractCollection.php.

     {
         return $this->_applyOrderStatusFilter();
     }

◆ _applyOrderStatusFilter()

_applyOrderStatusFilter ( )

protected

Apply order status filter

Returns: $this

Definition at line 59 of file AbstractCollection.php.

     {
         if ($this->_orderStatus === null) {
             return $this;
         }
         $orderStatus = $this->_orderStatus;
         if (!is_array($orderStatus)) {
             $orderStatus = [$orderStatus];
         }
         $this->getSelect()->where('order_status IN(?)', $orderStatus);
         return $this;
     }

◆ addOrderStatusFilter()

addOrderStatusFilter ( $orderStatus )

Set status filter

Parameters

string $orderStatus

Returns: $this

Definition at line 48 of file AbstractCollection.php.

     {
         $this->_orderStatus = $orderStatus;
         return $this;
     }

Field Documentation

◆ $_orderStatus

$_orderStatus = null

protected

Definition at line 20 of file AbstractCollection.php.

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _applyCustomFilter()

◆ _applyOrderStatusFilter()

◆ addOrderStatusFilter()

Field Documentation

◆ $_orderStatus