cs: Fix code style (safe rules only).

2025-08-21 23:23:51 +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/ChillPersonBundle/Timeline/AbstractTimelineAccompanyingPeriod.php
+++ b/src/Bundle/ChillPersonBundle/Timeline/AbstractTimelineAccompanyingPeriod.php
@@ -1,52 +1,43 @@
 <?php

-/*
- * Copyright (C) 2015 Champs-Libres Coopérative <info@champs-libres.coop>
+/**
+ * Chill is a software for social workers
 *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public License
- * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
 */

 namespace Chill\PersonBundle\Timeline;

-use Chill\MainBundle\Timeline\TimelineProviderInterface;
-use Doctrine\ORM\EntityManager;
-use Chill\PersonBundle\Entity\AccompanyingPeriod;
-use Chill\PersonBundle\Entity\Person;
-use Chill\PersonBundle\Entity\AccompanyingPeriodParticipation;
-use Chill\MainBundle\Entity\Center;
-use Chill\PersonBundle\Security\Authorization\PersonVoter;
-use Symfony\Component\Security\Core\Security;
 use Chill\MainBundle\Security\Authorization\AuthorizationHelper;
+use Chill\MainBundle\Timeline\TimelineProviderInterface;
 use Chill\MainBundle\Timeline\TimelineSingleQuery;
+use Chill\PersonBundle\Entity\AccompanyingPeriod;
+use Chill\PersonBundle\Entity\AccompanyingPeriodParticipation;
+use Chill\PersonBundle\Entity\Person;
+use Chill\PersonBundle\Security\Authorization\PersonVoter;
+use Doctrine\ORM\EntityManager;
+use LogicException;
+use Symfony\Component\Security\Core\Security;
+use function implode;
+use function in_array;

 /**
- * Provide method to build timeline for accompanying periods
- * 
+ * Provide method to build timeline for accompanying periods.
+ *
 * This class is resued by TimelineAccompanyingPeriodOpening (for opening)
 * and TimelineAccompanyingPeriodClosing (for closing)
- *
 */
 abstract class AbstractTimelineAccompanyingPeriod implements TimelineProviderInterface
 {
-    protected EntityManager $em;
+    private const SUPPORTED_CONTEXTS = ['person', 'center'];

-    private Security $security;
+    protected EntityManager $em;

    private AuthorizationHelper $authorizationHelper;

-    private const SUPPORTED_CONTEXTS = [ 'person', 'center' ];
-    
+    private Security $security;
+
    public function __construct(EntityManager $em, Security $security, AuthorizationHelper $authorizationHelper)
    {
        $this->em = $em;
@@ -54,53 +45,96 @@ abstract class AbstractTimelineAccompanyingPeriod implements TimelineProviderInt
        $this->authorizationHelper = $authorizationHelper;
    }

-    /**
-     * 
-     * {@inheritDoc}
-     */
    public function getEntities(array $ids)
    {
        $periods = $this->em
-                ->getRepository('ChillPersonBundle:AccompanyingPeriod')
-                ->findBy(array('id' => $ids));
-        
+            ->getRepository('ChillPersonBundle:AccompanyingPeriod')
+            ->findBy(['id' => $ids]);
+
        //set results in an associative array with id as indexes
-        $results = array();
-        foreach($periods as $period) {
+        $results = [];
+
+        foreach ($periods as $period) {
            $results[$period->getId()] = $period;
        }
-        
+
        return $results;
    }

    /**
-     * prepare fetchQuery without `WHERE` and `TYPE` clause
-     * 
+     * prepare fetchQuery without `WHERE` and `TYPE` clause.
+     *
     * @param string $context
-     * @param array $args
+     *
+     * @throws LogicException
+     *
     * @return array
-     * @throws \LogicException
     */
    protected function basicFetchQuery($context, array $args)
    {
-        if (FALSE === \in_array($context, self::SUPPORTED_CONTEXTS)) {
-            throw new \LogicException('TimelineAccompanyingPeriod is not able '
-                    . 'to render context '.$context);
+        if (false === in_array($context, self::SUPPORTED_CONTEXTS)) {
+            throw new LogicException('TimelineAccompanyingPeriod is not able '
+                    . 'to render context ' . $context);
        }
-        
+
        $metadata = $this->em
-                ->getClassMetadata(AccompanyingPeriod::class)
-                ;
+            ->getClassMetadata(AccompanyingPeriod::class);
        [$where, $parameters] = $this->buildWhereClause($context, $args);

        return TimelineSingleQuery::fromArray([
            'id' => "{$metadata->getTableName()}.{$metadata->getColumnName('id')}",
            'FROM' => $this->buildFromClause($context),
            'WHERE' => $where,
-            'parameters' => $parameters
+            'parameters' => $parameters,
        ]);
    }

+    protected function buildWhereClause($context, array $args): array
+    {
+        $participation = $this->em->getClassMetadata(AccompanyingPeriodParticipation::class);
+        $join = $participation->getAssociationMapping('person')['joinColumns'][0];
+        $person = $this->em->getClassMetadata(Person::class);
+        $joinCenter = $person->getAssociationMapping('center')['joinColumns'][0];
+
+        if ('center' === $context) {
+            $allowedCenters = $this->authorizationHelper->filterReachableCenters($this->security->getUser(), $args['centers'], PersonVoter::SEE);
+            $params = [];
+            $questionMarks = [];
+            $query = "{$person->getTableName()}.{$joinCenter['name']} IN (";
+
+            foreach ($allowedCenters as $c) {
+                $questionMarks[] = '?';
+                $params[] = $c->getId();
+            }
+            $query .= implode(', ', $questionMarks) . ')';
+
+            return [$query, $params];
+        }
+
+        if ('person' === $context) {
+            return ["{$participation->getTableName()}.{$join['name']} = ?", [$args['person']->getId()]];
+        }
+
+        throw new LogicException("this context is not supported: {$context}");
+    }
+
+    /**
+     * return the expected response for TimelineProviderInterface::getEntityTemplate.
+     *
+     * @param string $template the template for rendering
+     * @param mixed $entity
+     * @param string $context
+     *
+     * @return array
+     */
+    protected function getBasicEntityTemplate($template, $entity, $context, array $args)
+    {
+        return [
+            'template' => $template,
+            'template_data' => ['period' => $entity, 'context' => $context],
+        ];
+    }
+
    private function buildFromClause($context)
    {
        $period = $this->em->getClassMetadata(AccompanyingPeriod::class);
@@ -109,64 +143,19 @@ abstract class AbstractTimelineAccompanyingPeriod implements TimelineProviderInt
        $join = $participation->getAssociationMapping('accompanyingPeriod')['joinColumns'][0];
        $joinPerson = $participation->getAssociationMapping('person')['joinColumns'][0];

-        if ($context === 'person') {
-            return "{$period->getTableName()} ".
-                "JOIN {$participation->getTableName()} ".
-                "ON {$participation->getTableName()}.{$join['name']} = ".
+        if ('person' === $context) {
+            return "{$period->getTableName()} " .
+                "JOIN {$participation->getTableName()} " .
+                "ON {$participation->getTableName()}.{$join['name']} = " .
                "{$period->getTableName()}.{$join['referencedColumnName']}";
-        } else {
-            return "{$period->getTableName()} ".
-                "JOIN {$participation->getTableName()} ".
-                "ON {$participation->getTableName()}.{$join['name']} = ".
-                "{$period->getTableName()}.{$join['referencedColumnName']} ".
-                "JOIN {$person->getTableName()} ".
-                "ON {$participation->getTableName()}.{$joinPerson['name']} = ".
-                "{$person->getTableName()}.{$joinPerson['referencedColumnName']}"
-                ;
        }

-    }
-
-    protected function buildWhereClause($context, array $args): array
-    {
-        $participation = $this->em->getClassMetadata(AccompanyingPeriodParticipation::class);
-        $join = $participation->getAssociationMapping('person')['joinColumns'][0];
-        $person = $this->em->getClassMetadata(Person::class);
-        $joinCenter = $person->getAssociationMapping('center')['joinColumns'][0];
-
-        if ($context === 'center') {
-            $allowedCenters = $this->authorizationHelper->filterReachableCenters($this->security->getUser(), $args['centers'], PersonVoter::SEE);
-            $params = [];
-            $questionMarks = [];
-            $query = "{$person->getTableName()}.{$joinCenter['name']} IN (";
-            foreach ($allowedCenters as $c) {
-                $questionMarks[] = '?';
-                $params[] = $c->getId();
-            }
-            $query .= \implode(", ", $questionMarks).")";
-
-            return [$query, $params];
-        } elseif ($context === 'person') {
-            return [ "{$participation->getTableName()}.{$join['name']} = ?", [ $args['person']->getId() ]];
-        }
-
-        throw new \LogicException("this context is not supported: $context");
-    }
-
-    /**
-     * return the expected response for TimelineProviderInterface::getEntityTemplate
-     * 
-     * @param string $template the template for rendering
-     * @param mixed $entity
-     * @param string $context
-     * @param array $args
-     * @return array
-     */
-    protected function getBasicEntityTemplate($template, $entity, $context, array $args)
-    {
-        return array(
-            'template' => $template,
-            'template_data' => ['period' => $entity, 'context' => $context]
-        );
+        return "{$period->getTableName()} " .
+                "JOIN {$participation->getTableName()} " .
+                "ON {$participation->getTableName()}.{$join['name']} = " .
+                "{$period->getTableName()}.{$join['referencedColumnName']} " .
+                "JOIN {$person->getTableName()} " .
+                "ON {$participation->getTableName()}.{$joinPerson['name']} = " .
+                "{$person->getTableName()}.{$joinPerson['referencedColumnName']}";
    }
 }