sonata-project / SonataAdminBundle

src/Admin/AbstractAdmin.php

Doc Comments +13 added lines

@@ -936,6 +936,7 @@ 
 
     /**
      * NEXT_MAJOR: remove this method.
+     * @param string $subClass
      */
     public function addSubClass($subClass): void
     {
@@ -1067,6 +1068,9 @@ 
         return $this->routeGenerator->hasAdminRoute($this, $name);
     }
 
+    /**
+     * @param string $adminCode
+     */
     public function isCurrentRoute(string $name, ?string $adminCode = null): bool
     {
         if (!$this->hasRequest()) {
@@ -1309,6 +1313,9 @@ 
         return $this->baseControllerName;
     }
 
+    /**
+     * @param string $label
+     */
     public function setLabel(?string $label): void
     {
         $this->label = $label;
@@ -1822,6 +1829,7 @@ 
      *
      * NEXT_MAJOR: remove this method
      *
+     * @param string $domain
      * @return string the translated string
      *
      * @deprecated since sonata-project/admin-bundle 3.9, to be removed with 4.0
@@ -2002,6 +2010,9 @@ 
         return $this->managerType;
     }
 
+    /**
+     * @param string $type
+     */
     public function setManagerType(?string $type): void
     {
         $this->managerType = $type;
@@ -2409,6 +2420,7 @@ 
 
     /**
      * {@inheritdoc}
+     * @param boolean $isShown
      */
     final public function showMosaicButton($isShown): void
     {
@@ -2535,6 +2547,7 @@ 
      * NEXT_MAJOR: remove this method.
      *
      * @deprecated Use configureTabMenu instead
+     * @param string $action
      */
     protected function configureSideMenu(ItemInterface $menu, $action, ?AdminInterface $childAdmin = null): void
     {

src/Admin/AdminInterface.php

Doc Comments +120 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,12 +100,19 @@ 
      */
     public function getClass(): string;
 
+    /**
+     * @return void
+     */
     public function attachAdminClass(FieldDescriptionInterface $fieldDescription): void;
 
+    /**
+     * @return DatagridInterface|null
+     */
     public function getDatagrid(): ?DatagridInterface;
 
     /**
      * Set base controller name.
+     * @return void
      */
     public function setBaseControllerName(string $baseControllerName): void;
 
@@ -83,14 +123,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;
 
     /**
@@ -110,6 +155,7 @@ 
 
     /**
      * Returns a form depend on the given $object.
+     * @return \Symfony\Component\Form\Form|null
      */
     public function getForm(): ?FormInterface;
 
@@ -140,6 +186,9 @@ 
      */
     public function getSecurityInformation(): array;
 
+    /**
+     * @return void
+     */
     public function setParentFieldDescription(FieldDescriptionInterface $parentFieldDescription): void;
 
     /**
@@ -179,8 +228,14 @@ 
      */
     public function hasRoute(string $name): bool;
 
+    /**
+     * @return void
+     */
     public function setSecurityHandler(SecurityHandlerInterface $securityHandler): void;
 
+    /**
+     * @return SecurityHandlerInterface
+     */
     public function getSecurityHandler(): ?SecurityHandlerInterface;
 
     /**
@@ -199,15 +254,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;
 
     /**
@@ -215,6 +283,9 @@ 
      */
     public function getFormTheme(): array;
 
+    /**
+     * @return void
+     */
     public function setFilterTheme(array $filterTheme): void;
 
     /**
@@ -222,6 +293,9 @@ 
      */
     public function getFilterTheme(): array;
 
+    /**
+     * @return void
+     */
     public function addExtension(AdminExtensionInterface $extension): void;
 
     /**
@@ -231,8 +305,14 @@ 
      */
     public function getExtensions(): array;
 
+    /**
+     * @return void
+     */
     public function setRouteBuilder(RouteBuilderInterface $routeBuilder): void;
 
+    /**
+     * @return RouteBuilderInterface
+     */
     public function getRouteBuilder(): ?RouteBuilderInterface;
 
     /**
@@ -240,8 +320,14 @@ 
      */
     public function toString($object): string;
 
+    /**
+     * @return void
+     */
     public function setLabelTranslatorStrategy(LabelTranslatorStrategyInterface $labelTranslatorStrategy): void;
 
+    /**
+     * @return LabelTranslatorStrategyInterface
+     */
     public function getLabelTranslatorStrategy(): ?LabelTranslatorStrategyInterface;
 
     /**
@@ -253,6 +339,9 @@ 
 
     public function getNewInstance(): object;
 
+    /**
+     * @return void
+     */
     public function setUniqid(string $uniqId): void;
 
     /**
@@ -272,6 +361,9 @@ 
      */
     public function getObject($id): ?object;
 
+    /**
+     * @return void
+     */
     public function setSubject(?object $subject): void;
 
     /**
@@ -313,6 +405,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;
 
@@ -335,6 +428,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;
 
@@ -342,6 +436,7 @@ 
 
     /**
      * Add object security, fe. make the current user owner of the object.
+     * @return void
      */
     public function createObjectSecurity(object $object): void;
 
@@ -350,6 +445,9 @@ 
      */
     public function getParent(): ?self;
 
+    /**
+     * @return void
+     */
     public function setParent(self $admin): void;
 
     /**
@@ -361,6 +459,7 @@ 
      * Set the translation domain.
      *
      * @param string $translationDomain the translation domain
+     * @return void
      */
     public function setTranslationDomain(string $translationDomain): void;
 
@@ -382,6 +481,7 @@ 
 
     /**
      * Set the form groups.
+     * @return void
      */
     public function setFormGroups(array $formGroups): void;
 
@@ -390,6 +490,9 @@ 
      */
     public function getFormTabs();
 
+    /**
+     * @return void
+     */
     public function setFormTabs(array $formTabs): void;
 
     /**
@@ -397,10 +500,14 @@ 
      */
     public function getShowTabs();
 
+    /**
+     * @return void
+     */
     public function setShowTabs(array $showTabs): void;
 
     /**
      * Remove a form group field.
+     * @return void
      */
     public function removeFieldFromFormGroup(string $key): void;
 
@@ -415,21 +522,25 @@ 
 
     /**
      * 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;
 
     /**
      * add a FieldDescription.
+     * @return void
      */
     public function addFormFieldDescription(string $name, FieldDescriptionInterface $fieldDescription): void;
 
     /**
      * Remove a FieldDescription.
+     * @return void
      */
     public function removeFormFieldDescription(string $name): void;
 
@@ -447,11 +558,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;
 
@@ -490,6 +603,7 @@ 
 
     /**
      * Returns Admin`s label.
+     * @return string
      */
     public function getLabel(): ?string;
 
@@ -504,6 +618,7 @@ 
 
     /**
      * Set the current child status.
+     * @return void
      */
     public function setCurrentChild(bool $currentChild): void;
 
@@ -529,6 +644,9 @@ 
      */
     public function getListModes(): array;
 
+    /**
+     * @return void
+     */
     public function setListMode(string $mode): void;
 
     /**
@@ -553,12 +671,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;
 

src/Admin/BaseFieldDescription.php

Doc Comments +9 added lines

@@ -131,6 +131,9 @@ 
      */
     private static $fieldGetters = [];
 
+    /**
+     * @param string $fieldName
+     */
     public function setFieldName(?string $fieldName): void
     {
         $this->fieldName = $fieldName;
@@ -141,6 +144,9 @@ 
         return $this->fieldName;
     }
 
+    /**
+     * @param string $name
+     */
     public function setName(?string $name): void
     {
         $this->name = $name;
@@ -270,6 +276,9 @@ 
         return null !== $this->associationAdmin;
     }
 
+    /**
+     * @param string $fieldName
+     */
     public function getFieldValue(?object $object, ?string $fieldName)
     {
         if ($this->isVirtual() || null === $object) {

src/Admin/FieldDescriptionInterface.php

Doc Comments +16 added lines

@@ -20,6 +20,7 @@ 
 {
     /**
      * set the field name.
+     * @return void
      */
     public function setFieldName(?string $fieldName): void;
 
@@ -32,6 +33,7 @@ 
 
     /**
      * Set the name.
+     * @return void
      */
     public function setName(?string $name): void;
 
@@ -55,6 +57,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;
 
@@ -66,6 +69,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;
 
@@ -78,6 +82,7 @@ 
 
     /**
      * Sets the template used to render the field.
+     * @return void
      */
     public function setTemplate(string $template): void;
 
@@ -91,21 +96,25 @@ 
     /**
      * 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);
 
     /**
      * Returns the parent Admin (only used in nested admin).
+     * @return AdminInterface|null
      */
     public function getParent(): ?AdminInterface;
 
@@ -121,6 +130,7 @@ 
 
     /**
      * Returns the related Target Entity.
+     * @return string
      */
     public function getTargetEntity(): ?string;
 
@@ -152,11 +162,13 @@ 
      * 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);
 
     /**
      * Returns the associated Admin instance (only used if the field is linked to an Admin).
+     * @return AdminInterface
      */
     public function getAssociationAdmin(): ?AdminInterface;
 
@@ -174,6 +186,7 @@ 
 
     /**
      * set the admin class linked to this FieldDescription.
+     * @return void
      */
     public function setAdmin(AdminInterface $admin);
 
@@ -186,11 +199,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;
 
@@ -198,6 +213,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);