forked from magento/magento2
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathForm.php
More file actions
219 lines (199 loc) · 5.91 KB
/
Form.php
File metadata and controls
219 lines (199 loc) · 5.91 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
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
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Review\Block;
use Magento\Catalog\Model\Product;
use Magento\Customer\Model\Context;
use Magento\Customer\Model\Url;
use Magento\Review\Model\ResourceModel\Rating\Collection as RatingCollection;
/**
* Review form block
*
* @api
* @SuppressWarnings(PHPMD.CouplingBetweenObjects)
* @since 100.0.2
*/
class Form extends \Magento\Framework\View\Element\Template
{
/**
* @var \Magento\Review\Helper\Data
*/
protected $_reviewData = null;
/**
* Catalog product model
*
* @var \Magento\Catalog\Api\ProductRepositoryInterface
*/
protected $productRepository;
/**
* Rating model
*
* @var \Magento\Review\Model\RatingFactory
*/
protected $_ratingFactory;
/**
* @var \Magento\Framework\Url\EncoderInterface
*/
protected $urlEncoder;
/**
* Message manager interface
*
* @var \Magento\Framework\Message\ManagerInterface
*/
protected $messageManager;
/**
* @var \Magento\Framework\App\Http\Context
*/
protected $httpContext;
/**
* @var \Magento\Customer\Model\Url
*/
protected $customerUrl;
/**
* @var array
*/
protected $jsLayout;
/**
* @var \Magento\Framework\Serialize\Serializer\Json
*/
private $serializer;
/**
* @param \Magento\Framework\View\Element\Template\Context $context
* @param \Magento\Framework\Url\EncoderInterface $urlEncoder
* @param \Magento\Review\Helper\Data $reviewData
* @param \Magento\Catalog\Api\ProductRepositoryInterface $productRepository
* @param \Magento\Review\Model\RatingFactory $ratingFactory
* @param \Magento\Framework\Message\ManagerInterface $messageManager
* @param \Magento\Framework\App\Http\Context $httpContext
* @param Url $customerUrl
* @param array $data
* @param \Magento\Framework\Serialize\Serializer\Json|null $serializer
* @throws \RuntimeException
* @SuppressWarnings(PHPMD.ExcessiveParameterList)
*/
public function __construct(
\Magento\Framework\View\Element\Template\Context $context,
\Magento\Framework\Url\EncoderInterface $urlEncoder,
\Magento\Review\Helper\Data $reviewData,
\Magento\Catalog\Api\ProductRepositoryInterface $productRepository,
\Magento\Review\Model\RatingFactory $ratingFactory,
\Magento\Framework\Message\ManagerInterface $messageManager,
\Magento\Framework\App\Http\Context $httpContext,
\Magento\Customer\Model\Url $customerUrl,
array $data = [],
\Magento\Framework\Serialize\Serializer\Json $serializer = null
) {
$this->urlEncoder = $urlEncoder;
$this->_reviewData = $reviewData;
$this->productRepository = $productRepository;
$this->_ratingFactory = $ratingFactory;
$this->messageManager = $messageManager;
$this->httpContext = $httpContext;
$this->customerUrl = $customerUrl;
parent::__construct($context, $data);
$this->jsLayout = isset($data['jsLayout']) ? $data['jsLayout'] : [];
$this->serializer = $serializer ?: \Magento\Framework\App\ObjectManager::getInstance()
->get(\Magento\Framework\Serialize\Serializer\Json::class);
}
/**
* Initialize review form
*
* @return void
*/
protected function _construct()
{
parent::_construct();
$this->setAllowWriteReviewFlag(
$this->httpContext->getValue(Context::CONTEXT_AUTH)
|| $this->_reviewData->getIsGuestAllowToWrite()
);
if (!$this->getAllowWriteReviewFlag()) {
$queryParam = $this->urlEncoder->encode(
$this->getUrl('*/*/*', ['_current' => true]) . '#review-form'
);
$this->setLoginLink(
$this->getUrl(
'customer/account/login/',
[Url::REFERER_QUERY_PARAM_NAME => $queryParam]
)
);
}
$this->setTemplate('Magento_Review::form.phtml');
}
/**
* Return JavaScript layout object
*
* @return string
*/
public function getJsLayout()
{
return $this->serializer->serialize($this->jsLayout);
}
/**
* Get product info
*
* @return \Magento\Catalog\Api\Data\ProductInterface
* @throws \Magento\Framework\Exception\NoSuchEntityException
*/
public function getProductInfo()
{
return $this->productRepository->getById(
$this->getProductId(),
false,
$this->_storeManager->getStore()->getId()
);
}
/**
* Get review product post action
*
* @return string
*/
public function getAction()
{
return $this->getUrl(
'review/product/post',
[
'_secure' => $this->getRequest()->isSecure(),
'id' => $this->getProductId(),
]
);
}
/**
* Get collection of ratings
*
* @return RatingCollection
* @throws \Magento\Framework\Exception\LocalizedException
*/
public function getRatings()
{
return $this->_ratingFactory->create()->getResourceCollection()->addEntityFilter(
'product'
)->setPositionOrder()->addRatingPerStoreName(
$this->_storeManager->getStore()->getId()
)->setStoreFilter(
$this->_storeManager->getStore()->getId()
)->setActiveFilter(
true
)->load()->addOptionToItems();
}
/**
* Return register URL
*
* @return string
*/
public function getRegisterUrl()
{
return $this->customerUrl->getRegisterUrl();
}
/**
* Get review product id
*
* @return int
*/
protected function getProductId()
{
return $this->getRequest()->getParam('id', false);
}
}