wikimedia /
mediawiki
Complex classes like SearchEngine 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 SearchEngine, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 34 | abstract class SearchEngine { |
||
| 35 | /** @var string */ |
||
| 36 | public $prefix = ''; |
||
| 37 | |||
| 38 | /** @var int[]|null */ |
||
| 39 | public $namespaces = [ NS_MAIN ]; |
||
| 40 | |||
| 41 | /** @var int */ |
||
| 42 | protected $limit = 10; |
||
| 43 | |||
| 44 | /** @var int */ |
||
| 45 | protected $offset = 0; |
||
| 46 | |||
| 47 | /** @var array|string */ |
||
| 48 | protected $searchTerms = []; |
||
| 49 | |||
| 50 | /** @var bool */ |
||
| 51 | protected $showSuggestion = true; |
||
| 52 | private $sort = 'relevance'; |
||
| 53 | |||
| 54 | /** @var array Feature values */ |
||
| 55 | protected $features = []; |
||
| 56 | |||
| 57 | /** @const string profile type for completionSearch */ |
||
| 58 | const COMPLETION_PROFILE_TYPE = 'completionSearchProfile'; |
||
| 59 | |||
| 60 | /** @const string profile type for query independent ranking features */ |
||
| 61 | const FT_QUERY_INDEP_PROFILE_TYPE = 'fulltextQueryIndepProfile'; |
||
| 62 | |||
| 63 | /** |
||
| 64 | * Perform a full text search query and return a result set. |
||
| 65 | * If full text searches are not supported or disabled, return null. |
||
| 66 | * STUB |
||
| 67 | * |
||
| 68 | * @param string $term Raw search term |
||
| 69 | * @return SearchResultSet|Status|null |
||
| 70 | */ |
||
| 71 | function searchText( $term ) { |
||
| 74 | |||
| 75 | /** |
||
| 76 | * Perform a title-only search query and return a result set. |
||
| 77 | * If title searches are not supported or disabled, return null. |
||
| 78 | * STUB |
||
| 79 | * |
||
| 80 | * @param string $term Raw search term |
||
| 81 | * @return SearchResultSet|null |
||
| 82 | */ |
||
| 83 | function searchTitle( $term ) { |
||
| 86 | |||
| 87 | /** |
||
| 88 | * @since 1.18 |
||
| 89 | * @param string $feature |
||
| 90 | * @return bool |
||
| 91 | */ |
||
| 92 | public function supports( $feature ) { |
||
| 101 | |||
| 102 | /** |
||
| 103 | * Way to pass custom data for engines |
||
| 104 | * @since 1.18 |
||
| 105 | * @param string $feature |
||
| 106 | * @param mixed $data |
||
| 107 | * @return bool |
||
| 108 | */ |
||
| 109 | public function setFeatureData( $feature, $data ) { |
||
| 112 | |||
| 113 | /** |
||
| 114 | * When overridden in derived class, performs database-specific conversions |
||
| 115 | * on text to be used for searching or updating search index. |
||
| 116 | * Default implementation does nothing (simply returns $string). |
||
| 117 | * |
||
| 118 | * @param string $string String to process |
||
| 119 | * @return string |
||
| 120 | */ |
||
| 121 | public function normalizeText( $string ) { |
||
| 127 | |||
| 128 | /** |
||
| 129 | * Transform search term in cases when parts of the query came as different |
||
| 130 | * GET params (when supported), e.g. for prefix queries: |
||
| 131 | * search=test&prefix=Main_Page/Archive -> test prefix:Main Page/Archive |
||
| 132 | * @param string $term |
||
| 133 | * @return string |
||
| 134 | */ |
||
| 135 | public function transformSearchTerm( $term ) { |
||
| 138 | |||
| 139 | /** |
||
| 140 | * Get service class to finding near matches. |
||
| 141 | * @param Config $config Configuration to use for the matcher. |
||
| 142 | * @return SearchNearMatcher |
||
| 143 | */ |
||
| 144 | public function getNearMatcher( Config $config ) { |
||
| 148 | |||
| 149 | /** |
||
| 150 | * Get near matcher for default SearchEngine. |
||
| 151 | * @return SearchNearMatcher |
||
| 152 | */ |
||
| 153 | protected static function defaultNearMatcher() { |
||
| 157 | |||
| 158 | /** |
||
| 159 | * If an exact title match can be found, or a very slightly close match, |
||
| 160 | * return the title. If no match, returns NULL. |
||
| 161 | * @deprecated since 1.27; Use SearchEngine::getNearMatcher() |
||
| 162 | * @param string $searchterm |
||
| 163 | * @return Title |
||
| 164 | */ |
||
| 165 | public static function getNearMatch( $searchterm ) { |
||
| 168 | |||
| 169 | /** |
||
| 170 | * Do a near match (see SearchEngine::getNearMatch) and wrap it into a |
||
| 171 | * SearchResultSet. |
||
| 172 | * @deprecated since 1.27; Use SearchEngine::getNearMatcher() |
||
| 173 | * @param string $searchterm |
||
| 174 | * @return SearchResultSet |
||
| 175 | */ |
||
| 176 | public static function getNearMatchResultSet( $searchterm ) { |
||
| 179 | |||
| 180 | /** |
||
| 181 | * Get chars legal for search. |
||
| 182 | * NOTE: usage as static is deprecated and preserved only as BC measure |
||
| 183 | * @return string |
||
| 184 | */ |
||
| 185 | public static function legalSearchChars() { |
||
| 188 | |||
| 189 | /** |
||
| 190 | * Set the maximum number of results to return |
||
| 191 | * and how many to skip before returning the first. |
||
| 192 | * |
||
| 193 | * @param int $limit |
||
| 194 | * @param int $offset |
||
| 195 | */ |
||
| 196 | function setLimitOffset( $limit, $offset = 0 ) { |
||
| 200 | |||
| 201 | /** |
||
| 202 | * Set which namespaces the search should include. |
||
| 203 | * Give an array of namespace index numbers. |
||
| 204 | * |
||
| 205 | * @param int[]|null $namespaces |
||
| 206 | */ |
||
| 207 | function setNamespaces( $namespaces ) { |
||
| 219 | |||
| 220 | /** |
||
| 221 | * Set whether the searcher should try to build a suggestion. Note: some searchers |
||
| 222 | * don't support building a suggestion in the first place and others don't respect |
||
| 223 | * this flag. |
||
| 224 | * |
||
| 225 | * @param bool $showSuggestion Should the searcher try to build suggestions |
||
| 226 | */ |
||
| 227 | function setShowSuggestion( $showSuggestion ) { |
||
| 230 | |||
| 231 | /** |
||
| 232 | * Get the valid sort directions. All search engines support 'relevance' but others |
||
| 233 | * might support more. The default in all implementations should be 'relevance.' |
||
| 234 | * |
||
| 235 | * @since 1.25 |
||
| 236 | * @return array(string) the valid sort directions for setSort |
||
|
|
|||
| 237 | */ |
||
| 238 | public function getValidSorts() { |
||
| 241 | |||
| 242 | /** |
||
| 243 | * Set the sort direction of the search results. Must be one returned by |
||
| 244 | * SearchEngine::getValidSorts() |
||
| 245 | * |
||
| 246 | * @since 1.25 |
||
| 247 | * @throws InvalidArgumentException |
||
| 248 | * @param string $sort sort direction for query result |
||
| 249 | */ |
||
| 250 | public function setSort( $sort ) { |
||
| 257 | |||
| 258 | /** |
||
| 259 | * Get the sort direction of the search results |
||
| 260 | * |
||
| 261 | * @since 1.25 |
||
| 262 | * @return string |
||
| 263 | */ |
||
| 264 | public function getSort() { |
||
| 267 | |||
| 268 | /** |
||
| 269 | * Parse some common prefixes: all (search everything) |
||
| 270 | * or namespace names and set the list of namespaces |
||
| 271 | * of this class accordingly. |
||
| 272 | * |
||
| 273 | * @param string $query |
||
| 274 | * @return string |
||
| 275 | */ |
||
| 276 | function replacePrefixes( $query ) { |
||
| 284 | |||
| 285 | /** |
||
| 286 | * Parse some common prefixes: all (search everything) |
||
| 287 | * or namespace names |
||
| 288 | * |
||
| 289 | * @param string $query |
||
| 290 | * @return false|array false if no namespace was extracted, an array |
||
| 291 | * with the parsed query at index 0 and an array of namespaces at index |
||
| 292 | * 1 (or null for all namespaces). |
||
| 293 | */ |
||
| 294 | public static function parseNamespacePrefixes( $query ) { |
||
| 325 | |||
| 326 | /** |
||
| 327 | * Find snippet highlight settings for all users |
||
| 328 | * @return array Contextlines, contextchars |
||
| 329 | */ |
||
| 330 | public static function userHighlightPrefs() { |
||
| 335 | |||
| 336 | /** |
||
| 337 | * Create or update the search index record for the given page. |
||
| 338 | * Title and text should be pre-processed. |
||
| 339 | * STUB |
||
| 340 | * |
||
| 341 | * @param int $id |
||
| 342 | * @param string $title |
||
| 343 | * @param string $text |
||
| 344 | */ |
||
| 345 | function update( $id, $title, $text ) { |
||
| 348 | |||
| 349 | /** |
||
| 350 | * Update a search index record's title only. |
||
| 351 | * Title should be pre-processed. |
||
| 352 | * STUB |
||
| 353 | * |
||
| 354 | * @param int $id |
||
| 355 | * @param string $title |
||
| 356 | */ |
||
| 357 | function updateTitle( $id, $title ) { |
||
| 360 | |||
| 361 | /** |
||
| 362 | * Delete an indexed page |
||
| 363 | * Title should be pre-processed. |
||
| 364 | * STUB |
||
| 365 | * |
||
| 366 | * @param int $id Page id that was deleted |
||
| 367 | * @param string $title Title of page that was deleted |
||
| 368 | */ |
||
| 369 | function delete( $id, $title ) { |
||
| 372 | |||
| 373 | /** |
||
| 374 | * Get OpenSearch suggestion template |
||
| 375 | * |
||
| 376 | * @deprecated since 1.25 |
||
| 377 | * @return string |
||
| 378 | */ |
||
| 379 | public static function getOpenSearchTemplate() { |
||
| 383 | |||
| 384 | /** |
||
| 385 | * Get the raw text for updating the index from a content object |
||
| 386 | * Nicer search backends could possibly do something cooler than |
||
| 387 | * just returning raw text |
||
| 388 | * |
||
| 389 | * @todo This isn't ideal, we'd really like to have content-specific handling here |
||
| 390 | * @param Title $t Title we're indexing |
||
| 391 | * @param Content $c Content of the page to index |
||
| 392 | * @return string |
||
| 393 | */ |
||
| 394 | public function getTextFromContent( Title $t, Content $c = null ) { |
||
| 397 | |||
| 398 | /** |
||
| 399 | * If an implementation of SearchEngine handles all of its own text processing |
||
| 400 | * in getTextFromContent() and doesn't require SearchUpdate::updateText()'s |
||
| 401 | * rather silly handling, it should return true here instead. |
||
| 402 | * |
||
| 403 | * @return bool |
||
| 404 | */ |
||
| 405 | public function textAlreadyUpdatedForIndex() { |
||
| 408 | |||
| 409 | /** |
||
| 410 | * Makes search simple string if it was namespaced. |
||
| 411 | * Sets namespaces of the search to namespaces extracted from string. |
||
| 412 | * @param string $search |
||
| 413 | * @return string Simplified search string |
||
| 414 | */ |
||
| 415 | protected function normalizeNamespaces( $search ) { |
||
| 446 | |||
| 447 | /** |
||
| 448 | * Perform a completion search. |
||
| 449 | * Does not resolve namespaces and does not check variants. |
||
| 450 | * Search engine implementations may want to override this function. |
||
| 451 | * @param string $search |
||
| 452 | * @return SearchSuggestionSet |
||
| 453 | */ |
||
| 454 | protected function completionSearchBackend( $search ) { |
||
| 473 | |||
| 474 | /** |
||
| 475 | * Perform a completion search. |
||
| 476 | * @param string $search |
||
| 477 | * @return SearchSuggestionSet |
||
| 478 | */ |
||
| 479 | public function completionSearch( $search ) { |
||
| 486 | |||
| 487 | /** |
||
| 488 | * Perform a completion search with variants. |
||
| 489 | * @param string $search |
||
| 490 | * @return SearchSuggestionSet |
||
| 491 | */ |
||
| 492 | public function completionSearchWithVariants( $search ) { |
||
| 518 | |||
| 519 | /** |
||
| 520 | * Extract titles from completion results |
||
| 521 | * @param SearchSuggestionSet $completionResults |
||
| 522 | * @return Title[] |
||
| 523 | */ |
||
| 524 | public function extractTitles( SearchSuggestionSet $completionResults ) { |
||
| 529 | |||
| 530 | /** |
||
| 531 | * Process completion search results. |
||
| 532 | * Resolves the titles and rescores. |
||
| 533 | * @param SearchSuggestionSet $suggestions |
||
| 534 | * @return SearchSuggestionSet |
||
| 535 | */ |
||
| 536 | protected function processCompletionResults( $search, SearchSuggestionSet $suggestions ) { |
||
| 576 | |||
| 577 | /** |
||
| 578 | * Simple prefix search for subpages. |
||
| 579 | * @param string $search |
||
| 580 | * @return Title[] |
||
| 581 | */ |
||
| 582 | public function defaultPrefixSearch( $search ) { |
||
| 590 | |||
| 591 | /** |
||
| 592 | * Call out to simple search backend. |
||
| 593 | * Defaults to TitlePrefixSearch. |
||
| 594 | * @param string $search |
||
| 595 | * @return Title[] |
||
| 596 | */ |
||
| 597 | protected function simplePrefixSearch( $search ) { |
||
| 602 | |||
| 603 | /** |
||
| 604 | * Make a list of searchable namespaces and their canonical names. |
||
| 605 | * @deprecated since 1.27; use SearchEngineConfig::searchableNamespaces() |
||
| 606 | * @return array |
||
| 607 | */ |
||
| 608 | public static function searchableNamespaces() { |
||
| 611 | |||
| 612 | /** |
||
| 613 | * Extract default namespaces to search from the given user's |
||
| 614 | * settings, returning a list of index numbers. |
||
| 615 | * @deprecated since 1.27; use SearchEngineConfig::userNamespaces() |
||
| 616 | * @param user $user |
||
| 617 | * @return array |
||
| 618 | */ |
||
| 619 | public static function userNamespaces( $user ) { |
||
| 622 | |||
| 623 | /** |
||
| 624 | * An array of namespaces indexes to be searched by default |
||
| 625 | * @deprecated since 1.27; use SearchEngineConfig::defaultNamespaces() |
||
| 626 | * @return array |
||
| 627 | */ |
||
| 628 | public static function defaultNamespaces() { |
||
| 631 | |||
| 632 | /** |
||
| 633 | * Get a list of namespace names useful for showing in tooltips |
||
| 634 | * and preferences |
||
| 635 | * @deprecated since 1.27; use SearchEngineConfig::namespacesAsText() |
||
| 636 | * @param array $namespaces |
||
| 637 | * @return array |
||
| 638 | */ |
||
| 639 | public static function namespacesAsText( $namespaces ) { |
||
| 642 | |||
| 643 | /** |
||
| 644 | * Load up the appropriate search engine class for the currently |
||
| 645 | * active database backend, and return a configured instance. |
||
| 646 | * @deprecated since 1.27; Use SearchEngineFactory::create |
||
| 647 | * @param string $type Type of search backend, if not the default |
||
| 648 | * @return SearchEngine |
||
| 649 | */ |
||
| 650 | public static function create( $type = null ) { |
||
| 653 | |||
| 654 | /** |
||
| 655 | * Return the search engines we support. If only $wgSearchType |
||
| 656 | * is set, it'll be an array of just that one item. |
||
| 657 | * @deprecated since 1.27; use SearchEngineConfig::getSearchTypes() |
||
| 658 | * @return array |
||
| 659 | */ |
||
| 660 | public static function getSearchTypes() { |
||
| 663 | |||
| 664 | /** |
||
| 665 | * Get a list of supported profiles. |
||
| 666 | * Some search engine implementations may expose specific profiles to fine-tune |
||
| 667 | * its behaviors. |
||
| 668 | * The profile can be passed as a feature data with setFeatureData( $profileType, $profileName ) |
||
| 669 | * The array returned by this function contains the following keys: |
||
| 670 | * - name: the profile name to use with setFeatureData |
||
| 671 | * - desc-message: the i18n description |
||
| 672 | * - default: set to true if this profile is the default |
||
| 673 | * |
||
| 674 | * @since 1.28 |
||
| 675 | * @param $profileType the type of profiles |
||
| 676 | * @return array|null the list of profiles or null if none available |
||
| 677 | */ |
||
| 678 | public function getProfiles( $profileType ) { |
||
| 681 | |||
| 682 | /** |
||
| 683 | * Create a search field definition. |
||
| 684 | * Specific search engines should override this method to create search fields. |
||
| 685 | * @param string $name |
||
| 686 | * @param int $type One of the types in SearchIndexField::INDEX_TYPE_* |
||
| 687 | * @return SearchIndexField |
||
| 688 | * @since 1.28 |
||
| 689 | */ |
||
| 690 | public function makeSearchFieldMapping( $name, $type ) { |
||
| 693 | |||
| 694 | /** |
||
| 695 | * Get fields for search index |
||
| 696 | * @since 1.28 |
||
| 697 | * @return SearchIndexField[] Index field definitions for all content handlers |
||
| 698 | */ |
||
| 699 | public function getSearchIndexFields() { |
||
| 722 | |||
| 723 | /** |
||
| 724 | * Augment search results with extra data. |
||
| 725 | * |
||
| 726 | * @param SearchResultSet $resultSet |
||
| 727 | */ |
||
| 728 | public function augmentSearchResults( SearchResultSet $resultSet ) { |
||
| 753 | } |
||
| 754 | |||
| 764 |
Loading history...
This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types.