sonata-project / SonataAdminBundle

src/Datagrid/ListMapper.php

Doc Comments +1 added lines, -1 removed lines

@@ -52,7 +52,7 @@
     }
 
     /**
-     * @param FieldDescriptionInterface|string $name
+     * @param \Sonata\AdminBundle\Admin\BaseFieldDescription $name
      * @param array<string, mixed>             $fieldDescriptionOptions
      */
     public function addIdentifier($name, ?string $type = null, array $fieldDescriptionOptions = []): self

src/Datagrid/Pager.php

Doc Comments +3 added lines, -2 removed lines

@@ -132,6 +132,7 @@ 
     /**
      * Returns an array of page numbers to use in pagination links.
      *
+     * @param integer $nbLinks
      * @return int[]
      */
     public function getLinks(?int $nbLinks = null): array
@@ -380,7 +381,7 @@ 
     /**
      * Returns a parameter.
      *
-     * @param mixed $default
+     * @param null|string $default
      *
      * @return mixed
      */
@@ -400,7 +401,7 @@ 
     /**
      * Sets a parameter.
      *
-     * @param mixed $value
+     * @param string $value
      */
     public function setParameter(string $name, $value): void
     {

src/Filter/Persister/FilterPersisterInterface.php

Doc Comments +2 added lines

@@ -41,11 +41,13 @@
      *     "_per_page" => {int count rows per page}.
      *
      * @param array<string, int|string|array{type: int, value: mixed}> $filters
+     * @return void
      */
     public function set(string $adminCode, array $filters): void;
 
     /**
      * Reset persisted filters for given admin.
+     * @return void
      */
     public function reset(string $adminCode): void;
 }

src/Filter/FilterInterface.php

Doc Comments +12 added lines, -2 removed lines

@@ -43,6 +43,9 @@ 
 
     public function getLabel(): ?string;
 
+    /**
+     * @return void
+     */
     public function setLabel(string $label): void;
 
     /**
@@ -51,19 +54,21 @@ 
     public function getDefaultOptions(): array;
 
     /**
-     * @param mixed $default
+     * @param boolean $default
      *
      * @return mixed
      */
     public function getOption(string $name, $default = null);
 
     /**
-     * @param mixed $value
+     * @param boolean $value
+     * @return void
      */
     public function setOption(string $name, $value): void;
 
     /**
      * @param array<string, mixed> $options
+     * @return void
      */
     public function initialize(string $name, array $options = []): void;
 
@@ -105,6 +110,7 @@ 
 
     /**
      * @param mixed $value
+     * @return void
      */
     public function setFieldOption(string $name, $value): void;
 
@@ -124,9 +130,13 @@ 
 
     /**
      * Set the condition to use with the left side of the query : OR or AND.
+     * @return void
      */
     public function setCondition(string $condition): void;
 
+    /**
+     * @return string|null
+     */
     public function getCondition(): ?string;
 
     public function getTranslationDomain(): ?string;

src/Datagrid/DatagridInterface.php

Doc Comments +11 added lines

@@ -32,8 +32,14 @@ 
      */
     public function getResults(): array;
 
+    /**
+     * @return void
+     */
     public function buildPager(): void;
 
+    /**
+     * @return void
+     */
     public function addFilter(FilterInterface $filter): void;
 
     /**
@@ -45,6 +51,7 @@ 
      * Reorder filters.
      *
      * @param string[] $keys
+     * @return void
      */
     public function reorderFilters(array $keys): void;
 
@@ -57,6 +64,7 @@ 
 
     /**
      * @param mixed $value
+     * @return void
      */
     public function setValue(string $name, ?string $operator, $value): void;
 
@@ -66,6 +74,9 @@ 
 
     public function hasFilter(string $name): bool;
 
+    /**
+     * @return void
+     */
     public function removeFilter(string $name): void;
 
     public function hasActiveFilters(): bool;

src/Admin/AdminInterface.php

Doc Comments +131 added lines

@@ -40,24 +40,54 @@ 
  */
 interface AdminInterface extends AccessRegistryInterface, FieldDescriptionRegistryInterface, LifecycleHookProviderInterface, MenuBuilderInterface, ParentAdminInterface, UrlGeneratorInterface
 {
+    /**
+     * @return void
+     */
     public function setMenuFactory(FactoryInterface $menuFactory): void;
 
+    /**
+     * @return FactoryInterface
+     */
     public function getMenuFactory(): ?FactoryInterface;
 
+    /**
+     * @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 void
+     */
     public function setRequest(Request $request): void;
 
+    /**
+     * @return void
+     */
     public function setConfigurationPool(Pool $pool): void;
 
     /**
@@ -68,12 +98,16 @@ 
      */
     public function getClass(): string;
 
+    /**
+     * @return void
+     */
     public function attachAdminClass(FieldDescriptionInterface $fieldDescription): void;
 
     public function getDatagrid(): DatagridInterface;
 
     /**
      * Set base controller name.
+     * @return void
      */
     public function setBaseControllerName(string $baseControllerName): void;
 
@@ -84,14 +118,19 @@ 
 
     /**
      * Sets a list of templates.
+     * @return void
      */
     public function setTemplates(array $templates): void;
 
     /**
      * Sets a specific template.
+     * @return void
      */
     public function setTemplate(string $name, string $template): void;
 
+    /**
+     * @return ModelManagerInterface
+     */
     public function getModelManager(): ?ModelManagerInterface;
 
     /**
@@ -108,6 +147,7 @@ 
 
     /**
      * Returns a form depend on the given $object.
+     * @return FormInterface|null
      */
     public function getForm(): ?FormInterface;
 
@@ -133,6 +173,9 @@ 
      */
     public function getSecurityInformation(): array;
 
+    /**
+     * @return void
+     */
     public function setParentFieldDescription(FieldDescriptionInterface $parentFieldDescription): void;
 
     /**
@@ -157,8 +200,14 @@ 
      */
     public function hasRoute(string $name): bool;
 
+    /**
+     * @return void
+     */
     public function setSecurityHandler(SecurityHandlerInterface $securityHandler): void;
 
+    /**
+     * @return SecurityHandlerInterface
+     */
     public function getSecurityHandler(): ?SecurityHandlerInterface;
 
     /**
@@ -177,17 +226,33 @@ 
      * Shorthand method for templating.
      *
      * @param object $model
+     * @return string
      */
     public function id($model): ?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;
 
+    /**
+     * @return FieldDescriptionCollection|null
+     */
     public function getList(): ?FieldDescriptionCollection;
 
     /**
@@ -195,6 +260,9 @@ 
      */
     public function getFormTheme(): array;
 
+    /**
+     * @return void
+     */
     public function setFilterTheme(array $filterTheme): void;
 
     /**
@@ -202,6 +270,9 @@ 
      */
     public function getFilterTheme(): array;
 
+    /**
+     * @return void
+     */
     public function addExtension(AdminExtensionInterface $extension): void;
 
     /**
@@ -211,8 +282,14 @@ 
      */
     public function getExtensions(): array;
 
+    /**
+     * @return void
+     */
     public function setRouteBuilder(RouteBuilderInterface $routeBuilder): void;
 
+    /**
+     * @return RouteBuilderInterface
+     */
     public function getRouteBuilder(): ?RouteBuilderInterface;
 
     /**
@@ -220,8 +297,14 @@ 
      */
     public function toString($object): string;
 
+    /**
+     * @return void
+     */
     public function setLabelTranslatorStrategy(LabelTranslatorStrategyInterface $labelTranslatorStrategy): void;
 
+    /**
+     * @return LabelTranslatorStrategyInterface
+     */
     public function getLabelTranslatorStrategy(): ?LabelTranslatorStrategyInterface;
 
     /**
@@ -233,6 +316,9 @@ 
 
     public function getNewInstance(): object;
 
+    /**
+     * @return void
+     */
     public function setUniqid(string $uniqId): void;
 
     /**
@@ -252,6 +338,9 @@ 
      */
     public function getObject($id): ?object;
 
+    /**
+     * @return void
+     */
     public function setSubject(?object $subject): void;
 
     public function getSubject(): object;
@@ -275,6 +364,7 @@ 
 
     /**
      * Call before the batch action, allow you to alter the query and the idx.
+     * @return void
      */
     public function preBatchAction(string $actionName, ProxyQueryInterface $query, array &$idx, bool $allElements = false): void;
 
@@ -297,6 +387,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;
 
@@ -304,11 +395,15 @@ 
 
     /**
      * Add object security, fe. make the current user owner of the object.
+     * @return void
      */
     public function createObjectSecurity(object $object): void;
 
     public function getParent(): self;
 
+    /**
+     * @return void
+     */
     public function setParent(self $admin): void;
 
     /**
@@ -320,6 +415,7 @@ 
      * Set the translation domain.
      *
      * @param string $translationDomain the translation domain
+     * @return void
      */
     public function setTranslationDomain(string $translationDomain): void;
 
@@ -339,6 +435,7 @@ 
 
     /**
      * Set the form groups.
+     * @return void
      */
     public function setFormGroups(array $formGroups): void;
 
@@ -347,6 +444,9 @@ 
      */
     public function getFormTabs(): array;
 
+    /**
+     * @return void
+     */
     public function setFormTabs(array $formTabs): void;
 
     /**
@@ -354,10 +454,14 @@ 
      */
     public function getShowTabs(): array;
 
+    /**
+     * @return void
+     */
     public function setShowTabs(array $showTabs): void;
 
     /**
      * Remove a form group field.
+     * @return void
      */
     public function removeFieldFromFormGroup(string $key): void;
 
@@ -370,11 +474,13 @@ 
 
     /**
      * Set the show groups.
+     * @return void
      */
     public function setShowGroups(array $showGroups): void;
 
     /**
      * Reorder items in showGroup.
+     * @return void
      */
     public function reorderShowGroup(string $group, array $keys): void;
 
@@ -390,6 +496,7 @@ 
 
     /**
      * Sets the list of supported sub classes.
+     * @return void
      */
     public function setSubClasses(array $subClasses): void;
 
@@ -428,6 +535,7 @@ 
 
     /**
      * Returns Admin`s label.
+     * @return string
      */
     public function getLabel(): ?string;
 
@@ -442,6 +550,7 @@ 
 
     /**
      * Set the current child status.
+     * @return void
      */
     public function setCurrentChild(bool $currentChild): void;
 
@@ -465,6 +574,9 @@ 
      */
     public function getListModes(): array;
 
+    /**
+     * @return void
+     */
     public function setListMode(string $mode): void;
 
     /**
@@ -489,12 +601,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;
 
@@ -515,6 +629,9 @@ 
      */
     public function getRootCode(): string;
 
+    /**
+     * @return void
+     */
     public function setFilterPersister(?FilterPersisterInterface $filterPersister = null): void;
 
     /**
@@ -527,14 +644,24 @@ 
      */
     public function getBaseRouteName(): string;
 
+    /**
+     * @param AbstractAdmin $childAdmin
+     */
     public function getSideMenu(string $action, ?self $childAdmin = null): ItemInterface;
 
+    /**
+     * @return void
+     */
     public function addParentAssociationMapping(string $code, string $value): void;
 
+    /**
+     * @return RouteGeneratorInterface|null
+     */
     public function getRouteGenerator(): ?RouteGeneratorInterface;
 
     /**
      * Returns the current child admin instance.
+     * @return AdminInterface|null
      */
     public function getCurrentChildAdmin(): ?self;
 
@@ -544,11 +671,15 @@ 
      */
     public function getParentAssociationMapping(): ?string;
 
+    /**
+     * @return void
+     */
     public function reorderFormGroup(string $group, array $keys): void;
 
     /**
      * This method is being called by the main admin class and the child class,
      * the getFormBuilder is only call by the main admin class.
+     * @return void
      */
     public function defineFormBuilder(FormBuilderInterface $formBuilder): void;
 }