| Current File : //var/www/vinorea/src/PrestaShopBundle/Controller/Admin/Improve/International/TaxController.php |
<?php
/**
* Copyright since 2007 PrestaShop SA and Contributors
* PrestaShop is an International Registered Trademark & Property of PrestaShop SA
*
* NOTICE OF LICENSE
*
* This source file is subject to the Open Software License (OSL 3.0)
* that is bundled with this package in the file LICENSE.md.
* It is also available through the world-wide-web at this URL:
* https://opensource.org/licenses/OSL-3.0
* If you did not receive a copy of the license and are unable to
* obtain it through the world-wide-web, please send an email
* to license@prestashop.com so we can send you a copy immediately.
*
* DISCLAIMER
*
* Do not edit or add to this file if you wish to upgrade PrestaShop to newer
* versions in the future. If you wish to customize PrestaShop for your
* needs please refer to https://devdocs.prestashop.com/ for more information.
*
* @author PrestaShop SA and Contributors <contact@prestashop.com>
* @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\Improve\International;
use Exception;
use PrestaShop\PrestaShop\Core\Domain\Tax\Command\BulkDeleteTaxCommand;
use PrestaShop\PrestaShop\Core\Domain\Tax\Command\BulkToggleTaxStatusCommand;
use PrestaShop\PrestaShop\Core\Domain\Tax\Command\DeleteTaxCommand;
use PrestaShop\PrestaShop\Core\Domain\Tax\Command\ToggleTaxStatusCommand;
use PrestaShop\PrestaShop\Core\Domain\Tax\Exception\DeleteTaxException;
use PrestaShop\PrestaShop\Core\Domain\Tax\Exception\TaxException;
use PrestaShop\PrestaShop\Core\Domain\Tax\Exception\TaxNotFoundException;
use PrestaShop\PrestaShop\Core\Domain\Tax\Exception\UpdateTaxException;
use PrestaShop\PrestaShop\Core\Domain\Tax\Query\GetTaxForEditing;
use PrestaShop\PrestaShop\Core\Domain\Tax\QueryResult\EditableTax;
use PrestaShop\PrestaShop\Core\Form\FormHandlerInterface;
use PrestaShop\PrestaShop\Core\Search\Filters\TaxFilters;
use PrestaShopBundle\Controller\Admin\FrameworkBundleAdminController;
use PrestaShopBundle\Security\Annotation\AdminSecurity;
use PrestaShopBundle\Security\Annotation\DemoRestricted;
use Symfony\Component\HttpFoundation\RedirectResponse;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
/**
* Responsible for handling "Improve > International > Taxes" page.
*/
class TaxController extends FrameworkBundleAdminController
{
/**
* Show taxes page.
*
* @AdminSecurity("is_granted('read', request.get('_legacy_controller'))")
*
* @param Request $request
* @param TaxFilters $filters
*
* @return Response
*/
public function indexAction(Request $request, TaxFilters $filters)
{
$legacyController = $request->attributes->get('_legacy_controller');
$taxGridFactory = $this->get('prestashop.core.grid.factory.tax');
$taxGrid = $taxGridFactory->getGrid($filters);
$taxOptionsForm = $this->getTaxOptionsFormHandler()->getForm();
return $this->render('@PrestaShop/Admin/Improve/International/Tax/index.html.twig', [
'taxGrid' => $this->presentGrid($taxGrid),
'enableSidebar' => true,
'help_link' => $this->generateSidebarLink($legacyController),
'taxOptionsForm' => $taxOptionsForm->createView(),
]);
}
/**
* Process tax options configuration form.
*
* @AdminSecurity(
* "is_granted('update', request.get('_legacy_controller')) && is_granted('create', request.get('_legacy_controller')) && is_granted('delete', request.get('_legacy_controller'))",
* redirectRoute="admin_taxes_index"
* )
* @DemoRestricted(redirectRoute="admin_taxes_index")
*
* @param Request $request
*
* @return RedirectResponse
*/
public function saveOptionsAction(Request $request)
{
$taxOptionsFormHandler = $this->getTaxOptionsFormHandler();
$taxOptionsForm = $taxOptionsFormHandler->getForm();
$taxOptionsForm->handleRequest($request);
if ($taxOptionsForm->isSubmitted()) {
$errors = $taxOptionsFormHandler->save($taxOptionsForm->getData());
if (empty($errors)) {
$this->addFlash('success', $this->trans('Update successful', 'Admin.Notifications.Success'));
return $this->redirectToRoute('admin_taxes_index');
}
$this->flashErrors($errors);
}
return $this->redirectToRoute('admin_taxes_index');
}
/**
* @deprecated since 1.7.8 and will be removed in next major. Use CommonController:searchGridAction instead
*
* Provides filters functionality.
*
* @AdminSecurity("is_granted('read', request.get('_legacy_controller'))")
*
* @param Request $request
*
* @return RedirectResponse
*/
public function searchAction(Request $request)
{
$definitionFactory = $this->get('prestashop.core.grid.definition.factory.tax');
$definitionFactory = $definitionFactory->getDefinition();
$gridFilterFormFactory = $this->get('prestashop.core.grid.filter.form_factory');
$searchParametersForm = $gridFilterFormFactory->create($definitionFactory);
$searchParametersForm->handleRequest($request);
$filters = [];
if ($searchParametersForm->isSubmitted()) {
$filters = $searchParametersForm->getData();
}
return $this->redirectToRoute('admin_taxes_index', ['filters' => $filters]);
}
/**
* @AdminSecurity(
* "is_granted('create', request.get('_legacy_controller'))",
* redirectRoute="admin_taxes_index",
* )
*
* @param Request $request
*
* @return Response
*/
public function createAction(Request $request)
{
$taxFormHandler = $this->get('prestashop.core.form.identifiable_object.handler.tax_form_handler');
$taxFormBuilder = $this->get('prestashop.core.form.identifiable_object.builder.tax_form_builder');
try {
$taxForm = $taxFormBuilder->getForm();
} catch (Exception $exception) {
$this->addFlash(
'error',
$this->getErrorMessageForException($exception, $this->getErrorMessages())
);
return $this->redirectToRoute('admin_taxes_index');
}
try {
$taxForm->handleRequest($request);
$result = $taxFormHandler->handle($taxForm);
if (null !== $result->getIdentifiableObjectId()) {
$this->addFlash(
'success',
$this->trans('Successful creation', 'Admin.Notifications.Success')
);
return $this->redirectToRoute('admin_taxes_index');
}
} catch (Exception $e) {
$this->addFlash('error', $this->getErrorMessageForException($e, $this->getErrorMessages()));
}
return $this->render('@PrestaShop/Admin/Improve/International/Tax/create.html.twig', [
'taxForm' => $taxForm->createView(),
'help_link' => $this->generateSidebarLink($request->attributes->get('_legacy_controller')),
'enableSidebar' => true,
'multistoreInfoTip' => $this->trans(
'Note that this feature is only available in the "all stores" context. It will be added to all your stores.',
'Admin.Notifications.Info'
),
'multistoreIsUsed' => $this->get('prestashop.adapter.multistore_feature')->isUsed(),
]);
}
/**
* Handles tax edit
*
* @AdminSecurity(
* "is_granted('update', request.get('_legacy_controller'))",
* redirectRoute="admin_taxes_index",
* )
*
* @param Request $request
* @param int $taxId
*
* @return Response
*/
public function editAction(Request $request, $taxId)
{
$taxFormHandler = $this->get('prestashop.core.form.identifiable_object.handler.tax_form_handler');
$taxFormBuilder = $this->get('prestashop.core.form.identifiable_object.builder.tax_form_builder');
try {
$taxForm = $taxFormBuilder->getFormFor((int) $taxId);
} catch (Exception $exception) {
$this->addFlash(
'error',
$this->getErrorMessageForException($exception, $this->getErrorMessages())
);
return $this->redirectToRoute('admin_taxes_index');
}
try {
$taxForm->handleRequest($request);
$result = $taxFormHandler->handleFor((int) $taxId, $taxForm);
if ($result->isSubmitted() && $result->isValid()) {
$this->addFlash('success', $this->trans('Successful update', 'Admin.Notifications.Success'));
return $this->redirectToRoute('admin_taxes_index');
}
} catch (Exception $e) {
$this->addFlash('error', $this->getErrorMessageForException($e, $this->getErrorMessages()));
if ($e instanceof TaxNotFoundException) {
return $this->redirectToRoute('admin_taxes_index');
}
}
/** @var EditableTax $editableTax */
$editableTax = $this->getQueryBus()->handle(new GetTaxForEditing((int) $taxId));
return $this->render('@PrestaShop/Admin/Improve/International/Tax/edit.html.twig', [
'taxForm' => $taxForm->createView(),
'taxName' => $editableTax->getLocalizedNames()[$this->getContextLangId()],
'help_link' => $this->generateSidebarLink($request->attributes->get('_legacy_controller')),
'enableSidebar' => true,
]);
}
/**
* Deletes tax.
*
* @AdminSecurity(
* "is_granted('delete', request.get('_legacy_controller'))",
* redirectRoute="admin_taxes_index",
* )
* @DemoRestricted(redirectRoute="admin_taxes_index")
*
* @param int $taxId
*
* @return RedirectResponse
*/
public function deleteAction($taxId)
{
try {
$this->getCommandBus()->handle(new DeleteTaxCommand((int) $taxId));
$this->addFlash(
'success',
$this->trans('Successful deletion', 'Admin.Notifications.Success')
);
} catch (TaxException $e) {
}
return $this->redirectToRoute('admin_taxes_index');
}
/**
* Toggles status.
*
* @param int $taxId
*
* @AdminSecurity(
* "is_granted('update', request.get('_legacy_controller'))",
* redirectRoute="admin_taxes_index",
* )
* @DemoRestricted(redirectRoute="admin_taxes_index")
*
* @return RedirectResponse
*/
public function toggleStatusAction($taxId)
{
try {
/** @var EditableTax $editableTax */
$editableTax = $this->getQueryBus()->handle(new GetTaxForEditing((int) $taxId));
$this->getCommandBus()->handle(new ToggleTaxStatusCommand((int) $taxId, !$editableTax->isActive()));
$this->addFlash(
'success',
$this->trans('The status has been successfully updated.', 'Admin.Notifications.Success')
);
} catch (TaxException $e) {
$this->addFlash('error', $this->getErrorMessageForException($e, $this->getErrorMessages()));
}
return $this->redirectToRoute('admin_taxes_index');
}
/**
* Enables taxes status on bulk action.
*
* @param Request $request
*
* @AdminSecurity(
* "is_granted('update', request.get('_legacy_controller'))",
* redirectRoute="admin_taxes_index",
* )
* @DemoRestricted(redirectRoute="admin_taxes_index")
*
* @return RedirectResponse
*/
public function bulkEnableStatusAction(Request $request)
{
$taxIds = $request->request->get('tax_bulk');
try {
$this->getCommandBus()->handle(new BulkToggleTaxStatusCommand($taxIds, true));
$this->addFlash(
'success',
$this->trans('The status has been successfully updated.', 'Admin.Notifications.Success')
);
} catch (TaxException $e) {
$this->addFlash('error', $this->getErrorMessageForException($e, $this->getErrorMessages()));
}
return $this->redirectToRoute('admin_taxes_index');
}
/**
* Disables taxes status on bulk action.
*
* @param Request $request
*
* @AdminSecurity(
* "is_granted('update', request.get('_legacy_controller'))",
* redirectRoute="admin_taxes_index",
* )
* @DemoRestricted(redirectRoute="admin_taxes_index")
*
* @return RedirectResponse
*/
public function bulkDisableStatusAction(Request $request)
{
$taxIds = $request->request->get('tax_bulk');
try {
$this->getCommandBus()->handle(new BulkToggleTaxStatusCommand($taxIds, false));
$this->addFlash(
'success',
$this->trans('The status has been successfully updated.', 'Admin.Notifications.Success')
);
} catch (TaxException $e) {
$this->addFlash('error', $this->getErrorMessageForException($e, $this->getErrorMessages()));
}
return $this->redirectToRoute('admin_taxes_index');
}
/**
* Delete taxes on bulk action.
*
* @param Request $request
*
* @AdminSecurity(
* "is_granted('delete', request.get('_legacy_controller'))",
* redirectRoute="admin_taxes_index",
* )
* @DemoRestricted(redirectRoute="admin_taxes_index")
*
* @return RedirectResponse
*/
public function bulkDeleteAction(Request $request)
{
$taxIds = $request->request->get('tax_bulk');
try {
$this->getCommandBus()->handle(new BulkDeleteTaxCommand($taxIds));
$this->addFlash(
'success',
$this->trans('Successful deletion', 'Admin.Notifications.Success')
);
} catch (TaxException $e) {
$this->addFlash('error', $this->getErrorMessageForException($e, $this->getErrorMessages()));
}
return $this->redirectToRoute('admin_taxes_index');
}
/**
* @return FormHandlerInterface
*/
private function getTaxOptionsFormHandler(): FormHandlerInterface
{
return $this->get('prestashop.admin.tax_options.form_handler');
}
/**
* Gets error messages for exceptions
*
* @return array
*/
private function getErrorMessages()
{
return [
TaxNotFoundException::class => $this->trans(
'The object cannot be loaded (or found).',
'Admin.Notifications.Error'
),
UpdateTaxException::class => [
UpdateTaxException::FAILED_BULK_UPDATE_STATUS => [
$this->trans(
'An error occurred while updating the status.',
'Admin.Notifications.Error'
),
],
UpdateTaxException::FAILED_UPDATE_STATUS => [
$this->trans(
'An error occurred while updating the status for an object.',
'Admin.Notifications.Error'
),
],
],
DeleteTaxException::class => [
DeleteTaxException::FAILED_BULK_DELETE => $this->trans(
'An error occurred while deleting this selection.',
'Admin.Notifications.Error'
),
DeleteTaxException::FAILED_DELETE => $this->trans(
'An error occurred while deleting the object.',
'Admin.Notifications.Error'
),
],
];
}
}