vendor/easycorp/easyadmin-bundle/src/Dto/EntityDto.php line 15

  1. <?php
  3. namespace EasyCorp\Bundle\EasyAdminBundle\Dto;
  5. use Doctrine\ORM\Mapping\ClassMetadataInfo;
  6. use Doctrine\Persistence\Mapping\ClassMetadata;
  7. use EasyCorp\Bundle\EasyAdminBundle\Collection\ActionCollection;
  8. use EasyCorp\Bundle\EasyAdminBundle\Collection\FieldCollection;
  9. use EasyCorp\Bundle\EasyAdminBundle\Config\KeyValueStore;
  10. use Symfony\Component\PropertyAccess\PropertyAccess;
  12. /**
  13.  * @author Javier Eguiluz <javier.eguiluz@gmail.com>
  14.  */
  15. final class EntityDto
  16. {
  17.     private bool $isAccessible = true;
  18.     private string $fqcn;
  19.     /** @var ClassMetadataInfo */
  20.     private ClassMetadata $metadata;
  21.     private $instance;
  22.     private $primaryKeyName;
  23.     private mixed $primaryKeyValue = null;
  24.     private ?string $permission;
  25.     private ?FieldCollection $fields = null;
  26.     private ?ActionCollection $actions = null;
  28.     /**
  29.      * @param ClassMetadata&ClassMetadataInfo $entityMetadata
  30.      */
  31.     public function __construct(string $entityFqcn, ClassMetadata $entityMetadata, ?string $entityPermission = null, /* ?object */ $entityInstance = null)
  32.     {
  33.         if (!\is_object($entityInstance)
  34.             && null !== $entityInstance) {
  35.             trigger_deprecation(
  36.                 'easycorp/easyadmin-bundle',
  37.                 '4.0.5',
  38.                 'Argument "%s" for "%s" must be one of these types: %s. Passing type "%s" will cause an error in 5.0.0.',
  39.                 '$entityInstance',
  40.                 __METHOD__,
  41.                 '"object" or "null"',
  42.                 \gettype($entityInstance)
  43.             );
  44.         }
  46.         $this->fqcn = $entityFqcn;
  47.         $this->metadata = $entityMetadata;
  48.         $this->instance = $entityInstance;
  49.         $this->primaryKeyName = $this->metadata->getIdentifierFieldNames()[0];
  50.         $this->permission = $entityPermission;
  51.     }
  53.     public function __toString(): string
  54.     {
  55.         return $this->toString();
  56.     }
  58.     public function getFqcn(): string
  59.     {
  60.         return $this->fqcn;
  61.     }
  63.     public function getName(): string
  64.     {
  65.         return basename(str_replace('\\', '/', $this->fqcn));
  66.     }
  68.     public function toString(): string
  69.     {
  70.         if (null === $this->instance) {
  71.             return '';
  72.         }
  74.         if (method_exists($this->instance, '__toString')) {
  75.             return (string) $this->instance;
  76.         }
  78.         return sprintf('%s #%s', $this->getName(), substr($this->getPrimaryKeyValueAsString(), 0, 16));
  79.     }
  81.     public function getInstance()/* : ?object */
  82.     {
  83.         return $this->instance;
  84.     }
  86.     public function getPrimaryKeyName(): ?string
  87.     {
  88.         return $this->primaryKeyName;
  89.     }
  91.     public function getPrimaryKeyValue(): mixed
  92.     {
  93.         if (null === $this->instance) {
  94.             return null;
  95.         }
  97.         if (null !== $this->primaryKeyValue) {
  98.             return $this->primaryKeyValue;
  99.         }
  101.         $propertyAccessor = PropertyAccess::createPropertyAccessorBuilder()
  102.             ->enableExceptionOnInvalidIndex()
  103.             ->getPropertyAccessor();
  105.         $primaryKeyValue = $propertyAccessor->getValue($this->instance, $this->primaryKeyName);
  107.         return $this->primaryKeyValue = $primaryKeyValue;
  108.     }
  110.     public function getPrimaryKeyValueAsString(): string
  111.     {
  112.         return (string) $this->getPrimaryKeyValue();
  113.     }
  115.     public function getPermission(): ?string
  116.     {
  117.         return $this->permission;
  118.     }
  120.     public function isAccessible(): bool
  121.     {
  122.         return $this->isAccessible;
  123.     }
  125.     public function markAsInaccessible(): void
  126.     {
  127.         $this->isAccessible = false;
  128.         $this->instance = null;
  129.         $this->fields = null;
  130.     }
  132.     public function getFields(): ?FieldCollection
  133.     {
  134.         return $this->fields;
  135.     }
  137.     public function setFields(FieldCollection $fields): void
  138.     {
  139.         $this->fields = $fields;
  140.     }
  142.     public function setActions(ActionCollection $actions): void
  143.     {
  144.         $this->actions = $actions;
  145.     }
  147.     public function getActions(): ActionCollection
  148.     {
  149.         return $this->actions;
  150.     }
  152.     /**
  153.      * Returns the names of all properties defined in the entity, no matter
  154.      * if they are used or not in the application.
  155.      */
  156.     public function getAllPropertyNames(): array
  157.     {
  158.         return $this->metadata->getFieldNames();
  159.     }
  161.     public function getPropertyMetadata(string $propertyName): KeyValueStore
  162.     {
  163.         if (\array_key_exists($propertyName, $this->metadata->fieldMappings)) {
  164.             return KeyValueStore::new($this->metadata->fieldMappings[$propertyName]);
  165.         }
  167.         if (\array_key_exists($propertyName, $this->metadata->associationMappings)) {
  168.             return KeyValueStore::new($this->metadata->associationMappings[$propertyName]);
  169.         }
  171.         throw new \InvalidArgumentException(sprintf('The "%s" field does not exist in the "%s" entity.', $propertyName, $this->getFqcn()));
  172.     }
  174.     public function getPropertyDataType(string $propertyName)
  175.     {
  176.         return $this->getPropertyMetadata($propertyName)->get('type');
  177.     }
  179.     public function hasProperty(string $propertyName): bool
  180.     {
  181.         return \array_key_exists($propertyName, $this->metadata->fieldMappings)
  182.             || \array_key_exists($propertyName, $this->metadata->associationMappings);
  183.     }
  185.     public function isAssociation(string $propertyName): bool
  186.     {
  187.         return \array_key_exists($propertyName, $this->metadata->associationMappings)
  188.             || (str_contains($propertyName, '.') && !$this->isEmbeddedClassProperty($propertyName));
  189.     }
  191.     public function isToOneAssociation(string $propertyName): bool
  192.     {
  193.         $associationType = $this->getPropertyMetadata($propertyName)->get('type');
  195.         return \in_array($associationType, [ClassMetadataInfo::ONE_TO_ONE, ClassMetadataInfo::MANY_TO_ONE], true);
  196.     }
  198.     public function isToManyAssociation(string $propertyName): bool
  199.     {
  200.         $associationType = $this->getPropertyMetadata($propertyName)->get('type');
  202.         return \in_array($associationType, [ClassMetadataInfo::ONE_TO_MANY, ClassMetadataInfo::MANY_TO_MANY], true);
  203.     }
  205.     public function isEmbeddedClassProperty(string $propertyName): bool
  206.     {
  207.         $propertyNameParts = explode('.', $propertyName, 2);
  209.         return \array_key_exists($propertyNameParts[0], $this->metadata->embeddedClasses);
  210.     }
  212.     public function setInstance(?object $newEntityInstance): void
  213.     {
  214.         if (null !== $this->instance && null !== $newEntityInstance && !$newEntityInstance instanceof $this->fqcn) {
  215.             throw new \InvalidArgumentException(sprintf('The new entity instance must be of the same type as the previous instance (original instance: "%s", new instance: "%s").', $this->fqcn, $newEntityInstance::class));
  216.         }
  218.         $this->instance = $newEntityInstance;
  219.         $this->primaryKeyValue = null;
  220.     }
  222.     public function newWithInstance(/* object */ $newEntityInstance): self
  223.     {
  224.         if (!\is_object($newEntityInstance)) {
  225.             trigger_deprecation(
  226.                 'easycorp/easyadmin-bundle',
  227.                 '4.0.5',
  228.                 'Argument "%s" for "%s" must be one of these types: %s. Passing type "%s" will cause an error in 5.0.0.',
  229.                 '$newEntityInstance',
  230.                 __METHOD__,
  231.                 '"object"',
  232.                 \gettype($newEntityInstance)
  233.             );
  234.         }
  236.         if (null !== $this->instance && !$newEntityInstance instanceof $this->fqcn) {
  237.             throw new \InvalidArgumentException(sprintf('The new entity instance must be of the same type as the previous instance (original instance: "%s", new instance: "%s").', $this->fqcn, $newEntityInstance::class));
  238.         }
  240.         return new self($this->fqcn, $this->metadata, $this->permission, $newEntityInstance);
  241.     }
  242. }