TYPO3-Solr /
ext-solr
Complex classes like SearchResultSetService 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 SearchResultSetService, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 46 | class SearchResultSetService |
||
| 47 | { |
||
| 48 | /** |
||
| 49 | * Additional filters, which will be added to the query, as well as to |
||
| 50 | * suggest queries. |
||
| 51 | * |
||
| 52 | * @var array |
||
| 53 | */ |
||
| 54 | protected $additionalFilters = []; |
||
| 55 | |||
| 56 | /** |
||
| 57 | * Track, if the number of results per page has been changed by the current request |
||
| 58 | * |
||
| 59 | * @var bool |
||
| 60 | */ |
||
| 61 | protected $resultsPerPageChanged = false; |
||
| 62 | |||
| 63 | /** |
||
| 64 | * @var \ApacheSolrForTypo3\Solr\Search |
||
| 65 | */ |
||
| 66 | protected $search; |
||
| 67 | |||
| 68 | /** |
||
| 69 | * @var SearchResultSet |
||
| 70 | */ |
||
| 71 | protected $lastResultSet = null; |
||
| 72 | |||
| 73 | /** |
||
| 74 | * @var bool |
||
| 75 | */ |
||
| 76 | protected $useQueryAwareComponents = true; |
||
| 77 | |||
| 78 | /** |
||
| 79 | * @var |
||
| 80 | */ |
||
| 81 | protected $isSolrAvailable = false; |
||
| 82 | |||
| 83 | /** |
||
| 84 | * @var TypoScriptConfiguration |
||
| 85 | */ |
||
| 86 | protected $typoScriptConfiguration; |
||
| 87 | |||
| 88 | /** |
||
| 89 | * @var \ApacheSolrForTypo3\Solr\System\Logging\SolrLogManager; |
||
| 90 | */ |
||
| 91 | protected $logger = null; |
||
| 92 | |||
| 93 | /** |
||
| 94 | * @param TypoScriptConfiguration $configuration |
||
| 95 | * @param Search $search |
||
| 96 | */ |
||
| 97 | 41 | public function __construct(TypoScriptConfiguration $configuration, Search $search) |
|
| 103 | |||
| 104 | /** |
||
| 105 | * @param bool $useCache |
||
| 106 | * @return bool |
||
| 107 | */ |
||
| 108 | 25 | public function getIsSolrAvailable($useCache = true) |
|
| 113 | |||
| 114 | /** |
||
| 115 | * @return bool |
||
| 116 | */ |
||
| 117 | 25 | public function getHasSearched() |
|
| 121 | |||
| 122 | /** |
||
| 123 | * Retrieves the used search instance. |
||
| 124 | * |
||
| 125 | * @return Search |
||
| 126 | */ |
||
| 127 | 2 | public function getSearch() |
|
| 131 | |||
| 132 | /** |
||
| 133 | * @param bool $useQueryAwareComponents |
||
| 134 | */ |
||
| 135 | public function setUseQueryAwareComponents($useQueryAwareComponents) |
||
| 139 | |||
| 140 | /** |
||
| 141 | * @return bool |
||
| 142 | */ |
||
| 143 | public function getUseQueryAwareComponents() |
||
| 147 | |||
| 148 | /** |
||
| 149 | * Initializes the Query object and SearchComponents and returns |
||
| 150 | * the initialized query object, when a search should be executed. |
||
| 151 | * |
||
| 152 | * @param string $rawQuery |
||
| 153 | * @param int $resultsPerPage |
||
| 154 | * @return Query |
||
| 155 | */ |
||
| 156 | 33 | protected function getPreparedQuery($rawQuery, $resultsPerPage) |
|
| 193 | |||
| 194 | /** |
||
| 195 | * @param Query $query |
||
| 196 | */ |
||
| 197 | 33 | protected function initializeRegisteredSearchComponents(Query $query) |
|
| 212 | |||
| 213 | /** |
||
| 214 | * Returns the number of results per Page. |
||
| 215 | * |
||
| 216 | * Also influences how many result documents are returned by the Solr |
||
| 217 | * server as the return value is used in the Solr "rows" GET parameter. |
||
| 218 | * |
||
| 219 | * @param string $rawQuery |
||
| 220 | * @param int|null $requestedPerPage |
||
| 221 | * @return int number of results to show per page |
||
| 222 | */ |
||
| 223 | 33 | protected function getNumberOfResultsPerPage($rawQuery, $requestedPerPage = null) |
|
| 248 | |||
| 249 | /** |
||
| 250 | * Provides a hook for other classes to process the search's response. |
||
| 251 | * |
||
| 252 | * @param string $rawQuery |
||
| 253 | * @param Query $query The query that has been searched for. |
||
| 254 | * @param \Apache_Solr_Response $response The search's response. |
||
| 255 | */ |
||
| 256 | 35 | protected function processResponse($rawQuery, Query $query, \Apache_Solr_Response $response) |
|
| 277 | |||
| 278 | /** |
||
| 279 | * This method is used to add documents to the expanded documents of the SearchResult |
||
| 280 | * when collapsing is configured. |
||
| 281 | * |
||
| 282 | * @param \Apache_Solr_Response $response |
||
| 283 | */ |
||
| 284 | 35 | protected function addExpandedDocumentsFromVariants(\Apache_Solr_Response $response) |
|
| 323 | |||
| 324 | /** |
||
| 325 | * Wrap all results document it a custom EXT:solr SearchResult object. |
||
| 326 | * |
||
| 327 | * Can be overwritten: |
||
| 328 | * |
||
| 329 | * $GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['solr']['searchResultClassName '] = '' |
||
| 330 | * |
||
| 331 | * to use a custom result object. |
||
| 332 | * |
||
| 333 | * @param \Apache_Solr_Response $response |
||
| 334 | * @throws \Apache_Solr_ParserException |
||
| 335 | */ |
||
| 336 | 35 | protected function wrapResultDocumentInResultObject(\Apache_Solr_Response $response) |
|
| 337 | { |
||
| 338 | try { |
||
| 339 | 35 | $documents = $response->response->docs; |
|
| 340 | 1 | } catch (Apache_Solr_ParserException $e) { |
|
| 341 | // when variant are enable and the index is empty, we get a parse exception, because of a |
||
| 342 | // Apache Solr Bug. |
||
| 343 | // see: https://github.com/TYPO3-Solr/ext-solr/issues/668 |
||
| 344 | // @todo this try/catch block can be removed after upgrading to Apache Solr 6.4 |
||
| 345 | 1 | if (!$this->typoScriptConfiguration->getSearchVariants()) { |
|
| 346 | throw $e; |
||
| 347 | } |
||
| 348 | |||
| 349 | 1 | $response->response = new \stdClass(); |
|
| 350 | 1 | $response->spellcheck = []; |
|
| 351 | 1 | $response->debug = []; |
|
| 352 | 1 | $response->responseHeader = []; |
|
| 353 | 1 | $response->facet_counts = []; |
|
| 354 | |||
| 355 | 1 | $documents = []; |
|
| 356 | } |
||
| 357 | |||
| 358 | 35 | if (!is_array($documents)) { |
|
| 359 | 5 | return; |
|
| 360 | } |
||
| 361 | |||
| 362 | 30 | foreach ($documents as $key => $originalDocument) { |
|
| 363 | 27 | $result = $this->wrapApacheSolrDocumentInResultObject($originalDocument); |
|
| 364 | 27 | $documents[$key] = $result; |
|
| 365 | } |
||
| 366 | |||
| 367 | 30 | $response->response->docs = $documents; |
|
| 368 | 30 | } |
|
| 369 | |||
| 370 | /** |
||
| 371 | * This method is used to wrap the \Apache_Solr_Document instance in an instance of the configured SearchResult |
||
| 372 | * class. |
||
| 373 | * |
||
| 374 | * @param \Apache_Solr_Document $originalDocument |
||
| 375 | * @throws \InvalidArgumentException |
||
| 376 | * @return SearchResult |
||
| 377 | */ |
||
| 378 | 27 | protected function wrapApacheSolrDocumentInResultObject(\Apache_Solr_Document $originalDocument) |
|
| 379 | { |
||
| 380 | 27 | $searchResultClassName = $this->getResultClassName(); |
|
| 381 | 27 | $result = GeneralUtility::makeInstance($searchResultClassName, $originalDocument); |
|
| 382 | 27 | if (!$result instanceof SearchResult) { |
|
| 383 | throw new \InvalidArgumentException('Could not create result object with class: ' . (string)$searchResultClassName, 1470037679); |
||
| 384 | } |
||
| 385 | |||
| 386 | 27 | return $result; |
|
| 387 | } |
||
| 388 | |||
| 389 | /** |
||
| 390 | * @return string |
||
| 391 | */ |
||
| 392 | 27 | protected function getResultClassName() |
|
| 393 | { |
||
| 394 | 27 | return isset($GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['solr']['searchResultClassName ']) ? |
|
| 395 | 27 | $GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['solr']['searchResultClassName '] : SearchResult::class; |
|
| 396 | } |
||
| 397 | |||
| 398 | /** |
||
| 399 | * @return string |
||
| 400 | */ |
||
| 401 | 35 | protected function getResultSetClassName() |
|
| 402 | { |
||
| 403 | 35 | return isset($GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['solr']['searchResultSetClassName ']) ? |
|
| 404 | 35 | $GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['solr']['searchResultSetClassName '] : SearchResultSet::class; |
|
| 405 | } |
||
| 406 | |||
| 407 | /** |
||
| 408 | * Checks it the results should be hidden in the response. |
||
| 409 | * |
||
| 410 | * @param string $rawQuery |
||
| 411 | * @return bool |
||
| 412 | */ |
||
| 413 | 35 | protected function shouldHideResultsFromInitialSearch($rawQuery) |
|
| 414 | { |
||
| 415 | 35 | return ($this->typoScriptConfiguration->getSearchInitializeWithEmptyQuery() || $this->typoScriptConfiguration->getSearchInitializeWithQuery()) && !$this->typoScriptConfiguration->getSearchShowResultsOfInitialEmptyQuery() && !$this->typoScriptConfiguration->getSearchShowResultsOfInitialQuery() && $rawQuery === null; |
|
| 416 | } |
||
| 417 | |||
| 418 | /** |
||
| 419 | * Initializes additional filters configured through TypoScript and |
||
| 420 | * Flexforms for use in regular queries and suggest queries. |
||
| 421 | * |
||
| 422 | * @param Query $query |
||
| 423 | * @return void |
||
| 424 | */ |
||
| 425 | 33 | protected function applyPageSectionsRootLineFilter(Query $query) |
|
| 426 | { |
||
| 427 | 33 | $searchQueryFilters = $this->typoScriptConfiguration->getSearchQueryFilterConfiguration(); |
|
| 428 | 33 | if (count($searchQueryFilters) <= 0) { |
|
| 429 | 31 | return; |
|
| 430 | } |
||
| 431 | |||
| 432 | // special filter to limit search to specific page tree branches |
||
| 433 | 2 | if (array_key_exists('__pageSections', $searchQueryFilters)) { |
|
| 434 | $query->setRootlineFilter($searchQueryFilters['__pageSections']); |
||
| 435 | $this->typoScriptConfiguration->removeSearchQueryFilterForPageSections(); |
||
| 436 | } |
||
| 437 | 2 | } |
|
| 438 | |||
| 439 | /** |
||
| 440 | * Retrieves the configuration filters from the TypoScript configuration, except the __pageSections filter. |
||
| 441 | * |
||
| 442 | * @return array |
||
| 443 | */ |
||
| 444 | 38 | public function getAdditionalFilters() |
|
| 445 | { |
||
| 446 | // when we've build the additionalFilter once, we could return them |
||
| 447 | 38 | if (count($this->additionalFilters) > 0) { |
|
| 448 | 2 | return $this->additionalFilters; |
|
| 449 | } |
||
| 450 | |||
| 451 | 38 | $searchQueryFilters = $this->typoScriptConfiguration->getSearchQueryFilterConfiguration(); |
|
| 452 | 38 | if (count($searchQueryFilters) <= 0) { |
|
| 453 | 36 | return []; |
|
| 454 | } |
||
| 455 | |||
| 456 | 2 | $cObj = GeneralUtility::makeInstance(ContentObjectRenderer::class); |
|
| 457 | |||
| 458 | // all other regular filters |
||
| 459 | 2 | foreach ($searchQueryFilters as $filterKey => $filter) { |
|
| 460 | // the __pageSections filter should not be handled as additional filter |
||
| 461 | 2 | if ($filterKey === '__pageSections') { |
|
| 462 | continue; |
||
| 463 | } |
||
| 464 | |||
| 465 | 2 | $filterIsArray = is_array($searchQueryFilters[$filterKey]); |
|
| 466 | 2 | if ($filterIsArray) { |
|
| 467 | continue; |
||
| 468 | } |
||
| 469 | |||
| 470 | 2 | $hasSubConfiguration = is_array($searchQueryFilters[$filterKey . '.']); |
|
| 471 | 2 | if ($hasSubConfiguration) { |
|
| 472 | $filter = $cObj->stdWrap($searchQueryFilters[$filterKey], $searchQueryFilters[$filterKey . '.']); |
||
| 473 | } |
||
| 474 | |||
| 475 | 2 | $this->additionalFilters[$filterKey] = $filter; |
|
| 476 | } |
||
| 477 | |||
| 478 | 2 | return $this->additionalFilters; |
|
| 479 | } |
||
| 480 | |||
| 481 | /** |
||
| 482 | * Performs a search and returns a SearchResultSet. |
||
| 483 | * |
||
| 484 | * @param SearchRequest $searchRequest |
||
| 485 | * @return SearchResultSet |
||
| 486 | */ |
||
| 487 | 35 | public function search(SearchRequest $searchRequest) |
|
| 488 | { |
||
| 489 | /** @var $resultSet SearchResultSet */ |
||
| 490 | 35 | $resultSetClass = $this->getResultSetClassName(); |
|
| 491 | 35 | $resultSet = GeneralUtility::makeInstance($resultSetClass); |
|
| 492 | 35 | $resultSet->setUsedSearchRequest($searchRequest); |
|
| 493 | 35 | $this->lastResultSet = $resultSet; |
|
| 494 | |||
| 495 | 35 | $resultSet = $this->handleSearchHook('beforeSearch', $resultSet); |
|
| 496 | |||
| 497 | 35 | if ($searchRequest->getRawUserQueryIsNull() && !$this->getInitialSearchIsConfigured()) { |
|
| 498 | // when no rawQuery was passed or no initialSearch is configured, we pass an empty result set |
||
| 499 | 2 | return $resultSet; |
|
| 500 | } |
||
| 501 | |||
| 502 | 33 | if ($searchRequest->getRawUserQueryIsEmptyString() && !$this->typoScriptConfiguration->getSearchQueryAllowEmptyQuery()) { |
|
| 503 | // the user entered an empty query string "" or " " and empty querystring is not allowed |
||
| 504 | return $resultSet; |
||
| 505 | } |
||
| 506 | |||
| 507 | 33 | $rawQuery = $searchRequest->getRawUserQuery(); |
|
| 508 | 33 | $resultsPerPage = $this->getNumberOfResultsPerPage($rawQuery, $searchRequest->getResultsPerPage()); |
|
| 509 | 33 | $query = $this->getPreparedQuery($rawQuery, $resultsPerPage); |
|
| 510 | |||
| 511 | 33 | $resultSet->setUsedQuery($query); |
|
| 512 | |||
| 513 | 33 | $currentPage = max(0, $searchRequest->getPage()); |
|
| 514 | // if the number of results per page has been changed by the current request, reset the pagebrowser |
||
| 515 | 33 | if ($this->resultsPerPageChanged) { |
|
| 516 | 4 | $currentPage = 0; |
|
| 517 | } |
||
| 518 | |||
| 519 | 33 | $offSet = $currentPage * $resultsPerPage; |
|
| 520 | // performing the actual search, sending the query to the Solr server |
||
| 521 | 33 | $response = $this->search->search($query, $offSet, null); |
|
| 522 | |||
| 523 | 33 | $this->processResponse($rawQuery, $query, $response); |
|
| 524 | 33 | $this->addSearchResultsToResultSet($response, $resultSet); |
|
| 525 | |||
| 526 | 33 | $resultSet->setResponse($response); |
|
| 527 | 33 | $resultSet->setUsedPage($currentPage); |
|
| 528 | 33 | $resultSet->setUsedResultsPerPage($resultsPerPage); |
|
| 529 | 33 | $resultSet->setUsedAdditionalFilters($this->getAdditionalFilters()); |
|
| 530 | 33 | $resultSet->setUsedSearch($this->search); |
|
| 531 | |||
| 532 | /** @var $searchResultReconstitutionProcessor ResultSetReconstitutionProcessor */ |
||
| 533 | 33 | $searchResultReconstitutionProcessor = GeneralUtility::makeInstance(ResultSetReconstitutionProcessor::class); |
|
| 534 | 33 | $searchResultReconstitutionProcessor->process($resultSet); |
|
| 535 | |||
| 536 | 33 | return $this->handleSearchHook('afterSearch', $resultSet); |
|
| 537 | } |
||
| 538 | |||
| 539 | /** |
||
| 540 | * Retrieves a single document from solr by document id. |
||
| 541 | * |
||
| 542 | * @param string $documentId |
||
| 543 | * @return SearchResult |
||
| 544 | */ |
||
| 545 | 2 | public function getDocumentById($documentId) |
|
| 546 | { |
||
| 547 | /* @var $query Query */ |
||
| 548 | 2 | $query = GeneralUtility::makeInstance(Query::class, $documentId); |
|
| 549 | 2 | $query->setQueryFieldsFromString('id'); |
|
| 550 | |||
| 551 | 2 | $response = $this->search->search($query, 0, 1); |
|
| 552 | 2 | $this->processResponse($documentId, $query, $response); |
|
| 553 | |||
| 554 | 2 | $resultDocument = isset($response->response->docs[0]) ? $response->response->docs[0] : null; |
|
| 555 | 2 | return $resultDocument; |
|
| 556 | } |
||
| 557 | |||
| 558 | /** |
||
| 559 | * This method is used to call the registered hooks during the search execution. |
||
| 560 | * |
||
| 561 | * @param string $eventName |
||
| 562 | * @param SearchResultSet $resultSet |
||
| 563 | * @return SearchResultSet |
||
| 564 | */ |
||
| 565 | 35 | private function handleSearchHook($eventName, SearchResultSet $resultSet) |
|
| 566 | { |
||
| 567 | 35 | if (!is_array($GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['solr'][$eventName])) { |
|
| 568 | 35 | return $resultSet; |
|
| 569 | } |
||
| 570 | |||
| 571 | foreach ($GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['solr'][$eventName] as $classReference) { |
||
| 572 | $afterSearchProcessor = GeneralUtility::getUserObj($classReference); |
||
| 573 | if ($afterSearchProcessor instanceof SearchResultSetProcessor) { |
||
| 574 | $afterSearchProcessor->process($resultSet); |
||
| 575 | } |
||
| 576 | } |
||
| 577 | |||
| 578 | return $resultSet; |
||
| 579 | } |
||
| 580 | |||
| 581 | /** |
||
| 582 | * @return SearchResultSet |
||
| 583 | */ |
||
| 584 | 24 | public function getLastResultSet() |
|
| 585 | { |
||
| 586 | 24 | return $this->lastResultSet; |
|
| 587 | } |
||
| 588 | |||
| 589 | /** |
||
| 590 | * This method returns true when the last search was executed with an empty query |
||
| 591 | * string or whitespaces only. When no search was triggered it will return false. |
||
| 592 | * |
||
| 593 | * @return bool |
||
| 594 | */ |
||
| 595 | public function getLastSearchWasExecutedWithEmptyQueryString() |
||
| 596 | { |
||
| 597 | $wasEmptyQueryString = false; |
||
| 598 | if ($this->lastResultSet != null) { |
||
| 599 | $wasEmptyQueryString = $this->lastResultSet->getUsedSearchRequest()->getRawUserQueryIsEmptyString(); |
||
| 600 | } |
||
| 601 | |||
| 602 | return $wasEmptyQueryString; |
||
| 603 | } |
||
| 604 | |||
| 605 | /** |
||
| 606 | * @param int $requestedPerPage |
||
| 607 | */ |
||
| 608 | 3 | protected function setPerPageInSession($requestedPerPage) |
|
| 609 | { |
||
| 610 | 3 | $GLOBALS['TSFE']->fe_user->setKey('ses', 'tx_solr_resultsPerPage', intval($requestedPerPage)); |
|
| 611 | 3 | } |
|
| 612 | |||
| 613 | /** |
||
| 614 | * @return mixed |
||
| 615 | */ |
||
| 616 | 26 | protected function getPerPageFromSession() |
|
| 617 | { |
||
| 618 | 26 | return $GLOBALS['TSFE']->fe_user->getKey('ses', 'tx_solr_resultsPerPage'); |
|
| 619 | } |
||
| 620 | |||
| 621 | /** |
||
| 622 | * @return bool |
||
| 623 | */ |
||
| 624 | 2 | protected function getInitialSearchIsConfigured() |
|
| 628 | |||
| 629 | /** |
||
| 630 | * @return mixed |
||
| 631 | */ |
||
| 632 | 26 | protected function getRegisteredSearchComponents() |
|
| 636 | |||
| 637 | /** |
||
| 638 | * This method is used to reference the SearchResult object from the response in the SearchResultSet object. |
||
| 639 | * |
||
| 640 | * @param \Apache_Solr_Response $response |
||
| 641 | * @param SearchResultSet $resultSet |
||
| 642 | */ |
||
| 643 | 33 | protected function addSearchResultsToResultSet($response, $resultSet) |
|
| 644 | { |
||
| 645 | 33 | if (!is_array($response->response->docs)) { |
|
| 646 | 5 | return; |
|
| 647 | } |
||
| 648 | |||
| 649 | 28 | foreach ($response->response->docs as $searchResult) { |
|
| 650 | 25 | $resultSet->addSearchResult($searchResult); |
|
| 653 | } |
||
| 654 |
Loading history...
An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name.
If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading.