b2pweb / bdf-prime

src/Query/Extension/OrderableTrait.php

<?php

namespace Bdf\Prime\Query\Extension;

use Bdf\Prime\Query\Contract\Orderable;

/**
 * Trait for @see Orderable
 *
 * @property array{orders:array<array{sort:string,order:Orderable::ORDER_*}>} $statements
 *
 * @psalm-require-implements Orderable
 */

The doc comment array{orders:array<array{sort:string,order:Orderable::ORDER_*}>} at position 14 could not be parsed: Expected '}' at position 14, but found 'Orderable'.

trait OrderableTrait
{
    /**
     * {@inheritdoc}
     *
     * @see Orderable::order()
     */
    public function order($sort, ?string $order = null)
    {
        $this->compilerState->invalidate('orders');

        $this->statements['orders'] = [];

The property statements does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        if (!is_array($sort)) {
            $sort = [$sort => $order];
        }

        foreach ($sort as $column => $order) {
            if (is_int($column)) {
                $column = $order;
                $order = Orderable::ORDER_ASC;
            }

            $this->statements['orders'][] = [
                'sort'  => $column,
                'order' => !$order ? Orderable::ORDER_ASC : $order,
            ];
        }

        return $this;
    }

    /**
     * {@inheritdoc}
     *
     * @see Orderable::addOrder()
     */
    public function addOrder($sort, ?string $order = null)
    {
        $this->compilerState->invalidate('orders');

        if (!is_array($sort)) {
            $sort = [$sort => $order];
        }

        foreach ($sort as $column => $order) {
            if (is_int($column)) {
                $column = $order;
                $order = Orderable::ORDER_ASC;
            }

            $this->statements['orders'][] = [

The property statements does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

                'sort'  => $column,
                'order' => !$order ? Orderable::ORDER_ASC : $order,
            ];
        }

        return $this;
    }

    /**
     * {@inheritdoc}
     *
     * @see Orderable::getOrders()
     * @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
    {
        $orders = [];

        foreach ($this->statements['orders'] as $part) {
            $orders[$part['sort']] = $part['order'];
        }

        return $orders;
    }
}