For AI agents: the complete documentation index is available at llms.txt; this page is also available as Markdown at index.md.

• Documentation >
• Search >
• Sort Clause reference >
• Shopping List Sort Clauses

Shopping list search sort clauses reference

The sort clauses are in the Ibexa\Contracts\ShoppingList\Value\Query\SortClause namespace.

Sort clause	Description
CreatedAt	Sort by creation date
IsDefault	Sort by being default or not
Name	Sort by name
UpdatedAt	Sort by last modification date

The following example returns all the shopping lists available to the current user. The returned shopping list are sorted with the default shopping list on top, followed by the rest sorted by their name.

use Ibexa\Contracts\ShoppingList\Value\Query\SortClause\IsDefault;
use Ibexa\Contracts\ShoppingList\Value\Query\SortClause\Name;
use Ibexa\Contracts\ShoppingList\Value\ShoppingListQuery;

/** @var \Ibexa\Contracts\ShoppingList\ShoppingListServiceInterface $shoppingListService */
$lists = $shoppingListService->findShoppingLists(
    new ShoppingListQuery(
        null,
        [
            new IsDefault(IsDefault::SORT_DESC),
            new Name(),
        ]
    )
);

For more information about shopping lists search, see List and search shopping lists.

Copy as Markdown View as Markdown View on GitHub