-
Notifications
You must be signed in to change notification settings - Fork 0
/
Collection.php
executable file
·489 lines (446 loc) · 13.3 KB
/
Collection.php
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
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
<?php
/**
* Magento Enterprise Edition
*
* NOTICE OF LICENSE
*
* This source file is subject to the Magento Enterprise Edition End User License Agreement
* that is bundled with this package in the file LICENSE_EE.txt.
* It is also available through the world-wide-web at this URL:
* http://www.magento.com/license/enterprise-edition
* If you did not receive a copy of the license and are unable to
* obtain it through the world-wide-web, please send an email
* to license@magento.com so we can send you a copy immediately.
*
* DISCLAIMER
*
* Do not edit or add to this file if you wish to upgrade Magento to newer
* versions in the future. If you wish to customize Magento for your
* needs please refer to http://www.magento.com for more information.
*
* @category Mage
* @package Mage_Catalog
* @copyright Copyright (c) 2006-2014 X.commerce, Inc. (http://www.magento.com)
* @license http://www.magento.com/license/enterprise-edition
*/
/**
* Category resource collection
*
* @category Mage
* @package Mage_Catalog
* @author Magento Core Team <core@magentocommerce.com>
*/
class Mage_Catalog_Model_Resource_Category_Collection extends Mage_Catalog_Model_Resource_Collection_Abstract
{
/**
* Event prefix
*
* @var string
*/
protected $_eventPrefix = 'catalog_category_collection';
/**
* Event object name
*
* @var string
*/
protected $_eventObject = 'category_collection';
/**
* Name of product table
*
* @var string
*/
protected $_productTable;
/**
* Store id, that we should count products on
*
* @var int
*/
protected $_productStoreId;
/**
* Name of product website table
*
* @var string
*/
protected $_productWebsiteTable;
/**
* Load with product count flag
*
* @var boolean
*/
protected $_loadWithProductCount = false;
/**
* Catalog factory instance
*
* @var Mage_Catalog_Model_Factory
*/
protected $_factory;
/**
* Disable flat flag
*
* @var bool
*/
protected $_disableFlat = false;
/**
* Initialize factory
*
* @param Mage_Core_Model_Resource_Abstract $resource
* @param array $args
*/
public function __construct($resource = null, array $args = array())
{
parent::__construct($resource);
$this->_factory = !empty($args['factory']) ? $args['factory'] : Mage::getSingleton('catalog/factory');
}
/**
* Init collection and determine table names
*
*/
protected function _construct()
{
$this->_init('catalog/category');
$this->_productWebsiteTable = $this->getTable('catalog/product_website');
$this->_productTable = $this->getTable('catalog/category_product');
}
/**
* Add Id filter
*
* @param array $categoryIds
* @return Mage_Catalog_Model_Resource_Category_Collection
*/
public function addIdFilter($categoryIds)
{
if (is_array($categoryIds)) {
if (empty($categoryIds)) {
$condition = '';
} else {
$condition = array('in' => $categoryIds);
}
} elseif (is_numeric($categoryIds)) {
$condition = $categoryIds;
} elseif (is_string($categoryIds)) {
$ids = explode(',', $categoryIds);
if (empty($ids)) {
$condition = $categoryIds;
} else {
$condition = array('in' => $ids);
}
}
$this->addFieldToFilter('entity_id', $condition);
return $this;
}
/**
* Set flag for loading product count
*
* @param boolean $flag
* @return Mage_Catalog_Model_Resource_Category_Collection
*/
public function setLoadProductCount($flag)
{
$this->_loadWithProductCount = $flag;
return $this;
}
/**
* Before collection load
*
* @return Mage_Catalog_Model_Resource_Category_Collection
*/
protected function _beforeLoad()
{
Mage::dispatchEvent($this->_eventPrefix . '_load_before',
array($this->_eventObject => $this));
return parent::_beforeLoad();
}
/**
* After collection load
*
* @return Mage_Catalog_Model_Resource_Category_Collection
*/
protected function _afterLoad()
{
Mage::dispatchEvent($this->_eventPrefix . '_load_after',
array($this->_eventObject => $this));
return parent::_afterLoad();
}
/**
* Set id of the store that we should count products on
*
* @param int $storeId
* @return Mage_Catalog_Model_Resource_Category_Collection
*/
public function setProductStoreId($storeId)
{
$this->_productStoreId = $storeId;
return $this;
}
/**
* Get id of the store that we should count products on
*
* @return int
*/
public function getProductStoreId()
{
if (is_null($this->_productStoreId)) {
$this->_productStoreId = Mage_Catalog_Model_Abstract::DEFAULT_STORE_ID;
}
return $this->_productStoreId;
}
/**
* Load collection
*
* @param bool $printQuery
* @param bool $logQuery
* @return Mage_Catalog_Model_Resource_Category_Collection
*/
public function load($printQuery = false, $logQuery = false)
{
if ($this->isLoaded()) {
return $this;
}
if ($this->_loadWithProductCount) {
$this->addAttributeToSelect('all_children');
$this->addAttributeToSelect('is_anchor');
}
parent::load($printQuery, $logQuery);
if ($this->_loadWithProductCount) {
$this->_loadProductCount();
}
return $this;
}
/**
* Load categories product count
*
*/
protected function _loadProductCount()
{
$this->loadProductCount($this->_items, true, true);
}
/**
* Load product count for specified items
*
* @param array $items
* @param boolean $countRegular get product count for regular (non-anchor) categories
* @param boolean $countAnchor get product count for anchor categories
* @return Mage_Catalog_Model_Resource_Category_Collection
*/
public function loadProductCount($items, $countRegular = true, $countAnchor = true)
{
$anchor = array();
$regular = array();
$websiteId = Mage::app()->getStore($this->getProductStoreId())->getWebsiteId();
foreach ($items as $item) {
if ($item->getIsAnchor()) {
$anchor[$item->getId()] = $item;
} else {
$regular[$item->getId()] = $item;
}
}
if ($countRegular) {
// Retrieve regular categories product counts
$regularIds = array_keys($regular);
if (!empty($regularIds)) {
$select = $this->_conn->select();
$select->from(
array('main_table' => $this->_productTable),
array('category_id', new Zend_Db_Expr('COUNT(main_table.product_id)'))
)
->where($this->_conn->quoteInto('main_table.category_id IN(?)', $regularIds))
->group('main_table.category_id');
if ($websiteId) {
$select->join(
array('w' => $this->_productWebsiteTable),
'main_table.product_id = w.product_id', array()
)
->where('w.website_id = ?', $websiteId);
}
$counts = $this->_conn->fetchPairs($select);
foreach ($regular as $item) {
if (isset($counts[$item->getId()])) {
$item->setProductCount($counts[$item->getId()]);
} else {
$item->setProductCount(0);
}
}
}
}
if ($countAnchor) {
// Retrieve Anchor categories product counts
foreach ($anchor as $item) {
if ($allChildren = $item->getAllChildren()) {
$bind = array(
'entity_id' => $item->getId(),
'c_path' => $item->getPath() . '/%'
);
$select = $this->_conn->select();
$select->from(
array('main_table' => $this->_productTable),
new Zend_Db_Expr('COUNT(DISTINCT main_table.product_id)')
)
->joinInner(
array('e' => $this->getTable('catalog/category')),
'main_table.category_id=e.entity_id',
array()
)
->where('e.entity_id = :entity_id')
->orWhere('e.path LIKE :c_path');
if ($websiteId) {
$select->join(
array('w' => $this->_productWebsiteTable),
'main_table.product_id = w.product_id', array()
)
->where('w.website_id = ?', $websiteId);
}
$item->setProductCount((int) $this->_conn->fetchOne($select, $bind));
} else {
$item->setProductCount(0);
}
}
}
return $this;
}
/**
* Add category path filter
*
* @param string $regexp
* @return Mage_Catalog_Model_Resource_Category_Collection
*/
public function addPathFilter($regexp)
{
$this->addFieldToFilter('path', array('regexp' => $regexp));
return $this;
}
/**
* Joins url rewrite rules to collection
*
* @return Mage_Catalog_Model_Resource_Category_Collection
*/
public function joinUrlRewrite()
{
$this->_factory->getCategoryUrlRewriteHelper()
->joinTableToEavCollection($this, $this->_getCurrentStoreId());
return $this;
}
/**
* Retrieves store_id from current store
*
* @return int
*/
protected function _getCurrentStoreId()
{
return (int)Mage::app()->getStore()->getId();
}
/**
* Add active category filter
*
* @return Mage_Catalog_Model_Resource_Category_Collection
*/
public function addIsActiveFilter()
{
$this->addAttributeToFilter('is_active', 1);
Mage::dispatchEvent($this->_eventPrefix . '_add_is_active_filter',
array($this->_eventObject => $this));
return $this;
}
/**
* Add name attribute to result
*
* @return Mage_Catalog_Model_Resource_Category_Collection
*/
public function addNameToResult()
{
$this->addAttributeToSelect('name');
return $this;
}
/**
* Add url rewrite rules to collection
*
* @return Mage_Catalog_Model_Resource_Category_Collection
*/
public function addUrlRewriteToResult()
{
$this->joinUrlRewrite();
return $this;
}
/**
* Add category path filter
*
* @param array|string $paths
* @return Mage_Catalog_Model_Resource_Category_Collection
*/
public function addPathsFilter($paths)
{
if (!is_array($paths)) {
$paths = array($paths);
}
$write = $this->getResource()->getWriteConnection();
$cond = array();
foreach ($paths as $path) {
$cond[] = $write->quoteInto('e.path LIKE ?', "$path%");
}
if ($cond) {
$this->getSelect()->where(join(' OR ', $cond));
}
return $this;
}
/**
* Add category level filter
*
* @param int|string $level
* @return Mage_Catalog_Model_Resource_Category_Collection
*/
public function addLevelFilter($level)
{
$this->addFieldToFilter('level', array('lteq' => $level));
return $this;
}
/**
* Add root category filter
*
* @return Mage_Catalog_Model_Resource_Category_Collection
*/
public function addRootLevelFilter()
{
$this->addFieldToFilter('path', array('neq' => '1'));
$this->addLevelFilter(1);
return $this;
}
/**
* Add order field
*
* @param string $field
* @return Mage_Catalog_Model_Resource_Category_Collection
*/
public function addOrderField($field)
{
$this->setOrder($field, self::SORT_ORDER_ASC);
return $this;
}
/**
* Set disable flat flag
*
* @param bool $flag
* @return Mage_Catalog_Model_Resource_Category_Collection
*/
public function setDisableFlat($flag)
{
$this->_disableFlat = (bool) $flag;
return $this;
}
/**
* Retrieve disable flat flag value
*
* @return bool
*/
public function getDisableFlat()
{
return $this->_disableFlat;
}
/**
* Retrieve collection empty item
*
* @return Mage_Catalog_Model_Category
*/
public function getNewEmptyItem()
{
return new $this->_itemObjectClass(array('disable_flat' => $this->getDisableFlat()));
}
}