Add missing type hints and adjust PHPDoc annotations

Author: Arkounay

Attribute/Crud.php

@@ -10,7 +10,7 @@
     final public const FETCH_MANUAL = 'manual';
 
     /**
-     * @var string auto|manual
+     * @var 'auto'|'manual'|null
      * Check if fields should be fetched automatically or manually
      */
     public ?string $fetchMode;

Attribute/Field.php

@@ -6,6 +6,9 @@
 readonly class Field
 {
 
+    /**
+     * @param array<string, mixed> $options
+     */
     public function __construct(
         public ?string $label = null,
         public ?string $twigName = null,
@@ -20,4 +23,4 @@ public function __construct(
         public mixed $payload = null
     ) {}
 
-}
+}

Controller/Crud.php

@@ -64,8 +64,10 @@ abstract class Crud extends AbstractController
     /** @var EntityRepository<T>  */
     protected EntityRepository $repository;
 
+    /** @var Fields<T> */
     protected Fields $fields;
 
+    /** @var Filters<T> */
     protected Filters $filters;
 
     /** If the Crud is active and fully loaded */
@@ -332,7 +334,7 @@ public function toggleBooleanPostAction(Request $request, $entity): Response
         if (!$this->isEditableBoolean($entity)) {
             throw $this->createAccessDeniedException("Entity {$this->getEntity()} cannot be edited (boolean).");
         }
-        
+
         $index = $request->request->get('index');
         $value = $request->request->getBoolean('checked');
         $propertyAccessor = PropertyAccess::createPropertyAccessor();
@@ -661,6 +663,7 @@ protected function createNew(): object
 
     /**
      * Overrides a form type. By default, forms are created using a custom formBuilder.
+     * @param T $entity
      */
     protected function overrideFormType($entity, bool $creation): ?string
     {
@@ -770,6 +773,8 @@ protected function getFieldFetchMode(): string
 
     /**
      * Fields that will be used to display the list of entities.
+     *
+     * @return Fields<T>
      */
     protected function getListingFields(): Fields
     {
@@ -778,6 +783,8 @@ protected function getListingFields(): Fields
 
     /**
      * Fields that will be used to display the detail of an entity.
+     *
+     * @return Fields<T>
      */
     protected function getViewFields(): Fields
     {
@@ -786,6 +793,8 @@ protected function getViewFields(): Fields
 
     /**
      * Fields that will be used for the export of an entity.
+     *
+     * @return Fields<T>
      */
     protected function getExportFields(): Fields
     {
@@ -794,12 +803,17 @@ protected function getExportFields(): Fields
 
     /**
      * Fields that will be used to automatically generate the form in the create / edit actions.
+     *
+     * @return Fields<T>
      */
     protected function getFormFields(): Fields
     {
         return clone $this->fields->filter(static fn(Field $field) => $field->isDisplayedInForm());
     }
 
+    /**
+     * @return Filters<T>
+     */
     protected function getFilters(): Filters
     {
         return $this->filters;
@@ -823,6 +837,8 @@ public function load(Request $request): void
 
     /**
      * Creates a Fields object without any field by default
+     *
+     * @return Fields<T>
      */
     protected function createFields(): Fields
     {
@@ -831,6 +847,8 @@ protected function createFields(): Fields
 
     /**
      * Creates a Fields object with default fields
+     *
+     * @return Fields<T>
      */
     protected function createFieldsFromMetadata(): Fields
     {
@@ -869,6 +887,9 @@ protected function createFieldsFromMetadata(): Fields
         return $fields;
     }
 
+    /**
+     * @return Filters<T>
+     */
     final protected function createFilters(): Filters
     {
         return new Filters($this->metadata, $this->fieldService);
@@ -967,6 +988,7 @@ protected function createFilterForm(): FormBuilderInterface
     /**
      * All the actions that will generate Routes.
      * Every functions that end with "Actions" will be considered as an Action and thus, a new route will be automatically created.
+     * @return array<string>
      */
     public function getAllActions(): array
     {
@@ -983,7 +1005,7 @@ public function getAllActions(): array
 
     /**
      * Finds the entity from an id.
-     * @return T
+     * @return T|null
      */
     public function guessEntity()
     {
@@ -1003,11 +1025,12 @@ public function getDescription(): string
     }
 
     /**
-     * The default paginations options. Used to add a default sorting on the listing page.
+     * The default pagination options. Used to add a default sorting on the listing page.
+     * @param Fields<T> $fields
+     * @return array<string, string>
      */
     protected function getPaginationOptions(Fields $fields): array
     {
-        /** @var Fields|Field[] $fields */
         foreach ($fields as $field) {
             if ($field->getDefaultSortDirection() !== null) {
                 return ['defaultSortFieldName' => 'e.' . $field->getIndex(), 'defaultSortDirection' => $field->getDefaultSortDirection()];
@@ -1028,7 +1051,7 @@ protected function getPaginationOptions(Fields $fields): array
     /**
      * True by default
      * If true, the responsive mode will be simplified, there won't be a table but a simple list that will display entity's toString().
-     * This removes batch actions and fields informations.
+     * This removes batch actions and fields information.
      * Return false to use a responsive table with more data instead.
      */
     protected function simpleResponsiveMode(): bool
@@ -1063,6 +1086,9 @@ protected function backUrl(): string
         return $this->generateUrl('qag.' . $this->getRoute(), $this->getListRouteParams());
     }
 
+    /**
+     * @return array<string, mixed>
+     */
     protected function getListRouteParams(): array
     {
         $params = array_merge($this->request->query->all(), $this->request->get('referer', []));
@@ -1072,6 +1098,7 @@ protected function getListRouteParams(): array
 
     /**
      * Checks if there are actions to display in the page, so the last column can be removed if there are not.
+     * @param array<int, Actions<int|string>> $actionEntities
      */
     protected function hasActions(array $actionEntities): bool
     {
@@ -1096,6 +1123,7 @@ protected function hasQuickListQueryBuilderSecurity(): bool
 
     /**
      * Used to check if the entity is a part of the getListQueryBuilder
+     * @param T $entity
      */
     protected function entityIsInList($entity): bool
     {
@@ -1108,6 +1136,8 @@ protected function entityIsInList($entity): bool
 
     /**
      * Allows params overriding before twig rendering
+     * @param array<string, mixed> $params
+     * @return array<string, mixed>
      */
     protected function retrieveParams(string $action, array $params): array
     {
@@ -1118,6 +1148,9 @@ protected function retrieveParams(string $action, array $params): array
         ], $params);
     }
 
+    /**
+     * @return array{0: bool, 1: string|null, 2: \Symfony\Component\Form\FormInterface|null, 3: int}
+     */
     protected function applySearchAndFiltersQueryBuilder(Request $request, QueryBuilder $queryBuilder): array
     {
         $isSearchable = $this->isSearchable();

Model/Action.php

@@ -46,14 +46,14 @@ public function setLabel(?string $label): self
         return $this;
     }
 
+    /**
+     * @return string[]
+     */
     public function getClasses(): array
     {
         return $this->classes;
     }
 
-    /**
-     * @param string[] $classes
-     */
     public function addSharedClasses(string ...$classes): self
     {
         foreach ($classes as $class) {
@@ -64,9 +64,6 @@ public function addSharedClasses(string ...$classes): self
         return $this;
     }
 
-    /**
-     * @param string[] $classes
-     */
     public function addClasses(string ...$classes): self
     {
         $this->classes = array_merge($this->classes, $classes);
@@ -93,16 +90,25 @@ public function removeClass(string $class): self
     }
 
 
+    /**
+     * @return string[]
+     */
     public function getDropdownClasses(): array
     {
         return $this->dropdownClasses;
     }
 
-    public function getAttributes(): ?array
+    /**
+     * @return string[]
+     */
+    public function getAttributes(): array
     {
         return $this->attributes;
     }
 
+    /**
+     * @param string[] $attributes
+     */
     public function setAttributes(array $attributes): self
     {
         $this->attributes = $attributes;
@@ -120,6 +126,9 @@ public function addAttribute(string $key, string $content): self
         return $this;
     }
 
+    /**
+     * @param string[] $attributes
+     */
     public function addAttributes(array $attributes): self
     {
         $this->attributes = array_merge($this->attributes, $attributes);
@@ -131,9 +140,6 @@ public function setModal(Modal $modal): void
         $this->attributes = array_merge($this->attributes, $modal->toAttributes());
     }
 
-    /**
-     * @param string[] $classes
-     */
     public function addDropDownClasses(string ...$classes): self
     {
         $this->dropdownClasses = array_merge($this->dropdownClasses, $classes);
@@ -183,4 +189,4 @@ public function setIcon(?string $icon): self
         return $this;
     }
 
-}
+}

Model/Actions.php

@@ -6,6 +6,8 @@
 use function Symfony\Component\String\u;
 
 /**
+ * @template TKey of array-key
+ * @template-extends TypedArray<TKey, Action>
  * @method Action get(string $field)
  */
 class Actions extends TypedArray

Model/Field.php

@@ -11,10 +11,7 @@
 class Field implements Listable
 {
 
-    /**
-     * @var string
-     */
-    protected $index;
+    protected string $index;
 
     /**
      * @var string
@@ -82,7 +79,7 @@ class Field implements Listable
     protected $formType;
 
     /**
-     * @var array
+     * @var array<string, mixed>
      */
     protected $options = [];
 
@@ -264,11 +261,17 @@ public function setFormType(?string $formType): self
         return $this;
     }
 
+    /**
+     * @return array<string, mixed>
+     */
     public function getOptions(): array
     {
         return $this->options;
     }
 
+    /**
+     * @param array<string, mixed> $options
+     */
     public function setOptions(array $options): self
     {
         $this->options = $options;
@@ -332,16 +335,25 @@ public function setPosition(?int $position): void
         $this->position = $position;
     }
 
-    public function getPayload()
+    /**
+     * @return mixed
+     */
+    public function getPayload(): mixed
     {
         return $this->payload;
     }
 
-    public function setPayload($payload): void
+    /**
+     * @param mixed $payload
+     */
+    public function setPayload(mixed $payload): void
     {
         $this->payload = $payload;
     }
 
+    /**
+     * @return array<string, mixed>
+     */
     public function guessFormOptions(): array
     {
         $options = ['label' => $this->getLabel(), 'required' => $this->isRequired()];
@@ -394,11 +406,11 @@ public function guessFormType(): ?string
         return match ($this->getType()) {
             'decimal' => TextType::class,
             'enum' => EnumType::class,
-            'date' => $this->getFormType() ?? DateType::class,
-            'datetime_immutable', 'datetime' => $this->getFormType() ?? DateTimeType::class,
-            'relation_to_many', 'relation' => $this->getFormType() ?? EntityType::class,
+            'date' => DateType::class,
+            'datetime_immutable', 'datetime' => DateTimeType::class,
+            'relation_to_many', 'relation' => EntityType::class,
             default => null,
         };
     }
 
-}
+}