References PaginationExtension
Reference
C
Class

ApiPlatform\Doctrine\Orm\Extension\PaginationExtension

Applies pagination on the Doctrine query for resource collection when enabled.

class ApiPlatform\Doctrine\Orm\Extension\PaginationExtension implements , `<a href="/docs/main/references/Doctrine/Orm/Extension/QueryCollectionExtensionInterface">ApiPlatform\Doctrine\Orm\Extension\QueryCollectionExtensionInterface
{
    public __construct(Doctrine\Persistence\ManagerRegistry $managerRegistry, null|ApiPlatform\State\Pagination\Pagination $pagination)
    public applyToCollection(Doctrine\ORM\QueryBuilder $queryBuilder, $queryNameGenerator, string $resourceClass, null|`<a href="/docs/main/references/Metadata/Operation">ApiPlatform\Metadata\Operation $operation, array $context): null
    public supportsResult(string $resourceClass, null|ApiPlatform\Metadata\Operation $operation, array $context): bool
    public getResult(Doctrine\ORM\QueryBuilder $queryBuilder, null|string $resourceClass, null|ApiPlatform\Metadata\Operation $operation, array $context): iterable
}

Methods

__construct

public __construct(Doctrine\Persistence\ManagerRegistry $managerRegistry, null|ApiPlatform\State\Pagination\Pagination $pagination)

Parameters

managerRegistryDoctrine\Persistence\ManagerRegistry
pagination`ApiPlatform\State\Pagination\Pagination`

applyToCollection

public applyToCollection(Doctrine\ORM\QueryBuilder $queryBuilder, $queryNameGenerator, string $resourceClass, null|`<a href="/docs/main/references/Metadata/Operation">ApiPlatform\Metadata\Operation $operation, array $context): null

Parameters

queryBuilderDoctrine\ORM\QueryBuilder
queryNameGenerator`ApiPlatform\Doctrine\Orm\Util\QueryNameGeneratorInterface`
resourceClassstring
operation`ApiPlatform\Metadata\Operation`
contextarray

Returns

null

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\ORM\QueryBuilder $queryBuilder, null|string $resourceClass, null|ApiPlatform\Metadata\Operation $operation, array $context): iterable

Parameters

queryBuilderDoctrine\ORM\QueryBuilder
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