sonata-project / SonataAdminBundle

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);
 

src/Security/Handler/AclSecurityHandler.php

Doc Comments +1 added lines

@@ -191,6 +191,7 @@
      * NEXT_MAJOR: change signature to `addObjectOwner(MutableAclInterface $acl, ?UserSecurityIdentity $securityIdentity = null): void`.
      *
      * @param MutableAclInterface $acl
+     * @param UserSecurityIdentity $securityIdentity
      *
      * @return void
      */

src/Security/Handler/AclSecurityHandlerInterface.php

Doc Comments +4 added lines, -1 removed lines

@@ -25,6 +25,7 @@ 
 {
     /**
      * Set the permissions not related to an object instance and also to be available when objects do not exist.
+     * @return void
      */
     public function setAdminPermissions(array $permissions);
 
@@ -37,6 +38,7 @@ 
 
     /**
      * Set the permissions related to an object instance.
+     * @return void
      */
     public function setObjectPermissions(array $permissions);
 
@@ -110,6 +112,7 @@ 
 
     /**
      * Delete the ACL.
+     * @return void
      */
     public function deleteAcl(ObjectIdentityInterface $objectIdentity);
 
@@ -120,7 +123,7 @@ 
      *
      * @param string $role
      *
-     * @return array-key|false index if found, FALSE if not found
+     * @return integer index if found, FALSE if not found
      */
     public function findClassAceIndexByRole(AclInterface $acl, $role);
 

src/Search/SearchHandler.php

Doc Comments +1 added lines, -1 removed lines

@@ -38,7 +38,7 @@
     /**
      * NEXT_MAJOR: Change signature to __construct(bool $caseSensitive) and remove pool property.
      *
-     * @param Pool|bool $deprecatedPoolOrCaseSensitive
+     * @param boolean $deprecatedPoolOrCaseSensitive
      * @param bool      $caseSensitive
      */
     public function __construct($deprecatedPoolOrCaseSensitive, $caseSensitive = true)