Inheritance diagram for SpecialReplaceText:

[legend]

Collaboration diagram for SpecialReplaceText:

[legend]

Public Member Functions
	__construct ()

	createJobsForTextReplacements ()
	Returns the set of MediaWiki jobs that will do all the actual replacements.

	doesWrites ()
	@inheritDoc

	doSpecialReplaceText ()
	Do the actual display and logic of Special:ReplaceText.

	execute ( $query)

	extractContext ( $text, $target, $use_regex=false)
	Extract context and highlights search text.

	getAnyWarningMessageBeforeReplace ( $titles_for_edit, $titles_for_move)
	Get the warning message if the replacement string is either blank or found elsewhere on the wiki (since undoing the replacement would be difficult in either case).

	getSelectedNamespaces ()

	getTitlesForEditingWithContext ()
	Returns the set of Titles whose contents would be modified by this replacement, along with the "search context" string for each one.

	getTitlesForMoveAndUnmoveableTitles ()
	Returns two lists: the set of titles that would be moved/renamed by the current text replacement, and the set of titles that would ordinarily be moved but are not moveable, due to permissions or any other reason.

	namespaceTables ( $namespaces, $rowsPerTable=3)
	Copied almost exactly from MediaWiki's SpecialSearch class, i.e.

	pageListForm ( $titles_for_edit, $titles_for_move, $unmoveable_titles)

	showForm ( $warning_msg=null)

Public Member Functions inherited from SpecialPage
	__construct ( $name='', $restriction='', $listed=true, $function=false, $file='', $includable=false)
	Default constructor for special pages Derivative classes should call this from their constructor Note that if the user does not have the required level, an error message will be displayed by the default execute() method, without the global function ever being called.

	addHelpLink ( $to, $overrideBaseUrl=false)
	Adds help link with an icon via page indicators.

	checkPermissions ()
	Checks if userCanExecute, and if not throws a PermissionsError.

	checkReadOnly ()
	If the wiki is currently in readonly mode, throws a ReadOnlyError.

	displayRestrictionError ()
	Output an error message telling the user what access level they have to have.

	getConfig ()
	Shortcut to get main config object.

	getContext ()
	Gets the context this SpecialPage is executed in.

	getDescription ()
	Returns the name that goes in the \<h1\> in the special page itself, and also the name that will be listed in Special:Specialpages.

	getFinalGroupName ()
	Get the group that the special page belongs in on Special:SpecialPage Use this method, instead of getGroupName to allow customization of the group name from the wiki side.

	getFullTitle ()
	Return the full title, including $par.

	getLanguage ()
	Shortcut to get user's language.

	getLinkRenderer ()

	getLocalName ()
	Get the localised name of the special page.

	getName ()
	Get the name of this Special Page.

	getOutput ()
	Get the OutputPage being used for this instance.

	getPageTitle ( $subpage=false)
	Get a self-referential title object.

	getRequest ()
	Get the WebRequest being used for this instance.

	getRestriction ()
	Get the permission that a user must have to execute this page.

	getSkin ()
	Shortcut to get the skin being used for this instance.

	getTitle ( $subpage=false)
	Get a self-referential title object.

	getUser ()
	Shortcut to get the User executing this instance.

	including ( $x=null)
	Whether the special page is being evaluated via transclusion.

	isCached ()
	Is this page cached? Expensive pages are cached or disabled in miser mode.

	isExpensive ()
	Is this page expensive (for some definition of expensive)? Expensive pages are disabled or cached in miser mode.

	isIncludable ()
	Whether it's allowed to transclude the special page via {{Special:Foo/params}}.

	isListed ()
	Whether this special page is listed in Special:SpecialPages.

	isRestricted ()
	Can be overridden by subclasses with more complicated permissions schemes.

	listed ( $x=null)
	Get or set whether this special page is listed in Special:SpecialPages.

	maxIncludeCacheTime ()
	How long to cache page when it is being included.

	msg ( $key)
	Wrapper around wfMessage that sets the current context.

	outputHeader ( $summaryMessageKey='')
	Outputs a summary message on top of special pages Per default the message key is the canonical name of the special page May be overridden, i.e.

	prefixSearchSubpages ( $search, $limit, $offset)
	Return an array of subpages beginning with $search that this special page will accept.

	requireLogin ( $reasonMsg='exception-nologin-text', $titleMsg='exception-nologin')
	If the user is not logged in, throws UserNotLoggedIn error.

	run ( $subPage)
	Entry point.

	setContext ( $context)
	Sets the context this SpecialPage is executed in.

	setHeaders ()
	Sets headers - this should be called from the execute() method of all derived classes!

	setLinkRenderer (LinkRenderer $linkRenderer)

	setListed ( $listed)
	Set whether this page is listed in Special:Specialpages, at run-time.

	userCanExecute (User $user)
	Checks if the given user (identified by an object) can execute this special page (as defined by $mRestriction).

Protected Member Functions
	getGroupName ()
	@inheritDoc

Protected Member Functions inherited from SpecialPage
	addFeedLinks ( $params)
	Adds RSS/atom links.

	afterExecute ( $subPage)
	Gets called after.

	beforeExecute ( $subPage)
	Gets called before.

	checkLoginSecurityLevel ( $level=null)
	Verifies that the user meets the security level, possibly reauthenticating them in the process.

	getCacheTTL ()

	getLoginSecurityLevel ()
	Tells if the special page does something security-sensitive and needs extra defense against a stolen account (e.g.

	getRobotPolicy ()
	Return the robot policy.

	getSubpagesForPrefixSearch ()
	Return an array of subpages that this special page will accept for prefix searches.

	prefixSearchString ( $search, $limit, $offset)
	Perform a regular substring search for prefixSearchSubpages.

	setReauthPostData (array $data)
	Record preserved POST data after a reauthentication.

	useTransactionalTimeLimit ()
	Call wfTransactionalTimeLimit() if this request was POSTed.

Private Member Functions
	convertWhiteSpaceToHTML ( $msg)

	getMatchingTitles ( $str, $namespaces, $category, $prefix, $use_regex=false)

Private Attributes
	$category

	$doAnnounce

	$edit_pages

	$move_pages

	$prefix

	$replacement

	$selected_namespaces

	$target

	$use_regex

Additional Inherited Members
Static Public Member Functions inherited from SpecialPage
static	getSafeTitleFor ( $name, $subpage=false)
	Get a localised Title object for a page name with a possibly unvalidated subpage.

static	getTitleFor ( $name, $subpage=false, $fragment='')
	Get a localised Title object for a specified special page name If you don't need a full Title object, consider using TitleValue through getTitleValueFor() below.

static	getTitleValueFor ( $name, $subpage=false, $fragment='')
	Get a localised TitleValue object for a specified special page name.

Static Protected Member Functions inherited from SpecialPage
static	prefixSearchArray ( $search, $limit, array $subpages, $offset)
	Helper function for implementations of prefixSearchSubpages() that filter the values in memory (as opposed to making a query).

Protected Attributes inherited from SpecialPage
IContextSource	$mContext
	Current request context.

	$mIncludable

	$mIncluding

	$mName

	$mRestriction

Detailed Description

Definition at line 21 of file SpecialReplaceText.php.

Constructor & Destructor Documentation

◆ __construct()

SpecialReplaceText::__construct ( )

Definition at line 32 of file SpecialReplaceText.php.

Member Function Documentation

◆ convertWhiteSpaceToHTML()

SpecialReplaceText::convertWhiteSpaceToHTML ( $msg )

private

Definition at line 752 of file SpecialReplaceText.php.

Referenced by extractContext().

◆ createJobsForTextReplacements()

SpecialReplaceText::createJobsForTextReplacements ( )

Returns the set of MediaWiki jobs that will do all the actual replacements.

Returns: array jobs

Definition at line 226 of file SpecialReplaceText.php.

References $doAnnounce, $replacement, $request, $target, $use_regex, $value, $wgReplaceTextUser, SpecialPage\getRequest(), SpecialPage\getUser(), SpecialPage\msg(), and User\newFromName().

Referenced by doSpecialReplaceText().

◆ doesWrites()

SpecialReplaceText::doesWrites ( )

@inheritDoc

Reimplemented from SpecialPage.

Definition at line 39 of file SpecialReplaceText.php.

◆ doSpecialReplaceText()

SpecialReplaceText::doSpecialReplaceText ( )

Do the actual display and logic of Special:ReplaceText.

Definition at line 91 of file SpecialReplaceText.php.

References $link, $out, $request, createJobsForTextReplacements(), getAnyWarningMessageBeforeReplace(), SpecialPage\getLanguage(), SpecialPage\getOutput(), SpecialPage\getPageTitle(), SpecialPage\getRequest(), getSelectedNamespaces(), getTitlesForEditingWithContext(), getTitlesForMoveAndUnmoveableTitles(), SpecialPage\getUser(), ReplaceTextUtils\link(), list, SpecialPage\msg(), NS_CATEGORY, pageListForm(), showForm(), and JobQueueGroup\singleton().

Referenced by execute().

◆ execute()

SpecialReplaceText::execute ( $query )

Parameters

null | string $query

Reimplemented from SpecialPage.

Definition at line 46 of file SpecialReplaceText.php.

References $out, $wgCompressRevisions, $wgExternalStores, doSpecialReplaceText(), SpecialPage\getOutput(), SpecialPage\getUser(), and SpecialPage\setHeaders().

◆ extractContext()

SpecialReplaceText::extractContext	(	$text,
		$target,
		$use_regex = false )

Extract context and highlights search text.

Todo: The bolding needs to be fixed for regular expressions.

Parameters

string	$text
string	$target
bool	$use_regex

Returns: string

Definition at line 692 of file SpecialReplaceText.php.

References $context, $matches, $target, $use_regex, $wgLang, convertWhiteSpaceToHTML(), SpecialPage\getUser(), and list.

Referenced by getTitlesForEditingWithContext().

◆ getAnyWarningMessageBeforeReplace()

SpecialReplaceText::getAnyWarningMessageBeforeReplace	(		$titles_for_edit,
			$titles_for_move )

Get the warning message if the replacement string is either blank or found elsewhere on the wiki (since undoing the replacement would be difficult in either case).

Parameters

array	$titles_for_edit
array	$titles_for_move

Returns: string|null Warning message, if any

Definition at line 362 of file SpecialReplaceText.php.

References $res, ReplaceTextSearch\doSearchQuery(), getMatchingTitles(), and SpecialPage\msg().

Referenced by doSpecialReplaceText().

◆ getGroupName()

SpecialReplaceText::getGroupName ( )

protected

@inheritDoc

Reimplemented from SpecialPage.

Definition at line 789 of file SpecialReplaceText.php.

◆ getMatchingTitles()

SpecialReplaceText::getMatchingTitles	(	$str,
		$namespaces,
		$category,
		$prefix,
		$use_regex = false )

private

Definition at line 761 of file SpecialReplaceText.php.

References $category, $dbr, $namespaces, $prefix, $sort, $tables, $use_regex, $vars, ReplaceTextSearch\categoryCondition(), DB_REPLICA, ReplaceTextSearch\prefixCondition(), ReplaceTextSearch\regexCond(), and wfGetDB().

Referenced by getAnyWarningMessageBeforeReplace(), and getTitlesForMoveAndUnmoveableTitles().

◆ getSelectedNamespaces()

SpecialReplaceText::getSelectedNamespaces ( )

Returns: array namespaces selected for search

Definition at line 77 of file SpecialReplaceText.php.

References $selected_namespaces, and SpecialPage\getRequest().

Referenced by doSpecialReplaceText().

◆ getTitlesForEditingWithContext()

SpecialReplaceText::getTitlesForEditingWithContext ( )

Returns the set of Titles whose contents would be modified by this replacement, along with the "search context" string for each one.

Returns: array The set of Titles and their search context strings

Definition at line 281 of file SpecialReplaceText.php.

References $context, $res, $title, ReplaceTextSearch\doSearchQuery(), and extractContext().

Referenced by doSpecialReplaceText().

◆ getTitlesForMoveAndUnmoveableTitles()

SpecialReplaceText::getTitlesForMoveAndUnmoveableTitles ( )

Returns two lists: the set of titles that would be moved/renamed by the current text replacement, and the set of titles that would ordinarily be moved but are not moveable, due to permissions or any other reason.

Returns: array

Definition at line 312 of file SpecialReplaceText.php.

References $res, $title, and getMatchingTitles().

Referenced by doSpecialReplaceText().

◆ namespaceTables()

SpecialReplaceText::namespaceTables	(		$namespaces,
			$rowsPerTable = 3 )

Copied almost exactly from MediaWiki's SpecialSearch class, i.e.

the search page

Parameters

string[]	$namespaces
int	$rowsPerTable

Returns: string HTML

Definition at line 527 of file SpecialReplaceText.php.

References $namespaces, $rows, $tables, $wgContLang, and SpecialPage\msg().

Referenced by showForm().

◆ pageListForm()

SpecialReplaceText::pageListForm	(	$titles_for_edit,
		$titles_for_move,
		$unmoveable_titles )

Parameters

array	$titles_for_edit
array	$titles_for_move
array	$unmoveable_titles

Definition at line 569 of file SpecialReplaceText.php.

References $context, $out, $title, $wgLang, SpecialPage\getOutput(), SpecialPage\getPageTitle(), SpecialPage\getTitleFor(), ReplaceTextUtils\link(), list, SpecialPage\msg(), and text.

Referenced by doSpecialReplaceText().

◆ showForm()

SpecialReplaceText::showForm ( $warning_msg = null )

Parameters

string | null $warning_msg Message to be shown at top of form

Definition at line 403 of file SpecialReplaceText.php.

References $dbr, $namespaces, $out, $tables, DB_REPLICA, SpecialPage\getOutput(), SpecialPage\getPageTitle(), SpecialPage\getTitleFor(), SpecialPage\msg(), namespaceTables(), text, and wfGetDB().

Referenced by doSpecialReplaceText().

Member Data Documentation

◆ $category

SpecialReplaceText::$category

private

Definition at line 25 of file SpecialReplaceText.php.

Referenced by getMatchingTitles().

◆ $doAnnounce

SpecialReplaceText::$doAnnounce

private

Definition at line 30 of file SpecialReplaceText.php.

Referenced by createJobsForTextReplacements().

◆ $edit_pages

SpecialReplaceText::$edit_pages

private

Definition at line 27 of file SpecialReplaceText.php.

◆ $move_pages

SpecialReplaceText::$move_pages

private

Definition at line 28 of file SpecialReplaceText.php.

◆ $prefix

SpecialReplaceText::$prefix

private

Definition at line 26 of file SpecialReplaceText.php.

Referenced by getMatchingTitles().

◆ $replacement

SpecialReplaceText::$replacement

private

Definition at line 23 of file SpecialReplaceText.php.

Referenced by createJobsForTextReplacements().

◆ $selected_namespaces

SpecialReplaceText::$selected_namespaces

private

Definition at line 29 of file SpecialReplaceText.php.

Referenced by getSelectedNamespaces().

◆ $target

SpecialReplaceText::$target

private

Definition at line 22 of file SpecialReplaceText.php.

Referenced by createJobsForTextReplacements(), and extractContext().

◆ $use_regex

SpecialReplaceText::$use_regex

private

Definition at line 24 of file SpecialReplaceText.php.

Referenced by createJobsForTextReplacements(), extractContext(), and getMatchingTitles().

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

extensions/ReplaceText/src/SpecialReplaceText.php

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ convertWhiteSpaceToHTML()

◆ createJobsForTextReplacements()

◆ doesWrites()

◆ doSpecialReplaceText()

◆ execute()

◆ extractContext()

◆ getAnyWarningMessageBeforeReplace()

◆ getGroupName()

◆ getMatchingTitles()

◆ getSelectedNamespaces()

◆ getTitlesForEditingWithContext()

◆ getTitlesForMoveAndUnmoveableTitles()

◆ namespaceTables()

◆ pageListForm()

◆ showForm()

Member Data Documentation

◆ $category

◆ $doAnnounce

◆ $edit_pages

◆ $move_pages

◆ $prefix

◆ $replacement

◆ $selected_namespaces

◆ $target

◆ $use_regex