| Current File : /var/www/vinorea/src/PrestaShopBundle/Controller/Admin/Improve/International/LanguageController.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\Language\Command\BulkDeleteLanguagesCommand;
use PrestaShop\PrestaShop\Core\Domain\Language\Command\BulkToggleLanguagesStatusCommand;
use PrestaShop\PrestaShop\Core\Domain\Language\Command\DeleteLanguageCommand;
use PrestaShop\PrestaShop\Core\Domain\Language\Command\ToggleLanguageStatusCommand;
use PrestaShop\PrestaShop\Core\Domain\Language\Exception\CannotDisableDefaultLanguageException;
use PrestaShop\PrestaShop\Core\Domain\Language\Exception\CopyingNoPictureException;
use PrestaShop\PrestaShop\Core\Domain\Language\Exception\DefaultLanguageException;
use PrestaShop\PrestaShop\Core\Domain\Language\Exception\LanguageConstraintException;
use PrestaShop\PrestaShop\Core\Domain\Language\Exception\LanguageException;
use PrestaShop\PrestaShop\Core\Domain\Language\Exception\LanguageImageUploadingException;
use PrestaShop\PrestaShop\Core\Domain\Language\Exception\LanguageNotFoundException;
use PrestaShop\PrestaShop\Core\Domain\Language\Query\GetLanguageForEditing;
use PrestaShop\PrestaShop\Core\Domain\Language\QueryResult\EditableLanguage;
use PrestaShop\PrestaShop\Core\Grid\Definition\Factory\LanguageGridDefinitionFactory;
use PrestaShop\PrestaShop\Core\Image\Uploader\Exception\UploadedImageConstraintException;
use PrestaShop\PrestaShop\Core\Search\Filters\LanguageFilters;
use PrestaShop\PrestaShop\Core\Util\Url\UrlFileCheckerInterface;
use PrestaShopBundle\Controller\Admin\FrameworkBundleAdminController;
use PrestaShopBundle\Security\Annotation\AdminSecurity;
use PrestaShopBundle\Security\Annotation\DemoRestricted;
use PrestaShopBundle\Service\Grid\ResponseBuilder;
use Symfony\Component\HttpFoundation\RedirectResponse;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
/**
* Class LanguageController manages "Improve > International > Localization > Languages".
*/
class LanguageController extends FrameworkBundleAdminController
{
/**
* Show languages listing page.
*
* @AdminSecurity("is_granted('read', request.get('_legacy_controller'))")
*
* @param Request $request
* @param LanguageFilters $filters
*
* @return Response
*/
public function indexAction(Request $request, LanguageFilters $filters)
{
$languageGridFactory = $this->get('prestashop.core.grid.factory.language');
$languageGrid = $languageGridFactory->getGrid($filters);
return $this->render('@PrestaShop/Admin/Improve/International/Language/index.html.twig', [
'languageGrid' => $this->presentGrid($languageGrid),
'isHtaccessFileWriter' => $this->get(UrlFileCheckerInterface::class)->isHtaccessFileWritable(),
'help_link' => $this->generateSidebarLink($request->attributes->get('_legacy_controller')),
'multistoreInfoTip' => $this->trans(
'Note that this page is available in all shops context only, this is why your context has just switched.',
'Admin.Notifications.Info'
),
'multistoreIsUsed' => $this->get('prestashop.adapter.multistore_feature')->isUsed(),
]);
}
/**
* @deprecated since 1.7.8 and will be removed in next major. Use CommonController:searchGridAction instead
*
* Process Grid search.
*
* @AdminSecurity("is_granted('read', request.get('_legacy_controller'))")
*
* @param Request $request
*
* @return RedirectResponse
*/
public function searchGridAction(Request $request)
{
/** @var ResponseBuilder $responseBuilder */
$responseBuilder = $this->get('prestashop.bundle.grid.response_builder');
return $responseBuilder->buildSearchResponse(
$this->get('prestashop.core.grid.definition.factory.language'),
$request,
LanguageGridDefinitionFactory::GRID_ID,
'admin_languages_index'
);
}
/**
* Show language creation form page and handle its submit.
*
* @AdminSecurity("is_granted('create', request.get('_legacy_controller'))")
*
* @param Request $request
*
* @return Response
*/
public function createAction(Request $request)
{
$languageFormHandler = $this->get('prestashop.core.form.identifiable_object.handler.language_form_handler');
$languageFormBuilder = $this->get('prestashop.core.form.identifiable_object.builder.language_form_builder');
$languageForm = $languageFormBuilder->getForm();
$languageForm->handleRequest($request);
try {
$result = $languageFormHandler->handle($languageForm);
if (null !== $result->getIdentifiableObjectId()) {
$this->addFlash('success', $this->trans('Successful creation', 'Admin.Notifications.Success'));
return $this->redirectToRoute('admin_languages_index');
}
} catch (Exception $e) {
$this->addFlash('error', $this->getErrorMessageForException($e, $this->getErrorMessages($e)));
}
return $this->render('@PrestaShop/Admin/Improve/International/Language/create.html.twig', [
'languageForm' => $languageForm->createView(),
'help_link' => $this->generateSidebarLink($request->attributes->get('_legacy_controller')),
'enableSidebar' => true,
]);
}
/**
* Show language edit form page and handle its submit.
*
* @AdminSecurity("is_granted('update', request.get('_legacy_controller'))")
*
* @param int $languageId
* @param Request $request
*
* @return Response
*/
public function editAction($languageId, Request $request)
{
$languageFormHandler = $this->get('prestashop.core.form.identifiable_object.handler.language_form_handler');
$languageFormBuilder = $this->get('prestashop.core.form.identifiable_object.builder.language_form_builder');
try {
$languageForm = $languageFormBuilder->getFormFor((int) $languageId, [], [
'is_for_editing' => true,
]);
} catch (Exception $exception) {
$this->addFlash(
'error',
$this->getErrorMessageForException($exception, $this->getErrorMessages($exception))
);
return $this->redirectToRoute('admin_languages_index');
}
try {
$languageForm->handleRequest($request);
$result = $languageFormHandler->handleFor((int) $languageId, $languageForm);
if ($result->isSubmitted() && $result->isValid()) {
$this->addFlash(
'success',
$this->trans('Successful update', 'Admin.Notifications.Success')
);
return $this->redirectToRoute('admin_languages_index');
}
} catch (Exception $e) {
$this->addFlash('error', $this->getErrorMessageForException($e, $this->getErrorMessages($e)));
if ($e instanceof LanguageNotFoundException) {
return $this->redirectToRoute('admin_languages_index');
}
}
/** @var EditableLanguage $editableLanguage */
$editableLanguage = $this->getQueryBus()->handle(new GetLanguageForEditing((int) $languageId));
return $this->render('@PrestaShop/Admin/Improve/International/Language/edit.html.twig', [
'languageForm' => $languageForm->createView(),
'editableLanguage' => $editableLanguage,
'help_link' => $this->generateSidebarLink($request->attributes->get('_legacy_controller')),
'enableSidebar' => true,
]);
}
/**
* Deletes language
*
* @AdminSecurity("is_granted('delete', request.get('_legacy_controller'))", redirectRoute="admin_languages_index")
* @DemoRestricted(redirectRoute="admin_languages_index")
*
* @param int $languageId
*
* @return RedirectResponse
*/
public function deleteAction($languageId)
{
try {
$this->getCommandBus()->handle(new DeleteLanguageCommand((int) $languageId));
$this->addFlash('success', $this->trans('Successful deletion', 'Admin.Notifications.Success'));
} catch (LanguageException $e) {
$this->addFlash('error', $this->getErrorMessageForException($e, $this->getErrorMessages($e)));
}
return $this->redirectToRoute('admin_languages_index');
}
/**
* Deletes languages in bulk action
*
* @AdminSecurity("is_granted('delete', request.get('_legacy_controller'))", redirectRoute="admin_languages_index")
* @DemoRestricted(redirectRoute="admin_languages_index")
*
* @param Request $request
*
* @return RedirectResponse
*/
public function bulkDeleteAction(Request $request)
{
$languageIds = $this->getBulkLanguagesFromRequest($request);
try {
$this->getCommandBus()->handle(new BulkDeleteLanguagesCommand($languageIds));
$this->addFlash(
'success',
$this->trans('The selection has been successfully deleted.', 'Admin.Notifications.Success')
);
} catch (LanguageException $e) {
$this->addFlash('error', $this->getErrorMessageForException($e, $this->getErrorMessages($e)));
}
return $this->redirectToRoute('admin_languages_index');
}
/**
* Toggles language status
*
* @AdminSecurity("is_granted('update', request.get('_legacy_controller'))", redirectRoute="admin_languages_index")
* @DemoRestricted(redirectRoute="admin_languages_index")
*
* @param int $languageId
*
* @return RedirectResponse
*/
public function toggleStatusAction($languageId)
{
try {
/** @var EditableLanguage $editableLanguage */
$editableLanguage = $this->getQueryBus()->handle(new GetLanguageForEditing((int) $languageId));
$this->getCommandBus()->handle(new ToggleLanguageStatusCommand(
(int) $languageId,
!$editableLanguage->isActive()
));
$this->addFlash(
'success',
$this->trans('The status has been successfully updated.', 'Admin.Notifications.Success')
);
} catch (LanguageException $e) {
$this->addFlash('error', $this->getErrorMessageForException($e, $this->getErrorMessages($e)));
}
return $this->redirectToRoute('admin_languages_index');
}
/**
* Toggles languages status in bulk action
*
* @AdminSecurity("is_granted('update', request.get('_legacy_controller'))", redirectRoute="admin_languages_index")
* @DemoRestricted(redirectRoute="admin_languages_index")
*
* @param Request $request
* @param string $status
*
* @return RedirectResponse
*/
public function bulkToggleStatusAction(Request $request, $status)
{
$languageIds = $this->getBulkLanguagesFromRequest($request);
$expectedStatus = 'enable' === $status;
try {
$this->getCommandBus()->handle(new BulkToggleLanguagesStatusCommand(
$languageIds,
$expectedStatus
));
$this->addFlash(
'success',
$this->trans('The status has been successfully updated.', 'Admin.Notifications.Success')
);
} catch (LanguageException $e) {
$this->addFlash('error', $this->getErrorMessageForException($e, $this->getErrorMessages($e)));
}
return $this->redirectToRoute('admin_languages_index');
}
/**
* @param Exception $e
*
* @return array
*/
private function getErrorMessages(Exception $e)
{
$iniConfig = $this->get('prestashop.core.configuration.ini_configuration');
return [
LanguageNotFoundException::class => $this->trans(
'The object cannot be loaded (or found).',
'Admin.Notifications.Error'
),
CannotDisableDefaultLanguageException::class => $this->trans(
'You cannot change the status of the default language.',
'Admin.International.Notification'
),
UploadedImageConstraintException::class => [
UploadedImageConstraintException::EXCEEDED_SIZE => $this->trans(
'Max file size allowed is "%s" bytes.', 'Admin.Notifications.Error', [
$iniConfig->getUploadMaxSizeInBytes(),
]),
UploadedImageConstraintException::UNRECOGNIZED_FORMAT => $this->trans(
'Image format not recognized, allowed formats are: .gif, .jpg, .png',
'Admin.Notifications.Error'
),
],
CopyingNoPictureException::class => [
CopyingNoPictureException::PRODUCT_IMAGE_COPY_ERROR => $this->trans(
'An error occurred while copying "No Picture" image to your product folder.',
'Admin.International.Notification'
),
CopyingNoPictureException::CATEGORY_IMAGE_COPY_ERROR => $this->trans(
'An error occurred while copying "No picture" image to your category folder.',
'Admin.International.Notification'
),
CopyingNoPictureException::BRAND_IMAGE_COPY_ERROR => $this->trans(
'An error occurred while copying "No picture" image to your brand folder.',
'Admin.International.Notification'
),
],
LanguageImageUploadingException::class => [
LanguageImageUploadingException::MEMORY_LIMIT_RESTRICTION => $this->trans(
'Due to memory limit restrictions, this image cannot be loaded. Please increase your memory_limit value via your server\'s configuration settings.',
'Admin.Notifications.Error'
),
LanguageImageUploadingException::UNEXPECTED_ERROR => $this->trans(
'An error occurred while uploading the image.',
'Admin.Notifications.Error'
),
],
LanguageConstraintException::class => [
LanguageConstraintException::INVALID_ISO_CODE => $this->trans(
'The %s field is invalid.',
'Admin.Notifications.Error',
[sprintf('"%s"', $this->trans('ISO code', 'Admin.International.Feature'))]
),
LanguageConstraintException::INVALID_IETF_TAG => $this->trans(
'The %s field is invalid.',
'Admin.Notifications.Error',
[sprintf('"%s"', $this->trans('Language code', 'Admin.International.Feature'))]
),
LanguageConstraintException::DUPLICATE_ISO_CODE => $this->trans(
'This ISO code is already linked to another language.',
'Admin.International.Notification'
),
LanguageConstraintException::EMPTY_BULK_DELETE => $this->trans(
'You must select at least one element to delete.',
'Admin.Notifications.Error'
),
],
DefaultLanguageException::class => [
DefaultLanguageException::CANNOT_DELETE_ERROR => $this->trans(
'You cannot delete the default language.',
'Admin.International.Notification'
),
DefaultLanguageException::CANNOT_DISABLE_ERROR => $this->trans(
'You cannot change the status of the default language.',
'Admin.International.Notification'
),
DefaultLanguageException::CANNOT_DELETE_DEFAULT_ERROR => $this->trans(
'You cannot delete the default language.',
'Admin.International.Notification'
),
DefaultLanguageException::CANNOT_DELETE_IN_USE_ERROR => $this->trans(
'You cannot delete the language currently in use. Please select a different language.',
'Admin.International.Notification'
),
],
];
}
/**
* Get language ids from request for bulk action
*
* @param Request $request
*
* @return int[]
*/
private function getBulkLanguagesFromRequest(Request $request)
{
$languageIds = $request->request->get('language_language_bulk');
if (!is_array($languageIds)) {
return [];
}
foreach ($languageIds as $i => $languageId) {
$languageIds[$i] = (int) $languageId;
}
return $languageIds;
}
}