Product reviews API #8772
[Product Reviews API] - add API for product reviews
- Loading branch information
commit 3c1048f9562028ebe0963d8b13c7fd097ed75950
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,106 @@ | ||
| <?php | ||
|
|
||
| /* | ||
| * This file is part of the Sylius package. | ||
| * | ||
| * (c) Paweł Jędrzejewski | ||
| * | ||
| * For the full copyright and license information, please view the LICENSE | ||
| * file that was distributed with this source code. | ||
| */ | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| namespace Sylius\Bundle\AdminApiBundle\Controller; | ||
|
|
||
| use Symfony\Component\HttpFoundation\JsonResponse; | ||
| use Symfony\Component\HttpFoundation\Request; | ||
| use Symfony\Component\HttpFoundation\Response; | ||
| use Doctrine\ORM\EntityManagerInterface; | ||
| use Sylius\Component\Core\Repository\ProductReviewRepositoryInterface; | ||
| use Sylius\Component\Resource\Repository\RepositoryInterface; | ||
| use Sylius\Component\Review\Model\ReviewInterface; | ||
|
|
||
| /** | ||
| * @author Paul Stoica <paul.stoica18@gmail.com> | ||
| */ | ||
| final class UpdateProductReviewStatusController | ||
| { | ||
| /** | ||
| * @var ProductReviewRepositoryInterface | ||
| */ | ||
| private $productReviewRepository; | ||
|
|
||
| /** | ||
| * @var EntityManagerInterface | ||
| */ | ||
| private $manager; | ||
|
|
||
| /** | ||
| * @param RepositoryInterface $productReviewRepository | ||
| * @param EntityManagerInterface $manager | ||
| */ | ||
| public function __construct( | ||
| RepositoryInterface $productReviewRepository, | ||
| EntityManagerInterface $manager | ||
| ) { | ||
| $this->productReviewRepository = $productReviewRepository; | ||
| $this->manager = $manager; | ||
| } | ||
|
|
||
| /** | ||
| * @param Request $request | ||
| * | ||
| * @return JsonResponse | ||
| */ | ||
| public function acceptProductReviewAction(Request $request): JsonResponse | ||
| { | ||
| $reviewId = $request->get('id'); | ||
| $productCode = $request->get('productCode'); | ||
|
|
||
| if (!in_array($request->getMethod(), ['POST', 'PUT', 'PATCH'], true) && (null === $reviewId || null === $productCode)) { | ||
| return new JsonResponse(null, Response::HTTP_NO_CONTENT); | ||
| } | ||
|
|
||
| /** @var ReviewInterface $productReview */ | ||
| $productReview = $this->productReviewRepository->findOneByIdAndProductCode( | ||
| $reviewId, | ||
| $productCode | ||
| ); | ||
|
|
||
| $productReview->setStatus(ReviewInterface::STATUS_ACCEPTED); | ||
|
|
||
| $this->manager->persist($productReview); | ||
| $this->manager->flush(); | ||
|
|
||
| return new JsonResponse(null, Response::HTTP_NO_CONTENT); | ||
| } | ||
|
|
||
| /** | ||
| * @param Request $request | ||
| * | ||
| * @return JsonResponse | ||
| */ | ||
| public function rejectProductReviewAction(Request $request): JsonResponse | ||
| { | ||
| $reviewId = $request->get('id'); | ||
| $productCode = $request->get('productCode'); | ||
|
|
||
| if (!in_array($request->getMethod(), ['POST', 'PUT', 'PATCH'], true) && (null === $reviewId || null === $productCode)) { | ||
| return new JsonResponse(null, Response::HTTP_NO_CONTENT); | ||
| } | ||
|
|
||
| /** @var ReviewInterface $productReview */ | ||
| $productReview = $this->productReviewRepository->findOneByIdAndProductCode( | ||
| $reviewId, | ||
| $productCode | ||
| ); | ||
|
|
||
| $productReview->setStatus(ReviewInterface::STATUS_REJECTED); | ||
|
|
||
| $this->manager->persist($productReview); | ||
| $this->manager->flush(); | ||
|
|
||
| return new JsonResponse(null, Response::HTTP_NO_CONTENT); | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| # This file is part of the Sylius package. | ||
| # (c) Paweł Jędrzejewski | ||
| # | ||
| # @author Paul Stoica <paul.stoica18@gmail.com> | ||
|
There was a problem hiding this comment. We are not using author docblocks anymore, because they are just redundant (data can be fetched from git history), please remove it from here and other files |
||
|
|
||
| sylius_grid: | ||
| grids: | ||
| sylius_admin_api_product_review: | ||
| driver: | ||
| name: doctrine/orm | ||
| options: | ||
| class: "%sylius.model.product_review.class%" | ||
| repository: | ||
| method: createQueryBuilderByProductCode | ||
| arguments: ["%locale%", $productCode] | ||
| sorting: | ||
| date: desc | ||
| fields: | ||
| date: | ||
| type: datetime | ||
| label: sylius.ui.date | ||
| path: createdAt | ||
| sortable: createdAt | ||
| options: | ||
| format: d-m-Y H:i:s | ||
| title: | ||
| type: string | ||
| label: sylius.ui.title | ||
| sortable: ~ | ||
| rating: | ||
| type: string | ||
| label: sylius.ui.rating | ||
| sortable: ~ | ||
| status: | ||
| type: twig | ||
| label: sylius.ui.status | ||
| reviewSubject: | ||
| type: string | ||
| label: sylius.ui.product | ||
| author: | ||
| type: string | ||
| label: sylius.ui.customer | ||
| filters: | ||
| title: | ||
| type: string | ||
| label: sylius.ui.title | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,84 @@ | ||
| # This file is part of the Sylius package. | ||
| # (c) Paweł Jędrzejewski | ||
| # | ||
| # @author Paul Stoica <paul.stoica18@gmail.com> | ||
|
|
||
| sylius_admin_api_product_review: | ||
| resource: | | ||
| path: 'reviews' | ||
| grid: sylius_admin_api_product_review | ||
| alias: sylius.product_review | ||
| section: admin_api | ||
| only: ['index'] | ||
| serialization_version: $version | ||
| vars: | ||
| route: | ||
| parameters: | ||
| productCode: $productCode | ||
| type: sylius.resource_api | ||
|
|
||
| sylius_admin_api_product_review_create: | ||
| path: /reviews/ | ||
| methods: [POST] | ||
| defaults: | ||
| _controller: sylius.controller.product_review:createAction | ||
| _sylius: | ||
| serialization_groups: [Default, Detailed] | ||
| serialization_version: $version | ||
| section: admin_api | ||
| form: Sylius\Bundle\CoreBundle\Form\Type\Product\ProductReviewType | ||
| factory: | ||
| method: createForSubject | ||
| arguments: | ||
| - expr:notFoundOnNull(service('sylius.repository.product').findOneByCode($productCode)) | ||
|
|
||
| sylius_admin_api_product_review_update: | ||
| path: /reviews/{id} | ||
| methods: [PUT, PATCH] | ||
| defaults: | ||
| _controller: sylius.controller.product_review:updateAction | ||
| _sylius: | ||
| serialization_version: $version | ||
| section: admin_api | ||
| form: Sylius\Bundle\CoreBundle\Form\Type\Product\ProductReviewType | ||
| repository: | ||
| method: findOneByIdAndProductCode | ||
| arguments: [$id, $productCode] | ||
|
|
||
| sylius_admin_api_product_review_delete: | ||
| path: /reviews/{id} | ||
| methods: [DELETE] | ||
| defaults: | ||
| _controller: sylius.controller.product_review:deleteAction | ||
| _sylius: | ||
| serialization_version: $version | ||
| section: admin_api | ||
| repository: | ||
| method: findOneByIdAndProductCode | ||
| arguments: [$id, $productCode] | ||
| csrf_protection: false | ||
|
|
||
| sylius_admin_api_product_review_show: | ||
| path: /reviews/{code} | ||
| methods: [GET] | ||
| defaults: | ||
| _controller: sylius.controller.product_review:showAction | ||
| _sylius: | ||
| serialization_version: $version | ||
| section: admin_api | ||
| serialization_groups: [Default, Detailed] | ||
| repository: | ||
| method: findOneByIdAndProductCode | ||
| arguments: [$code, $productCode] | ||
|
|
||
| sylius_admin_api_product_review_accept: | ||
| path: /reviews/{id}/accept | ||
| methods: [POST, PUT, PATCH] | ||
| defaults: | ||
| _controller: sylius.controller.update_product_review_status:acceptProductReviewAction | ||
|
|
||
| sylius_admin_api_product_review_reject: | ||
| path: /reviews/{id}/reject | ||
| methods: [POST, PUT, PATCH] | ||
| defaults: | ||
| _controller: sylius.controller.update_product_review_status:rejectProductReviewAction |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -13,12 +13,14 @@ | |
|
|
||
| namespace Sylius\Component\Core\Repository; | ||
|
|
||
| use Doctrine\ORM\QueryBuilder; | ||
| use Sylius\Component\Core\Model\ChannelInterface; | ||
| use Sylius\Component\Resource\Repository\RepositoryInterface; | ||
| use Sylius\Component\Review\Model\ReviewInterface; | ||
|
|
||
| /** | ||
| * @author Mateusz Zalewski <mateusz.zalewski@lakion.com> | ||
| * @author Paul Stoica <paul.stoica18@gmail.com> | ||
| */ | ||
| interface ProductReviewRepositoryInterface extends RepositoryInterface | ||
| { | ||
|
|
@@ -38,4 +40,20 @@ public function findLatestByProductId($productId, int $count): array; | |
| * @return array|ReviewInterface[] | ||
| */ | ||
| public function findAcceptedByProductSlugAndChannel(string $slug, string $locale, ChannelInterface $channel): array; | ||
|
|
||
| /** | ||
| * @param string $locale | ||
| * @param string $productCode | ||
| * | ||
| * @return QueryBuilder | ||
| */ | ||
| public function createQueryBuilderByProductCode(string $locale, string $productCode): QueryBuilder; | ||
|
There was a problem hiding this comment. Adding methods to an interface is a BC break. There was a problem hiding this comment. @pamil, in this case how can proceed next? Should we put the methods only into the ProductReviewRepository? There was a problem hiding this comment. According to our proposed BC promise (#8901), it isn't a BC break 🎉 |
||
|
|
||
| /** | ||
| * @param integer $id | ||
|
|
||
| * @param string $productCode | ||
|
|
||
| * | ||
| * @return ReviewInterface|null | ||
| */ | ||
| public function findOneByIdAndProductCode(string $id, string $productCode): ?ReviewInterface; | ||
|
|
||
| } | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should never do
setStatusbut use State Machine instead. :) http://docs.sylius.org/en/latest/book/architecture/state_machine.htmlThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Alright, I will make the change.