Spatie\QueryBuilder\Sort

Complexity

Total Complexity

11

Size/Duplication

Total Lines	73
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	0

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	10	1
A	parsePropertyDirection()	0	4	2
A	sort()	0	8	1
A	field()	0	4	1
A	custom()	0	4	1
A	getProperty()	0	4	1
A	isForProperty()	0	4	1
A	resolveSortClass()	0	8	2
A	getColumnName()	0	4	1

<?php

namespace Spatie\QueryBuilder;

use Illuminate\Database\Eloquent\Builder;
use Spatie\QueryBuilder\Sorts\SortsField;
use Spatie\QueryBuilder\Enums\SortDirection;
use Spatie\QueryBuilder\Sorts\Sort as CustomSort;

class Sort
{
    /** @var string */
    protected $sortClass;

    /** @var string|\Spatie\QueryBuilder\Sorts\Sort */
    protected $property;

    /** @var string */
    protected $defaultDirection;

    /** @var string */
    protected $columnName;

    public function __construct(string $property, $sortClass, ?string $columnName = null)
    {
        $this->property = ltrim($property, '-');

        $this->sortClass = $sortClass;

        $this->defaultDirection = static::parsePropertyDirection($property);

        $this->columnName = $columnName ?? $property;
    }

    public static function parsePropertyDirection(string $property): string
    {
        return $property[0] === '-' ? SortDirection::DESCENDING : SortDirection::ASCENDING;
    }

    public function sort(Builder $builder, ?bool $descending = null)
    {
        $sortClass = $this->resolveSortClass();

        $descending = $descending ?? ($this->defaultDirection === SortDirection::DESCENDING);

        ($sortClass)($builder, $descending, $this->columnName);
    }

    public static function field(string $property, ?string $columnName = null) : self
    {
        return new static($property, SortsField::class, $columnName);
    }

    public static function custom(string $property, $sortClass, ?string $columnName = null) : self
    {
        return new static($property, $sortClass, $columnName);
    }

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

    public function isForProperty(string $property): bool
    {
        return $this->property === $property;
    }

    private function resolveSortClass(): CustomSort
    {
        if ($this->sortClass instanceof CustomSort) {
            return $this->sortClass;
        }

        return new $this->sortClass;
    }

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