Total Complexity | 52 |
Total Lines | 551 |
Duplicated Lines | 16.7 % |
Coverage | 32.02% |
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:
Complex classes like BaseRepository 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.
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 BaseRepository, and based on these observations, apply Extract Interface, too.
1 | <?php |
||
15 | class BaseRepository extends EntityRepository |
||
16 | { |
||
17 | protected $fields; |
||
18 | |||
19 | protected $request; |
||
20 | |||
21 | protected $use_result_cache = false; |
||
22 | |||
23 | protected $entityAlias; |
||
24 | |||
25 | protected $route_name; |
||
26 | |||
27 | protected $currentEntityAlias; |
||
28 | |||
29 | protected $embeddedFields; |
||
30 | |||
31 | protected $joins = []; |
||
32 | |||
33 | protected $queryBuilderFactory; |
||
34 | |||
35 | protected $queryOptions; |
||
36 | 5 | ||
37 | protected $configProvider; |
||
38 | 5 | ||
39 | public function __construct($manager, $class) |
||
40 | 5 | { |
|
41 | parent::__construct($manager, $class); |
||
42 | 5 | ||
43 | 5 | $this->fields = array_keys($this->getClassMetadata()->fieldMappings); |
|
44 | 5 | ||
45 | 5 | $entityName = explode('\\', strtolower($this->getEntityName()) ); |
|
46 | $entityName = $entityName[count($entityName)-1]; |
||
47 | 5 | $entityAlias = $entityName[0]; |
|
48 | 5 | $this->entityAlias = $entityAlias; |
|
49 | |||
50 | $this->queryBuilderFactory = new QueryBuilderFactory($this->getEntityManager()); |
||
51 | } |
||
52 | |||
53 | public function initFromQueryBuilderOptions(QueryBuilderOptions $options) |
||
54 | { |
||
55 | $this->queryBuilderFactory->createQueryBuilder($this->getEntityName(), $this->entityAlias); |
||
56 | |||
57 | $fieldMappings = $this->getClassMetadata()->fieldMappings; |
||
58 | $this->fields = array_keys($fieldMappings); |
||
59 | |||
60 | $this->queryBuilderFactory->setFields($this->fields ?? []); |
||
61 | $this->queryBuilderFactory->setFilters($options->getFilters()); |
||
62 | $this->queryBuilderFactory->setOrFilters($options->getOrFilters()); |
||
63 | $this->queryBuilderFactory->setSorting($options->getSorting()); |
||
64 | $this->queryBuilderFactory->setRel($options->getRel()); |
||
65 | $this->queryBuilderFactory->setPrinting($options->getPrinting()); |
||
66 | $this->queryBuilderFactory->setSelect($options->getSelect()); |
||
67 | } |
||
68 | |||
69 | public function getQueryBuilderFactory() |
||
74 | } |
||
75 | |||
76 | public function useResultCache($bool) |
||
77 | { |
||
78 | 1 | $this->use_result_cache = $bool; |
|
79 | } |
||
80 | 1 | ||
81 | public function setRequest(Request $request) |
||
82 | { |
||
83 | return $this->setQueryOptionsFromRequest($request); |
||
84 | } |
||
85 | |||
86 | public function setRequestWithFilter(Request $request, $filter) |
||
87 | { |
||
88 | return $this->setQueryOptionsFromRequestWithCustomFilter($request, $filter); |
||
89 | } |
||
90 | |||
91 | public function setRequestWithOrFilter(Request $request, $orFilter) |
||
94 | } |
||
95 | |||
96 | public function setQueryOptions(QueryBuilderOptions $options) |
||
97 | { |
||
98 | 3 | $this->queryOptions = $options; |
|
99 | } |
||
100 | 3 | ||
101 | public function setQueryOptionsFromRequest(Request $request = null) |
||
157 | } |
||
158 | |||
159 | View Code Duplication | public function setQueryOptionsFromRequestWithCustomFilter(Request $request = null, $filter) |
|
204 | } |
||
205 | |||
206 | View Code Duplication | public function setQueryOptionsFromRequestWithCustomOrFilter(Request $request = null, $orFilter) |
|
207 | { |
||
208 | $filters = $request->query->get('filtering', []); |
||
251 | 1 | } |
|
252 | 1 | ||
253 | 1 | public function getRequest() |
|
256 | 1 | } |
|
257 | 1 | ||
258 | 1 | public function setRouteName($route_name = '') |
|
262 | } |
||
263 | 1 | ||
264 | 1 | public function findAllPaginated() |
|
265 | 1 | { |
|
266 | if ($this->configProvider) { |
||
267 | $this->setRequest($this->configProvider->getRequest()); |
||
268 | 1 | $this->queryBuilderFactory->setConfigProvider($this->configProvider); |
|
269 | } |
||
270 | 1 | ||
271 | if (!$this->queryOptions) { |
||
272 | throw new \RuntimeException( |
||
273 | 4 | 'Oops! QueryBuilderOptions was never defined.' |
|
274 | ); |
||
275 | 4 | } |
|
276 | |||
277 | $this->initFromQueryBuilderOptions($this->queryOptions); |
||
278 | |||
279 | $this->queryBuilderFactory->filter(); |
||
280 | $this->queryBuilderFactory->sort(); |
||
281 | |||
282 | return $this->paginateResults($this->queryBuilderFactory->getQueryBuilder()); |
||
283 | } |
||
284 | |||
285 | protected function paginateResults( |
||
286 | \Doctrine\ORM\QueryBuilder $queryBuilder |
||
287 | ) { |
||
288 | $limit = $this->queryOptions->get('limit', 10); |
||
289 | $page = $this->queryOptions->get('page', 1); |
||
290 | |||
291 | |||
292 | $pagerAdapter = new DoctrineORMAdapter($queryBuilder); |
||
293 | |||
294 | $query = $pagerAdapter->getQuery(); |
||
295 | if(isset($this->use_result_cache) and $this->use_result_cache){ |
||
296 | $query->useResultCache(true, 600); |
||
297 | } |
||
298 | |||
299 | $pager = new Pagerfanta($pagerAdapter); |
||
300 | $pager->setNormalizeOutOfRangePages(true); |
||
301 | $pager->setMaxPerPage($limit); |
||
302 | $pager->setCurrentPage($page); |
||
303 | |||
304 | $pagerFactory = new PagerfantaFactory(); |
||
305 | |||
306 | $router = $this->createRouter(); |
||
307 | |||
308 | $results = $pagerFactory->createRepresentation($pager, $router); |
||
309 | |||
310 | return $results; |
||
311 | } |
||
312 | |||
313 | protected function customQueryStringValues() |
||
314 | { |
||
315 | return []; |
||
316 | } |
||
317 | |||
318 | protected function createRouter() |
||
319 | { |
||
320 | $request = $this->getRequest(); |
||
321 | $params = []; |
||
322 | |||
323 | $list = array_merge([ |
||
324 | 'filtering', |
||
325 | 'limit', |
||
326 | 'page', |
||
327 | 'sorting', |
||
328 | ], $this->customQueryStringValues()); |
||
329 | |||
330 | foreach ($list as $itemKey => $itemValue) { |
||
331 | $params[$itemValue] = $this->queryOptions->get($itemValue); |
||
332 | } |
||
333 | |||
334 | if(!isset($this->route_name)){ |
||
335 | $this->route_name = $this->queryOptions->get('_route'); |
||
336 | } |
||
337 | |||
338 | return new Route($this->route_name, $params); |
||
339 | } |
||
340 | |||
341 | /** @deprecate use QueryBuilderFatory instead */ |
||
342 | public function noExistsJoin($prevEntityAlias, $currentEntityAlias) |
||
343 | { |
||
344 | $needle = $prevEntityAlias . "_" . $currentEntityAlias; |
||
345 | return ! in_array($needle, $this->joins); |
||
346 | } |
||
347 | |||
348 | /** @deprecate use QueryBuilderFatory instead */ |
||
349 | public function storeJoin($prevEntityAlias, $currentEntityAlias) |
||
350 | { |
||
351 | $needle = $prevEntityAlias . "_" . $currentEntityAlias; |
||
352 | $this->joins[$needle] = $needle; |
||
353 | } |
||
354 | |||
355 | /** @deprecate use QueryBuilderFatory instead */ |
||
356 | public function join($queryBuilder, $key, $val) |
||
357 | { |
||
358 | if (strstr($key, '_embedded.')) { |
||
359 | $embeddedFields = explode('.', $key); |
||
360 | $numFields = count($embeddedFields); |
||
361 | |||
362 | $prevEntityAlias = $this->entityAlias; // Stocksellouts |
||
363 | $prevEntityName = $this->getEntityName(); // Stocksellouts |
||
364 | |||
365 | for ($i = 1; $i < $numFields - 1; $i++) { |
||
366 | $metadata = $this->getEntityManager()->getClassMetadata($prevEntityName); |
||
367 | |||
368 | $currentRelation = $embeddedFields[$i]; |
||
369 | |||
370 | if ($metadata->hasAssociation($currentRelation)) { |
||
371 | |||
372 | $association = $metadata->getAssociationMapping($currentRelation); |
||
373 | |||
374 | $currentEntityAlias = $this->getEntityAlias($association['targetEntity']); |
||
375 | |||
376 | if ($this->noExistsJoin($prevEntityAlias, $currentRelation)) { |
||
377 | if ($association['isOwningSide']) { |
||
378 | $queryBuilder->join($association['targetEntity'], "$currentEntityAlias", "WITH", "$currentEntityAlias.id = " . "$prevEntityAlias.$currentRelation"); |
||
379 | } else { |
||
380 | $mappedBy = $association['mappedBy']; |
||
381 | $queryBuilder->join($association['targetEntity'], "$currentEntityAlias", "WITH", "$currentEntityAlias.$mappedBy = " . "$prevEntityAlias.id"); |
||
382 | } |
||
383 | |||
384 | $this->storeJoin($prevEntityAlias, $currentRelation); |
||
385 | } |
||
386 | } |
||
387 | |||
388 | $prevEntityAlias = $currentEntityAlias; |
||
389 | $prevEntityName = $association['targetEntity']; |
||
390 | } |
||
391 | |||
392 | $this->setEmbeddedFields($embeddedFields); |
||
393 | $this->setCurrentEntityAlias($currentEntityAlias); |
||
394 | } |
||
395 | |||
396 | return $queryBuilder; |
||
397 | } |
||
398 | |||
399 | protected function getCurrentEntityAlias() : string |
||
400 | { |
||
401 | return $this->currentEntityAlias; |
||
402 | } |
||
403 | |||
404 | protected function setCurrentEntityAlias(string $currentEntityAlias) |
||
405 | { |
||
406 | $this->currentEntityAlias = $currentEntityAlias; |
||
407 | } |
||
408 | |||
409 | protected function getEmbeddedFields() : array |
||
410 | { |
||
411 | return $this->embeddedFields; |
||
412 | } |
||
413 | |||
414 | protected function setEmbeddedFields(array $embeddedFields) |
||
415 | { |
||
416 | $this->embeddedFields = $embeddedFields; |
||
417 | } |
||
418 | |||
419 | /** @deprecate use QueryBuilderFatory component instead */ |
||
420 | //protected function sort($queryBuilder) |
||
421 | //{ |
||
422 | //$request = $this->getRequest(); |
||
423 | //$sorting = $request->query->get('sorting', array()); |
||
424 | |||
425 | //foreach ($this->fields as $field) { |
||
426 | //if (isset($sorting[$field])) { |
||
427 | //$direction = ($sorting[$field] === 'asc') ? 'asc' : 'desc'; |
||
428 | //$queryBuilder->addOrderBy($this->entityAlias.'.'.$field, $direction); |
||
429 | //} |
||
430 | //} |
||
431 | |||
432 | 1 | //// &sorting[_embedded.{{relazione}}.{{campo}}={{val}} |
|
433 | //foreach ($sorting as $sort => $val) { |
||
434 | 1 | //if (strstr($sort, '_embedded.')) { |
|
435 | 1 | ||
436 | 1 | //$queryBuilder = $this->join($queryBuilder, $sort, $val); |
|
437 | |||
438 | //$currentEntityAlias = $this->getCurrentEntityAlias(); |
||
439 | //$embeddedFields = $this->getEmbeddedFields(); |
||
440 | //$numFields = count($embeddedFields); |
||
441 | |||
442 | //$fieldName = $embeddedFields[$numFields - 1]; |
||
443 | //$direction = ($val === 'asc') ? 'asc' : 'desc'; |
||
444 | //$queryBuilder->addOrderBy("$currentEntityAlias." . $fieldName, $direction); |
||
445 | //} |
||
446 | //} |
||
447 | |||
448 | //return $queryBuilder; |
||
449 | //} |
||
450 | |||
451 | public function getEntityAlias(string $entityName) : string |
||
452 | { |
||
453 | $arrayEntityName = explode('\\', strtolower($entityName) ); |
||
454 | $entityAlias = $arrayEntityName[count($arrayEntityName)-1]; |
||
455 | return $entityAlias; |
||
456 | } |
||
457 | |||
458 | /** @deprecate use QueryBuilderFatory component instead */ |
||
459 | //protected function filter($queryBuilder) |
||
460 | //{ |
||
461 | //$request = $this->getRequest(); |
||
462 | //$filtering = $request->query->get('filtering', array()); |
||
463 | |||
464 | //foreach ($this->fields as $field) { |
||
465 | //if (isset($filtering[$field])) { |
||
466 | //switch ($field) { |
||
467 | //case 'id': |
||
468 | //case 'year': |
||
469 | //case 'week': |
||
470 | //$queryBuilder->andWhere($this->entityAlias.'.'.$field.' = :filter_'.$field) |
||
471 | //->setParameter('filter_'.$field, $filtering[$field]); |
||
472 | //break; |
||
473 | //default: |
||
474 | //$queryBuilder->andWhere($this->entityAlias.'.'.$field.' LIKE :filter_'.$field) |
||
475 | //->setParameter('filter_'.$field, '%'.$filtering[$field].'%'); |
||
476 | //} |
||
477 | //} |
||
478 | //} |
||
479 | |||
480 | //// &filtering[_embedded.{{relazione}}.{{campo}}]={{val}} |
||
481 | //foreach ($filtering as $filter => $val) { |
||
482 | //if (strstr($filter, '_embedded.')) { |
||
483 | |||
484 | //$queryBuilder = $this->join($queryBuilder, $filter, $val); |
||
485 | |||
486 | //$currentEntityAlias = $this->getCurrentEntityAlias(); |
||
487 | //$embeddedFields = $this->getEmbeddedFields(); |
||
488 | //$numFields = count($embeddedFields); |
||
489 | //$fieldName = $embeddedFields[$numFields - 1]; |
||
490 | |||
491 | //$paramName = str_replace(".", "_", $filter); |
||
492 | |||
493 | //switch ($fieldName) { |
||
494 | //case 'id': |
||
495 | //case 'codiceClienteFornitore': |
||
496 | //case 'codiceFamily': |
||
497 | //case 'year': |
||
498 | //case 'week': |
||
499 | //$queryBuilder->andWhere("$currentEntityAlias." . $fieldName . ' = :filter_' . $paramName) |
||
500 | //->setParameter('filter_' . $paramName, $val); |
||
501 | //break; |
||
502 | //default : |
||
503 | //$queryBuilder->andWhere("$currentEntityAlias." . $fieldName . ' LIKE :filter_' . $paramName) |
||
504 | //->setParameter('filter_' . $paramName, '%' . $val . '%'); |
||
505 | //} |
||
506 | //} |
||
507 | //} |
||
508 | |||
509 | //return $queryBuilder; |
||
510 | //} |
||
511 | |||
512 | protected function relationship($queryBuilder) |
||
513 | { |
||
514 | return $queryBuilder; |
||
515 | } |
||
516 | |||
517 | /** |
||
518 | * |
||
519 | * @param type $insertFields |
||
520 | * @param type $updateFields |
||
521 | * |
||
522 | * USE: |
||
523 | * |
||
524 | * $this->getEntityManager() |
||
525 | * ->getRepository('User') |
||
526 | * ->onDuplicateUpdate(['column1' => 'user_reminder_1', 'column2' => 235], ['column2' => 255]); |
||
527 | */ |
||
528 | public function onDuplicateUpdate($insertFields, $updateFields) |
||
554 | } |
||
555 | |||
556 | public function getQueryBuilderFactoryWithoutInitialization() |
||
557 | { |
||
558 | return $this->queryBuilderFactory; |
||
559 | } |
||
560 | |||
561 | public function setConfigProvider(ConfigProvider $provider) |
||
566 | } |
||
567 | } |
||
568 |
The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g.
excluded_paths: ["lib/*"]
, you can move it to the dependency path list as follows:For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths