References AggregationResultCollectionExtensionInterface
Reference
I
Interface

ApiPlatform\Doctrine\Odm\Extension\AggregationResultCollectionExtensionInterface

Interface of Doctrine MongoDB ODM aggregation extensions that supports result production for specific cases such as pagination.

interface ApiPlatform\Doctrine\Odm\Extension\AggregationResultCollectionExtensionInterface implements ApiPlatform\Doctrine\Odm\Extension\AggregationCollectionExtensionInterface
{
    public supportsResult(string $resourceClass, null|ApiPlatform\Metadata\Operation $operation, array $context): bool
    public getResult(Doctrine\ODM\MongoDB\Aggregation\Builder $aggregationBuilder, string $resourceClass, null|ApiPlatform\Metadata\Operation $operation, array $context): iterable
    public applyToCollection(Doctrine\ODM\MongoDB\Aggregation\Builder $aggregationBuilder, string $resourceClass, null|ApiPlatform\Metadata\Operation $operation, array $context): null
}

Methods

supportsResult

public supportsResult(string $resourceClass, null|ApiPlatform\Metadata\Operation $operation, array $context): bool

Parameters

resourceClassstring
operation`ApiPlatform\Metadata\Operation`
contextarray

Returns

bool

getResult

public getResult(Doctrine\ODM\MongoDB\Aggregation\Builder $aggregationBuilder, string $resourceClass, null|ApiPlatform\Metadata\Operation $operation, array $context): iterable

Parameters

aggregationBuilderDoctrine\ODM\MongoDB\Aggregation\Builder
resourceClassstring
operation`ApiPlatform\Metadata\Operation`
contextarray

Returns

iterable

Made with love by

Les-Tilleuls.coop can help you design and develop your APIs and web projects, and train your teams in API Platform, Symfony, Next.js, Kubernetes and a wide range of other technologies.

Learn more

Copyright © 2023 Kévin Dunglas

Sponsored by Les-Tilleuls.coop