sonata-project / SonataAdminBundle

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,