Sfneal\Scopes\OrderScope

Complexity

Total Complexity

3

Size/Duplication

Total Lines	47
Duplicated Lines	0 %

Importance

Changes	3
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	apply()	0	9	2

<?php

namespace Sfneal\Scopes;

use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Scope;

class OrderScope implements Scope
{
    /**
     * @var string Name of the column that identifies order
     */
    private string $column;

    /**
     * @var string Direction to order results (asc or desc)
     */
    private string $direction;

    /**
     * @var bool Raw OrderBy clause to order null values last
     */
    private bool $raw;

    /**
     * OrderOrderScope constructor.
     *
     * @param  string  $column
     * @param  string  $direction
     * @param  bool  $raw
     */
    public function __construct(string $column = 'order', string $direction = 'desc', bool $raw = false)
    {
        $this->column = $column;
        $this->direction = ucwords($direction);
        $this->raw = $raw;
    }

    /**
     * Apply the scope to a given Eloquent query builder.
     *
     * @param  Builder  $builder
     * @param  Model  $model
     * @return void
     */
    public function apply(Builder $builder, Model $model): void
    {
        // Use '-' prefix to order NULL values last
        if ($this->raw) {
            $builder->orderByRaw("-`{$this->column}` desc");
        }

        // Standard orderBy clause
        $builder->orderBy($this->column, $this->direction);
    }
}