Spatie\QueryBuilder\AllowedSort

Complexity

Total Complexity

9

Size/Duplication

Total Lines	62
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	1

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	10	1
A	parseSortDirection()	0	4	2
A	sort()	0	6	1
A	field()	0	4	1
A	custom()	0	4	1
A	getName()	0	4	1
A	isSort()	0	4	1
A	getInternalName()	0	4	1

<?php

namespace Spatie\QueryBuilder;

use Spatie\QueryBuilder\Sorts\Sort;
use Spatie\QueryBuilder\Sorts\SortsField;
use Spatie\QueryBuilder\Enums\SortDirection;

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

    /** @var \Spatie\QueryBuilder\Sorts\Sort */
    protected $name;

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

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

    public function __construct(string $name, Sort $sortClass, ?string $internalName = null)
    {
        $this->name = ltrim($name, '-');

It seems like ltrim($name, '-') of type string is incompatible with the declared type object<Spatie\QueryBuilder\Sorts\Sort> of property $name.

        $this->sortClass = $sortClass;

It seems like $sortClass of type object<Spatie\QueryBuilder\Sorts\Sort> is incompatible with the declared type string of property $sortClass.

        $this->defaultDirection = static::parseSortDirection($name);

        $this->internalName = $internalName ?? $this->name;
    }

    public static function parseSortDirection(string $name): string
    {
        return strpos($name, '-') === 0 ? SortDirection::DESCENDING : SortDirection::ASCENDING;
    }

    public function sort(QueryBuilder $query, ?bool $descending = null): void
    {
        $descending = $descending ?? ($this->defaultDirection === SortDirection::DESCENDING);

        ($this->sortClass)($query, $descending, $this->internalName);
    }

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

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

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

    public function isSort(string $sortName): bool
    {
        return $this->name === $sortName;
    }

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