ApiPlatform\Doctrine\Orm\Extension\QueryResultCollectionExtensionInterface

Interface of Doctrine ORM query extensions that supports result production for specific cases such as pagination.

interface ApiPlatformApiPlatform\Doctrine\Orm\Extension\QueryCollectionExtensionInterface
{
    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
    public applyToCollection(Doctrine\ORM\QueryBuilder $queryBuilder, ApiPlatform\Doctrine\Orm\Util\QueryNameGeneratorInterface $queryNameGenerator, string $resourceClass, null|ApiPlatform\Metadata\Operation $operation, array $context): null
}

interfaceApiPlatform\Doctrine\Orm\Extension\QueryCollectionExtensionInterface
{
    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
    public applyToCollection(Doctrine\ORM\QueryBuilder $queryBuilder, ApiPlatform\Doctrine\Orm\Util\QueryNameGeneratorInterface $queryNameGenerator, 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\ORM\QueryBuilder $queryBuilder, null|string $resourceClass, null|ApiPlatform\Metadata\Operation $operation, array $context): iterable

public getResult(Doctrine\ORM\QueryBuilder $queryBuilder, null|string $resourceClass, null|ApiPlatform\Metadata\Operation $operation, array $context): iterable

Parameters

queryBuilder	Doctrine\ORM\QueryBuilder
resourceClass	string
operation	ApiPlatform\Metadata\Operation
context	array

Returns

iterable