ShowSearchHitHandler::onShowSearchHit() - Code Metrics - wikimedia/mediawiki-extensions-Wikibase - Measure and Improve Code Quality continuously with Scrutinizer

ShowSearchHitHandler::onShowSearchHit() B
last analyzed 2020-11-13 17:34 UTC

↳ Parent: ShowSearchHitHandler

Complexity

Conditions	8
Paths	12

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	53
rs	7.781
c	0
b	0
f	0
cc	8
nc	12
nop	12

How to fix Long Method Many Parameters

<?php

namespace Wikibase\Repo\Hooks;

use Html;
use HtmlArmor;
use InvalidArgumentException;
use Language;
use MediaWiki\Search\Hook\ShowSearchHitHook;
use MediaWiki\Search\Hook\ShowSearchHitTitleHook;
use MWException;
use RequestContext;
use SearchResult;
use SpecialSearch;
use Title;
use Wikibase\DataModel\Entity\EntityDocument;
use Wikibase\DataModel\Entity\Item;
use Wikibase\DataModel\Services\Lookup\EntityLookup;
use Wikibase\DataModel\Statement\StatementListProvider;
use Wikibase\DataModel\Term\DescriptionsProvider;
use Wikibase\DataModel\Term\TermFallback;
use Wikibase\Lib\LanguageFallbackChainFactory;
use Wikibase\Lib\LanguageFallbackIndicator;
use Wikibase\Lib\LanguageNameLookup;
use Wikibase\Lib\Store\EntityIdLookup;
use Wikibase\Lib\Store\RevisionedUnresolvedRedirectException;
use Wikibase\Repo\Content\EntityContentFactory;
use Wikibase\Repo\Search\ExtendedResult;
use Wikibase\Repo\WikibaseRepo;

/**
 * Handler to format entities in the search results
 *
 * @license GPL-2.0-or-later
 * @author Matěj Suchánek
 * @author Daniel Kinzler
 */
class ShowSearchHitHandler implements ShowSearchHitHook, ShowSearchHitTitleHook {

	private $entityContentFactory;
	private $entityIdLookup;
	private $entityLookup;
	private $fallbackChainFactory;

	public function __construct(
		EntityContentFactory $entityContentFactory,
		EntityIdLookup $entityIdLookup,
		EntityLookup $entityLookup,
		LanguageFallbackChainFactory $fallbackChainFactory
	) {
		$this->entityContentFactory = $entityContentFactory;
		$this->entityIdLookup = $entityIdLookup;
		$this->entityLookup = $entityLookup;
		$this->fallbackChainFactory = $fallbackChainFactory;
	}

	public static function factory(): self {
		$wikibaseRepo = WikibaseRepo::getDefaultInstance();

		return new self(
			$wikibaseRepo->getEntityContentFactory(),
			$wikibaseRepo->getEntityIdLookup(),
			$wikibaseRepo->getEntityLookup(),
			$wikibaseRepo->getLanguageFallbackChainFactory()
		);
	}

	/**
	 * Format the output when the search result contains entities
	 * @see https://www.mediawiki.org/wiki/Manual:Hooks/ShowSearchHit
	 * @see showEntityResultHit
	 * @see showPlainSearchHit
	 * @param SpecialSearch $searchPage
	 * @param SearchResult $result
	 * @param string[] $terms
	 * @param string &$link
	 * @param string &$redirect
	 * @param string &$section
	 * @param string &$extract
	 * @param string &$score
	 * @param string &$size
	 * @param string &$date
	 * @param string &$related
	 * @param string &$html
	 * @return void
	 */
	public function onShowSearchHit( $searchPage, $result,
		$terms, &$link, &$redirect, &$section, &$extract, &$score, &$size, &$date, &$related,
		&$html
	): void {
		if ( $result instanceof ExtendedResult ) {
			return;
		}

		$languageFallbackChain = $this->fallbackChainFactory->newFromContext( $searchPage->getContext() );

		$title = $result->getTitle();

		if ( !$this->isTitleEntity( $title ) ) {
			return;
		}

		try {
			$entity = $this->getEntity( $title );
		} catch ( RevisionedUnresolvedRedirectException $exception ) {
			return;
		}

		if ( !( $entity instanceof DescriptionsProvider ) ) {
			return;
		}

		$extract = '';

		$entityTerms = $entity->getDescriptions()->toTextArray();
		$termData = $languageFallbackChain->extractPreferredValue( $entityTerms );
		if ( $termData !== null ) {
			// TODO: do something akin to SearchResult::getTextSnippet here?
			self::addDescription( $extract, $termData, $searchPage );
		}

		if ( $entity instanceof StatementListProvider ) {
			$statementCount = $entity->getStatements()->count();
		} else {
			$statementCount = 0;
		}
		if ( $entity instanceof Item ) {
			$linkCount = $entity->getSiteLinkList()->count();
		} else {
			$linkCount = 0;
		}

		// set $size to size metrics
		$size = $searchPage->msg(
			'wikibase-search-result-stats',
			$statementCount,
			$linkCount
		)->escaped();
	}

	private function isTitleEntity( Title $title ): bool {
		$contentModel = $title->getContentModel();
		return $this->entityContentFactory->isEntityContentModel( $contentModel );
	}

	private function getEntity( Title $title ): ?EntityDocument {
		$entityId = $this->entityIdLookup->getEntityIdForTitle( $title );
		if ( $entityId ) {
			return $this->entityLookup->getEntity( $entityId );
		}
		return null;
	}

	/**
	 * Add attributes appropriate for language of this text.
	 * @param array &$attr Link attributes, to be modified if needed
	 * @param string $displayLanguage
	 * @param array $text Text description array, with language in ['language']
	 */
	public static function addLanguageAttrs( array &$attr, string $displayLanguage, array $text ) {
		if ( $text['language'] !== $displayLanguage ) {
			try {
				$language = Language::factory( $text['language'] );
			} catch ( MWException $e ) {

				// If somebody fed us broken language, ignore it
				return;
			}
			$attr += [ 'dir' => $language->getDir(), 'lang' => $language->getHtmlCode() ];
		}
	}

	/**
	 * Add HTML description to search result.
	 * @param string &$html The html of the description will be appended here.
	 * @param string[] $description Description as [language, value] array
	 * @param SpecialSearch $searchPage
	 */
	public static function addDescription( string &$html, array $description, SpecialSearch $searchPage ) {
		RequestContext::getMain()->getOutput()->addModuleStyles( [ 'wikibase.common' ] );
		$displayLanguage = $searchPage->getLanguage()->getCode();
		$description = self::withLanguage( $description, $displayLanguage );
		$attr = [ 'class' => 'wb-itemlink-description' ];
		self::addLanguageAttrs( $attr, $displayLanguage, $description );
		// Wrap with searchresult div, as original code does
		$html .= Html::rawElement( 'div', [ 'class' => 'searchresult' ],
			Html::rawElement( 'span', $attr, HtmlArmor::getHtml( $description['value'] ) )
		);
	}

	/**
	 * Remove span tag placed around title search hit for entity titles
	 * to highlight matches in bold.
	 *
	 * @todo Add highlighting when Q##-id matches and not label text.
	 *
	 * @param Title &$title
	 * @param string|HtmlArmor|null &$titleSnippet
	 * @param SearchResult $result
	 * @param array $terms
	 * @param SpecialSearch $specialSearch
	 * @param string[] &$query
	 * @param string[] &$attributes
	 * @return void
	 */
	public function onShowSearchHitTitle(
		&$title,
		&$titleSnippet,
		$result,
		$terms,
		$specialSearch,
		&$query,
		&$attributes
	): void {
		if ( $result instanceof ExtendedResult ) {
			return;
		}
		if ( $this->isTitleEntity( $title ) ) {
			$titleSnippet = $title->getFullText();
		}
	}

	/**
	 * If text's language is not the same as display language, add
	 * marker with language name to the string.
	 *
	 * @param string[] $text ['language' => LANG, 'value' => TEXT]
	 * @param string $displayLanguage
	 * @return array ['language' => LANG, 'value' => TEXT]
	 */
	public static function withLanguage( $text, $displayLanguage ) {
		if ( $text['language'] == $displayLanguage || $text['value'] == '' ) {
			return $text;
		}
		try {
			$termFallback = new TermFallback( $displayLanguage, HtmlArmor::getHtml( $text['value'] ),
					$text['language'], null );
		} catch ( InvalidArgumentException $e ) {
			return $text;
		}
		$fallback = new LanguageFallbackIndicator( new LanguageNameLookup( $displayLanguage ) );
		$markedText = HtmlArmor::getHtml( $text['value'] ) . $fallback->getHtml( $termFallback );
		return [
			'language' => $text['language'],
			'value' => new HtmlArmor( $markedText )
		];
	}

}


1			<?php
2
3			namespace Wikibase\Repo\Hooks;
4
5			use Html;
6			use HtmlArmor;
7			use InvalidArgumentException;
8			use Language;
9			use MediaWiki\Search\Hook\ShowSearchHitHook;
10			use MediaWiki\Search\Hook\ShowSearchHitTitleHook;
11			use MWException;
12			use RequestContext;
13			use SearchResult;
14			use SpecialSearch;
15			use Title;
16			use Wikibase\DataModel\Entity\EntityDocument;
17			use Wikibase\DataModel\Entity\Item;
18			use Wikibase\DataModel\Services\Lookup\EntityLookup;
19			use Wikibase\DataModel\Statement\StatementListProvider;
20			use Wikibase\DataModel\Term\DescriptionsProvider;
21			use Wikibase\DataModel\Term\TermFallback;
22			use Wikibase\Lib\LanguageFallbackChainFactory;
23			use Wikibase\Lib\LanguageFallbackIndicator;
24			use Wikibase\Lib\LanguageNameLookup;
25			use Wikibase\Lib\Store\EntityIdLookup;
26			use Wikibase\Lib\Store\RevisionedUnresolvedRedirectException;
27			use Wikibase\Repo\Content\EntityContentFactory;
28			use Wikibase\Repo\Search\ExtendedResult;
29			use Wikibase\Repo\WikibaseRepo;
30
31			/**
32			* Handler to format entities in the search results
33			*
34			* @license GPL-2.0-or-later
35			* @author Matěj Suchánek
36			* @author Daniel Kinzler
37			*/
38			class ShowSearchHitHandler implements ShowSearchHitHook, ShowSearchHitTitleHook {
39
40			private $entityContentFactory;
41			private $entityIdLookup;
42			private $entityLookup;
43			private $fallbackChainFactory;
44
45			public function __construct(
46			EntityContentFactory $entityContentFactory,
47			EntityIdLookup $entityIdLookup,
48			EntityLookup $entityLookup,
49			LanguageFallbackChainFactory $fallbackChainFactory
50			) {
51			$this->entityContentFactory = $entityContentFactory;
52			$this->entityIdLookup = $entityIdLookup;
53			$this->entityLookup = $entityLookup;
54			$this->fallbackChainFactory = $fallbackChainFactory;
55			}
56
57			public static function factory(): self {
58			$wikibaseRepo = WikibaseRepo::getDefaultInstance();
59
60			return new self(
61			$wikibaseRepo->getEntityContentFactory(),
62			$wikibaseRepo->getEntityIdLookup(),
63			$wikibaseRepo->getEntityLookup(),
64			$wikibaseRepo->getLanguageFallbackChainFactory()
65			);
66			}
67
68			/**
69			* Format the output when the search result contains entities
70			* @see https://www.mediawiki.org/wiki/Manual:Hooks/ShowSearchHit
71			* @see showEntityResultHit
72			* @see showPlainSearchHit
73			* @param SpecialSearch $searchPage
74			* @param SearchResult $result
75			* @param string[] $terms
76			* @param string &$link
77			* @param string &$redirect
78			* @param string &$section
79			* @param string &$extract
80			* @param string &$score
81			* @param string &$size
82			* @param string &$date
83			* @param string &$related
84			* @param string &$html
85			* @return void
86			*/
87			public function onShowSearchHit( $searchPage, $result,
88			$terms, &$link, &$redirect, &$section, &$extract, &$score, &$size, &$date, &$related,
89			&$html
90			): void {
91			if ( $result instanceof ExtendedResult ) {
92			return;
93			}
94
95			$languageFallbackChain = $this->fallbackChainFactory->newFromContext( $searchPage->getContext() );
96
97			$title = $result->getTitle();
98
99			if ( !$this->isTitleEntity( $title ) ) {
100			return;
101			}
102
103			try {
104			$entity = $this->getEntity( $title );
105			} catch ( RevisionedUnresolvedRedirectException $exception ) {
106			return;
107			}
108
109			if ( !( $entity instanceof DescriptionsProvider ) ) {
110			return;
111			}
112
113			$extract = '';
114
115			$entityTerms = $entity->getDescriptions()->toTextArray();
116			$termData = $languageFallbackChain->extractPreferredValue( $entityTerms );
117			if ( $termData !== null ) {
118			// TODO: do something akin to SearchResult::getTextSnippet here?
119			self::addDescription( $extract, $termData, $searchPage );
120			}
121
122			if ( $entity instanceof StatementListProvider ) {
123			$statementCount = $entity->getStatements()->count();
124			} else {
125			$statementCount = 0;
126			}
127			if ( $entity instanceof Item ) {
128			$linkCount = $entity->getSiteLinkList()->count();
129			} else {
130			$linkCount = 0;
131			}
132
133			// set $size to size metrics
134			$size = $searchPage->msg(
135			'wikibase-search-result-stats',
136			$statementCount,
137			$linkCount
138			)->escaped();
139			}
140
141			private function isTitleEntity( Title $title ): bool {
142			$contentModel = $title->getContentModel();
143			return $this->entityContentFactory->isEntityContentModel( $contentModel );
144			}
145
146			private function getEntity( Title $title ): ?EntityDocument {
147			$entityId = $this->entityIdLookup->getEntityIdForTitle( $title );
148			if ( $entityId ) {
149			return $this->entityLookup->getEntity( $entityId );
150			}
151			return null;
152			}
153
154			/**
155			* Add attributes appropriate for language of this text.
156			* @param array &$attr Link attributes, to be modified if needed
157			* @param string $displayLanguage
158			* @param array $text Text description array, with language in ['language']
159			*/
160			public static function addLanguageAttrs( array &$attr, string $displayLanguage, array $text ) {
161			if ( $text['language'] !== $displayLanguage ) {
162			try {
163			$language = Language::factory( $text['language'] );
164			} catch ( MWException $e ) {
			0 ignored issues – show Bug introduced 2018-03-16 11:43 UTC by Report Bug Copy Issue Report The class `MWException` does not exist. Is this class maybe located in a folder that is not analyzed, or in a newer version of your dependencies than listed in your composer.lock/composer.json? Loading history...
165			// If somebody fed us broken language, ignore it
166			return;
167			}
168			$attr += [ 'dir' => $language->getDir(), 'lang' => $language->getHtmlCode() ];
169			}
170			}
171
172			/**
173			* Add HTML description to search result.
174			* @param string &$html The html of the description will be appended here.
175			* @param string[] $description Description as [language, value] array
176			* @param SpecialSearch $searchPage
177			*/
178			public static function addDescription( string &$html, array $description, SpecialSearch $searchPage ) {
179			RequestContext::getMain()->getOutput()->addModuleStyles( [ 'wikibase.common' ] );
180			$displayLanguage = $searchPage->getLanguage()->getCode();
181			$description = self::withLanguage( $description, $displayLanguage );
182			$attr = [ 'class' => 'wb-itemlink-description' ];
183			self::addLanguageAttrs( $attr, $displayLanguage, $description );
184			// Wrap with searchresult div, as original code does
185			$html .= Html::rawElement( 'div', [ 'class' => 'searchresult' ],
186			Html::rawElement( 'span', $attr, HtmlArmor::getHtml( $description['value'] ) )
187			);
188			}
189
190			/**
191			* Remove span tag placed around title search hit for entity titles
192			* to highlight matches in bold.
193			*
194			* @todo Add highlighting when Q##-id matches and not label text.
195			*
196			* @param Title &$title
197			* @param string\|HtmlArmor\|null &$titleSnippet
198			* @param SearchResult $result
199			* @param array $terms
200			* @param SpecialSearch $specialSearch
201			* @param string[] &$query
202			* @param string[] &$attributes
203			* @return void
204			*/
205			public function onShowSearchHitTitle(
206			&$title,
207			&$titleSnippet,
208			$result,
209			$terms,
210			$specialSearch,
211			&$query,
212			&$attributes
213			): void {
214			if ( $result instanceof ExtendedResult ) {
215			return;
216			}
217			if ( $this->isTitleEntity( $title ) ) {
218			$titleSnippet = $title->getFullText();
219			}
220			}
221
222			/**
223			* If text's language is not the same as display language, add
224			* marker with language name to the string.
225			*
226			* @param string[] $text ['language' => LANG, 'value' => TEXT]
227			* @param string $displayLanguage
228			* @return array ['language' => LANG, 'value' => TEXT]
229			*/
230			public static function withLanguage( $text, $displayLanguage ) {
231			if ( $text['language'] == $displayLanguage \|\| $text['value'] == '' ) {
232			return $text;
233			}
234			try {
235			$termFallback = new TermFallback( $displayLanguage, HtmlArmor::getHtml( $text['value'] ),
236			$text['language'], null );
237			} catch ( InvalidArgumentException $e ) {
238			return $text;
239			}
240			$fallback = new LanguageFallbackIndicator( new LanguageNameLookup( $displayLanguage ) );
241			$markedText = HtmlArmor::getHtml( $text['value'] ) . $fallback->getHtml( $termFallback );
242			return [
243			'language' => $text['language'],
244			'value' => new HtmlArmor( $markedText )
245			];
246			}
247
248			}
249

wikimedia / mediawiki-extensions-Wikibase

ShowSearchHitHandler::onShowSearchHit() B last analyzed 2020-11-13 17:34 UTC

Complexity

Size

Duplication

Importance

How to fix Long Method Many Parameters

Long Method

Many Parameters

Duplication Side-by-Side

Filter issues like

ShowSearchHitHandler::onShowSearchHit() B
last analyzed 2020-11-13 17:34 UTC