SortableTrait::setNewOrder() - Code Metrics - Inspection of "Allow setNewOrder() to accept a custom sort column" - spatie/eloquent-sortable - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#72)

unknown

created 2019-03-22 21:50 UTC

SortableTrait::setNewOrder() A

↳ Parent: SortableTrait

Complexity

Conditions	5
Paths	5

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	20
rs	9.2888
c	0
b	0
f	0
cc	5
nc	5
nop	3

<?php

namespace Spatie\EloquentSortable;

use ArrayAccess;
use InvalidArgumentException;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\SoftDeletingScope;

trait SortableTrait
{
    public static function bootSortableTrait()
    {
        static::creating(function ($model) {

            if ($model instanceof Sortable && $model->shouldSortWhenCreating()) {
                $model->setHighestOrderNumber();
            }
        });
    }

    /**
     * Modify the order column value.
     */
    public function setHighestOrderNumber()
    {
        $orderColumnName = $this->determineOrderColumnName();

        $this->$orderColumnName = $this->getHighestOrderNumber() + 1;
    }

    /**
     * Determine the order value for the new record.
     */
    public function getHighestOrderNumber(): int
    {
        return (int) $this->buildSortQuery()->max($this->determineOrderColumnName());
    }

    /**
     * Let's be nice and provide an ordered scope.
     *
     * @param \Illuminate\Database\Eloquent\Builder $query
     * @param string $direction
     *
     * @return \Illuminate\Database\Query\Builder
     */
    public function scopeOrdered(Builder $query, string $direction = 'asc')
    {
        return $query->orderBy($this->determineOrderColumnName(), $direction);

    }

    /**
     * This function reorders the records: the record with the first id in the array
     * will get order 1, the record with the second it will get order 2, ...
     *
     * A starting order number can be optionally supplied (defaults to 1).
     *
     * @param array|\ArrayAccess $ids
     * @param int $startOrder
     * @param string $primaryKeyColumn
     */
    public static function setNewOrder($ids, int $startOrder = 1, string $primaryKeyColumn = null)
    {
        if (! is_array($ids) && ! $ids instanceof ArrayAccess) {
            throw new InvalidArgumentException('You must pass an array or ArrayAccess object to setNewOrder');
        }

        $model = new static;

        $orderColumnName = $model->determineOrderColumnName();

        if (is_null($primaryKeyColumn)) {
            $primaryKeyColumn = $model->getKeyName();
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        }

        foreach ($ids as $id) {
            static::withoutGlobalScope(SoftDeletingScope::class)
                ->where($primaryKeyColumn, $id)
                ->update([$orderColumnName => $startOrder++]);
        }
    }

    /**
     * This function reorders the records using an alternate column
     * than the model's primary key.
     *
     * A starting order number can be optionally supplied (defaults to 1).
     *
     * @param string $primaryKeyColumn
     * @param array|\ArrayAccess $ids
     * @param int $startOrder
     */
    public static function setNewOrderByCustomColumn(string $primaryKeyColumn, $ids, int $startOrder = 1){
        self::setNewOrder($ids, $startOrder, $primaryKeyColumn);
    }

    /*
     * Determine the column name of the order column.
     */
    protected function determineOrderColumnName(): string
    {
        if (
            isset($this->sortable['order_column_name']) &&
            ! empty($this->sortable['order_column_name'])
        ) {
            return $this->sortable['order_column_name'];
        }

        return 'order_column';
    }

    /**
     * Determine if the order column should be set when saving a new model instance.
     */
    public function shouldSortWhenCreating(): bool
    {
        return $this->sortable['sort_when_creating'] ?? true;
    }

    /**
     * Swaps the order of this model with the model 'below' this model.
     *
     * @return $this
     */
    public function moveOrderDown()

    {
        $orderColumnName = $this->determineOrderColumnName();

        $swapWithModel = $this->buildSortQuery()->limit(1)
            ->ordered()
            ->where($orderColumnName, '>', $this->$orderColumnName)
            ->first();

        if (! $swapWithModel) {
            return $this;
        }

        return $this->swapOrderWithModel($swapWithModel);
    }

    /**
     * Swaps the order of this model with the model 'above' this model.
     *
     * @return $this
     */
    public function moveOrderUp()

    {
        $orderColumnName = $this->determineOrderColumnName();

        $swapWithModel = $this->buildSortQuery()->limit(1)
            ->ordered('desc')
            ->where($orderColumnName, '<', $this->$orderColumnName)
            ->first();

        if (! $swapWithModel) {
            return $this;
        }

        return $this->swapOrderWithModel($swapWithModel);
    }

    /**
     * Swap the order of this model with the order of another model.
     *
     * @param \Spatie\EloquentSortable\Sortable $otherModel
     *
     * @return $this
     */
    public function swapOrderWithModel(Sortable $otherModel)
    {
        $orderColumnName = $this->determineOrderColumnName();

        $oldOrderOfOtherModel = $otherModel->$orderColumnName;

        $otherModel->$orderColumnName = $this->$orderColumnName;
        $otherModel->save();

        $this->$orderColumnName = $oldOrderOfOtherModel;
        $this->save();
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

        return $this;
    }

    /**
     * Swap the order of two models.
     *
     * @param \Spatie\EloquentSortable\Sortable $model
     * @param \Spatie\EloquentSortable\Sortable $otherModel
     */
    public static function swapOrder(Sortable $model, Sortable $otherModel)
    {
        $model->swapOrderWithModel($otherModel);
    }

    /**
     * Moves this model to the first position.
     *
     * @return $this
     */
    public function moveToStart()
    {
        $firstModel = $this->buildSortQuery()->limit(1)
            ->ordered()
            ->first();

        if ($firstModel->id === $this->id) {
class MyClass { }

$x = new MyClass();
$x->foo = true;
            return $this;
        }

        $orderColumnName = $this->determineOrderColumnName();

        $this->$orderColumnName = $firstModel->$orderColumnName;
        $this->save();
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

        $this->buildSortQuery()->where($this->getKeyName(), '!=', $this->id)->increment($orderColumnName);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

        return $this;
    }

    /**
     * Moves this model to the last position.
     *
     * @return $this
     */
    public function moveToEnd()
    {
        $maxOrder = $this->getHighestOrderNumber();

        $orderColumnName = $this->determineOrderColumnName();

        if ($this->$orderColumnName === $maxOrder) {
            return $this;
        }

        $oldOrder = $this->$orderColumnName;

        $this->$orderColumnName = $maxOrder;
        $this->save();
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

        $this->buildSortQuery()->where($this->getKeyName(), '!=', $this->id)
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            ->where($orderColumnName, '>', $oldOrder)
            ->decrement($orderColumnName);

        return $this;
    }

    /**
     * Build eloquent builder of sortable.
     *
     * @return \Illuminate\Database\Eloquent\Builder
     */
    public function buildSortQuery()
    {
        return static::query();
    }
}


1		<?php
2
3		namespace Spatie\EloquentSortable;
4
5		use ArrayAccess;
6		use InvalidArgumentException;
7		use Illuminate\Database\Eloquent\Builder;
8		use Illuminate\Database\Eloquent\SoftDeletingScope;
9
10		trait SortableTrait
11		{
12		public static function bootSortableTrait()
13		{
14		static::creating(function ($model) {
		0 ignored issues – show Bug introduced 2016-10-21 22:32 UTC by Report Bug Copy Issue Report The method `creating()` does not exist on `Spatie\EloquentSortable\SortableTrait`. Did you maybe mean `shouldSortWhenCreating()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
15		if ($model instanceof Sortable && $model->shouldSortWhenCreating()) {
16		$model->setHighestOrderNumber();
17		}
18		});
19		}
20
21		/**
22		* Modify the order column value.
23		*/
24		public function setHighestOrderNumber()
25		{
26		$orderColumnName = $this->determineOrderColumnName();
27
28		$this->$orderColumnName = $this->getHighestOrderNumber() + 1;
29		}
30
31		/**
32		* Determine the order value for the new record.
33		*/
34		public function getHighestOrderNumber(): int
35		{
36		return (int) $this->buildSortQuery()->max($this->determineOrderColumnName());
37		}
38
39		/**
40		* Let's be nice and provide an ordered scope.
41		*
42		* @param \Illuminate\Database\Eloquent\Builder $query
43		* @param string $direction
44		*
45		* @return \Illuminate\Database\Query\Builder
46		*/
47		public function scopeOrdered(Builder $query, string $direction = 'asc')
48		{
49		return $query->orderBy($this->determineOrderColumnName(), $direction);
		0 ignored issues – show Bug introduced 2017-04-05 09:01 UTC by Report Bug Copy Issue Report The method `orderBy()` does not exist on `Illuminate\Database\Eloquent\Builder`. Did you maybe mean `enforceOrderBy()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
50		}
51
52		/**
53		* This function reorders the records: the record with the first id in the array
54		* will get order 1, the record with the second it will get order 2, ...
55		*
56		* A starting order number can be optionally supplied (defaults to 1).
57		*
58		* @param array\|\ArrayAccess $ids
59		* @param int $startOrder
60		* @param string $primaryKeyColumn
61		*/
62		public static function setNewOrder($ids, int $startOrder = 1, string $primaryKeyColumn = null)
63		{
64		if (! is_array($ids) && ! $ids instanceof ArrayAccess) {
65		throw new InvalidArgumentException('You must pass an array or ArrayAccess object to setNewOrder');
66		}
67
68		$model = new static;
69
70		$orderColumnName = $model->determineOrderColumnName();
71
72		if (is_null($primaryKeyColumn)) {
73		$primaryKeyColumn = $model->getKeyName();
		0 ignored issues – show Bug introduced 2016-10-18 22:46 UTC by Report Bug Copy Issue Report It seems like `getKeyName()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
74		}
75
76		foreach ($ids as $id) {
77		static::withoutGlobalScope(SoftDeletingScope::class)
78		->where($primaryKeyColumn, $id)
79		->update([$orderColumnName => $startOrder++]);
80		}
81		}
82
83		/**
84		* This function reorders the records using an alternate column
85		* than the model's primary key.
86		*
87		* A starting order number can be optionally supplied (defaults to 1).
88		*
89		* @param string $primaryKeyColumn
90		* @param array\|\ArrayAccess $ids
91		* @param int $startOrder
92		*/
93		public static function setNewOrderByCustomColumn(string $primaryKeyColumn, $ids, int $startOrder = 1){
94		self::setNewOrder($ids, $startOrder, $primaryKeyColumn);
95		}
96
97		/*
98		* Determine the column name of the order column.
99		*/
100		protected function determineOrderColumnName(): string
101		{
102		if (
103		isset($this->sortable['order_column_name']) &&
104		! empty($this->sortable['order_column_name'])
105		) {
106		return $this->sortable['order_column_name'];
107		}
108
109		return 'order_column';
110		}
111
112		/**
113		* Determine if the order column should be set when saving a new model instance.
114		*/
115		public function shouldSortWhenCreating(): bool
116		{
117		return $this->sortable['sort_when_creating'] ?? true;
118		}
119
120		/**
121		* Swaps the order of this model with the model 'below' this model.
122		*
123		* @return $this
124		*/
125	View Code Duplication	public function moveOrderDown()
		0 ignored issues – show Duplication introduced 2017-08-30 15:43 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
126		{
127		$orderColumnName = $this->determineOrderColumnName();
128
129		$swapWithModel = $this->buildSortQuery()->limit(1)
130		->ordered()
131		->where($orderColumnName, '>', $this->$orderColumnName)
132		->first();
133
134		if (! $swapWithModel) {
135		return $this;
136		}
137
138		return $this->swapOrderWithModel($swapWithModel);
139		}
140
141		/**
142		* Swaps the order of this model with the model 'above' this model.
143		*
144		* @return $this
145		*/
146	View Code Duplication	public function moveOrderUp()
		0 ignored issues – show Duplication introduced 2017-08-30 15:43 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
147		{
148		$orderColumnName = $this->determineOrderColumnName();
149
150		$swapWithModel = $this->buildSortQuery()->limit(1)
151		->ordered('desc')
152		->where($orderColumnName, '<', $this->$orderColumnName)
153		->first();
154
155		if (! $swapWithModel) {
156		return $this;
157		}
158
159		return $this->swapOrderWithModel($swapWithModel);
160		}
161
162		/**
163		* Swap the order of this model with the order of another model.
164		*
165		* @param \Spatie\EloquentSortable\Sortable $otherModel
166		*
167		* @return $this
168		*/
169		public function swapOrderWithModel(Sortable $otherModel)
170		{
171		$orderColumnName = $this->determineOrderColumnName();
172
173		$oldOrderOfOtherModel = $otherModel->$orderColumnName;
174
175		$otherModel->$orderColumnName = $this->$orderColumnName;
176		$otherModel->save();
177
178		$this->$orderColumnName = $oldOrderOfOtherModel;
179		$this->save();
		0 ignored issues – show Bug introduced 2017-01-28 19:34 UTC by Report Bug Copy Issue Report It seems like `save()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
180
181		return $this;
182		}
183
184		/**
185		* Swap the order of two models.
186		*
187		* @param \Spatie\EloquentSortable\Sortable $model
188		* @param \Spatie\EloquentSortable\Sortable $otherModel
189		*/
190		public static function swapOrder(Sortable $model, Sortable $otherModel)
191		{
192		$model->swapOrderWithModel($otherModel);
193		}
194
195		/**
196		* Moves this model to the first position.
197		*
198		* @return $this
199		*/
200		public function moveToStart()
201		{
202		$firstModel = $this->buildSortQuery()->limit(1)
203		->ordered()
204		->first();
205
206		if ($firstModel->id === $this->id) {
		0 ignored issues – show Bug introduced 2016-10-18 21:42 UTC by Report Bug Copy Issue Report The property `id` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
207		return $this;
208		}
209
210		$orderColumnName = $this->determineOrderColumnName();
211
212		$this->$orderColumnName = $firstModel->$orderColumnName;
213		$this->save();
		0 ignored issues – show Bug introduced 2017-04-16 10:13 UTC by Report Bug Copy Issue Report It seems like `save()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
214
215		$this->buildSortQuery()->where($this->getKeyName(), '!=', $this->id)->increment($orderColumnName);
		0 ignored issues – show Bug introduced 2016-10-19 14:01 UTC by Report Bug Copy Issue Report It seems like `getKeyName()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
216
217		return $this;
218		}
219
220		/**
221		* Moves this model to the last position.
222		*
223		* @return $this
224		*/
225		public function moveToEnd()
226		{
227		$maxOrder = $this->getHighestOrderNumber();
228
229		$orderColumnName = $this->determineOrderColumnName();
230
231		if ($this->$orderColumnName === $maxOrder) {
232		return $this;
233		}
234
235		$oldOrder = $this->$orderColumnName;
236
237		$this->$orderColumnName = $maxOrder;
238		$this->save();
		0 ignored issues – show Bug introduced 2017-04-16 10:13 UTC by Report Bug Copy Issue Report It seems like `save()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
239
240		$this->buildSortQuery()->where($this->getKeyName(), '!=', $this->id)
		0 ignored issues – show Bug introduced 2016-10-18 22:48 UTC by Report Bug Copy Issue Report It seems like `getKeyName()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
241		->where($orderColumnName, '>', $oldOrder)
242		->decrement($orderColumnName);
243
244		return $this;
245		}
246
247		/**
248		* Build eloquent builder of sortable.
249		*
250		* @return \Illuminate\Database\Eloquent\Builder
251		*/
252		public function buildSortQuery()
253		{
254		return static::query();
255		}
256		}
257

spatie / eloquent-sortable

Pull Request — master (#72)

SortableTrait::setNewOrder() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like