vendor/api-platform/core/src/Api/IriConverterInterface.php line 44

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