Add typehint (#1293)

sonata-project · Feb 3, 2021 · 35aad95 · 35aad95
1 parent cad72fb
commit 35aad95
Show file tree

Hide file tree

Showing 35 changed files with 77 additions and 506 deletions.
diff --git a/src/Admin/FieldDescription.php b/src/Admin/FieldDescription.php
@@ -91,7 +91,7 @@ public function isIdentifier(): bool
         return $this->fieldMapping['id'] ?? false;
     }
 
-    public function getValue($object)
+    public function getValue(object $object)
     {
         foreach ($this->parentAssociationMappings as $parentAssociationMapping) {
             $object = $this->getFieldValue($object, $parentAssociationMapping['fieldName']);

diff --git a/src/Datagrid/OrderByToSelectWalker.php b/src/Datagrid/OrderByToSelectWalker.php
@@ -14,6 +14,7 @@
 namespace Sonata\DoctrineORMAdminBundle\Datagrid;
 
 use Doctrine\ORM\Query\AST\Functions\IdentityFunction;
+use Doctrine\ORM\Query\AST\Node;
 use Doctrine\ORM\Query\AST\OrderByClause;
 use Doctrine\ORM\Query\AST\PathExpression;
 use Doctrine\ORM\Query\AST\SelectExpression;
@@ -90,7 +91,7 @@ public function walkSelectStatement(SelectStatement $AST): void
      *
      * @return IdentityFunction|PathExpression
      */
-    private function createSelectExpressionItem(PathExpression $pathExpression)
+    private function createSelectExpressionItem(PathExpression $pathExpression): Node
     {
         if (PathExpression::TYPE_SINGLE_VALUED_ASSOCIATION === $pathExpression->type) {
             $identity = new IdentityFunction('identity');

diff --git a/src/Datagrid/ProxyQuery.php b/src/Datagrid/ProxyQuery.php
@@ -114,22 +114,19 @@ class ProxyQuery implements ProxyQueryInterface
      */
     private $hints = [];
 
-    /**
-     * @param QueryBuilder $queryBuilder
-     */
-    public function __construct($queryBuilder)
+    public function __construct(QueryBuilder $queryBuilder)
     {
         $this->queryBuilder = $queryBuilder;
         $this->uniqueParameterId = 0;
         $this->entityJoinAliases = [];
     }
 
-    public function __call($name, $args)
+    public function __call(string $name, array $args)
     {
         return $this->queryBuilder->$name(...$args);
     }
 
-    public function __get($name)
+    public function __get(string $name)
     {
         return $this->queryBuilder->$name;
     }

diff --git a/src/Datagrid/ProxyQueryInterface.php b/src/Datagrid/ProxyQueryInterface.php
@@ -18,8 +18,5 @@
 
 interface ProxyQueryInterface extends BaseProxyQueryInterface
 {
-    /**
-     * @return QueryBuilder
-     */
-    public function getQueryBuilder();
+    public function getQueryBuilder(): QueryBuilder;
 }
diff --git a/src/DependencyInjection/Compiler/AddTemplatesCompilerPass.php b/src/DependencyInjection/Compiler/AddTemplatesCompilerPass.php
@@ -55,10 +55,9 @@ public function process(ContainerBuilder $container): void
     }
 
     /**
-     * @param string $name
-     * @param mixed  $value
+     * @param mixed $value
      */
-    public function mergeMethodCall(Definition $definition, $name, $value): void
+    public function mergeMethodCall(Definition $definition, string $name, $value): void
     {
         $methodCalls = $definition->getMethodCalls();
 

diff --git a/src/DependencyInjection/Configuration.php b/src/DependencyInjection/Configuration.php
@@ -30,10 +30,8 @@ class Configuration implements ConfigurationInterface
 {
     /**
      * Generates the configuration tree.
-     *
-     * @return TreeBuilder
      */
-    public function getConfigTreeBuilder()
+    public function getConfigTreeBuilder(): TreeBuilder
     {
         $treeBuilder = new TreeBuilder('sonata_doctrine_orm_admin');
 

diff --git a/src/Filter/AbstractDateFilter.php b/src/Filter/AbstractDateFilter.php
@@ -13,7 +13,6 @@
 
 namespace Sonata\DoctrineORMAdminBundle\Filter;
 
-use Sonata\AdminBundle\Datagrid\ProxyQueryInterface as BaseProxyQueryInterface;
 use Sonata\AdminBundle\Form\Type\Filter\DateRangeType;
 use Sonata\AdminBundle\Form\Type\Filter\DateTimeRangeType;
 use Sonata\AdminBundle\Form\Type\Filter\DateTimeType;
@@ -46,21 +45,10 @@ abstract class AbstractDateFilter extends Filter
      */
     protected $time = false;
 
-    public function filter(BaseProxyQueryInterface $query, $alias, $field, $data): void
+    public function filter(ProxyQueryInterface $query, string $alias, string $field, array $data): void
     {
-        /* NEXT_MAJOR: Remove this deprecation and update the typehint */
-        if (!$query instanceof ProxyQueryInterface) {
-            @trigger_error(sprintf(
-                'Passing %s as argument 1 to %s() is deprecated since sonata-project/doctrine-orm-admin-bundle 3.27'
-                .' and will throw a \TypeError error in version 4.0. You MUST pass an instance of %s instead.',
-                \get_class($query),
-                __METHOD__,
-                ProxyQueryInterface::class
-            ));
-        }
-
         // check data sanity
-        if (!$data || !\is_array($data) || !\array_key_exists('value', $data)) {
+        if (!\array_key_exists('value', $data)) {
             return;
         }
 

diff --git a/src/Filter/BooleanFilter.php b/src/Filter/BooleanFilter.php
@@ -13,7 +13,6 @@
 
 namespace Sonata\DoctrineORMAdminBundle\Filter;
 
-use Sonata\AdminBundle\Datagrid\ProxyQueryInterface as BaseProxyQueryInterface;
 use Sonata\AdminBundle\Form\Type\Filter\DefaultType;
 use Sonata\DoctrineORMAdminBundle\Datagrid\ProxyQueryInterface;
 use Sonata\Form\Type\BooleanType;
@@ -24,20 +23,9 @@
  */
 class BooleanFilter extends Filter
 {
-    public function filter(BaseProxyQueryInterface $query, $alias, $field, $data): void
+    public function filter(ProxyQueryInterface $query, string $alias, string $field, array $data): void
     {
-        /* NEXT_MAJOR: Remove this deprecation and update the typehint */
-        if (!$query instanceof ProxyQueryInterface) {
-            @trigger_error(sprintf(
-                'Passing %s as argument 1 to %s() is deprecated since sonata-project/doctrine-orm-admin-bundle 3.27'
-                .' and will throw a \TypeError error in version 4.0. You MUST pass an instance of %s instead.',
-                \get_class($query),
-                __METHOD__,
-                ProxyQueryInterface::class
-            ));
-        }
-
-        if (!$data || !\is_array($data) || !\array_key_exists('type', $data) || !\array_key_exists('value', $data)) {
+        if (!\array_key_exists('type', $data) || !\array_key_exists('value', $data)) {
             return;
         }
 

diff --git a/src/Filter/CallbackFilter.php b/src/Filter/CallbackFilter.php
@@ -13,7 +13,6 @@
 
 namespace Sonata\DoctrineORMAdminBundle\Filter;
 
-use Sonata\AdminBundle\Datagrid\ProxyQueryInterface as BaseProxyQueryInterface;
 use Sonata\AdminBundle\Form\Type\Filter\DefaultType;
 use Sonata\DoctrineORMAdminBundle\Datagrid\ProxyQueryInterface;
 use Symfony\Component\Form\Extension\Core\Type\HiddenType;
@@ -24,19 +23,8 @@
  */
 class CallbackFilter extends Filter
 {
-    public function filter(BaseProxyQueryInterface $query, $alias, $field, $data): void
+    public function filter(ProxyQueryInterface $query, string $alias, string $field, array $data): void
     {
-        /* NEXT_MAJOR: Remove this deprecation and update the typehint */
-        if (!$query instanceof ProxyQueryInterface) {
-            @trigger_error(sprintf(
-                'Passing %s as argument 1 to %s() is deprecated since sonata-project/doctrine-orm-admin-bundle 3.27'
-                .' and will throw a \TypeError error in version 4.0. You MUST pass an instance of %s instead.',
-                \get_class($query),
-                __METHOD__,
-                ProxyQueryInterface::class
-            ));
-        }
-
         if (!\is_callable($this->getOption('callback'))) {
             throw new \RuntimeException(sprintf('Please provide a valid callback option "filter" for field "%s"', $this->getName()));
         }
@@ -80,22 +68,8 @@ public function getRenderSettings(): array
         ]];
     }
 
-    /**
-     * @param mixed[] $data
-     */
-    protected function association(BaseProxyQueryInterface $query, array $data): array
+    protected function association(ProxyQueryInterface $query, array $data): array
     {
-        /* NEXT_MAJOR: Remove this deprecation and update the typehint */
-        if (!$query instanceof ProxyQueryInterface) {
-            @trigger_error(sprintf(
-                'Passing %s as argument 1 to %s() is deprecated since sonata-project/doctrine-orm-admin-bundle 3.27'
-                .' and will throw a \TypeError error in version 4.0. You MUST pass an instance of %s instead.',
-                \get_class($query),
-                __METHOD__,
-                ProxyQueryInterface::class
-            ));
-        }
-
         $alias = $query->entityJoin($this->getParentAssociationMappings());
 
         return [$this->getOption('alias', $alias), $this->getFieldName()];

diff --git a/src/Filter/ChoiceFilter.php b/src/Filter/ChoiceFilter.php
@@ -13,7 +13,6 @@
 
 namespace Sonata\DoctrineORMAdminBundle\Filter;
 
-use Sonata\AdminBundle\Datagrid\ProxyQueryInterface as BaseProxyQueryInterface;
 use Sonata\AdminBundle\Form\Type\Filter\DefaultType;
 use Sonata\AdminBundle\Form\Type\Operator\EqualOperatorType;
 use Sonata\DoctrineORMAdminBundle\Datagrid\ProxyQueryInterface;
@@ -23,20 +22,9 @@
  */
 class ChoiceFilter extends Filter
 {
-    public function filter(BaseProxyQueryInterface $query, $alias, $field, $data): void
+    public function filter(ProxyQueryInterface $query, string $alias, string $field, array $data): void
     {
-        /* NEXT_MAJOR: Remove this deprecation and update the typehint */
-        if (!$query instanceof ProxyQueryInterface) {
-            @trigger_error(sprintf(
-                'Passing %s as argument 1 to %s() is deprecated since sonata-project/doctrine-orm-admin-bundle 3.27'
-                .' and will throw a \TypeError error in version 4.0. You MUST pass an instance of %s instead.',
-                \get_class($query),
-                __METHOD__,
-                ProxyQueryInterface::class
-            ));
-        }
-
-        if (!$data || !\is_array($data) || !\array_key_exists('type', $data) || !\array_key_exists('value', $data)) {
+        if (!\array_key_exists('type', $data) || !\array_key_exists('value', $data)) {
             return;
         }
 
@@ -66,10 +54,7 @@ public function getRenderSettings(): array
         ]];
     }
 
-    /**
-     * NEXT_MAJOR: Change the typehint to ProxyQueryInterface.
-     */
-    private function filterWithMultipleValues(BaseProxyQueryInterface $query, string $alias, string $field, array $data = []): void
+    private function filterWithMultipleValues(ProxyQueryInterface $query, string $alias, string $field, array $data = []): void
     {
         if (0 === \count($data['value'])) {
             return;
@@ -100,10 +85,7 @@ private function filterWithMultipleValues(BaseProxyQueryInterface $query, string
         }
     }
 
-    /**
-     * NEXT_MAJOR: Change the typehint to ProxyQueryInterface.
-     */
-    private function filterWithSingleValue(BaseProxyQueryInterface $query, string $alias, string $field, array $data = []): void
+    private function filterWithSingleValue(ProxyQueryInterface $query, string $alias, string $field, array $data = []): void
     {
         if ('' === $data['value'] || false === $data['value']) {
             return;

diff --git a/src/Filter/ClassFilter.php b/src/Filter/ClassFilter.php
@@ -13,7 +13,6 @@
 
 namespace Sonata\DoctrineORMAdminBundle\Filter;
 
-use Sonata\AdminBundle\Datagrid\ProxyQueryInterface as BaseProxyQueryInterface;
 use Sonata\AdminBundle\Form\Type\Filter\DefaultType;
 use Sonata\AdminBundle\Form\Type\Operator\EqualOperatorType;
 use Sonata\DoctrineORMAdminBundle\Datagrid\ProxyQueryInterface;
@@ -29,20 +28,9 @@ class ClassFilter extends Filter
         EqualOperatorType::TYPE_NOT_EQUAL => 'NOT INSTANCE OF',
     ];
 
-    public function filter(BaseProxyQueryInterface $query, $alias, $field, $data): void
+    public function filter(ProxyQueryInterface $query, string $alias, string $field, array $data): void
     {
-        /* NEXT_MAJOR: Remove this deprecation and update the typehint */
-        if (!$query instanceof ProxyQueryInterface) {
-            @trigger_error(sprintf(
-                'Passing %s as argument 1 to %s() is deprecated since sonata-project/doctrine-orm-admin-bundle 3.27'
-                .' and will throw a \TypeError error in version 4.0. You MUST pass an instance of %s instead.',
-                \get_class($query),
-                __METHOD__,
-                ProxyQueryInterface::class
-            ));
-        }
-
-        if (!$data || !\is_array($data) || !\array_key_exists('value', $data)) {
+        if (!\array_key_exists('value', $data)) {
             return;
         }
 

diff --git a/src/Filter/EmptyFilter.php b/src/Filter/EmptyFilter.php