sonata-project / SonataAdminBundle

tests/Datagrid/DatagridMapperTest.php

Doc Comments +4 added lines

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

tests/Datagrid/ListMapperTest.php

Doc Comments +4 added lines

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

tests/Show/ShowMapperTest.php

Doc Comments +4 added lines

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

src/Security/Handler/SecurityHandlerInterface.php

Doc Comments +3 added lines, -1 removed lines

@@ -21,7 +21,7 @@ 
 interface SecurityHandlerInterface
 {
     /**
-     * @param string|array $attributes
+     * @param string $attributes
      * @param mixed|null   $object
      *
      * @return bool
@@ -44,6 +44,7 @@ 
      * Create object security, fe. make the current user owner of the object.
      *
      * @param object $object
+     * @return void
      */
     public function createObjectSecurity(AdminInterface $admin, $object);
 
@@ -51,6 +52,7 @@ 
      * Remove object security.
      *
      * @param object $object
+     * @return void
      */
     public function deleteObjectSecurity(AdminInterface $admin, $object);
 }

tests/Datagrid/PagerTest.php

Doc Comments +3 added lines

@@ -647,6 +647,9 @@
         $this->assertNull($this->pager->getQuery());
     }
 
+    /**
+     * @param Pager $obj
+     */
     protected function callMethod($obj, string $name, array $args = [])
     {
         $class = new \ReflectionClass($obj);

src/Command/QuestionableCommand.php

Doc Comments +1 added lines, -1 removed lines

@@ -24,7 +24,7 @@
 {
     /**
      * @param string   $questionText
-     * @param mixed    $default
+     * @param string    $default
      * @param callable $validator
      *
      * @return mixed

src/Model/ModelManagerInterface.php

Doc Comments +11 added lines, -2 removed lines

@@ -37,6 +37,7 @@ 
      * @param object $object
      *
      * @throws ModelManagerException
+     * @return void
      */
     public function create($object);
 
@@ -44,6 +45,7 @@ 
      * @param object $object
      *
      * @throws ModelManagerException
+     * @return void
      */
     public function update($object);
 
@@ -51,6 +53,7 @@ 
      * @param object $object
      *
      * @throws ModelManagerException
+     * @return void
      */
     public function delete($object);
 
@@ -72,7 +75,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);
 
@@ -80,6 +83,7 @@ 
      * @param string $class
      *
      * @throws ModelManagerException
+     * @return void
      */
     public function batchDelete($class, ProxyQueryInterface $queryProxy);
 
@@ -156,7 +160,7 @@ 
      *
      * @param string $class
      *
-     * @return object
+     * @return \Sonata\AdminBundle\Tests\App\Model\Foo
      */
     public function getModelInstance($class);
 
@@ -172,6 +176,7 @@ 
      *
      * @param array  $collection
      * @param object $element
+     * @return void
      */
     public function collectionRemoveElement(&$collection, &$element);
 
@@ -180,6 +185,7 @@ 
      *
      * @param array  $collection
      * @param object $element
+     * @return void
      */
     public function collectionAddElement(&$collection, &$element);
 
@@ -197,6 +203,7 @@ 
      * Clear the collection.
      *
      * @param array $collection
+     * @return void
      */
     public function collectionClear(&$collection);
 
@@ -229,6 +236,7 @@ 
 
     /**
      * @param mixed $query
+     * @return void
      */
     public function executeQuery($query);
 
@@ -261,6 +269,7 @@ 
 
     /**
      * @param string $class
+     * @return void
      */
     public function addIdentifiersToQuery($class, ProxyQueryInterface $query, array $idx);
 }

src/Filter/FilterInterface.php

Doc Comments +7 added lines, -2 removed lines

@@ -62,6 +62,7 @@ 
 
     /**
      * @param string $label
+     * @return void
      */
     public function setLabel($label);
 
@@ -72,7 +73,7 @@ 
 
     /**
      * @param string     $name
-     * @param mixed|null $default
+     * @param boolean $default
      *
      * @return mixed
      */
@@ -80,12 +81,14 @@ 
 
     /**
      * @param string $name
-     * @param mixed  $value
+     * @param boolean  $value
+     * @return void
      */
     public function setOption($name, $value);
 
     /**
      * @param string $name
+     * @return void
      */
     public function initialize($name, array $options = []);
 
@@ -129,6 +132,7 @@ 
      *
      * @param string $name
      * @param mixed  $value
+     * @return void
      */
     public function setFieldOption($name, $value);
 
@@ -155,6 +159,7 @@ 
      * Set the condition to use with the left side of the query : OR or AND.
      *
      * @param string $condition
+     * @return void
      */
     public function setCondition($condition);
 

src/Admin/AdminInterface.php

Doc Comments +75 added lines, -1 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);
 
@@ -175,6 +200,9 @@ 
      */
     public function getSecurityInformation();
 
+    /**
+     * @return void
+     */
     public function setParentFieldDescription(FieldDescriptionInterface $parentFieldDescription);
 
     /**
@@ -222,6 +250,9 @@ 
      */
     public function hasRoute($name);
 
+    /**
+     * @return void
+     */
     public function setSecurityHandler(SecurityHandlerInterface $securityHandler);
 
     /**
@@ -249,12 +280,13 @@ 
      *
      * @param object $entity
      *
-     * @return mixed
+     * @return string
      */
     public function id($entity);
 
     /**
      * @param ValidatorInterface $validator
+     * @return void
      */
     public function setValidator($validator);
 
@@ -268,6 +300,9 @@ 
      */
     public function getShow();
 
+    /**
+     * @return void
+     */
     public function setFormTheme(array $formTheme);
 
     /**
@@ -275,6 +310,9 @@ 
      */
     public function getFormTheme();
 
+    /**
+     * @return void
+     */
     public function setFilterTheme(array $filterTheme);
 
     /**
@@ -282,6 +320,9 @@ 
      */
     public function getFilterTheme();
 
+    /**
+     * @return void
+     */
     public function addExtension(AdminExtensionInterface $extension);
 
     /**
@@ -291,6 +332,9 @@ 
      */
     public function getExtensions();
 
+    /**
+     * @return void
+     */
     public function setRouteBuilder(RouteBuilderInterface $routeBuilder);
 
     /**
@@ -305,6 +349,9 @@ 
      */
     public function toString($object);
 
+    /**
+     * @return void
+     */
     public function setLabelTranslatorStrategy(LabelTranslatorStrategyInterface $labelTranslatorStrategy);
 
     /**
@@ -328,6 +375,7 @@ 
 
     /**
      * @param string $uniqId
+     * @return void
      */
     public function setUniqid($uniqId);
 
@@ -347,6 +395,7 @@ 
 
     /**
      * @param object|null $subject
+     * @return void
      */
     public function setSubject($subject);
 
@@ -394,6 +443,9 @@ 
      */
     public function getDataSourceIterator();
 
+    /**
+     * @return void
+     */
     public function configure();
 
     /**
@@ -401,6 +453,7 @@ 
      *
      * @param string $actionName
      * @param bool   $allElements
+     * @return void
      */
     public function preBatchAction($actionName, ProxyQueryInterface $query, array &$idx, $allElements);
 
@@ -425,6 +478,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);
 
@@ -439,6 +493,7 @@ 
      * Add object security, fe. make the current user owner of the object.
      *
      * @param object $object
+     * @return void
      */
     public function createObjectSecurity($object);
 
@@ -447,6 +502,9 @@ 
      */
     public function getParent();
 
+    /**
+     * @return void
+     */
     public function setParent(self $admin);
 
     /**
@@ -471,6 +529,7 @@ 
      * Set the translation domain.
      *
      * @param string $translationDomain the translation domain
+     * @return void
      */
     public function setTranslationDomain($translationDomain);
 
@@ -492,6 +551,7 @@ 
 
     /**
      * Set the form groups.
+     * @return void
      */
     public function setFormGroups(array $formGroups);
 
@@ -500,6 +560,9 @@ 
      */
     public function getFormTabs();
 
+    /**
+     * @return void
+     */
     public function setFormTabs(array $formTabs);
 
     /**
@@ -507,12 +570,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);
 
@@ -527,6 +594,7 @@ 
 
     /**
      * Set the show groups.
+     * @return void
      */
     public function setShowGroups(array $showGroups);
 
@@ -534,6 +602,7 @@ 
      * Reorder items in showGroup.
      *
      * @param string $group
+     * @return void
      */
     public function reorderShowGroup($group, array $keys);
 
@@ -541,6 +610,7 @@ 
      * add a FieldDescription.
      *
      * @param string $name
+     * @return void
      */
     public function addFormFieldDescription($name, FieldDescriptionInterface $fieldDescription);
 
@@ -548,6 +618,7 @@ 
      * Remove a FieldDescription.
      *
      * @param string $name
+     * @return void
      */
     public function removeFormFieldDescription($name);
 
@@ -560,6 +631,7 @@ 
 
     /**
      * Sets the list of supported sub classes.
+     * @return void
      */
     public function setSubClasses(array $subClasses);
 
@@ -628,6 +700,7 @@ 
      * Set the current child status.
      *
      * @param bool $currentChild
+     * @return void
      */
     public function setCurrentChild($currentChild);
 
@@ -675,6 +748,7 @@ 
 
     /**
      * @param string $mode
+     * @return void
      */
     public function setListMode($mode);