Add some Generics

Author: VincentLanglet

.ddev/example/Controller/Admin/BlogArticleCrudController.php

@@ -15,6 +15,9 @@
 use EasyCorp\Bundle\EasyAdminBundle\Field\TextField;
 use EasyCorp\Bundle\EasyAdminBundle\Filter\EntityFilter;
 
+/**
+ * @extends AbstractCrudController<BlogArticle>
+ */
 #[AdminCrud(routePath: '/blog-article')]
 class BlogArticleCrudController extends AbstractCrudController
 {

.ddev/example/Controller/Admin/CategoryCrudController.php

@@ -8,6 +8,9 @@
 use EasyCorp\Bundle\EasyAdminBundle\Field\AssociationField;
 use EasyCorp\Bundle\EasyAdminBundle\Field\TextField;
 
+/**
+ * @extends AbstractCrudController<Category>
+ */
 #[AdminCrud(routePath: '/category')]
 class CategoryCrudController extends AbstractCrudController
 {

doc/dashboards.rst

@@ -982,8 +982,8 @@ user locale. You can also use ``TranslatableMessage`` objects to define any text
 content in your backends (e.g. the label of some field, the help contents of
 some page, etc.)::
 
-    use function Symfony\Component\Translation\t;
     use Symfony\Component\Translation\TranslatableMessage;
+    use function Symfony\Component\Translation\t;
 
     // creating translatable messages using objects
     TextField::new('firstName', new TranslatableMessage('Name'))

src/Contracts/Controller/CrudControllerInterface.php

@@ -22,9 +22,14 @@
 
 /**
  * @author Javier Eguiluz <javier.eguiluz@gmail.com>
+ *
+ * @template TEntity of object
  */
 interface CrudControllerInterface
 {
+    /**
+     * @return class-string<TEntity>
+     */
     public static function getEntityFqcn(): string;
 
     public function configureCrud(Crud $crud): Crud;
@@ -65,10 +70,19 @@ public function createIndexQueryBuilder(SearchDto $searchDto, EntityDto $entityD
 
     public function createEntity(string $entityFqcn);
 
+    /**
+     * @param TEntity $entityInstance
+     */
     public function updateEntity(EntityManagerInterface $entityManager, $entityInstance): void;
 
+    /**
+     * @param TEntity $entityInstance
+     */
     public function persistEntity(EntityManagerInterface $entityManager, $entityInstance): void;
 
+    /**
+     * @param TEntity $entityInstance
+     */
     public function deleteEntity(EntityManagerInterface $entityManager, $entityInstance): void;
 
     public function createEditFormBuilder(EntityDto $entityDto, KeyValueStore $formOptions, AdminContext $context): FormBuilderInterface;

src/Contracts/Event/EntityLifecycleEventInterface.php

@@ -4,8 +4,13 @@
 
 /**
  * @author: Benjamin Leibinger <mail@leibinger.io>
+ *
+ * @template TEntity of object
  */
 interface EntityLifecycleEventInterface
 {
+    /**
+     * @return TEntity
+     */
     public function getEntityInstance();
 }

src/Controller/AbstractCrudController.php

@@ -65,6 +65,10 @@
 
 /**
  * @author Javier Eguiluz <javier.eguiluz@gmail.com>
+ *
+ * @template TEntity of object
+ *
+ * @implements  CrudControllerInterface<TEntity>
  */
 abstract class AbstractCrudController extends AbstractController implements CrudControllerInterface
 {

src/Dto/EntityDto.php

@@ -21,19 +21,29 @@
 
 /**
  * @author Javier Eguiluz <javier.eguiluz@gmail.com>
+ *
+ * @template TEntity of object
  */
 final class EntityDto
 {
     private bool $isAccessible = true;
+    /** @var class-string<TEntity> */
     private string $fqcn;
+    /** @var ClassMetadata<TEntity> */
     private ClassMetadata $metadata;
+    /** @var TEntity|null */
     private $instance;
     private $primaryKeyName;
     private mixed $primaryKeyValue = null;
     private string|Expression|null $permission;
     private ?FieldCollection $fields = null;
     private ?ActionCollection $actions = null;
 
+    /**
+     * @param class-string<TEntity>  $entityFqcn
+     * @param ClassMetadata<TEntity> $entityMetadata
+     * @param TEntity|null           $entityInstance
+     */
     public function __construct(string $entityFqcn, ClassMetadata $entityMetadata, string|Expression|null $entityPermission = null, /* ?object */ $entityInstance = null)
     {
         if (!\is_object($entityInstance)
@@ -61,6 +71,9 @@ public function __toString(): string
         return $this->toString();
     }
 
+    /**
+     * @return class-string<TEntity>
+     */
     public function getFqcn(): string
     {
         return $this->fqcn;
@@ -84,6 +97,9 @@ public function toString(): string
         return sprintf('%s #%s', $this->getName(), substr($this->getPrimaryKeyValueAsString(), 0, 16));
     }
 
+    /**
+     * @return TEntity|null
+     */
     public function getInstance()/* : ?object */
     {
         return $this->instance;
@@ -246,6 +262,9 @@ public function isEmbeddedClassProperty(string $propertyName): bool
         return \array_key_exists($propertyNameParts[0], $this->metadata->embeddedClasses);
     }
 
+    /**
+     * @param TEntity|null $newEntityInstance
+     */
     public function setInstance(?object $newEntityInstance): void
     {
         if (null !== $this->instance && null !== $newEntityInstance && !$newEntityInstance instanceof $this->fqcn) {
@@ -256,6 +275,9 @@ public function setInstance(?object $newEntityInstance): void
         $this->primaryKeyValue = null;
     }
 
+    /**
+     * @param TEntity $newEntityInstance
+     */
     public function newWithInstance(/* object */ $newEntityInstance): self
     {
         if (!\is_object($newEntityInstance)) {

src/Event/AbstractLifecycleEvent.php

@@ -6,11 +6,21 @@
 
 /**
  * @author: Benjamin Leibinger <mail@leibinger.io>
+ *
+ * @template TEntity of object
+ *
+ * @implements EntityLifecycleEventInterface<TEntity>
  */
 abstract class AbstractLifecycleEvent implements EntityLifecycleEventInterface
 {
+    /**
+     * @var TEntity
+     */
     protected $entityInstance;
 
+    /**
+     * @param TEntity $entityInstance
+     */
     public function __construct(/* ?object */ $entityInstance)
     {
         if (!\is_object($entityInstance)

src/Security/SecurityVoter.php

@@ -12,7 +12,7 @@
 use Symfony\Component\Security\Core\Authorization\AuthorizationCheckerInterface;
 use Symfony\Component\Security\Core\Authorization\Voter\Voter;
 
-/*
+/**
  * @author Javier Eguiluz <javier.eguiluz@gmail.com>
  */
 final class SecurityVoter extends Voter

tests/PrettyUrlsTestApplication/src/Controller/BlogPostCrudController.php

@@ -9,6 +9,9 @@
 use EasyCorp\Bundle\EasyAdminBundle\Field\TextField;
 use EasyCorp\Bundle\EasyAdminBundle\Tests\PrettyUrlsTestApplication\Entity\BlogPost;
 
+/**
+ * @extends AbstractCrudController<BlogPost>
+ */
 class BlogPostCrudController extends AbstractCrudController
 {
     public static function getEntityFqcn(): string