References
CollectionProvider
September 19-20, 2024 | Lille & online
The international conference on the API Platform Framework
API Platform Conference 2024: meet the best PHP, JavaScript and API experts
Learn more about the event, register for the conference, and get ready for two days of inspiration, ideas, and knowledge-sharing with our incredible lineup of renowned specialists and advocates.
Register nowReference
C
ClassApiPlatform\Elasticsearch\State\CollectionProvider
Collection provider for Elasticsearch.
class ApiPlatform\Elasticsearch\State\CollectionProvider implements ApiPlatform\State\ProviderInterface
{
public __construct(Elasticsearch\Client|Elastic\Elasticsearch\Client $client, null|$documentMetadataFactory, null|Symfony\Component\Serializer\Normalizer\DenormalizerInterface $denormalizer, null|`<a href="/docs/references/State/Pagination/Pagination">ApiPlatform\State\Pagination\Pagination</a>` $pagination, array<int, `<a href="/docs/references/Elasticsearch/Extension/RequestBodySearchCollectionExtensionInterface">ApiPlatform\Elasticsearch\Extension\RequestBodySearchCollectionExtensionInterface> $collectionExtensions)
public provide($operation, array $uriVariables, array $context): `<a href="/docs/references/Elasticsearch/Paginator">ApiPlatform\Elasticsearch\Paginator
}Methods
__construct
public __construct(Elasticsearch\Client|Elastic\Elasticsearch\Client $client, null|$documentMetadataFactory, null|Symfony\Component\Serializer\Normalizer\DenormalizerInterface $denormalizer, null|`<a href="/docs/references/State/Pagination/Pagination">ApiPlatform\State\Pagination\Pagination</a>` $pagination, array<int, `<a href="/docs/references/Elasticsearch/Extension/RequestBodySearchCollectionExtensionInterface">ApiPlatform\Elasticsearch\Extension\RequestBodySearchCollectionExtensionInterface> $collectionExtensions)Parameters
| client | Elasticsearch\Client Elastic\Elasticsearch\Client | |
| documentMetadataFactory | `ApiPlatform\Elasticsearch\Metadata\Document\Factory\DocumentMetadataFactoryInterface` | |
| denormalizer | Symfony\Component\Serializer\Normalizer\DenormalizerInterface | |
| pagination | `ApiPlatform\State\Pagination\Pagination` | |
| collectionExtensions | array<int, `ApiPlatform\Elasticsearch\Extension\RequestBodySearchCollectionExtensionInterface`> |
provide
Provides data.
public provide($operation, array $uriVariables, array $context): `<a href="/docs/references/Elasticsearch/Paginator">ApiPlatform\Elasticsearch\PaginatorParameters
| operation | `ApiPlatform\Metadata\Operation` | |
| uriVariables | array | |
| context | array |
Returns
<a href="/docs/references/Elasticsearch/Paginator">ApiPlatform\Elasticsearch\Paginator</a>
