Collection.php 8.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270
  1. <?php
  2. /**
  3. * Copyright © Magento, Inc. All rights reserved.
  4. * See COPYING.txt for license details.
  5. */
  6. /**
  7. * Customers Report collection
  8. */
  9. namespace Magento\Reports\Model\ResourceModel\Customer;
  10. /**
  11. * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
  12. * @api
  13. * @since 100.0.2
  14. */
  15. class Collection extends \Magento\Customer\Model\ResourceModel\Customer\Collection
  16. {
  17. /**
  18. * Add order statistics flag
  19. *
  20. * @var bool
  21. */
  22. protected $_addOrderStatistics = false;
  23. /**
  24. * Add order statistics is filter flag
  25. *
  26. * @var bool
  27. */
  28. protected $_addOrderStatFilter = false;
  29. /**
  30. * Customer id table name
  31. *
  32. * @var string
  33. */
  34. protected $_customerIdTableName;
  35. /**
  36. * Customer id field name
  37. *
  38. * @var string
  39. */
  40. protected $_customerIdFieldName;
  41. /**
  42. * Order entity table name
  43. *
  44. * @var string
  45. */
  46. protected $_orderEntityTable;
  47. /**
  48. * Order entity field name
  49. *
  50. * @var string
  51. */
  52. protected $_orderEntityField;
  53. /**
  54. * @var \Magento\Quote\Api\CartRepositoryInterface
  55. */
  56. protected $quoteRepository;
  57. /**
  58. * @var \Magento\Quote\Model\ResourceModel\Quote\Item\CollectionFactory
  59. */
  60. protected $_quoteItemFactory;
  61. /**
  62. * @var \Magento\Sales\Model\ResourceModel\Order\Collection
  63. */
  64. protected $orderResource;
  65. /**
  66. * @param \Magento\Framework\Data\Collection\EntityFactory $entityFactory
  67. * @param \Psr\Log\LoggerInterface $logger
  68. * @param \Magento\Framework\Data\Collection\Db\FetchStrategyInterface $fetchStrategy
  69. * @param \Magento\Framework\Event\ManagerInterface $eventManager
  70. * @param \Magento\Eav\Model\Config $eavConfig
  71. * @param \Magento\Framework\App\ResourceConnection $resource
  72. * @param \Magento\Eav\Model\EntityFactory $eavEntityFactory
  73. * @param \Magento\Eav\Model\ResourceModel\Helper $resourceHelper
  74. * @param \Magento\Framework\Validator\UniversalFactory $universalFactory
  75. * @param \Magento\Framework\Model\ResourceModel\Db\VersionControl\Snapshot $entitySnapshot
  76. * @param \Magento\Framework\DataObject\Copy\Config $fieldsetConfig
  77. * @param \Magento\Quote\Api\CartRepositoryInterface $quoteRepository
  78. * @param \Magento\Quote\Model\ResourceModel\Quote\Item\CollectionFactory $quoteItemFactory
  79. * @param \Magento\Sales\Model\ResourceModel\Order\Collection $orderResource
  80. * @param mixed $connection
  81. * @param string $modelName
  82. *
  83. * @SuppressWarnings(PHPMD.ExcessiveParameterList)
  84. */
  85. public function __construct(
  86. \Magento\Framework\Data\Collection\EntityFactory $entityFactory,
  87. \Psr\Log\LoggerInterface $logger,
  88. \Magento\Framework\Data\Collection\Db\FetchStrategyInterface $fetchStrategy,
  89. \Magento\Framework\Event\ManagerInterface $eventManager,
  90. \Magento\Eav\Model\Config $eavConfig,
  91. \Magento\Framework\App\ResourceConnection $resource,
  92. \Magento\Eav\Model\EntityFactory $eavEntityFactory,
  93. \Magento\Eav\Model\ResourceModel\Helper $resourceHelper,
  94. \Magento\Framework\Validator\UniversalFactory $universalFactory,
  95. \Magento\Framework\Model\ResourceModel\Db\VersionControl\Snapshot $entitySnapshot,
  96. \Magento\Framework\DataObject\Copy\Config $fieldsetConfig,
  97. \Magento\Quote\Api\CartRepositoryInterface $quoteRepository,
  98. \Magento\Quote\Model\ResourceModel\Quote\Item\CollectionFactory $quoteItemFactory,
  99. \Magento\Sales\Model\ResourceModel\Order\Collection $orderResource,
  100. \Magento\Framework\DB\Adapter\AdapterInterface $connection = null,
  101. $modelName = self::CUSTOMER_MODEL_NAME
  102. ) {
  103. parent::__construct(
  104. $entityFactory,
  105. $logger,
  106. $fetchStrategy,
  107. $eventManager,
  108. $eavConfig,
  109. $resource,
  110. $eavEntityFactory,
  111. $resourceHelper,
  112. $universalFactory,
  113. $entitySnapshot,
  114. $fieldsetConfig,
  115. $connection,
  116. $modelName
  117. );
  118. $this->orderResource = $orderResource;
  119. $this->quoteRepository = $quoteRepository;
  120. $this->_quoteItemFactory = $quoteItemFactory;
  121. }
  122. /**
  123. * Add cart info to collection
  124. *
  125. * @return $this
  126. */
  127. public function addCartInfo()
  128. {
  129. foreach ($this->getItems() as $item) {
  130. try {
  131. $quote = $this->quoteRepository->getForCustomer($item->getId());
  132. $totals = $quote->getTotals();
  133. $item->setTotal($totals['subtotal']->getValue());
  134. $quoteItems = $this->_quoteItemFactory->create()->setQuoteFilter($quote->getId());
  135. $quoteItems->load();
  136. $item->setItems($quoteItems->count());
  137. } catch (\Magento\Framework\Exception\NoSuchEntityException $e) {
  138. $item->remove();
  139. }
  140. }
  141. return $this;
  142. }
  143. /**
  144. * Add customer name to results
  145. *
  146. * @return $this
  147. */
  148. public function addCustomerName()
  149. {
  150. $this->addNameToSelect();
  151. return $this;
  152. }
  153. /**
  154. * Add order statistics
  155. *
  156. * @param bool $isFilter
  157. * @return $this
  158. */
  159. public function addOrdersStatistics($isFilter = false)
  160. {
  161. $this->_addOrderStatistics = true;
  162. $this->_addOrderStatFilter = (bool)$isFilter;
  163. return $this;
  164. }
  165. /**
  166. * Add orders statistics to collection items
  167. *
  168. * @return $this
  169. */
  170. protected function _addOrdersStatistics()
  171. {
  172. $customerIds = $this->getColumnValues($this->getResource()->getIdFieldName());
  173. if ($this->_addOrderStatistics && !empty($customerIds)) {
  174. $connection = $this->orderResource->getConnection();
  175. $baseSubtotalRefunded = $connection->getIfNullSql('orders.base_subtotal_refunded', 0);
  176. $baseSubtotalCanceled = $connection->getIfNullSql('orders.base_subtotal_canceled', 0);
  177. $baseDiscountCanceled = $connection->getIfNullSql('orders.base_discount_canceled', 0);
  178. $totalExpr = $this->_addOrderStatFilter ?
  179. "(orders.base_subtotal-{$baseSubtotalCanceled}-{$baseSubtotalRefunded} - {$baseDiscountCanceled}"
  180. . " - ABS(orders.base_discount_amount))*orders.base_to_global_rate" :
  181. "orders.base_subtotal-{$baseSubtotalCanceled}-{$baseSubtotalRefunded} - {$baseDiscountCanceled}"
  182. . " - ABS(orders.base_discount_amount)";
  183. $select = $this->orderResource->getConnection()->select();
  184. $select->from(
  185. ['orders' => $this->orderResource->getTable('sales_order')],
  186. [
  187. 'orders_avg_amount' => "AVG({$totalExpr})",
  188. 'orders_sum_amount' => "SUM({$totalExpr})",
  189. 'orders_count' => 'COUNT(orders.entity_id)',
  190. 'customer_id'
  191. ]
  192. )->where(
  193. 'orders.state <> ?',
  194. \Magento\Sales\Model\Order::STATE_CANCELED
  195. )->where(
  196. 'orders.customer_id IN(?)',
  197. $customerIds
  198. )->group(
  199. 'orders.customer_id'
  200. );
  201. foreach ($this->orderResource->getConnection()->fetchAll($select) as $ordersInfo) {
  202. $this->getItemById($ordersInfo['customer_id'])->addData($ordersInfo);
  203. }
  204. }
  205. return $this;
  206. }
  207. /**
  208. * Collection after load operations like adding orders statistics
  209. *
  210. * @return $this
  211. */
  212. protected function _afterLoad()
  213. {
  214. $this->_addOrdersStatistics();
  215. return $this;
  216. }
  217. /**
  218. * Order by customer registration
  219. *
  220. * @param string $dir
  221. * @return $this
  222. */
  223. public function orderByCustomerRegistration($dir = self::SORT_ORDER_DESC)
  224. {
  225. $this->addAttributeToSort('entity_id', $dir);
  226. return $this;
  227. }
  228. /**
  229. * Get select count sql
  230. *
  231. * @return string
  232. */
  233. public function getSelectCountSql()
  234. {
  235. $countSelect = clone $this->getSelect();
  236. $countSelect->reset(\Magento\Framework\DB\Select::ORDER);
  237. $countSelect->reset(\Magento\Framework\DB\Select::LIMIT_COUNT);
  238. $countSelect->reset(\Magento\Framework\DB\Select::LIMIT_OFFSET);
  239. $countSelect->reset(\Magento\Framework\DB\Select::COLUMNS);
  240. $countSelect->reset(\Magento\Framework\DB\Select::GROUP);
  241. $countSelect->reset(\Magento\Framework\DB\Select::HAVING);
  242. $countSelect->columns("count(DISTINCT e.entity_id)");
  243. return $countSelect;
  244. }
  245. }