References
AggregationResultCollectionExtensionInterface
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
I
InterfaceApiPlatform\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): boolParameters
| 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): iterableParameters
| aggregationBuilder | Doctrine\ODM\MongoDB\Aggregation\Builder | |
| resourceClass | string | |
| operation | `ApiPlatform\Metadata\Operation` | |
| context | array |
Returns
iterable
