cs: Fix code style (safe rules only).

2025-08-21 07:03:49 +00:00 · 2021-11-23 14:06:38 +01:00
parent 149d7ce991
commit 8f96a1121d
1223 changed files with 65199 additions and 64625 deletions
--- a/src/Bundle/ChillMainBundle/CRUD/Controller/AbstractCRUDController.php
+++ b/src/Bundle/ChillMainBundle/CRUD/Controller/AbstractCRUDController.php
@@ -1,96 +1,63 @@
 <?php

+/**
+ * Chill is a software for social workers
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ */
+
 declare(strict_types=1);

 namespace Chill\MainBundle\CRUD\Controller;

-use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
-use Symfony\Component\HttpFoundation\Request;
-use Symfony\Component\HttpFoundation\Response;
-use Symfony\Component\Validator\Validator\ValidatorInterface;
+use Chill\MainBundle\CRUD\Resolver\Resolver;
 use Chill\MainBundle\Pagination\PaginatorFactory;
 use Chill\MainBundle\Pagination\PaginatorInterface;
 use Chill\MainBundle\Security\Authorization\AuthorizationHelper;
-use Chill\MainBundle\CRUD\Resolver\Resolver;
+use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
 use Symfony\Component\EventDispatcher\EventDispatcherInterface;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\Serializer\SerializerInterface;
 use Symfony\Component\Translation\TranslatorInterface;
+use Symfony\Component\Validator\Validator\ValidatorInterface;
+use function array_merge;

 abstract class AbstractCRUDController extends AbstractController
 {
    /**
-     * The crud configuration
+     * The crud configuration.
     *
     * This configuration si defined by `chill_main['crud']` or `chill_main['apis']`
     */
    protected array $crudConfig = [];

-    /**
-     * get the instance of the entity with the given id
-     *
-     * @throw Symfony\Component\HttpKernel\Exception\NotFoundHttpException if the object is not found
-     */
-    protected function getEntity($action, string $id, Request $request): object
+    public static function getSubscribedServices(): array
    {
-        $e = $this
-            ->getDoctrine()
-            ->getRepository($this->getEntityClass())
-            ->find($id);
+        return array_merge(
+            parent::getSubscribedServices(),
+            [
+                'chill_main.paginator_factory' => PaginatorFactory::class,

-        if (null === $e) {
-            throw $this->createNotFoundException(sprintf("The object %s for id %s is not found", $this->getEntityClass(), $id));
-        }
-
-        return $e;
-    }
-
-    protected function createEntity(string $action, Request $request): object
-    {
-        $class = $this->getEntityClass();
-
-        return new $class;
+                'translator' => TranslatorInterface::class,
+                AuthorizationHelper::class => AuthorizationHelper::class,
+                EventDispatcherInterface::class => EventDispatcherInterface::class,
+                Resolver::class => Resolver::class,
+                SerializerInterface::class => SerializerInterface::class,
+                'validator' => ValidatorInterface::class,
+            ]
+        );
    }

    /**
-     * Count the number of entities
+     * Set the crud configuration.
     *
-     * By default, count all entities. You can customize the query by
-     * using the method `customizeQuery`.
+     * Used by the container to inject configuration for this crud.
     */
-    protected function countEntities(string $action, Request $request, $_format): int
+    public function setCrudConfig(array $config): void
    {
-        return $this->buildQueryEntities($action, $request)
-            ->select('COUNT(e)')
-            ->getQuery()
-            ->getSingleScalarResult();
-    }
-
-    /**
-     * Query the entity.
-     *
-     * By default, get all entities. You can customize the query by using the
-     * method `customizeQuery`.
-     *
-     * The method `orderEntity` is called internally to order entities.
-     *
-     * It returns, by default, a query builder.
-     */
-    protected function queryEntities(string $action, Request $request, string $_format, PaginatorInterface $paginator)
-    {
-        $query = $this->buildQueryEntities($action, $request)
-            ->setFirstResult($paginator->getCurrentPage()->getFirstItemNumber())
-            ->setMaxResults($paginator->getItemsPerPage());
-
-        // allow to order queries and return the new query
-        return $this->orderQuery($action, $query, $request, $paginator, $_format);
-    }
-
-    /**
-     * Add ordering fields in the query build by self::queryEntities
-     */
-    protected function orderQuery(string $action, $query, Request $request, PaginatorInterface $paginator, $_format)
-    {
-        return $query;
+        $this->crudConfig = $config;
    }

    /**
@@ -117,16 +84,157 @@ abstract class AbstractCRUDController extends AbstractController
        return $qb;
    }

-    protected function customizeQuery(string $action, Request $request, $query): void {}
+    /**
+     * check the acl. Called by every action.
+     *
+     * By default, check the role given by `getRoleFor` for the value given in
+     * $entity.
+     *
+     * Throw an \Symfony\Component\Security\Core\Exception\AccessDeniedHttpException
+     * if not accessible.
+     *
+     * @param mixed|null $entity
+     *
+     * @throws \Symfony\Component\Security\Core\Exception\AccessDeniedHttpException
+     */
+    protected function checkACL(string $action, Request $request, string $_format, $entity = null)
+    {
+        // @TODO: Implements abstract getRoleFor method or do it in the interface.
+        $this->denyAccessUnlessGranted($this->getRoleFor($action, $request, $entity, $_format), $entity);
+    }
+
+    /**
+     * Count the number of entities.
+     *
+     * By default, count all entities. You can customize the query by
+     * using the method `customizeQuery`.
+     *
+     * @param mixed $_format
+     */
+    protected function countEntities(string $action, Request $request, $_format): int
+    {
+        return $this->buildQueryEntities($action, $request)
+            ->select('COUNT(e)')
+            ->getQuery()
+            ->getSingleScalarResult();
+    }
+
+    protected function createEntity(string $action, Request $request): object
+    {
+        $class = $this->getEntityClass();
+
+        return new $class();
+    }
+
+    protected function customizeQuery(string $action, Request $request, $query): void
+    {
+    }
+
+    protected function getActionConfig(string $action)
+    {
+        return $this->crudConfig['actions'][$action];
+    }
+
+    /**
+     * @return string The crud name.
+     */
+    protected function getCrudName(): string
+    {
+        return $this->crudConfig['name'];
+    }
+
+    /**
+     * get the instance of the entity with the given id.
+     *
+     * @throw Symfony\Component\HttpKernel\Exception\NotFoundHttpException if the object is not found
+     *
+     * @param mixed $action
+     */
+    protected function getEntity($action, string $id, Request $request): object
+    {
+        $e = $this
+            ->getDoctrine()
+            ->getRepository($this->getEntityClass())
+            ->find($id);
+
+        if (null === $e) {
+            throw $this->createNotFoundException(sprintf('The object %s for id %s is not found', $this->getEntityClass(), $id));
+        }
+
+        return $e;
+    }
+
+    /**
+     * Get the FQDN of the class.
+     *
+     * @return class-string The FQDN of the class
+     */
+    protected function getEntityClass(): string
+    {
+        return $this->crudConfig['class'];
+    }
+
+    protected function getPaginatorFactory(): PaginatorFactory
+    {
+        return $this->container->get('chill_main.paginator_factory');
+    }

    /**
     * Get the result of the query.
+     *
+     * @param mixed $query
     */
    protected function getQueryResult(string $action, Request $request, string $_format, int $totalItems, PaginatorInterface $paginator, $query)
    {
        return $query->getQuery()->getResult();
    }

+    protected function getValidator(): ValidatorInterface
+    {
+        return $this->get('validator');
+    }
+
+    /**
+     * Called on post check ACL.
+     *
+     * @param mixed $entity
+     */
+    protected function onPostCheckACL(string $action, Request $request, string $_format, $entity): ?Response
+    {
+        return null;
+    }
+
+    /**
+     * Called on post fetch entity.
+     *
+     * @param mixed $entity
+     * @param mixed $_format
+     */
+    protected function onPostFetchEntity(string $action, Request $request, $entity, $_format): ?Response
+    {
+        return null;
+    }
+
+    /**
+     * Method used by indexAction.
+     *
+     * @param mixed $query
+     */
+    protected function onPostIndexBuildQuery(string $action, Request $request, string $_format, int $totalItems, PaginatorInterface $paginator, $query): ?Response
+    {
+        return null;
+    }
+
+    /**
+     * Method used by indexAction.
+     *
+     * @param mixed $entities
+     */
+    protected function onPostIndexFetchQuery(string $action, Request $request, string $_format, int $totalItems, PaginatorInterface $paginator, $entities): ?Response
+    {
+        return null;
+    }
+
    protected function onPreIndex(string $action, Request $request, string $_format): ?Response
    {
        return null;
@@ -141,111 +249,33 @@ abstract class AbstractCRUDController extends AbstractController
    }

    /**
-     * Method used by indexAction.
-     */
-    protected function onPostIndexBuildQuery(string $action, Request $request, string $_format, int $totalItems, PaginatorInterface $paginator, $query): ?Response
-    {
-        return null;
-    }
-
-    /**
-     * Method used by indexAction.
-     */
-    protected function onPostIndexFetchQuery(string $action, Request $request, string $_format, int $totalItems, PaginatorInterface $paginator, $entities): ?Response
-    {
-        return null;
-    }
-
-    /**
-     * Get the FQDN of the class.
+     * Add ordering fields in the query build by self::queryEntities.
     *
-     * @return class-string The FQDN of the class
+     * @param mixed $query
+     * @param mixed $_format
     */
-    protected function getEntityClass(): string
+    protected function orderQuery(string $action, $query, Request $request, PaginatorInterface $paginator, $_format)
    {
-        return $this->crudConfig['class'];
+        return $query;
    }

    /**
-     * Called on post fetch entity.
-     */
-    protected function onPostFetchEntity(string $action, Request $request, $entity, $_format): ?Response
-    {
-        return null;
-    }
-
-    /**
-     * Called on post check ACL.
-     */
-    protected function onPostCheckACL(string $action, Request $request, string $_format, $entity): ?Response
-    {
-        return null;
-    }
-
-    /**
-     * check the acl. Called by every action.
+     * Query the entity.
     *
-     * By default, check the role given by `getRoleFor` for the value given in
-     * $entity.
+     * By default, get all entities. You can customize the query by using the
+     * method `customizeQuery`.
     *
-     * Throw an \Symfony\Component\Security\Core\Exception\AccessDeniedHttpException
-     * if not accessible.
+     * The method `orderEntity` is called internally to order entities.
     *
-     * @throws \Symfony\Component\Security\Core\Exception\AccessDeniedHttpException
+     * It returns, by default, a query builder.
     */
-    protected function checkACL(string $action, Request $request, string $_format, $entity = null)
+    protected function queryEntities(string $action, Request $request, string $_format, PaginatorInterface $paginator)
    {
-        // @TODO: Implements abstract getRoleFor method or do it in the interface.
-        $this->denyAccessUnlessGranted($this->getRoleFor($action, $request, $entity, $_format), $entity);
-    }
+        $query = $this->buildQueryEntities($action, $request)
+            ->setFirstResult($paginator->getCurrentPage()->getFirstItemNumber())
+            ->setMaxResults($paginator->getItemsPerPage());

-    /**
-     * @return string The crud name.
-     */
-    protected function getCrudName(): string
-    {
-        return $this->crudConfig['name'];
-    }
-
-    protected function getActionConfig(string $action)
-    {
-        return $this->crudConfig['actions'][$action];
-    }
-
-    /**
-     * Set the crud configuration
-     *
-     * Used by the container to inject configuration for this crud.
-     */
-    public function setCrudConfig(array $config): void
-    {
-        $this->crudConfig = $config;
-    }
-
-    protected function getPaginatorFactory(): PaginatorFactory
-    {
-        return $this->container->get('chill_main.paginator_factory');
-    }
-
-    protected function getValidator(): ValidatorInterface
-    {
-        return $this->get('validator');
-    }
-
-    public static function getSubscribedServices(): array
-    {
-        return \array_merge(
-            parent::getSubscribedServices(),
-            [
-                'chill_main.paginator_factory' => PaginatorFactory::class,
-
-                'translator' => TranslatorInterface::class,
-                AuthorizationHelper::class => AuthorizationHelper::class,
-                EventDispatcherInterface::class => EventDispatcherInterface::class,
-                Resolver::class => Resolver::class,
-                SerializerInterface::class => SerializerInterface::class,
-                'validator' => ValidatorInterface::class,
-            ]
-        );
+        // allow to order queries and return the new query
+        return $this->orderQuery($action, $query, $request, $paginator, $_format);
    }
 }