Skip to content

Commit

Permalink
Refacto ProfileController based on PrestaShopAdminController
Browse files Browse the repository at this point in the history
  • Loading branch information
@jolelievre
jolelievre committed Oct 17, 2024
1 parent 7471624 commit cd6b289
Show file tree
Hide file tree
Showing 2 changed files with 71 additions and 50 deletions.
111 changes: 63 additions & 48 deletions src/PrestaShopBundle/Controller/Admin/Configure/AdvancedParameters/ProfileController.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,12 +38,18 @@
use PrestaShop\PrestaShop\Core\Domain\Profile\ProfileSettings;
use PrestaShop\PrestaShop\Core\Domain\Profile\Query\GetProfileForEditing;
use PrestaShop\PrestaShop\Core\Domain\Profile\QueryResult\EditableProfile;
use PrestaShop\PrestaShop\Core\Form\IdentifiableObject\Builder\FormBuilderInterface;
use PrestaShop\PrestaShop\Core\Form\IdentifiableObject\Handler\FormHandlerInterface;
use PrestaShop\PrestaShop\Core\Grid\Definition\Factory\GridDefinitionFactoryInterface;
use PrestaShop\PrestaShop\Core\Grid\Filter\GridFilterFormFactory;
use PrestaShop\PrestaShop\Core\Grid\GridFactoryInterface;
use PrestaShop\PrestaShop\Core\Image\Uploader\Exception\UploadedImageConstraintException;
use PrestaShop\PrestaShop\Core\Search\Filters\ProfileFilters;
use PrestaShopBundle\Controller\Admin\FrameworkBundleAdminController;
use PrestaShopBundle\Controller\Admin\PrestaShopAdminController;
use PrestaShopBundle\Controller\Attribute\AllShopContext;
use PrestaShopBundle\Security\Attribute\AdminSecurity;
use PrestaShopBundle\Security\Attribute\DemoRestricted;
use Symfony\Component\DependencyInjection\Attribute\Autowire;
use Symfony\Component\HttpFoundation\RedirectResponse;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
Expand All @@ -53,39 +59,34 @@
* "Configure > Advanced parameters > Team > Roles" page.
*/
#[AllShopContext]
class ProfileController extends FrameworkBundleAdminController
class ProfileController extends PrestaShopAdminController
{
/**
* Show profiles listing page.
*
* @param ProfileFilters $filters
*
* @return Response
*/
#[AdminSecurity("is_granted('read', request.get('_legacy_controller'))")]
public function indexAction(ProfileFilters $filters)
{
$profilesGridFactory = $this->get('prestashop.core.grid.factory.profiles');

public function indexAction(
ProfileFilters $filters,
#[Autowire(service: 'prestashop.core.grid.factory.profiles')]
GridFactoryInterface $profilesGridFactory,
): Response {
return $this->render(
'@PrestaShop/Admin/Configure/AdvancedParameters/Profiles/index.html.twig',
[
'layoutHeaderToolbarBtn' => [
'add' => [
'href' => $this->generateUrl('admin_profiles_create'),
'desc' => $this->trans('Add new role', 'Admin.Advparameters.Feature'),
'desc' => $this->trans('Add new role', [], 'Admin.Advparameters.Feature'),
'icon' => 'add_circle_outline',
],
],
'help_link' => $this->generateSidebarLink('AdminProfiles'),
'enableSidebar' => true,
'layoutTitle' => $this->trans('Roles', 'Admin.Navigation.Menu'),
'layoutTitle' => $this->trans('Roles', [], 'Admin.Navigation.Menu'),
'grid' => $this->presentGrid($profilesGridFactory->getGrid($filters)),
'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(),
'multistoreIsUsed' => $this->getShopContext()->isMultiShopUsed(),
]
);
}
Expand All @@ -98,12 +99,13 @@ public function indexAction(ProfileFilters $filters)
* @return RedirectResponse
*/
#[AdminSecurity("is_granted('read', request.get('_legacy_controller'))")]
public function searchAction(Request $request)
{
$definitionFactory = $this->get('prestashop.core.grid.definition.factory.profile');
public function searchAction(
Request $request,
#[Autowire(service: 'prestashop.core.grid.definition.factory.profile')]
GridDefinitionFactoryInterface $definitionFactory,
GridFilterFormFactory $gridFilterFormFactory,
): RedirectResponse {
$definitionFactory = $definitionFactory->getDefinition();

$gridFilterFormFactory = $this->get('prestashop.core.grid.filter.form_factory');
$searchParametersForm = $gridFilterFormFactory->create($definitionFactory);
$searchParametersForm->handleRequest($request);

Expand All @@ -125,17 +127,21 @@ public function searchAction(Request $request)
*/
#[DemoRestricted(redirectRoute: 'admin_profiles_index')]
#[AdminSecurity("is_granted('create', request.get('_legacy_controller'))")]
public function createAction(Request $request)
{
$form = $this->get('prestashop.core.form.identifiable_object.builder.profile_form_builder')->getForm();
public function createAction(
Request $request,
#[Autowire(service: 'prestashop.core.form.identifiable_object.builder.profile_form_builder')]
FormBuilderInterface $formBuilder,
#[Autowire(service: 'prestashop.core.form.identifiable_object.handler.profile_form_handler')]
FormHandlerInterface $formHandler,
): Response {
$form = $formBuilder->getForm();
$form->handleRequest($request);

try {
$formHandler = $this->get('prestashop.core.form.identifiable_object.handler.profile_form_handler');
$handlerResult = $formHandler->handle($form);

if (null !== $handlerResult->getIdentifiableObjectId()) {
$this->addFlash('success', $this->trans('Successful creation', 'Admin.Notifications.Success'));
$this->addFlash('success', $this->trans('Successful creation', [], 'Admin.Notifications.Success'));

return $this->redirectToRoute('admin_profiles_index');
}
Expand All @@ -145,14 +151,15 @@ public function createAction(Request $request)

return $this->render('@PrestaShop/Admin/Configure/AdvancedParameters/Profiles/create.html.twig', [
'profileForm' => $form->createView(),
'layoutTitle' => $this->trans('New role', 'Admin.Navigation.Menu'),
'layoutTitle' => $this->trans('New role', [], 'Admin.Navigation.Menu'),
'help_link' => $this->generateSidebarLink('AdminProfiles'),
'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(),
'multistoreIsUsed' => $this->getShopContext()->isMultiShopUsed(),
]);
}

Expand All @@ -166,11 +173,14 @@ public function createAction(Request $request)
*/
#[DemoRestricted(redirectRoute: 'admin_profiles_index')]
#[AdminSecurity("is_granted('update', request.get('_legacy_controller'))", message: 'You do not have permission to edit this.')]
public function editAction($profileId, Request $request)
{
$formHandler = $this->get('prestashop.core.form.identifiable_object.handler.profile_form_handler');
$formBuilder = $this->get('prestashop.core.form.identifiable_object.builder.profile_form_builder');

public function editAction(
int $profileId,
Request $request,
#[Autowire(service: 'prestashop.core.form.identifiable_object.builder.profile_form_builder')]
FormBuilderInterface $formBuilder,
#[Autowire(service: 'prestashop.core.form.identifiable_object.handler.profile_form_handler')]
FormHandlerInterface $formHandler,
): Response {
try {
$form = $formBuilder->getFormFor((int) $profileId);
} catch (Exception $exception) {
Expand All @@ -187,7 +197,7 @@ public function editAction($profileId, Request $request)
$handlerResult = $formHandler->handleFor((int) $profileId, $form);

if ($handlerResult->isSubmitted() && $handlerResult->isValid()) {
$this->addFlash('success', $this->trans('Successful update', 'Admin.Notifications.Success'));
$this->addFlash('success', $this->trans('Successful update', [], 'Admin.Notifications.Success'));

return $this->redirectToRoute('admin_profiles_index');
}
Expand All @@ -200,16 +210,16 @@ public function editAction($profileId, Request $request)
}

/** @var EditableProfile $editableProfile */
$editableProfile = $this->getQueryBus()->handle(new GetProfileForEditing((int) $profileId));
$editableProfile = $this->dispatchQuery(new GetProfileForEditing($profileId));

return $this->render('@PrestaShop/Admin/Configure/AdvancedParameters/Profiles/edit.html.twig', [
'profileForm' => $form->createView(),
'layoutTitle' => $this->trans(
'Editing %role_name% role',
'Admin.Navigation.Menu',
[
'%role_name%' => $editableProfile->getLocalizedNames()[$this->getContextLangId()],
]
'%role_name%' => $editableProfile->getLocalizedNames()[$this->getLanguageContext()->getId()],
],
'Admin.Navigation.Menu',
),
'help_link' => $this->generateSidebarLink('AdminProfiles'),
'enableSidebar' => true,
Expand All @@ -225,14 +235,14 @@ public function editAction($profileId, Request $request)
*/
#[DemoRestricted(redirectRoute: 'admin_profiles_index')]
#[AdminSecurity("is_granted('delete', request.get('_legacy_controller'))", message: 'You do not have permission to edit this.')]
public function deleteAction($profileId)
public function deleteAction(int $profileId): RedirectResponse
{
try {
$deleteProfileCommand = new DeleteProfileCommand($profileId);

$this->getCommandBus()->handle($deleteProfileCommand);
$this->dispatchCommand($deleteProfileCommand);

$this->addFlash('success', $this->trans('Successful deletion', 'Admin.Notifications.Success'));
$this->addFlash('success', $this->trans('Successful deletion', [], 'Admin.Notifications.Success'));
} catch (ProfileException $e) {
$this->addFlash('error', $this->getErrorMessageForException($e, $this->getErrorMessages()));
}
Expand All @@ -249,14 +259,14 @@ public function deleteAction($profileId)
*/
#[DemoRestricted(redirectRoute: 'admin_profiles_index')]
#[AdminSecurity("is_granted('delete', request.get('_legacy_controller'))", message: 'You do not have permission to edit this.')]
public function bulkDeleteAction(Request $request)
public function bulkDeleteAction(Request $request): RedirectResponse
{
$profileIds = $request->request->all('profile_bulk');

try {
$this->getCommandBus()->handle(new BulkDeleteProfileCommand($profileIds));
$this->dispatchCommand(new BulkDeleteProfileCommand($profileIds));

$this->addFlash('success', $this->trans('Successful deletion', 'Admin.Notifications.Success'));
$this->addFlash('success', $this->trans('Successful deletion', [], 'Admin.Notifications.Success'));
} catch (ProfileException $e) {
$this->addFlash('error', $this->getErrorMessageForException($e, $this->getErrorMessages()));
}
Expand All @@ -265,44 +275,49 @@ public function bulkDeleteAction(Request $request)
}

/**
* Get human readable error for exception.
* Get human-readable error for exception.
*
* @return array
*/
protected function getErrorMessages()
protected function getErrorMessages(): array
{
return [
UploadedImageConstraintException::class => $this->trans(
'Image format not recognized, allowed formats are: %s',
[implode(', ', ImageManager::EXTENSIONS_SUPPORTED)],
'Admin.Notifications.Error',
[implode(', ', ImageManager::EXTENSIONS_SUPPORTED)]
),
ProfileConstraintException::class => [
ProfileConstraintException::INVALID_NAME => $this->trans(
'This field cannot be longer than %limit% characters (incl. HTML tags)',
['%limit%' => ProfileSettings::NAME_MAX_LENGTH],
'Admin.Notifications.Error',
['%limit%' => ProfileSettings::NAME_MAX_LENGTH]
),
],
ProfileNotFoundException::class => $this->trans(
'The object cannot be loaded (or found).',
[],
'Admin.Notifications.Error'
),
CannotDeleteSuperAdminProfileException::class => $this->trans(
'For security reasons, you cannot delete the Administrator\'s role.',
[],
'Admin.Advparameters.Notification'
),
FailedToDeleteProfileException::class => [
FailedToDeleteProfileException::UNEXPECTED_ERROR => $this->trans(
'An error occurred while deleting the object.',
[],
'Admin.Notifications.Error'
),
FailedToDeleteProfileException::PROFILE_IS_ASSIGNED_TO_EMPLOYEE => $this->trans(
'Role(s) assigned to employee cannot be deleted',
[],
'Admin.Notifications.Error'
),
FailedToDeleteProfileException::PROFILE_IS_ASSIGNED_TO_CONTEXT_EMPLOYEE => $this->trans(
'You cannot delete your own role',
[],
'Admin.Notifications.Error'
),
],
Expand Down
10 changes: 8 additions & 2 deletions src/PrestaShopBundle/Resources/config/services/core/grid/grid_filter_form_factory.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,18 @@ services:
_defaults:
public: true

prestashop.core.grid.filter.form_factory:
class: 'PrestaShop\PrestaShop\Core\Grid\Filter\GridFilterFormFactory'
PrestaShop\PrestaShop\Core\Grid\Filter\GridFilterFormFactory:
public: false
arguments:
- '@form.factory'
- '@prestashop.core.hook.dispatcher'

prestashop.core.grid.filter.form_factory:
alias: 'PrestaShop\PrestaShop\Core\Grid\Filter\GridFilterFormFactory'
deprecated:
package: PrestaShop\PrestaShop
version: 9.0

prestashop.core.grid.filter.category_form_factory:
class: 'PrestaShop\PrestaShop\Core\Grid\Filter\CategoryFilterFormFactory'
arguments:
Expand Down

0 comments on commit cd6b289

Please sign in to comment.