vendor/api-platform/core/src/Doctrine/Common/PropertyHelperTrait.php line 132

  1. <?php
  3. /*
  4.  * This file is part of the API Platform project.
  5.  *
  6.  * (c) Kévin Dunglas <dunglas@gmail.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. declare(strict_types=1);
  14. namespace ApiPlatform\Doctrine\Common;
  16. use Doctrine\Persistence\ManagerRegistry;
  17. use Doctrine\Persistence\Mapping\ClassMetadata;
  19. /**
  20.  * Helper trait for getting information regarding a property using the resource metadata.
  21.  *
  22.  * @author Kévin Dunglas <dunglas@gmail.com>
  23.  * @author Théo FIDRY <theo.fidry@gmail.com>
  24.  * @author Alan Poulain <contact@alanpoulain.eu>
  25.  */
  26. trait PropertyHelperTrait
  27. {
  28.     abstract protected function getManagerRegistry(): ManagerRegistry;
  30.     /**
  31.      * Determines whether the given property is mapped.
  32.      */
  33.     protected function isPropertyMapped(string $property, string $resourceClass, bool $allowAssociation = false): bool
  34.     {
  35.         if ($this->isPropertyNested($property, $resourceClass)) {
  36.             $propertyParts = $this->splitPropertyParts($property, $resourceClass);
  37.             $metadata = $this->getNestedMetadata($resourceClass, $propertyParts['associations']);
  38.             $property = $propertyParts['field'];
  39.         } else {
  40.             $metadata = $this->getClassMetadata($resourceClass);
  41.         }
  43.         return $metadata->hasField($property) || ($allowAssociation && $metadata->hasAssociation($property));
  44.     }
  46.     /**
  47.      * Determines whether the given property is nested.
  48.      */
  49.     protected function isPropertyNested(string $property, string $resourceClass): bool
  50.     {
  51.         $pos = strpos($property, '.');
  52.         if (false === $pos) {
  53.             return false;
  54.         }
  56.         return $this->getClassMetadata($resourceClass)->hasAssociation(substr($property, 0, $pos));
  57.     }
  59.     /**
  60.      * Determines whether the given property is embedded.
  61.      */
  62.     protected function isPropertyEmbedded(string $property, string $resourceClass): bool
  63.     {
  64.         return str_contains($property, '.') && $this->getClassMetadata($resourceClass)->hasField($property);
  65.     }
  67.     /**
  68.      * Splits the given property into parts.
  69.      *
  70.      * Returns an array with the following keys:
  71.      *   - associations: array of associations according to nesting order
  72.      *   - field: string holding the actual field (leaf node)
  73.      */
  74.     protected function splitPropertyParts(string $property, string $resourceClass): array
  75.     {
  76.         $parts = explode('.', $property);
  78.         $metadata = $this->getClassMetadata($resourceClass);
  79.         $slice = 0;
  81.         foreach ($parts as $part) {
  82.             if ($metadata->hasAssociation($part)) {
  83.                 $metadata = $this->getClassMetadata($metadata->getAssociationTargetClass($part));
  84.                 ++$slice;
  85.             }
  86.         }
  88.         if (\count($parts) === $slice) {
  89.             --$slice;
  90.         }
  92.         return [
  93.             'associations' => \array_slice($parts, 0, $slice),
  94.             'field' => implode('.', \array_slice($parts, $slice)),
  95.         ];
  96.     }
  98.     /**
  99.      * Gets the Doctrine Type of a given property/resourceClass.
  100.      */
  101.     protected function getDoctrineFieldType(string $property, string $resourceClass): ?string
  102.     {
  103.         $propertyParts = $this->splitPropertyParts($property, $resourceClass);
  104.         $metadata = $this->getNestedMetadata($resourceClass, $propertyParts['associations']);
  106.         return $metadata->getTypeOfField($propertyParts['field']);
  107.     }
  109.     /**
  110.      * Gets nested class metadata for the given resource.
  111.      *
  112.      * @param string[] $associations
  113.      */
  114.     protected function getNestedMetadata(string $resourceClass, array $associations): ClassMetadata
  115.     {
  116.         $metadata = $this->getClassMetadata($resourceClass);
  118.         foreach ($associations as $association) {
  119.             if ($metadata->hasAssociation($association)) {
  120.                 $associationClass = $metadata->getAssociationTargetClass($association);
  122.                 $metadata = $this->getClassMetadata($associationClass);
  123.             }
  124.         }
  126.         return $metadata;
  127.     }
  129.     /**
  130.      * Gets class metadata for the given resource.
  131.      */
  132.     protected function getClassMetadata(string $resourceClass): ClassMetadata
  133.     {
  134.         return $this
  135.             ->getManagerRegistry()
  136.             ->getManagerForClass($resourceClass)
  137.             ->getClassMetadata($resourceClass);
  138.     }
  139. }