SearchResult.php 2.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263
  1. <?php
  2. /**
  3. * Search engine result
  4. *
  5. * This program is free software; you can redistribute it and/or modify
  6. * it under the terms of the GNU General Public License as published by
  7. * the Free Software Foundation; either version 2 of the License, or
  8. * (at your option) any later version.
  9. *
  10. * This program is distributed in the hope that it will be useful,
  11. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13. * GNU General Public License for more details.
  14. *
  15. * You should have received a copy of the GNU General Public License along
  16. * with this program; if not, write to the Free Software Foundation, Inc.,
  17. * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18. * http://www.gnu.org/copyleft/gpl.html
  19. *
  20. * @file
  21. * @ingroup Search
  22. */
  23. /**
  24. * NOTE: this class is being refactored into an abstract base class.
  25. * If you extend this class directly, please implement all the methods declared
  26. * in RevisionSearchResultTrait or extend RevisionSearchResult.
  27. *
  28. * Once the hard-deprecation period is over (1.36?):
  29. * - all methods declared in RevisionSearchResultTrait should be declared
  30. * as abstract in this class
  31. * - RevisionSearchResultTrait body should be moved to RevisionSearchResult and then removed without
  32. * deprecation
  33. * - caveat: all classes extending this one may potentially break if they did not properly implement
  34. * all the methods.
  35. * @ingroup Search
  36. */
  37. class SearchResult {
  38. use SearchResultTrait;
  39. use RevisionSearchResultTrait;
  40. public function __construct() {
  41. if ( self::class === static::class ) {
  42. wfDeprecated( __METHOD__, '1.34' );
  43. }
  44. }
  45. /**
  46. * Return a new SearchResult and initializes it with a title.
  47. *
  48. * @param Title $title
  49. * @param ISearchResultSet|null $parentSet
  50. * @return SearchResult
  51. */
  52. public static function newFromTitle( $title, ISearchResultSet $parentSet = null ) {
  53. $result = new RevisionSearchResult( $title );
  54. if ( $parentSet ) {
  55. $parentSet->augmentResult( $result );
  56. }
  57. return $result;
  58. }
  59. }