studiomado /
query-bundle
| Total Complexity | 52 |
| Total Lines | 545 |
| Duplicated Lines | 16.88 % |
| 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->queryOptions && $this->configProvider) { |
||
| 267 | $this->setRequest($this->configProvider->getRequest()); |
||
| 268 | 1 | $this->queryBuilderFactory->setConfigProvider($this->configProvider); |
|
| 269 | } |
||
| 270 | 1 | ||
| 271 | $this->initFromQueryBuilderOptions($this->queryOptions); |
||
| 272 | |||
| 273 | 4 | $this->queryBuilderFactory->filter(); |
|
| 274 | $this->queryBuilderFactory->sort(); |
||
| 275 | 4 | ||
| 276 | return $this->paginateResults($this->queryBuilderFactory->getQueryBuilder()); |
||
| 277 | } |
||
| 278 | |||
| 279 | protected function paginateResults( |
||
| 280 | \Doctrine\ORM\QueryBuilder $queryBuilder |
||
| 281 | ) { |
||
| 282 | $limit = $this->queryOptions->get('limit', 10); |
||
| 283 | $page = $this->queryOptions->get('page', 1); |
||
| 284 | |||
| 285 | |||
| 286 | $pagerAdapter = new DoctrineORMAdapter($queryBuilder); |
||
| 287 | |||
| 288 | $query = $pagerAdapter->getQuery(); |
||
| 289 | if(isset($this->use_result_cache) and $this->use_result_cache){ |
||
| 290 | $query->useResultCache(true, 600); |
||
| 291 | } |
||
| 292 | |||
| 293 | $pager = new Pagerfanta($pagerAdapter); |
||
| 294 | $pager->setNormalizeOutOfRangePages(true); |
||
| 295 | $pager->setMaxPerPage($limit); |
||
| 296 | $pager->setCurrentPage($page); |
||
| 297 | |||
| 298 | $pagerFactory = new PagerfantaFactory(); |
||
| 299 | |||
| 300 | $router = $this->createRouter(); |
||
| 301 | |||
| 302 | $results = $pagerFactory->createRepresentation($pager, $router); |
||
| 303 | |||
| 304 | return $results; |
||
| 305 | } |
||
| 306 | |||
| 307 | protected function customQueryStringValues() |
||
| 308 | { |
||
| 309 | return []; |
||
| 310 | } |
||
| 311 | |||
| 312 | protected function createRouter() |
||
| 313 | { |
||
| 314 | $request = $this->getRequest(); |
||
| 315 | $params = []; |
||
| 316 | |||
| 317 | $list = array_merge([ |
||
| 318 | 'filtering', |
||
| 319 | 'limit', |
||
| 320 | 'page', |
||
| 321 | 'sorting', |
||
| 322 | ], $this->customQueryStringValues()); |
||
| 323 | |||
| 324 | foreach ($list as $itemKey => $itemValue) { |
||
| 325 | $params[$itemValue] = $this->queryOptions->get($itemValue); |
||
| 326 | } |
||
| 327 | |||
| 328 | if(!isset($this->route_name)){ |
||
| 329 | $this->route_name = $this->queryOptions->get('_route'); |
||
| 330 | } |
||
| 331 | |||
| 332 | return new Route($this->route_name, $params); |
||
| 333 | } |
||
| 334 | |||
| 335 | /** @deprecate use QueryBuilderFatory instead */ |
||
| 336 | public function noExistsJoin($prevEntityAlias, $currentEntityAlias) |
||
| 337 | { |
||
| 338 | $needle = $prevEntityAlias . "_" . $currentEntityAlias; |
||
| 339 | return ! in_array($needle, $this->joins); |
||
| 340 | } |
||
| 341 | |||
| 342 | /** @deprecate use QueryBuilderFatory instead */ |
||
| 343 | public function storeJoin($prevEntityAlias, $currentEntityAlias) |
||
| 344 | { |
||
| 345 | $needle = $prevEntityAlias . "_" . $currentEntityAlias; |
||
| 346 | $this->joins[$needle] = $needle; |
||
| 347 | } |
||
| 348 | |||
| 349 | /** @deprecate use QueryBuilderFatory instead */ |
||
| 350 | public function join($queryBuilder, $key, $val) |
||
| 351 | { |
||
| 352 | if (strstr($key, '_embedded.')) { |
||
| 353 | $embeddedFields = explode('.', $key); |
||
| 354 | $numFields = count($embeddedFields); |
||
| 355 | |||
| 356 | $prevEntityAlias = $this->entityAlias; // Stocksellouts |
||
| 357 | $prevEntityName = $this->getEntityName(); // Stocksellouts |
||
| 358 | |||
| 359 | for ($i = 1; $i < $numFields - 1; $i++) { |
||
| 360 | $metadata = $this->getEntityManager()->getClassMetadata($prevEntityName); |
||
| 361 | |||
| 362 | $currentRelation = $embeddedFields[$i]; |
||
| 363 | |||
| 364 | if ($metadata->hasAssociation($currentRelation)) { |
||
| 365 | |||
| 366 | $association = $metadata->getAssociationMapping($currentRelation); |
||
| 367 | |||
| 368 | $currentEntityAlias = $this->getEntityAlias($association['targetEntity']); |
||
| 369 | |||
| 370 | if ($this->noExistsJoin($prevEntityAlias, $currentRelation)) { |
||
| 371 | if ($association['isOwningSide']) { |
||
| 372 | $queryBuilder->join($association['targetEntity'], "$currentEntityAlias", "WITH", "$currentEntityAlias.id = " . "$prevEntityAlias.$currentRelation"); |
||
| 373 | } else { |
||
| 374 | $mappedBy = $association['mappedBy']; |
||
| 375 | $queryBuilder->join($association['targetEntity'], "$currentEntityAlias", "WITH", "$currentEntityAlias.$mappedBy = " . "$prevEntityAlias.id"); |
||
| 376 | } |
||
| 377 | |||
| 378 | $this->storeJoin($prevEntityAlias, $currentRelation); |
||
| 379 | } |
||
| 380 | } |
||
| 381 | |||
| 382 | $prevEntityAlias = $currentEntityAlias; |
||
| 383 | $prevEntityName = $association['targetEntity']; |
||
| 384 | } |
||
| 385 | |||
| 386 | $this->setEmbeddedFields($embeddedFields); |
||
| 387 | $this->setCurrentEntityAlias($currentEntityAlias); |
||
| 388 | } |
||
| 389 | |||
| 390 | return $queryBuilder; |
||
| 391 | } |
||
| 392 | |||
| 393 | protected function getCurrentEntityAlias() : string |
||
| 394 | { |
||
| 395 | return $this->currentEntityAlias; |
||
| 396 | } |
||
| 397 | |||
| 398 | protected function setCurrentEntityAlias(string $currentEntityAlias) |
||
| 399 | { |
||
| 400 | $this->currentEntityAlias = $currentEntityAlias; |
||
| 401 | } |
||
| 402 | |||
| 403 | protected function getEmbeddedFields() : array |
||
| 404 | { |
||
| 405 | return $this->embeddedFields; |
||
| 406 | } |
||
| 407 | |||
| 408 | protected function setEmbeddedFields(array $embeddedFields) |
||
| 409 | { |
||
| 410 | $this->embeddedFields = $embeddedFields; |
||
| 411 | } |
||
| 412 | |||
| 413 | /** @deprecate use QueryBuilderFatory component instead */ |
||
| 414 | //protected function sort($queryBuilder) |
||
| 415 | //{ |
||
| 416 | //$request = $this->getRequest(); |
||
| 417 | //$sorting = $request->query->get('sorting', array()); |
||
| 418 | |||
| 419 | //foreach ($this->fields as $field) { |
||
| 420 | //if (isset($sorting[$field])) { |
||
| 421 | //$direction = ($sorting[$field] === 'asc') ? 'asc' : 'desc'; |
||
| 422 | //$queryBuilder->addOrderBy($this->entityAlias.'.'.$field, $direction); |
||
| 423 | //} |
||
| 424 | //} |
||
| 425 | |||
| 426 | //// &sorting[_embedded.{{relazione}}.{{campo}}={{val}} |
||
| 427 | //foreach ($sorting as $sort => $val) { |
||
| 428 | //if (strstr($sort, '_embedded.')) { |
||
| 429 | |||
| 430 | //$queryBuilder = $this->join($queryBuilder, $sort, $val); |
||
| 431 | |||
| 432 | 1 | //$currentEntityAlias = $this->getCurrentEntityAlias(); |
|
| 433 | //$embeddedFields = $this->getEmbeddedFields(); |
||
| 434 | 1 | //$numFields = count($embeddedFields); |
|
| 435 | 1 | ||
| 436 | 1 | //$fieldName = $embeddedFields[$numFields - 1]; |
|
| 437 | //$direction = ($val === 'asc') ? 'asc' : 'desc'; |
||
| 438 | //$queryBuilder->addOrderBy("$currentEntityAlias." . $fieldName, $direction); |
||
| 439 | //} |
||
| 440 | //} |
||
| 441 | |||
| 442 | //return $queryBuilder; |
||
| 443 | //} |
||
| 444 | |||
| 445 | public function getEntityAlias(string $entityName) : string |
||
| 446 | { |
||
| 447 | $arrayEntityName = explode('\\', strtolower($entityName) ); |
||
| 448 | $entityAlias = $arrayEntityName[count($arrayEntityName)-1]; |
||
| 449 | return $entityAlias; |
||
| 450 | } |
||
| 451 | |||
| 452 | /** @deprecate use QueryBuilderFatory component instead */ |
||
| 453 | //protected function filter($queryBuilder) |
||
| 454 | //{ |
||
| 455 | //$request = $this->getRequest(); |
||
| 456 | //$filtering = $request->query->get('filtering', array()); |
||
| 457 | |||
| 458 | //foreach ($this->fields as $field) { |
||
| 459 | //if (isset($filtering[$field])) { |
||
| 460 | //switch ($field) { |
||
| 461 | //case 'id': |
||
| 462 | //case 'year': |
||
| 463 | //case 'week': |
||
| 464 | //$queryBuilder->andWhere($this->entityAlias.'.'.$field.' = :filter_'.$field) |
||
| 465 | //->setParameter('filter_'.$field, $filtering[$field]); |
||
| 466 | //break; |
||
| 467 | //default: |
||
| 468 | //$queryBuilder->andWhere($this->entityAlias.'.'.$field.' LIKE :filter_'.$field) |
||
| 469 | //->setParameter('filter_'.$field, '%'.$filtering[$field].'%'); |
||
| 470 | //} |
||
| 471 | //} |
||
| 472 | //} |
||
| 473 | |||
| 474 | //// &filtering[_embedded.{{relazione}}.{{campo}}]={{val}} |
||
| 475 | //foreach ($filtering as $filter => $val) { |
||
| 476 | //if (strstr($filter, '_embedded.')) { |
||
| 477 | |||
| 478 | //$queryBuilder = $this->join($queryBuilder, $filter, $val); |
||
| 479 | |||
| 480 | //$currentEntityAlias = $this->getCurrentEntityAlias(); |
||
| 481 | //$embeddedFields = $this->getEmbeddedFields(); |
||
| 482 | //$numFields = count($embeddedFields); |
||
| 483 | //$fieldName = $embeddedFields[$numFields - 1]; |
||
| 484 | |||
| 485 | //$paramName = str_replace(".", "_", $filter); |
||
| 486 | |||
| 487 | //switch ($fieldName) { |
||
| 488 | //case 'id': |
||
| 489 | //case 'codiceClienteFornitore': |
||
| 490 | //case 'codiceFamily': |
||
| 491 | //case 'year': |
||
| 492 | //case 'week': |
||
| 493 | //$queryBuilder->andWhere("$currentEntityAlias." . $fieldName . ' = :filter_' . $paramName) |
||
| 494 | //->setParameter('filter_' . $paramName, $val); |
||
| 495 | //break; |
||
| 496 | //default : |
||
| 497 | //$queryBuilder->andWhere("$currentEntityAlias." . $fieldName . ' LIKE :filter_' . $paramName) |
||
| 498 | //->setParameter('filter_' . $paramName, '%' . $val . '%'); |
||
| 499 | //} |
||
| 500 | //} |
||
| 501 | //} |
||
| 502 | |||
| 503 | //return $queryBuilder; |
||
| 504 | //} |
||
| 505 | |||
| 506 | protected function relationship($queryBuilder) |
||
| 507 | { |
||
| 508 | return $queryBuilder; |
||
| 509 | } |
||
| 510 | |||
| 511 | /** |
||
| 512 | * |
||
| 513 | * @param type $insertFields |
||
| 514 | * @param type $updateFields |
||
| 515 | * |
||
| 516 | * USE: |
||
| 517 | * |
||
| 518 | * $this->getEntityManager() |
||
| 519 | * ->getRepository('User') |
||
| 520 | * ->onDuplicateUpdate(['column1' => 'user_reminder_1', 'column2' => 235], ['column2' => 255]); |
||
| 521 | */ |
||
| 522 | public function onDuplicateUpdate($insertFields, $updateFields) |
||
| 548 | } |
||
| 549 | |||
| 550 | public function getQueryBuilderFactoryWithoutInitialization() |
||
| 551 | { |
||
| 552 | return $this->queryBuilderFactory; |
||
| 553 | } |
||
| 554 | |||
| 555 | public function setConfigProvider(ConfigProvider $provider) |
||
| 560 | } |
||
| 561 | } |
||
| 562 |
Loading history...
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