Stratadox\Sorting\Sort

Complexity

Total Complexity

11

Size/Duplication

Total Lines	58
Duplicated Lines	0 %

Importance

Changes	3
Bugs	0	Features	0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	andThenDescendingBy()	0	3	1
A	__construct()	0	8	1
A	ascendingBy()	0	5	2
A	isRequired()	0	3	1
A	andThenAscendingBy()	0	3	1
A	field()	0	3	1
A	descendingBy()	0	5	2
A	next()	0	3	1
A	ascends()	0	3	1

<?php
declare(strict_types=1);

namespace Stratadox\Sorting;

use Stratadox\Sorting\Contracts\ExtensibleSorting;
use Stratadox\Sorting\Contracts\Sorting;

/**
 * Sort according to this definition.
 *
 * Contains the field, the sorting direction and the sorting definition for
 * unresolved elements.
 *
 * @author  Stratadox
 * @package Stratadox\Sorting
 */
final class Sort implements ExtensibleSorting
{
    private $field;
    private $ascends;
    private $next;

    private function __construct(
        string $field,
        bool $ascends,
        Sorting $next
    ) {
        $this->field = $field;
        $this->ascends = $ascends;
        $this->next = $next;
    }

    public static function descendingBy(
        string $field,
        Sorting $next = null
    ): ExtensibleSorting {
        return new Sort($field, false, $next ?: DoNotSort::atAll());
    }

    public static function ascendingBy(
        string $field,
        Sorting $next = null
    ): ExtensibleSorting {
        return new Sort($field, true, $next ?: DoNotSort::atAll());
    }

    public function field(): string
    {
        return $this->field;
    }

    public function next(): Sorting
    {
        return $this->next;
    }

    public function ascends(): bool
    {
        return $this->ascends;
    }

    public function isRequired(): bool
    {
        return true;
    }

    public function andThenAscendingBy(string $field): ExtensibleSorting
    {
        return new Sort($this->field, $this->ascends, Sort::ascendingBy($field));
    }

    public function andThenDescendingBy(string $field): ExtensibleSorting
    {
        return new Sort($this->field, $this->ascends, Sort::descendingBy($field));
    }
}