vendor/api-platform/core/src/Core/Metadata/Resource/Factory/PhpDocResourceMetadataFactory.php line 32

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\Resource\Factory;
  16. use ApiPlatform\Core\Metadata\Resource\ResourceMetadata;
  17. use phpDocumentor\Reflection\DocBlockFactory;
  18. use phpDocumentor\Reflection\DocBlockFactoryInterface;
  19. use phpDocumentor\Reflection\Types\ContextFactory;
  21. /**
  22. * Extracts descriptions from PHPDoc.
  23. *
  24. * @author Kévin Dunglas <dunglas@gmail.com>
  25. */
  26. final class PhpDocResourceMetadataFactory implements ResourceMetadataFactoryInterface
  27. {
  28. private $decorated;
  29. private $docBlockFactory;
  30. private $contextFactory;
  32. public function __construct(ResourceMetadataFactoryInterface $decorated, DocBlockFactoryInterface $docBlockFactory = null)
  33. {
  34. $this->decorated = $decorated;
  35. $this->docBlockFactory = $docBlockFactory ?: DocBlockFactory::createInstance();
  36. $this->contextFactory = new ContextFactory();
  37. }
  39. /**
  40. * {@inheritdoc}
  41. */
  42. public function create(string $resourceClass): ResourceMetadata
  43. {
  44. $resourceMetadata = $this->decorated->create($resourceClass);
  46. if (null !== $resourceMetadata->getDescription()) {
  47. return $resourceMetadata;
  48. }
  50. $reflectionClass = new \ReflectionClass($resourceClass);
  52. try {
  53. $docBlock = $this->docBlockFactory->create($reflectionClass, $this->contextFactory->createFromReflector($reflectionClass));
  54. $resourceMetadata = $resourceMetadata->withDescription($docBlock->getSummary());
  55. } catch (\InvalidArgumentException $e) {
  56. // Ignore empty DocBlocks
  57. }
  59. return $resourceMetadata;
  60. }
  61. }