Inheritance diagram for Collection:

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\Framework\Model\ResourceModel\Db\VersionControl\Snapshot $entitySnapshot, \Magento\Framework\DB\Helper $coreResourceHelper, \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig, \Magento\Store\Model\StoreManagerInterface $storeManager, \Magento\Framework\Stdlib\DateTime\TimezoneInterface $localeDate, \Magento\Sales\Model\Order\Config $orderConfig, \Magento\Sales\Model\ResourceModel\Report\OrderFactory $reportOrderFactory, \Magento\Framework\DB\Adapter\AdapterInterface $connection=null, \Magento\Framework\Model\ResourceModel\Db\AbstractDb $resource=null)

	checkIsLive ($range)

	isLive ()

	prepareSummary ($range, $customStart, $customEnd, $isFilter=0)

	getDateRange ($range, $customStart, $customEnd, $returnObjects=false)

	addItemCountExpr ()

	calculateTotals ($isFilter=0)

	calculateSales ($isFilter=0)

	setDateRange ($fromDate, $toDate)

	setStoreIds ($storeIds)

	groupByCustomer ()

	joinCustomerName ($alias='name')

	addOrdersCount ()

	addRevenueToSelect ($convertCurrency=false)

	addSumAvgTotals ($storeId=0)

	orderByTotalAmount ($dir=self::SORT_ORDER_DESC)

	orderByOrdersCount ($dir=self::SORT_ORDER_DESC)

	orderByCustomerRegistration ($dir=self::SORT_ORDER_DESC)

	orderByCreatedAt ($dir=self::SORT_ORDER_DESC)

	getSelectCountSql ()

	addCreateAtPeriodFilter ($period)

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

	addItemCountExpr ()

	getSelectCountSql ()

	addAddressFields ()

	addFieldToSearchFilter ($field, $condition=null)

	addAttributeToSearchFilter ($attributes, $condition=null)

	addBillingAgreementsFilter ($agreements)

Public Member Functions inherited from AbstractCollection
	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)

Public Member Functions inherited from OrderSearchResultInterface
	getItems ()

	setItems (array $items=null)

Public Member Functions inherited from SearchResultsInterface
	getSearchCriteria ()

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

	getTotalCount ()

	setTotalCount ($totalCount)

Protected Member Functions
	_getSalesAmountExpression ()

	_prepareSummaryLive ($range, $customStart, $customEnd, $isFilter=0)

	_prepareSummaryAggregated ($range, $customStart, $customEnd)

	_getRangeExpression ($range)

	_getRangeExpressionForAttribute ($range, $attribute)

	_getTZRangeOffsetExpression ($range, $attribute, $from=null, $to=null)

	_getTZRangeExpressionForAttribute ($range, $attribute, $tzFrom='+00:00', $tzTo=null)

	_calculateTotalsLive ($isFilter=0)

	_calculateTotalsAggregated ($isFilter=0)

	getTotalsExpression ( $storeId, $baseSubtotalRefunded, $baseSubtotalCanceled, $baseDiscountCanceled)

	_initInitialFieldsToSelect ()

Protected Member Functions inherited from Collection
	_construct ()

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

	_addAddressFields ()

Protected Member Functions inherited from AbstractCollection
	_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
	$_isLive = false

	$_salesAmountExpression

	$_scopeConfig

	$_storeManager

	$_localeDate

	$_orderConfig

	$_reportOrderFactory

Protected Attributes inherited from Collection
	$_idFieldName = 'entity_id'

	$_eventPrefix = 'sales_order_collection'

	$_eventObject = 'order_collection'

	$_coreResourceHelper

Protected Attributes inherited from AbstractCollection
	$_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

Reports orders collection

Author: Magento Core Team core@.nosp@m.mage.nosp@m.ntoco.nosp@m.mmer.nosp@m.ce.co.nosp@m.m @SuppressWarnings(PHPMD.CouplingBetweenObjects) @api

Since: 100.0.2

Definition at line 19 of file Collection.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\Framework\Model\ResourceModel\Db\VersionControl\Snapshot	$entitySnapshot,
		\Magento\Framework\DB\Helper	$coreResourceHelper,
		\Magento\Framework\App\Config\ScopeConfigInterface	$scopeConfig,
		\Magento\Store\Model\StoreManagerInterface	$storeManager,
		\Magento\Framework\Stdlib\DateTime\TimezoneInterface	$localeDate,
		\Magento\Sales\Model\Order\Config	$orderConfig,
		\Magento\Sales\Model\ResourceModel\Report\OrderFactory	$reportOrderFactory,
		\Magento\Framework\DB\Adapter\AdapterInterface	$connection = `null`,
		\Magento\Framework\Model\ResourceModel\Db\AbstractDb	$resource = `null`
	)

Constructor

Parameters

\Magento\Framework\Data\Collection\EntityFactory	$entityFactory
\Psr\Log\LoggerInterface	$logger
\Magento\Framework\Data\Collection\Db\FetchStrategyInterface	$fetchStrategy
\Magento\Framework\Event\ManagerInterface	$eventManager
\Magento\Framework\Model\ResourceModel\Db\VersionControl\Snapshot	$entitySnapshot
\Magento\Framework\DB\Helper	$coreResourceHelper
\Magento\Framework\App\Config\ScopeConfigInterface	$scopeConfig
\Magento\Store\Model\StoreManagerInterface	$storeManager
\Magento\Framework\Stdlib\DateTime\TimezoneInterface	$localeDate
\Magento\Sales\Model\Order\Config	$orderConfig
\Magento\Sales\Model\ResourceModel\Report\OrderFactory	$reportOrderFactory
null	$connection
\Magento\Framework\Model\ResourceModel\Db\AbstractDb	$resource	@SuppressWarnings(PHPMD.ExcessiveParameterList)

Definition at line 89 of file Collection.php.

       {
         parent::__construct(
             $entityFactory,
             $logger,
             $fetchStrategy,
             $eventManager,
             $entitySnapshot,
             $coreResourceHelper,
             $connection,
             $resource
         );
         $this->_scopeConfig = $scopeConfig;
         $this->_storeManager = $storeManager;
         $this->_localeDate = $localeDate;
         $this->_orderConfig = $orderConfig;
         $this->_reportOrderFactory = $reportOrderFactory;
     }

Member Function Documentation

◆ _calculateTotalsAggregated()

_calculateTotalsAggregated ( $isFilter = 0 )

protected

Calculate totals aggregated report

Parameters

int $isFilter

Returns: $this @SuppressWarnings(PHPMD.UnusedFormalParameter)

Definition at line 564 of file Collection.php.

     {
         $this->setMainTable('sales_order_aggregated_created');
         $this->removeAllFieldsFromSelect();
 
         $this->getSelect()->columns(
             [
                 'revenue' => 'SUM(main_table.total_revenue_amount)',
                 'tax' => 'SUM(main_table.total_tax_amount_actual)',
                 'shipping' => 'SUM(main_table.total_shipping_amount_actual)',
                 'quantity' => 'SUM(orders_count)',
             ]
         );
 
         $statuses = $this->_orderConfig->getStateStatuses(\Magento\Sales\Model\Order::STATE_CANCELED);
 
         if (empty($statuses)) {
             $statuses = [0];
         }
 
         $this->getSelect()->where('main_table.order_status NOT IN(?)', $statuses);
 
         return $this;
     }

◆ _calculateTotalsLive()

_calculateTotalsLive ( $isFilter = 0 )

protected

Calculate totals live report

Parameters

int $isFilter

Returns: $this

Definition at line 512 of file Collection.php.

     {
         $this->setMainTable('sales_order');
         $this->removeAllFieldsFromSelect();
 
         $connection = $this->getConnection();
 
         $baseTaxInvoiced = $connection->getIfNullSql('main_table.base_tax_invoiced', 0);
         $baseTaxRefunded = $connection->getIfNullSql('main_table.base_tax_refunded', 0);
         $baseShippingInvoiced = $connection->getIfNullSql('main_table.base_shipping_invoiced', 0);
         $baseShippingRefunded = $connection->getIfNullSql('main_table.base_shipping_refunded', 0);
 
         $revenueExp = $this->_getSalesAmountExpression();
         $taxExp = sprintf('%s - %s', $baseTaxInvoiced, $baseTaxRefunded);
         $shippingExp = sprintf('%s - %s', $baseShippingInvoiced, $baseShippingRefunded);
 
         if ($isFilter == 0) {
             $rateExp = $connection->getIfNullSql('main_table.base_to_global_rate', 0);
             $this->getSelect()->columns(
                 [
                     'revenue' => new \Zend_Db_Expr(sprintf('SUM((%s) * %s)', $revenueExp, $rateExp)),
                     'tax' => new \Zend_Db_Expr(sprintf('SUM((%s) * %s)', $taxExp, $rateExp)),
                     'shipping' => new \Zend_Db_Expr(sprintf('SUM((%s) * %s)', $shippingExp, $rateExp)),
                 ]
             );
         } else {
             $this->getSelect()->columns(
                 [
                     'revenue' => new \Zend_Db_Expr(sprintf('SUM(%s)', $revenueExp)),
                     'tax' => new \Zend_Db_Expr(sprintf('SUM(%s)', $taxExp)),
                     'shipping' => new \Zend_Db_Expr(sprintf('SUM(%s)', $shippingExp)),
                 ]
             );
         }
 
         $this->getSelect()->columns(
             ['quantity' => 'COUNT(main_table.entity_id)']
         )->where(
             'main_table.state NOT IN (?)',
             [\Magento\Sales\Model\Order::STATE_PENDING_PAYMENT, \Magento\Sales\Model\Order::STATE_NEW]
         );
 
         return $this;
     }

◆ _getRangeExpression()

_getRangeExpression ( $range )

protected

Get range expression

Parameters

string $range

Returns: \Zend_Db_Expr

Definition at line 319 of file Collection.php.

     {
         switch ($range) {
             case '24h':
                 $expression = $this->getConnection()->getConcatSql(
                     [
                         $this->getConnection()->getDateFormatSql('{{attribute}}', '%Y-%m-%d %H:'),
                         $this->getConnection()->quote('00'),
                     ]
                 );
                 break;
             case '7d':
             case '1m':
                 $expression = $this->getConnection()->getDateFormatSql('{{attribute}}', '%Y-%m-%d');
                 break;
             case '1y':
             case '2y':
             case 'custom':
             default:
                 $expression = $this->getConnection()->getDateFormatSql('{{attribute}}', '%Y-%m');
                 break;
         }
 
         return $expression;
     }

◆ _getRangeExpressionForAttribute()

_getRangeExpressionForAttribute	(	$range,
		$attribute
	)

protected

Retrieve range expression adapted for attribute

Parameters

string	$range
string	$attribute

Returns: string

Definition at line 352 of file Collection.php.

     {
         $expression = $this->_getRangeExpression($range);
         return str_replace('{{attribute}}', $this->getConnection()->quoteIdentifier($attribute), $expression);
     }

◆ _getSalesAmountExpression()

_getSalesAmountExpression ( )

protected

Get sales amount expression

Returns: string

Definition at line 174 of file Collection.php.

     {
         if (null === $this->_salesAmountExpression) {
             $connection = $this->getConnection();
             $expressionTransferObject = new \Magento\Framework\DataObject(
                 [
                     'expression' => '%s - %s - %s - (%s - %s - %s)',
                     'arguments' => [
                         $connection->getIfNullSql('main_table.base_total_invoiced', 0),
                         $connection->getIfNullSql('main_table.base_tax_invoiced', 0),
                         $connection->getIfNullSql('main_table.base_shipping_invoiced', 0),
                         $connection->getIfNullSql('main_table.base_total_refunded', 0),
                         $connection->getIfNullSql('main_table.base_tax_refunded', 0),
                         $connection->getIfNullSql('main_table.base_shipping_refunded', 0),
                     ],
                 ]
             );
 
             $this->_eventManager->dispatch(
                 'sales_prepare_amount_expression',
                 ['collection' => $this, 'expression_object' => $expressionTransferObject]
             );
             $this->_salesAmountExpression = vsprintf(
                 $expressionTransferObject->getExpression(),
                 $expressionTransferObject->getArguments()
             );
         }
 
         return $this->_salesAmountExpression;
     }

◆ _getTZRangeExpressionForAttribute()

_getTZRangeExpressionForAttribute	(	$range,
		$attribute,
		$tzFrom = `'+00:00'`,
		$tzTo = `null`
	)

protected

Retrieve range expression with timezone conversion adapted for attribute

Parameters

string	$range
string	$attribute
string	$tzFrom
string	$tzTo

Returns: string @SuppressWarnings(PHPMD.UnusedFormalParameter)

Definition at line 386 of file Collection.php.

                                                                                            :00', $tzTo = null)
     {
         if (null == $tzTo) {
             $tzTo = $this->_localeDate->scopeDate()->format('P');
         }
         $connection = $this->getConnection();
         $expression = $this->_getRangeExpression($range);
         $attribute = $connection->quoteIdentifier($attribute);
         $periodExpr = $connection->getDateAddSql(
             $attribute,
             $tzTo,
             \Magento\Framework\DB\Adapter\AdapterInterface::INTERVAL_HOUR
         );
 
         return str_replace('{{attribute}}', $periodExpr, $expression);
     }

◆ _getTZRangeOffsetExpression()

_getTZRangeOffsetExpression	(	$range,
		$attribute,
		$from = `null`,
		$to = `null`
	)

protected

Retrieve query for attribute with timezone conversion

Parameters

string	$range
string	$attribute
string \| null	$from
string \| null	$to

Returns: string

Definition at line 367 of file Collection.php.

     {
         return str_replace(
             '{{attribute}}',
             $this->_reportOrderFactory->create()->getStoreTZOffsetQuery($this->getMainTable(), $attribute, $from, $to),
             $this->_getRangeExpression($range)
         );
     }

◆ _initInitialFieldsToSelect()

_initInitialFieldsToSelect ( )

protected

Initialize initial fields to select

Returns: $this @codeCoverageIgnore

Definition at line 906 of file Collection.php.

     {
         // No fields should be initialized
         return $this;
     }

◆ _prepareSummaryAggregated()

_prepareSummaryAggregated	(	$range,
		$customStart,
		$customEnd
	)

protected

Prepare report summary from aggregated data

Parameters

string	$range
string \| null	$customStart
string \| null	$customEnd

Returns: $this

Reset all columns, because result will group only by 'created_at' field

Definition at line 275 of file Collection.php.

     {
         $this->setMainTable('sales_order_aggregated_created');
         $this->getSelect()->reset(\Magento\Framework\DB\Select::COLUMNS);
         $rangePeriod = $this->_getRangeExpressionForAttribute($range, 'main_table.period');
 
         $tableName = $this->getConnection()->quoteIdentifier('main_table.period');
         $rangePeriodAggregateStmt = str_replace($tableName, "MIN({$tableName})", $rangePeriod);
 
         $this->getSelect()->columns(
             [
                 'revenue' => 'SUM(main_table.total_revenue_amount)',
                 'quantity' => 'SUM(main_table.orders_count)',
                 'range' => $rangePeriodAggregateStmt,
             ]
         )->order(
             'range'
         )->group(
             $rangePeriod
         );
 
         $this->getSelect()->where(
             $this->_getConditionSql('main_table.period', $this->getDateRange($range, $customStart, $customEnd))
         );
 
         $statuses = $this->_orderConfig->getStateStatuses(\Magento\Sales\Model\Order::STATE_CANCELED);
 
         if (empty($statuses)) {
             $statuses = [0];
         }
         $this->addFieldToFilter('main_table.order_status', ['nin' => $statuses]);
 
         return $this;
     }

◆ _prepareSummaryLive()

_prepareSummaryLive	(	$range,
		$customStart,
		$customEnd,
		$isFilter = `0`
	)

protected

Prepare report summary from live data

Parameters

string	$range
mixed	$customStart
mixed	$customEnd
int	$isFilter

Returns: $this

Reset all columns, because result will group only by 'created_at' field

Definition at line 214 of file Collection.php.

     {
         $this->setMainTable('sales_order');
         $connection = $this->getConnection();
 
         $this->getSelect()->reset(\Magento\Framework\DB\Select::COLUMNS);
 
         $expression = $this->_getSalesAmountExpression();
         if ($isFilter == 0) {
             $this->getSelect()->columns(
                 [
                     'revenue' => new \Zend_Db_Expr(
                         sprintf(
                             'SUM((%s) * %s)',
                             $expression,
                             $connection->getIfNullSql('main_table.base_to_global_rate', 0)
                         )
                     ),
                 ]
             );
         } else {
             $this->getSelect()->columns(['revenue' => new \Zend_Db_Expr(sprintf('SUM(%s)', $expression))]);
         }
 
         $dateRange = $this->getDateRange($range, $customStart, $customEnd);
 
         $tzRangeOffsetExpression = $this->_getTZRangeOffsetExpression(
             $range,
             'created_at',
             $dateRange['from'],
             $dateRange['to']
         );
 
         $this->getSelect()->columns(
             ['quantity' => 'COUNT(main_table.entity_id)', 'range' => $tzRangeOffsetExpression]
         )->where(
             'main_table.state NOT IN (?)',
             [\Magento\Sales\Model\Order::STATE_PENDING_PAYMENT, \Magento\Sales\Model\Order::STATE_NEW]
         )->order(
             'range',
             \Magento\Framework\DB\Select::SQL_ASC
         )->group(
             $tzRangeOffsetExpression
         );
 
         $this->addFieldToFilter('created_at', $dateRange);
 
         return $this;
     }

◆ addCreateAtPeriodFilter()

addCreateAtPeriodFilter ( $period )

Add period filter by created_at attribute

Parameters

string $period

Returns: $this

Definition at line 918 of file Collection.php.

     {
         list($from, $to) = $this->getDateRange($period, 0, 0, true);
 
         $this->checkIsLive($period);
 
         if ($this->isLive()) {
             $fieldToFilter = 'created_at';
         } else {
             $fieldToFilter = 'period';
         }
 
         $this->addFieldToFilter(
             $fieldToFilter,
             [
                 'from' => $from->format(\Magento\Framework\Stdlib\DateTime::DATETIME_PHP_FORMAT),
                 'to' => $to->format(\Magento\Framework\Stdlib\DateTime::DATETIME_PHP_FORMAT)
             ]
         );
 
         return $this;
     }

◆ addItemCountExpr()

addItemCountExpr ( )

Add item count expression

Returns: $this

Definition at line 483 of file Collection.php.

     {
         $this->getSelect()->columns(['items_count' => 'total_item_count'], 'main_table');
         return $this;
     }

◆ addOrdersCount()

addOrdersCount ( )

Add Order count field to select

Returns: $this

Definition at line 757 of file Collection.php.

     {
         $this->addFieldToFilter('state', ['neq' => \Magento\Sales\Model\Order::STATE_CANCELED]);
         $this->getSelect()->columns(['orders_count' => 'COUNT(main_table.entity_id)']);
 
         return $this;
     }

◆ addRevenueToSelect()

addRevenueToSelect ( $convertCurrency = false )

Add revenue

Parameters

bool $convertCurrency

Returns: $this

Definition at line 771 of file Collection.php.

     {
         $expr = $this->getTotalsExpression(
             !$convertCurrency,
             $this->getConnection()->getIfNullSql('main_table.base_subtotal_refunded', 0),
             $this->getConnection()->getIfNullSql('main_table.base_subtotal_canceled', 0),
             $this->getConnection()->getIfNullSql('main_table.base_discount_canceled', 0)
         );
         $this->getSelect()->columns(['revenue' => $expr]);
 
         return $this;
     }

◆ addSumAvgTotals()

addSumAvgTotals ( $storeId = 0 )

Add summary average totals

Parameters

int $storeId

Returns: $this

calculate average and total amount

Definition at line 790 of file Collection.php.

     {
         $expr = $this->getTotalsExpression(
             $storeId,
             $this->getConnection()->getIfNullSql('main_table.base_subtotal_refunded', 0),
             $this->getConnection()->getIfNullSql('main_table.base_subtotal_canceled', 0),
             $this->getConnection()->getIfNullSql('main_table.base_discount_canceled', 0)
         );
 
         $this->getSelect()->columns(
             ['orders_avg_amount' => "AVG({$expr})"]
         )->columns(
             ['orders_sum_amount' => "SUM({$expr})"]
         );
 
         return $this;
     }

◆ calculateSales()

calculateSales ( $isFilter = 0 )

Calculate lifitime sales

Parameters

int $isFilter

Returns: $this

Definition at line 595 of file Collection.php.

     {
         $statuses = $this->_orderConfig->getStateStatuses(\Magento\Sales\Model\Order::STATE_CANCELED);
 
         if (empty($statuses)) {
             $statuses = [0];
         }
         $connection = $this->getConnection();
 
         if ($this->_scopeConfig->getValue(
             'sales/dashboard/use_aggregated_data',
             \Magento\Store\Model\ScopeInterface::SCOPE_STORE
         )
         ) {
             $this->setMainTable('sales_order_aggregated_created');
             $this->removeAllFieldsFromSelect();
             $averageExpr = $connection->getCheckSql(
                 'SUM(main_table.orders_count) > 0',
                 'SUM(main_table.total_revenue_amount)/SUM(main_table.orders_count)',
                 0
             );
             $this->getSelect()->columns(
                 ['lifetime' => 'SUM(main_table.total_revenue_amount)', 'average' => $averageExpr]
             );
 
             if (!$isFilter) {
                 $this->addFieldToFilter(
                     'store_id',
                     ['eq' => $this->_storeManager->getStore(\Magento\Store\Model\Store::ADMIN_CODE)->getId()]
                 );
             }
             $this->getSelect()->where('main_table.order_status NOT IN(?)', $statuses);
         } else {
             $this->setMainTable('sales_order');
             $this->removeAllFieldsFromSelect();
 
             $expr = $this->_getSalesAmountExpression();
 
             if ($isFilter == 0) {
                 $expr = '(' . $expr . ') * main_table.base_to_global_rate';
             }
 
             $this->getSelect()->columns(
                 ['lifetime' => "SUM({$expr})", 'average' => "AVG({$expr})"]
             )->where(
                 'main_table.status NOT IN(?)',
                 $statuses
             )->where(
                 'main_table.state NOT IN(?)',
                 [\Magento\Sales\Model\Order::STATE_NEW, \Magento\Sales\Model\Order::STATE_PENDING_PAYMENT]
             );
         }
         return $this;
     }

◆ calculateTotals()

calculateTotals ( $isFilter = 0 )

Calculate totals report

Parameters

int $isFilter

Returns: $this

Definition at line 495 of file Collection.php.

     {
         if ($this->isLive()) {
             $this->_calculateTotalsLive($isFilter);
         } else {
             $this->_calculateTotalsAggregated($isFilter);
         }
 
         return $this;
     }

◆ checkIsLive()

checkIsLive ( $range )

Check range for live mode

Parameters

string $range

Returns: $this @SuppressWarnings(PHPMD.UnusedFormalParameter)

Definition at line 128 of file Collection.php.

     {
         $this->_isLive = (bool)(!$this->_scopeConfig->getValue(
             'sales/dashboard/use_aggregated_data',
             \Magento\Store\Model\ScopeInterface::SCOPE_STORE
         ));
         return $this;
     }

◆ getDateRange()

getDateRange	(	$range,
		$customStart,
		$customEnd,
		$returnObjects = `false`
	)

Calculate From and To dates (or times) by given period

Parameters

string	$range
string	$customStart
string	$customEnd
bool	$returnObjects

Returns: array @SuppressWarnings(PHPMD.CyclomaticComplexity)

Definition at line 413 of file Collection.php.

     {
         $dateEnd = new \DateTime();
         $dateStart = new \DateTime();
 
         // go to the end of a day
         $dateEnd->setTime(23, 59, 59);
 
         $dateStart->setTime(0, 0, 0);
 
         switch ($range) {
             case '24h':
                 $dateEnd = new \DateTime();
                 $dateEnd->modify('+1 hour');
                 $dateStart = clone $dateEnd;
                 $dateStart->modify('-1 day');
                 break;
 
             case '7d':
                 // substract 6 days we need to include
                 // only today and not hte last one from range
                 $dateStart->modify('-6 days');
                 break;
 
             case '1m':
                 $dateStart->setDate(
                     $dateStart->format('Y'),
                     $dateStart->format('m'),
                     $this->_scopeConfig->getValue(
                         'reports/dashboard/mtd_start',
                         \Magento\Store\Model\ScopeInterface::SCOPE_STORE
                     )
                 );
                 break;
 
             case 'custom':
                 $dateStart = $customStart ? $customStart : $dateEnd;
                 $dateEnd = $customEnd ? $customEnd : $dateEnd;
                 break;
 
             case '1y':
             case '2y':
                 $startMonthDay = explode(
                     ',',
                     $this->_scopeConfig->getValue(
                         'reports/dashboard/ytd_start',
                         \Magento\Store\Model\ScopeInterface::SCOPE_STORE
                     )
                 );
                 $startMonth = isset($startMonthDay[0]) ? (int)$startMonthDay[0] : 1;
                 $startDay = isset($startMonthDay[1]) ? (int)$startMonthDay[1] : 1;
                 $dateStart->setDate($dateStart->format('Y'), $startMonth, $startDay);
                 if ($range == '2y') {
                     $dateStart->modify('-1 year');
                 }
                 break;
         }
 
         if ($returnObjects) {
             return [$dateStart, $dateEnd];
         } else {
             return ['from' => $dateStart, 'to' => $dateEnd, 'datetime' => true];
         }
     }

◆ getSelectCountSql()

getSelectCountSql ( )

Get select count sql

Returns: Select

Definition at line 886 of file Collection.php.

     {
         $countSelect = clone $this->getSelect();
         $countSelect->reset(\Magento\Framework\DB\Select::ORDER);
         $countSelect->reset(\Magento\Framework\DB\Select::LIMIT_COUNT);
         $countSelect->reset(\Magento\Framework\DB\Select::LIMIT_OFFSET);
         $countSelect->reset(\Magento\Framework\DB\Select::COLUMNS);
         $countSelect->reset(\Magento\Framework\DB\Select::GROUP);
         $countSelect->reset(\Magento\Framework\DB\Select::HAVING);
         $countSelect->columns("COUNT(DISTINCT main_table.entity_id)");
 
         return $countSelect;
     }

◆ getTotalsExpression()

getTotalsExpression	(	$storeId,
		$baseSubtotalRefunded,
		$baseSubtotalCanceled,
		$baseDiscountCanceled
	)

protected

Get SQL expression for totals

Parameters

int	$storeId
string	$baseSubtotalRefunded
string	$baseSubtotalCanceled
string	$baseDiscountCanceled

Returns: string

Definition at line 820 of file Collection.php.

       {
         $template = ($storeId != 0)
             ? '(main_table.base_subtotal - %2$s - %1$s - ABS(main_table.base_discount_amount) - %3$s)'
             : '((main_table.base_subtotal - %1$s - %2$s - ABS(main_table.base_discount_amount) - %3$s) '
                 . ' * main_table.base_to_global_rate)';
         return sprintf($template, $baseSubtotalRefunded, $baseSubtotalCanceled, $baseDiscountCanceled);
     }

◆ groupByCustomer()

groupByCustomer ( )

Add group By customer attribute

Returns: $this

Definition at line 732 of file Collection.php.

     {
         $this->getSelect()->where('main_table.customer_id IS NOT NULL')->group('main_table.customer_id');
         return $this;
     }

◆ isLive()

isLive ( )

Retrieve is live flag for rep

Returns: bool @codeCoverageIgnore

Definition at line 143 of file Collection.php.

     {
         return $this->_isLive;
     }

◆ joinCustomerName()

joinCustomerName ( $alias = 'name' )

Join Customer Name (concat)

Parameters

string $alias

Returns: $this

Definition at line 744 of file Collection.php.

     {
         $fields = ['main_table.customer_firstname', 'main_table.customer_lastname'];
         $fieldConcat = $this->getConnection()->getConcatSql($fields, ' ');
         $this->getSelect()->columns([$alias => $fieldConcat]);
         return $this;
     }

◆ orderByCreatedAt()

orderByCreatedAt ( $dir = self::SORT_ORDER_DESC )

Sort order by order created_at date

Parameters

string $dir

Returns: $this

Definition at line 875 of file Collection.php.

     {
         $this->setOrder('created_at', $dir);
         return $this;
     }

◆ orderByCustomerRegistration()

orderByCustomerRegistration ( $dir = self::SORT_ORDER_DESC )

Order by customer registration

Parameters

string $dir

Returns: $this

Definition at line 863 of file Collection.php.

     {
         $this->setOrder('customer_id', $dir);
         return $this;
     }

◆ orderByOrdersCount()

orderByOrdersCount ( $dir = self::SORT_ORDER_DESC )

Order by orders count

Parameters

string $dir

Returns: $this

Definition at line 851 of file Collection.php.

     {
         $this->getSelect()->order('orders_count ' . $dir);
         return $this;
     }

◆ orderByTotalAmount()

orderByTotalAmount ( $dir = self::SORT_ORDER_DESC )

Sort order by total amount

Parameters

string $dir

Returns: $this

Definition at line 839 of file Collection.php.

     {
         $this->getSelect()->order('orders_sum_amount ' . $dir);
         return $this;
     }

◆ prepareSummary()

prepareSummary	(	$range,
		$customStart,
		$customEnd,
		$isFilter = `0`
	)

Prepare report summary

Parameters

string	$range
mixed	$customStart
mixed	$customEnd
int	$isFilter

Returns: $this

Definition at line 157 of file Collection.php.

     {
         $this->checkIsLive($range);
         if ($this->_isLive) {
             $this->_prepareSummaryLive($range, $customStart, $customEnd, $isFilter);
         } else {
             $this->_prepareSummaryAggregated($range, $customStart, $customEnd, $isFilter);
         }
 
         return $this;
     }

◆ setDateRange()

setDateRange	(	$fromDate,
		$toDate
	)

Set date range

Parameters

string	$fromDate
string	$toDate

Returns: $this

Definition at line 657 of file Collection.php.

     {
         $this->_reset()->addFieldToFilter(
             'created_at',
             ['from' => $fromDate, 'to' => $toDate]
         )->addFieldToFilter(
             'state',
             ['neq' => \Magento\Sales\Model\Order::STATE_CANCELED]
         )->getSelect()->columns(
             ['orders' => 'COUNT(DISTINCT(main_table.entity_id))']
         )->group(
             'entity_id'
         );
 
         $this->getSelect()->columns(['items' => 'SUM(main_table.total_qty_ordered)']);
 
         return $this;
     }

◆ setStoreIds()

setStoreIds ( $storeIds )

Set store filter collection

Parameters

int[] $storeIds

Returns: $this

Definition at line 682 of file Collection.php.

     {
         $connection = $this->getConnection();
         $baseSubtotalInvoiced = $connection->getIfNullSql('main_table.base_subtotal_invoiced', 0);
         $baseDiscountRefunded = $connection->getIfNullSql('main_table.base_discount_refunded', 0);
         $baseSubtotalRefunded = $connection->getIfNullSql('main_table.base_subtotal_refunded', 0);
         $baseDiscountInvoiced = $connection->getIfNullSql('main_table.base_discount_invoiced', 0);
         $baseTotalInvocedCost = $connection->getIfNullSql('main_table.base_total_invoiced_cost', 0);
         if ($storeIds) {
             $this->getSelect()->columns(
                 [
                     'subtotal' => 'SUM(main_table.base_subtotal)',
                     'tax' => 'SUM(main_table.base_tax_amount)',
                     'shipping' => 'SUM(main_table.base_shipping_amount)',
                     'discount' => 'SUM(main_table.base_discount_amount)',
                     'total' => 'SUM(main_table.base_grand_total)',
                     'invoiced' => 'SUM(main_table.base_total_paid)',
                     'refunded' => 'SUM(main_table.base_total_refunded)',
                     'profit' => "SUM({$baseSubtotalInvoiced}) " .
                     "+ SUM({$baseDiscountRefunded}) - SUM({$baseSubtotalRefunded}) " .
                     "- SUM({$baseDiscountInvoiced}) - SUM({$baseTotalInvocedCost})",
                 ]
             );
         } else {
             $this->getSelect()->columns(
                 [
                     'subtotal' => 'SUM(main_table.base_subtotal * main_table.base_to_global_rate)',
                     'tax' => 'SUM(main_table.base_tax_amount * main_table.base_to_global_rate)',
                     'shipping' => 'SUM(main_table.base_shipping_amount * main_table.base_to_global_rate)',
                     'discount' => 'SUM(main_table.base_discount_amount * main_table.base_to_global_rate)',
                     'total' => 'SUM(main_table.base_grand_total * main_table.base_to_global_rate)',
                     'invoiced' => 'SUM(main_table.base_total_paid * main_table.base_to_global_rate)',
                     'refunded' => 'SUM(main_table.base_total_refunded * main_table.base_to_global_rate)',
                     'profit' => "SUM({$baseSubtotalInvoiced} *  main_table.base_to_global_rate) " .
                     "+ SUM({$baseDiscountRefunded} * main_table.base_to_global_rate) " .
                     "- SUM({$baseSubtotalRefunded} * main_table.base_to_global_rate) " .
                     "- SUM({$baseDiscountInvoiced} * main_table.base_to_global_rate) " .
                     "- SUM({$baseTotalInvocedCost} * main_table.base_to_global_rate)",
                 ]
             );
         }
 
         return $this;
     }

Field Documentation

◆ $_isLive

$_isLive = false

protected

Definition at line 26 of file Collection.php.

◆ $_localeDate

$_localeDate

protected

Definition at line 54 of file Collection.php.

◆ $_orderConfig

$_orderConfig

protected

Definition at line 61 of file Collection.php.

◆ $_reportOrderFactory

$_reportOrderFactory

protected

Definition at line 68 of file Collection.php.

◆ $_salesAmountExpression

$_salesAmountExpression

protected

Definition at line 33 of file Collection.php.

◆ $_scopeConfig

$_scopeConfig

protected

Definition at line 40 of file Collection.php.

◆ $_storeManager

$_storeManager

protected

Definition at line 47 of file Collection.php.

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

vendor/magento/module-reports/Model/ResourceModel/Order/Collection.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _calculateTotalsAggregated()

◆ _calculateTotalsLive()

◆ _getRangeExpression()

◆ _getRangeExpressionForAttribute()

◆ _getSalesAmountExpression()

◆ _getTZRangeExpressionForAttribute()

◆ _getTZRangeOffsetExpression()

◆ _initInitialFieldsToSelect()

◆ _prepareSummaryAggregated()

◆ _prepareSummaryLive()

◆ addCreateAtPeriodFilter()

◆ addItemCountExpr()

◆ addOrdersCount()

◆ addRevenueToSelect()

◆ addSumAvgTotals()

◆ calculateSales()

◆ calculateTotals()

◆ checkIsLive()

◆ getDateRange()

◆ getSelectCountSql()

◆ getTotalsExpression()

◆ groupByCustomer()

◆ isLive()

◆ joinCustomerName()

◆ orderByCreatedAt()

◆ orderByCustomerRegistration()

◆ orderByOrdersCount()

◆ orderByTotalAmount()

◆ prepareSummary()

◆ setDateRange()

◆ setStoreIds()

Field Documentation

◆ $_isLive

◆ $_localeDate

◆ $_orderConfig

◆ $_reportOrderFactory

◆ $_salesAmountExpression

◆ $_scopeConfig

◆ $_storeManager