musa11971\SortRequest\EloquentSortingHandler

Complexity

Total Complexity

6

Size/Duplication

Total Lines	72
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	handle()	0	17	2
A	checkForTrait()	0	6	2
A	__construct()	0	8	1
A	handleSort()	0	4	1

<?php

namespace musa11971\SortRequest;

use Illuminate\Database\Eloquent\Builder;
use Illuminate\Http\Request;
use musa11971\SortRequest\Exceptions\EloquentSortingException;

class EloquentSortingHandler {
    /** @var Request $request */
    private $request;

    /** @var Builder $builder */
    private $builder;

    /** @var array $rules */
    private $rules;

    /** @var SortableColumnCollection $sortableColumns */
    private $sortableColumns;

    public function __construct($request, $builder)
    {
        $this->request = $request;
        $this->builder = $builder;

        // Get the rules and sortable columns from the request
        $this->rules = $this->request->validatedSortingRules();
        $this->sortableColumns = $this->request->transformedSortableColumns();
    }

    /**
     * Handles the actual Eloquent sorting and returns the builder.
     *
     * @return Builder
     * @throws EloquentSortingException
     */
    function handle()

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

    {
        // Check whether the request uses the trait before continuing
        $this->checkForTrait();

        // Loop through every rule and handle it individually
        foreach($this->rules as $rule)
        {
            // Find the relevant sortable column for this rule
            $sortableColumn = $this->sortableColumns->find($rule['column']);

            // Handle the sorting actions for the column
            $this->handleSort($sortableColumn, $rule, $this->builder);
        }

        // Pass back the builder so that it can be chained
        return $this->builder;
    }

    /**
     * Handle the sorting of a column.
     *
     * @param SortableColumn $sortableColumn
     * @param array $rule
     * @param Builder $builder
     */
    private function handleSort($sortableColumn, $rule, &$builder)
    {
        // Call the sorter's apply method
        $builder = $sortableColumn->sorter->apply(request(), $builder, $rule['direction']);
    }

    /**
     * Checks whether the request uses the trait.
     *
     * @throws EloquentSortingException
     */
    private function checkForTrait()
    {
        if(!method_exists($this->request, 'validatedSortingRules')) {
            $requestClass = get_class($this->request);

            throw new EloquentSortingException("{$requestClass} is not using the SortsViaRequest trait.");
        }
    }
}