BaseService::list() - Code Metrics - Inspection of "changes" - SherifElfadaly/Laravel-Api-Skeleton - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( de5c78...60eb24 )

by Sherif

created 2020-08-23 08:41 UTC

BaseService::list() A

↳ Parent: BaseService

Complexity

Conditions	4
Paths	6

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	16
rs	9.7333
c	0
b	0
f	0
cc	4
nc	6
nop	6

<?php

namespace App\Modules\Core\BaseClasses;

use App\Modules\Core\Interfaces\BaseServiceInterface;

abstract class BaseService implements BaseServiceInterface
{
    /**
     * @var object
     */
    public $repo;

    /**
     * Init new object.
     *
     * @param   mixed  $repo
     * @return  void

     */
    public function __construct($repo)
    {
        $this->repo = $repo;
    }

    /**
     * Fetch records with relations based on the given params.
     *
     * @param   array   $relations
     * @param   array   $conditions
     * @param   integer $perPage
     * @param   string  $sortBy
     * @param   boolean $desc
     * @param   boolean $trashed
     * @return collection
     */
    public function list($relations = [], $conditions = false, $perPage = 15, $sortBy = 'created_at', $desc = true, $trashed = false)
    {
        $translatable = $this->repo->model->translatable ?? [];
        $filters = $this->constructFilters($conditions);

        $sortBy = in_array($sortBy, $translatable) ? $sortBy . '->' . \Session::get('locale') : $sortBy;

        if ($trashed) {
            return $this->deleted(['and' => $filters], $perPage ?? 15, $sortBy ?? 'created_at', $desc ?? true);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        }
        
        if (count($filters)) {
            return $this->paginateBy(['and' => $filters], $perPage ?? 15, $relations, $sortBy ?? 'created_at', $desc ?? true);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        }

        return $this->paginate($perPage ?? 15, $relations, $sortBy ?? 'created_at', $desc ?? true);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    /**
     * Fetch all records with relations from the storage.
     *
     * @param  array   $relations
     * @param  string  $sortBy
     * @param  boolean $desc
     * @param  array   $columns
     * @return collection
     */
    public function all($relations = [], $sortBy = 'created_at', $desc = 1, $columns = ['*'])
    {
        return $this->repo->all($relations, $sortBy, $desc, $columns);
    }
    
    /**
     * Fetch all records with relations from storage in pages.
     *
     * @param  integer $perPage
     * @param  array   $relations
     * @param  string  $sortBy
     * @param  boolean $desc
     * @param  array   $columns
     * @return collection
     */
    public function paginate($perPage = 15, $relations = [], $sortBy = 'created_at', $desc = 1, $columns = ['*'])
    {
        return $this->repo->paginate($perPage, $relations, $sortBy, $desc, $columns);
    }

    /**
     * Fetch all records with relations based on
     * the given condition from storage in pages.
     *
     * @param  array   $conditions array of conditions
     * @param  integer $perPage
     * @param  array   $relations
     * @param  string  $sortBy
     * @param  boolean $desc
     * @param  array   $columns
     * @return collection
     */
    public function paginateBy($conditions, $perPage = 15, $relations = [], $sortBy = 'created_at', $desc = 1, $columns = ['*'])
    {
        return $this->repo->paginateBy($conditions, $perPage, $relations, $sortBy, $desc, $columns);
    }
    
    /**
     * Save the given model to the storage.
     *
     * @param  array $data
     * @return mixed
     */
    public function save(array $data)
    {
        return $this->repo->save($data);
    }

    /**
     * Delete record from the storage based on the given
     * condition.
     *
     * @param  var $value condition value
     * @param  string $attribute condition column name
     * @return void
     */
    public function delete($value, $attribute = 'id')
    {
        return $this->repo->delete($value, $attribute);
    }
    
    /**
     * Fetch records from the storage based on the given
     * id.
     *
     * @param  integer $id
     * @param  array   $relations
     * @param  array   $columns
     * @return object
     */
    public function find($id, $relations = [], $columns = ['*'])
    {
        return $this->repo->find($id, $relations, $columns);
    }
    
    /**
     * Fetch records from the storage based on the given
     * condition.
     *
     * @param  array   $conditions array of conditions
     * @param  array   $relations
     * @param  string  $sortBy
     * @param  boolean $desc
     * @param  array   $columns
     * @return collection
     */
    public function findBy($conditions, $relations = [], $sortBy = 'created_at', $desc = 1, $columns = ['*'])
    {
        return $this->repo->findBy($conditions, $relations, $sortBy, $desc, $columns);
    }

    /**
     * Fetch the first record from the storage based on the given
     * condition.
     *
     * @param  array   $conditions array of conditions
     * @param  array   $relations
     * @param  array   $columns
     * @return object
     */
    public function first($conditions, $relations = [], $columns = ['*'])
    {
        return $this->repo->first($conditions, $relations, $columns);
    }

    /**
     * Return the deleted models in pages based on the given conditions.
     *
     * @param  array   $conditions array of conditions
     * @param  integer $perPage
     * @param  string  $sortBy
     * @param  boolean $desc
     * @param  array   $columns
     * @return collection
     */
    public function deleted($conditions, $perPage = 15, $sortBy = 'created_at', $desc = 1, $columns = ['*'])
    {
        return $this->repo->deleted($conditions, $perPage, $sortBy, $desc, $columns);
    }

    /**
     * Restore the deleted model.
     *
     * @param  integer $id
     * @return void
     */
    public function restore($id)
    {
        return $this->repo->restore($id);
    }

    /**
     * Prepare filters for repo.
     *
     * @param  array   $conditions
     * @return array
     */
    public function constructFilters($conditions)
    {
        $filters = [];
        $translatable = $this->repo->model->translatable ?? [];
        foreach ($conditions as $key => $value) {
            if ((in_array($key, $this->repo->model->fillable ?? []) || method_exists($this->repo->model, $key) || in_array($key, ['or', 'and'])) && $key !== 'trashed') {
                $key = in_array($key, $translatable) ? $key . '->' . (\Session::get('locale') == 'all' ? 'en' : \Session::get('locale')) : $key;
                if (filter_var($value, FILTER_VALIDATE_BOOLEAN, FILTER_NULL_ON_FAILURE) !== null && strpos($key, '_id') === false && ! is_null($value)) {
                    $filters[$key] = filter_var($value, FILTER_VALIDATE_BOOLEAN);
                } elseif (! is_array($value) && strpos($key, '_id')) {
                    $filters[$key] = [
                        'op' => 'in',
                        'val' => explode(',', $value)
                    ];
                } elseif (is_array($value)) {
                    $filters[$key] = $value;
                } elseif($value) {
                    $key = 'LOWER(' . $key . ')';
                    $value = strtolower($value);
                    $filters[$key] = [
                        'op' => 'like',
                        'val' => '%' . $value . '%'
                    ];
                }
            }
        }

        return $filters;
    }
}


1			<?php
2
3			namespace App\Modules\Core\BaseClasses;
4
5			use App\Modules\Core\Interfaces\BaseServiceInterface;
6
7			abstract class BaseService implements BaseServiceInterface
8			{
9			/**
10			* @var object
11			*/
12			public $repo;
13
14			/**
15			* Init new object.
16			*
17			* @param mixed $repo
18			* @return void
			0 ignored issues – show Comprehensibility Best Practice introduced 2020-03-30 10:13 UTC by Report Bug Copy Issue Report Adding a `@return` annotation to constructors is generally not recommended as a constructor does not have a meaningful return value. Adding a `@return` annotation to a constructor is not recommended, since a constructor does not have a meaningful return value. Please refer to the PHP core documentation on constructors. Loading history...
19			*/
20			public function __construct($repo)
21			{
22			$this->repo = $repo;
23			}
24
25			/**
26			* Fetch records with relations based on the given params.
27			*
28			* @param array $relations
29			* @param array $conditions
30			* @param integer $perPage
31			* @param string $sortBy
32			* @param boolean $desc
33			* @param boolean $trashed
34			* @return collection
35			*/
36			public function list($relations = [], $conditions = false, $perPage = 15, $sortBy = 'created_at', $desc = true, $trashed = false)
37			{
38			$translatable = $this->repo->model->translatable ?? [];
39			$filters = $this->constructFilters($conditions);
			0 ignored issues – show Bug introduced 2020-08-23 08:50 UTC by Report Bug Copy Issue Report It seems like `$conditions` defined by parameter `$conditions` on line 36 can also be of type `false`; however, `App\Modules\Core\BaseCla...ice::constructFilters()` does only seem to accept `array`, maybe add an additional type check? This check looks at variables that have been passed in as parameters and are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
40			$sortBy = in_array($sortBy, $translatable) ? $sortBy . '->' . \Session::get('locale') : $sortBy;
41
42			if ($trashed) {
43			return $this->deleted(['and' => $filters], $perPage ?? 15, $sortBy ?? 'created_at', $desc ?? true);
			0 ignored issues – show Documentation introduced 2020-04-27 16:29 UTC by Report Bug Copy Issue Report `$desc ?? true` is of type `boolean`, but the function expects a `integer`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
44			}
45
46			if (count($filters)) {
47			return $this->paginateBy(['and' => $filters], $perPage ?? 15, $relations, $sortBy ?? 'created_at', $desc ?? true);
			0 ignored issues – show Documentation introduced 2020-02-26 15:48 UTC by Report Bug Copy Issue Report `$desc ?? true` is of type `boolean`, but the function expects a `integer`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
48			}
49
50			return $this->paginate($perPage ?? 15, $relations, $sortBy ?? 'created_at', $desc ?? true);
			0 ignored issues – show Documentation introduced 2020-02-26 15:48 UTC by Report Bug Copy Issue Report `$desc ?? true` is of type `boolean`, but the function expects a `integer`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
51			}
52
53			/**
54			* Fetch all records with relations from the storage.
55			*
56			* @param array $relations
57			* @param string $sortBy
58			* @param boolean $desc
59			* @param array $columns
60			* @return collection
61			*/
62			public function all($relations = [], $sortBy = 'created_at', $desc = 1, $columns = ['*'])
63			{
64			return $this->repo->all($relations, $sortBy, $desc, $columns);
65			}
66
67			/**
68			* Fetch all records with relations from storage in pages.
69			*
70			* @param integer $perPage
71			* @param array $relations
72			* @param string $sortBy
73			* @param boolean $desc
74			* @param array $columns
75			* @return collection
76			*/
77			public function paginate($perPage = 15, $relations = [], $sortBy = 'created_at', $desc = 1, $columns = ['*'])
78			{
79			return $this->repo->paginate($perPage, $relations, $sortBy, $desc, $columns);
80			}
81
82			/**
83			* Fetch all records with relations based on
84			* the given condition from storage in pages.
85			*
86			* @param array $conditions array of conditions
87			* @param integer $perPage
88			* @param array $relations
89			* @param string $sortBy
90			* @param boolean $desc
91			* @param array $columns
92			* @return collection
93			*/
94			public function paginateBy($conditions, $perPage = 15, $relations = [], $sortBy = 'created_at', $desc = 1, $columns = ['*'])
95			{
96			return $this->repo->paginateBy($conditions, $perPage, $relations, $sortBy, $desc, $columns);
97			}
98
99			/**
100			* Save the given model to the storage.
101			*
102			* @param array $data
103			* @return mixed
104			*/
105			public function save(array $data)
106			{
107			return $this->repo->save($data);
108			}
109
110			/**
111			* Delete record from the storage based on the given
112			* condition.
113			*
114			* @param var $value condition value
115			* @param string $attribute condition column name
116			* @return void
117			*/
118			public function delete($value, $attribute = 'id')
119			{
120			return $this->repo->delete($value, $attribute);
121			}
122
123			/**
124			* Fetch records from the storage based on the given
125			* id.
126			*
127			* @param integer $id
128			* @param array $relations
129			* @param array $columns
130			* @return object
131			*/
132			public function find($id, $relations = [], $columns = ['*'])
133			{
134			return $this->repo->find($id, $relations, $columns);
135			}
136
137			/**
138			* Fetch records from the storage based on the given
139			* condition.
140			*
141			* @param array $conditions array of conditions
142			* @param array $relations
143			* @param string $sortBy
144			* @param boolean $desc
145			* @param array $columns
146			* @return collection
147			*/
148			public function findBy($conditions, $relations = [], $sortBy = 'created_at', $desc = 1, $columns = ['*'])
149			{
150			return $this->repo->findBy($conditions, $relations, $sortBy, $desc, $columns);
151			}
152
153			/**
154			* Fetch the first record from the storage based on the given
155			* condition.
156			*
157			* @param array $conditions array of conditions
158			* @param array $relations
159			* @param array $columns
160			* @return object
161			*/
162			public function first($conditions, $relations = [], $columns = ['*'])
163			{
164			return $this->repo->first($conditions, $relations, $columns);
165			}
166
167			/**
168			* Return the deleted models in pages based on the given conditions.
169			*
170			* @param array $conditions array of conditions
171			* @param integer $perPage
172			* @param string $sortBy
173			* @param boolean $desc
174			* @param array $columns
175			* @return collection
176			*/
177			public function deleted($conditions, $perPage = 15, $sortBy = 'created_at', $desc = 1, $columns = ['*'])
178			{
179			return $this->repo->deleted($conditions, $perPage, $sortBy, $desc, $columns);
180			}
181
182			/**
183			* Restore the deleted model.
184			*
185			* @param integer $id
186			* @return void
187			*/
188			public function restore($id)
189			{
190			return $this->repo->restore($id);
191			}
192
193			/**
194			* Prepare filters for repo.
195			*
196			* @param array $conditions
197			* @return array
198			*/
199			public function constructFilters($conditions)
200			{
201			$filters = [];
202			$translatable = $this->repo->model->translatable ?? [];
203			foreach ($conditions as $key => $value) {
204			if ((in_array($key, $this->repo->model->fillable ?? []) \|\| method_exists($this->repo->model, $key) \|\| in_array($key, ['or', 'and'])) && $key !== 'trashed') {
205			$key = in_array($key, $translatable) ? $key . '->' . (\Session::get('locale') == 'all' ? 'en' : \Session::get('locale')) : $key;
206			if (filter_var($value, FILTER_VALIDATE_BOOLEAN, FILTER_NULL_ON_FAILURE) !== null && strpos($key, '_id') === false && ! is_null($value)) {
207			$filters[$key] = filter_var($value, FILTER_VALIDATE_BOOLEAN);
208			} elseif (! is_array($value) && strpos($key, '_id')) {
209			$filters[$key] = [
210			'op' => 'in',
211			'val' => explode(',', $value)
212			];
213			} elseif (is_array($value)) {
214			$filters[$key] = $value;
215			} elseif($value) {
216			$key = 'LOWER(' . $key . ')';
217			$value = strtolower($value);
218			$filters[$key] = [
219			'op' => 'like',
220			'val' => '%' . $value . '%'
221			];
222			}
223			}
224			}
225
226			return $filters;
227			}
228			}
229

SherifElfadaly / Laravel-Api-Skeleton

Push — master ( de5c78...60eb24 )

BaseService::list() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like