Merge pull request #2660 from acrobat/setup-phpstan

[AllBundles] Integrate phpstan in travis build suite
Kunstmaan · Jun 25, 2020 · eab2a6b · eab2a6b
2 parents 92791c2 + bb283af
commit eab2a6b
Show file tree

Hide file tree

Showing 19 changed files with 67 additions and 14 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -90,4 +90,10 @@ jobs:
         - npm run buildGroundControlSkeleton
       after_script: skip
 
+    # Code quality checks
+    - stage: Code quality
+      php: 7.4
+      env: PHPStan=true
+      script: vendor/bin/phpstan analyse --no-progress
+
 
diff --git a/composer.json b/composer.json
@@ -88,7 +88,9 @@
         "matthiasnoback/symfony-dependency-injection-test": "^3.1",
         "symfony/phpunit-bridge": "^4.3",
         "phpunit/phpunit": "^7.5",
-        "friendsofphp/php-cs-fixer": "^2.13"
+        "friendsofphp/php-cs-fixer": "^2.13",
+        "phpstan/phpstan": "^0.12.18",
+        "phpstan/phpstan-doctrine": "^0.12.10"
     },
     "replace": {
         "kunstmaan/admin-bundle": "self.version",

diff --git a/phpstan.neon b/phpstan.neon
@@ -0,0 +1,22 @@
+includes:
+    - vendor/phpstan/phpstan-doctrine/extension.neon
+
+parameters:
+    level: 1
+    paths:
+        -  src
+
+    excludes_analyse:
+        - src/Kunstmaan/*/Tests/*
+        - src/Kunstmaan/*/vendor/*
+        - src/Kunstmaan/BehatBundle
+        - src/Kunstmaan/GeneratorBundle/Resources/SensioGeneratorBundle
+        - src/Kunstmaan/CacheBundle # Temporary excluded for full rework
+        # Excluded deprecated classes/files
+        - src/Kunstmaan/AdminBundle/Composer/ScriptHandler.php
+        - src/Kunstmaan/AdminBundle/EventListener/ConsoleExceptionListener.php
+
+    ignoreErrors:
+        # Ignore errors on unfound classes for old symfony version BC layers
+        - '#^Class Symfony\\Component\\Security\\Core\\Role\\RoleInterface not found\.\z#'
+        - '#Constructor of class Kunstmaan\\MediaBundle\\AdminList\\MediaAdminListConfigurator has an unused parameter \$mediaManager\.#' # Will be fixed in separate PR
diff --git a/src/Kunstmaan/AdminBundle/Controller/ExceptionController.php b/src/Kunstmaan/AdminBundle/Controller/ExceptionController.php
@@ -12,6 +12,9 @@
 
 class ExceptionController extends AdminListController
 {
+    /** @var ExceptionAdminListConfigurator */
+    private $configurator;
+
     private function getAdminListConfigurator()
     {
         if (!isset($this->configurator)) {

diff --git a/src/Kunstmaan/AdminBundle/Helper/AdminRouteHelper.php b/src/Kunstmaan/AdminBundle/Helper/AdminRouteHelper.php
@@ -41,7 +41,7 @@ public function __construct($adminKey, RequestStack $requestStack)
      */
     public function isAdminRoute($url)
     {
-        if ($this->matchesPreviewRoute($url)) {
+        if ($this->matchesPreviewRoute()) {
             return false;
         }
 

diff --git a/src/Kunstmaan/AdminBundle/Helper/FormWidgets/Tabs/TabPane.php b/src/Kunstmaan/AdminBundle/Helper/FormWidgets/Tabs/TabPane.php
@@ -46,6 +46,9 @@ class TabPane
      */
     protected $formView;
 
+    /** @var Slugifier */
+    private $slugifier;
+
     /**
      * @param string               $identifier  The identifier
      * @param Request              $request     The request

diff --git a/src/Kunstmaan/AdminBundle/Helper/Security/Acl/AclNativeHelper.php b/src/Kunstmaan/AdminBundle/Helper/Security/Acl/AclNativeHelper.php
@@ -87,6 +87,7 @@ public function apply(QueryBuilder $queryBuilder, PermissionDefinition $permissi
         /* @var $token TokenInterface */
         $token = $this->tokenStorage->getToken();
         $userRoles = array();
+        $user = null;
         if (!\is_null($token)) {
             $user = $token->getUser();
             if (method_exists($this->roleHierarchy, 'getReachableRoleNames')) {

diff --git a/src/Kunstmaan/AdminBundle/Helper/VersionCheck/VersionChecker.php b/src/Kunstmaan/AdminBundle/Helper/VersionCheck/VersionChecker.php
@@ -63,7 +63,7 @@ public function __construct(ContainerInterface $container, Cache $cache, $transl
 
         // NEXT_MAJOR Add "Symfony\Contracts\Translation\TranslatorInterface" typehint when sf <4.4 support is removed.
         if (!$translator instanceof TranslatorInterface && !$translator instanceof LegacyTranslatorInterface) {
-            throw new \InvalidArgumentException(sprintf('The "$translator" parameter should be instance of "%s" or "%s"', Symfony\Contracts\Translation\TranslatorInterface::class, LegacyTranslatorInterface::class));
+            throw new \InvalidArgumentException(sprintf('The "$translator" parameter should be instance of "%s" or "%s"', TranslatorInterface::class, LegacyTranslatorInterface::class));
         }
 
         $this->translator = $translator;

diff --git a/src/Kunstmaan/AdminListBundle/AdminList/FieldAlias.php b/src/Kunstmaan/AdminListBundle/AdminList/FieldAlias.php
@@ -7,6 +7,12 @@
  */
 class FieldAlias
 {
+    /** @var string */
+    private $abbr;
+
+    /** @var string */
+    private $relation;
+
     /**
      * FieldAlias constructor.
      *

diff --git a/src/Kunstmaan/DashboardBundle/Controller/GoogleAnalyticsController.php b/src/Kunstmaan/DashboardBundle/Controller/GoogleAnalyticsController.php
@@ -93,9 +93,10 @@ public function setTokenAction(Request $request)
     {
         $this->denyAccessUnlessGranted('ROLE_SUPER_ADMIN');
 
-        $code = urldecode($request->query->get('code'));
+        $codeParameter = $request->query->get('code');
 
-        if (isset($code)) {
+        if (null !== $codeParameter) {
+            $code = urldecode($codeParameter);
             $clientHelper = $this->container->get('kunstmaan_dashboard.helper.google.client');
             $configHelper = $this->container->get('kunstmaan_dashboard.helper.google.analytics.config');
 

diff --git a/src/Kunstmaan/GeneratorBundle/Command/GenerateAdminListCommand.php b/src/Kunstmaan/GeneratorBundle/Command/GenerateAdminListCommand.php
@@ -190,7 +190,7 @@ protected function updateRouting(
         $prefix = $multilang ? '/{_locale}' : '';
 
         $code = sprintf("%s:\n", strtolower($bundle->getName()) . '_' . strtolower($entityClass) . '_admin_list');
-        $code .= sprintf("    resource: '@%s/Controller/%sAdminListController.php'\n", $bundle->getName(), $entityClass, "'");
+        $code .= sprintf("    resource: '@%s/Controller/%sAdminListController.php'\n", $bundle->getName(), $entityClass);
         $code .= "    type:     annotation\n";
         $code .= sprintf("    prefix:   %s/%s/%s/\n", $prefix, $adminKey, strtolower($entityClass));
         if ($multilang) {

diff --git a/src/Kunstmaan/GeneratorBundle/Command/GeneratePageCommand.php b/src/Kunstmaan/GeneratorBundle/Command/GeneratePageCommand.php
@@ -203,7 +203,7 @@ function ($name) use ($generator, $bundlePath) {
          * Ask for which sections pagepart configuration the end user wants to use for the different sections
          */
         $this->assistant->writeLine(array("\nThe select page template consists of these contexts: " . implode(', ', $templateConfig['contexts'])));
-        $this->section = array();
+        $this->sections = array();
         foreach ($templateConfig['contexts'] as $context) {
             $question = "Which pagepart configuration would you like to use for the '$context' context";
             $section = $this->askForSections($question, $this->bundle, false, $context);

diff --git a/src/Kunstmaan/GeneratorBundle/Generator/Symfony4EntityRepositoryGenerator.php b/src/Kunstmaan/GeneratorBundle/Generator/Symfony4EntityRepositoryGenerator.php
@@ -50,8 +50,6 @@ public function generateEntityRepositoryClass(string $entityClass, string $repos
     public function writeEntityRepositoryClass($entityClass, $repositoryClass, $outputDirectory)
     {
         $classNameParts = explode('\\', $repositoryClass);
-        $repositoryClassName = end($classNameParts);
-        $this->repositoryName = $repositoryClassName;
         $code = $this->generateEntityRepositoryClass($entityClass, $repositoryClass);
 
         $path = $outputDirectory . DIRECTORY_SEPARATOR . 'Repository' . DIRECTORY_SEPARATOR . end($classNameParts) . '.php';

diff --git a/src/Kunstmaan/MultiDomainBundle/Helper/DomainConfiguration.php b/src/Kunstmaan/MultiDomainBundle/Helper/DomainConfiguration.php
@@ -33,6 +33,9 @@ class DomainConfiguration extends BaseDomainConfiguration
      */
     protected $adminRouteHelper;
 
+    /** @var EntityManagerInterface */
+    private $em;
+
     /**
      * @param ContainerInterface|string $multilanguage
      */

diff --git a/src/Kunstmaan/NodeBundle/Helper/Menu/PageMenuAdaptor.php b/src/Kunstmaan/NodeBundle/Helper/Menu/PageMenuAdaptor.php
@@ -10,7 +10,6 @@
 use Kunstmaan\AdminBundle\Helper\Menu\TopMenuItem;
 use Kunstmaan\AdminBundle\Helper\Security\Acl\AclNativeHelper;
 use Kunstmaan\AdminBundle\Helper\Security\Acl\Permission\PermissionMap;
-use Kunstmaan\NodeBundle\Entity\Node;
 use Kunstmaan\NodeBundle\Helper\NodeMenuItem;
 use Kunstmaan\NodeBundle\Helper\PagesConfiguration;
 use Symfony\Component\HttpFoundation\Request;
@@ -157,7 +156,6 @@ private function getTreeNodes(
                 $includeHiddenFromNav,
                 $rootNode
             );
-            /** @var Node $nodeInfo */
             foreach ($allNodes as $nodeInfo) {
                 $refEntityName = $nodeInfo['ref_entity_name'];
                 if ($this->pagesConfiguration->isHiddenFromTree($refEntityName)) {

diff --git a/src/Kunstmaan/NodeBundle/Helper/NodeMenu.php b/src/Kunstmaan/NodeBundle/Helper/NodeMenu.php
@@ -485,6 +485,7 @@ function (Node $entry) use ($includeOffline) {
             );
 
             if (!\is_null($parent)) {
+                $parentNode = null;
                 /** @var Node $parentNode */
                 if ($parent instanceof NodeTranslation) {
                     $parentNode = $parent->getNode();
@@ -500,7 +501,7 @@ function (Node $entry) use ($includeOffline) {
                 // Look for a node with the same parent id
                 /** @var Node $node */
                 foreach ($nodes as $node) {
-                    if ($node->getParent()->getId() == $parentNode->getId()) {
+                    if ($parentNode && $node->getParent()->getId() == $parentNode->getId()) {
                         $resultNode = $node;
 
                         break;
@@ -516,7 +517,7 @@ function (Node $entry) use ($includeOffline) {
                                 $tempNode->getParent()
                             )) {
                             $tempParent = $tempNode->getParent();
-                            if ($tempParent->getId() == $parentNode->getId()) {
+                            if ($parentNode && $tempParent->getId() == $parentNode->getId()) {
                                 $resultNode = $node;
 
                                 break;

diff --git a/src/Kunstmaan/NodeSearchBundle/Configuration/NodePagesConfiguration.php b/src/Kunstmaan/NodeSearchBundle/Configuration/NodePagesConfiguration.php
@@ -548,6 +548,7 @@ protected function addPageContent(NodeTranslation $nodeTranslation, $page, &$doc
      */
     protected function enterRequestScope($lang)
     {
+        $locale = null;
         $requestStack = $this->container->get('request_stack');
         // If there already is a request, get the locale from it.
         if ($requestStack->getCurrentRequest()) {

diff --git a/src/Kunstmaan/TranslatorBundle/AdminList/TranslationAdminListConfigurator.php b/src/Kunstmaan/TranslatorBundle/AdminList/TranslationAdminListConfigurator.php
@@ -247,6 +247,7 @@ public function getQueryBuilder()
 
                 foreach ($this->locales as $key => $locale) {
                     $uniqueId = 'txt_'.$key;
+                    $expr = null;
                     switch ($textComparator) {
                         case 'equals':
                             $expr = $this->queryBuilder->expr()->eq('t_'.$locale.'.`text`', ':var_'.$uniqueId);
@@ -287,7 +288,10 @@ public function getQueryBuilder()
 
                             break;
                     }
-                    $orX->add($expr);
+
+                    if (null !== $expr) {
+                        $orX->add($expr);
+                    }
                 }
 
                 $this->queryBuilder->andWhere($orX);

diff --git a/src/Kunstmaan/TranslatorBundle/Service/Translator/CacheValidator.php b/src/Kunstmaan/TranslatorBundle/Service/Translator/CacheValidator.php
@@ -2,13 +2,17 @@
 
 namespace Kunstmaan\TranslatorBundle\Service\Translator;
 
+use Psr\Log\LoggerInterface;
 use Symfony\Component\Finder\Finder;
 
 /**
  * Validates and checks translations cache
  */
 class CacheValidator
 {
+    /** @var LoggerInterface */
+    private $logger;
+
     /**
      * Where to store cache files
      *