sonata-project / SonataAdminBundle

src/Twig/Extension/SonataAdminExtension.php

Doc Comments +6 added lines, -5 removed lines

@@ -182,7 +182,7 @@ 
     /**
      * render a view element.
      *
-     * @param object $object
+     * @param \stdClass $object
      *
      * @return string
      */
@@ -221,8 +221,8 @@ 
     /**
      * render a compared view element.
      *
-     * @param mixed $baseObject
-     * @param mixed $compareObject
+     * @param \stdClass $baseObject
+     * @param \stdClass $compareObject
      *
      * @return string
      */
@@ -343,7 +343,8 @@ 
     /**
      * Get the identifiers as a string that is safe to use in a url.
      *
-     * @param object $model
+     * @param \stdClass $model
+     * @param AdminInterface $admin
      *
      * @return string string representation of the id that is safe to use in a url
      */
@@ -365,7 +366,7 @@ 
     }
 
     /**
-     * @return string|bool
+     * @return string|false
      */
     public function getXEditableType($type)
     {

tests/Datagrid/ListMapperTest.php

Doc Comments +4 added lines

@@ -414,6 +414,10 @@
         );
     }
 
+    /**
+     * @param string $name
+     * @param string $label
+     */
     private function getFieldDescriptionMock(?string $name = null, ?string $label = null): BaseFieldDescription
     {
         $fieldDescription = $this->getMockForAbstractClass(BaseFieldDescription::class);

src/Block/AdminListBlockService.php

Doc Comments +1 added lines, -1 removed lines

@@ -44,7 +44,7 @@
      * NEXT_MAJOR: Change signature for (Environment $twig, Pool $pool, ?TemplateRegistryInterface $templateRegistry = null).
      *
      * @param Environment|string                  $twigOrName
-     * @param EngineInterface|Pool|null           $poolOrTemplating
+     * @param Pool|null           $poolOrTemplating
      * @param Pool|TemplateRegistryInterface|null $templateRegistryOrPool
      */
     public function __construct(

src/Block/AdminSearchBlockService.php

Doc Comments +2 added lines, -1 removed lines

@@ -45,8 +45,9 @@
      * NEXT_MAJOR: Change signature for (Environment $twig, Pool $pool, SearchHandler $searchHandler).
      *
      * @param Environment|string        $twigOrName
-     * @param Pool|EngineInterface|null $poolOrTemplating
+     * @param Pool|null $poolOrTemplating
      * @param SearchHandler|Pool        $searchHandlerOrPool
+     * @param SearchHandler $searchHandler
      */
     public function __construct($twigOrName, ?object $poolOrTemplating, object $searchHandlerOrPool, ?SearchHandler $searchHandler = null)
     {

src/Block/AdminStatsBlockService.php

Doc Comments +2 added lines, -1 removed lines

@@ -37,7 +37,8 @@
      * NEXT_MAJOR: Change signature for (Environment $twig, Pool $pool).
      *
      * @param Environment|string        $twigOrName
-     * @param Pool|EngineInterface|null $poolOrTemplating
+     * @param Pool|null $poolOrTemplating
+     * @param Pool $pool
      */
     public function __construct($twigOrName, ?object $poolOrTemplating, ?Pool $pool = null)
     {

src/Admin/BaseFieldDescription.php

Doc Comments +3 added lines

@@ -540,6 +540,9 @@
         return $object->{$fieldName};
     }
 
+    /**
+     * @param string $fieldName
+     */
     private function cacheFieldGetter(object $object, ?string $fieldName, string $method, ?string $getter = null): void
     {
         $getterKey = $this->getFieldGetterKey($object, $fieldName);

src/Model/ModelManagerInterface.php

Doc Comments +11 added lines, -1 removed lines

@@ -36,6 +36,7 @@ 
      * @param object $object
      *
      * @throws ModelManagerException
+     * @return void
      */
     public function create($object);
 
@@ -43,6 +44,7 @@ 
      * @param object $object
      *
      * @throws ModelManagerException
+     * @return void
      */
     public function update($object);
 
@@ -50,6 +52,7 @@ 
      * @param object $object
      *
      * @throws ModelManagerException
+     * @return void
      */
     public function delete($object);
 
@@ -71,7 +74,7 @@ 
      * @param string $class
      * @param mixed  $id
      *
-     * @return object|null the object with id or null if not found
+     * @return \Sonata\AdminBundle\Tests\App\Model\Foo|null the object with id or null if not found
      */
     public function find($class, $id);
 
@@ -79,6 +82,7 @@ 
      * @param string $class
      *
      * @throws ModelManagerException
+     * @return void
      */
     public function batchDelete($class, ProxyQueryInterface $queryProxy);
 
@@ -90,6 +94,7 @@ 
      *
      * @param array  $parentAssociationMapping
      * @param string $class
+     * @return FieldDescriptionInterface
      */
     public function getParentFieldDescription($parentAssociationMapping, $class);
 
@@ -180,6 +185,7 @@ 
      *
      * @param array  $collection
      * @param object $element
+     * @return void
      */
     public function collectionRemoveElement(&$collection, &$element);
 
@@ -188,6 +194,7 @@ 
      *
      * @param array  $collection
      * @param object $element
+     * @return void
      */
     public function collectionAddElement(&$collection, &$element);
 
@@ -205,6 +212,7 @@ 
      * Clear the collection.
      *
      * @param array $collection
+     * @return void
      */
     public function collectionClear(&$collection);
 
@@ -235,6 +243,7 @@ 
 
     /**
      * @param mixed $query
+     * @return void
      */
     public function executeQuery($query);
 
@@ -272,6 +281,7 @@ 
 
     /**
      * @param string $class
+     * @return void
      */
     public function addIdentifiersToQuery($class, ProxyQueryInterface $query, array $idx);
 }

src/Admin/AbstractAdmin.php

Doc Comments +2 added lines, -1 removed lines

@@ -1111,6 +1111,7 @@ 
 
     /**
      * NEXT_MAJOR: remove this method.
+     * @param string $subClass
      */
     public function addSubClass($subClass)
     {
@@ -2677,7 +2678,7 @@ 
      *
      * @param string $context
      *
-     * @return array
+     * @return string[]
      */
     public function getPermissionsShow($context)
     {

src/Admin/AdminInterface.php

Doc Comments +73 added lines, -2 removed lines

@@ -67,6 +67,9 @@ 
  */
 interface AdminInterface extends AccessRegistryInterface, FieldDescriptionRegistryInterface, LifecycleHookProviderInterface, MenuBuilderInterface, ParentAdminInterface, UrlGeneratorInterface
 {
+    /**
+     * @return void
+     */
     public function setMenuFactory(MenuFactoryInterface $menuFactory);
 
     /**
@@ -74,8 +77,14 @@ 
      */
     public function getMenuFactory();
 
+    /**
+     * @return void
+     */
     public function setFormContractor(FormContractorInterface $formContractor);
 
+    /**
+     * @return void
+     */
     public function setListBuilder(ListBuilderInterface $listBuilder);
 
     /**
@@ -83,6 +92,9 @@ 
      */
     public function getListBuilder();
 
+    /**
+     * @return void
+     */
     public function setDatagridBuilder(DatagridBuilderInterface $datagridBuilder);
 
     /**
@@ -90,6 +102,9 @@ 
      */
     public function getDatagridBuilder();
 
+    /**
+     * @return void
+     */
     public function setTranslator(TranslatorInterface $translator);
 
     /**
@@ -97,8 +112,14 @@ 
      */
     public function getTranslator();
 
+    /**
+     * @return void
+     */
     public function setRequest(Request $request);
 
+    /**
+     * @return void
+     */
     public function setConfigurationPool(Pool $pool);
 
     /**
@@ -111,6 +132,9 @@ 
      */
     public function getClass();
 
+    /**
+     * @return void
+     */
     public function attachAdminClass(FieldDescriptionInterface $fieldDescription);
 
     // NEXT_MAJOR: uncomment this method in 4.0
@@ -125,6 +149,7 @@ 
      * Set base controller name.
      *
      * @param string $baseControllerName
+     * @return void
      */
     public function setBaseControllerName($baseControllerName);
 
@@ -199,6 +224,9 @@ 
      */
     public function getSecurityInformation();
 
+    /**
+     * @return void
+     */
     public function setParentFieldDescription(FieldDescriptionInterface $parentFieldDescription);
 
     /**
@@ -276,12 +304,13 @@ 
      *
      * @param object $model
      *
-     * @return mixed
+     * @return string
      */
     public function id($model);
 
     /**
      * @param ValidatorInterface $validator
+     * @return void
      */
     public function setValidator($validator);
 
@@ -298,6 +327,9 @@ 
 //    NEXT_MAJOR: uncomment this method in 4.0
 //    public function getList(): ?FieldDescriptionCollection;
 
+    /**
+     * @return void
+     */
     public function setFormTheme(array $formTheme);
 
     /**
@@ -305,6 +337,9 @@ 
      */
     public function getFormTheme();
 
+    /**
+     * @return void
+     */
     public function setFilterTheme(array $filterTheme);
 
     /**
@@ -312,6 +347,9 @@ 
      */
     public function getFilterTheme();
 
+    /**
+     * @return void
+     */
     public function addExtension(AdminExtensionInterface $extension);
 
     /**
@@ -321,6 +359,9 @@ 
      */
     public function getExtensions();
 
+    /**
+     * @return void
+     */
     public function setRouteBuilder(RouteBuilderInterface $routeBuilder);
 
     /**
@@ -335,6 +376,9 @@ 
      */
     public function toString($object);
 
+    /**
+     * @return void
+     */
     public function setLabelTranslatorStrategy(LabelTranslatorStrategyInterface $labelTranslatorStrategy);
 
     /**
@@ -358,6 +402,7 @@ 
 
     /**
      * @param string $uniqId
+     * @return void
      */
     public function setUniqid($uniqId);
 
@@ -377,6 +422,7 @@ 
 
     /**
      * @param object|null $subject
+     * @return void
      */
     public function setSubject($subject);
 
@@ -414,7 +460,7 @@ 
      *
      * Returns the collection of list FieldDescriptions.
      *
-     * @return array
+     * @return FieldDescriptionInterface[]
      */
     public function getListFieldDescriptions();
 
@@ -432,6 +478,9 @@ 
      */
     public function getDataSourceIterator();
 
+    /**
+     * @return void
+     */
     public function configure();
 
     /**
@@ -439,6 +488,7 @@ 
      *
      * @param string $actionName
      * @param bool   $allElements
+     * @return void
      */
     public function preBatchAction($actionName, ProxyQueryInterface $query, array &$idx, $allElements);
 
@@ -463,6 +513,7 @@ 
      *
      * @deprecated this feature cannot be stable, use a custom validator,
      *             the feature will be removed with Symfony 2.2
+     * @return void
      */
     public function validate(ErrorElement $errorElement, $object);
 
@@ -477,6 +528,7 @@ 
      * Add object security, fe. make the current user owner of the object.
      *
      * @param object $object
+     * @return void
      */
     public function createObjectSecurity($object);
 
@@ -485,6 +537,9 @@ 
      */
     public function getParent();
 
+    /**
+     * @return void
+     */
     public function setParent(self $admin);
 
     /**
@@ -509,6 +564,7 @@ 
      * Set the translation domain.
      *
      * @param string $translationDomain the translation domain
+     * @return void
      */
     public function setTranslationDomain($translationDomain);
 
@@ -530,6 +586,7 @@ 
 
     /**
      * Set the form groups.
+     * @return void
      */
     public function setFormGroups(array $formGroups);
 
@@ -538,6 +595,9 @@ 
      */
     public function getFormTabs();
 
+    /**
+     * @return void
+     */
     public function setFormTabs(array $formTabs);
 
     /**
@@ -545,12 +605,16 @@ 
      */
     public function getShowTabs();
 
+    /**
+     * @return void
+     */
     public function setShowTabs(array $showTabs);
 
     /**
      * Remove a form group field.
      *
      * @param string $key
+     * @return void
      */
     public function removeFieldFromFormGroup($key);
 
@@ -565,6 +629,7 @@ 
 
     /**
      * Set the show groups.
+     * @return void
      */
     public function setShowGroups(array $showGroups);
 
@@ -572,6 +637,7 @@ 
      * Reorder items in showGroup.
      *
      * @param string $group
+     * @return void
      */
     public function reorderShowGroup($group, array $keys);
 
@@ -581,6 +647,7 @@ 
      * add a FieldDescription.
      *
      * @param string $name
+     * @return void
      */
     public function addFormFieldDescription($name, FieldDescriptionInterface $fieldDescription);
 
@@ -590,6 +657,7 @@ 
      * Remove a FieldDescription.
      *
      * @param string $name
+     * @return void
      */
     public function removeFormFieldDescription($name);
 
@@ -602,6 +670,7 @@ 
 
     /**
      * Sets the list of supported sub classes.
+     * @return void
      */
     public function setSubClasses(array $subClasses);
 
@@ -670,6 +739,7 @@ 
      * Set the current child status.
      *
      * @param bool $currentChild
+     * @return void
      */
     public function setCurrentChild($currentChild);
 
@@ -719,6 +789,7 @@ 
 
     /**
      * @param string $mode
+     * @return void
      */
     public function setListMode($mode);