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 <?php
/* --------------------------------------------------------------
ProductReviewsApiV2Controller.inc.php 2018-01-23
Gambio GmbH
http://www.gambio.de
Copyright (c) 2018 Gambio GmbH
Released under the GNU General Public License (Version 2)
[http://www.gnu.org/licenses/gpl-2.0.html]
--------------------------------------------------------------
*/
MainFactory::load_class('HttpApiV2Controller');
/**
* Class ProductReviewsApiV2Controller
*
* Provides a gateway to the ReviewWriteService and ReviewReadService classes, which handle the shop
* review resources.
*
* @category System
* @package ApiV2Controllers
*/
class ProductReviewsApiV2Controller extends HttpApiV2Controller
{
/**
* Reviews write service.
*
* @var ReviewWriteService
*/
protected $reviewWriteService;
/**
* Reviews read service.
*
* @var ReviewReadService
*/
protected $reviewReadService;
/**
* Review JSON serializer.
*
* @var ReviewJsonSerializer
*/
protected $reviewJsonSerializer;
/**
* @var LanguageProviderInterface
*/
protected $languageProvider;
/**
* Initializes API Controller
*/
protected function __initialize()
{
$this->reviewWriteService = StaticGXCoreLoader::getService('ReviewWrite');
$this->reviewReadService = StaticGXCoreLoader::getService('ReviewRead');
$this->reviewJsonSerializer = MainFactory::create('ReviewJsonSerializer', $this->reviewWriteService);
$this->languageProvider = MainFactory::create('LanguageProvider',
StaticGXCoreLoader::getDatabaseQueryBuilder());
}
/**
* @api {get} /products/:id/reviews/:id Get reviews or average rating for single product
* @apiVersion 2.6.0
* @apiName GetReviewsForProduct
* @apiGroup Products
*
* @apiDescription
* Get multiple, a single review record or the average rating for a single product through the GET method.
* Use optional lang (e.g.: lang=en) GET-parameter flag to filter based on the provided language code.
*
* @apiExample {curl} Get All Review records
* curl -i --user admin@shop.de:12345 http://shop.de/api.php/v2/products/1/reviews
*
* @apiExample {curl} Get All English Review records
* curl -i --user admin@shop.de:12345 http://shop.de/api.php/v2/products/1/reviews?lang=en
*
* @apiExample {curl} Get Review record with ID = 982
* curl -i --user admin@shop.de:12345 http://shop.de/api.php/v2/products/1/reviews/982
*
* @apiExample {curl} Get Average Rating For Product With ID = 1
* curl -i --user admin@shop.de:12345 http://shop.de/api.php/v2/products/1/reviews_avg
*
* @apiError 400-BadRequest Product ID is missing or invalid.
* @apiErrorExample Error-Response (Missing or invalid product ID)
* HTTP/1.1 400 Bad Request
* {
* "code": 400,
* "status": "error",
* "message": "Product record ID was not provided or is invalid."
* }
*
* @apiError 400-BadRequest Review ID is missing or invalid.
* @apiErrorExample Error-Response (Missing or invalid review ID)
* HTTP/1.1 400 Bad Request
* {
* "code": 400,
* "status": "error",
* "message": "Review record ID is invalid."
* }
*
* @apiError 404-NotFound Review record could not be found.
* @apiErrorExample Error-Response (Review Not Found)
* HTTP/1.1 404 Not Found
* {
* "code": 404,
* "status": "error",
* "message": "Review record could not be found."
* }
*/
public function get()
{
if(!isset($this->uri[1]) || !is_numeric($this->uri[1]))
{
throw new HttpApiV2Exception('Product record ID was not provided or is invalid: ' . gettype($this->uri[1]),
400);
}
if(isset($this->uri[2]) && $this->uri[2] === 'reviews_avg')
{
$productId = new IdType($this->uri[1]);
return $this->_writeResponse([
'action' => 'reviews_avg',
'productId' => $productId->asInt(),
'average' => $this->reviewReadService->getAverageRatingByProductId($productId)
]);
}
if(isset($this->uri[3]) && is_numeric($this->uri[3]))
{
try
{
$review = $this->reviewReadService->getById(new IdType((int)$this->uri[3]));
return $this->_writeResponse($this->reviewJsonSerializer->serialize($review, $encode = false));
}
catch(EntityNotFoundException $e)
{
throw new HttpApiV2Exception($e->getMessage(), 404, $e);
}
}
if(isset($this->uri[3]) && !is_numeric($this->uri[3]))
{
throw new HttpApiV2Exception('Review record ID is invalid: ' . gettype($this->uri[3]), 400);
}
$productId = new IdType($this->uri[1]);
if($this->api->request->get('lang') !== null)
{
$langParameter = $this->api->request->get('lang');
$languageCode = new LanguageCode(new NonEmptyStringType($langParameter));
$languageId = new IdType($this->languageProvider->getIdByCode($languageCode));
$reviewCollection = $this->reviewReadService->getReviewsByProductId($productId, $languageId);
}
else
{
$reviewCollection = new ReviewCollection();
foreach($this->languageProvider->getIds() as $languageId)
{
$productReviews = $this->reviewReadService->getReviewsByProductId($productId, $languageId);
foreach($productReviews as $review)
{
$reviewCollection->addItem($review);
}
}
}
return $this->_writeResponse($this->reviewJsonSerializer->serializeReviewCollection($reviewCollection,
$encode = false));
}
/**
* @api {post} /products/:id/reviews Create review for single product
* @apiVersion 2.6.0
* @apiName CreateReviewForProduct
* @apiGroup Products
*
* @apiDescription
* This method enables the creation of a new review into the system for the product with the ID that is provided in
* the request URI. The productId in the request URI will override the productId of the request body.
*
* @apiParamExample {json} Review entity
* {
* "productId": 2,
* "rating": 5,
* "languageId": 1,
* "text": "Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam",
* "customer": {
* "customerId": 3,
* "customerName": "John Doe"
* }
* }
*
* @apiParam {Number} productId The ID of the reviewed product.
* @apiParam {Number} rating The numeric rating value. All integers from 1 to 5 are valid.
* @apiParam {Number} languageId The language ID.
* @apiParam {String} text The review content.
* @apiParam {Object} customer Contains various customer specific information.
* @apiParam {Number} customer.customerId Customer's ID.
* @apiParam {String} customer.customerName Customer's name.
*
* @apiSuccess (201) Request-Body If successful, this method returns the complete review resource in the response
* body.
*
* @apiSuccessExample {json} Success-Response
* {
* "id": 3,
* "productId": 2,
* "rating": 5,
* "dateAdded": "2018-01-10 19:10:00",
* "lastModified": "2018-01-10 19:10:00",
* "languageId": 1,
* "text": "Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam",
* "customer": {
* "customerId": 3,
* "customerName": "John Doe"
* }
* }
*
* @apiError 400-BadRequest Product ID is missing or invalid.
* @apiErrorExample Error-Response (Missing or invalid product ID)
* HTTP/1.1 400 Bad Request
* {
* "code": 400,
* "status": "error",
* "message": "Product record ID was not provided or is invalid."
* }
*
* @apiError 400-BadRequest The body of the request was empty.
* @apiErrorExample Error-Response
* HTTP/1.1 400 Bad Request
* {
* "code": 400,
* "status": "error",
* "message": "Review data were not provided."
* }
*/
public function post()
{
if(!isset($this->uri[1]) || !is_numeric($this->uri[1]))
{
throw new HttpApiV2Exception('Product record ID was not provided or is invalid: ' . gettype($this->uri[1]),
400);
}
$reviewJsonString = $this->api->request->getBody();
if(empty($reviewJsonString))
{
throw new HttpApiV2Exception('Review data were not provided.', 400);
}
$productId = new IdType($this->uri[1]);
$review = $this->reviewJsonSerializer->deserialize($reviewJsonString);
$review->setProductId($productId);
$this->reviewWriteService->store($review);
$this->_writeResponse($this->reviewJsonSerializer->serialize($review, $encode = false));
}
/**
* @api {put} /products/:id/reviews/:id Update review for single product
* @apiVersion 2.6.0
* @apiName UpdateReviewForProduct
* @apiGroup Products
*
* @apiDescription
* Use this method to update an existing review record. Take a look in the POST method for more detailed
* explanation on every resource property.
*
* @apiSuccess Response-Body If successful, this method returns the updated withdrawal resource in the
* response body.
*
* @apiError 400-BadRequest Product ID is missing or invalid.
* @apiErrorExample Error-Response (Missing or invalid product ID)
* HTTP/1.1 400 Bad Request
* {
* "code": 400,
* "status": "error",
* "message": "Product record ID was not provided or is invalid."
* }
*
* @apiError 400-BadRequest Review ID is missing or invalid.
* @apiErrorExample Error-Response (Missing or invalid review ID)
* HTTP/1.1 400 Bad Request
* {
* "code": 400,
* "status": "error",
* "message": "Review record ID was not provided or is invalid."
* }
*
* @apiError 400-BadRequest Review data were not provided.
* @apiErrorExample Error-Response (No data)
* HTTP/1.1 400 Bad Request
* {
* "code": 400,
* "status": "error",
* "message": "Review data were not provided."
* }
*
* @apiError 404-NotFound Review record with provided ID not associated with provided product record ID.
* @apiErrorExample Error-Response (Wrong product-to-review association)
* HTTP/1.1 404 Not Found
* {
* "code": 404,
* "status": "error",
* "message": "Provided review record ID ([:reviewId]) is not associated with provided product record ID
* ([:productId])."
* }
*/
public function put()
{
if(!isset($this->uri[1]) || !is_numeric($this->uri[1]))
{
throw new HttpApiV2Exception('Product record ID was not provided or is invalid: ' . gettype($this->uri[1]),
400);
}
if(!isset($this->uri[3]) || !is_numeric($this->uri[3]))
{
throw new HttpApiV2Exception('Review record ID was not provided or is invalid: ' . gettype($this->uri[3]),
400);
}
$reviewJsonString = $this->api->request->getBody();
if(empty($reviewJsonString))
{
throw new HttpApiV2Exception('Review data were not provided.', 400);
}
try
{
$review = $this->reviewReadService->getById(new IdType($this->uri[3]));
if($review->getProductId() !== (int)$this->uri[1])
{
throw new EntityNotFoundException('Provided review record ID (' . $this->uri[3]
. ') is not associated with provided product record ID ('
. $this->uri[1] . ').', 404);
}
$productId = new IdType($this->uri[1]);
$review = $this->reviewJsonSerializer->deserialize($reviewJsonString, $review);
$review->setProductId($productId);
$this->reviewWriteService->store($review);
$this->_writeResponse($this->reviewJsonSerializer->serialize($review, $encode = false));
}
catch(EntityNotFoundException $e)
{
throw new HttpApiV2Exception($e->getMessage(), 404, $e);
}
}
/**
* @api {delete} /products/:1/reviews/:id Delete review
* @apiVersion 2.6.0
* @apiName DeleteReviewForProduct
* @apiGroup Products
*
* @apiDescription
* Removes a review record from the system. Assuming that the provided product-to-review association (product ID
* and review Id in request URI) is correct this method will always return success even if the review does not
* exist (due to internal ReviewWriteService architecture decisions, which strive to avoid unnecessary failures).
*
* @apiExample {curl} Delete review with ID = 84 for product with ID = 23
* curl -X DELETE --user admin@shop.de:12345 http://shop.de/api.php/v2/products/23/reviews/84
*
*
* @apiError 400-BadRequest Product ID is missing or invalid.
* @apiErrorExample Error-Response (Missing or invalid product ID)
* HTTP/1.1 400 Bad Request
* {
* "code": 400,
* "status": "error",
* "message": "Product record ID was not provided or is invalid."
* }
*
* @apiError 400-BadRequest Review ID is missing or invalid.
* @apiErrorExample Error-Response (Missing or invalid review ID)
* HTTP/1.1 400 Bad Request
* {
* "code": 400,
* "status": "error",
* "message": "Review record ID was not provided or is invalid."
* }
*
* @apiError 404-NotFound Review record with provided ID not associated with provided product record ID.
* @apiErrorExample Error-Response (Wrong product-to-review association)
* HTTP/1.1 404 Not Found
* {
* "code": 404,
* "status": "error",
* "message": "Provided review record ID ([:reviewId]) is not associated with provided product record ID
* ([:productId])."
* }
*
* @apiSuccessExample {json} Success-Response
* {
* "code": 200,
* "status": "success",
* "action": "delete",
* "reviewId": 84
* }
*/
public function delete()
{
if(!isset($this->uri[1]) || !is_numeric($this->uri[1]))
{
throw new HttpApiV2Exception('Product record ID was not provided or is invalid: ' . gettype($this->uri[1]),
400);
}
if(!isset($this->uri[3]) || !is_numeric($this->uri[3]))
{
throw new HttpApiV2Exception('Review record ID was not provided or is invalid in the resource URL', 400);
}
try
{
$review = $this->reviewReadService->getById(new IdType($this->uri[3]));
if($review->getProductId() !== (int)$this->uri[1])
{
throw new HttpApiV2Exception('Provided review record ID (' . $this->uri[3]
. ') is not associated with provided product record ID (' . $this->uri[1]
. ').', 404);
}
$this->reviewWriteService->delete($review);
}
catch(EntityNotFoundException $e)
{
}
$this->_writeResponse([
'code' => 200,
'status' => 'success',
'action' => 'delete',
'reviewId' => (int)$this->uri[3]
]);
}
}