sonata-project / SonataAdminBundle

src/Admin/AbstractAdmin.php

Doc Comments +7 added lines

@@ -1236,6 +1236,9 @@ 
         return $this->baseControllerName;
     }
 
+    /**
+     * @param string $label
+     */
     public function setLabel(?string $label): void
     {
         $this->label = $label;
@@ -1877,6 +1880,9 @@ 
         return $this->managerType;
     }
 
+    /**
+     * @param string $type
+     */
     public function setManagerType(?string $type): void
     {
         $this->managerType = $type;
@@ -2311,6 +2317,7 @@ 
 
     /**
      * {@inheritdoc}
+     * @param boolean $isShown
      */
     final public function showMosaicButton($isShown): void
     {

src/Admin/FieldDescriptionInterface.php

Doc Comments +16 added lines

@@ -26,6 +26,7 @@ 
 {
     /**
      * set the field name.
+     * @return void
      */
     public function setFieldName(?string $fieldName): void;
 
@@ -38,6 +39,7 @@ 
 
     /**
      * Set the name.
+     * @return void
      */
     public function setName(?string $name): void;
 
@@ -61,6 +63,7 @@ 
      * Define an option, an option is has a name and a value.
      *
      * @param mixed $value
+     * @return void
      */
     public function setOption(string $name, $value): void;
 
@@ -72,6 +75,7 @@ 
      * Then the value are copied across to the related property value.
      *
      * @param array<string, mixed> $options
+     * @return void
      */
     public function setOptions(array $options): void;
 
@@ -84,6 +88,8 @@ 
 
     /**
      * Sets the template used to render the field.
+     * @param string $template
+     * @return void
      */
     public function setTemplate(?string $template): void;
 
@@ -97,16 +103,19 @@ 
     /**
      * Sets the field type. The type is a mandatory field as it's used to select the correct template
      * or the logic associated to the current FieldDescription object.
+     * @return void
      */
     public function setType(?string $type): void;
 
     /**
      * Returns the type.
+     * @return string
      */
     public function getType(): ?string;
 
     /**
      * set the parent Admin (only used in nested admin).
+     * @return void
      */
     public function setParent(AdminInterface $parent);
 
@@ -129,6 +138,7 @@ 
 
     /**
      * Returns the related Target object model.
+     * @return string
      */
     public function getTargetModel(): ?string;
 
@@ -160,6 +170,7 @@ 
      * set the association admin instance (only used if the field is linked to an Admin).
      *
      * @param AdminInterface $associationAdmin the associated admin
+     * @return void
      */
     public function setAssociationAdmin(AdminInterface $associationAdmin);
 
@@ -184,6 +195,7 @@ 
 
     /**
      * set the admin class linked to this FieldDescription.
+     * @return void
      */
     public function setAdmin(AdminInterface $admin);
 
@@ -198,11 +210,13 @@ 
      * merge option values related to the provided option name.
      *
      * @throws \RuntimeException
+     * @return void
      */
     public function mergeOption(string $name, array $options = []): void;
 
     /**
      * merge options values.
+     * @return void
      */
     public function mergeOptions(array $options = []): void;
 
@@ -210,6 +224,7 @@ 
      * set the original mapping type (only used if the field is linked to an entity).
      *
      * @param string|int $mappingType
+     * @return void
      */
     public function setMappingType($mappingType);
 
@@ -259,6 +274,7 @@ 
 
     /**
      * Defines the help message.
+     * @return void
      */
     public function setHelp(string $help): void;
 }

tests/Fixtures/Admin/CommentAdmin.php

Doc Comments +6 added lines

@@ -18,6 +18,9 @@ 
 
 class CommentAdmin extends AbstractAdmin
 {
+    /**
+     * @param string $label
+     */
     public function setClassnameLabel($label): void
     {
         $this->classnameLabel = $label;
@@ -28,6 +31,9 @@ 
         $collection->remove('edit');
     }
 
+    /**
+     * @param string $associationMapping
+     */
     public function setParentAssociationMapping($associationMapping): void
     {
         $this->parentAssociationMapping = $associationMapping;

src/Route/RouteCollection.php

Doc Comments +3 added lines

@@ -62,6 +62,9 @@
         $this->baseControllerName = $baseControllerName;
     }
 
+    /**
+     * @param string $pattern
+     */
     public function add(
         string $name,
         ?string $pattern = null,

src/Admin/AdminInterface.php

Doc Comments +128 added lines

@@ -39,22 +39,49 @@ 
  */
 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 setRequest(Request $request): void;
 
+    /**
+     * @return void
+     */
     public function setConfigurationPool(Pool $pool): void;
 
     /**
@@ -65,12 +92,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;
 
@@ -81,14 +112,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;
 
     /**
@@ -105,6 +141,7 @@ 
 
     /**
      * Returns a form depend on the given $object.
+     * @return \Symfony\Component\Form\Form|null
      */
     public function getForm(): ?FormInterface;
 
@@ -130,6 +167,9 @@ 
      */
     public function getSecurityInformation(): array;
 
+    /**
+     * @return void
+     */
     public function setParentFieldDescription(FieldDescriptionInterface $parentFieldDescription): void;
 
     /**
@@ -154,8 +194,14 @@ 
      */
     public function hasRoute(string $name): bool;
 
+    /**
+     * @return void
+     */
     public function setSecurityHandler(SecurityHandlerInterface $securityHandler): void;
 
+    /**
+     * @return SecurityHandlerInterface
+     */
     public function getSecurityHandler(): ?SecurityHandlerInterface;
 
     /**
@@ -174,17 +220,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;
 
     /**
@@ -192,6 +254,9 @@ 
      */
     public function getFormTheme(): array;
 
+    /**
+     * @return void
+     */
     public function setFilterTheme(array $filterTheme): void;
 
     /**
@@ -199,6 +264,9 @@ 
      */
     public function getFilterTheme(): array;
 
+    /**
+     * @return void
+     */
     public function addExtension(AdminExtensionInterface $extension): void;
 
     /**
@@ -208,8 +276,14 @@ 
      */
     public function getExtensions(): array;
 
+    /**
+     * @return void
+     */
     public function setRouteBuilder(RouteBuilderInterface $routeBuilder): void;
 
+    /**
+     * @return RouteBuilderInterface
+     */
     public function getRouteBuilder(): ?RouteBuilderInterface;
 
     /**
@@ -217,8 +291,14 @@ 
      */
     public function toString($object): string;
 
+    /**
+     * @return void
+     */
     public function setLabelTranslatorStrategy(LabelTranslatorStrategyInterface $labelTranslatorStrategy): void;
 
+    /**
+     * @return LabelTranslatorStrategyInterface
+     */
     public function getLabelTranslatorStrategy(): ?LabelTranslatorStrategyInterface;
 
     /**
@@ -230,6 +310,9 @@ 
 
     public function getNewInstance(): object;
 
+    /**
+     * @return void
+     */
     public function setUniqid(string $uniqId): void;
 
     /**
@@ -249,6 +332,9 @@ 
      */
     public function getObject($id): ?object;
 
+    /**
+     * @return void
+     */
     public function setSubject(?object $subject): void;
 
     public function getSubject(): object;
@@ -272,6 +358,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;
 
@@ -294,6 +381,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;
 
@@ -301,11 +389,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;
 
     /**
@@ -317,6 +409,7 @@ 
      * Set the translation domain.
      *
      * @param string $translationDomain the translation domain
+     * @return void
      */
     public function setTranslationDomain(string $translationDomain): void;
 
@@ -336,6 +429,7 @@ 
 
     /**
      * Set the form groups.
+     * @return void
      */
     public function setFormGroups(array $formGroups): void;
 
@@ -344,6 +438,9 @@ 
      */
     public function getFormTabs(): array;
 
+    /**
+     * @return void
+     */
     public function setFormTabs(array $formTabs): void;
 
     /**
@@ -351,10 +448,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;
 
@@ -367,11 +468,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;
 
@@ -387,6 +490,7 @@ 
 
     /**
      * Sets the list of supported sub classes.
+     * @return void
      */
     public function setSubClasses(array $subClasses): void;
 
@@ -425,6 +529,7 @@ 
 
     /**
      * Returns Admin`s label.
+     * @return string
      */
     public function getLabel(): ?string;
 
@@ -439,6 +544,7 @@ 
 
     /**
      * Set the current child status.
+     * @return void
      */
     public function setCurrentChild(bool $currentChild): void;
 
@@ -462,6 +568,9 @@ 
      */
     public function getListModes(): array;
 
+    /**
+     * @return void
+     */
     public function setListMode(string $mode): void;
 
     /**
@@ -486,12 +595,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;
 
@@ -517,6 +628,9 @@ 
      */
     public function getRootCode(): string;
 
+    /**
+     * @return void
+     */
     public function setFilterPersister(?FilterPersisterInterface $filterPersister = null): void;
 
     /**
@@ -529,14 +643,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;
 
@@ -546,11 +670,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;
 }