Collaboration diagram for MediaWiki\Search\SearchWidgets\SearchFormWidget:

[legend]

Public Member Functions
	__construct (SpecialSearch $specialSearch, SearchEngineConfig $searchConfig, HookContainer $hookContainer, ILanguageConverter $languageConverter, NamespaceInfo $namespaceInfo, array $profiles)

	render ( $profile, $term, $numResults, $totalResults, $approximateTotalResults, $offset, $isPowerSearch, array $options=[])

Protected Member Functions
	getHookContainer ()

	getHookRunner ()

	makeSearchLink ( $term, $label, $tooltip, array $params=[])
	Make a search link with some target namespaces.

	optionsHtml ( $term, $isPowerSearch, $profile)
	Generates HTML for advanced options available with the currently selected search profile.

	powerSearchBox ( $term, array $opts)

	profileTabsHtml ( $profile, $term)
	Generates HTML for the list of available search profiles.

	shortDialogHtml ( $profile, $term, $numResults, $totalResults, $approximateTotalResults, $offset, array $options=[])

	startsWithImage ( $term)
	Check if query starts with image: prefix.

Protected Attributes
array	$profiles

SearchEngineConfig	$searchConfig

SpecialSearch	$specialSearch

Detailed Description

Definition at line 18 of file SearchFormWidget.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Search\SearchWidgets\SearchFormWidget::__construct	(	SpecialSearch	$specialSearch,
		SearchEngineConfig	$searchConfig,
		HookContainer	$hookContainer,
		ILanguageConverter	$languageConverter,
		NamespaceInfo	$namespaceInfo,
		array	$profiles )

Definition at line 27 of file SearchFormWidget.php.

References MediaWiki\Search\SearchWidgets\SearchFormWidget\$profiles, MediaWiki\Search\SearchWidgets\SearchFormWidget\$searchConfig, and MediaWiki\Search\SearchWidgets\SearchFormWidget\$specialSearch.

Member Function Documentation

◆ getHookContainer()

MediaWiki\Search\SearchWidgets\SearchFormWidget::getHookContainer ( )

protected

Returns: HookContainer

Since: 1.35

Definition at line 289 of file SearchFormWidget.php.

◆ getHookRunner()

MediaWiki\Search\SearchWidgets\SearchFormWidget::getHookRunner ( )

protected

Returns: HookRunner

Since: 1.35

Access: internal: This is for use by core only. Hook interfaces may be removed without notice.

Definition at line 299 of file SearchFormWidget.php.

Referenced by MediaWiki\Search\SearchWidgets\SearchFormWidget\optionsHtml(), and MediaWiki\Search\SearchWidgets\SearchFormWidget\powerSearchBox().

◆ makeSearchLink()

MediaWiki\Search\SearchWidgets\SearchFormWidget::makeSearchLink	(		$term,
			$label,
			$tooltip,
		array	$params = [] )

protected

Make a search link with some target namespaces.

Parameters

string	$term	The term to search for
string	$label	Link's text
string	$tooltip	Link's tooltip
array	$params	Query string parameters

Returns: string HTML fragment

Definition at line 221 of file SearchFormWidget.php.

References MediaWiki\Html\element().

Referenced by MediaWiki\Search\SearchWidgets\SearchFormWidget\profileTabsHtml().

◆ optionsHtml()

MediaWiki\Search\SearchWidgets\SearchFormWidget::optionsHtml	(	$term,
		$isPowerSearch,
		$profile )

protected

Generates HTML for advanced options available with the currently selected search profile.

Parameters

string	$term	User provided search term
bool	$isPowerSearch	Is the advanced search profile enabled?
string	$profile	The current search profile

Returns: string HTML

Definition at line 246 of file SearchFormWidget.php.

References MediaWiki\Search\SearchWidgets\SearchFormWidget\getHookRunner(), and MediaWiki\Search\SearchWidgets\SearchFormWidget\powerSearchBox().

Referenced by MediaWiki\Search\SearchWidgets\SearchFormWidget\render().

◆ powerSearchBox()

MediaWiki\Search\SearchWidgets\SearchFormWidget::powerSearchBox	(		$term,
		array	$opts )

protected

Parameters

string	$term	The current search term
array	$opts	Additional key/value pairs that will be submitted with the generated form.

Returns: string HTML

Definition at line 265 of file SearchFormWidget.php.

References MediaWiki\Search\SearchWidgets\SearchFormWidget\getHookRunner().

Referenced by MediaWiki\Search\SearchWidgets\SearchFormWidget\optionsHtml().

◆ profileTabsHtml()

MediaWiki\Search\SearchWidgets\SearchFormWidget::profileTabsHtml	(		$profile,
			$term )

protected

Generates HTML for the list of available search profiles.

Parameters

string	$profile	The currently selected profile
string	$term	The user provided search terms

Returns: string HTML

Definition at line 170 of file SearchFormWidget.php.

References MediaWiki\Search\SearchWidgets\SearchFormWidget\makeSearchLink(), and MediaWiki\Search\SearchWidgets\SearchFormWidget\startsWithImage().

Referenced by MediaWiki\Search\SearchWidgets\SearchFormWidget\render().

◆ render()

MediaWiki\Search\SearchWidgets\SearchFormWidget::render	(		$profile,
			$term,
			$numResults,
			$totalResults,
			$approximateTotalResults,
			$offset,
			$isPowerSearch,
		array	$options = [] )

Parameters

string	$profile	The current search profile
string	$term	The current search term
int	$numResults	The number of results shown
int	$totalResults	The total estimated results found
bool	$approximateTotalResults	Whether $totalResults is approximate or not
int	$offset	Current offset in search results
bool	$isPowerSearch	Is the 'advanced' section open?
array	$options	Widget options

Returns: string HTML

Definition at line 55 of file SearchFormWidget.php.

References MediaWiki\Search\SearchWidgets\SearchFormWidget\optionsHtml(), MediaWiki\Search\SearchWidgets\SearchFormWidget\profileTabsHtml(), MediaWiki\Search\SearchWidgets\SearchFormWidget\shortDialogHtml(), and wfScript().

◆ shortDialogHtml()

MediaWiki\Search\SearchWidgets\SearchFormWidget::shortDialogHtml	(		$profile,
			$term,
			$numResults,
			$totalResults,
			$approximateTotalResults,
			$offset,
		array	$options = [] )

protected

Parameters

string	$profile	The current search profile
string	$term	The current search term
int	$numResults	The number of results shown
int	$totalResults	The total estimated results found
bool	$approximateTotalResults	Whether $totalResults is approximate or not
int	$offset	Current offset in search results
array	$options	Widget options

Returns: string HTML

Definition at line 105 of file SearchFormWidget.php.

Referenced by MediaWiki\Search\SearchWidgets\SearchFormWidget\render().

◆ startsWithImage()

MediaWiki\Search\SearchWidgets\SearchFormWidget::startsWithImage ( $term )

protected

Check if query starts with image: prefix.

Parameters

string $term The string to check

Returns: bool

Definition at line 206 of file SearchFormWidget.php.

References NS_FILE.

Referenced by MediaWiki\Search\SearchWidgets\SearchFormWidget\profileTabsHtml().

Member Data Documentation

◆ $profiles

array MediaWiki\Search\SearchWidgets\SearchFormWidget::$profiles

protected

Definition at line 25 of file SearchFormWidget.php.

Referenced by MediaWiki\Search\SearchWidgets\SearchFormWidget\__construct().

◆ $searchConfig

SearchEngineConfig MediaWiki\Search\SearchWidgets\SearchFormWidget::$searchConfig

protected

Definition at line 20 of file SearchFormWidget.php.

Referenced by MediaWiki\Search\SearchWidgets\SearchFormWidget\__construct().

◆ $specialSearch

SpecialSearch MediaWiki\Search\SearchWidgets\SearchFormWidget::$specialSearch

protected

Definition at line 19 of file SearchFormWidget.php.

Referenced by MediaWiki\Search\SearchWidgets\SearchFormWidget\__construct().

The documentation for this class was generated from the following file:

includes/Search/SearchWidgets/SearchFormWidget.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getHookContainer()

◆ getHookRunner()

◆ makeSearchLink()

◆ optionsHtml()

◆ powerSearchBox()

◆ profileTabsHtml()

◆ render()

◆ shortDialogHtml()

◆ startsWithImage()

Member Data Documentation

◆ $profiles

◆ $searchConfig

◆ $specialSearch