forked from magento/magento2
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathRating.php
More file actions
182 lines (167 loc) · 4.92 KB
/
Rating.php
File metadata and controls
182 lines (167 loc) · 4.92 KB
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
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Review\Model;
use Magento\Framework\DataObject\IdentityInterface;
/**
* Rating model
*
* @api
* @method array getRatingCodes()
* @method \Magento\Review\Model\Rating setRatingCodes(array $value)
* @method array getStores()
* @method \Magento\Review\Model\Rating setStores(array $value)
* @method string getRatingCode()
*
* @since 100.0.2
*/
class Rating extends \Magento\Framework\Model\AbstractModel implements IdentityInterface
{
/**
* rating entity codes
*/
public const ENTITY_PRODUCT_CODE = 'product';
public const ENTITY_PRODUCT_REVIEW_CODE = 'product_review';
public const ENTITY_REVIEW_CODE = 'review';
/**
* @var \Magento\Review\Model\Rating\OptionFactory
*/
protected $_ratingOptionFactory;
/**
* @var \Magento\Review\Model\ResourceModel\Rating\Option\CollectionFactory
*/
protected $_ratingCollectionF;
/**
* @param \Magento\Framework\Model\Context $context
* @param \Magento\Framework\Registry $registry
* @param \Magento\Review\Model\Rating\OptionFactory $ratingOptionFactory
* @param \Magento\Review\Model\ResourceModel\Rating\Option\CollectionFactory $ratingCollectionF
* @param \Magento\Framework\Model\ResourceModel\AbstractResource $resource
* @param \Magento\Framework\Data\Collection\AbstractDb $resourceCollection
* @param array $data
*/
public function __construct(
\Magento\Framework\Model\Context $context,
\Magento\Framework\Registry $registry,
\Magento\Review\Model\Rating\OptionFactory $ratingOptionFactory,
\Magento\Review\Model\ResourceModel\Rating\Option\CollectionFactory $ratingCollectionF,
\Magento\Framework\Model\ResourceModel\AbstractResource $resource = null,
\Magento\Framework\Data\Collection\AbstractDb $resourceCollection = null,
array $data = []
) {
$this->_ratingOptionFactory = $ratingOptionFactory;
$this->_ratingCollectionF = $ratingCollectionF;
parent::__construct($context, $registry, $resource, $resourceCollection, $data);
}
/**
* Define resource model
*
* @return void
*/
protected function _construct()
{
$this->_init(\Magento\Review\Model\ResourceModel\Rating::class);
}
/**
* Add a vote to an option
*
* @param int $optionId
* @param int $entityPkValue
* @return $this
*/
public function addOptionVote($optionId, $entityPkValue)
{
$this->_ratingOptionFactory->create()->setOptionId(
$optionId
)->setRatingId(
$this->getId()
)->setReviewId(
$this->getReviewId()
)->setEntityPkValue(
$entityPkValue
)->addVote();
return $this;
}
/**
* Update a vote for an option
*
* @param int $optionId
* @return $this
*/
public function updateOptionVote($optionId)
{
$this->_ratingOptionFactory->create()->setOptionId(
$optionId
)->setVoteId(
$this->getVoteId()
)->setReviewId(
$this->getReviewId()
)->setDoUpdate(
1
)->addVote();
return $this;
}
/**
* Retrieve rating options
*
* @return array
*/
public function getOptions()
{
$options = $this->getData('options');
if ($options) {
return $options;
} elseif ($this->getId()) {
return $this->_ratingCollectionF->create()->addRatingFilter(
$this->getId()
)->setPositionOrder()->load()->getItems();
}
return [];
}
/**
* Get rating collection object
*
* @param int $entityPkValue
* @param bool $onlyForCurrentStore
* @return \Magento\Framework\Data\Collection\AbstractDb
*/
public function getEntitySummary($entityPkValue, $onlyForCurrentStore = true)
{
$this->setEntityPkValue($entityPkValue);
return $this->_getResource()->getEntitySummary($this, $onlyForCurrentStore);
}
/**
* Get summary of review
*
* @param int $reviewId
* @param bool $onlyForCurrentStore
* @return array
*/
public function getReviewSummary($reviewId, $onlyForCurrentStore = true)
{
$this->setReviewId($reviewId);
return $this->_getResource()->getReviewSummary($this, $onlyForCurrentStore);
}
/**
* Get rating entity type id by code
*
* @param string $entityCode
* @return int
*/
public function getEntityIdByCode($entityCode)
{
return $this->getResource()->getEntityIdByCode($entityCode);
}
/**
* Return unique ID(s) for each object in system
*
* @return array
*/
public function getIdentities()
{
// clear cache for all reviews
return [Review::CACHE_TAG];
}
}