Copied!

Id

Id.php : 28
Implements SortClauseInterface

Sort clause for sorting payments by ID.

The following example sorts payment by descending IDs, from greater to lower:

$query = new PaymentQuery();
$query->addSortClause(new Id(SortDirection::DESC));

$payments = $paymentService->findPayments($query);

Typically used to ensure that the payments order is deterministic.

Tags
See
PaymentServiceInterface::findPayments()

Constants

publicSORT_ASC

AbstractSortClause.php : 16
public mixed SORT_ASC = \Ibexa\Contracts\CoreSearch\Values\Query\SortDirection::ASC

publicSORT_DESC

AbstractSortClause.php : 19
public mixed SORT_DESC = \Ibexa\Contracts\CoreSearch\Values\Query\SortDirection::DESC

Methods

public__construct()

Id.php : 30

Constructs a new SortClause on $sortTarget in direction $sortDirection.

public __construct([string $sortDirection = self::SORT_ASC ])

Parameters

Name Type Default value Description
$sortDirection string Id::SORT_ASC

one of SortDirection::ASC or SortDirection::DESC

publicgetDirection()

AbstractSortClause.php : 39
public final getDirection() : string

Return values

string

publicgetField()

FieldValueSortClause.php : 24
public getField() : string

Return values

string

publicsetDirection()

AbstractSortClause.php : 47
public final setDirection(string $direction) : void

Parameters

Name Type Default value Description
$direction string - -
Tags
Throws
InvalidArgumentException

if the given sort direction is invalid