SearchResult::getExtensionData() - Code Metrics - wikimedia/mediawiki - Measure and Improve Code Quality continuously with Scrutinizer

SearchResult::getExtensionData() A
last analyzed 2016-11-13 17:42 UTC

↳ Parent: SearchResult

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	2
nc	1
nop	0
dl	0
loc	3
rs	10
c	0
b	0
f	0

<?php
/**
 * Search engine result
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 * http://www.gnu.org/copyleft/gpl.html
 *
 * @file
 * @ingroup Search
 */

use MediaWiki\MediaWikiServices;

/**
 * @todo FIXME: This class is horribly factored. It would probably be better to
 * have a useful base class to which you pass some standard information, then
 * let the fancy self-highlighters extend that.
 * @ingroup Search
 */
class SearchResult {

	/**
	 * @var Revision
	 */
	protected $mRevision = null;

	/**
	 * @var File
	 */
	protected $mImage = null;

	/**
	 * @var Title
	 */
	protected $mTitle;

	/**
	 * @var string
	 */
	protected $mText;

	/**
	 * @var SearchEngine
	 */
	protected $searchEngine;

	/**
	 * A set of extension data.
	 * @var array[]
	 */
	protected $extensionData;

	/**
	 * Return a new SearchResult and initializes it with a title.
	 *
	 * @param Title           $title
	 * @param SearchResultSet $parentSet
	 * @return SearchResult
	 */
	public static function newFromTitle( $title, SearchResultSet $parentSet = null ) {
		$result = new static();
		$result->initFromTitle( $title );
		if ( $parentSet ) {
			$parentSet->augmentResult( $result );
		}
		return $result;
	}

	/**
	 * Initialize from a Title and if possible initializes a corresponding
	 * Revision and File.
	 *
	 * @param Title $title
	 */
	protected function initFromTitle( $title ) {
		$this->mTitle = $title;
		if ( !is_null( $this->mTitle ) ) {
			$id = false;
			Hooks::run( 'SearchResultInitFromTitle', [ $title, &$id ] );
			$this->mRevision = Revision::newFromTitle(
				$this->mTitle, $id, Revision::READ_NORMAL );
			if ( $this->mTitle->getNamespace() === NS_FILE ) {
				$this->mImage = wfFindFile( $this->mTitle );
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
			}
		}
		$this->searchEngine = MediaWikiServices::getInstance()->newSearchEngine();
	}

	/**
	 * Check if this is result points to an invalid title
	 *
	 * @return bool
	 */
	function isBrokenTitle() {
		return is_null( $this->mTitle );
	}

	/**
	 * Check if target page is missing, happens when index is out of date
	 *
	 * @return bool
	 */
	function isMissingRevision() {
		return !$this->mRevision && !$this->mImage;
	}

	/**
	 * @return Title
	 */
	function getTitle() {
		return $this->mTitle;
	}

	/**
	 * Get the file for this page, if one exists
	 * @return File|null
	 */
	function getFile() {
		return $this->mImage;
	}

	/**
	 * Lazy initialization of article text from DB
	 */
	protected function initText() {
		if ( !isset( $this->mText ) ) {
			if ( $this->mRevision != null ) {
				$this->mText = $this->searchEngine->getTextFromContent(
						$this->mTitle, $this->mRevision->getContent() );
			} else { // TODO: can we fetch raw wikitext for commons images?
				$this->mText = '';
			}
		}
	}

	/**
	 * @param array $terms Terms to highlight
	 * @return string Highlighted text snippet, null (and not '') if not supported
	 */
	function getTextSnippet( $terms ) {
		global $wgAdvancedSearchHighlighting;
		$this->initText();

		// TODO: make highliter take a content object. Make ContentHandler a factory for SearchHighliter.
		list( $contextlines, $contextchars ) = $this->searchEngine->userHighlightPrefs();

		$h = new SearchHighlighter();
		if ( count( $terms ) > 0 ) {
			if ( $wgAdvancedSearchHighlighting ) {
				return $h->highlightText( $this->mText, $terms, $contextlines, $contextchars );
			} else {
				return $h->highlightSimple( $this->mText, $terms, $contextlines, $contextchars );
			}
		} else {
			return $h->highlightNone( $this->mText, $contextlines, $contextchars );
		}
	}

	/**
	 * @return string Highlighted title, '' if not supported
	 */
	function getTitleSnippet() {
		return '';
	}

	/**
	 * @return string Highlighted redirect name (redirect to this page), '' if none or not supported
	 */
	function getRedirectSnippet() {
		return '';
	}

	/**
	 * @return Title|null Title object for the redirect to this page, null if none or not supported
	 */
	function getRedirectTitle() {
		return null;
	}

	/**
	 * @return string Highlighted relevant section name, null if none or not supported
	 */
	function getSectionSnippet() {
		return '';
	}

	/**
	 * @return Title|null Title object (pagename+fragment) for the section,
	 *  null if none or not supported
	 */
	function getSectionTitle() {
		return null;
	}

	/**
	 * @return string Highlighted relevant category name or '' if none or not supported
	 */
	public function getCategorySnippet() {
		return '';
	}

	/**
	 * @return string Timestamp
	 */
	function getTimestamp() {
		if ( $this->mRevision ) {
			return $this->mRevision->getTimestamp();
		} elseif ( $this->mImage ) {
			return $this->mImage->getTimestamp();
		}
		return '';
	}

	/**
	 * @return int Number of words
	 */
	function getWordCount() {
		$this->initText();
		return str_word_count( $this->mText );
	}

	/**
	 * @return int Size in bytes
	 */
	function getByteSize() {
		$this->initText();
		return strlen( $this->mText );
	}

	/**
	 * @return string Interwiki prefix of the title (return iw even if title is broken)
	 */
	function getInterwikiPrefix() {
		return '';
	}

	/**
	 * @return string Interwiki namespace of the title (since we likely can't resolve it locally)
	 */
	function getInterwikiNamespaceText() {
		return '';
	}

	/**
	 * Did this match file contents (eg: PDF/DJVU)?
	 * @return bool
	 */
	function isFileMatch() {
		return false;
	}

	/**
	 * Get the extension data as:
	 * augmentor name => data
	 * @return array[]
	 */
	public function getExtensionData() {
		return $this->extensionData;
	}

	/**
	 * Set extension data for this result.
	 * The data is:
	 * augmentor name => data
	 * @param array[] $extensionData
	 */
	public function setExtensionData( array $extensionData ) {
		$this->extensionData = $extensionData;
	}

}


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			use MediaWiki\MediaWikiServices;
25
26			/**
27			* @todo FIXME: This class is horribly factored. It would probably be better to
28			* have a useful base class to which you pass some standard information, then
29			* let the fancy self-highlighters extend that.
30			* @ingroup Search
31			*/
32			class SearchResult {
33
34			/**
35			* @var Revision
36			*/
37			protected $mRevision = null;
38
39			/**
40			* @var File
41			*/
42			protected $mImage = null;
43
44			/**
45			* @var Title
46			*/
47			protected $mTitle;
48
49			/**
50			* @var string
51			*/
52			protected $mText;
53
54			/**
55			* @var SearchEngine
56			*/
57			protected $searchEngine;
58
59			/**
60			* A set of extension data.
61			* @var array[]
62			*/
63			protected $extensionData;
64
65			/**
66			* Return a new SearchResult and initializes it with a title.
67			*
68			* @param Title $title
69			* @param SearchResultSet $parentSet
70			* @return SearchResult
71			*/
72			public static function newFromTitle( $title, SearchResultSet $parentSet = null ) {
73			$result = new static();
74			$result->initFromTitle( $title );
75			if ( $parentSet ) {
76			$parentSet->augmentResult( $result );
77			}
78			return $result;
79			}
80
81			/**
82			* Initialize from a Title and if possible initializes a corresponding
83			* Revision and File.
84			*
85			* @param Title $title
86			*/
87			protected function initFromTitle( $title ) {
88			$this->mTitle = $title;
89			if ( !is_null( $this->mTitle ) ) {
90			$id = false;
91			Hooks::run( 'SearchResultInitFromTitle', [ $title, &$id ] );
92			$this->mRevision = Revision::newFromTitle(
93			$this->mTitle, $id, Revision::READ_NORMAL );
94			if ( $this->mTitle->getNamespace() === NS_FILE ) {
95			$this->mImage = wfFindFile( $this->mTitle );
			0 ignored issues – show Documentation Bug introduced 2016-01-16 18:00 UTC by Report Bug Copy Issue Report It seems like `wfFindFile($this->mTitle)` can also be of type `boolean`. However, the property `$mImage` is declared as type `object<File>`. Maybe add an additional type check? 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 `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. 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. class Id { public $id; public function __construct($id) { $this->id = $id; } } class Account { /** @var Id $id */ public $id; } $account_id = false; if (starsAreRight()) { $account_id = new Id(42); } $account = new Account(); if ($account instanceof Id) { $account->id = $account_id; } Loading history...
96			}
97			}
98			$this->searchEngine = MediaWikiServices::getInstance()->newSearchEngine();
99			}
100
101			/**
102			* Check if this is result points to an invalid title
103			*
104			* @return bool
105			*/
106			function isBrokenTitle() {
107			return is_null( $this->mTitle );
108			}
109
110			/**
111			* Check if target page is missing, happens when index is out of date
112			*
113			* @return bool
114			*/
115			function isMissingRevision() {
116			return !$this->mRevision && !$this->mImage;
117			}
118
119			/**
120			* @return Title
121			*/
122			function getTitle() {
123			return $this->mTitle;
124			}
125
126			/**
127			* Get the file for this page, if one exists
128			* @return File\|null
129			*/
130			function getFile() {
131			return $this->mImage;
132			}
133
134			/**
135			* Lazy initialization of article text from DB
136			*/
137			protected function initText() {
138			if ( !isset( $this->mText ) ) {
139			if ( $this->mRevision != null ) {
140			$this->mText = $this->searchEngine->getTextFromContent(
141			$this->mTitle, $this->mRevision->getContent() );
142			} else { // TODO: can we fetch raw wikitext for commons images?
143			$this->mText = '';
144			}
145			}
146			}
147
148			/**
149			* @param array $terms Terms to highlight
150			* @return string Highlighted text snippet, null (and not '') if not supported
151			*/
152			function getTextSnippet( $terms ) {
153			global $wgAdvancedSearchHighlighting;
154			$this->initText();
155
156			// TODO: make highliter take a content object. Make ContentHandler a factory for SearchHighliter.
157			list( $contextlines, $contextchars ) = $this->searchEngine->userHighlightPrefs();
158
159			$h = new SearchHighlighter();
160			if ( count( $terms ) > 0 ) {
161			if ( $wgAdvancedSearchHighlighting ) {
162			return $h->highlightText( $this->mText, $terms, $contextlines, $contextchars );
163			} else {
164			return $h->highlightSimple( $this->mText, $terms, $contextlines, $contextchars );
165			}
166			} else {
167			return $h->highlightNone( $this->mText, $contextlines, $contextchars );
168			}
169			}
170
171			/**
172			* @return string Highlighted title, '' if not supported
173			*/
174			function getTitleSnippet() {
175			return '';
176			}
177
178			/**
179			* @return string Highlighted redirect name (redirect to this page), '' if none or not supported
180			*/
181			function getRedirectSnippet() {
182			return '';
183			}
184
185			/**
186			* @return Title\|null Title object for the redirect to this page, null if none or not supported
187			*/
188			function getRedirectTitle() {
189			return null;
190			}
191
192			/**
193			* @return string Highlighted relevant section name, null if none or not supported
194			*/
195			function getSectionSnippet() {
196			return '';
197			}
198
199			/**
200			* @return Title\|null Title object (pagename+fragment) for the section,
201			* null if none or not supported
202			*/
203			function getSectionTitle() {
204			return null;
205			}
206
207			/**
208			* @return string Highlighted relevant category name or '' if none or not supported
209			*/
210			public function getCategorySnippet() {
211			return '';
212			}
213
214			/**
215			* @return string Timestamp
216			*/
217			function getTimestamp() {
218			if ( $this->mRevision ) {
219			return $this->mRevision->getTimestamp();
220			} elseif ( $this->mImage ) {
221			return $this->mImage->getTimestamp();
222			}
223			return '';
224			}
225
226			/**
227			* @return int Number of words
228			*/
229			function getWordCount() {
230			$this->initText();
231			return str_word_count( $this->mText );
232			}
233
234			/**
235			* @return int Size in bytes
236			*/
237			function getByteSize() {
238			$this->initText();
239			return strlen( $this->mText );
240			}
241
242			/**
243			* @return string Interwiki prefix of the title (return iw even if title is broken)
244			*/
245			function getInterwikiPrefix() {
246			return '';
247			}
248
249			/**
250			* @return string Interwiki namespace of the title (since we likely can't resolve it locally)
251			*/
252			function getInterwikiNamespaceText() {
253			return '';
254			}
255
256			/**
257			* Did this match file contents (eg: PDF/DJVU)?
258			* @return bool
259			*/
260			function isFileMatch() {
261			return false;
262			}
263
264			/**
265			* Get the extension data as:
266			* augmentor name => data
267			* @return array[]
268			*/
269			public function getExtensionData() {
270			return $this->extensionData;
271			}
272
273			/**
274			* Set extension data for this result.
275			* The data is:
276			* augmentor name => data
277			* @param array[] $extensionData
278			*/
279			public function setExtensionData( array $extensionData ) {
280			$this->extensionData = $extensionData;
281			}
282
283			}
284

wikimedia / mediawiki

SearchResult::getExtensionData() A last analyzed 2016-11-13 17:42 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

SearchResult::getExtensionData() A
last analyzed 2016-11-13 17:42 UTC