vendor/easycorp/easyadmin-bundle/src/Factory/EntityFactory.php line 71

  1. <?php
  3. namespace EasyCorp\Bundle\EasyAdminBundle\Factory;
  5. use Doctrine\Common\Util\ClassUtils;
  6. use Doctrine\ORM\Mapping\ClassMetadataInfo;
  7. use Doctrine\Persistence\ManagerRegistry;
  8. use Doctrine\Persistence\Mapping\ClassMetadata;
  9. use Doctrine\Persistence\ObjectManager;
  10. use Doctrine\Persistence\Proxy;
  11. use EasyCorp\Bundle\EasyAdminBundle\Collection\ActionCollection;
  12. use EasyCorp\Bundle\EasyAdminBundle\Collection\EntityCollection;
  13. use EasyCorp\Bundle\EasyAdminBundle\Collection\FieldCollection;
  14. use EasyCorp\Bundle\EasyAdminBundle\Dto\ActionConfigDto;
  15. use EasyCorp\Bundle\EasyAdminBundle\Dto\EntityDto;
  16. use EasyCorp\Bundle\EasyAdminBundle\Event\AfterEntityBuiltEvent;
  17. use EasyCorp\Bundle\EasyAdminBundle\Exception\EntityNotFoundException;
  18. use EasyCorp\Bundle\EasyAdminBundle\Security\Permission;
  19. use Symfony\Component\Security\Core\Authorization\AuthorizationCheckerInterface;
  20. use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
  22. /**
  23.  * @author Javier Eguiluz <javier.eguiluz@gmail.com>
  24.  */
  25. final class EntityFactory
  26. {
  27.     private FieldFactory $fieldFactory;
  28.     private ActionFactory $actionFactory;
  29.     private AuthorizationCheckerInterface $authorizationChecker;
  30.     private ManagerRegistry $doctrine;
  31.     private EventDispatcherInterface $eventDispatcher;
  33.     public function __construct(FieldFactory $fieldFactory, ActionFactory $actionFactory, AuthorizationCheckerInterface $authorizationChecker, ManagerRegistry $doctrine, EventDispatcherInterface $eventDispatcher)
  34.     {
  35.         $this->fieldFactory = $fieldFactory;
  36.         $this->actionFactory = $actionFactory;
  37.         $this->authorizationChecker = $authorizationChecker;
  38.         $this->doctrine = $doctrine;
  39.         $this->eventDispatcher = $eventDispatcher;
  40.     }
  42.     public function processFields(EntityDto $entityDto, FieldCollection $fields): void
  43.     {
  44.         $this->fieldFactory->processFields($entityDto, $fields);
  45.     }
  47.     public function processFieldsForAll(EntityCollection $entities, FieldCollection $fields): void
  48.     {
  49.         foreach ($entities as $entity) {
  50.             $this->processFields($entity, clone $fields);
  51.             $entities->set($entity);
  52.         }
  53.     }
  55.     public function processActions(EntityDto $entityDto, ActionConfigDto $actionConfigDto): void
  56.     {
  57.         $this->actionFactory->processEntityActions($entityDto, $actionConfigDto);
  58.     }
  60.     public function processActionsForAll(EntityCollection $entities, ActionConfigDto $actionConfigDto): ActionCollection
  61.     {
  62.         foreach ($entities as $entity) {
  63.             $this->processActions($entity, clone $actionConfigDto);
  64.         }
  66.         return $this->actionFactory->processGlobalActions($actionConfigDto);
  67.     }
  69.     public function create(string $entityFqcn, $entityId = null, ?string $entityPermission = null): EntityDto
  70.     {
  71.         return $this->doCreate($entityFqcn, $entityId, $entityPermission);
  72.     }
  74.     public function createForEntityInstance($entityInstance): EntityDto
  75.     {
  76.         return $this->doCreate(null, null, null, $entityInstance);
  77.     }
  79.     public function createCollection(EntityDto $entityDto, ?iterable $entityInstances): EntityCollection
  80.     {
  81.         $entityDtos = [];
  83.         foreach ($entityInstances as $entityInstance) {
  84.             $newEntityDto = $entityDto->newWithInstance($entityInstance);
  85.             $newEntityId = $newEntityDto->getPrimaryKeyValueAsString();
  86.             if (!$this->authorizationChecker->isGranted(Permission::EA_ACCESS_ENTITY, $newEntityDto)) {
  87.                 $newEntityDto->markAsInaccessible();
  88.             }
  90.             $entityDtos[$newEntityId] = $newEntityDto;
  91.         }
  93.         return EntityCollection::new($entityDtos);
  94.     }
  96.     /**
  97.      * @return ClassMetadata&ClassMetadataInfo
  98.      */
  99.     public function getEntityMetadata(string $entityFqcn): ClassMetadata
  100.     {
  101.         $entityManager = $this->getEntityManager($entityFqcn);
  102.         /** @var ClassMetadata&ClassMetadataInfo $entityMetadata */
  103.         $entityMetadata = $entityManager->getClassMetadata($entityFqcn);
  105.         if (1 !== \count($entityMetadata->getIdentifierFieldNames())) {
  106.             throw new \RuntimeException(sprintf('EasyAdmin does not support Doctrine entities with composite primary keys (such as the ones used in the "%s" entity).', $entityFqcn));
  107.         }
  109.         return $entityMetadata;
  110.     }
  112.     private function doCreate(?string $entityFqcn = null, $entityId = null, ?string $entityPermission = null, $entityInstance = null): EntityDto
  113.     {
  114.         if (null === $entityInstance && null !== $entityFqcn) {
  115.             $entityInstance = null === $entityId ? null : $this->getEntityInstance($entityFqcn, $entityId);
  116.         }
  118.         if (null !== $entityInstance && null === $entityFqcn) {
  119.             if ($entityInstance instanceof Proxy) {
  120.                 $entityInstance->__load();
  121.             }
  123.             $entityFqcn = ClassUtils::getClass($entityInstance);
  124.         }
  126.         $entityMetadata = $this->getEntityMetadata($entityFqcn);
  127.         $entityDto = new EntityDto($entityFqcn, $entityMetadata, $entityPermission, $entityInstance);
  129.         if (!$this->authorizationChecker->isGranted(Permission::EA_ACCESS_ENTITY, $entityDto)) {
  130.             $entityDto->markAsInaccessible();
  131.         }
  133.         $this->eventDispatcher->dispatch(new AfterEntityBuiltEvent($entityDto));
  135.         return $entityDto;
  136.     }
  138.     private function getEntityManager(string $entityFqcn): ObjectManager
  139.     {
  140.         if (null === $entityManager = $this->doctrine->getManagerForClass($entityFqcn)) {
  141.             throw new \RuntimeException(sprintf('There is no Doctrine Entity Manager defined for the "%s" class', $entityFqcn));
  142.         }
  144.         return $entityManager;
  145.     }
  147.     private function getEntityInstance(string $entityFqcn, $entityIdValue): object
  148.     {
  149.         $entityManager = $this->getEntityManager($entityFqcn);
  150.         if (null === $entityInstance = $entityManager->getRepository($entityFqcn)->find($entityIdValue)) {
  151.             $entityIdName = $entityManager->getClassMetadata($entityFqcn)->getIdentifierFieldNames()[0];
  153.             throw new EntityNotFoundException(['entity_name' => $entityFqcn, 'entity_id_name' => $entityIdName, 'entity_id_value' => $entityIdValue]);
  154.         }
  156.         return $entityInstance;
  157.     }
  158. }