EloquentRepository - Code Metrics - Inspection of "Adding whereHas and findWhereHas methods (#69)" - rinvex/laravel-repositories - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( beaec1...bd8098 )

by Abdelrahman

created 2016-08-28 00:24 UTC

EloquentRepository A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	288
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes	26
Bugs	11	Features	7

Metric	Value
c	26
b	11
f	7
dl	0
loc	288
wmc	26
lcom	1
cbo	3
rs	10

14 Methods

Rating	Name	Size	Complexity
A	createModel()	16	4
A	find()	6	1
A	findBy()	6	1
A	findFirst()	6	1
A	findAll()	6	1
A	paginate()	8	2
A	simplePaginate()	8	2
A	findWhere()	10	1
A	findWhereIn()	10	1
A	findWhereNotIn()	10	1
A	findWhereHas()	10	1
A	create()	20	2
A	update()	21	4
A	delete()	21	4

<?php

/*
 * NOTICE OF LICENSE
 *
 * Part of the Rinvex Repository Package.
 *
 * This source file is subject to The MIT License (MIT)
 * that is bundled with this package in the LICENSE file.
 *
 * Package: Rinvex Repository Package
 * License: The MIT License (MIT)
 * Link:    https://rinvex.com
 */

namespace Rinvex\Repository\Repositories;

use Illuminate\Database\Eloquent\Model;
use Illuminate\Pagination\Paginator;
use Rinvex\Repository\Exceptions\RepositoryException;

class EloquentRepository extends BaseRepository
{
    /**
     * Create a new repository model instance.
     *
     * @throws \Rinvex\Repository\Exceptions\RepositoryException
     *
     * @return \Illuminate\Database\Eloquent\Model
     */
    public function createModel()
    {
        if (is_string($model = $this->getModel())) {
            if (! class_exists($class = '\\'.ltrim($model, '\\'))) {
                throw new RepositoryException("Class {$model} does NOT exist!");
            }

            $model = $this->getContainer()->make($class);
        }

        if (! $model instanceof Model) {
            throw new RepositoryException("Class {$model} must be an instance of \\Illuminate\\Database\\Eloquent\\Model");
        }

        return $model;
    }

    /**
     * Find an entity by it's primary key.
     *
     * @param int   $id
     * @param array $attributes
     *
     * @return \Illuminate\Database\Eloquent\Model
     */
    public function find($id, $attributes = ['*'])
    {
        return $this->executeCallback(get_called_class(), __FUNCTION__, func_get_args(), function () use ($id, $attributes) {
            return $this->prepareQuery($this->createModel())->find($id, $attributes);
        });
    }

    /**
     * Find an entity by one of it's attributes.
     *
     * @param string $attribute
     * @param string $value
     * @param array  $attributes
     *
     * @return \Illuminate\Database\Eloquent\Model
     */
    public function findBy($attribute, $value, $attributes = ['*'])
    {
        return $this->executeCallback(get_called_class(), __FUNCTION__, func_get_args(), function () use ($attribute, $value, $attributes) {
            return $this->prepareQuery($this->createModel())->where($attribute, '=', $value)->first($attributes);
        });
    }

    /**
     * Find the first entity.
     *
     * @param array $attributes
     *
     * @return \Illuminate\Database\Eloquent\Model
     */
    public function findFirst($attributes = ['*'])
    {
        return $this->executeCallback(get_called_class(), __FUNCTION__, func_get_args(), function () use ($attributes) {
            return $this->prepareQuery($this->createModel())->first($attributes);
        });
    }

    /**
     * Find all entities.
     *
     * @param array $attributes
     *
     * @return \Illuminate\Support\Collection
     */
    public function findAll($attributes = ['*'])
    {
        return $this->executeCallback(get_called_class(), __FUNCTION__, func_get_args(), function () use ($attributes) {
            return $this->prepareQuery($this->createModel())->get($attributes);
        });
    }

    /**
     * Paginate all entities.
     *
     * @param int|null $perPage
     * @param array    $attributes
     * @param string   $pageName
     * @param int|null $page
     *
     * @throws \InvalidArgumentException
     *
     * @return \Illuminate\Contracts\Pagination\LengthAwarePaginator
     */
    public function paginate($perPage = null, $attributes = ['*'], $pageName = 'page', $page = null)
    {
        $page = $page ?: Paginator::resolveCurrentPage($pageName);

        return $this->executeCallback(get_called_class(), __FUNCTION__, array_merge(func_get_args(), compact('page')), function () use ($perPage, $attributes, $pageName, $page) {
            return $this->prepareQuery($this->createModel())->paginate($perPage, $attributes, $pageName, $page);
        });
    }

    /**
     * Paginate all entities into a simple paginator.
     *
     * @param int|null $perPage
     * @param array    $attributes
     * @param string   $pageName
     * @param int|null $page
     *
     * @return \Illuminate\Contracts\Pagination\Paginator
     */
    public function simplePaginate($perPage = null, $attributes = ['*'], $pageName = 'page', $page = null)
    {
        $page = $page ?: Paginator::resolveCurrentPage($pageName);

        return $this->executeCallback(get_called_class(), __FUNCTION__, array_merge(func_get_args(), compact('page')), function () use ($perPage, $attributes, $pageName, $page) {

            return $this->prepareQuery($this->createModel())->simplePaginate($perPage, $attributes, $pageName, $page);
        });
    }

    /**
     * Find all entities matching where conditions.
     *
     * @param array $where
     * @param array $attributes
     *
     * @return \Illuminate\Support\Collection
     */
    public function findWhere(array $where, $attributes = ['*'])
    {
        return $this->executeCallback(get_called_class(), __FUNCTION__, func_get_args(), function () use ($where, $attributes) {
            list($attribute, $operator, $value, $boolean) = array_pad($where, 4, null);

            $this->where($attribute, $operator, $value, $boolean);

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

    /**
     * Find all entities matching whereIn conditions.
     *
     * @param array $where
     * @param array $attributes
     *
     * @return \Illuminate\Support\Collection
     */
    public function findWhereIn(array $where, $attributes = ['*'])
    {
        return $this->executeCallback(get_called_class(), __FUNCTION__, func_get_args(), function () use ($where, $attributes) {
            list($attribute, $values, $boolean, $not) = array_pad($where, 4, null);

            $this->whereIn($attribute, $values, $boolean, $not);

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

    /**
     * Find all entities matching whereNotIn conditions.
     *
     * @param array $where
     * @param array $attributes
     *
     * @return \Illuminate\Support\Collection
     */
    public function findWhereNotIn(array $where, $attributes = ['*'])
    {
        return $this->executeCallback(get_called_class(), __FUNCTION__, func_get_args(), function () use ($where, $attributes) {
            list($attribute, $values, $boolean) = array_pad($where, 3, null);

            $this->whereNotIn($attribute, $values, $boolean);

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

    /**
     * Add a relationship count / exists condition to the query with where clauses.
     *
     * @param array $where
     * @param array $attributes
     *
     * @return \Illuminate\Database\Eloquent\Builder|static
     */
    public function findWhereHas(array $where, $attributes = ['*'])
    {
        return $this->executeCallback(get_called_class(), __FUNCTION__, func_get_args(), function () use ($where, $attributes) {

            list($relation, $callback, $operator, $count) = array_pad($where, 4, null);

            $this->whereHas($relation, $callback, $operator, $count);

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

    /**
     * Create a new entity with the given attributes.
     *
     * @param array $attributes
     *
     * @return array

     */
    public function create(array $attributes = [])
    {
        // Create a new instance
        $instance = $this->createModel();

        // Fire the created event
        $this->getContainer('events')->fire($this->getRepositoryId().'.entity.creating', [$this, $instance]);

        // Fill instance with data
        $instance->fill($attributes);

        // Save the instance
        $created = $instance->save();

        // Fire the created event
        $this->getContainer('events')->fire($this->getRepositoryId().'.entity.created', [$this, $instance]);

        // Return instance
        return $created ? $instance : $created;
    }

    /**
     * Update an entity with the given attributes.
     *
     * @param mixed $id
     * @param array $attributes
     *
     * @return array

     */
    public function update($id, array $attributes = [])
    {
        // Find the given instance
        $instance = $id instanceof Model ? $id : $this->find($id);

        if ($instance) {
            // Fire the updated event
            $this->getContainer('events')->fire($this->getRepositoryId().'.entity.updating', [$this, $instance]);

            // Fill instance with data
            $instance->fill($attributes);

            // Update the instance
            $updated = $instance->save();

            // Fire the updated event
            $this->getContainer('events')->fire($this->getRepositoryId().'.entity.updated', [$this, $instance]);
        }

        return $updated ? $instance : $updated;
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
    }

    /**
     * Delete an entity with the given id.
     *
     * @param mixed $id
     *
     * @return array

     */
    public function delete($id)
    {
        // Find the given instance
        $deleted  = false;

        // Find the given instance
        $instance = $id instanceof Model ? $id : $this->find($id);

        if ($instance) {
            // Fire the deleted event
            $this->getContainer('events')->fire($this->getRepositoryId().'.entity.deleting', [$this, $instance]);

            // Delete the instance
            $deleted = $instance->delete();

            // Fire the deleted event
            $this->getContainer('events')->fire($this->getRepositoryId().'.entity.deleted', [$this, $instance]);
        }

        return $deleted ? $instance : $deleted;
    }
}


1			<?php
2
3			/*
4			* NOTICE OF LICENSE
5			*
6			* Part of the Rinvex Repository Package.
7			*
8			* This source file is subject to The MIT License (MIT)
9			* that is bundled with this package in the LICENSE file.
10			*
11			* Package: Rinvex Repository Package
12			* License: The MIT License (MIT)
13			* Link: https://rinvex.com
14			*/
15
16			namespace Rinvex\Repository\Repositories;
17
18			use Illuminate\Database\Eloquent\Model;
19			use Illuminate\Pagination\Paginator;
20			use Rinvex\Repository\Exceptions\RepositoryException;
21
22			class EloquentRepository extends BaseRepository
23			{
24			/**
25			* Create a new repository model instance.
26			*
27			* @throws \Rinvex\Repository\Exceptions\RepositoryException
28			*
29			* @return \Illuminate\Database\Eloquent\Model
30			*/
31			public function createModel()
32			{
33			if (is_string($model = $this->getModel())) {
34			if (! class_exists($class = '\\'.ltrim($model, '\\'))) {
35			throw new RepositoryException("Class {$model} does NOT exist!");
36			}
37
38			$model = $this->getContainer()->make($class);
39			}
40
41			if (! $model instanceof Model) {
42			throw new RepositoryException("Class {$model} must be an instance of \\Illuminate\\Database\\Eloquent\\Model");
43			}
44
45			return $model;
46			}
47
48			/**
49			* Find an entity by it's primary key.
50			*
51			* @param int $id
52			* @param array $attributes
53			*
54			* @return \Illuminate\Database\Eloquent\Model
55			*/
56			public function find($id, $attributes = ['*'])
57			{
58			return $this->executeCallback(get_called_class(), __FUNCTION__, func_get_args(), function () use ($id, $attributes) {
59			return $this->prepareQuery($this->createModel())->find($id, $attributes);
60			});
61			}
62
63			/**
64			* Find an entity by one of it's attributes.
65			*
66			* @param string $attribute
67			* @param string $value
68			* @param array $attributes
69			*
70			* @return \Illuminate\Database\Eloquent\Model
71			*/
72			public function findBy($attribute, $value, $attributes = ['*'])
73			{
74			return $this->executeCallback(get_called_class(), __FUNCTION__, func_get_args(), function () use ($attribute, $value, $attributes) {
75			return $this->prepareQuery($this->createModel())->where($attribute, '=', $value)->first($attributes);
76			});
77			}
78
79			/**
80			* Find the first entity.
81			*
82			* @param array $attributes
83			*
84			* @return \Illuminate\Database\Eloquent\Model
85			*/
86			public function findFirst($attributes = ['*'])
87			{
88			return $this->executeCallback(get_called_class(), __FUNCTION__, func_get_args(), function () use ($attributes) {
89			return $this->prepareQuery($this->createModel())->first($attributes);
90			});
91			}
92
93			/**
94			* Find all entities.
95			*
96			* @param array $attributes
97			*
98			* @return \Illuminate\Support\Collection
99			*/
100			public function findAll($attributes = ['*'])
101			{
102			return $this->executeCallback(get_called_class(), __FUNCTION__, func_get_args(), function () use ($attributes) {
103			return $this->prepareQuery($this->createModel())->get($attributes);
104			});
105			}
106
107			/**
108			* Paginate all entities.
109			*
110			* @param int\|null $perPage
111			* @param array $attributes
112			* @param string $pageName
113			* @param int\|null $page
114			*
115			* @throws \InvalidArgumentException
116			*
117			* @return \Illuminate\Contracts\Pagination\LengthAwarePaginator
118			*/
119			public function paginate($perPage = null, $attributes = ['*'], $pageName = 'page', $page = null)
120			{
121			$page = $page ?: Paginator::resolveCurrentPage($pageName);
122
123			return $this->executeCallback(get_called_class(), __FUNCTION__, array_merge(func_get_args(), compact('page')), function () use ($perPage, $attributes, $pageName, $page) {
124			return $this->prepareQuery($this->createModel())->paginate($perPage, $attributes, $pageName, $page);
125			});
126			}
127
128			/**
129			* Paginate all entities into a simple paginator.
130			*
131			* @param int\|null $perPage
132			* @param array $attributes
133			* @param string $pageName
134			* @param int\|null $page
135			*
136			* @return \Illuminate\Contracts\Pagination\Paginator
137			*/
138			public function simplePaginate($perPage = null, $attributes = ['*'], $pageName = 'page', $page = null)
139			{
140			$page = $page ?: Paginator::resolveCurrentPage($pageName);
141
142			return $this->executeCallback(get_called_class(), __FUNCTION__, array_merge(func_get_args(), compact('page')), function () use ($perPage, $attributes, $pageName, $page) {
			0 ignored issues – show Coding Style introduced 2016-08-18 20:04 UTC by Report Bug Copy Issue Report This line exceeds maximum limit of 120 characters; contains 178 characters Overly long lines are hard to read on any screen. Most code styles therefor impose a maximum limit on the number of characters in a line. Loading history...
143			return $this->prepareQuery($this->createModel())->simplePaginate($perPage, $attributes, $pageName, $page);
144			});
145			}
146
147			/**
148			* Find all entities matching where conditions.
149			*
150			* @param array $where
151			* @param array $attributes
152			*
153			* @return \Illuminate\Support\Collection
154			*/
155			public function findWhere(array $where, $attributes = ['*'])
156			{
157			return $this->executeCallback(get_called_class(), __FUNCTION__, func_get_args(), function () use ($where, $attributes) {
158			list($attribute, $operator, $value, $boolean) = array_pad($where, 4, null);
159
160			$this->where($attribute, $operator, $value, $boolean);
161
162			return $this->prepareQuery($this->createModel())->get($attributes);
163			});
164			}
165
166			/**
167			* Find all entities matching whereIn conditions.
168			*
169			* @param array $where
170			* @param array $attributes
171			*
172			* @return \Illuminate\Support\Collection
173			*/
174			public function findWhereIn(array $where, $attributes = ['*'])
175			{
176			return $this->executeCallback(get_called_class(), __FUNCTION__, func_get_args(), function () use ($where, $attributes) {
177			list($attribute, $values, $boolean, $not) = array_pad($where, 4, null);
178
179			$this->whereIn($attribute, $values, $boolean, $not);
180
181			return $this->prepareQuery($this->createModel())->get($attributes);
182			});
183			}
184
185			/**
186			* Find all entities matching whereNotIn conditions.
187			*
188			* @param array $where
189			* @param array $attributes
190			*
191			* @return \Illuminate\Support\Collection
192			*/
193			public function findWhereNotIn(array $where, $attributes = ['*'])
194			{
195			return $this->executeCallback(get_called_class(), __FUNCTION__, func_get_args(), function () use ($where, $attributes) {
196			list($attribute, $values, $boolean) = array_pad($where, 3, null);
197
198			$this->whereNotIn($attribute, $values, $boolean);
199
200			return $this->prepareQuery($this->createModel())->get($attributes);
201			});
202			}
203
204			/**
205			* Add a relationship count / exists condition to the query with where clauses.
206			*
207			* @param array $where
208			* @param array $attributes
209			*
210			* @return \Illuminate\Database\Eloquent\Builder\|static
211			*/
212			public function findWhereHas(array $where, $attributes = ['*'])
213			{
214			return $this->executeCallback(get_called_class(), __FUNCTION__, func_get_args(), function () use ($where, $attributes) {
			0 ignored issues – show Coding Style introduced 2016-08-27 19:50 UTC by Report Bug Copy Issue Report This line exceeds maximum limit of 120 characters; contains 128 characters Overly long lines are hard to read on any screen. Most code styles therefor impose a maximum limit on the number of characters in a line. Loading history...
215			list($relation, $callback, $operator, $count) = array_pad($where, 4, null);
216
217			$this->whereHas($relation, $callback, $operator, $count);
218
219			return $this->prepareQuery($this->createModel())->get($attributes);
220			});
221			}
222
223			/**
224			* Create a new entity with the given attributes.
225			*
226			* @param array $attributes
227			*
228			* @return array
			0 ignored issues – show Documentation introduced 2016-08-18 20:04 UTC by Report Bug Copy Issue Report Should the return type not be `Model\|boolean`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
229			*/
230			public function create(array $attributes = [])
231			{
232			// Create a new instance
233			$instance = $this->createModel();
234
235			// Fire the created event
236			$this->getContainer('events')->fire($this->getRepositoryId().'.entity.creating', [$this, $instance]);
237
238			// Fill instance with data
239			$instance->fill($attributes);
240
241			// Save the instance
242			$created = $instance->save();
243
244			// Fire the created event
245			$this->getContainer('events')->fire($this->getRepositoryId().'.entity.created', [$this, $instance]);
246
247			// Return instance
248			return $created ? $instance : $created;
249			}
250
251			/**
252			* Update an entity with the given attributes.
253			*
254			* @param mixed $id
255			* @param array $attributes
256			*
257			* @return array
			0 ignored issues – show Documentation introduced 2016-08-18 20:04 UTC by Report Bug Copy Issue Report Should the return type not be `Model\|boolean`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
258			*/
259			public function update($id, array $attributes = [])
260			{
261			// Find the given instance
262			$instance = $id instanceof Model ? $id : $this->find($id);
263
264			if ($instance) {
265			// Fire the updated event
266			$this->getContainer('events')->fire($this->getRepositoryId().'.entity.updating', [$this, $instance]);
267
268			// Fill instance with data
269			$instance->fill($attributes);
270
271			// Update the instance
272			$updated = $instance->save();
273
274			// Fire the updated event
275			$this->getContainer('events')->fire($this->getRepositoryId().'.entity.updated', [$this, $instance]);
276			}
277
278			return $updated ? $instance : $updated;
			0 ignored issues – show Bug introduced 2016-08-06 08:58 UTC by Report Bug Copy Issue Report The variable `$updated` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history...
279			}
280
281			/**
282			* Delete an entity with the given id.
283			*
284			* @param mixed $id
285			*
286			* @return array
			0 ignored issues – show Documentation introduced 2016-08-06 08:58 UTC by Report Bug Copy Issue Report Should the return type not be `boolean\|null\|Model`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
287			*/
288			public function delete($id)
289			{
290			// Find the given instance
291			$deleted = false;
292
293			// Find the given instance
294			$instance = $id instanceof Model ? $id : $this->find($id);
295
296			if ($instance) {
297			// Fire the deleted event
298			$this->getContainer('events')->fire($this->getRepositoryId().'.entity.deleting', [$this, $instance]);
299
300			// Delete the instance
301			$deleted = $instance->delete();
302
303			// Fire the deleted event
304			$this->getContainer('events')->fire($this->getRepositoryId().'.entity.deleted', [$this, $instance]);
305			}
306
307			return $deleted ? $instance : $deleted;
308			}
309			}
310

rinvex / laravel-repositories

Push — develop ( beaec1...bd8098 )

EloquentRepository A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

14 Methods

Available Fixes

Duplication Side-by-Side

Filter issues like