SebastianBerc\Repositories\Traits\Sortable

Complexity

Total Complexity

16

Size/Duplication

Total Lines	159
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Test Coverage

Coverage

76.47%

Importance

Changes	9
Bugs	3	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	multiSortBy()	0	12	3
B	sortByRelation()	0	31	4
B	joinRelation()	0	18	5
A	joinBelongsToMany()	0	14	1
A	joinBelongsTo()	0	9	1
A	joinHasOneOrMany()	0	9	1
A	sortBy()	0	6	1

<?php

namespace SebastianBerc\Repositories\Traits;

use DB;
use Illuminate\Database\Eloquent\Relations\BelongsTo;
use Illuminate\Database\Eloquent\Relations\BelongsToMany;
use Illuminate\Database\Eloquent\Relations\HasMany;
use Illuminate\Database\Eloquent\Relations\HasOne;
use Illuminate\Database\Eloquent\Relations\HasOneOrMany;
use Illuminate\Database\Eloquent\Relations\Relation;

/**
 * Class Sortable.
 *
 * @author    Sebastian Berć <sebastian.berc@gmail.com>
 * @copyright Copyright (c) Sebastian Berć
 */
trait Sortable
{
    /**
     * Append many column sorting to query builder.
     *
     * @param array $columns
     *
     * @return $this
     */
    public function multiSortBy(array $columns)
    {
        foreach ($columns as $column => $direction) {
            if (strpos($column, '.')) {
                $this->sortByRelation($column, $direction);

$column is of type integer|string, but the function expects a array.

            } else {
                $this->sortBy($column, $direction);
            }
        }

        return $this;
    }

    /**
     * Append relation column sorting to query builder.
     *
     * @param array  $column
     * @param string $direction
     *
     * @return $this
     */
    public function sortByRelation($column, $direction = 'ASC')
    {
        $relations = explode('.', $column);
        $column    = array_pop($relations);

        /** @var \Illuminate\Database\Eloquent\Model $model */
        $model = $this->repository->makeModel();

The property repository does not exist. Did you maybe forget to declare it?

        $this->instance->getQuery()->orders = [];

The property instance does not exist. Did you maybe forget to declare it?

        foreach ($relations as $relation) {
            /* @var Relation $relationClass */
            $this->joinRelation($relationClass = $model->{camel_case($relation)}());

            $model = $relationClass->getRelated();
        }

        $selectedColumns = $this->instance->getQuery()->columns;

        $addColumn = DB::raw("{$this->repository->makeModel()->getTable()}.*");

        if (is_array($selectedColumns) && array_search('*', $selectedColumns, true) !== null) {
            $this->instance->getQuery()->columns[array_search('*', $selectedColumns, true)] = $addColumn;
        } else {
            $this->instance->select($addColumn);
        }

        $this->instance->orderBy("{$model->getTable()}.{$column}", $direction);

        return $this;
    }

    /**
     * Add joining the tables to query based on the type of relationship.
     *
     * @param Relation $relationClass
     *
     * @return $this
     */
    protected function joinRelation(Relation $relationClass)
    {
        switch (get_class($relationClass)) {
            case BelongsToMany::class:
                /* @var BelongsToMany $relationClass */
                $this->joinBelongsToMany($relationClass);
                break;
            case BelongsTo::class:
                /* @var BelongsTo $relationClass */
                $this->joinBelongsTo($relationClass);
                break;
            case HasOne::class:
            case HasMany::class:
                /* @var HasOneOrMany $relationClass */
                $this->joinHasOneOrMany($relationClass);
                break;
        }
    }

    /**
     * Join a belongs to many relationship.
     *
     * @param BelongsToMany $relation
     *
     * @return mixed
     */
    protected function joinBelongsToMany(BelongsToMany $relation)
    {
        return $this->instance->join(
            $relation->getTable(),
            $relation->getParent()->getTable() . '.' . $relation->getParent()->getKeyName(),
            '=',
            $relation->getForeignKey()
        )->join(
            $relation->getRelated()->getTable(),
            $relation->getRelated()->getTable() . '.' . $relation->getRelated()->getKeyName(),
            '=',
            $relation->getOtherKey()
        );
    }

    /**
     * Join a belongs to relationship.
     *
     * @param BelongsTo $relation
     *
     * @return mixed
     */
    protected function joinBelongsTo(BelongsTo $relation)
    {
        return $this->instance->join(
            $relation->getRelated()->getTable(),
            $relation->getQualifiedOtherKeyName(),
            '=',
            $relation->getQualifiedForeignKey()
        );
    }

    /**
     * Join a has one relationship.
     *
     * @param HasOneOrMany $relation
     *
     * @return mixed
     */
    protected function joinHasOneOrMany(HasOneOrMany $relation)
    {
        return $this->instance->join(
            $relation->getRelated()->getTable(),
            $relation->getRelated()->getTable() . '.' . $relation->getParent()->getForeignKey(),
            '=',
            $relation->getParent()->getTable() . '.' . $relation->getParent()->getKeyName()
        );
    }

    /**
     * Append column sorting to query builder.
     *
     * @param string|array $column
     * @param string       $direction
     *
     * @return $this
     */
    public function sortBy($column, $direction = 'ASC')
    {
        $this->instance->orderBy($column, $direction);

        return $this;
    }
}