vendor/api-platform/core/src/Metadata/IriConverterInterface.php line 20

  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\Metadata;
  16. use ApiPlatform\Metadata\Exception\InvalidArgumentException;
  17. use ApiPlatform\Metadata\Exception\ItemNotFoundException;
  18. use ApiPlatform\Metadata\Exception\RuntimeException;
  20. if (interface_exists(\ApiPlatform\Api\IriConverterInterface::class)) {
  21.     class_alias(
  22.         \ApiPlatform\Api\IriConverterInterface::class,
  23.         __NAMESPACE__.'\IriConverterInterface'
  24.     );
  26.     if (false) { // @phpstan-ignore-line
  27.         interface IriConverterInterface extends \ApiPlatform\Api\IriConverterInterface
  28.         {
  29.         }
  30.     }
  31. } else {
  32.     /**
  33.      * Converts item and resources to IRI and vice versa.
  34.      *
  35.      * @author Kévin Dunglas <dunglas@gmail.com>
  36.      */
  37.     interface IriConverterInterface
  38.     {
  39.         /**
  40.          * Retrieves an item from its IRI.
  41.          *
  42.          * @throws InvalidArgumentException
  43.          * @throws ItemNotFoundException
  44.          */
  45.         public function getResourceFromIri(string $iri, array $context = [], Operation $operation = null): object;
  47.         /**
  48.          * Gets the IRI associated with the given item.
  49.          *
  50.          * @param object|class-string $resource
  51.          *
  52.          * @throws InvalidArgumentException
  53.          * @throws RuntimeException
  54.          */
  55.         public function getIriFromResource(object|string $resource, int $referenceType = UrlGeneratorInterface::ABS_PATH, Operation $operation = null, array $context = []): ?string;
  56.     }
  57. }