vendor/api-platform/core/src/Core/Metadata/Property/Factory/AnnotationSubresourceMetadataFactory.php line 65

Open in your IDE?
  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\Core\Metadata\Property\Factory;
  16. use ApiPlatform\Core\Annotation\ApiSubresource;
  17. use ApiPlatform\Core\Metadata\Property\PropertyMetadata;
  18. use ApiPlatform\Core\Metadata\Property\SubresourceMetadata;
  19. use ApiPlatform\Exception\InvalidResourceException;
  20. use ApiPlatform\Util\Reflection;
  21. use Doctrine\Common\Annotations\Reader;
  22. use Symfony\Component\PropertyInfo\Type;
  24. /**
  25.  * Adds subresources to the properties metadata from {@see ApiResource} annotations.
  26.  *
  27.  * @author Antoine Bluchet <soyuka@gmail.com>
  28.  */
  29. final class AnnotationSubresourceMetadataFactory implements PropertyMetadataFactoryInterface
  30. {
  31.     private $reader;
  32.     private $decorated;
  34.     public function __construct(Reader $reader = null, PropertyMetadataFactoryInterface $decorated)
  35.     {
  36.         $this->reader = $reader;
  37.         $this->decorated = $decorated;
  38.     }
  40.     /**
  41.      * {@inheritdoc}
  42.      */
  43.     public function create(string $resourceClass, string $property, array $options = []): PropertyMetadata
  44.     {
  45.         $propertyMetadata = $this->decorated->create($resourceClass, $property, $options);
  47.         try {
  48.             $reflectionClass = new \ReflectionClass($resourceClass);
  49.         } catch (\ReflectionException $reflectionException) {
  50.             return $propertyMetadata;
  51.         }
  53.         if ($reflectionClass->hasProperty($property)) {
  54.             $reflectionProperty = $reflectionClass->getProperty($property);
  55.             if (\PHP_VERSION_ID >= 80000 && $attributes = $reflectionProperty->getAttributes(ApiSubresource::class)) {
  56.                 return $this->updateMetadata($attributes[0]->newInstance(), $propertyMetadata, $resourceClass, $property);
  57.             }
  59.             if (!$this->reader) {
  60.                 return $propertyMetadata;
  61.             }
  63.             $annotation = $this->reader->getPropertyAnnotation($reflectionProperty, ApiSubresource::class);
  64.             if ($annotation instanceof ApiSubresource) {
  65.                 trigger_deprecation('api-platform/core', '2.7', sprintf('Declare a new resource instead of using ApiSubresource on the property "%s".', $property));
  67.                 return $this->updateMetadata($annotation, $propertyMetadata, $resourceClass, $property);
  68.             }
  69.         }
  71.         foreach (array_merge(Reflection::ACCESSOR_PREFIXES, Reflection::MUTATOR_PREFIXES) as $prefix) {
  72.             $methodName = $prefix.ucfirst($property);
  73.             if (!$reflectionClass->hasMethod($methodName)) {
  74.                 continue;
  75.             }
  77.             $reflectionMethod = $reflectionClass->getMethod($methodName);
  78.             if (!$reflectionMethod->isPublic()) {
  79.                 continue;
  80.             }
  82.             if (\PHP_VERSION_ID >= 80000 && $attributes = $reflectionMethod->getAttributes(ApiSubresource::class)) {
  83.                 return $this->updateMetadata($attributes[0]->newInstance(), $propertyMetadata, $resourceClass, $property);
  84.             }
  86.             if (!$this->reader) {
  87.                 return $propertyMetadata;
  88.             }
  90.             $annotation = $this->reader->getMethodAnnotation($reflectionMethod, ApiSubresource::class);
  91.             if ($annotation instanceof ApiSubresource) {
  92.                 return $this->updateMetadata($annotation, $propertyMetadata, $resourceClass, $property);
  93.             }
  94.         }
  96.         return $propertyMetadata;
  97.     }
  99.     private function updateMetadata(ApiSubresource $annotation, PropertyMetadata $propertyMetadata, string $originResourceClass, string $propertyName): PropertyMetadata
  100.     {
  101.         // TODO: 3.0 support multiple types, default value of types will be [] instead of null
  102.         $type = $propertyMetadata->getType();
  103.         if (null === $type) {
  104.             throw new InvalidResourceException(sprintf('Property "%s" on resource "%s" is declared as a subresource, but its type could not be determined.', $propertyName, $originResourceClass));
  105.         }
  106.         $isCollection = $type->isCollection();
  108.         if (
  109.             $isCollection &&
  110.             $collectionValueType = method_exists(Type::class, 'getCollectionValueTypes') ? ($type->getCollectionValueTypes()[0] ?? null) : $type->getCollectionValueType()
  111.         ) {
  112.             $resourceClass = $collectionValueType->getClassName();
  113.         } else {
  114.             $resourceClass = $type->getClassName();
  115.         }
  117.         $maxDepth = $annotation->maxDepth;
  118.         // @ApiSubresource is on the class identifier (/collection/{id}/subcollection/{subcollectionId})
  119.         if (null === $resourceClass) {
  120.             $resourceClass = $originResourceClass;
  121.             $isCollection = false;
  122.         }
  124.         return $propertyMetadata->withSubresource(new SubresourceMetadata($resourceClass, $isCollection, $maxDepth));
  125.     }
  126. }