sonata-project / SonataAdminBundle

src/Controller/PolyfillControllerTrait.php

Doc Comments +3 added lines

@@ -25,6 +25,9 @@
  */
 trait PolyfillControllerTrait
 {
+    /**
+     * @param string $methodName
+     */
     public function __call($methodName, $arguments)
     {
         $this->proxyToController($methodName, $arguments);

src/Admin/AdminInterface.php

Doc Comments +133 added lines

@@ -41,26 +41,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;
 
     /**
@@ -71,12 +104,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;
 
@@ -87,11 +124,13 @@ 
 
     /**
      * 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;
 
@@ -114,6 +153,7 @@ 
 
     /**
      * Returns a form depend on the given $object.
+     * @return \Symfony\Component\Form\Form|null
      */
     public function getForm(): ?FormInterface;
 
@@ -144,6 +184,9 @@ 
      */
     public function getSecurityInformation(): array;
 
+    /**
+     * @return void
+     */
     public function setParentFieldDescription(FieldDescriptionInterface $parentFieldDescription): void;
 
     /**
@@ -183,8 +226,14 @@ 
      */
     public function hasRoute(string $name): bool;
 
+    /**
+     * @return void
+     */
     public function setSecurityHandler(SecurityHandlerInterface $securityHandler): void;
 
+    /**
+     * @return SecurityHandlerInterface
+     */
     public function getSecurityHandler(): ?SecurityHandlerInterface;
 
     /**
@@ -203,17 +252,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;
 
     /**
@@ -221,6 +286,9 @@ 
      */
     public function getFormTheme(): array;
 
+    /**
+     * @return void
+     */
     public function setFilterTheme(array $filterTheme): void;
 
     /**
@@ -228,6 +296,9 @@ 
      */
     public function getFilterTheme(): array;
 
+    /**
+     * @return void
+     */
     public function addExtension(AdminExtensionInterface $extension): void;
 
     /**
@@ -237,8 +308,14 @@ 
      */
     public function getExtensions(): array;
 
+    /**
+     * @return void
+     */
     public function setRouteBuilder(RouteBuilderInterface $routeBuilder): void;
 
+    /**
+     * @return RouteBuilderInterface
+     */
     public function getRouteBuilder(): ?RouteBuilderInterface;
 
     /**
@@ -246,8 +323,14 @@ 
      */
     public function toString($object): string;
 
+    /**
+     * @return void
+     */
     public function setLabelTranslatorStrategy(LabelTranslatorStrategyInterface $labelTranslatorStrategy): void;
 
+    /**
+     * @return LabelTranslatorStrategyInterface
+     */
     public function getLabelTranslatorStrategy(): ?LabelTranslatorStrategyInterface;
 
     /**
@@ -259,6 +342,9 @@ 
 
     public function getNewInstance(): object;
 
+    /**
+     * @return void
+     */
     public function setUniqid(string $uniqId): void;
 
     /**
@@ -278,6 +364,9 @@ 
      */
     public function getObject($id): ?object;
 
+    /**
+     * @return void
+     */
     public function setSubject(?object $subject): void;
 
     /**
@@ -289,6 +378,7 @@ 
      * NEXT_MAJOR: Remove this method, since it's already in FieldDescriptionRegistryInterface.
      *
      * Returns a list FieldDescription.
+     * @return null|FieldDescriptionInterface
      */
     public function getListFieldDescription(string $name): ?FieldDescriptionInterface;
 
@@ -325,6 +415,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;
 
@@ -347,6 +438,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;
 
@@ -354,6 +446,7 @@ 
 
     /**
      * Add object security, fe. make the current user owner of the object.
+     * @return void
      */
     public function createObjectSecurity(object $object): void;
 
@@ -362,6 +455,9 @@ 
      */
     public function getParent(): ?self;
 
+    /**
+     * @return void
+     */
     public function setParent(self $admin): void;
 
     /**
@@ -373,6 +469,7 @@ 
      * Set the translation domain.
      *
      * @param string $translationDomain the translation domain
+     * @return void
      */
     public function setTranslationDomain(string $translationDomain): void;
 
@@ -392,6 +489,7 @@ 
 
     /**
      * Set the form groups.
+     * @return void
      */
     public function setFormGroups(array $formGroups): void;
 
@@ -400,6 +498,9 @@ 
      */
     public function getFormTabs(): array;
 
+    /**
+     * @return void
+     */
     public function setFormTabs(array $formTabs): void;
 
     /**
@@ -407,10 +508,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;
 
@@ -423,11 +528,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;
 
@@ -435,6 +542,7 @@ 
      * NEXT_MAJOR: Remove this method, since it's already in FieldDescriptionRegistryInterface.
      *
      * add a FieldDescription.
+     * @return void
      */
     public function addFormFieldDescription(string $name, FieldDescriptionInterface $fieldDescription): void;
 
@@ -442,6 +550,7 @@ 
      * NEXT_MAJOR: Remove this method, since it's already in FieldDescriptionRegistryInterface.
      *
      * Remove a FieldDescription.
+     * @return void
      */
     public function removeFormFieldDescription(string $name): void;
 
@@ -459,11 +568,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;
 
@@ -502,6 +613,7 @@ 
 
     /**
      * Returns Admin`s label.
+     * @return string
      */
     public function getLabel(): ?string;
 
@@ -516,6 +628,7 @@ 
 
     /**
      * Set the current child status.
+     * @return void
      */
     public function setCurrentChild(bool $currentChild): void;
 
@@ -541,6 +654,9 @@ 
      */
     public function getListModes(): array;
 
+    /**
+     * @return void
+     */
     public function setListMode(string $mode): void;
 
     /**
@@ -565,12 +681,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;
 
@@ -596,6 +714,9 @@ 
      */
     public function getRootCode(): string;
 
+    /**
+     * @return void
+     */
     public function setFilterPersister(?FilterPersisterInterface $filterPersister = null): void;
 
     /**
@@ -608,28 +729,40 @@ 
      */
     public function getBaseRouteName(): string;
 
+    /**
+     * @param AbstractAdmin $childAdmin
+     */
     public function getSideMenu(string $action, ?AdminInterface $childAdmin = null): \Knp\Menu\ItemInterface;
 
+    /**
+     * @return void
+     */
     public function addParentAssociationMapping(string $code, string $value): void;
 
     public function getRouteGenerator(): RouteGeneratorInterface;
 
     /**
      * Returns the current child admin instance.
+     * @return AdminInterface|null
      */
     public function getCurrentChildAdmin(): ?AdminInterface;
 
     /**
      * Returns the name of the parent related field, so the field can be use to set the default
      * value (ie the parent object) or to filter the object.
+     * @return string|null
      */
     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;
 }

src/Admin/FieldDescriptionInterface.php

Doc Comments +14 added lines

@@ -26,6 +26,7 @@ 
 {
     /**
      * set the field name.
+     * @return void
      */
     public function setFieldName(?string $fieldName): void;
 
@@ -38,6 +39,8 @@ 
 
     /**
      * Set the name.
+     * @param string $name
+     * @return void
      */
     public function setName(?string $name): void;
 
@@ -61,6 +64,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 +76,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 +89,7 @@ 
 
     /**
      * Sets the template used to render the field.
+     * @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);
 
@@ -169,6 +178,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);
 
@@ -196,6 +206,7 @@ 
 
     /**
      * set the admin class linked to this FieldDescription.
+     * @return void
      */
     public function setAdmin(AdminInterface $admin);
 
@@ -211,11 +222,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;
 
@@ -223,6 +236,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);
 

src/Security/Handler/AclSecurityHandler.php

Doc Comments +3 added lines

@@ -182,6 +182,9 @@
         return $acls;
     }
 
+    /**
+     * @param UserSecurityIdentity $securityIdentity
+     */
     public function addObjectOwner(AclInterface $acl, ?UserSecurityIdentity $securityIdentity = null): void
     {
         if (!$acl instanceof MutableAclInterface) {