* @copyright Since 2007 PrestaShop SA and Contributors * @license https://opensource.org/licenses/OSL-3.0 Open Software License (OSL 3.0) */ namespace PrestaShopBundle\Controller\Admin\Sell\Catalog; use Exception; use PrestaShop\PrestaShop\Core\Domain\AttributeGroup\Attribute\Command\BulkDeleteAttributeCommand; use PrestaShop\PrestaShop\Core\Domain\AttributeGroup\Attribute\Command\DeleteAttributeCommand; use PrestaShop\PrestaShop\Core\Domain\AttributeGroup\Attribute\Exception\AttributeNotFoundException; use PrestaShop\PrestaShop\Core\Domain\AttributeGroup\Attribute\Exception\DeleteAttributeException; use PrestaShop\PrestaShop\Core\Domain\AttributeGroup\Exception\AttributeGroupNotFoundException; use PrestaShop\PrestaShop\Core\Exception\TranslatableCoreException; use PrestaShop\PrestaShop\Core\Grid\Position\GridPositionUpdaterInterface; use PrestaShop\PrestaShop\Core\Grid\Position\PositionUpdateFactoryInterface; use PrestaShop\PrestaShop\Core\Search\Filters\AttributeFilters; use PrestaShopBundle\Controller\Admin\FrameworkBundleAdminController; use PrestaShopBundle\Security\Annotation\AdminSecurity; use Symfony\Component\HttpFoundation\RedirectResponse; use Symfony\Component\HttpFoundation\Request; use Symfony\Component\HttpFoundation\Response; /** * Responsible for Sell > Catalog > Attributes & Features > Attributes > Attribute */ class AttributeController extends FrameworkBundleAdminController { /** * Displays Attribute groups > attributes page * * @AdminSecurity("is_granted('read', request.get('_legacy_controller'))", * redirectRoute="admin_attributes_index", * redirectQueryParamsToKeep={"attributeGroupId"} * ) * * @param Request $request * @param int|string $attributeGroupId * @param AttributeFilters $attributeFilters * * @return Response */ public function indexAction(Request $request, $attributeGroupId, AttributeFilters $attributeFilters) { try { $attributeGridFactory = $this->get('prestashop.core.grid.factory.attribute'); $attributeGrid = $attributeGridFactory->getGrid($attributeFilters); } catch (Exception $e) { $this->addFlash('error', $this->getErrorMessageForException($e, $this->getErrorMessages())); return $this->redirectToRoute('admin_attribute_groups_index'); } return $this->render('@PrestaShop/Admin/Sell/Catalog/Attribute/index.html.twig', [ 'attributeGrid' => $this->presentGrid($attributeGrid), 'attributeGroupId' => $attributeGroupId, 'enableSidebar' => true, 'help_link' => $this->generateSidebarLink($request->attributes->get('_legacy_controller')), ]); } /** * Updates attributes positioning order * * @AdminSecurity("is_granted('update', request.get('_legacy_controller'))", * redirectRoute="admin_attributes_index", * redirectQueryParamsToKeep={"attributeGroupId"} * ) * * @param Request $request * @param int $attributeGroupId * * @return RedirectResponse */ public function updatePositionAction(Request $request, int $attributeGroupId) { $positionsData = [ 'positions' => $request->request->get('positions'), 'parentId' => $attributeGroupId, ]; $positionDefinition = $this->get('prestashop.core.grid.attribute.position_definition'); $positionUpdateFactory = $this->get(PositionUpdateFactoryInterface::class); try { $positionUpdate = $positionUpdateFactory->buildPositionUpdate($positionsData, $positionDefinition); $updater = $this->get(GridPositionUpdaterInterface::class); $updater->update($positionUpdate); $this->addFlash('success', $this->trans('Successful update', 'Admin.Notifications.Success')); } catch (TranslatableCoreException $e) { $errors = [$e->toArray()]; $this->flashErrors($errors); } catch (Exception $e) { $this->flashErrors([$e->getMessage()]); } return $this->redirectToRoute('admin_attributes_index', [ 'attributeGroupId' => $attributeGroupId, ]); } /** * @AdminSecurity( * "is_granted('create', request.get('_legacy_controller'))", * message="You do not have permission to create this." * ) * * @param int $attributeGroupId * * @return RedirectResponse */ public function createAction(int $attributeGroupId) { // @todo: implement in another pr return $this->redirectToRoute('admin_attributes_index', [ 'attributeGroupId' => $attributeGroupId, ]); } /** * @AdminSecurity( * "is_granted('update', request.get('_legacy_controller'))", * message="You do not have permission to update this." * ) * * @param int $attributeId * @param int $attributeGroupId * * @return RedirectResponse */ public function editAction(int $attributeId, int $attributeGroupId) { // @todo: implement in another pr return $this->redirectToRoute('admin_attributes_index', [ 'attributeGroupId' => $attributeGroupId, ]); } /** * Deletes attribute * * @AdminSecurity("is_granted('delete', request.get('_legacy_controller'))", * redirectRoute="admin_attributes_index", * redirectQueryParamsToKeep={"attributeGroupId"} * ) * * @param int $attributeGroupId * @param int $attributeId * * @return RedirectResponse */ public function deleteAction(int $attributeGroupId, int $attributeId) { try { $this->getCommandBus()->handle(new DeleteAttributeCommand((int) $attributeId)); $this->addFlash( 'success', $this->trans('Successful deletion', 'Admin.Notifications.Success') ); } catch (Exception $e) { $this->addFlash('error', $this->getErrorMessageForException($e, $this->getErrorMessages())); } return $this->redirectToRoute('admin_attributes_index', [ 'attributeGroupId' => $attributeGroupId, ]); } /** * Deletes multiple attributes by provided ids from request * * @AdminSecurity("is_granted('delete', request.get('_legacy_controller'))", * redirectRoute="admin_attributes_index", * redirectQueryParamsToKeep={"attributeGroupId"} * ) * * @param int $attributeGroupId * @param Request $request * * @return RedirectResponse */ public function bulkDeleteAction(int $attributeGroupId, Request $request) { try { $this->getCommandBus()->handle(new BulkDeleteAttributeCommand( $this->getAttributeIdsFromRequest($request)) ); $this->addFlash( 'success', $this->trans('Successful deletion', 'Admin.Notifications.Success') ); } catch (Exception $e) { $this->addFlash('error', $this->getErrorMessageForException($e, $this->getErrorMessages())); } return $this->redirectToRoute('admin_attributes_index', [ 'attributeGroupId' => $attributeGroupId, ]); } /** * @param Request $request * * @return array */ private function getAttributeIdsFromRequest(Request $request) { $attributeIds = $request->request->get('attribute_bulk'); if (!is_array($attributeIds)) { return []; } foreach ($attributeIds as $i => $attributeId) { $attributeIds[$i] = (int) $attributeId; } return $attributeIds; } /** * Provides translated error messages for exceptions * * @return array */ private function getErrorMessages() { $notFoundMessage = $this->trans( 'The object cannot be loaded (or found).', 'Admin.Notifications.Error' ); return [ AttributeNotFoundException::class => $notFoundMessage, AttributeGroupNotFoundException::class => $notFoundMessage, DeleteAttributeException::class => [ DeleteAttributeException::FAILED_DELETE => $this->trans( 'An error occurred while deleting the object.', 'Admin.Notifications.Error' ), DeleteAttributeException::FAILED_BULK_DELETE => $this->trans( 'An error occurred while deleting this selection.', 'Admin.Notifications.Error' ), ], ]; } }