sonata-project / SonataAdminBundle

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

tests/Form/Widget/FormSonataFilterChoiceWidgetTest.php

Doc Comments +3 added lines

@@ -56,6 +56,9 @@
         );
     }
 
+    /**
+     * @return string
+     */
     protected function getChoiceClass()
     {
         return ChoiceType::class;

src/Twig/Extension/SonataAdminExtension.php

Doc Comments +3 added lines, -3 removed lines

@@ -182,7 +182,7 @@ 
     /**
      * render a view element.
      *
-     * @param object $object
+     * @param \stdClass $object
      *
      * @return string
      */
@@ -319,7 +319,7 @@ 
     /**
      * Get the identifiers as a string that is safe to use in a url.
      *
-     * @param object $model
+     * @param \stdClass $model
      *
      * @return string string representation of the id that is safe to use in a url
      */
@@ -341,7 +341,7 @@ 
     }
 
     /**
-     * @return string|bool
+     * @return string|false
      */
     public function getXEditableType($type)
     {

src/Controller/CRUDController.php

Doc Comments +2 added lines, -2 removed lines

@@ -743,8 +743,8 @@
     /**
      * Compare history revisions of object.
      *
-     * @param int|string|null $baseRevision
-     * @param int|string|null $compareRevision
+     * @param null|integer $baseRevision
+     * @param null|integer $compareRevision
      *
      * @throws AccessDeniedException If access is not granted
      * @throws NotFoundHttpException If the object or revision does not exist or the audit reader is not available

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 +117 added lines

@@ -37,26 +37,59 @@ 
  */
 interface AdminInterface extends AccessRegistryInterface, FieldDescriptionRegistryInterface, LifecycleHookProviderInterface, MenuBuilderInterface, ParentAdminInterface, UrlGeneratorInterface
 {
+    /**
+     * @return void
+     */
     public function setMenuFactory(MenuFactoryInterface $menuFactory): void;
 
+    /**
+     * @return MenuFactoryInterface
+     */
     public function getMenuFactory(): ?MenuFactoryInterface;
 
+    /**
+     * @return void
+     */
     public function setFormContractor(FormContractorInterface $formContractor): void;
 
+    /**
+     * @return void
+     */
     public function setListBuilder(ListBuilderInterface $listBuilder): void;
 
+    /**
+     * @return ListBuilderInterface
+     */
     public function getListBuilder(): ?ListBuilderInterface;
 
+    /**
+     * @return void
+     */
     public function setDatagridBuilder(DatagridBuilderInterface $datagridBuilder): void;
 
+    /**
+     * @return DatagridBuilderInterface
+     */
     public function getDatagridBuilder(): ?DatagridBuilderInterface;
 
+    /**
+     * @return void
+     */
     public function setTranslator(TranslatorInterface $translator): void;
 
+    /**
+     * @return TranslatorInterface
+     */
     public function getTranslator(): ?TranslatorInterface;
 
+    /**
+     * @return void
+     */
     public function setRequest(Request $request): void;
 
+    /**
+     * @return void
+     */
     public function setConfigurationPool(Pool $pool): void;
 
     /**
@@ -67,14 +100,21 @@ 
      */
     public function getClass(): string;
 
+    /**
+     * @return void
+     */
     public function attachAdminClass(FieldDescriptionInterface $fieldDescription): void;
 
+    /**
+     * @return DatagridInterface|null
+     */
     public function getDatagrid(): ?DatagridInterface;
 
     /**
      * Set base controller name.
      *
      * @param string $baseControllerName
+     * @return void
      */
     public function setBaseControllerName($baseControllerName): void;
 
@@ -85,6 +125,7 @@ 
 
     /**
      * Sets a list of templates.
+     * @return void
      */
     public function setTemplates(array $templates): void;
 
@@ -93,9 +134,13 @@ 
      *
      * @param string $name
      * @param string $template
+     * @return void
      */
     public function setTemplate($name, $template): void;
 
+    /**
+     * @return ModelManagerInterface
+     */
     public function getModelManager(): ?ModelManagerInterface;
 
     /**
@@ -115,6 +160,7 @@ 
 
     /**
      * Returns a form depend on the given $object.
+     * @return \Symfony\Component\Form\Form|null
      */
     public function getForm(): ?FormInterface;
 
@@ -145,6 +191,9 @@ 
      */
     public function getSecurityInformation(): array;
 
+    /**
+     * @return void
+     */
     public function setParentFieldDescription(FieldDescriptionInterface $parentFieldDescription): void;
 
     /**
@@ -186,8 +235,14 @@ 
      */
     public function hasRoute(string $name): bool;
 
+    /**
+     * @return void
+     */
     public function setSecurityHandler(SecurityHandlerInterface $securityHandler): void;
 
+    /**
+     * @return SecurityHandlerInterface
+     */
     public function getSecurityHandler(): ?SecurityHandlerInterface;
 
     /**
@@ -206,15 +261,28 @@ 
      * Shorthand method for templating.
      *
      * @param object $entity
+     * @return string
      */
     public function id($entity): ?string;
 
+    /**
+     * @return void
+     */
     public function setValidator(ValidatorInterface $validator): void;
 
+    /**
+     * @return ValidatorInterface
+     */
     public function getValidator(): ?ValidatorInterface;
 
+    /**
+     * @return FieldDescriptionCollection|null
+     */
     public function getShow(): ?FieldDescriptionCollection;
 
+    /**
+     * @return void
+     */
     public function setFormTheme(array $formTheme): void;
 
     /**
@@ -222,6 +290,9 @@ 
      */
     public function getFormTheme(): array;
 
+    /**
+     * @return void
+     */
     public function setFilterTheme(array $filterTheme): void;
 
     /**
@@ -229,6 +300,9 @@ 
      */
     public function getFilterTheme(): array;
 
+    /**
+     * @return void
+     */
     public function addExtension(AdminExtensionInterface $extension): void;
 
     /**
@@ -238,8 +312,14 @@ 
      */
     public function getExtensions(): array;
 
+    /**
+     * @return void
+     */
     public function setRouteBuilder(RouteBuilderInterface $routeBuilder): void;
 
+    /**
+     * @return RouteBuilderInterface
+     */
     public function getRouteBuilder(): ?RouteBuilderInterface;
 
     /**
@@ -247,8 +327,14 @@ 
      */
     public function toString($object): string;
 
+    /**
+     * @return void
+     */
     public function setLabelTranslatorStrategy(LabelTranslatorStrategyInterface $labelTranslatorStrategy): void;
 
+    /**
+     * @return LabelTranslatorStrategyInterface
+     */
     public function getLabelTranslatorStrategy(): ?LabelTranslatorStrategyInterface;
 
     /**
@@ -265,6 +351,7 @@ 
 
     /**
      * @param string $uniqId
+     * @return void
      */
     public function setUniqid($uniqId): void;
 
@@ -287,6 +374,7 @@ 
 
     /**
      * @param object|null $subject
+     * @return void
      */
     public function setSubject($subject): void;
 
@@ -333,6 +421,7 @@ 
      *
      * @param string $actionName
      * @param bool   $allElements
+     * @return void
      */
     public function preBatchAction($actionName, ProxyQueryInterface $query, array &$idx, $allElements): void;
 
@@ -355,6 +444,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): void;
 
@@ -367,11 +457,18 @@ 
      * Add object security, fe. make the current user owner of the object.
      *
      * @param object $object
+     * @return void
      */
     public function createObjectSecurity($object): void;
 
+    /**
+     * @return AdminInterface|null
+     */
     public function getParent(): ?self;
 
+    /**
+     * @return void
+     */
     public function setParent(self $admin): void;
 
     /**
@@ -383,6 +480,7 @@ 
      * Set the translation domain.
      *
      * @param string $translationDomain the translation domain
+     * @return void
      */
     public function setTranslationDomain($translationDomain): void;
 
@@ -402,21 +500,29 @@ 
 
     /**
      * Set the form groups.
+     * @return void
      */
     public function setFormGroups(array $formGroups): void;
 
     public function getFormTabs();
 
+    /**
+     * @return void
+     */
     public function setFormTabs(array $formTabs): void;
 
     public function getShowTabs();
 
+    /**
+     * @return void
+     */
     public function setShowTabs(array $showTabs): void;
 
     /**
      * Remove a form group field.
      *
      * @param string $key
+     * @return void
      */
     public function removeFieldFromFormGroup($key): void;
 
@@ -429,6 +535,7 @@ 
 
     /**
      * Set the show groups.
+     * @return void
      */
     public function setShowGroups(array $showGroups): void;
 
@@ -436,6 +543,7 @@ 
      * Reorder items in showGroup.
      *
      * @param string $group
+     * @return void
      */
     public function reorderShowGroup($group, array $keys): void;
 
@@ -443,6 +551,7 @@ 
      * add a FieldDescription.
      *
      * @param string $name
+     * @return void
      */
     public function addFormFieldDescription($name, FieldDescriptionInterface $fieldDescription): void;
 
@@ -450,6 +559,7 @@ 
      * Remove a FieldDescription.
      *
      * @param string $name
+     * @return void
      */
     public function removeFormFieldDescription($name): void;
 
@@ -467,11 +577,13 @@ 
      * Adds a new class to a list of supported sub classes.
      *
      * @param $subClass
+     * @return void
      */
     public function addSubClass($subClass): void;
 
     /**
      * Sets the list of supported sub classes.
+     * @return void
      */
     public function setSubClasses(array $subClasses): void;
 
@@ -510,6 +622,7 @@ 
 
     /**
      * Returns Admin`s label.
+     * @return string
      */
     public function getLabel(): ?string;
 
@@ -524,6 +637,7 @@ 
 
     /**
      * Set the current child status.
+     * @return void
      */
     public function setCurrentChild(bool $currentChild): void;
 
@@ -549,6 +663,7 @@ 
 
     /**
      * @param string $mode
+     * @return void
      */
     public function setListMode($mode): void;
 
@@ -574,12 +689,14 @@ 
 
     /**
      * Returns the result link for an object.
+     * @return string|null
      */
     public function getSearchResultLink(object $object): ?string;
 
     /**
      * Setting to true will enable mosaic button for the admin screen.
      * Setting to false will hide mosaic button for the admin screen.
+     * @return void
      */
     public function showMosaicButton(bool $isShown): void;