Copied!

QueryFieldServiceInterface

QueryFieldServiceInterface.php : 14

Executes queries for a query field.

Methods

publiccountContentItems()

QueryFieldServiceInterface.php : 38

Counts the total results of a query.

public countContentItems(Content $content, string $fieldDefinitionIdentifier) : int

Parameters

Name Type Default value Description
$content Content - -
$fieldDefinitionIdentifier string - -

Return values

int

Tags
Throws
InvalidArgumentException

publicgetPaginationConfiguration()

QueryFieldServiceInterface.php : 62
public getPaginationConfiguration(Content $content, string $fieldDefinitionIdentifier) : int

Parameters

Name Type Default value Description
$content Content - -
$fieldDefinitionIdentifier string - -

Return values

int

The page size, or 0 if pagination is disabled.

Tags
Throws
InvalidArgumentException

publicloadContentItems()

QueryFieldServiceInterface.php : 26

Executes the query without pagination and returns the content items.

public loadContentItems(Location $content, string $fieldDefinitionIdentifier) : array<string|int, Content>

Parameters

Name Type Default value Description
$content Location - -
$fieldDefinitionIdentifier string - -

Return values

array<string|int, Content>

Tags
Throws
InvalidArgumentException

publicloadContentItemsSlice()

QueryFieldServiceInterface.php : 52

Executes a paginated query and return the requested content items slice.

public loadContentItemsSlice(Content $content, string $fieldDefinitionIdentifier, int $offset, int $limit) : array<string|int, Content>

Parameters

Name Type Default value Description
$content Content - -
$fieldDefinitionIdentifier string - -
$offset int - -
$limit int - -

Return values

array<string|int, Content>

Tags
Throws
InvalidArgumentException