vendor/api-platform/core/src/Documentation/Documentation.php line 31

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\Documentation;
  16. use ApiPlatform\Metadata\Resource\ResourceNameCollection;
  18. /**
  19. * Generates the API documentation.
  20. *
  21. * @author Amrouche Hamza <hamza.simperfit@gmail.com>
  22. */
  23. final class Documentation implements DocumentationInterface
  24. {
  25. private $resourceNameCollection;
  26. private $title;
  27. private $description;
  28. private $version;
  29. private $mimeTypes = [];
  31. public function __construct(ResourceNameCollection $resourceNameCollection, string $title = '', string $description = '', string $version = '', array $formats = null)
  32. {
  33. $this->resourceNameCollection = $resourceNameCollection;
  34. $this->title = $title;
  35. $this->description = $description;
  36. $this->version = $version;
  38. if (null === $formats) {
  39. return;
  40. }
  42. @trigger_error(sprintf('Passing a 5th parameter to the constructor of "%s" is deprecated since API Platform 2.5', __CLASS__), \E_USER_DEPRECATED);
  44. foreach ($formats as $mimeTypes) {
  45. foreach ($mimeTypes as $mimeType) {
  46. $this->mimeTypes[] = $mimeType;
  47. }
  48. }
  49. }
  51. public function getMimeTypes(): array
  52. {
  53. @trigger_error(sprintf('The method "%s" is deprecated since API Platform 2.5, use the "formats" attribute instead', __METHOD__), \E_USER_DEPRECATED);
  55. return $this->mimeTypes;
  56. }
  58. public function getVersion(): string
  59. {
  60. return $this->version;
  61. }
  63. public function getDescription(): string
  64. {
  65. return $this->description;
  66. }
  68. public function getTitle(): string
  69. {
  70. return $this->title;
  71. }
  73. public function getResourceNameCollection(): ResourceNameCollection
  74. {
  75. return $this->resourceNameCollection;
  76. }
  77. }
  79. class_alias(Documentation::class, \ApiPlatform\Core\Documentation\Documentation::class);