SearchResult: clean up construction
[mediawiki.git] / includes / search / SearchResult.php
blobaeaba8df324c3af6372ca0b9391a0f26f856d19f
1 <?php
2 /**
3 * Search engine result
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.
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.
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
20 * @file
21 * @ingroup Search
24 /**
25 * @todo FIXME: This class is horribly factored. It would probably be better to
26 * have a useful base class to which you pass some standard information, then
27 * let the fancy self-highlighters extend that.
28 * @ingroup Search
30 class SearchResult {
32 /**
33 * @var Revision
35 protected $mRevision = null;
37 /**
38 * @var File
40 protected $mImage = null;
42 /**
43 * @var Title
45 protected $mTitle;
47 /**
48 * @var string
50 protected $mText;
52 /**
53 * Return a new SearchResult and initializes it with a title.
55 * @param Title $title
56 * @return SearchResult
58 public static function newFromTitle( $title ) {
59 $result = new self();
60 $result->initFromTitle( $title );
61 return $result;
64 /**
65 * Initialize from a Title and if possible initializes a corresponding
66 * Revision and File.
68 * @param Title $title
70 protected function initFromTitle( $title ) {
71 $this->mTitle = $title;
72 if ( !is_null( $this->mTitle ) ) {
73 $id = false;
74 wfRunHooks( 'SearchResultInitFromTitle', array( $title, &$id ) );
75 $this->mRevision = Revision::newFromTitle(
76 $this->mTitle, $id, Revision::READ_NORMAL );
77 if ( $this->mTitle->getNamespace() === NS_FILE ) {
78 $this->mImage = wfFindFile( $this->mTitle );
83 /**
84 * Check if this is result points to an invalid title
86 * @return bool
88 function isBrokenTitle() {
89 return is_null( $this->mTitle );
92 /**
93 * Check if target page is missing, happens when index is out of date
95 * @return bool
97 function isMissingRevision() {
98 return !$this->mRevision && !$this->mImage;
102 * @return Title
104 function getTitle() {
105 return $this->mTitle;
109 * Get the file for this page, if one exists
110 * @return File|null
112 function getFile() {
113 return $this->mImage;
117 * Lazy initialization of article text from DB
119 protected function initText() {
120 if ( !isset( $this->mText ) ) {
121 if ( $this->mRevision != null ) {
122 $this->mText = SearchEngine::create()
123 ->getTextFromContent( $this->mTitle, $this->mRevision->getContent() );
124 } else { // TODO: can we fetch raw wikitext for commons images?
125 $this->mText = '';
131 * @param array $terms Terms to highlight
132 * @return string Highlighted text snippet, null (and not '') if not supported
134 function getTextSnippet( $terms ) {
135 global $wgAdvancedSearchHighlighting;
136 $this->initText();
138 // TODO: make highliter take a content object. Make ContentHandler a factory for SearchHighliter.
139 list( $contextlines, $contextchars ) = SearchEngine::userHighlightPrefs();
141 $h = new SearchHighlighter();
142 if ( count( $terms ) > 0 ) {
143 if ( $wgAdvancedSearchHighlighting ) {
144 return $h->highlightText( $this->mText, $terms, $contextlines, $contextchars );
145 } else {
146 return $h->highlightSimple( $this->mText, $terms, $contextlines, $contextchars );
148 } else {
149 return $h->highlightNone( $this->mText, $contextlines, $contextchars );
154 * @return string Highlighted title, '' if not supported
156 function getTitleSnippet() {
157 return '';
161 * @return string Highlighted redirect name (redirect to this page), '' if none or not supported
163 function getRedirectSnippet() {
164 return '';
168 * @return Title Title object for the redirect to this page, null if none or not supported
170 function getRedirectTitle() {
171 return null;
175 * @return string Highlighted relevant section name, null if none or not supported
177 function getSectionSnippet() {
178 return '';
182 * @return Title Title object (pagename+fragment) for the section, null if none or not supported
184 function getSectionTitle() {
185 return null;
189 * @return string Timestamp
191 function getTimestamp() {
192 if ( $this->mRevision ) {
193 return $this->mRevision->getTimestamp();
194 } elseif ( $this->mImage ) {
195 return $this->mImage->getTimestamp();
197 return '';
201 * @return int Number of words
203 function getWordCount() {
204 $this->initText();
205 return str_word_count( $this->mText );
209 * @return int Size in bytes
211 function getByteSize() {
212 $this->initText();
213 return strlen( $this->mText );
217 * @return string Interwiki prefix of the title (return iw even if title is broken)
219 function getInterwikiPrefix() {
220 return '';
224 * @return string Interwiki namespace of the title (since we likely can't resolve it locally)
226 function getInterwikiNamespaceText() {
227 return '';
231 * Did this match file contents (eg: PDF/DJVU)?
232 * @return bool
234 function isFileMatch() {
235 return false;