Repository::restore() - Code Metrics - Inspection of "add quality tools" - mshamaseen/laravel-repository-pattern - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 0a4c8d...e29dcc )

by Hamzah

created 2019-01-14 14:56 UTC

Repository::restore() A

↳ Parent: Repository

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	12
c	0
b	0
f	0
rs	9.8666
cc	2
nc	2
nop	1

<?php
/**
 * Created by PhpStorm.
 * User: Hamza Alayed
 * Date: 11/29/18
 * Time: 9:38 AM.
 */

namespace Shamaseen\Repository\Generator\Bases;


use Illuminate\Container\Container as App;
use Illuminate\Database\Eloquent\Builder;

/**
 * Class Database.
 */
abstract class Repository implements Contract

{
    protected $with = [];
    /**
     * @var App
     */
    protected $app;

    /** @var string */
    protected $order = null;

    protected $direction = 'desc';
    /**
     * @var Entity
     */
    protected $model;
    /**
     * @var boolean
     */
    private $trash = false;
    /**
     * @var boolean
     */
    private $withTrash = false;

    /**
     * @param App $app
     */
    public function __construct(App $app)
    {
        $this->app = $app;
        $this->makeModel();
    }

    protected function makeModel()
    {
        $this->model = $this->app->make($this->getModelClass());
    }

    /**
     * @return string
     */
    abstract protected function getModelClass(): string;

    /**
     * @param int $limit
     * @param array $filters
     *
     * @return \Illuminate\Contracts\Pagination\Paginator
     */
    public function simplePaginate($limit = 10, $filters = [])
    {
        return $this->filter($filters)->simplePaginate($limit);
    }

    /**
     * @param array $filters
     * @return Entity
     */
    public function filter($filters = [])
    {
        if (isset($filters['order'])) {
            $this->order = $filters['order'];
            unset($filters['order']);
        }

        if (isset($filters['direction'])) {
            $this->direction = $filters['direction'];
            unset($filters['direction']);
        }

        /** @var Entity $latest */
        $latest = $this->model->with($this->with);
        if ('' != $this->order) {
            $latest->orderBy($this->order, $this->direction);
        }

        if (isset($filters['search'])) {
            foreach ($this->model->searchable as $item) {

                $latest->where($item, 'like', '%' . $filters['search'] . '%', 'or');
            }

            unset($filters['search']);
        }
        unset($filters['page']);

        if ($this->trash) {
            $latest->onlyTrashed();
        }
        if ($this->withTrash) {
            $latest->withTrashed();
        }

        return $latest->where($filters);
    }

    /**
     * @param int $limit
     * @param array $filters
     *
     * @return \Illuminate\Contracts\Pagination\LengthAwarePaginator
     */
    public function paginate($limit = 10, $filters = [])
    {
        return $this->filter($filters)->paginate($limit);
    }

    /**
     * @param array $filters
     *
     * @return Builder[]|\Illuminate\Database\Eloquent\Collection
     */
    public function get($filters = [])
    {
        return $this->filter($filters)->get();
    }

    /**
     * @param $entityId
     * @param array $attributes
     *
     * @return bool
     */
    public function update($entityId = 0, $attributes = [])
    {
        $item = $this->model->where('id', $entityId);

        if ($item) {
            return $item->update($attributes);
        }

        return false;
    }

    /**
     * @param $entityId
     *
     * @throws \Exception
     *
     * @return bool
     */
    public function delete($entityId = 0)
    {
        $item = $this->model->where('id', $entityId);

        if ($item && $item->delete()) {

            return true;
        }

        return false;
    }

    /**
     * @param array $attributes
     *
     * @return bool
     */
    public function insert($attributes = [])
    {
        return $this->model->insert($attributes);
    }


    /**
     * @param array $columns
     *
     * @return mixed
     */
    public function all($columns = ['*'])
    {
        return $this->model->all($columns);
    }

    /**
     * @param string $name
     * @param string $entityId
     * @param array $filters
     *
     * @return array
     */
    public function pluck($name = 'name', $entityId = 'id', $filters = [])
    {
        return $this->model->where($filters)->pluck($name, $entityId)->toArray();
    }

    /**
     * @param $entityId
     * @param array $columns
     *
     * @return Entity
     */
    public function find($entityId = 0, $columns = ['*'])
    {
        return $this->model->with($this->with)->select($columns)->where('id', $entityId)->first();
    }

    /**
     * @param array $filter
     * @param array $columns
     *
     * @return Entity
     */
    public function first($filter = [], $columns = ['*'])
    {
        return $this->model->with($this->with)->select($columns)->where($filter)->first();
    }

    /**
     * @param $haystack
     * @param $needle
     *
     * @return Entity[]|\Illuminate\Database\Eloquent\Collection
     */
    public function search($haystack, $needle)
    {
        return $this->model->where($haystack, 'like', $needle)->get();
    }


    /**
     * @param $filters
     * @param array $columns
     *
     * @return Entity
     */
    public function findBy($filters = [], $columns = ['*'])
    {
        return $this->model->with($this->with)->select($columns)->where($filters)->first();
    }

    /**
     * @param array $attributes
     *
     * @return Entity|\Illuminate\Database\Eloquent\Model
     */
    public function create($attributes = [])
    {
        return $this->model->create($attributes);
    }

    /**
     * @param array $attributes
     *
     * @return Entity|\Illuminate\Database\Eloquent\Model
     */
    public function createOrUpdate($attributes = [])
    {
        return $this->model->updateOrCreate($attributes);
    }

    /**
     * @param array $data
     *
     * @return \Illuminate\Database\Eloquent\Model
     */
    public function createOrFirst($data = [])
    {
        return $this->model->firstOrCreate($data);
    }

    /**
     * Get entity name
     *
     * @return string
     */
    public function entityName()
    {
        return $this->getModelClass();
    }

    /**
     * @param int $entityId
     *
     * @return bool|null
     */
    public function restore($entityId = 0)
    {
        /** @var Entity $entity */
        $entity = $this->model->withTrashed()
            ->whereId($entityId)
            ->first();
        if ($entity) {
            return $entity->restore();
        }

        return false;
    }

    /**
     * @param int $entityId
     *
     * @return bool|null
     */
    public function forceDelete($entityId = 0)
    {
        /** @var Entity $entity */
        $entity = $this->model->withTrashed()
            ->whereId($entityId)
            ->first();
        if ($entity) {
            return $entity->forceDelete();
        }

        return false;
    }

    /**
     * @return void
     */
    public function trash()
    {
        $this->trash = true;
        $this->withTrash = false;
    }

    /**
     * @return void
     */
    public function withTrash()
    {
        $this->trash = false;
        $this->withTrash = true;
    }
}


1			<?php
2			/**
3			* Created by PhpStorm.
4			* User: Hamza Alayed
5			* Date: 11/29/18
6			* Time: 9:38 AM.
7			*/
8
9			namespace Shamaseen\Repository\Generator\Bases;
10
11
12			use Illuminate\Container\Container as App;
13			use Illuminate\Database\Eloquent\Builder;
14
15			/**
16			* Class Database.
17			*/
18			abstract class Repository implements Contract
			0 ignored issues – show Coding Style introduced 2019-01-14 15:00 UTC by Report Bug Copy Issue Report `Repository` does not seem to conform to the naming convention (`^Abstract\|Factory$`). This check examines a number of code elements and verifies that they conform to the given naming conventions. You can set conventions for local variables, abstract classes, utility classes, constant, properties, methods, parameters, interfaces, classes, exceptions and special methods. Loading history...
19			{
20			protected $with = [];
21			/**
22			* @var App
23			*/
24			protected $app;
25
26			/** @var string */
27			protected $order = null;
28
29			protected $direction = 'desc';
30			/**
31			* @var Entity
32			*/
33			protected $model;
34			/**
35			* @var boolean
36			*/
37			private $trash = false;
38			/**
39			* @var boolean
40			*/
41			private $withTrash = false;
42
43			/**
44			* @param App $app
45			*/
46			public function __construct(App $app)
47			{
48			$this->app = $app;
49			$this->makeModel();
50			}
51
52			protected function makeModel()
53			{
54			$this->model = $this->app->make($this->getModelClass());
55			}
56
57			/**
58			* @return string
59			*/
60			abstract protected function getModelClass(): string;
61
62			/**
63			* @param int $limit
64			* @param array $filters
65			*
66			* @return \Illuminate\Contracts\Pagination\Paginator
67			*/
68			public function simplePaginate($limit = 10, $filters = [])
69			{
70			return $this->filter($filters)->simplePaginate($limit);
71			}
72
73			/**
74			* @param array $filters
75			* @return Entity
76			*/
77			public function filter($filters = [])
78			{
79			if (isset($filters['order'])) {
80			$this->order = $filters['order'];
81			unset($filters['order']);
82			}
83
84			if (isset($filters['direction'])) {
85			$this->direction = $filters['direction'];
86			unset($filters['direction']);
87			}
88
89			/** @var Entity $latest */
90			$latest = $this->model->with($this->with);
91			if ('' != $this->order) {
92			$latest->orderBy($this->order, $this->direction);
93			}
94
95			if (isset($filters['search'])) {
96			foreach ($this->model->searchable as $item) {
			0 ignored issues – show Bug introduced 2019-01-14 15:00 UTC by Report Bug Copy Issue Report The property `searchable` cannot be accessed from this context as it is declared `protected` in class `Shamaseen\Repository\Generator\Bases\Entity`. This check looks for access to properties that are not accessible from the current context. If you need to make a property accessible to another context you can either raise its visibility level or provide an accessible getter in the defining class. Loading history...
97			$latest->where($item, 'like', '%' . $filters['search'] . '%', 'or');
98			}
99
100			unset($filters['search']);
101			}
102			unset($filters['page']);
103
104			if ($this->trash) {
105			$latest->onlyTrashed();
106			}
107			if ($this->withTrash) {
108			$latest->withTrashed();
109			}
110
111			return $latest->where($filters);
112			}
113
114			/**
115			* @param int $limit
116			* @param array $filters
117			*
118			* @return \Illuminate\Contracts\Pagination\LengthAwarePaginator
119			*/
120			public function paginate($limit = 10, $filters = [])
121			{
122			return $this->filter($filters)->paginate($limit);
123			}
124
125			/**
126			* @param array $filters
127			*
128			* @return Builder[]\|\Illuminate\Database\Eloquent\Collection
129			*/
130			public function get($filters = [])
131			{
132			return $this->filter($filters)->get();
133			}
134
135			/**
136			* @param $entityId
137			* @param array $attributes
138			*
139			* @return bool
140			*/
141			public function update($entityId = 0, $attributes = [])
142			{
143			$item = $this->model->where('id', $entityId);
144
145			if ($item) {
146			return $item->update($attributes);
147			}
148
149			return false;
150			}
151
152			/**
153			* @param $entityId
154			*
155			* @throws \Exception
156			*
157			* @return bool
158			*/
159			public function delete($entityId = 0)
160			{
161			$item = $this->model->where('id', $entityId);
162
163			if ($item && $item->delete()) {
			0 ignored issues – show Unused Code introduced 2019-01-14 15:00 UTC by Report Bug Copy Issue Report This `if` statement, and the following `return` statement can be replaced with `return $item && $item->delete();`. Loading history...
164			return true;
165			}
166
167			return false;
168			}
169
170			/**
171			* @param array $attributes
172			*
173			* @return bool
174			*/
175			public function insert($attributes = [])
176			{
177			return $this->model->insert($attributes);
178			}
179
180
181			/**
182			* @param array $columns
183			*
184			* @return mixed
185			*/
186			public function all($columns = ['*'])
187			{
188			return $this->model->all($columns);
189			}
190
191			/**
192			* @param string $name
193			* @param string $entityId
194			* @param array $filters
195			*
196			* @return array
197			*/
198			public function pluck($name = 'name', $entityId = 'id', $filters = [])
199			{
200			return $this->model->where($filters)->pluck($name, $entityId)->toArray();
201			}
202
203			/**
204			* @param $entityId
205			* @param array $columns
206			*
207			* @return Entity
208			*/
209			public function find($entityId = 0, $columns = ['*'])
210			{
211			return $this->model->with($this->with)->select($columns)->where('id', $entityId)->first();
212			}
213
214			/**
215			* @param array $filter
216			* @param array $columns
217			*
218			* @return Entity
219			*/
220			public function first($filter = [], $columns = ['*'])
221			{
222			return $this->model->with($this->with)->select($columns)->where($filter)->first();
223			}
224
225			/**
226			* @param $haystack
227			* @param $needle
228			*
229			* @return Entity[]\|\Illuminate\Database\Eloquent\Collection
230			*/
231			public function search($haystack, $needle)
232			{
233			return $this->model->where($haystack, 'like', $needle)->get();
234			}
235
236
237			/**
238			* @param $filters
239			* @param array $columns
240			*
241			* @return Entity
242			*/
243			public function findBy($filters = [], $columns = ['*'])
244			{
245			return $this->model->with($this->with)->select($columns)->where($filters)->first();
246			}
247
248			/**
249			* @param array $attributes
250			*
251			* @return Entity\|\Illuminate\Database\Eloquent\Model
252			*/
253			public function create($attributes = [])
254			{
255			return $this->model->create($attributes);
256			}
257
258			/**
259			* @param array $attributes
260			*
261			* @return Entity\|\Illuminate\Database\Eloquent\Model
262			*/
263			public function createOrUpdate($attributes = [])
264			{
265			return $this->model->updateOrCreate($attributes);
266			}
267
268			/**
269			* @param array $data
270			*
271			* @return \Illuminate\Database\Eloquent\Model
272			*/
273			public function createOrFirst($data = [])
274			{
275			return $this->model->firstOrCreate($data);
276			}
277
278			/**
279			* Get entity name
280			*
281			* @return string
282			*/
283			public function entityName()
284			{
285			return $this->getModelClass();
286			}
287
288			/**
289			* @param int $entityId
290			*
291			* @return bool\|null
292			*/
293			public function restore($entityId = 0)
294			{
295			/** @var Entity $entity */
296			$entity = $this->model->withTrashed()
297			->whereId($entityId)
298			->first();
299			if ($entity) {
300			return $entity->restore();
301			}
302
303			return false;
304			}
305
306			/**
307			* @param int $entityId
308			*
309			* @return bool\|null
310			*/
311			public function forceDelete($entityId = 0)
312			{
313			/** @var Entity $entity */
314			$entity = $this->model->withTrashed()
315			->whereId($entityId)
316			->first();
317			if ($entity) {
318			return $entity->forceDelete();
319			}
320
321			return false;
322			}
323
324			/**
325			* @return void
326			*/
327			public function trash()
328			{
329			$this->trash = true;
330			$this->withTrash = false;
331			}
332
333			/**
334			* @return void
335			*/
336			public function withTrash()
337			{
338			$this->trash = false;
339			$this->withTrash = true;
340			}
341			}
342

mshamaseen / laravel-repository-pattern

Push — master ( 0a4c8d...e29dcc )

Repository::restore() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like