Add more phpdoc

src/Admin/FieldDescription.php

@@ -15,6 +15,9 @@
 
 use Sonata\AdminBundle\Admin\BaseFieldDescription;
 
+/**
+ * @final since sonata-project/doctrine-orm-admin-bundle 3.x
+ */
 class FieldDescription extends BaseFieldDescription
 {
     public function __construct()
@@ -52,9 +55,6 @@ public function getTargetEntity()
         return $this->getTargetModel();
     }
 
-    /**
-     * @final since sonata-project/doctrine-orm-admin-bundle 3.20.
-     */
     public function getTargetModel(): ?string
     {
         if ($this->associationMapping) {

src/Builder/DatagridBuilder.php

@@ -28,6 +28,9 @@
 use Symfony\Component\Form\Extension\Core\Type\FormType;
 use Symfony\Component\Form\FormFactoryInterface;
 
+/**
+ * @final since sonata-project/doctrine-orm-admin-bundle 3.x
+ */
 class DatagridBuilder implements DatagridBuilderInterface
 {
     /**

src/Builder/FormContractor.php

@@ -27,6 +27,9 @@
 use Symfony\Component\Form\Extension\Core\Type\FormType;
 use Symfony\Component\Form\FormFactoryInterface;
 
+/**
+ * @final since sonata-project/doctrine-orm-admin-bundle 3.x
+ */
 class FormContractor implements FormContractorInterface
 {
     /**
@@ -195,6 +198,8 @@ private function hasAssociation(FieldDescriptionInterface $fieldDescription): bo
 
     /**
      * @param string[] $classes
+     *
+     * @phpstan-param class-string[] $classes
      */
     private function isAnyInstanceOf(?string $type, array $classes): bool
     {

src/Builder/ListBuilder.php

@@ -21,6 +21,9 @@
 use Sonata\AdminBundle\Guesser\TypeGuesserInterface;
 use Sonata\DoctrineORMAdminBundle\Guesser\TypeGuesser;
 
+/**
+ * @final since sonata-project/doctrine-orm-admin-bundle 3.x
+ */
 class ListBuilder implements ListBuilderInterface
 {
     /**

src/Builder/ShowBuilder.php

@@ -21,6 +21,9 @@
 use Sonata\AdminBundle\Guesser\TypeGuesserInterface;
 use Sonata\DoctrineORMAdminBundle\Guesser\TypeGuesser;
 
+/**
+ * @final since sonata-project/doctrine-orm-admin-bundle 3.x
+ */
 class ShowBuilder implements ShowBuilderInterface
 {
     /**

src/Datagrid/Pager.php

@@ -21,6 +21,8 @@
  * Doctrine pager class.
  *
  * @author Jonathan H. Wage <[email protected]>
+ *
+ * @final since sonata-project/doctrine-orm-admin-bundle 3.x
  */
 class Pager extends BasePager
 {
@@ -36,6 +38,9 @@ class Pager extends BasePager
      */
     protected $queryBuilder = null;
 
+    /**
+     * @return int
+     */
     public function computeNbResult()
     {
         $countQuery = clone $this->getQuery();

src/Datagrid/ProxyQuery.php

@@ -81,12 +81,12 @@ class ProxyQuery implements ProxyQueryInterface
     protected $queryBuilder;
 
     /**
-     * @var string
+     * @var string|null
      */
     protected $sortBy;
 
     /**
-     * @var mixed
+     * @var string|null
      */
     protected $sortOrder;
 

src/DependencyInjection/Compiler/AddAuditEntityCompilerPass.php

@@ -17,6 +17,8 @@
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 
 /**
+ * @final since sonata-project/doctrine-orm-admin-bundle 3.x
+ *
  * @author Thomas Rabaix <[email protected]>
  */
 class AddAuditEntityCompilerPass implements CompilerPassInterface

src/DependencyInjection/Compiler/AddGuesserCompilerPass.php

@@ -18,6 +18,8 @@
 use Symfony\Component\DependencyInjection\Reference;
 
 /**
+ * @final since sonata-project/doctrine-orm-admin-bundle 3.x
+ *
  * @author Thomas Rabaix <[email protected]>
  */
 class AddGuesserCompilerPass implements CompilerPassInterface

src/DependencyInjection/Compiler/AddTemplatesCompilerPass.php

@@ -18,6 +18,8 @@
 use Symfony\Component\DependencyInjection\Definition;
 
 /**
+ * @final since sonata-project/doctrine-orm-admin-bundle 3.x
+ *
  * @author Thomas Rabaix <[email protected]>
  */
 class AddTemplatesCompilerPass implements CompilerPassInterface
@@ -55,6 +57,8 @@ public function process(ContainerBuilder $container)
     /**
      * @param string $name
      * @param mixed  $value
+     *
+     * @return void
      */
     public function mergeMethodCall(Definition $definition, $name, $value)
     {

src/DependencyInjection/Configuration.php

@@ -17,6 +17,8 @@
 use Symfony\Component\Config\Definition\ConfigurationInterface;
 
 /**
+ * @final since sonata-project/doctrine-orm-admin-bundle 3.x
+ *
  * This class contains the configuration information for the bundle.
  *
  * This information is solely responsible for how the different configuration

src/DependencyInjection/SonataDoctrineORMAdminExtension.php

@@ -20,6 +20,8 @@
 use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
 
 /**
+ * @final since sonata-project/doctrine-orm-admin-bundle 3.x
+ *
  * @author Thomas Rabaix <[email protected]>
  * @author Michael Williams <[email protected]>
  */

src/Filter/BooleanFilter.php

@@ -18,6 +18,9 @@
 use Sonata\Form\Type\BooleanType;
 use Symfony\Component\Form\Extension\Core\Type\HiddenType;
 
+/**
+ * @final since sonata-project/doctrine-orm-admin-bundle 3.x
+ */
 class BooleanFilter extends Filter
 {
     public function filter(ProxyQueryInterface $queryBuilder, $alias, $field, $data)

src/Filter/CallbackFilter.php

@@ -18,6 +18,9 @@
 use Symfony\Component\Form\Extension\Core\Type\HiddenType;
 use Symfony\Component\Form\Extension\Core\Type\TextType;
 
+/**
+ * @final since sonata-project/doctrine-orm-admin-bundle 3.x
+ */
 class CallbackFilter extends Filter
 {
     public function filter(ProxyQueryInterface $queryBuilder, $alias, $field, $data)
@@ -50,7 +53,12 @@ public function getRenderSettings()
         ]];
     }
 
-    protected function association(ProxyQueryInterface $queryBuilder, $data)
+    /**
+     * @param mixed[] $value
+     *
+     * @return array
+     */
+    protected function association(ProxyQueryInterface $queryBuilder, $value)
     {
         $alias = $queryBuilder->entityJoin($this->getParentAssociationMappings());
 

src/Filter/ChoiceFilter.php

@@ -17,6 +17,9 @@
 use Sonata\AdminBundle\Form\Type\Filter\DefaultType;
 use Sonata\AdminBundle\Form\Type\Operator\EqualOperatorType;
 
+/**
+ * @final since sonata-project/doctrine-orm-admin-bundle 3.x
+ */
 class ChoiceFilter extends Filter
 {
     public function filter(ProxyQueryInterface $queryBuilder, $alias, $field, $data)

src/Filter/ClassFilter.php

@@ -18,6 +18,9 @@
 use Sonata\AdminBundle\Form\Type\Operator\EqualOperatorType;
 use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
 
+/**
+ * @final since sonata-project/doctrine-orm-admin-bundle 3.x
+ */
 class ClassFilter extends Filter
 {
     public const CHOICES = [

src/Filter/DateFilter.php

@@ -15,6 +15,9 @@
 
 use Symfony\Component\Form\Extension\Core\Type\DateType;
 
+/**
+ * @final since sonata-project/doctrine-orm-admin-bundle 3.x
+ */
 class DateFilter extends AbstractDateFilter
 {
     /**

src/Filter/DateRangeFilter.php

@@ -15,6 +15,9 @@
 
 use Sonata\Form\Type\DateRangeType;
 
+/**
+ * @final since sonata-project/doctrine-orm-admin-bundle 3.x
+ */
 class DateRangeFilter extends AbstractDateFilter
 {
     /**

src/Filter/DateTimeFilter.php

@@ -15,6 +15,9 @@
 
 use Symfony\Component\Form\Extension\Core\Type\DateTimeType;
 
+/**
+ * @final since sonata-project/doctrine-orm-admin-bundle 3.x
+ */
 class DateTimeFilter extends AbstractDateFilter
 {
     /**

src/Filter/DateTimeRangeFilter.php

@@ -15,6 +15,9 @@
 
 use Sonata\Form\Type\DateTimeRangeType;
 
+/**
+ * @final since sonata-project/doctrine-orm-admin-bundle 3.x
+ */
 class DateTimeRangeFilter extends AbstractDateFilter
 {
     /**

src/Filter/Filter.php

@@ -39,6 +39,11 @@ public function isActive()
         return $this->active;
     }
 
+    /**
+     * @param mixed[] $value
+     *
+     * @return string[]
+     */
     protected function association(ProxyQueryInterface $queryBuilder, $value)
     {
         $alias = $queryBuilder->entityJoin($this->getParentAssociationMappings());

src/Filter/ModelAutocompleteFilter.php

@@ -20,22 +20,25 @@
 use Sonata\AdminBundle\Form\Type\ModelAutocompleteType;
 use Sonata\AdminBundle\Form\Type\Operator\EqualOperatorType;
 
+/**
+ * @final since sonata-project/doctrine-orm-admin-bundle 3.x
+ */
 class ModelAutocompleteFilter extends Filter
 {
-    public function filter(ProxyQueryInterface $queryBuilder, $alias, $field, $data)
+    public function filter(ProxyQueryInterface $queryBuilder, $alias, $field, $value)
     {
-        if (!$data || !\is_array($data) || !\array_key_exists('value', $data)) {
+        if (!$value || !\is_array($value) || !\array_key_exists('value', $value)) {
             return;
         }
 
-        if ($data['value'] instanceof Collection) {
-            $data['value'] = $data['value']->toArray();
+        if ($value['value'] instanceof Collection) {
+            $value['value'] = $value['value']->toArray();
         }
 
-        if (\is_array($data['value'])) {
-            $this->handleMultiple($queryBuilder, $alias, $data);
+        if (\is_array($value['value'])) {
+            $this->handleMultiple($queryBuilder, $alias, $value);
         } else {
-            $this->handleModel($queryBuilder, $alias, $data);
+            $this->handleModel($queryBuilder, $alias, $value);
         }
     }
 
@@ -67,52 +70,59 @@ public function getRenderSettings()
      *
      * @param ProxyQueryInterface|QueryBuilder $queryBuilder
      * @param string                           $alias
-     * @param mixed                            $data
+     * @param mixed[]                          $value
      *
-     * @return mixed
+     * @return void
      */
-    protected function handleMultiple(ProxyQueryInterface $queryBuilder, $alias, $data)
+    protected function handleMultiple(ProxyQueryInterface $queryBuilder, $alias, $value)
     {
-        if (0 === \count($data['value'])) {
+        if (0 === \count($value['value'])) {
             return;
         }
 
         $parameterName = $this->getNewParameterName($queryBuilder);
 
-        if (isset($data['type']) && EqualOperatorType::TYPE_NOT_EQUAL === $data['type']) {
+        if (isset($value['type']) && EqualOperatorType::TYPE_NOT_EQUAL === $value['type']) {
             $this->applyWhere($queryBuilder, $queryBuilder->expr()->notIn($alias, ':'.$parameterName));
         } else {
             $this->applyWhere($queryBuilder, $queryBuilder->expr()->in($alias, ':'.$parameterName));
         }
 
-        $queryBuilder->setParameter($parameterName, $data['value']);
+        $queryBuilder->setParameter($parameterName, $value['value']);
     }
 
     /**
      * @param ProxyQueryInterface|QueryBuilder $queryBuilder
      * @param string                           $alias
-     * @param mixed                            $data
+     * @param mixed[]                          $value
      *
-     * @return mixed
+     * @return void
      */
-    protected function handleModel(ProxyQueryInterface $queryBuilder, $alias, $data)
+    protected function handleModel(ProxyQueryInterface $queryBuilder, $alias, $value)
     {
-        if (empty($data['value'])) {
+        if (empty($value['value'])) {
             return;
         }
 
         $parameterName = $this->getNewParameterName($queryBuilder);
 
-        if (isset($data['type']) && EqualOperatorType::TYPE_NOT_EQUAL === $data['type']) {
+        if (isset($value['type']) && EqualOperatorType::TYPE_NOT_EQUAL === $value['type']) {
             $this->applyWhere($queryBuilder, sprintf('%s != :%s', $alias, $parameterName));
         } else {
             $this->applyWhere($queryBuilder, sprintf('%s = :%s', $alias, $parameterName));
         }
 
-        $queryBuilder->setParameter($parameterName, $data['value']);
+        $queryBuilder->setParameter($parameterName, $value['value']);
     }
 
-    protected function association(ProxyQueryInterface $queryBuilder, $data)
+    /**
+     * @param mixed[] $value
+     *
+     * @return array
+     *
+     * @phpstan-return array{string, bool}
+     */
+    protected function association(ProxyQueryInterface $queryBuilder, $value)
     {
         $associationMappings = $this->getParentAssociationMappings();
         $associationMappings[] = $this->getAssociationMapping();