ApiPlatform\Doctrine\Odm\Extension\AggregationResultCollectionExtensionInterface

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

interface ApiPlatformApiPlatform\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
}

interfaceApiPlatform\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

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

Parameters

resourceClass	string
operation	ApiPlatform\Metadata\Operation
context	array

Returns

bool

getResult

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

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

Parameters

aggregationBuilder	Doctrine\ODM\MongoDB\Aggregation\Builder
resourceClass	string
operation	ApiPlatform\Metadata\Operation
context	array

Returns

iterable