Erikmitk /
kitodo-presentation
| Total Complexity | 85 |
| Total Lines | 537 |
| Duplicated Lines | 0 % |
| Changes | 8 | ||
| Bugs | 2 | Features | 1 |
Complex classes like SearchController 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 SearchController, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 36 | class SearchController extends AbstractController |
||
| 37 | { |
||
| 38 | /** |
||
| 39 | * @access protected |
||
| 40 | * @var CollectionRepository |
||
| 41 | */ |
||
| 42 | protected CollectionRepository $collectionRepository; |
||
| 43 | |||
| 44 | /** |
||
| 45 | * @access public |
||
| 46 | * |
||
| 47 | * @param CollectionRepository $collectionRepository |
||
| 48 | * |
||
| 49 | * @return void |
||
| 50 | */ |
||
| 51 | public function injectCollectionRepository(CollectionRepository $collectionRepository): void |
||
| 52 | { |
||
| 53 | $this->collectionRepository = $collectionRepository; |
||
| 54 | } |
||
| 55 | |||
| 56 | /** |
||
| 57 | * @access protected |
||
| 58 | * @var MetadataRepository |
||
| 59 | */ |
||
| 60 | protected MetadataRepository $metadataRepository; |
||
| 61 | |||
| 62 | /** |
||
| 63 | * @access public |
||
| 64 | * |
||
| 65 | * @param MetadataRepository $metadataRepository |
||
| 66 | * |
||
| 67 | * @return void |
||
| 68 | */ |
||
| 69 | public function injectMetadataRepository(MetadataRepository $metadataRepository): void |
||
| 70 | { |
||
| 71 | $this->metadataRepository = $metadataRepository; |
||
| 72 | } |
||
| 73 | |||
| 74 | /** |
||
| 75 | * @access protected |
||
| 76 | * @var array The current search parameter |
||
| 77 | */ |
||
| 78 | protected ?array $searchParams; |
||
| 79 | |||
| 80 | /** |
||
| 81 | * Search Action |
||
| 82 | * |
||
| 83 | * @access public |
||
| 84 | * |
||
| 85 | * @return void |
||
| 86 | */ |
||
| 87 | public function searchAction(): void |
||
| 88 | { |
||
| 89 | // if search was triggered, get search parameters from POST variables |
||
| 90 | $this->searchParams = $this->getParametersSafely('searchParameter'); |
||
|
|
|||
| 91 | |||
| 92 | // output is done by main action |
||
| 93 | $this->forward('main', null, null, ['searchParameter' => $this->searchParams]); |
||
| 94 | } |
||
| 95 | |||
| 96 | /** |
||
| 97 | * Main action |
||
| 98 | * |
||
| 99 | * This shows the search form and optional the facets and extended search form. |
||
| 100 | * |
||
| 101 | * @access public |
||
| 102 | * |
||
| 103 | * @return void |
||
| 104 | */ |
||
| 105 | public function mainAction(): void |
||
| 210 | } |
||
| 211 | |||
| 212 | /** |
||
| 213 | * Adds the facets menu to the search form |
||
| 214 | * |
||
| 215 | * @access protected |
||
| 216 | */ |
||
| 217 | protected function addFacetsMenu(): void |
||
| 218 | { |
||
| 219 | // Quit without doing anything if no facets are configured. |
||
| 220 | if (empty($this->settings['facets']) && empty($this->settings['facetCollections'])) { |
||
| 221 | return; |
||
| 222 | } |
||
| 223 | |||
| 224 | // Get facets from plugin configuration. |
||
| 225 | $facets = []; |
||
| 226 | foreach (GeneralUtility::trimExplode(',', $this->settings['facets'], true) as $facet) { |
||
| 227 | $facets[$facet . '_faceting'] = Helper::translate($facet, 'tx_dlf_metadata', $this->settings['storagePid']); |
||
| 228 | } |
||
| 229 | |||
| 230 | $this->view->assign('facetsMenu', $this->makeFacetsMenuArray($facets)); |
||
| 231 | } |
||
| 232 | |||
| 233 | /** |
||
| 234 | * This builds a menu array for HMENU |
||
| 235 | * |
||
| 236 | * @access public |
||
| 237 | * |
||
| 238 | * @param array $facets |
||
| 239 | * |
||
| 240 | * @return array HMENU array |
||
| 241 | */ |
||
| 242 | public function makeFacetsMenuArray(array $facets): array |
||
| 243 | { |
||
| 244 | // Set default value for facet search. |
||
| 245 | $search = [ |
||
| 246 | 'query' => '*:*', |
||
| 247 | 'params' => [ |
||
| 248 | 'component' => [ |
||
| 249 | 'facetset' => [ |
||
| 250 | 'facet' => [] |
||
| 251 | ] |
||
| 252 | ], |
||
| 253 | 'filterquery' => [] |
||
| 254 | ] |
||
| 255 | ]; |
||
| 256 | |||
| 257 | $fields = Solr::getFields(); |
||
| 258 | |||
| 259 | // Set search query. |
||
| 260 | $searchParams = $this->searchParams; |
||
| 261 | if ( |
||
| 262 | (!empty($searchParams['fulltext'])) |
||
| 263 | || preg_match('/' . $fields['fulltext'] . ':\((.*)\)/', trim($searchParams['query']), $matches) |
||
| 264 | ) { |
||
| 265 | // If the query already is a fulltext query e.g using the facets |
||
| 266 | $searchParams['query'] = empty($matches[1]) ? $searchParams['query'] : $matches[1]; |
||
| 267 | // Search in fulltext field if applicable. Query must not be empty! |
||
| 268 | if (!empty($searchParams['query'])) { |
||
| 269 | $search['query'] = $fields['fulltext'] . ':(' . Solr::escapeQuery(trim($searchParams['query'])) . ')'; |
||
| 270 | } |
||
| 271 | } else { |
||
| 272 | // Retain given search field if valid. |
||
| 273 | if (!empty($searchParams['query'])) { |
||
| 274 | $search['query'] = Solr::escapeQueryKeepField(trim($searchParams['query']), $this->settings['storagePid']); |
||
| 275 | } |
||
| 276 | } |
||
| 277 | |||
| 278 | $collectionsQuery = $this->addCollectionsQuery($search['query']); |
||
| 279 | if (!empty($collectionsQuery)) { |
||
| 280 | $search['params']['filterquery'][]['query'] = $collectionsQuery; |
||
| 281 | } |
||
| 282 | |||
| 283 | // add filter query for date search |
||
| 284 | if (!empty($this->searchParams['dateFrom']) && !empty($this->searchParams['dateTo'])) { |
||
| 285 | // combine dateFrom and dateTo into filterquery as range search |
||
| 286 | $search['params']['filterquery'][]['query'] = '{!join from=' . $fields['uid'] . ' to=' . $fields['uid'] . '}' . $fields['date'] . ':[' . $this->searchParams['dateFrom'] . ' TO ' . $this->searchParams['dateTo'] . ']'; |
||
| 287 | } |
||
| 288 | |||
| 289 | // Add extended search query. |
||
| 290 | if ( |
||
| 291 | !empty($searchParams['extQuery']) |
||
| 292 | && is_array($searchParams['extQuery']) |
||
| 293 | ) { |
||
| 294 | // If the search query is already set by the simple search field, we have to reset it. |
||
| 295 | $search['query'] = ''; |
||
| 296 | $allowedOperators = ['AND', 'OR', 'NOT']; |
||
| 297 | $numberOfExtQueries = count($searchParams['extQuery']); |
||
| 298 | for ($i = 0; $i < $numberOfExtQueries; $i++) { |
||
| 299 | if (!empty($searchParams['extQuery'][$i])) { |
||
| 300 | if ( |
||
| 301 | in_array($searchParams['extOperator'][$i], $allowedOperators) |
||
| 302 | ) { |
||
| 303 | if (!empty($search['query'])) { |
||
| 304 | $search['query'] .= ' ' . $searchParams['extOperator'][$i] . ' '; |
||
| 305 | } |
||
| 306 | $search['query'] .= Indexer::getIndexFieldName($searchParams['extField'][$i], $this->settings['storagePid']) . ':(' . Solr::escapeQuery($searchParams['extQuery'][$i]) . ')'; |
||
| 307 | } |
||
| 308 | } |
||
| 309 | } |
||
| 310 | } |
||
| 311 | |||
| 312 | if (isset($this->searchParams['fq']) && is_array($this->searchParams['fq'])) { |
||
| 313 | foreach ($this->searchParams['fq'] as $fq) { |
||
| 314 | $search['params']['filterquery'][]['query'] = $fq; |
||
| 315 | } |
||
| 316 | } |
||
| 317 | |||
| 318 | // Get applicable facets. |
||
| 319 | $solr = Solr::getInstance($this->settings['solrcore']); |
||
| 320 | if (!$solr->ready) { |
||
| 321 | $this->logger->error('Apache Solr not available'); |
||
| 322 | return []; |
||
| 323 | } |
||
| 324 | |||
| 325 | foreach (array_keys($facets) as $field) { |
||
| 326 | $search['params']['component']['facetset']['facet'][] = [ |
||
| 327 | 'type' => 'field', |
||
| 328 | 'mincount' => '1', |
||
| 329 | 'key' => $field, |
||
| 330 | 'field' => $field, |
||
| 331 | 'limit' => $this->settings['limitFacets'], |
||
| 332 | 'sort' => isset($this->settings['sortingFacets']) ? $this->settings['sortingFacets'] : 'count' |
||
| 333 | ]; |
||
| 334 | } |
||
| 335 | |||
| 336 | // Set additional query parameters. |
||
| 337 | $search['params']['start'] = 0; |
||
| 338 | $search['params']['rows'] = 0; |
||
| 339 | // Set query. |
||
| 340 | $search['params']['query'] = $search['query']; |
||
| 341 | // Perform search. |
||
| 342 | $selectQuery = $solr->service->createSelect($search['params']); |
||
| 343 | // check for solr response |
||
| 344 | $solrRequest = $solr->service->createRequest($selectQuery); |
||
| 345 | $response = $solr->service->executeRequest($solrRequest); |
||
| 346 | // return empty facet on solr error |
||
| 347 | if ($response->getStatusCode() == 400) { |
||
| 348 | return []; |
||
| 349 | } |
||
| 350 | $results = $solr->service->select($selectQuery); |
||
| 351 | $facet = $results->getFacetSet(); |
||
| 352 | |||
| 353 | $facetCollectionArray = []; |
||
| 354 | |||
| 355 | // replace everything expect numbers and comma |
||
| 356 | $facetCollections = preg_replace('/[^\d,]/', '', $this->settings['facetCollections']); |
||
| 357 | |||
| 358 | if (!empty($facetCollections)) { |
||
| 359 | $collections = $this->collectionRepository->findCollectionsBySettings(['collections' => $facetCollections]); |
||
| 360 | |||
| 361 | /** @var Collection $collection */ |
||
| 362 | foreach ($collections as $collection) { |
||
| 363 | $facetCollectionArray[] = $collection->getIndexName(); |
||
| 364 | } |
||
| 365 | } |
||
| 366 | |||
| 367 | return $this->processResults($facet, $facetCollectionArray, $search); |
||
| 368 | } |
||
| 369 | |||
| 370 | /** |
||
| 371 | * Add the collection query string, if the collections are given. |
||
| 372 | * |
||
| 373 | * @access private |
||
| 374 | * |
||
| 375 | * @param string $query The current query |
||
| 376 | * |
||
| 377 | * @return string The collection query string |
||
| 378 | */ |
||
| 379 | private function addCollectionsQuery(string $query): string |
||
| 380 | { |
||
| 381 | // if collections are given, we prepare the collections query string |
||
| 382 | // extract collections from collection parameter |
||
| 383 | $collections = null; |
||
| 384 | if ($this->searchParams['collection']) { |
||
| 385 | foreach (explode(',', $this->searchParams['collection']) as $collectionEntry) { |
||
| 386 | $collections[] = $this->collectionRepository->findByUid((int) $collectionEntry); |
||
| 387 | } |
||
| 388 | } |
||
| 389 | if ($collections) { |
||
| 390 | $collectionsQueryString = ''; |
||
| 391 | $virtualCollectionsQueryString = ''; |
||
| 392 | foreach ($collections as $collectionEntry) { |
||
| 393 | // check for virtual collections query string |
||
| 394 | if ($collectionEntry->getIndexSearch()) { |
||
| 395 | $virtualCollectionsQueryString .= empty($virtualCollectionsQueryString) ? '(' . $collectionEntry->getIndexSearch() . ')' : ' OR (' . $collectionEntry->getIndexSearch() . ')'; |
||
| 396 | } else { |
||
| 397 | $collectionsQueryString .= empty($collectionsQueryString) ? '"' . $collectionEntry->getIndexName() . '"' : ' OR "' . $collectionEntry->getIndexName() . '"'; |
||
| 398 | } |
||
| 399 | } |
||
| 400 | |||
| 401 | // distinguish between simple collection browsing and actual searching within the collection(s) |
||
| 402 | if (!empty($collectionsQueryString)) { |
||
| 403 | if (empty($query)) { |
||
| 404 | $collectionsQueryString = '(collection_faceting:(' . $collectionsQueryString . ') AND toplevel:true AND partof:0)'; |
||
| 405 | } else { |
||
| 406 | $collectionsQueryString = '(collection_faceting:(' . $collectionsQueryString . '))'; |
||
| 407 | } |
||
| 408 | } |
||
| 409 | |||
| 410 | // virtual collections might query documents that are neither toplevel:true nor partof:0 and need to be searched separately |
||
| 411 | if (!empty($virtualCollectionsQueryString)) { |
||
| 412 | $virtualCollectionsQueryString = '(' . $virtualCollectionsQueryString . ')'; |
||
| 413 | } |
||
| 414 | |||
| 415 | // combine both querystrings into a single filterquery via OR if both are given, otherwise pass either of those |
||
| 416 | return implode(" OR ", array_filter([$collectionsQueryString, $virtualCollectionsQueryString])); |
||
| 417 | } |
||
| 418 | return ""; |
||
| 419 | } |
||
| 420 | |||
| 421 | /** |
||
| 422 | * Creates an array for a HMENU entry of a facet value. |
||
| 423 | * |
||
| 424 | * @access private |
||
| 425 | * |
||
| 426 | * @param string $field The facet's index_name |
||
| 427 | * @param string $value The facet's value |
||
| 428 | * @param int $count Number of hits for this facet |
||
| 429 | * @param array $search The parameters of the current search query |
||
| 430 | * @param string &$state The state of the parent item |
||
| 431 | * |
||
| 432 | * @return array The array for the facet's menu entry |
||
| 433 | */ |
||
| 434 | private function getFacetsMenuEntry(string $field, string $value, int $count, array $search, string &$state): array |
||
| 462 | } |
||
| 463 | |||
| 464 | /** |
||
| 465 | * Process results. |
||
| 466 | * |
||
| 467 | * @access private |
||
| 468 | * |
||
| 469 | * @param FacetSet|null $facet |
||
| 470 | * @param array $facetCollectionArray |
||
| 471 | * @param array $search |
||
| 472 | * |
||
| 473 | * @return array menu array |
||
| 474 | */ |
||
| 475 | private function processResults($facet, array $facetCollectionArray, array $search): array |
||
| 476 | { |
||
| 477 | $menuArray = []; |
||
| 478 | |||
| 479 | if ($facet) { |
||
| 480 | foreach ($facet as $field => $values) { |
||
| 481 | $entryArray = []; |
||
| 482 | $entryArray['field'] = substr($field, 0, strpos($field, '_faceting')); |
||
| 483 | $entryArray['count'] = 0; |
||
| 484 | $entryArray['_OVERRIDE_HREF'] = ''; |
||
| 485 | $entryArray['ITEM_STATE'] = 'NO'; |
||
| 486 | // Count number of facet values. |
||
| 487 | $i = 0; |
||
| 488 | foreach ($values as $value => $count) { |
||
| 489 | if ($count > 0) { |
||
| 490 | // check if facet collection configuration exists |
||
| 491 | if (!empty($this->settings['facetCollections'])) { |
||
| 492 | if ($field == "collection_faceting" && !in_array($value, $facetCollectionArray)) { |
||
| 493 | continue; |
||
| 494 | } |
||
| 495 | } |
||
| 496 | $entryArray['count']++; |
||
| 497 | if ($entryArray['ITEM_STATE'] == 'NO') { |
||
| 498 | $entryArray['ITEM_STATE'] = 'IFSUB'; |
||
| 499 | } |
||
| 500 | $entryArray['_SUB_MENU'][] = $this->getFacetsMenuEntry($field, $value, $count, $search, $entryArray['ITEM_STATE']); |
||
| 501 | if (++$i == $this->settings['limit']) { |
||
| 502 | break; |
||
| 503 | } |
||
| 504 | } else { |
||
| 505 | break; |
||
| 506 | } |
||
| 507 | } |
||
| 508 | $menuArray[] = $entryArray; |
||
| 509 | } |
||
| 510 | } |
||
| 511 | return $menuArray; |
||
| 512 | } |
||
| 513 | |||
| 514 | /** |
||
| 515 | * Translates value depending on the index name. |
||
| 516 | * |
||
| 517 | * @access private |
||
| 518 | * |
||
| 519 | * @param string $field The facet's index_name |
||
| 520 | * @param string $value The facet's value |
||
| 521 | * |
||
| 522 | * @return string |
||
| 523 | */ |
||
| 524 | private function translateValue(string $field, string $value): string |
||
| 541 | } |
||
| 542 | } |
||
| 543 | |||
| 544 | /** |
||
| 545 | * Returns the extended search form and adds the JS files necessary for extended search. |
||
| 546 | * |
||
| 547 | * @access private |
||
| 548 | * |
||
| 549 | * @return void |
||
| 550 | */ |
||
| 551 | private function addExtendedSearch(): void |
||
| 573 | } |
||
| 574 | } |
||
| 575 |
Loading history...
Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly.
For example, imagine you have a variable
$accountIdthat can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to theidproperty of an instance of theAccountclass. This class holds a proper account, so the id value must no longer be false.Either this assignment is in error or a type check should be added for that assignment.