musa11971\SortRequest\Traits\SortsViaRequest

Complexity

Total Complexity

5

Size/Duplication

Total Lines	52
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	sortingRules()	0	4	1
A	transformedSortableColumns()	0	3	1
A	__construct()	0	7	2
A	validatedSortingRules()	0	3	1

<?php

namespace musa11971\SortRequest\Traits;

use Illuminate\Foundation\Http\FormRequest;
use musa11971\SortRequest\Exceptions\BadTraitImplementation;
use musa11971\SortRequest\Rules\SortParameter;

trait SortsViaRequest
{
    /**
     * Returns the columns that can be sorted on.
     *
     * @return array
     */
    abstract function getSortableColumns(): array;

It is generally recommended to explicitly declare the visibility for methods.

    /** @var SortParameter $sortParameterRule */
    private $sortParameterRule;

    /** @noinspection PhpUnhandledExceptionInspection */
    public function __construct()
    {
        if(!($this instanceof FormRequest))
            throw new BadTraitImplementation(__TRAIT__);

        // Create an instance of the validation rule
        $this->sortParameterRule = new SortParameter($this->getSortableColumns());
    }

    /**
     * Returns the validated sorting rules.
     *
     * @return array
     */
    function validatedSortingRules()

It is generally recommended to explicitly declare the visibility for methods.

    {
        return $this->sortParameterRule->sortingRules;
    }

    /**
     * Returns the transformed sortable columns.
     *
     * @return \musa11971\SortRequest\SortableColumnCollection
     */
    function transformedSortableColumns()

It is generally recommended to explicitly declare the visibility for methods.

    {
        return $this->sortParameterRule->sortableColumns;
    }

    /**
     * Get the validation rules for the sorting.
     *
     * @param string $parameterName
     * @return array
     */
    protected function sortingRules($parameterName = 'sort')
    {
        return [
            $parameterName => [$this->sortParameterRule]
        ];
    }
}