Total Complexity | 21 |
Total Lines | 207 |
Duplicated Lines | 42.51 % |
Changes | 0 |
Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
1 | <?php namespace GeneaLabs\LaravelModelCaching; |
||
10 | class Builder extends EloquentBuilder |
||
11 | { |
||
12 | protected function cache(array $tags = []) |
||
21 | } |
||
22 | |||
23 | // protected function cacheResults(Relation $relation, array $models, string $name) : array |
||
24 | // { |
||
25 | // $parentIds = implode('_', collect($models)->pluck('id')->toArray()); |
||
26 | // $parentName = str_slug(get_class($relation->getParent())); |
||
27 | // $childName = str_slug(get_class($relation->getRelated())); |
||
28 | // |
||
29 | // $cachedResults = $this->cache([$parentName, $childName])->rememberForever( |
||
30 | // "{$parentName}_{$parentIds}-{$childName}s", |
||
31 | // function () use ($relation, $models, $name) { |
||
32 | // return $relation->match( |
||
33 | // $relation->initRelation($models, $name), |
||
34 | // $relation->getEager(), |
||
35 | // $name |
||
36 | // ); |
||
37 | // } |
||
38 | // ); |
||
39 | // |
||
40 | // return $cachedResults; |
||
41 | // } |
||
42 | // |
||
43 | // protected function eagerLoadRelation(array $models, $name, Closure $constraints) |
||
44 | // { |
||
45 | // $relation = $this->getRelation($name); |
||
46 | // $relation->addEagerConstraints($models); |
||
47 | // $constraints($relation); |
||
48 | // |
||
49 | // return $this->cacheResults($relation, $models, $name); |
||
50 | // } |
||
51 | |||
52 | protected function getCacheKey(array $columns = ['*'], $ids = null) : string |
||
53 | { |
||
54 | $key = str_slug(get_class($this->model)); |
||
55 | |||
56 | if ($ids) { |
||
57 | $key .= '_' . (is_array($ids) |
||
58 | ? implode('_', $ids) |
||
59 | : $ids); |
||
60 | } |
||
61 | |||
62 | if ($columns !== ['*']) { |
||
63 | $key .= '_' . implode('_', $columns); |
||
64 | } |
||
65 | |||
66 | $key .= collect($this->query->wheres)->reduce(function ($carry, $where) { |
||
67 | $value = $where['value'] ?? implode('_', $where['values']) ?? ''; |
||
68 | |||
69 | return "{$carry}-{$where['column']}_{$value}"; |
||
70 | }); |
||
71 | |||
72 | if (collect($this->eagerLoad)->isNotEmpty()) { |
||
73 | $key .= '-' . implode('-', collect($this->eagerLoad)->keys()->toArray()); |
||
74 | } |
||
75 | |||
76 | if ($this->query->offset) { |
||
77 | $key .= "-offset_{$this->query->offset}"; |
||
78 | } |
||
79 | |||
80 | if ($this->query->limit) { |
||
81 | $key .= "-limit_{$this->query->limit}"; |
||
82 | } |
||
83 | |||
84 | return $key; |
||
85 | } |
||
86 | |||
87 | protected function getCacheTags() : array |
||
101 | } |
||
102 | |||
103 | View Code Duplication | public function avg($column) |
|
1 ignored issue
–
show
|
|||
104 | { |
||
105 | $tags = [str_slug(get_class($this->model))]; |
||
106 | $key = str_slug(get_class($this->model)) ."-avg_{$column}"; |
||
107 | |||
108 | return $this->cache($tags) |
||
109 | ->rememberForever($key, function () use ($column) { |
||
110 | return parent::avg($column); |
||
1 ignored issue
–
show
|
|||
111 | }); |
||
112 | } |
||
113 | |||
114 | View Code Duplication | public function count($columns = ['*']) |
|
1 ignored issue
–
show
|
|||
115 | { |
||
116 | $tags = [str_slug(get_class($this->model))]; |
||
117 | $key = str_slug(get_class($this->model)) ."-count"; |
||
118 | |||
119 | return $this->cache($tags) |
||
120 | ->rememberForever($key, function () use ($columns) { |
||
121 | return parent::count($columns); |
||
1 ignored issue
–
show
|
|||
122 | }); |
||
123 | } |
||
124 | |||
125 | View Code Duplication | public function cursor() |
|
1 ignored issue
–
show
|
|||
126 | { |
||
127 | $tags = [str_slug(get_class($this->model))]; |
||
128 | $key = str_slug(get_class($this->model)) ."-cursor"; |
||
129 | |||
130 | return $this->cache($tags) |
||
131 | ->rememberForever($key, function () { |
||
132 | return collect(parent::cursor()); |
||
133 | }); |
||
134 | } |
||
135 | |||
136 | /** |
||
137 | * @SuppressWarnings(PHPMD.ShortVariable) |
||
138 | */ |
||
139 | View Code Duplication | public function find($id, $columns = ['*']) |
|
1 ignored issue
–
show
|
|||
140 | { |
||
141 | $tags = $this->getCacheTags(); |
||
142 | $key = $this->getCacheKey($columns, $id); |
||
143 | |||
144 | return $this->cache($tags) |
||
145 | ->rememberForever($key, function () use ($id, $columns) { |
||
146 | return parent::find($id, $columns); |
||
147 | }); |
||
148 | } |
||
149 | |||
150 | View Code Duplication | public function first($columns = ['*']) |
|
1 ignored issue
–
show
|
|||
151 | { |
||
152 | $tags = $this->getCacheTags(); |
||
153 | $key = $this->getCacheKey($columns) . '-first'; |
||
154 | |||
155 | return $this->cache($tags) |
||
156 | ->rememberForever($key, function () use ($columns) { |
||
157 | return parent::first($columns); |
||
158 | }); |
||
159 | } |
||
160 | |||
161 | View Code Duplication | public function get($columns = ['*']) |
|
1 ignored issue
–
show
|
|||
162 | { |
||
163 | $tags = $this->getCacheTags(); |
||
164 | $key = $this->getCacheKey($columns); |
||
165 | |||
166 | return $this->cache($tags) |
||
167 | ->rememberForever($key, function () use ($columns) { |
||
168 | return parent::get($columns); |
||
169 | }); |
||
170 | } |
||
171 | |||
172 | View Code Duplication | public function max($column) |
|
1 ignored issue
–
show
|
|||
173 | { |
||
174 | $tags = [str_slug(get_class($this->model))]; |
||
175 | $key = str_slug(get_class($this->model)) ."-max_{$column}"; |
||
176 | |||
177 | return $this->cache($tags) |
||
178 | ->rememberForever($key, function () use ($column) { |
||
179 | return parent::max($column); |
||
1 ignored issue
–
show
|
|||
180 | }); |
||
181 | } |
||
182 | |||
183 | View Code Duplication | public function min($column) |
|
1 ignored issue
–
show
|
|||
184 | { |
||
185 | $tags = [str_slug(get_class($this->model))]; |
||
186 | $key = str_slug(get_class($this->model)) ."-min_{$column}"; |
||
187 | |||
188 | return $this->cache($tags) |
||
189 | ->rememberForever($key, function () use ($column) { |
||
190 | return parent::min($column); |
||
1 ignored issue
–
show
|
|||
191 | }); |
||
192 | } |
||
193 | |||
194 | public function pluck($column, $key = null) |
||
195 | { |
||
196 | $tags = $this->getCacheTags(); |
||
197 | $cacheKey = $this->getCacheKey([$column]) . "-pluck_{$column}"; |
||
198 | |||
199 | if ($key) { |
||
200 | $cacheKey .= "_{$key}"; |
||
201 | } |
||
202 | |||
203 | return $this->cache($tags) |
||
204 | ->rememberForever($cacheKey, function () use ($column, $key) { |
||
205 | return parent::pluck($column, $key); |
||
206 | }); |
||
207 | } |
||
208 | |||
209 | View Code Duplication | public function sum($column) |
|
217 | }); |
||
218 | } |
||
219 | } |
||
220 |
Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.
You can also find more detailed suggestions in the “Code” section of your repository.