Merge pull request #4265 from greg0ire/improve_phpdoc

Apply phpstan fixes

Admin/AbstractAdmin.php

@@ -1433,7 +1433,7 @@ abstract class AbstractAdmin implements AdminInterface, DomainObjectInterface
     /**
      * Returns the master admin.
      *
-     * @return Admin the root admin class
+     * @return AbstractAdmin the root admin class
      */
     public function getRoot()
     {

Admin/AdminHelper.php

@@ -46,7 +46,7 @@ class AdminHelper
      * @param FormBuilderInterface $formBuilder
      * @param string               $elementId
      *
-     * @return FormBuilderInterface
+     * @return FormBuilderInterface|null
      */
     public function getChildFormBuilder(FormBuilderInterface $formBuilder, $elementId)
     {

Admin/AdminInterface.php

@@ -403,7 +403,7 @@ interface AdminInterface
      *
      * @param string $name
      *
-     * @return array|null
+     * @return FieldDescriptionInterface|null
      */
     public function getFilterFieldDescription($name);
 

Admin/Pool.php

@@ -214,7 +214,7 @@ class Pool
      *
      * @param string $adminCode
      *
-     * @return \Sonata\AdminBundle\Admin\AdminInterface|null
+     * @return \Sonata\AdminBundle\Admin\AdminInterface|false|null
      */
     public function getAdminByAdminCode($adminCode)
     {

Controller/CRUDController.php

@@ -111,7 +111,7 @@ class CRUDController extends Controller
             'form' => $formView,
             'datagrid' => $datagrid,
             'csrf_token' => $this->getCsrfToken('sonata.batch'),
-        ), null, $request);
+        ), null);
     }
 
     /**
@@ -505,7 +505,7 @@ class CRUDController extends Controller
             $isFormValid = $form->isValid();
 
             // persist if the form was valid and if in preview mode the preview was approved
-            if ($isFormValid && (!$this->isInPreviewMode($request) || $this->isPreviewApproved($request))) {
+            if ($isFormValid && (!$this->isInPreviewMode() || $this->isPreviewApproved())) {
                 $this->admin->checkAccess('create', $object);
 
                 try {
@@ -646,7 +646,7 @@ class CRUDController extends Controller
             'object' => $object,
             'revisions' => $revisions,
             'currentRevision' => $revisions ? current($revisions) : false,
-        ), null, $request);
+        ), null);
     }
 
     /**
@@ -900,7 +900,7 @@ class CRUDController extends Controller
             'roles' => $aclRoles,
             'aclUsersForm' => $aclUsersForm->createView(),
             'aclRolesForm' => $aclRolesForm->createView(),
-        ), null, $request);
+        ), null);
     }
 
     /**

Controller/HelperController.php

@@ -16,7 +16,6 @@ use Sonata\AdminBundle\Admin\AdminInterface;
 use Sonata\AdminBundle\Admin\Pool;
 use Sonata\AdminBundle\Filter\FilterInterface;
 use Symfony\Bridge\Twig\Form\TwigRenderer;
-use Symfony\Component\Form\FormInterface;
 use Symfony\Component\HttpFoundation\JsonResponse;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
@@ -145,7 +144,7 @@ class HelperController
 
         $admin->setSubject($subject);
 
-        $formBuilder = $admin->getFormBuilder($subject);
+        $formBuilder = $admin->getFormBuilder();
 
         $form = $formBuilder->getForm();
         $form->handleRequest($request);
@@ -444,7 +443,7 @@ class HelperController
      * @param AdminInterface $admin
      * @param string         $field
      *
-     * @return FormInterface
+     * @return \Sonata\AdminBundle\Admin\FieldDescriptionInterface
      *
      * @throws \RuntimeException
      */
@@ -471,7 +470,7 @@ class HelperController
      * @param AdminInterface $admin
      * @param string         $field
      *
-     * @return FormInterface
+     * @return \Sonata\AdminBundle\Admin\FieldDescriptionInterface
      *
      * @throws \RuntimeException
      */

Datagrid/Pager.php

@@ -56,7 +56,7 @@ abstract class Pager implements \Iterator, \Countable, \Serializable, PagerInter
     protected $currentMaxLink = 1;
 
     /**
-     * @var bool
+     * @var mixed bool|int
      */
     protected $maxRecordLimit = false;
 
@@ -67,7 +67,7 @@ abstract class Pager implements \Iterator, \Countable, \Serializable, PagerInter
 
     // used by iterator interface
     /**
-     * @var array|null
+     * @var \Traversable|array|null
      */
     protected $results = null;
 

Form/ChoiceList/ModelChoiceLoader.php

@@ -26,6 +26,8 @@ use Symfony\Component\PropertyAccess\PropertyPath;
  */
 class ModelChoiceLoader implements ChoiceLoaderInterface
 {
+    public $identifier;
+
     /**
      * @var \Sonata\AdminBundle\Model\ModelManagerInterface
      */

Form/DataTransformer/ModelToIdPropertyTransformer.php

@@ -43,7 +43,7 @@ class ModelToIdPropertyTransformer implements DataTransformerInterface
     protected $multiple;
 
     /**
-     * @var callback
+     * @var callable|null
      */
     protected $toStringCallback;
 

Form/DataTransformer/ModelsToArrayTransformer.php

@@ -11,6 +11,7 @@
 
 namespace Sonata\AdminBundle\Form\DataTransformer;
 
+use Doctrine\Common\Util\ClassUtils;
 use Sonata\AdminBundle\Form\ChoiceList\ModelChoiceList;
 use Sonata\AdminBundle\Form\ChoiceList\ModelChoiceLoader;
 use Sonata\AdminBundle\Model\ModelManagerInterface;

Mapper/BaseGroupedMapper.php

@@ -19,17 +19,17 @@ namespace Sonata\AdminBundle\Mapper;
 abstract class BaseGroupedMapper extends BaseMapper
 {
     /**
-     * @var string
+     * @var string|null
      */
     protected $currentGroup;
 
     /**
-     * @var string
+     * @var string|null
      */
     protected $currentTab;
 
     /**
-     * @var bool
+     * @var bool|null
      */
     protected $apply;
 

Search/SearchHandler.php

@@ -40,7 +40,7 @@ class SearchHandler
      * @param int            $page
      * @param int            $offset
      *
-     * @return PagerInterface
+     * @return PagerInterface|false
      *
      * @throws \RuntimeException
      */

Twig/Extension/SonataAdminExtension.php

@@ -447,7 +447,7 @@ EOT;
      * @param FieldDescriptionInterface $fieldDescription
      * @param string                    $defaultTemplate
      *
-     * @return \Twig_Template
+     * @return \Twig_TemplateInterface
      */
     protected function getTemplate(
         FieldDescriptionInterface $fieldDescription,