1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Sales\Model\ResourceModel\Collection;
/**
* Flat sales abstract collection
*
* @api
* @SuppressWarnings(PHPMD.CouplingBetweenObjects)
* @since 100.0.2
*/
abstract class AbstractCollection extends \Magento\Framework\Model\ResourceModel\Db\VersionControl\Collection
{
/**
* @var \Magento\Framework\DB\Select
*/
protected $_countSelect;
/**
* @var \Magento\Framework\Api\SearchCriteriaInterface
*/
protected $searchCriteria;
/**
* Set select count sql
*
* @param \Magento\Framework\DB\Select $countSelect
* @return $this
*/
public function setSelectCountSql(\Magento\Framework\DB\Select $countSelect)
{
$this->_countSelect = $countSelect;
return $this;
}
/**
* get select count sql
*
* @return \Magento\Framework\DB\Select
*/
public function getSelectCountSql()
{
if (!$this->_countSelect instanceof \Magento\Framework\DB\Select) {
$this->setSelectCountSql(parent::getSelectCountSql());
}
return $this->_countSelect;
}
/**
* Check if $attribute is \Magento\Eav\Model\Entity\Attribute and convert to string field name
*
* @param string|\Magento\Eav\Model\Entity\Attribute $attribute
* @return string
* @throws \Magento\Framework\Exception\LocalizedException
*/
protected function _attributeToField($attribute)
{
$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;
}
/**
* Add attribute to select result set.
* Backward compatibility with EAV collection
*
* @param string $attribute
* @return $this
*/
public function addAttributeToSelect($attribute)
{
$this->addFieldToSelect($this->_attributeToField($attribute));
return $this;
}
/**
* Specify collection select filter by attribute value
* Backward compatibility with EAV collection
*
* @param string|\Magento\Eav\Model\Entity\Attribute $attribute
* @param array|int|string|null $condition
* @return $this
*/
public function addAttributeToFilter($attribute, $condition = null)
{
$this->addFieldToFilter($this->_attributeToField($attribute), $condition);
return $this;
}
/**
* Specify collection select order by attribute value
* Backward compatibility with EAV collection
*
* @param string $attribute
* @param string $dir
* @return $this
*/
public function addAttributeToSort($attribute, $dir = 'asc')
{
$this->addOrder($this->_attributeToField($attribute), $dir);
return $this;
}
/**
* Set collection page start and records to show
* Backward compatibility with EAV collection
*
* @param int $pageNum
* @param int $pageSize
* @return $this
*/
public function setPage($pageNum, $pageSize)
{
$this->setCurPage($pageNum)->setPageSize($pageSize);
return $this;
}
/**
* Create all ids retrieving select with limitation
* Backward compatibility with EAV collection
*
* @param int $limit
* @param int $offset
* @return \Magento\Eav\Model\Entity\Collection\AbstractCollection
*/
protected function _getAllIdsSelect($limit = null, $offset = null)
{
$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;
}
/**
* Retrieve all ids for collection
* Backward compatibility with EAV collection
*
* @param int $limit
* @param int $offset
* @return array
*/
public function getAllIds($limit = null, $offset = null)
{
return $this->getConnection()->fetchCol($this->_getAllIdsSelect($limit, $offset), $this->_bindParams);
}
/**
* Get search criteria.
*
* @return \Magento\Framework\Api\SearchCriteriaInterface|null
*/
public function getSearchCriteria()
{
return $this->searchCriteria;
}
/**
* Set search criteria.
*
* @param \Magento\Framework\Api\SearchCriteriaInterface $searchCriteria
* @return $this
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function setSearchCriteria(\Magento\Framework\Api\SearchCriteriaInterface $searchCriteria = null)
{
$this->searchCriteria = $searchCriteria;
return $this;
}
/**
* Get total count.
*
* @return int
*/
public function getTotalCount()
{
return $this->getSize();
}
/**
* Set total count.
*
* @param int $totalCount
* @return $this
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function setTotalCount($totalCount)
{
return $this;
}
/**
* Set items list.
*
* @param \Magento\Framework\Api\ExtensibleDataInterface[] $items
* @return $this
*/
public function setItems(array $items = null)
{
if (!$items) {
return $this;
}
foreach ($items as $item) {
$this->addItem($item);
}
return $this;
}
}