BuilderOverride::findOrFail() - Code Metrics - mjducharme/laravel-model-json-storage - Measure and Improve Code Quality continuously with Scrutinizer

BuilderOverride::findOrFail() A
last analyzed 2021-07-31 03:07 UTC

↳ Parent: BuilderOverride

Complexity

Conditions	2
Paths	2

Size

Total Lines	8
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	2.1481

Importance

Changes

Metric	Value
cc	2
eloc	5
c	0
b	0
f	0
nc	2
nop	2
dl	0
loc	8
ccs	4
cts	6
cp	0.6667
crap	2.1481
rs	10

<?php

namespace Okipa\LaravelModelJsonStorage;

use Illuminate\Database\Eloquent\ModelNotFoundException;
use Illuminate\Pagination\LengthAwarePaginator;
use Illuminate\Pagination\Paginator;
use Illuminate\Support\Collection;

trait BuilderOverride
{
    /**
     * The "select" clauses of the query.
     *
     * @var array
     */
    protected $selects = [];
    /**
     * The "where" clauses of the query.
     *
     * @var array
     */
    protected $wheres = [];
    /**
     * The "whereIn" clauses of the query.
     *
     * @var array
     */
    protected $whereIns = [];
    /**
     * The "whereNotIn" clauses of the query.
     *
     * @var array
     */
    protected $whereNotIns = [];
    /**
     * The "orderBy" clauses of the query.
     *
     * @var array
     */
    protected $orderBys = [];

    /**
     * Get the number of models to return per page.
     *
     * @return int
     */
    abstract public function getPerPage();

    /**
     * Set the column to be selected.
     *
     * @param  string $column
     *
     * @return $this
     */
    public function select(string $column)
    {
        $this->selects[] = $column;

        return $this;
    }

    /**
     * Add a new select column to the query.
     *
     * @param  string $column
     *
     * @return $this
     */
    public function addSelect(string $column)
    {
        $this->selects[] = $column;

        return $this;
    }

    /**
     * Add a "where in" clause to the query.
     *
     * @param string $column
     * @param array  $values
     *
     * @return $this
     */
    public function whereIn(string $column, array $values)
    {
        $this->whereIns[] = compact('column', 'values');

        return $this;
    }

    /**
     * Add a "where not in" clause to the query.
     *
     * @param string $column
     * @param array  $values
     *
     * @return $this
     */
    public function whereNotIn(string $column, array $values)
    {
        $this->whereNotIns[] = compact('column', 'values');

        return $this;
    }

    /**
     * Add an "order by" clause to the query.
     *
     * @param  string $column
     * @param  string $direction
     *
     * @return $this
     */
    public function orderBy(string $column, string $direction = 'asc')
    {
        $this->orderBys[] = compact('column', 'direction');

        return $this;
    }

    /**
     * Find a model by its primary key or throw an exception.
     *
     * @param  mixed $id
     * @param  array $columns
     *
     * @return \Illuminate\Database\Eloquent\Model|\Illuminate\Database\Eloquent\Collection
     * @throws \Illuminate\Database\Eloquent\ModelNotFoundException
     */
    public function findOrFail(int $id, array $columns = ['*'])
    {
        $result = $this->find($id, $columns);
        if (! is_null($result)) {
            return $result;
        }
        throw (new ModelNotFoundException)->setModel(
            get_class($this), $id
        );
    }

    /**
     * Execute a query for a single record by ID.
     *
     * @param  int   $id
     * @param  array $columns
     *
     * @return mixed|static
     */
    public function find(int $id, array $columns = ['*'])
    {
        return $this->where('id', '=', $id)->first($columns);
    }

    /**
     * Execute the query and get the first result.
     *
     * @param  array $columns
     *
     * @return Model|null
     */
    abstract public function first(array $columns = ['*']);

    /**
     * Add a basic where clause to the query.
     *
     * @param  string $column
     * @param  mixed  $operator
     * @param  mixed  $value
     *
     * @return $this
     */
    public function where(string $column, $operator = null, $value = null)
    {
        if (! isset($value)) {
            $value = $operator;
            $operator = '=';
        }
        $this->wheres[] = compact('column', 'operator', 'value');

        return $this;
    }

    /**
     * Get a single column's value from the first result of a query.
     *
     * @param string $column
     * The "pluck" collection method is used under the hood.
     *
     * @return Collection
     */
    public function value(string $column)
    {
        return $this->get()->pluck($column)->first();
    }

    /**
     * Execute the query as a "select" statement.
     *
     * @param  array $columns
     *
     * @return Collection
     */
    public function get(array $columns = ['*'])
    {
        if ($columns !== ['*']) {
            $this->selects = $columns;
        }
        $modelsCollection = $this->loadModelsFromJson();
        $this->applyWhereClauses($modelsCollection);
        $this->applyWhereInClauses($modelsCollection);
        $this->applyWhereNotInClauses($modelsCollection);
        $this->applyOrderByClauses($modelsCollection);
        $this->applySelectClauses($modelsCollection);

        return $modelsCollection->values();
    }

    /**
     * Apply the "where" clauses on the collection.
     *
     * @param $modelsCollection
     *
     * @return void
     */
    protected function applyWhereClauses(Collection &$modelsCollection)
    {
        if (! empty($this->wheres) && ! $modelsCollection->isEmpty()) {
            foreach ($this->wheres as $where) {
                $modelsCollection = $modelsCollection->where($where['column'], $where['operator'], $where['value']);
            }
        }
    }

    /**
     * Apply the "whereIn" clauses on the collection.
     *
     * @param $modelsCollection
     *
     * @return void
     */
    protected function applyWhereInClauses(Collection &$modelsCollection)
    {
        if (! empty($this->whereIns) && ! $modelsCollection->isEmpty()) {
            foreach ($this->whereIns as $whereIn) {
                $modelsCollection = $modelsCollection->whereIn($whereIn['column'], $whereIn['values']);
            }
        }
    }

    /**
     * Apply the "whereNotIn" clauses on the collection.
     *
     * @param $modelsCollection
     *
     * @return void
     */
    protected function applyWhereNotInClauses(Collection &$modelsCollection)
    {
        if (! empty($this->whereNotIns) && ! $modelsCollection->isEmpty()) {
            foreach ($this->whereNotIns as $whereNotIn) {
                $modelsCollection = $modelsCollection->whereNotIn($whereNotIn['column'], $whereNotIn['values']);
            }
        }
    }

    /**
     * Apply the "orderBy" clauses on the collection.
     *
     * @param $modelsCollection
     *
     * @return void
     */
    protected function applyOrderByClauses(Collection &$modelsCollection)
    {
        if (! empty($this->orderBys) && ! $modelsCollection->isEmpty()) {
            foreach ($this->orderBys as $orders) {
                $modelsCollection = $modelsCollection->sortBy(
                    $orders['column'],
                    SORT_REGULAR,
                    $orders['direction'] === 'desc'
                );
            }
        }
    }

    /**
     * Apply the "select" clauses on the collection.
     *
     * @param $modelsCollection
     *
     * @return void
     */
    protected function applySelectClauses(Collection &$modelsCollection)
    {
        if (! empty($this->selects) && $this->selects !== ['*'] && ! $modelsCollection->isEmpty()) {
            $selectCollection = new Collection();
            $modelsCollection->each(function($model) use ($selectCollection) {
                $selectCollection->push(collect($model->toArray())->only(array_unique($this->selects)));
            });
            $modelsCollection = $selectCollection;
        }
    }

    /**
     * Get an array with the values of a given column.
     *
     * @param string $column
     * @param string null|$key

     *
     * @return Collection
     */
    public function pluck(string $column, string $key = null)
    {
        return $this->get()->pluck($column, $key);
    }

    /**
     * Retrieve the "count" result of the query.
     *
     * @param  array $columns
     *
     * @return int
     */
    public function count(array $columns = ['*'])
    {
        return $this->get($columns)->count();
    }

    /**
     * Retrieve the minimum value of a given column.
     *
     * @param $column
     *
     * @return int
     */
    public function min(string $column)
    {
        return $this->get()->min($column);
    }

    /**
     * Retrieve the maximum value of a given column.
     *
     * @param  string $column
     *
     * @return int
     */
    public function max(string $column)
    {
        return $this->get()->max($column);
    }

    /**
     * Retrieve the average of the values of a given column.
     *
     * @param  string $column
     *
     * @return mixed
     */
    public function avg($column)
    {
        return $this->get()->avg($column);
    }

    /**
     * Paginate the given query.
     *
     * @param  int|null $perPage
     * @param  array    $columns
     * @param  string   $pageName
     * @param  int|null $page
     *
     * @return \Illuminate\Contracts\Pagination\LengthAwarePaginator
     * @throws \InvalidArgumentException
     */
    public function paginate(int $perPage = null, array $columns = ['*'], string $pageName = 'page', int $page = null)
    {
        $page = $page ?: Paginator::resolveCurrentPage($pageName);
        $perPage = $perPage ?: $this->getPerPage();
        $modelsCollection = $this->get($columns);
        $items = $modelsCollection->forPage($page, $perPage)->values();
        $total = $modelsCollection->count();

        return new LengthAwarePaginator(
            $items,
            $total,
            $perPage,
            $page,
            [
                'path'     => Paginator::resolveCurrentPath(),
                'pageName' => $pageName,
            ]
        );
    }

    /**
     * Load all of the models from the json file in the "modelsFromJson" variable.
     *
     * @return Collection
     */
    abstract protected function loadModelsFromJson();
}


1		<?php
2
3		namespace Okipa\LaravelModelJsonStorage;
4
5		use Illuminate\Database\Eloquent\ModelNotFoundException;
6		use Illuminate\Pagination\LengthAwarePaginator;
7		use Illuminate\Pagination\Paginator;
8		use Illuminate\Support\Collection;
9
10		trait BuilderOverride
11		{
12		/**
13		* The "select" clauses of the query.
14		*
15		* @var array
16		*/
17		protected $selects = [];
18		/**
19		* The "where" clauses of the query.
20		*
21		* @var array
22		*/
23		protected $wheres = [];
24		/**
25		* The "whereIn" clauses of the query.
26		*
27		* @var array
28		*/
29		protected $whereIns = [];
30		/**
31		* The "whereNotIn" clauses of the query.
32		*
33		* @var array
34		*/
35		protected $whereNotIns = [];
36		/**
37		* The "orderBy" clauses of the query.
38		*
39		* @var array
40		*/
41		protected $orderBys = [];
42
43		/**
44		* Get the number of models to return per page.
45		*
46		* @return int
47		*/
48		abstract public function getPerPage();
49
50		/**
51		* Set the column to be selected.
52		*
53		* @param string $column
54		*
55		* @return $this
56		*/
57	2	public function select(string $column)
58		{
59	2	$this->selects[] = $column;
60
61	2	return $this;
62		}
63
64		/**
65		* Add a new select column to the query.
66		*
67		* @param string $column
68		*
69		* @return $this
70		*/
71	1	public function addSelect(string $column)
72		{
73	1	$this->selects[] = $column;
74
75	1	return $this;
76		}
77
78		/**
79		* Add a "where in" clause to the query.
80		*
81		* @param string $column
82		* @param array $values
83		*
84		* @return $this
85		*/
86	1	public function whereIn(string $column, array $values)
87		{
88	1	$this->whereIns[] = compact('column', 'values');
89
90	1	return $this;
91		}
92
93		/**
94		* Add a "where not in" clause to the query.
95		*
96		* @param string $column
97		* @param array $values
98		*
99		* @return $this
100		*/
101	4	public function whereNotIn(string $column, array $values)
102		{
103	4	$this->whereNotIns[] = compact('column', 'values');
104
105	4	return $this;
106		}
107
108		/**
109		* Add an "order by" clause to the query.
110		*
111		* @param string $column
112		* @param string $direction
113		*
114		* @return $this
115		*/
116	1	public function orderBy(string $column, string $direction = 'asc')
117		{
118	1	$this->orderBys[] = compact('column', 'direction');
119
120	1	return $this;
121		}
122
123		/**
124		* Find a model by its primary key or throw an exception.
125		*
126		* @param mixed $id
127		* @param array $columns
128		*
129		* @return \Illuminate\Database\Eloquent\Model\|\Illuminate\Database\Eloquent\Collection
130		* @throws \Illuminate\Database\Eloquent\ModelNotFoundException
131		*/
132	1	public function findOrFail(int $id, array $columns = ['*'])
133		{
134	1	$result = $this->find($id, $columns);
135	1	if (! is_null($result)) {
136	1	return $result;
137		}
138		throw (new ModelNotFoundException)->setModel(
139		get_class($this), $id
140		);
141		}
142
143		/**
144		* Execute a query for a single record by ID.
145		*
146		* @param int $id
147		* @param array $columns
148		*
149		* @return mixed\|static
150		*/
151	2	public function find(int $id, array $columns = ['*'])
152		{
153	2	return $this->where('id', '=', $id)->first($columns);
154		}
155
156		/**
157		* Execute the query and get the first result.
158		*
159		* @param array $columns
160		*
161		* @return Model\|null
162		*/
163		abstract public function first(array $columns = ['*']);
164
165		/**
166		* Add a basic where clause to the query.
167		*
168		* @param string $column
169		* @param mixed $operator
170		* @param mixed $value
171		*
172		* @return $this
173		*/
174	4	public function where(string $column, $operator = null, $value = null)
175		{
176	4	if (! isset($value)) {
177	2	$value = $operator;
178	2	$operator = '=';
179		}
180	4	$this->wheres[] = compact('column', 'operator', 'value');
181
182	4	return $this;
183		}
184
185		/**
186		* Get a single column's value from the first result of a query.
187		*
188		* @param string $column
189		* The "pluck" collection method is used under the hood.
190		*
191		* @return Collection
192		*/
193	1	public function value(string $column)
194		{
195	1	return $this->get()->pluck($column)->first();
196		}
197
198		/**
199		* Execute the query as a "select" statement.
200		*
201		* @param array $columns
202		*
203		* @return Collection
204		*/
205	22	public function get(array $columns = ['*'])
206		{
207	22	if ($columns !== ['*']) {
208	2	$this->selects = $columns;
209		}
210	22	$modelsCollection = $this->loadModelsFromJson();
211	22	$this->applyWhereClauses($modelsCollection);
212	22	$this->applyWhereInClauses($modelsCollection);
213	22	$this->applyWhereNotInClauses($modelsCollection);
214	22	$this->applyOrderByClauses($modelsCollection);
215	22	$this->applySelectClauses($modelsCollection);
216
217	22	return $modelsCollection->values();
218		}
219
220		/**
221		* Apply the "where" clauses on the collection.
222		*
223		* @param $modelsCollection
224		*
225		* @return void
226		*/
227	22	protected function applyWhereClauses(Collection &$modelsCollection)
228		{
229	22	if (! empty($this->wheres) && ! $modelsCollection->isEmpty()) {
230	4	foreach ($this->wheres as $where) {
231	4	$modelsCollection = $modelsCollection->where($where['column'], $where['operator'], $where['value']);
232		}
233		}
234	22	}
235
236		/**
237		* Apply the "whereIn" clauses on the collection.
238		*
239		* @param $modelsCollection
240		*
241		* @return void
242		*/
243	22	protected function applyWhereInClauses(Collection &$modelsCollection)
244		{
245	22	if (! empty($this->whereIns) && ! $modelsCollection->isEmpty()) {
246	1	foreach ($this->whereIns as $whereIn) {
247	1	$modelsCollection = $modelsCollection->whereIn($whereIn['column'], $whereIn['values']);
248		}
249		}
250	22	}
251
252		/**
253		* Apply the "whereNotIn" clauses on the collection.
254		*
255		* @param $modelsCollection
256		*
257		* @return void
258		*/
259	22	protected function applyWhereNotInClauses(Collection &$modelsCollection)
260		{
261	22	if (! empty($this->whereNotIns) && ! $modelsCollection->isEmpty()) {
262	4	foreach ($this->whereNotIns as $whereNotIn) {
263	4	$modelsCollection = $modelsCollection->whereNotIn($whereNotIn['column'], $whereNotIn['values']);
264		}
265		}
266	22	}
267
268		/**
269		* Apply the "orderBy" clauses on the collection.
270		*
271		* @param $modelsCollection
272		*
273		* @return void
274		*/
275	22	protected function applyOrderByClauses(Collection &$modelsCollection)
276		{
277	22	if (! empty($this->orderBys) && ! $modelsCollection->isEmpty()) {
278	1	foreach ($this->orderBys as $orders) {
279	1	$modelsCollection = $modelsCollection->sortBy(
280	1	$orders['column'],
281	1	SORT_REGULAR,
282	1	$orders['direction'] === 'desc'
283		);
284		}
285		}
286	22	}
287
288		/**
289		* Apply the "select" clauses on the collection.
290		*
291		* @param $modelsCollection
292		*
293		* @return void
294		*/
295	22	protected function applySelectClauses(Collection &$modelsCollection)
296		{
297	22	if (! empty($this->selects) && $this->selects !== ['*'] && ! $modelsCollection->isEmpty()) {
298	4	$selectCollection = new Collection();
299		$modelsCollection->each(function($model) use ($selectCollection) {
300	4	$selectCollection->push(collect($model->toArray())->only(array_unique($this->selects)));
301	4	});
302	4	$modelsCollection = $selectCollection;
303		}
304	22	}
305
306		/**
307		* Get an array with the values of a given column.
308		*
309		* @param string $column
310		* @param string null\|$key
		0 ignored issues – show Documentation Bug introduced 2021-07-31 02:26 UTC by Report Bug Copy Issue Report The doc comment `null\|$key` at position `2` could not be parsed: Unknown type name '$key' at position 2 in null\|$key. Loading history...
311		*
312		* @return Collection
313		*/
314	1	public function pluck(string $column, string $key = null)
315		{
316	1	return $this->get()->pluck($column, $key);
317		}
318
319		/**
320		* Retrieve the "count" result of the query.
321		*
322		* @param array $columns
323		*
324		* @return int
325		*/
326	1	public function count(array $columns = ['*'])
327		{
328	1	return $this->get($columns)->count();
329		}
330
331		/**
332		* Retrieve the minimum value of a given column.
333		*
334		* @param $column
335		*
336		* @return int
337		*/
338	1	public function min(string $column)
339		{
340	1	return $this->get()->min($column);
341		}
342
343		/**
344		* Retrieve the maximum value of a given column.
345		*
346		* @param string $column
347		*
348		* @return int
349		*/
350	1	public function max(string $column)
351		{
352	1	return $this->get()->max($column);
353		}
354
355		/**
356		* Retrieve the average of the values of a given column.
357		*
358		* @param string $column
359		*
360		* @return mixed
361		*/
362	1	public function avg($column)
363		{
364	1	return $this->get()->avg($column);
365		}
366
367		/**
368		* Paginate the given query.
369		*
370		* @param int\|null $perPage
371		* @param array $columns
372		* @param string $pageName
373		* @param int\|null $page
374		*
375		* @return \Illuminate\Contracts\Pagination\LengthAwarePaginator
376		* @throws \InvalidArgumentException
377		*/
378	1	public function paginate(int $perPage = null, array $columns = ['*'], string $pageName = 'page', int $page = null)
379		{
380	1	$page = $page ?: Paginator::resolveCurrentPage($pageName);
381	1	$perPage = $perPage ?: $this->getPerPage();
382	1	$modelsCollection = $this->get($columns);
383	1	$items = $modelsCollection->forPage($page, $perPage)->values();
384	1	$total = $modelsCollection->count();
385
386	1	return new LengthAwarePaginator(
387	1	$items,
388	1	$total,
389	1	$perPage,
390	1	$page,
391		[
392	1	'path' => Paginator::resolveCurrentPath(),
393	1	'pageName' => $pageName,
394		]
395		);
396		}
397
398		/**
399		* Load all of the models from the json file in the "modelsFromJson" variable.
400		*
401		* @return Collection
402		*/
403		abstract protected function loadModelsFromJson();
404		}
405

mjducharme / laravel-model-json-storage

BuilderOverride::findOrFail() A last analyzed 2021-07-31 03:07 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

BuilderOverride::findOrFail() A
last analyzed 2021-07-31 03:07 UTC