fix: SA: Fix "...invoked with..." rule.

SA stands for Static Analysis.

src/Bundle/ChillActivityBundle/Timeline/TimelineActivityProvider.php

@@ -1,94 +1,53 @@
 <?php
 
-/*
- * Chill is a software for social workers
- * Copyright (C) 2015 Champs Libres <info@champs-libres.coop>
- *
- * 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/>.
- */
+declare(strict_types=1);
 
 namespace Chill\ActivityBundle\Timeline;
 
+use Chill\MainBundle\Entity\User;
+use Chill\MainBundle\Security\Authorization\AuthorizationHelperInterface;
 use Chill\MainBundle\Timeline\TimelineProviderInterface;
 use Chill\ActivityBundle\Repository\ActivityACLAwareRepository;
-use Doctrine\ORM\EntityManager;
-use Chill\MainBundle\Security\Authorization\AuthorizationHelper;
+use Doctrine\ORM\EntityManagerInterface;
 use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;
 use Symfony\Component\Security\Core\Role\Role;
-use Doctrine\ORM\Mapping\ClassMetadata;
 use Chill\PersonBundle\Entity\Person;
-use Chill\MainBundle\Entity\Scope;
 use Chill\ActivityBundle\Entity\Activity;
 use Chill\MainBundle\Timeline\TimelineSingleQuery;
+use Symfony\Component\Security\Core\User\UserInterface;
 
-/**
- * Provide activity for inclusion in timeline
- *
-*/
 class TimelineActivityProvider implements TimelineProviderInterface
 {
-    
-    /**
-     *
-     * @var EntityManager
-     */
-    protected $em;
-    
-    /**
-     *
-     * @var AuthorizationHelper
-     */
-    protected $helper;
-    
-    /**
-     *
-     * @var \Chill\MainBundle\Entity\User 
-     */
-    protected $user;
+    protected EntityManagerInterface $em;
+
+    protected AuthorizationHelperInterface $helper;
+
+    protected UserInterface $user;
 
     protected ActivityACLAwareRepository $aclAwareRepository;
 
     private const SUPPORTED_CONTEXTS = [ 'center', 'person'];
-    
-    /**
-     * TimelineActivityProvider constructor.
-     *
-     * @param EntityManager $em
-     * @param AuthorizationHelper $helper
-     * @param TokenStorageInterface $storage
-     */
+
     public function __construct(
-        EntityManager $em,
-        AuthorizationHelper $helper,
+        EntityManagerInterface $em,
+        AuthorizationHelperInterface $helper,
         TokenStorageInterface $storage,
         ActivityACLAwareRepository $aclAwareRepository
-    )
-    {
+    ) {
         $this->em = $em;
         $this->helper = $helper;
         $this->aclAwareRepository = $aclAwareRepository;
-        
-        if (!$storage->getToken()->getUser() instanceof \Chill\MainBundle\Entity\User)
+
+        if (!$storage->getToken()->getUser() instanceof User)
         {
             throw new \RuntimeException('A user should be authenticated !');
         }
-        
+
         $this->user = $storage->getToken()->getUser();
     }
-    
+
     /**
-     * 
+     *
      * {@inheritDoc}
      */
     public function fetchQuery($context, array $args)
@@ -97,23 +56,23 @@ class TimelineActivityProvider implements TimelineProviderInterface
             return TimelineSingleQuery::fromArray($this->aclAwareRepository
                 ->queryTimelineIndexer($context, $args));
         }
-        
+
         $metadataActivity = $this->em->getClassMetadata(Activity::class);
 
         [$where, $parameters] =  $this->getWhereClauseForPerson($args['person']);
-        
+
         return TimelineSingleQuery::fromArray([
            'id' => $metadataActivity->getTableName()
                 .'.'.$metadataActivity->getColumnName('id'),
            'type' => 'activity',
            'date' => $metadataActivity->getTableName()
                 .'.'.$metadataActivity->getColumnName('date'),
-           'FROM' => $this->getFromClausePerson($args['person']),
+           'FROM' => $this->getFromClausePerson(),
            'WHERE' => $where,
            'parameters' => $parameters
        ]);
     }
-    
+
     private function getWhereClauseForPerson(Person $person)
     {
         $parameters = [];
@@ -125,15 +84,15 @@ class TimelineActivityProvider implements TimelineProviderInterface
         $whereClause = sprintf(' {activity.person_id} = ? AND {activity.scope_id} IN ({scopes_ids}) ');
         $scopes_ids = [];
 
-        // first parameter: activity.person_id 
+        // first parameter: activity.person_id
         $parameters[] = $person->getId();
 
-        // loop on reachable scopes 
+        // loop on reachable scopes
         foreach ($reachableScopes as $scope) {
             if (\in_array($scope->getId(), $scopes_ids)) {
                 continue;
             }
-            $scopes_ids[] = '?'; 
+            $scopes_ids[] = '?';
             $parameters[] = $scope->getId();
         }
 
@@ -151,47 +110,40 @@ class TimelineActivityProvider implements TimelineProviderInterface
             $parameters
         ];
     }
-    
-    private function getFromClausePerson()
+
+    private function getFromClausePerson(): string
     {
         $metadataActivity = $this->em->getClassMetadata(Activity::class);
         $metadataPerson = $this->em->getClassMetadata(Person::class);
         $associationMapping = $metadataActivity->getAssociationMapping('person');
-        
-        return $metadataActivity->getTableName().' JOIN '
-            .$metadataPerson->getTableName().' ON '
-            .$metadataPerson->getTableName().'.'.
-                $associationMapping['joinColumns'][0]['referencedColumnName']
-            .' = '
-            .$associationMapping['joinColumns'][0]['name']
-            ;
+
+        return sprintf(
+            "%s JOIN %s ON %s.%s = %s",
+            $metadataActivity->getTableName(),
+            $metadataPerson->getTableName(),
+            $metadataPerson->getTableName(),
+            $associationMapping['joinColumns'][0]['referencedColumnName'],
+            $associationMapping['joinColumns'][0]['name']
+        );
     }
-    
-    /**
-     * 
-     * {@inheritDoc}
-     */
-    public function getEntities(array $ids)
+
+    public function getEntities(array $ids): array
     {
         $activities = $this->em->getRepository(Activity::class)
               ->findBy(array('id' => $ids));
-        
+
         $result = array();
         foreach($activities as $activity) {
             $result[$activity->getId()] = $activity;
         }
-        
+
         return $result;
     }
 
-    /**
-     * 
-     * {@inheritDoc}
-     */
-    public function getEntityTemplate($entity, $context, array $args)
+    public function getEntityTemplate($entity, $context, array $args): array
     {
         $this->checkContext($context);
-        
+
         return [
            'template' => 'ChillActivityBundle:Timeline:activity_person_context.html.twig',
            'template_data' => [
@@ -201,26 +153,25 @@ class TimelineActivityProvider implements TimelineProviderInterface
         ];
     }
 
-    /**
-     * 
-     * {@inheritDoc}
-     */
-    public function supportsType($type)
+    public function supportsType($type): bool
     {
         return $type === 'activity';
     }
-    
+
     /**
-     * check if the context is supported
-     * 
-     * @param string $context
+     * Check if the context is supported.
+     *
      * @throws \LogicException if the context is not supported
      */
-    private function checkContext($context)
+    private function checkContext(string $context)
     {
         if (FALSE === \in_array($context, self::SUPPORTED_CONTEXTS)) {
-            throw new \LogicException("The context '$context' is not "
-                  . "supported. Currently only 'person' is supported");
+            throw new \LogicException(
+                sprintf(
+                    "The context '%s' is not supported. Currently only 'person' is supported",
+                    $context
+                )
+            );
         }
     }