refactor: Deprecated Controller methods to get services

roadiz · Jun 15, 2023 · d8d351b · d8d351b
1 parent bee2f06
commit d8d351b
Show file tree

Hide file tree

Showing 7 changed files with 28 additions and 87 deletions.
diff --git a/lib/RoadizCompatBundle/config/services.yaml b/lib/RoadizCompatBundle/config/services.yaml
@@ -59,7 +59,9 @@ services:
         public: true
     assetPackages:
         alias: RZ\Roadiz\Documents\Packages
-        deprecated: ~
+        deprecated:
+            package: 'roadiz/compat-bundle'
+            version: '2.0.0'
         public: true
     Symfony\Contracts\Translation\TranslatorInterface:
         alias: 'translator.default'

diff --git a/lib/RoadizCompatBundle/src/Controller/AppController.php b/lib/RoadizCompatBundle/src/Controller/AppController.php
@@ -437,7 +437,7 @@ protected function publishMessage(
     public function getSession(): ?SessionInterface
     {
         $request = $this->getRequest();
-        return null !== $request && $request->hasPreviousSession() ? $request->getSession() : null;
+        return $request->hasPreviousSession() ? $request->getSession() : null;
     }
 
     /**

diff --git a/lib/RoadizCompatBundle/src/Controller/Controller.php b/lib/RoadizCompatBundle/src/Controller/Controller.php
@@ -83,6 +83,7 @@ public static function getSubscribedServices(): array
             'stopwatch' => Stopwatch::class,
             'translator' => TranslatorInterface::class,
             'urlGenerator' => UrlGeneratorInterface::class,
+            UrlGeneratorInterface::class => UrlGeneratorInterface::class,
             ContactFormManager::class => ContactFormManager::class,
             DocumentUrlGeneratorInterface::class => DocumentUrlGeneratorInterface::class,
             EmailManager::class => EmailManager::class,
@@ -103,6 +104,7 @@ public static function getSubscribedServices(): array
             Stopwatch::class => Stopwatch::class,
             TokenStorageInterface::class => TokenStorageInterface::class,
             TranslatorInterface::class => TranslatorInterface::class,
+            FormFactoryInterface::class => FormFactoryInterface::class,
             \RZ\Roadiz\Core\Handlers\HandlerFactoryInterface::class => HandlerFactoryInterface::class,
         ]);
     }
@@ -205,17 +207,6 @@ protected function getSettingsBag(): Settings
         return $settingsBag;
     }
 
-    /**
-     * @return Packages
-     * @deprecated
-     */
-    protected function getPackages(): Packages
-    {
-        /** @var Packages $packages */ # php-stan hint
-        $packages = $this->get('assetPackages');
-        return $packages;
-    }
-
     protected function getHandlerFactory(): HandlerFactoryInterface
     {
         /** @var HandlerFactoryInterface $handlerFactory */ # php-stan hint
@@ -242,7 +233,7 @@ protected function generateUrl($route, array $parameters = [], int $referenceTyp
     {
         if ($route instanceof NodesSources) {
             /** @var UrlGeneratorInterface $urlGenerator */
-            $urlGenerator = $this->get('urlGenerator');
+            $urlGenerator = $this->get(UrlGeneratorInterface::class);
             return $urlGenerator->generate(
                 RouteObjectInterface::OBJECT_BASED_ROUTE_NAME,
                 array_merge($parameters, [RouteObjectInterface::ROUTE_OBJECT => $route]),
@@ -253,41 +244,25 @@ protected function generateUrl($route, array $parameters = [], int $referenceTyp
     }
 
     /**
-     * @return string
+     * @return class-string
      */
-    public static function getCalledClass()
+    public static function getCalledClass(): string
     {
         $className = get_called_class();
-        if (strpos($className, "\\") !== 0) {
+        if (!str_starts_with($className, "\\")) {
             $className = "\\" . $className;
         }
         return $className;
     }
 
-    /**
-     * Validate a request against a given ROLE_* and throws
-     * an AccessDeniedException exception.
-     *
-     * @param string $role
-     * @deprecated Use denyAccessUnlessGranted() method instead
-     * @throws AccessDeniedException
-     * @return void
-     */
-    public function validateAccessForRole($role)
-    {
-        if (!$this->isGranted($role)) {
-            throw new AccessDeniedException("You don't have access to this page:" . $role);
-        }
-    }
-
     /**
      * Custom route for redirecting routes with a trailing slash.
      *
      * @param Request $request
      *
      * @return RedirectResponse
      */
-    public function removeTrailingSlashAction(Request $request)
+    public function removeTrailingSlashAction(Request $request): RedirectResponse
     {
         $pathInfo = $request->getPathInfo();
         $requestUri = $request->getRequestUri();
@@ -301,7 +276,7 @@ public function removeTrailingSlashAction(Request $request)
      * Make translation variable with the good localization.
      *
      * @param Request $request
-     * @param string $_locale
+     * @param string|null $_locale
      *
      * @return TranslationInterface
      * @throws NoTranslationAvailableException
@@ -394,7 +369,7 @@ protected function getNamespacedView(string $view, string $namespace = ''): stri
      * @param int $httpStatus
      * @return JsonResponse
      */
-    public function renderJson(array $data = [], int $httpStatus = JsonResponse::HTTP_OK)
+    public function renderJson(array $data = [], int $httpStatus = Response::HTTP_OK): JsonResponse
     {
         return $this->json($data, $httpStatus);
     }
@@ -424,24 +399,25 @@ protected function denyResourceExceptForFormats(Request $request, array $accepta
      * @param array $options Options for the form
      *
      * @return FormBuilderInterface
+     * @deprecated Use constructor service injection
      */
     protected function createNamedFormBuilder(string $name = 'form', $data = null, array $options = [])
     {
         /** @var FormFactoryInterface $formFactory */
-        $formFactory = $this->get('form.factory');
+        $formFactory = $this->get(FormFactoryInterface::class);
         return $formFactory->createNamedBuilder($name, FormType::class, $data, $options);
     }
 
     /**
      * Creates and returns an EntityListManager instance.
      *
-     * @param mixed $entity Entity class path
+     * @param class-string $entity Entity class path
      * @param array $criteria
      * @param array $ordering
      *
      * @return EntityListManagerInterface
      */
-    public function createEntityListManager($entity, array $criteria = [], array $ordering = [])
+    public function createEntityListManager(string $entity, array $criteria = [], array $ordering = []): EntityListManagerInterface
     {
         return new EntityListManager(
             $this->getRequest(),
@@ -457,6 +433,7 @@ public function createEntityListManager($entity, array $criteria = [], array $or
      * form by email.
      *
      * @return ContactFormManager
+     * @deprecated Use constructor service injection
      */
     public function createContactFormManager(): ContactFormManager
     {
@@ -469,6 +446,7 @@ public function createContactFormManager(): ContactFormManager
      * Create and return a EmailManager to build and send emails.
      *
      * @return EmailManager
+     * @deprecated Use constructor service injection
      */
     public function createEmailManager(): EmailManager
     {
@@ -480,26 +458,20 @@ public function createEmailManager(): EmailManager
     /**
      * Get a user from the tokenStorage.
      *
-     * @return UserInterface|object|null
+     * @return UserInterface|null
      *
      * @throws \LogicException If tokenStorage is not available
      *
      * @see TokenInterface::getUser()
      */
-    protected function getUser()
+    protected function getUser(): ?UserInterface
     {
         if (!$this->has('securityTokenStorage')) {
             throw new \LogicException('No TokenStorage has been registered in your application.');
         }
 
         /** @var TokenInterface|null $token */
         $token = $this->getTokenStorage()->getToken();
-        if (null === $token) {
-            return null;
-        }
-
-        $user = $token->getUser();
-
-        return \is_object($user) ? $user : null;
+        return $token?->getUser();
     }
 }
diff --git a/lib/RoadizCompatBundle/src/Controller/FrontendController.php b/lib/RoadizCompatBundle/src/Controller/FrontendController.php
@@ -10,6 +10,7 @@
 use RZ\Roadiz\CoreBundle\Entity\Node;
 use RZ\Roadiz\CoreBundle\Entity\NodesSources;
 use RZ\Roadiz\CoreBundle\EntityHandler\NodesSourcesHandler;
+use RZ\Roadiz\CoreBundle\ListManager\EntityListManagerInterface;
 use RZ\Roadiz\CoreBundle\Routing\NodeRouteHelper;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
@@ -424,7 +425,7 @@ protected function denyAccessUnlessPublished(): void
     /**
      * @inheritDoc
      */
-    public function createEntityListManager($entity, array $criteria = [], array $ordering = [])
+    public function createEntityListManager(string $entity, array $criteria = [], array $ordering = []): EntityListManagerInterface
     {
         return parent::createEntityListManager($entity, $criteria, $ordering)
             ->setAllowRequestSearching(false)

diff --git a/lib/RoadizCoreBundle/src/Routing/InstallRouteCollection.php b/lib/RoadizCoreBundle/src/Routing/InstallRouteCollection.php
diff --git a/lib/RoadizRozierBundle/src/Controller/BackendController.php b/lib/RoadizRozierBundle/src/Controller/BackendController.php
@@ -9,6 +9,7 @@
 use RZ\Roadiz\CoreBundle\Bag\NodeTypes;
 use RZ\Roadiz\CoreBundle\Bag\Roles;
 use RZ\Roadiz\CoreBundle\Bag\Settings;
+use RZ\Roadiz\CoreBundle\ListManager\EntityListManagerInterface;
 use RZ\Roadiz\CoreBundle\Mailer\EmailManager;
 use RZ\Roadiz\Documents\Packages;
 use RZ\Roadiz\OpenId\OAuth2LinkGenerator;
@@ -55,7 +56,7 @@ public static function getSubscribedServices(): array
     /**
      * @inheritDoc
      */
-    public function createEntityListManager($entity, array $criteria = [], array $ordering = [])
+    public function createEntityListManager(string $entity, array $criteria = [], array $ordering = []): EntityListManagerInterface
     {
         return parent::createEntityListManager($entity, $criteria, $ordering)
             ->setDisplayingNotPublishedNodes(true);

diff --git a/lib/Rozier/src/Forms/CustomFormFieldType.php b/lib/Rozier/src/Forms/CustomFormFieldType.php
@@ -9,6 +9,7 @@
 use Symfony\Component\Form\AbstractType;
 use Symfony\Component\Form\Extension\Core\Type\CheckboxType;
 use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
+use Symfony\Component\Form\Extension\Core\Type\TextareaType;
 use Symfony\Component\Form\Extension\Core\Type\TextType;
 use Symfony\Component\Form\FormBuilderInterface;
 use Symfony\Component\OptionsResolver\OptionsResolver;
@@ -50,7 +51,7 @@ public function buildForm(FormBuilderInterface $builder, array $options): void
             ])
             ->add(
                 'defaultValues',
-                TextType::class,
+                TextareaType::class,
                 [
                     'label' => 'defaultValues',
                     'required' => false,