sonata-project / SonataAdminBundle

src/Admin/UrlGeneratorInterface.php

Doc Comments +3 added lines

@@ -34,6 +34,9 @@
      */
     public function getRouterIdParameter(): string;
 
+    /**
+     * @return void
+     */
     public function setRouteGenerator(RouteGeneratorInterface $routeGenerator): void;
 
     /**

src/Admin/AccessRegistryInterface.php

Doc Comments +1 added lines

@@ -29,6 +29,7 @@
 
     /**
      * Hook to handle access authorization.
+     * @return void
      */
     public function checkAccess(string $action, ?object $object = null): void;
 

src/Admin/AdminExtensionInterface.php

Doc Comments +46 added lines

@@ -27,16 +27,34 @@ 
  */
 interface AdminExtensionInterface
 {
+    /**
+     * @return void
+     */
     public function configureFormFields(FormMapper $formMapper): void;
 
+    /**
+     * @return void
+     */
     public function configureListFields(ListMapper $listMapper): void;
 
+    /**
+     * @return void
+     */
     public function configureDatagridFilters(DatagridMapper $datagridMapper): void;
 
+    /**
+     * @return void
+     */
     public function configureShowFields(ShowMapper $showMapper): void;
 
+    /**
+     * @return void
+     */
     public function configureRoutes(AdminInterface $admin, RouteCollectionInterface $collection): void;
 
+    /**
+     * @return void
+     */
     public function configureTabMenu(
         AdminInterface $admin,
         MenuItemInterface $menu,
@@ -44,17 +62,25 @@ 
         ?AdminInterface $childAdmin = null
     ): void;
 
+    /**
+     * @return void
+     */
     public function validate(AdminInterface $admin, ErrorElement $errorElement, object $object): void;
 
+    /**
+     * @return void
+     */
     public function configureQuery(AdminInterface $admin, ProxyQueryInterface $query): void;
 
     /**
      * Get a chance to modify a newly created instance.
+     * @return void
      */
     public function alterNewInstance(AdminInterface $admin, object $object): void;
 
     /**
      * Get a chance to modify object instance.
+     * @return void
      */
     public function alterObject(AdminInterface $admin, object $object): void;
 
@@ -90,16 +116,34 @@ 
      */
     public function configureExportFields(AdminInterface $admin, array $fields): array;
 
+    /**
+     * @return void
+     */
     public function preUpdate(AdminInterface $admin, object $object): void;
 
+    /**
+     * @return void
+     */
     public function postUpdate(AdminInterface $admin, object $object): void;
 
+    /**
+     * @return void
+     */
     public function prePersist(AdminInterface $admin, object $object): void;
 
+    /**
+     * @return void
+     */
     public function postPersist(AdminInterface $admin, object $object): void;
 
+    /**
+     * @return void
+     */
     public function preRemove(AdminInterface $admin, object $object): void;
 
+    /**
+     * @return void
+     */
     public function postRemove(AdminInterface $admin, object $object): void;
 
     /**
@@ -120,6 +164,7 @@ 
      * Returns a list of default filters.
      *
      * @param array<string, array<string, mixed>> $filterValues
+     * @return void
      */
     public function configureDefaultFilterValues(AdminInterface $admin, array &$filterValues): void;
 
@@ -127,6 +172,7 @@ 
      * Returns a list of default sort values.
      *
      * @param array{_page?: int, _per_page?: int, _sort_by?: string, _sort_order?: string} $sortValues
+     * @return void
      */
     public function configureDefaultSortValues(AdminInterface $admin, array &$sortValues): void;
 }

src/Admin/AdminInterface.php

Doc Comments +127 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|null
+     */
     public function getMenuFactory(): ?FactoryInterface;
 
+    /**
+     * @return void
+     */
     public function setFormContractor(FormContractorInterface $formContractor): void;
 
+    /**
+     * @return void
+     */
     public function setListBuilder(ListBuilderInterface $listBuilder): void;
 
+    /**
+     * @return ListBuilderInterface|null
+     */
     public function getListBuilder(): ?ListBuilderInterface;
 
+    /**
+     * @return void
+     */
     public function setDatagridBuilder(DatagridBuilderInterface $datagridBuilder): void;
 
+    /**
+     * @return DatagridBuilderInterface|null
+     */
     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;
 
@@ -86,20 +120,34 @@ 
      * Sets a list of templates.
      *
      * @param array<string, string> $templates
+     * @return void
      */
     public function setTemplates(array $templates): void;
 
     /**
      * Sets a specific template.
+     * @return void
      */
     public function setTemplate(string $name, string $template): void;
 
+    /**
+     * @return void
+     */
     public function setModelManager(ModelManagerInterface $modelManager): void;
 
+    /**
+     * @return ModelManagerInterface
+     */
     public function getModelManager(): ?ModelManagerInterface;
 
+    /**
+     * @return void
+     */
     public function setManagerType(string $managerType): void;
 
+    /**
+     * @return string|null
+     */
     public function getManagerType(): ?string;
 
     public function createQuery(): ProxyQueryInterface;
@@ -132,6 +180,9 @@ 
      */
     public function getSecurityInformation(): array;
 
+    /**
+     * @return void
+     */
     public function setParentFieldDescription(FieldDescriptionInterface $parentFieldDescription): void;
 
     public function getParentFieldDescription(): FieldDescriptionInterface;
@@ -151,8 +202,14 @@ 
      */
     public function hasRoute(string $name): bool;
 
+    /**
+     * @return void
+     */
     public function setSecurityHandler(SecurityHandlerInterface $securityHandler): void;
 
+    /**
+     * @return SecurityHandlerInterface
+     */
     public function getSecurityHandler(): ?SecurityHandlerInterface;
 
     public function isGranted(string $name, ?object $object = null): bool;
@@ -164,17 +221,25 @@ 
 
     /**
      * Shorthand method for templating.
+     * @return string
      */
     public function id(object $model): ?string;
 
+    /**
+     * @return void
+     */
     public function setValidator(ValidatorInterface $validator): void;
 
+    /**
+     * @return ValidatorInterface|null
+     */
     public function getValidator(): ?ValidatorInterface;
 
     public function getShow(): FieldDescriptionCollection;
 
     /**
      * @param string[] $formTheme
+     * @return void
      */
     public function setFormTheme(array $formTheme): void;
 
@@ -187,6 +252,7 @@ 
 
     /**
      * @param string[] $filterTheme
+     * @return void
      */
     public function setFilterTheme(array $filterTheme): void;
 
@@ -195,6 +261,9 @@ 
      */
     public function getFilterTheme(): array;
 
+    /**
+     * @return void
+     */
     public function addExtension(AdminExtensionInterface $extension): void;
 
     /**
@@ -204,14 +273,26 @@ 
      */
     public function getExtensions(): array;
 
+    /**
+     * @return void
+     */
     public function setRouteBuilder(RouteBuilderInterface $routeBuilder): void;
 
+    /**
+     * @return RouteBuilderInterface|null
+     */
     public function getRouteBuilder(): ?RouteBuilderInterface;
 
     public function toString(?object $object): string;
 
+    /**
+     * @return void
+     */
     public function setLabelTranslatorStrategy(LabelTranslatorStrategyInterface $labelTranslatorStrategy): void;
 
+    /**
+     * @return LabelTranslatorStrategyInterface
+     */
     public function getLabelTranslatorStrategy(): ?LabelTranslatorStrategyInterface;
 
     /**
@@ -223,6 +304,9 @@ 
 
     public function getNewInstance(): object;
 
+    /**
+     * @return void
+     */
     public function setUniqid(string $uniqId): void;
 
     public function getUniqid(): string;
@@ -234,6 +318,9 @@ 
      */
     public function getObject($id): ?object;
 
+    /**
+     * @return void
+     */
     public function setSubject(?object $subject): void;
 
     public function getSubject(): object;
@@ -258,6 +345,7 @@ 
      * Call before the batch action, allow you to alter the query and the idx.
      *
      * @param mixed[] $idx
+     * @return void
      */
     public function preBatchAction(string $actionName, ProxyQueryInterface $query, array &$idx, bool $allElements = false): void;
 
@@ -278,6 +366,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 $object): void;
 
@@ -285,11 +374,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;
 
     /**
@@ -297,6 +390,9 @@ 
      */
     public function isChild(): bool;
 
+    /**
+     * @return void
+     */
     public function setTranslationDomain(string $translationDomain): void;
 
     public function getTranslationDomain(): string;
@@ -308,6 +404,7 @@ 
 
     /**
      * @param array<string, mixed> $formGroups
+     * @return void
      */
     public function setFormGroups(array $formGroups): void;
 
@@ -318,6 +415,7 @@ 
 
     /**
      * @param array<string, mixed> $formTabs
+     * @return void
      */
     public function setFormTabs(array $formTabs): void;
 
@@ -328,9 +426,13 @@ 
 
     /**
      * @param array<string, mixed> $showTabs
+     * @return void
      */
     public function setShowTabs(array $showTabs): void;
 
+    /**
+     * @return void
+     */
     public function removeFieldFromFormGroup(string $key): void;
 
     /**
@@ -340,6 +442,7 @@ 
 
     /**
      * @param array<string, mixed> $showGroups
+     * @return void
      */
     public function setShowGroups(array $showGroups): void;
 
@@ -347,6 +450,7 @@ 
      * Reorder items in showGroup.
      *
      * @param string[] $keys
+     * @return void
      */
     public function reorderShowGroup(string $group, array $keys): void;
 
@@ -366,6 +470,7 @@ 
      * Sets the list of supported sub classes.
      *
      * @param array<string, class-string> $subClasses
+     * @return void
      */
     public function setSubClasses(array $subClasses): void;
 
@@ -398,6 +503,7 @@ 
 
     /**
      * Returns Admin`s label.
+     * @return string|null
      */
     public function getLabel(): ?string;
 
@@ -415,6 +521,7 @@ 
 
     /**
      * Set the current child status.
+     * @return void
      */
     public function setCurrentChild(bool $currentChild): void;
 
@@ -435,6 +542,9 @@ 
      */
     public function getListModes(): array;
 
+    /**
+     * @return void
+     */
     public function setListMode(string $mode): void;
 
     /**
@@ -463,12 +573,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;
 
@@ -494,6 +606,9 @@ 
      */
     public function getRootCode(): string;
 
+    /**
+     * @return void
+     */
     public function setFilterPersister(?FilterPersisterInterface $filterPersister = null): void;
 
     /**
@@ -506,14 +621,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;
 
@@ -525,12 +650,14 @@ 
 
     /**
      * @param string[] $keys
+     * @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/BaseFieldDescription.php

Doc Comments +9 added lines

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

src/Admin/FieldDescriptionInterface.php

Doc Comments +30 added lines

@@ -18,14 +18,24 @@ 
  */
 interface FieldDescriptionInterface
 {
+    /**
+     * @return void
+     */
     public function setFieldName(?string $fieldName): void;
 
+    /**
+     * @return string|null
+     */
     public function getFieldName(): ?string;
 
+    /**
+     * @return void
+     */
     public function setName(?string $name): void;
 
     /**
      * Returns the name, the name can be used as a form label or table header.
+     * @return string|null
      */
     public function getName(): ?string;
 
@@ -42,6 +52,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;
 
@@ -53,6 +64,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;
 
@@ -65,21 +77,31 @@ 
 
     /**
      * Sets the template used to render the field.
+     * @param string $template
+     * @return void
      */
     public function setTemplate(?string $template): void;
 
+    /**
+     * @return string|null
+     */
     public function getTemplate(): ?string;
 
     /**
      * 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;
 
+    /**
+     * @return string|null
+     */
     public function getType(): ?string;
 
     /**
      * set the parent Admin (only used in nested admin).
+     * @return void
      */
     public function setParent(AdminInterface $parent): void;
 
@@ -108,6 +130,7 @@ 
 
     /**
      * Returns the related Target object model.
+     * @return string
      */
     public function getTargetModel(): ?string;
 
@@ -141,6 +164,7 @@ 
 
     /**
      * Set the association admin instance (only used if the field is linked to an Admin).
+     * @return void
      */
     public function setAssociationAdmin(AdminInterface $associationAdmin): void;
 
@@ -165,6 +189,9 @@ 
      */
     public function getValue(object $object);
 
+    /**
+     * @return void
+     */
     public function setAdmin(AdminInterface $admin): void;
 
     /**
@@ -180,6 +207,7 @@ 
      * @param array<string, mixed> $options
      *
      * @throws \RuntimeException
+     * @return void
      */
     public function mergeOption(string $name, array $options = []): void;
 
@@ -187,6 +215,7 @@ 
      * Merge options values.
      *
      * @param array<string, mixed> $options
+     * @return void
      */
     public function mergeOptions(array $options = []): void;
 
@@ -194,6 +223,7 @@ 
      * set the original mapping type (only used if the field is linked to an entity).
      *
      * @param int|string $mappingType
+     * @return void
      */
     public function setMappingType($mappingType): void;
 

src/Admin/Pool.php

Doc Comments +1 added lines

@@ -67,6 +67,7 @@
 
     /**
      * @param array<string, mixed> $options
+     * @param PropertyAccessorInterface $propertyAccessor
      */
     public function __construct(
         ContainerInterface $container,