ApiPlatform\State\Pagination\Pagination

Pagination configuration.

class ApiPlatform\State\Pagination\Pagination
{
    public __construct(array $options, array $graphQlOptions)
    public getPage(array $context): int
    public getOffset(null|ApiPlatform\Metadata\Operation $operation, array $context): int
    public getLimit(null|ApiPlatform\Metadata\Operation $operation, array $context): int
    public getPagination(null|ApiPlatform\Metadata\Operation $operation, array $context): array
    public isEnabled(null|ApiPlatform\Metadata\Operation $operation, array $context): bool
    public isGraphQlEnabled(null|ApiPlatform\Metadata\Operation $operation, array $context): bool
    public isPartialEnabled(null|ApiPlatform\Metadata\Operation $operation, array $context): bool
    public getOptions(): array
    public getGraphQlPaginationType(ApiPlatform\Metadata\Operation $operation): string
}

class ApiPlatform\State\Pagination\Pagination
{
    public __construct(array $options, array $graphQlOptions)
    public getPage(array $context): int
    public getOffset(null|ApiPlatform\Metadata\Operation $operation, array $context): int
    public getLimit(null|ApiPlatform\Metadata\Operation $operation, array $context): int
    public getPagination(null|ApiPlatform\Metadata\Operation $operation, array $context): array
    public isEnabled(null|ApiPlatform\Metadata\Operation $operation, array $context): bool
    public isGraphQlEnabled(null|ApiPlatform\Metadata\Operation $operation, array $context): bool
    public isPartialEnabled(null|ApiPlatform\Metadata\Operation $operation, array $context): bool
    public getOptions(): array
    public getGraphQlPaginationType(ApiPlatform\Metadata\Operation $operation): string
}

Methods

__construct

public __construct(array $options, array $graphQlOptions)

public __construct(array $options, array $graphQlOptions)

Parameters

options	array
graphQlOptions	array

getPage

Gets the current page.

public getPage(array $context): int

public getPage(array $context): int

Parameters

context

array

Returns

int

getOffset

Gets the current offset.

public getOffset(null|ApiPlatform\Metadata\Operation $operation, array $context): int

public getOffset(null|ApiPlatform\Metadata\Operation $operation, array $context): int

Parameters

operation	ApiPlatform\Metadata\Operation
context	array

Returns

int

getLimit

Gets the current limit.

public getLimit(null|ApiPlatform\Metadata\Operation $operation, array $context): int

public getLimit(null|ApiPlatform\Metadata\Operation $operation, array $context): int

Parameters

operation	ApiPlatform\Metadata\Operation
context	array

Returns

int

getPagination

Gets info about the pagination.Returns an array with the following info as values:

the page getPage
the offset getOffset
the limit getLimit

public getPagination(null|ApiPlatform\Metadata\Operation $operation, array $context): array

public getPagination(null|ApiPlatform\Metadata\Operation $operation, array $context): array

Parameters

operation	ApiPlatform\Metadata\Operation
context	array

Returns

array

isEnabled

Is the pagination enabled?

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

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

Parameters

operation	ApiPlatform\Metadata\Operation
context	array

Returns

bool

isGraphQlEnabled

Is the pagination enabled for GraphQL?

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

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

Parameters

operation	ApiPlatform\Metadata\Operation
context	array

Returns

bool

isPartialEnabled

Is the partial pagination enabled?

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

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

Parameters

operation	ApiPlatform\Metadata\Operation
context	array

Returns

bool

getOptions

public getOptions(): array

public getOptions(): array

Returns

array

getGraphQlPaginationType

public getGraphQlPaginationType(ApiPlatform\Metadata\Operation $operation): string

public getGraphQlPaginationType(ApiPlatform\Metadata\Operation $operation): string

Parameters

operation

ApiPlatform\Metadata\Operation

Returns

string