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

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\Exception\InvalidResourceException;
  18. use ApiPlatform\Core\Metadata\Property\PropertyMetadata;
  19. use ApiPlatform\Core\Metadata\Property\SubresourceMetadata;
  20. use ApiPlatform\Core\Util\Reflection;
  21. use Doctrine\Common\Annotations\Reader;
  23. /**
  24.  * Adds subresources to the properties metadata from {@see ApiResource} annotations.
  25.  *
  26.  * @author Antoine Bluchet <soyuka@gmail.com>
  27.  */
  28. final class AnnotationSubresourceMetadataFactory implements PropertyMetadataFactoryInterface
  29. {
  30.     private $reader;
  31.     private $decorated;
  33.     public function __construct(Reader $reader, PropertyMetadataFactoryInterface $decorated)
  34.     {
  35.         $this->reader = $reader;
  36.         $this->decorated = $decorated;
  37.     }
  39.     /**
  40.      * {@inheritdoc}
  41.      */
  42.     public function create(string $resourceClass, string $property, array $options = []): PropertyMetadata
  43.     {
  44.         $propertyMetadata = $this->decorated->create($resourceClass, $property, $options);
  46.         try {
  47.             $reflectionClass = new \ReflectionClass($resourceClass);
  48.         } catch (\ReflectionException $reflectionException) {
  49.             return $propertyMetadata;
  50.         }
  52.         if ($reflectionClass->hasProperty($property)) {
  53.             $annotation = $this->reader->getPropertyAnnotation($reflectionClass->getProperty($property), ApiSubresource::class);
  55.             if ($annotation instanceof ApiSubresource) {
  56.                 return $this->updateMetadata($annotation, $propertyMetadata, $resourceClass, $property);
  57.             }
  58.         }
  60.         foreach (array_merge(Reflection::ACCESSOR_PREFIXES, Reflection::MUTATOR_PREFIXES) as $prefix) {
  61.             $methodName = $prefix.ucfirst($property);
  62.             if (!$reflectionClass->hasMethod($methodName)) {
  63.                 continue;
  64.             }
  66.             $reflectionMethod = $reflectionClass->getMethod($methodName);
  67.             if (!$reflectionMethod->isPublic()) {
  68.                 continue;
  69.             }
  71.             $annotation = $this->reader->getMethodAnnotation($reflectionMethod, ApiSubresource::class);
  73.             if ($annotation instanceof ApiSubresource) {
  74.                 return $this->updateMetadata($annotation, $propertyMetadata, $resourceClass, $property);
  75.             }
  76.         }
  78.         return $propertyMetadata;
  79.     }
  81.     private function updateMetadata(ApiSubresource $annotation, PropertyMetadata $propertyMetadata, string $originResourceClass, string $propertyName): PropertyMetadata
  82.     {
  83.         $type = $propertyMetadata->getType();
  84.         if (null === $type) {
  85.             throw new InvalidResourceException(sprintf('Property "%s" on resource "%s" is declared as a subresource, but its type could not be determined.', $propertyName, $originResourceClass));
  86.         }
  87.         $isCollection = $type->isCollection();
  88.         $resourceClass = $isCollection && ($collectionValueType = $type->getCollectionValueType()) ? $collectionValueType->getClassName() : $type->getClassName();
  89.         $maxDepth = $annotation->maxDepth;
  90.         // @ApiSubresource is on the class identifier (/collection/{id}/subcollection/{subcollectionId})
  91.         if (null === $resourceClass) {
  92.             $resourceClass = $originResourceClass;
  93.             $isCollection = false;
  94.         }
  96.         return $propertyMetadata->withSubresource(new SubresourceMetadata($resourceClass, $isCollection, $maxDepth));
  97.     }
  98. }