vendor/api-platform/core/src/Core/DataProvider/SubresourceDataProviderInterface.php line 36

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\DataProvider;
  16. use ApiPlatform\Exception\ResourceClassNotSupportedException;
  18. /**
  19. * Retrieves subresources from a persistence layer.
  20. *
  21. * @author Antoine Bluchet <soyuka@gmail.com>
  22. */
  23. interface SubresourceDataProviderInterface
  24. {
  25. /**
  26. * Retrieves a subresource of an item.
  27. *
  28. * @param string $resourceClass The root resource class
  29. * @param array $identifiers Identifiers and their values
  30. * @param array $context The context indicates the conjunction between collection properties (identifiers) and their class
  31. *
  32. * @throws ResourceClassNotSupportedException
  33. *
  34. * @return iterable|object|null
  35. */
  36. public function getSubresource(string $resourceClass, array $identifiers, array $context, string $operationName = null);
  37. }