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

  1. <?php
  3. namespace EasyCorp\Bundle\EasyAdminBundle\Factory;
  5. use Doctrine\ORM\Mapping\ClassMetadata;
  6. use Doctrine\Persistence\ManagerRegistry;
  7. use Doctrine\Persistence\ObjectManager;
  8. use Doctrine\Persistence\Proxy;
  9. use EasyCorp\Bundle\EasyAdminBundle\Collection\ActionCollection;
  10. use EasyCorp\Bundle\EasyAdminBundle\Collection\EntityCollection;
  11. use EasyCorp\Bundle\EasyAdminBundle\Collection\FieldCollection;
  12. use EasyCorp\Bundle\EasyAdminBundle\Dto\ActionConfigDto;
  13. use EasyCorp\Bundle\EasyAdminBundle\Dto\EntityDto;
  14. use EasyCorp\Bundle\EasyAdminBundle\Event\AfterEntityBuiltEvent;
  15. use EasyCorp\Bundle\EasyAdminBundle\Exception\EntityNotFoundException;
  16. use EasyCorp\Bundle\EasyAdminBundle\Security\Permission;
  17. use Symfony\Component\ExpressionLanguage\Expression;
  18. use Symfony\Component\Security\Core\Authorization\AuthorizationCheckerInterface;
  19. use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
  21. /**
  22.  * @author Javier Eguiluz <javier.eguiluz@gmail.com>
  23.  */
  24. final class EntityFactory
  25. {
  26.     private FieldFactory $fieldFactory;
  27.     private ActionFactory $actionFactory;
  28.     private AuthorizationCheckerInterface $authorizationChecker;
  29.     private ManagerRegistry $doctrine;
  30.     private EventDispatcherInterface $eventDispatcher;
  32.     public function __construct(FieldFactory $fieldFactory, ActionFactory $actionFactory, AuthorizationCheckerInterface $authorizationChecker, ManagerRegistry $doctrine, EventDispatcherInterface $eventDispatcher)
  33.     {
  34.         $this->fieldFactory = $fieldFactory;
  35.         $this->actionFactory = $actionFactory;
  36.         $this->authorizationChecker = $authorizationChecker;
  37.         $this->doctrine = $doctrine;
  38.         $this->eventDispatcher = $eventDispatcher;
  39.     }
  41.     public function processFields(EntityDto $entityDto, FieldCollection $fields): void
  42.     {
  43.         $this->fieldFactory->processFields($entityDto, $fields);
  44.     }
  46.     public function processFieldsForAll(EntityCollection $entities, FieldCollection $fields): void
  47.     {
  48.         foreach ($entities as $entity) {
  49.             $this->processFields($entity, clone $fields);
  50.             $entities->set($entity);
  51.         }
  52.     }
  54.     public function processActions(EntityDto $entityDto, ActionConfigDto $actionConfigDto): void
  55.     {
  56.         $this->actionFactory->processEntityActions($entityDto, $actionConfigDto);
  57.     }
  59.     public function processActionsForAll(EntityCollection $entities, ActionConfigDto $actionConfigDto): ActionCollection
  60.     {
  61.         foreach ($entities as $entity) {
  62.             $this->processActions($entity, clone $actionConfigDto);
  63.         }
  65.         return $this->actionFactory->processGlobalActions($actionConfigDto);
  66.     }
  68.     public function create(string $entityFqcn, $entityId = null, string|Expression|null $entityPermission = null): EntityDto
  69.     {
  70.         return $this->doCreate($entityFqcn, $entityId, $entityPermission);
  71.     }
  73.     public function createForEntityInstance($entityInstance): EntityDto
  74.     {
  75.         return $this->doCreate(null, null, null, $entityInstance);
  76.     }
  78.     public function createCollection(EntityDto $entityDto, ?iterable $entityInstances): EntityCollection
  79.     {
  80.         $entityDtos = [];
  82.         foreach ($entityInstances as $entityInstance) {
  83.             $newEntityDto = $entityDto->newWithInstance($entityInstance);
  84.             $newEntityId = $newEntityDto->getPrimaryKeyValueAsString();
  85.             if (!$this->authorizationChecker->isGranted(Permission::EA_ACCESS_ENTITY, $newEntityDto)) {
  86.                 $newEntityDto->markAsInaccessible();
  87.             }
  89.             $entityDtos[$newEntityId] = $newEntityDto;
  90.         }
  92.         return EntityCollection::new($entityDtos);
  93.     }
  95.     public function getEntityMetadata(string $entityFqcn): ClassMetadata
  96.     {
  97.         $entityManager = $this->getEntityManager($entityFqcn);
  98.         /** @var ClassMetadata $entityMetadata */
  99.         $entityMetadata = $entityManager->getClassMetadata($entityFqcn);
  101.         if (1 !== \count($entityMetadata->getIdentifierFieldNames())) {
  102.             throw new \RuntimeException(sprintf('EasyAdmin does not support Doctrine entities with composite primary keys (such as the ones used in the "%s" entity).', $entityFqcn));
  103.         }
  105.         return $entityMetadata;
  106.     }
  108.     private function doCreate(?string $entityFqcn = null, $entityId = null, string|Expression|null $entityPermission = null, $entityInstance = null): EntityDto
  109.     {
  110.         if (null === $entityInstance && null !== $entityFqcn) {
  111.             $entityInstance = null === $entityId ? null : $this->getEntityInstance($entityFqcn, $entityId);
  112.         }
  114.         if (null !== $entityInstance && null === $entityFqcn) {
  115.             if ($entityInstance instanceof Proxy) {
  116.                 $entityInstance->__load();
  117.             }
  119.             $entityFqcn = $this->getRealClass($entityInstance::class);
  120.         }
  122.         $entityMetadata = $this->getEntityMetadata($entityFqcn);
  123.         $entityDto = new EntityDto($entityFqcn, $entityMetadata, $entityPermission, $entityInstance);
  125.         if (!$this->authorizationChecker->isGranted(Permission::EA_ACCESS_ENTITY, $entityDto)) {
  126.             $entityDto->markAsInaccessible();
  127.         }
  129.         $this->eventDispatcher->dispatch(new AfterEntityBuiltEvent($entityDto));
  131.         return $entityDto;
  132.     }
  134.     private function getEntityManager(string $entityFqcn): ObjectManager
  135.     {
  136.         if (null === $entityManager = $this->doctrine->getManagerForClass($entityFqcn)) {
  137.             throw new \RuntimeException(sprintf('There is no Doctrine Entity Manager defined for the "%s" class', $entityFqcn));
  138.         }
  140.         return $entityManager;
  141.     }
  143.     private function getEntityInstance(string $entityFqcn, $entityIdValue): object
  144.     {
  145.         $entityManager = $this->getEntityManager($entityFqcn);
  146.         if (null === $entityInstance = $entityManager->getRepository($entityFqcn)->find($entityIdValue)) {
  147.             $entityIdName = $entityManager->getClassMetadata($entityFqcn)->getIdentifierFieldNames()[0];
  149.             throw new EntityNotFoundException(['entity_name' => $entityFqcn, 'entity_id_name' => $entityIdName, 'entity_id_value' => $entityIdValue]);
  150.         }
  152.         return $entityInstance;
  153.     }
  155.     /**
  156.      * Code copied from Symfony\Bridge\Doctrine\Form\DoctrineOrmTypeGuesser
  157.      * because Doctrine ORM 3.x removed the ClassUtil class where this method was defined
  158.      * (c) Fabien Potencier <fabien@symfony.com> - MIT License.
  159.      */
  160.     private function getRealClass(string $class): string
  161.     {
  162.         if (false === $pos = strrpos($class, '\\'.Proxy::MARKER.'\\')) {
  163.             return $class;
  164.         }
  166.         return substr($class, $pos + Proxy::MARKER_LENGTH + 2);
  167.     }
  168. }