sonata-project / SonataAdminBundle

src/Admin/Pool.php

Doc Comments +2 added lines, -1 removed lines

@@ -87,6 +87,7 @@ 
      * @param string $title
      * @param string $logoTitle
      * @param array  $options
+     * @param PropertyAccessorInterface $propertyAccessor
      */
     public function __construct(
         ContainerInterface $container,
@@ -386,7 +387,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public function getAdminServiceIds()
     {

src/Controller/CRUDController.php

Doc Comments +9 added lines, -5 removed lines

@@ -66,6 +66,9 @@ 
      */
     private $templateRegistry;
 
+    /**
+     * @param ContainerInterface $container
+     */
     public function setContainer(?ContainerInterface $container = null)
     {
         $this->container = $container;
@@ -195,7 +198,7 @@ 
     /**
      * Delete action.
      *
-     * @param int|string|null $id
+     * @param integer|null $id
      *
      * @throws NotFoundHttpException If the object does not exist
      * @throws AccessDeniedException If access is not granted
@@ -791,7 +794,7 @@ 
     /**
      * View history revision of object.
      *
-     * @param int|string|null $id
+     * @param null|integer $id
      * @param string|null     $revision
      *
      * @throws AccessDeniedException If access is not granted
@@ -854,9 +857,9 @@ 
     /**
      * Compare history revisions of object.
      *
-     * @param int|string|null $id
-     * @param int|string|null $base_revision
-     * @param int|string|null $compare_revision
+     * @param null|integer $id
+     * @param null|integer $base_revision
+     * @param null|integer $compare_revision
      *
      * @throws AccessDeniedException If access is not granted
      * @throws NotFoundHttpException If the object or revision does not exist or the audit reader is not available
@@ -1580,6 +1583,7 @@ 
 
     /**
      * Sets the admin form theme to form view. Used for compatibility between Symfony versions.
+     * @param string[] $theme
      */
     private function setFormTheme(FormView $formView, ?array $theme = null): void
     {

src/Form/ChoiceList/ModelChoiceLoader.php

Doc Comments +1 added lines

@@ -65,6 +65,7 @@
      * @param string|null $property
      * @param mixed|null  $query
      * @param array       $choices
+     * @param PropertyAccessorInterface $propertyAccessor
      */
     public function __construct(
         ModelManagerInterface $modelManager,

src/Security/Handler/AclSecurityHandler.php

Doc Comments +3 added lines

@@ -184,6 +184,9 @@
         return $acls;
     }
 
+    /**
+     * @param UserSecurityIdentity $securityIdentity
+     */
     public function addObjectOwner(AclInterface $acl, ?UserSecurityIdentity $securityIdentity = null)
     {
         if (false === $this->findClassAceIndexByUsername($acl, $securityIdentity->getUsername())) {

src/Util/AdminObjectAclData.php

Doc Comments +1 added lines

@@ -80,6 +80,7 @@
     /**
      * @param object $object
      * @param string $maskBuilderClass
+     * @param \Traversable $aclRoles
      */
     public function __construct(
         AdminInterface $admin,

src/Menu/Matcher/Voter/AdminVoter.php

Doc Comments +4 added lines

@@ -38,6 +38,9 @@ 
      */
     private $request;
 
+    /**
+     * @param RequestStack $requestStack
+     */
     public function __construct(?RequestStack $requestStack = null)
     {
         $this->requestStack = $requestStack;
@@ -46,6 +49,7 @@ 
     /**
      * @deprecated since sonata-project/admin-bundle 3.31. Pass a RequestStack to the constructor instead.
      *
+     * @param Request $request
      * @return $this
      */
     public function setRequest($request)

tests/Show/ShowMapperTest.php

Doc Comments +4 added lines

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

src/Twig/Extension/SonataAdminExtension.php

Doc Comments +7 added lines, -6 removed lines

@@ -184,7 +184,7 @@ 
     /**
      * render a list element from the FieldDescription.
      *
-     * @param object $object
+     * @param \stdClass $object
      * @param array  $params
      *
      * @return string
@@ -272,7 +272,7 @@ 
     /**
      * render a view element.
      *
-     * @param object $object
+     * @param \stdClass $object
      *
      * @return string
      */
@@ -311,8 +311,8 @@ 
     /**
      * render a compared view element.
      *
-     * @param mixed $baseObject
-     * @param mixed $compareObject
+     * @param \stdClass $baseObject
+     * @param \stdClass $compareObject
      *
      * @return string
      */
@@ -433,7 +433,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
      */
@@ -455,7 +456,7 @@ 
     }
 
     /**
-     * @return string|bool
+     * @return string|false
      */
     public function getXEditableType($type)
     {

src/Admin/AdminInterface.php

Doc Comments +76 added lines, -2 removed lines

@@ -48,6 +48,9 @@ 
  */
 interface AdminInterface extends AccessRegistryInterface, FieldDescriptionRegistryInterface, LifecycleHookProviderInterface, MenuBuilderInterface, ParentAdminInterface, UrlGeneratorInterface
 {
+    /**
+     * @return void
+     */
     public function setMenuFactory(MenuFactoryInterface $menuFactory);
 
     /**
@@ -55,8 +58,14 @@ 
      */
     public function getMenuFactory();
 
+    /**
+     * @return void
+     */
     public function setFormContractor(FormContractorInterface $formContractor);
 
+    /**
+     * @return void
+     */
     public function setListBuilder(ListBuilderInterface $listBuilder);
 
     /**
@@ -64,6 +73,9 @@ 
      */
     public function getListBuilder();
 
+    /**
+     * @return void
+     */
     public function setDatagridBuilder(DatagridBuilderInterface $datagridBuilder);
 
     /**
@@ -71,6 +83,9 @@ 
      */
     public function getDatagridBuilder();
 
+    /**
+     * @return void
+     */
     public function setTranslator(TranslatorInterface $translator);
 
     /**
@@ -78,8 +93,14 @@ 
      */
     public function getTranslator();
 
+    /**
+     * @return void
+     */
     public function setRequest(Request $request);
 
+    /**
+     * @return void
+     */
     public function setConfigurationPool(Pool $pool);
 
     /**
@@ -92,6 +113,9 @@ 
      */
     public function getClass();
 
+    /**
+     * @return void
+     */
     public function attachAdminClass(FieldDescriptionInterface $fieldDescription);
 
     /**
@@ -103,6 +127,7 @@ 
      * Set base controller name.
      *
      * @param string $baseControllerName
+     * @return void
      */
     public function setBaseControllerName($baseControllerName);
 
@@ -177,6 +202,9 @@ 
      */
     public function getSecurityInformation();
 
+    /**
+     * @return void
+     */
     public function setParentFieldDescription(FieldDescriptionInterface $parentFieldDescription);
 
     /**
@@ -224,6 +252,9 @@ 
      */
     public function hasRoute($name);
 
+    /**
+     * @return void
+     */
     public function setSecurityHandler(SecurityHandlerInterface $securityHandler);
 
     /**
@@ -251,12 +282,13 @@ 
      *
      * @param object $model
      *
-     * @return mixed
+     * @return string
      */
     public function id($model);
 
     /**
      * @param ValidatorInterface $validator
+     * @return void
      */
     public function setValidator($validator);
 
@@ -270,6 +302,9 @@ 
      */
     public function getShow();
 
+    /**
+     * @return void
+     */
     public function setFormTheme(array $formTheme);
 
     /**
@@ -277,6 +312,9 @@ 
      */
     public function getFormTheme();
 
+    /**
+     * @return void
+     */
     public function setFilterTheme(array $filterTheme);
 
     /**
@@ -284,6 +322,9 @@ 
      */
     public function getFilterTheme();
 
+    /**
+     * @return void
+     */
     public function addExtension(AdminExtensionInterface $extension);
 
     /**
@@ -293,6 +334,9 @@ 
      */
     public function getExtensions();
 
+    /**
+     * @return void
+     */
     public function setRouteBuilder(RouteBuilderInterface $routeBuilder);
 
     /**
@@ -307,6 +351,9 @@ 
      */
     public function toString($object);
 
+    /**
+     * @return void
+     */
     public function setLabelTranslatorStrategy(LabelTranslatorStrategyInterface $labelTranslatorStrategy);
 
     /**
@@ -330,6 +377,7 @@ 
 
     /**
      * @param string $uniqId
+     * @return void
      */
     public function setUniqid($uniqId);
 
@@ -349,6 +397,7 @@ 
 
     /**
      * @param object|null $subject
+     * @return void
      */
     public function setSubject($subject);
 
@@ -380,7 +429,7 @@ 
     /**
      * Returns the collection of list FieldDescriptions.
      *
-     * @return array
+     * @return FieldDescriptionInterface[]
      */
     public function getListFieldDescriptions();
 
@@ -398,6 +447,9 @@ 
      */
     public function getDataSourceIterator();
 
+    /**
+     * @return void
+     */
     public function configure();
 
     /**
@@ -405,6 +457,7 @@ 
      *
      * @param string $actionName
      * @param bool   $allElements
+     * @return void
      */
     public function preBatchAction($actionName, ProxyQueryInterface $query, array &$idx, $allElements);
 
@@ -429,6 +482,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);
 
@@ -443,6 +497,7 @@ 
      * Add object security, fe. make the current user owner of the object.
      *
      * @param object $object
+     * @return void
      */
     public function createObjectSecurity($object);
 
@@ -451,6 +506,9 @@ 
      */
     public function getParent();
 
+    /**
+     * @return void
+     */
     public function setParent(self $admin);
 
     /**
@@ -475,6 +533,7 @@ 
      * Set the translation domain.
      *
      * @param string $translationDomain the translation domain
+     * @return void
      */
     public function setTranslationDomain($translationDomain);
 
@@ -496,6 +555,7 @@ 
 
     /**
      * Set the form groups.
+     * @return void
      */
     public function setFormGroups(array $formGroups);
 
@@ -504,6 +564,9 @@ 
      */
     public function getFormTabs();
 
+    /**
+     * @return void
+     */
     public function setFormTabs(array $formTabs);
 
     /**
@@ -511,12 +574,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);
 
@@ -531,6 +598,7 @@ 
 
     /**
      * Set the show groups.
+     * @return void
      */
     public function setShowGroups(array $showGroups);
 
@@ -538,6 +606,7 @@ 
      * Reorder items in showGroup.
      *
      * @param string $group
+     * @return void
      */
     public function reorderShowGroup($group, array $keys);
 
@@ -545,6 +614,7 @@ 
      * add a FieldDescription.
      *
      * @param string $name
+     * @return void
      */
     public function addFormFieldDescription($name, FieldDescriptionInterface $fieldDescription);
 
@@ -552,6 +622,7 @@ 
      * Remove a FieldDescription.
      *
      * @param string $name
+     * @return void
      */
     public function removeFormFieldDescription($name);
 
@@ -564,6 +635,7 @@ 
 
     /**
      * Sets the list of supported sub classes.
+     * @return void
      */
     public function setSubClasses(array $subClasses);
 
@@ -632,6 +704,7 @@ 
      * Set the current child status.
      *
      * @param bool $currentChild
+     * @return void
      */
     public function setCurrentChild($currentChild);
 
@@ -681,6 +754,7 @@ 
 
     /**
      * @param string $mode
+     * @return void
      */
     public function setListMode($mode);