bump PHPStan level to 2

add extra files to export-ignore
sonata-project · Jun 21, 2020 · 85525d9 · 85525d9
1 parent 70e1e48
commit 85525d9
Show file tree

Hide file tree

Showing 23 changed files with 345 additions and 18 deletions.
diff --git a/.gitattributes b/.gitattributes
@@ -2,3 +2,7 @@
 *.md export-ignore
 tests export-ignore
 docs export-ignore
+phpstan.neon.dist export-ignore
+phpstan-baseline.neon export-ignore
+Makefile export-ignore
+phpunit.xml.dist export-ignore
diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -1,5 +1,168 @@
 parameters:
 	ignoreErrors:
+		-
+		    # will be fixed in v4. Currently BC break
+			message: "#^Call to an undefined method Sonata\\\\AdminBundle\\\\Admin\\\\AdminInterface\\:\\:setFilterPersister\\(\\)\\.$#"
+			count: 1
+			path: src/Action/RetrieveAutocompleteItemsAction.php
+
+		-
+		    # will be fixed in v4. Currently BC break
+			message: "#^Call to an undefined method Sonata\\\\AdminBundle\\\\Datagrid\\\\PagerInterface\\:\\:isLastPage\\(\\)\\.$#"
+			count: 1
+			path: src/Action/RetrieveAutocompleteItemsAction.php
+
+		-
+		    # will be fixed in v4. Currently BC break
+			message: "#^Call to an undefined method Sonata\\\\AdminBundle\\\\Datagrid\\\\PagerInterface\\:\\:getPage\\(\\)\\.$#"
+			count: 1
+			path: src/Action/SearchAction.php
+
+		-
+		    # will be fixed in v4. Currently BC break
+			message: "#^Call to an undefined method Sonata\\\\AdminBundle\\\\Datagrid\\\\PagerInterface\\:\\:getNbResults\\(\\)\\.$#"
+			count: 1
+			path: src/Action/SearchAction.php
+
+		-
+		    # will be fixed in v4. Currently BC break
+			message: "#^Call to an undefined method Sonata\\\\AdminBundle\\\\Admin\\\\AdminInterface\\:\\:getBaseRoutePattern\\(\\)\\.$#"
+			count: 1
+			path: src/Admin/AbstractAdmin.php
+
+		-
+		    # will be fixed in v4. Currently BC break
+			message: "#^Call to an undefined method Sonata\\\\AdminBundle\\\\Admin\\\\AdminInterface\\:\\:getBaseRouteName\\(\\)\\.$#"
+			count: 2
+			path: src/Admin/AbstractAdmin.php
+
+		-
+		    # will be fixed in v4. Currently BC break
+			message: "#^Call to an undefined method Sonata\\\\AdminBundle\\\\Admin\\\\AdminInterface\\:\\:getSideMenu\\(\\)\\.$#"
+			count: 1
+			path: src/Admin/AbstractAdmin.php
+
+		-
+		    # will be fixed in v4. Currently BC break
+			message: "#^Call to an undefined method Sonata\\\\AdminBundle\\\\Admin\\\\AdminInterface\\:\\:addParentAssociationMapping\\(\\)\\.$#"
+			count: 1
+			path: src/Admin/AbstractAdmin.php
+
+		-
+		    # will be fixed in v4. Currently BC break
+			message: "#^Call to an undefined method Sonata\\\\AdminBundle\\\\Admin\\\\AdminInterface\\:\\:getRouteGenerator\\(\\)\\.$#"
+			count: 1
+			path: src/Admin/BreadcrumbsBuilder.php
+
+		-
+		    # will be fixed in v4. Currently BC break
+			message: "#^Call to an undefined method Sonata\\\\AdminBundle\\\\Admin\\\\AdminInterface\\:\\:getClassnameLabel\\(\\)\\.$#"
+			count: 2
+			path: src/Admin/BreadcrumbsBuilder.php
+
+		-
+		    # will be fixed in v4. Currently BC break
+			message: "#^Call to an undefined method Sonata\\\\AdminBundle\\\\Admin\\\\AdminInterface\\:\\:getCurrentChildAdmin\\(\\)\\.$#"
+			count: 1
+			path: src/Admin/BreadcrumbsBuilder.php
+
+		-
+		    # will be fixed in v4. Currently BC break
+			message: "#^Call to an undefined method Sonata\\\\AdminBundle\\\\Admin\\\\AdminInterface\\:\\:getParentAssociationMapping\\(\\)\\.$#"
+			count: 2
+			path: src/Controller/CRUDController.php
+
+		-
+		    # will be fixed in v4. Currently BC break
+			message: "#^Method Sonata\\\\AdminBundle\\\\Datagrid\\\\Datagrid\\:\\:addFilter\\(\\) should return Sonata\\\\AdminBundle\\\\Filter\\\\FilterInterface but return statement is missing\\.$#"
+			count: 1
+			path: src/Datagrid/Datagrid.php
+
+		-
+		    # will be fixed in v4. Currently BC break
+			message: "#^Method Sonata\\\\AdminBundle\\\\Admin\\\\FieldDescriptionInterface\\:\\:getLabel\\(\\) invoked with 1 parameter, 0 required\\.$#"
+			count: 1
+			path: src/Datagrid/ListMapper.php
+
+		-
+		    # will be fixed in v4. Currently BC break
+			message: "#^Constructor of class Sonata\\\\AdminBundle\\\\Form\\\\DataTransformer\\\\ModelsToArrayTransformer has an unused parameter \\$choiceList\\.$#"
+			count: 1
+			path: src/Form/DataTransformer/ModelsToArrayTransformer.php
+
+		-
+		    # will be fixed in v4. Currently BC break
+			message: "#^Constructor of class Sonata\\\\AdminBundle\\\\Form\\\\DataTransformer\\\\ModelsToArrayTransformer has an unused parameter \\$class\\.$#"
+			count: 1
+			path: src/Form/DataTransformer/ModelsToArrayTransformer.php
+
+		-
+		    # will be fixed in v4. Currently BC break
+			message: "#^Constructor of class Sonata\\\\AdminBundle\\\\Form\\\\DataTransformer\\\\ModelsToArrayTransformer has an unused parameter \\$modelManager\\.$#"
+			count: 1
+			path: src/Form/DataTransformer/ModelsToArrayTransformer.php
+
+		-
+		    # will be fixed in v4. Currently BC break
+			message: "#^Call to an undefined method Sonata\\\\AdminBundle\\\\Admin\\\\AdminInterface\\:\\:reorderFormGroup\\(\\)\\.$#"
+			count: 1
+			path: src/Form/FormMapper.php
+
+		-
+		    # will be fixed in v4. Currently BC break
+			message: "#^Call to an undefined method Sonata\\\\AdminBundle\\\\Admin\\\\FieldDescriptionInterface\\:\\:setHelp\\(\\)\\.$#"
+			count: 2
+			path: src/Form/FormMapper.php
+
+		-
+		    # will be fixed in v4. Currently BC break
+			message: "#^Method Sonata\\\\AdminBundle\\\\Admin\\\\AdminInterface\\:\\:getFormGroups\\(\\) invoked with 1 parameter, 0 required\\.$#"
+			count: 1
+			path: src/Form/FormMapper.php
+
+		-
+		    # will be fixed in v4. Currently BC break
+			message: "#^Method Sonata\\\\AdminBundle\\\\Admin\\\\AdminInterface\\:\\:getFormTabs\\(\\) invoked with 1 parameter, 0 required\\.$#"
+			count: 1
+			path: src/Form/FormMapper.php
+
+		-
+		    # will be fixed in v4. Currently BC break
+			message: "#^Call to an undefined method Sonata\\\\AdminBundle\\\\Admin\\\\AdminInterface\\:\\:defineFormBuilder\\(\\)\\.$#"
+			count: 1
+			path: src/Form/Type/AdminType.php
+
+		-
+		    # will be fixed in v4. Currently BC break
+			message: "#^Method Sonata\\\\AdminBundle\\\\Admin\\\\FieldDescriptionInterface\\:\\:getLabel\\(\\) invoked with 1 parameter, 0 required\\.$#"
+			count: 1
+			path: src/Show/ShowMapper.php
+
+		-
+		    # will be fixed in v4. Currently BC break
+			message: "#^Method Sonata\\\\AdminBundle\\\\Admin\\\\AdminInterface\\:\\:getShowGroups\\(\\) invoked with 1 parameter, 0 required\\.$#"
+			count: 1
+			path: src/Show/ShowMapper.php
+
+		-
+		    # will be fixed in v4. Currently BC break
+			message: "#^Method Sonata\\\\AdminBundle\\\\Admin\\\\AdminInterface\\:\\:getShowTabs\\(\\) invoked with 1 parameter, 0 required\\.$#"
+			count: 1
+			path: src/Show/ShowMapper.php
+
+		-
+		    # will be fixed in v4. Currently BC break
+			message: "#^Method Sonata\\\\AdminBundle\\\\Translator\\\\Extractor\\\\JMSTranslatorBundle\\\\AdminExtractor\\:\\:buildSecurityInformation\\(\\) should return array\\<string, mixed\\> but return statement is missing\\.$#"
+			count: 1
+			path: src/Translator/Extractor/JMSTranslatorBundle/AdminExtractor.php
+
+		-
+		    # will be fixed in v4. Currently BC break
+			message: "#^Method Sonata\\\\AdminBundle\\\\Translator\\\\Extractor\\\\JMSTranslatorBundle\\\\AdminExtractor\\:\\:getBaseRole\\(\\) should return string but return statement is missing\\.$#"
+			count: 1
+			path: src/Translator/Extractor/JMSTranslatorBundle/AdminExtractor.php
+
+# next 6 errors are due to not installed Doctrine ORM\ODM
 		-
 			message: "#^Class Doctrine\\\\ODM\\\\MongoDB\\\\PersistentCollection not found\\.$#"
 			count: 1
@@ -9,3 +172,35 @@ parameters:
 			message: "#^Class Doctrine\\\\ORM\\\\PersistentCollection not found\\.$#"
 			count: 1
 			path: src/Admin/AdminHelper.php
+
+		-
+			message: "#^Call to method getTypeClass\\(\\) on an unknown class Doctrine\\\\ODM\\\\MongoDB\\\\PersistentCollection\\.$#"
+			count: 1
+			path: src/Admin/AdminHelper.php
+
+		-
+			message: "#^Call to method getTypeClass\\(\\) on an unknown class Doctrine\\\\ORM\\\\PersistentCollection\\.$#"
+			count: 1
+			path: src/Admin/AdminHelper.php
+
+		-
+			message: "#^Call to method add\\(\\) on an unknown class Doctrine\\\\ODM\\\\MongoDB\\\\PersistentCollection\\.$#"
+			count: 1
+			path: src/Admin/AdminHelper.php
+
+		-
+			message: "#^Call to method add\\(\\) on an unknown class Doctrine\\\\ORM\\\\PersistentCollection\\.$#"
+			count: 1
+			path: src/Admin/AdminHelper.php
+
+# Symfony related errors
+		-
+			message: "#^Call to an undefined method Symfony\\\\Component\\\\Config\\\\Definition\\\\Builder\\\\NodeParentInterface\\:\\:arrayNode\\(\\)\\.$#"
+			count: 1
+			path: src/DependencyInjection/Configuration.php
+
+		-
+		    # Symfony BC break policy
+			message: "#^Method Symfony\\\\Contracts\\\\EventDispatcher\\\\EventDispatcherInterface\\:\\:dispatch\\(\\) invoked with 2 parameters, 1 required\\.$#"
+			count: 1
+			path: src/Menu/MenuBuilder.php
diff --git a/phpstan.neon.dist b/phpstan.neon.dist
@@ -1,7 +1,8 @@
 includes:
     - phpstan-baseline.neon
+
 parameters:
-    level: 0
+    level: 2
 
     paths:
         - src

diff --git a/src/Action/SetObjectFieldValueAction.php b/src/Action/SetObjectFieldValueAction.php
@@ -159,6 +159,7 @@ public function __invoke(Request $request): JsonResponse
         // render the widget
         // todo : fix this, the twig environment variable is not set inside the extension ...
         $extension = $this->twig->getExtension(SonataAdminExtension::class);
+        \assert($extension instanceof SonataAdminExtension);
 
         $content = $extension->renderListElement($this->twig, $rootObject, $fieldDescription);
 

diff --git a/src/Admin/AbstractAdmin.php b/src/Admin/AbstractAdmin.php
@@ -51,6 +51,7 @@
 use Symfony\Component\Security\Acl\Model\DomainObjectInterface;
 use Symfony\Component\Security\Core\Exception\AccessDeniedException;
 use Symfony\Component\Translation\TranslatorInterface;
+use Symfony\Component\Validator\Mapping\GenericMetadata;
 use Symfony\Component\Validator\Validator\ValidatorInterface;
 
 /**
@@ -3410,6 +3411,7 @@ protected function attachInlineValidator()
 
         // add the custom inline validation option
         $metadata = $this->validator->getMetadataFor($this->getClass());
+        \assert($metadata instanceof GenericMetadata);
 
         $metadata->addConstraint(new InlineConstraint([
             'service' => $this,

diff --git a/src/Admin/AdminInterface.php b/src/Admin/AdminInterface.php
@@ -225,6 +225,9 @@ public function getIdParameter();
      */
     public function hasRoute($name);
 
+    /**
+     * @return void
+     */
     public function setSecurityHandler(SecurityHandlerInterface $securityHandler);
 
     /**
@@ -726,6 +729,60 @@ public function getListMode();
      */
 //    NEXT_MAJOR: uncomment this method in 4.0
     // public function isDefaultFilter(string $name): bool;
+
+//    NEXT_MAJOR: uncomment this method in 4.0
+//    public function setFilterPersister(?\Sonata\AdminBundle\Filter\Persister\FilterPersisterInterface\FilterPersisterInterface $filterPersister = null): void;
+
+//    NEXT_MAJOR: uncomment this method in 4.0
+//    /**
+//     * Returns the baseRoutePattern used to generate the routing information.
+//     */
+//    public function getBaseRoutePattern(): string;
+
+//    NEXT_MAJOR: uncomment this method in 4.0
+//    /**
+//     * Returns the baseRouteName used to generate the routing information.
+//     */
+//    public function getBaseRouteName(): string;
+
+//    NEXT_MAJOR: uncomment this method in 4.0
+//    public function getSideMenu(string $action, ?AdminInterface $childAdmin = null): \Knp\Menu\ItemInterface;
+
+//    NEXT_MAJOR: uncomment this method in 4.0
+//    public function addParentAssociationMapping(string $code, string $value): void;
+
+//    NEXT_MAJOR: uncomment this method in 4.0
+//    public function getRouteGenerator(): \Sonata\AdminBundle\Route\RouteGeneratorInterface;
+
+//    NEXT_MAJOR: uncomment this method in 4.0
+//    /**
+//     * Returns the classname label.
+//     */
+//    public function getClassnameLabel(): string;
+
+//    NEXT_MAJOR: uncomment this method in 4.0
+//    /**
+//     * Returns the current child admin instance.
+//     */
+//    public function getCurrentChildAdmin(): ?AdminInterface;
+
+//    NEXT_MAJOR: uncomment this method in 4.0
+//    /**
+//     * Returns the name of the parent related field, so the field can be use to set the default
+//     * value (ie the parent object) or to filter the object.
+//     *
+//     */
+//    public function getParentAssociationMapping(): ?string;
+
+//    NEXT_MAJOR: uncomment this method in 4.0
+//    public function reorderFormGroup(string $group, array $keys): void;
+
+//    NEXT_MAJOR: uncomment this method in 4.0
+//    /**
+//     * This method is being called by the main admin class and the child class,
+//     * the getFormBuilder is only call by the main admin class.
+//     */
+//    public function defineFormBuilder(FormBuilderInterface $formBuilder): void;
 }
 
 class_exists(\Sonata\Form\Validator\ErrorElement::class);
diff --git a/src/Admin/FieldDescriptionInterface.php b/src/Admin/FieldDescriptionInterface.php
@@ -299,4 +299,10 @@ public function getSortParentAssociationMapping();
      * @return mixed
      */
     public function getFieldValue($object, $fieldName);
+
+//    NEXT_MAJOR: uncomment this method in 4.0
+//    /**
+//     * Defines the help message.
+//     */
+//    public function setHelp(string $help): void;
 }
diff --git a/src/Command/ExplainAdminCommand.php b/src/Command/ExplainAdminCommand.php
@@ -18,6 +18,7 @@
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\Validator\Mapping\ClassMetadata;
 use Symfony\Component\Validator\Mapping\Factory\MetadataFactoryInterface;
 
 /**
@@ -118,6 +119,7 @@ public function execute(InputInterface $input, OutputInterface $output)
         }
 
         $metadata = $this->validator->getMetadataFor($admin->getClass());
+        \assert($metadata instanceof ClassMetadata);
 
         $output->writeln('');
         $output->writeln('<comment>Validation Framework</comment> - http://symfony.com/doc/3.0/book/validation.html');

diff --git a/src/Controller/CRUDController.php b/src/Controller/CRUDController.php
@@ -52,6 +52,11 @@ class CRUDController implements ContainerAwareInterface
         ControllerTrait::render as originalRender;
     }
 
+    /**
+     * @var ContainerInterface
+     */
+    protected $container;
+
     /**
      * The related Admin class.
      *
@@ -1011,7 +1016,7 @@ public function aclAction($deprecatedId = null) // NEXT_MAJOR: Remove the unused
                 $updateMethod = 'updateAclRoles';
             }
 
-            if (isset($form)) {
+            if (isset($form, $updateMethod)) {
                 $form->handleRequest($request);
 
                 if ($form->isValid()) {

diff --git a/src/Datagrid/DatagridMapper.php b/src/Datagrid/DatagridMapper.php
@@ -32,6 +32,11 @@ class DatagridMapper extends BaseMapper
      */
     protected $datagrid;
 
+    /**
+     * @var DatagridBuilderInterface
+     */
+    protected $builder;
+
     public function __construct(
         DatagridBuilderInterface $datagridBuilder,
         DatagridInterface $datagrid,

diff --git a/src/Datagrid/ListMapper.php b/src/Datagrid/ListMapper.php
@@ -37,6 +37,11 @@ class ListMapper extends BaseMapper
      */
     protected $list;
 
+    /**
+     * @var ListBuilderInterface
+     */
+    protected $builder;
+
     public function __construct(
         ListBuilderInterface $listBuilder,
         FieldDescriptionCollection $list,