Repository::with() - Code Metrics - ozanakman/laravel-repository-generator - Measure and Improve Code Quality continuously with Scrutinizer

Repository::with() A
last analyzed 2017-09-12 12:42 UTC

↳ Parent: Repository

Complexity

Conditions	2
Paths	2

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	6
rs	9.4285
c	0
b	0
f	0
cc	2
eloc	3
nc	2
nop	1

<?php

namespace OzanAkman\RepositoryGenerator;

use InvalidArgumentException;

abstract class Repository implements RepositoryInterface
{
    /**
     * The model being used by repository.
     *
     * @var
     */
    public $model;

    /**
     * The relationships that should be eager loaded.
     *
     * @var array
     */
    public $relations = [];

    /**
     * Basic where clauses to affect query.
     *
     * @var array
     */
    protected $wheres = [];

    /**
     * The columns being selected.
     *
     * @var
     */
    protected $columns;

    /**
     * Indicates whether active column is being used.
     *
     * @var bool
     */
    public $active = false;

    /**
     * All of the available clause operators.
     *
     * @var array
     */
    public $operators = [
        '=', '<', '>', '<=', '>=', '<>', '!=',
        'like', 'like binary', 'not like', 'between', 'ilike',
        '&', '|', '^', '<<', '>>',
        'rlike', 'regexp', 'not regexp',
        '~', '~*', '!~', '!~*', 'similar to',
        'not similar to', 'not ilike', '~~*', '!~~*',
    ];

    /**
     * Create a new repository instance.
     *
     * @param $model
     */
    public function __construct($model)
    {
        $this->model = $model;
    }

    /**
     * Set the columns to be selected.
     *
     * @param  array|mixed $columns
     * @return $this
     */
    public function select($columns = ['*'])
    {
        $this->columns = is_array($columns) ? $columns : func_get_args();

        return $this;
    }

    /**
     * Set the query to get only active records from database.
     *
     * @return $this
     */
    public function active()
    {
        $this->where(config('repository-generator.active_column'), 1);

        return $this;
    }

    /**
     * Add a basic where clause to the query.
     *
     * @param $column
     * @param string $operator
     * @param mixed $value
     * @param string $boolean
     * @return $this
     */
    public function where($column, $operator = null, $value = null, $boolean = 'and')
    {
        list($value, $operator) = $this->prepareValueAndOperator(
            $value, $operator, func_num_args() == 2
        );

        if ($this->invalidOperator($operator)) {
            list($value, $operator) = [$operator, '='];

        }

        $this->wheres[] = compact(
            'type', 'column', 'operator', 'value', 'boolean'
        );

        return $this;
    }

    /**
     * Add a "where in" clause to the query.
     *
     * @param  string $column
     * @param  mixed $values
     * @param  string $boolean
     * @param  bool $not
     * @return $this
     */
    public function whereIn($column, $values, $boolean = 'and', $not = false)
    {
        $type = $not ? 'NotIn' : 'In';
        $this->wheres[] = compact('type', 'column', 'values', 'boolean');

        return $this;
    }

    /**
     * Add an "or where" clause to the query.
     *
     * @param  \Closure|string $column
     * @param  string $operator
     * @param  mixed $value
     * @return \Illuminate\Database\Query\Builder|static
filter:
    dependency_paths: ["lib/*"]
     */
    public function orWhere($column, $operator = null, $value = null)
    {
        return $this->where($column, $operator, $value, 'or');
    }

    /**
     * Set the relationships that should be eager loaded.
     *
     * @param  mixed $relations
     * @return $this
     */
    public function with($relations)
    {
        $relations = is_string($relations) ? func_get_args() : $relations;
        $this->relations[] = $relations;

        return $this;
    }

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

        return $query->count();
    }

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

    /**
     * Execute a query for a single record by bindings.
     *
     * @param array $columns
     * @return mixed
     */
    public function first($columns = ['*'])
    {
        if (is_null($this->columns)) {
            $this->columns = $columns;
        }

        return $this->prepareQuery()->first();
    }

    /**
     * Get a single column's value from the first result of a query.
     *
     * @param  string  $column
     * @return mixed
     */
    public function value($column)
    {
        if ($result = $this->first([$column])) {
            return $result->{$column};
        }
    }

    /**
     * Execute the query.
     *
     * @param  array $columns
     * @return \Illuminate\Support\Collection
     */
    public function get($columns = ['*'])
    {
        if (is_null($this->columns)) {
            $this->columns = $columns;
        }

        return $this->prepareQuery()->get();
    }

    /**
     * Paginate the given query into a simple paginator.
     *
     * @param int $rows
     * @return mixed
     */
    public function paginate($rows = 20)
    {
        return $this->prepareQuery()->paginate($rows);
    }

    /**
     * Create a new database record.
     *
     * @param array $attributes
     * @return mixed
     */
    public function create($attributes)
    {
        return $this->model->create($attributes);
    }

    /**
     * Update database record with given attributes by ID.
     *
     * @param $attributes
     * @param $id
     * @return mixed
     */
    public function update($attributes, $id)
    {
        $this->columns = null;
        $object = $this->where('id', $id)->first();

        return $object->update($attributes);
    }

    /**
     * Delete mass or single record from the database.
     *
     * @param  mixed  $id
     * @return int
     */
    public function delete($id = null)
    {
        if (! is_null($id)) {
            $this->where('id', $id);
        }

        return $this->prepareDeleteQuery()->delete();
    }

    /**
     * Delete a single record from the database by ID.
     *
     * @param $id
     * @return mixed
     */
    public function destroy($id)
    {
        return $this->model->destroy($id);
    }

    /**
     * Prepare a executable query.
     *
     * @return mixed
     */
    protected function prepareQuery()
    {
        $query = $this->model->select($this->columns);

        $wheres = $this->wheres;
        if (! is_null($wheres)) {
            foreach ($wheres as $where) {
                if (isset($where['values']) && isset($where['type'])) {
                    $query->whereIn($where['column'], $where['values']);
                } else {
                    $query->where($where['column'], $where['operator'], $where['value']);
                }
            }
        }

        $relations = $this->relations;
        if (! is_null($this->relations)) {
            foreach ($relations as $relation) {
                $query->with($relation);
            }
        }

        return $query;
    }

    /**
     * Prepare a executable delete query.
     *
     * @return mixed
     */
    protected function prepareDeleteQuery()
    {
        $query = $this->model;

        $wheres = $this->wheres;
        if (! is_null($wheres)) {
            foreach ($wheres as $where) {
                $query->where($where['column'], $where['operator'], $where['value']);
            }
        }

        return $query;
    }

    /**
     * Prepare the value and operator for a where clause.
     *
     * @param  string $value
     * @param  string $operator
     * @param  bool $useDefault
     * @return array
     *
     * @throws \InvalidArgumentException
     */
    protected function prepareValueAndOperator($value, $operator, $useDefault = false)
    {
        if ($useDefault) {
            return [$operator, '='];
        } elseif ($this->invalidOperatorAndValue($operator, $value)) {
            throw new InvalidArgumentException('Illegal operator and value combination.');
        }

        return [$value, $operator];
    }

    /**
     * Determine if the given operator and value combination is legal.
     *
     * Prevents using Null values with invalid operators.
     *
     * @param  string $operator
     * @param  mixed $value
     * @return bool
     */
    protected function invalidOperatorAndValue($operator, $value)
    {
        return is_null($value) && in_array($operator, $this->operators) &&
            ! in_array($operator, ['=', '<>', '!=']);
    }

    /**
     * Determine if the given operator is supported.
     *
     * @param  string $operator
     * @return bool
     */
    protected function invalidOperator($operator)
    {
        return ! in_array(strtolower($operator), $this->operators, true);
    }
}


1		<?php
2
3		namespace OzanAkman\RepositoryGenerator;
4
5		use InvalidArgumentException;
6
7		abstract class Repository implements RepositoryInterface
8		{
9		/**
10		* The model being used by repository.
11		*
12		* @var
13		*/
14		public $model;
15
16		/**
17		* The relationships that should be eager loaded.
18		*
19		* @var array
20		*/
21		public $relations = [];
22
23		/**
24		* Basic where clauses to affect query.
25		*
26		* @var array
27		*/
28		protected $wheres = [];
29
30		/**
31		* The columns being selected.
32		*
33		* @var
34		*/
35		protected $columns;
36
37		/**
38		* Indicates whether active column is being used.
39		*
40		* @var bool
41		*/
42		public $active = false;
43
44		/**
45		* All of the available clause operators.
46		*
47		* @var array
48		*/
49		public $operators = [
50		'=', '<', '>', '<=', '>=', '<>', '!=',
51		'like', 'like binary', 'not like', 'between', 'ilike',
52		'&', '\|', '^', '<<', '>>',
53		'rlike', 'regexp', 'not regexp',
54		'~', '~', '!~', '!~', 'similar to',
55		'not similar to', 'not ilike', '~~', '!~~',
56		];
57
58		/**
59		* Create a new repository instance.
60		*
61		* @param $model
62		*/
63		public function __construct($model)
64		{
65		$this->model = $model;
66		}
67
68		/**
69		* Set the columns to be selected.
70		*
71		* @param array\|mixed $columns
72		* @return $this
73		*/
74		public function select($columns = ['*'])
75		{
76		$this->columns = is_array($columns) ? $columns : func_get_args();
77
78		return $this;
79		}
80
81		/**
82		* Set the query to get only active records from database.
83		*
84		* @return $this
85		*/
86		public function active()
87		{
88		$this->where(config('repository-generator.active_column'), 1);
89
90		return $this;
91		}
92
93		/**
94		* Add a basic where clause to the query.
95		*
96		* @param $column
97		* @param string $operator
98		* @param mixed $value
99		* @param string $boolean
100		* @return $this
101		*/
102		public function where($column, $operator = null, $value = null, $boolean = 'and')
103		{
104		list($value, $operator) = $this->prepareValueAndOperator(
105		$value, $operator, func_num_args() == 2
106		);
107
108		if ($this->invalidOperator($operator)) {
109		list($value, $operator) = [$operator, '='];
		0 ignored issues – show Comprehensibility Best Practice introduced 2017-09-12 12:33 UTC by Report Bug Copy Issue Report This list assign is not used and could be removed. Loading history...
110		}
111
112		$this->wheres[] = compact(
113		'type', 'column', 'operator', 'value', 'boolean'
114		);
115
116		return $this;
117		}
118
119		/**
120		* Add a "where in" clause to the query.
121		*
122		* @param string $column
123		* @param mixed $values
124		* @param string $boolean
125		* @param bool $not
126		* @return $this
127		*/
128		public function whereIn($column, $values, $boolean = 'and', $not = false)
129		{
130		$type = $not ? 'NotIn' : 'In';
131		$this->wheres[] = compact('type', 'column', 'values', 'boolean');
132
133		return $this;
134		}
135
136		/**
137		* Add an "or where" clause to the query.
138		*
139		* @param \Closure\|string $column
140		* @param string $operator
141		* @param mixed $value
142		* @return \Illuminate\Database\Query\Builder\|static
		0 ignored issues – show Bug introduced 2017-09-12 12:33 UTC by Report Bug Copy Issue Report The type `Illuminate\Database\Query\Builder` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
143		*/
144		public function orWhere($column, $operator = null, $value = null)
145		{
146		return $this->where($column, $operator, $value, 'or');
147		}
148
149		/**
150		* Set the relationships that should be eager loaded.
151		*
152		* @param mixed $relations
153		* @return $this
154		*/
155		public function with($relations)
156		{
157		$relations = is_string($relations) ? func_get_args() : $relations;
158		$this->relations[] = $relations;
159
160		return $this;
161		}
162
163		/**
164		* Retrieve the "count" result of the query.
165		*
166		* @return int
167		*/
168		public function count()
169		{
170		$this->columns = ['id'];
171		$query = $this->prepareQuery();
172
173		return $query->count();
174		}
175
176		/**
177		* Execute a query for a single record by ID.
178		*
179		* @param int $id
180		* @param array $columns
181		* @return mixed\|static
182		*/
183		public function find($id, $columns = ['*'])
184		{
185		return $this->where('id', '=', $id)->first($columns);
186		}
187
188		/**
189		* Execute a query for a single record by bindings.
190		*
191		* @param array $columns
192		* @return mixed
193		*/
194	View Code Duplication	public function first($columns = ['*'])
195		{
196		if (is_null($this->columns)) {
197		$this->columns = $columns;
198		}
199
200		return $this->prepareQuery()->first();
201		}
202
203		/**
204		* Get a single column's value from the first result of a query.
205		*
206		* @param string $column
207		* @return mixed
208		*/
209		public function value($column)
210		{
211		if ($result = $this->first([$column])) {
212		return $result->{$column};
213		}
214		}
215
216		/**
217		* Execute the query.
218		*
219		* @param array $columns
220		* @return \Illuminate\Support\Collection
221		*/
222	View Code Duplication	public function get($columns = ['*'])
223		{
224		if (is_null($this->columns)) {
225		$this->columns = $columns;
226		}
227
228		return $this->prepareQuery()->get();
229		}
230
231		/**
232		* Paginate the given query into a simple paginator.
233		*
234		* @param int $rows
235		* @return mixed
236		*/
237		public function paginate($rows = 20)
238		{
239		return $this->prepareQuery()->paginate($rows);
240		}
241
242		/**
243		* Create a new database record.
244		*
245		* @param array $attributes
246		* @return mixed
247		*/
248		public function create($attributes)
249		{
250		return $this->model->create($attributes);
251		}
252
253		/**
254		* Update database record with given attributes by ID.
255		*
256		* @param $attributes
257		* @param $id
258		* @return mixed
259		*/
260		public function update($attributes, $id)
261		{
262		$this->columns = null;
263		$object = $this->where('id', $id)->first();
264
265		return $object->update($attributes);
266		}
267
268		/**
269		* Delete mass or single record from the database.
270		*
271		* @param mixed $id
272		* @return int
273		*/
274		public function delete($id = null)
275		{
276		if (! is_null($id)) {
277		$this->where('id', $id);
278		}
279
280		return $this->prepareDeleteQuery()->delete();
281		}
282
283		/**
284		* Delete a single record from the database by ID.
285		*
286		* @param $id
287		* @return mixed
288		*/
289		public function destroy($id)
290		{
291		return $this->model->destroy($id);
292		}
293
294		/**
295		* Prepare a executable query.
296		*
297		* @return mixed
298		*/
299		protected function prepareQuery()
300		{
301		$query = $this->model->select($this->columns);
302
303		$wheres = $this->wheres;
304		if (! is_null($wheres)) {
305		foreach ($wheres as $where) {
306		if (isset($where['values']) && isset($where['type'])) {
307		$query->whereIn($where['column'], $where['values']);
308		} else {
309		$query->where($where['column'], $where['operator'], $where['value']);
310		}
311		}
312		}
313
314		$relations = $this->relations;
315		if (! is_null($this->relations)) {
316		foreach ($relations as $relation) {
317		$query->with($relation);
318		}
319		}
320
321		return $query;
322		}
323
324		/**
325		* Prepare a executable delete query.
326		*
327		* @return mixed
328		*/
329		protected function prepareDeleteQuery()
330		{
331		$query = $this->model;
332
333		$wheres = $this->wheres;
334		if (! is_null($wheres)) {
335		foreach ($wheres as $where) {
336		$query->where($where['column'], $where['operator'], $where['value']);
337		}
338		}
339
340		return $query;
341		}
342
343		/**
344		* Prepare the value and operator for a where clause.
345		*
346		* @param string $value
347		* @param string $operator
348		* @param bool $useDefault
349		* @return array
350		*
351		* @throws \InvalidArgumentException
352		*/
353		protected function prepareValueAndOperator($value, $operator, $useDefault = false)
354		{
355		if ($useDefault) {
356		return [$operator, '='];
357		} elseif ($this->invalidOperatorAndValue($operator, $value)) {
358		throw new InvalidArgumentException('Illegal operator and value combination.');
359		}
360
361		return [$value, $operator];
362		}
363
364		/**
365		* Determine if the given operator and value combination is legal.
366		*
367		* Prevents using Null values with invalid operators.
368		*
369		* @param string $operator
370		* @param mixed $value
371		* @return bool
372		*/
373		protected function invalidOperatorAndValue($operator, $value)
374		{
375		return is_null($value) && in_array($operator, $this->operators) &&
376		! in_array($operator, ['=', '<>', '!=']);
377		}
378
379		/**
380		* Determine if the given operator is supported.
381		*
382		* @param string $operator
383		* @return bool
384		*/
385		protected function invalidOperator($operator)
386		{
387		return ! in_array(strtolower($operator), $this->operators, true);
388		}
389		}
390

ozanakman / laravel-repository-generator

Repository::with() A last analyzed 2017-09-12 12:42 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Repository::with() A
last analyzed 2017-09-12 12:42 UTC