b2pweb / bdf-prime

src/Query/Contract/Orderable.php

<?php

namespace Bdf\Prime\Query\Contract;

use Bdf\Prime\Query\Expression\ExpressionInterface;

/**
 * Interface for sortable (order) queries
 */
interface Orderable
{
    public const ORDER_ASC = 'ASC';
    public const ORDER_DESC = 'DESC';

    /**
     * Specifies an ordering for the query results.
     * Replaces any previously specified orderings, if any.
     *
     * <code>
     *     $query->order('u.id'); // ORDER BY u.id ASC
     *     $query->order(['u.id', 'name']); // ORDER BY u.id ASC, name ASC
     *     $query->order(['u.id' => 'asc', 'name' => 'desc']); // ORDER BY u.id asc, name desc
     * </code>
     *
     * @param string|array<string,Orderable::ORDER_*>|ExpressionInterface $sort The ordering expression.

The doc comment string|array<string,Orderable::ORDER_*>|ExpressionInterface at position 6 could not be parsed: Expected '>' at position 6, but found 'Orderable'.

     * @param Orderable::ORDER_*|null $order The ordering direction.
     *
     * @return $this This Query instance.
     */
    public function order($sort, ?string $order = null);

    /**
     * Adds an ordering for the query results.
     * Replaces any previously specified orderings, if any.
     *
     * <code>
     *     $query->addOrder('id'); // ORDER BY id ASC
     *     $query->addOrder('date', 'name'); // GROUP BY id ASC, date ASC, name ASC
     * </code>
     *
     * @param string|array<string,Orderable::ORDER_*>|ExpressionInterface $sort The ordering expression.

The doc comment string|array<string,Orderable::ORDER_*>|ExpressionInterface at position 6 could not be parsed: Expected '>' at position 6, but found 'Orderable'.

     * @param Orderable::ORDER_*|null $order The ordering direction.
     *
     * @return $this This Query instance.
     */
    public function addOrder($sort, ?string $order = null);

    /**
     * Get orders
     *
     * @return array<string, Orderable::ORDER_*>

The doc comment array<string, Orderable::ORDER_*> at position 4 could not be parsed: Expected '>' at position 4, but found 'Orderable'.

     */
    public function getOrders(): array;
}