Complex classes like CacheableRepository often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use CacheableRepository, and based on these observations, apply Extract Interface, too.
1 | <?php |
||
12 | trait CacheableRepository |
||
13 | { |
||
14 | /** |
||
15 | * @var CacheRepository |
||
16 | */ |
||
17 | protected $cacheRepository = null; |
||
18 | |||
19 | /** |
||
20 | * @var boolean |
||
21 | */ |
||
22 | protected $cacheSkip = false; |
||
23 | |||
24 | /** |
||
25 | * Set Cache Repository |
||
26 | * |
||
27 | * @param CacheRepository $repository |
||
28 | * |
||
29 | * @return $this |
||
30 | */ |
||
31 | 1 | public function setCacheRepository(CacheRepository $repository) |
|
37 | |||
38 | /** |
||
39 | * Return instance of Cache Repository |
||
40 | * |
||
41 | * @return CacheRepository |
||
42 | */ |
||
43 | 1 | public function getCacheRepository() |
|
51 | |||
52 | /** |
||
53 | * CacheTags |
||
54 | * |
||
55 | * @param mixed $tags |
||
56 | * |
||
57 | * @return \Illuminate\Cache\TaggedCache |
||
58 | */ |
||
59 | 1 | public function cacheTags($tags = null) |
|
65 | |||
66 | /** |
||
67 | * Skip Cache |
||
68 | * |
||
69 | * @param bool $status |
||
70 | * |
||
71 | * @return $this |
||
72 | */ |
||
73 | 1 | public function skipCache($status = true) |
|
79 | |||
80 | /** |
||
81 | * Is Skipped Cache |
||
82 | * |
||
83 | * @return bool |
||
84 | */ |
||
85 | 2 | public function isSkippedCache() |
|
97 | |||
98 | /** |
||
99 | * Allowed Cache |
||
100 | * |
||
101 | * @param string $method |
||
102 | * |
||
103 | * @return bool |
||
104 | */ |
||
105 | 1 | protected function allowedCache($method) |
|
130 | |||
131 | /** |
||
132 | * Get Cache key for the method |
||
133 | * |
||
134 | * @param string $method |
||
135 | * @param array $args |
||
136 | * |
||
137 | * @return string |
||
138 | */ |
||
139 | 1 | public function getCacheKey($method, $args = null) |
|
150 | |||
151 | /** |
||
152 | * Serialize the criteria making sure the Closures are taken care of. |
||
153 | * |
||
154 | * @return string |
||
155 | */ |
||
156 | 1 | protected function serializeCriteria() |
|
166 | |||
167 | /** |
||
168 | * Serialize single criterion with customized serialization of Closures. |
||
169 | * |
||
170 | * @param \Prettus\Repository\Contracts\CriteriaInterface $criterion |
||
171 | * |
||
172 | * @return \Prettus\Repository\Contracts\CriteriaInterface|array |
||
173 | * |
||
174 | * @throws \Exception |
||
175 | */ |
||
176 | protected function serializeCriterion($criterion) |
||
197 | |||
198 | /** |
||
199 | * Get cache minutes |
||
200 | * |
||
201 | * @return int |
||
202 | */ |
||
203 | 1 | public function getCacheMinutes() |
|
209 | |||
210 | /** |
||
211 | * call Cache |
||
212 | * |
||
213 | * @param string $method |
||
214 | * @param array $args |
||
215 | * |
||
216 | * @return mixed |
||
217 | */ |
||
218 | 1 | public function callCache($method, array $args) |
|
232 | |||
233 | /** |
||
234 | * Retrieve all data of repository |
||
235 | * |
||
236 | * @param array $columns |
||
237 | * |
||
238 | * @return mixed |
||
239 | */ |
||
240 | 1 | public function all($columns = ['*']) |
|
244 | |||
245 | /** |
||
246 | * Retrieve all data of repository, paginated |
||
247 | * |
||
248 | * @param null $limit |
||
249 | * @param array $columns |
||
250 | * |
||
251 | * @return mixed |
||
252 | */ |
||
253 | 1 | public function paginate($limit = null, $columns = ['*']) |
|
257 | |||
258 | /** |
||
259 | * Find data by id |
||
260 | * |
||
261 | * @param int $id |
||
262 | * @param array $columns |
||
263 | * |
||
264 | * @return mixed |
||
265 | */ |
||
266 | 1 | public function find($id, $columns = ['*']) |
|
270 | |||
271 | /** |
||
272 | * Find data by field and value |
||
273 | * |
||
274 | * @param string $field |
||
275 | * @param mixed $value |
||
276 | * @param array $columns |
||
277 | * |
||
278 | * @return mixed |
||
279 | */ |
||
280 | 1 | public function findByField($field, $value = null, $columns = ['*']) |
|
284 | |||
285 | /** |
||
286 | * Find data by multiple fields |
||
287 | * |
||
288 | * @param array $where |
||
289 | * @param array $columns |
||
290 | * |
||
291 | * @return mixed |
||
292 | */ |
||
293 | 1 | public function findWhere(array $where, $columns = ['*']) |
|
297 | |||
298 | /** |
||
299 | * Find data by Criteria |
||
300 | * |
||
301 | * @param CriteriaInterface $criteria |
||
302 | * |
||
303 | * @return mixed |
||
304 | */ |
||
305 | 1 | public function getByCriteria(CriteriaInterface $criteria) |
|
309 | |||
310 | /** |
||
311 | * Pluck |
||
312 | * |
||
313 | * @param string $column |
||
314 | * @param array $key |
||
315 | * |
||
316 | * @return array |
||
317 | */ |
||
318 | 1 | public function pluck($column, $key = null) |
|
322 | |||
323 | /** |
||
324 | * Count |
||
325 | * |
||
326 | * @param array $input Array Input |
||
327 | * |
||
328 | * @return int |
||
329 | */ |
||
330 | 1 | public function count(array $input = array()) |
|
334 | |||
335 | /** |
||
336 | * Max |
||
337 | * |
||
338 | * @param mixed $field Mixed Field |
||
339 | * @param array $input Array Input |
||
340 | * |
||
341 | * @return mixed |
||
342 | */ |
||
343 | 1 | public function max($field, array $input = array()) |
|
347 | |||
348 | /** |
||
349 | * Min |
||
350 | * |
||
351 | * @param mixed $field Mixed Field |
||
352 | * @param array $input Array Input |
||
353 | * |
||
354 | * @return mixed |
||
355 | */ |
||
356 | 1 | public function min($field, array $input = array()) |
|
360 | |||
361 | /** |
||
362 | * Sum |
||
363 | * |
||
364 | * @param mixed $field Mixed Field |
||
365 | * @param array $input Array Input |
||
366 | * |
||
367 | * @return float |
||
368 | */ |
||
369 | 1 | public function sum($field, array $input = array()) |
|
373 | |||
374 | /** |
||
375 | * Average |
||
376 | * |
||
377 | * @param mixed $field Mixed Field |
||
378 | * @param array $input Array Input |
||
379 | * |
||
380 | * @return float |
||
381 | */ |
||
382 | 1 | public function avg($field, array $input = array()) |
|
386 | } |
||
387 |
In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code:
Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: