vendor/easycorp/easyadmin-bundle/src/Configuration/MetadataConfigPass.php line 29

Open in your IDE?
  1. <?php
  3. namespace EasyCorp\Bundle\EasyAdminBundle\Configuration;
  5. use Doctrine\Common\Persistence\ManagerRegistry;
  6. use Doctrine\ORM\Mapping\ClassMetadata;
  7. use Symfony\Component\Config\Definition\Exception\InvalidTypeException;
  9. /**
  10.  * Introspects the metadata of the Doctrine entities to complete the
  11.  * configuration of the properties.
  12.  *
  13.  * @author Javier Eguiluz <javier.eguiluz@gmail.com>
  14.  */
  15. class MetadataConfigPass implements ConfigPassInterface
  16. {
  17.     /** @var ManagerRegistry */
  18.     private $doctrine;
  20.     public function __construct(ManagerRegistry $doctrine)
  21.     {
  22.         $this->doctrine = $doctrine;
  23.     }
  25.     public function process(array $backendConfig)
  26.     {
  27.         foreach ($backendConfig['entities'] as $entityName => $entityConfig) {
  28.             try {
  29.                 $em = $this->doctrine->getManagerForClass($entityConfig['class']);
  30.             } catch (\ReflectionException $e) {
  31.                 throw new InvalidTypeException(sprintf('The configured class "%s" for the path "easy_admin.entities.%s" does not exist. Did you forget to create the entity class or to define its namespace?', $entityConfig['class'], $entityName));
  32.             }
  34.             if (null === $em) {
  35.                 throw new InvalidTypeException(sprintf('The configured class "%s" for the path "easy_admin.entities.%s" is no mapped entity.', $entityConfig['class'], $entityName));
  36.             }
  38.             $entityMetadata = $em->getMetadataFactory()->getMetadataFor($entityConfig['class']);
  40.             $entityConfig['primary_key_field_name'] = $entityMetadata->getSingleIdentifierFieldName();
  42.             $entityConfig['properties'] = $this->processEntityPropertiesMetadata($entityMetadata);
  44.             $backendConfig['entities'][$entityName] = $entityConfig;
  45.         }
  47.         return $backendConfig;
  48.     }
  50.     /**
  51.      * Takes the entity metadata introspected via Doctrine and completes its
  52.      * contents to simplify data processing for the rest of the application.
  53.      *
  54.      * @param ClassMetadata $entityMetadata The entity metadata introspected via Doctrine
  55.      *
  56.      * @return array The entity properties metadata provided by Doctrine
  57.      *
  58.      * @throws \RuntimeException
  59.      */
  60.     private function processEntityPropertiesMetadata(ClassMetadata $entityMetadata)
  61.     {
  62.         $entityPropertiesMetadata = [];
  64.         if ($entityMetadata->isIdentifierComposite) {
  65.             throw new \RuntimeException(sprintf("The '%s' entity isn't valid because it contains a composite primary key.", $entityMetadata->name));
  66.         }
  68.         // introspect regular entity fields
  69.         foreach ($entityMetadata->fieldMappings as $fieldName => $fieldMetadata) {
  70.             $entityPropertiesMetadata[$fieldName] = $fieldMetadata;
  71.         }
  73.         // introspect fields for entity associations
  74.         foreach ($entityMetadata->associationMappings as $fieldName => $associationMetadata) {
  75.             $entityPropertiesMetadata[$fieldName] = array_merge($associationMetadata, [
  76.                 'type' => 'association',
  77.                 'associationType' => $associationMetadata['type'],
  78.             ]);
  80.             // associations different from *-to-one cannot be sorted
  81.             if ($associationMetadata['type'] & ClassMetadata::TO_MANY) {
  82.                 $entityPropertiesMetadata[$fieldName]['sortable'] = false;
  83.             }
  84.         }
  86.         return $entityPropertiesMetadata;
  87.     }
  88. }