Maintenance script that replaces text in pages. More...

Inheritance diagram for ReplaceAll:

Collaboration diagram for ReplaceAll:

[legend]

Public Member Functions
	__construct ()
	Default constructor.

	execute ()
	Do the actual work.All child classes will need to implement this Returns bool\|null\|void True for success, false for failure. Not returning a value, or returning null, is also interpreted as success. Returning false for failure will cause doMaintenance.php to exit the process with a non-zero exit status.

Public Member Functions inherited from Maintenance
	checkRequiredExtensions ()
	Verify that the required extensions are installed.

	cleanupChanneled ()
	Clean up channeled output.

	clearParamsAndArgs ()
	Clear all params and arguments.

	finalSetup ()
	Handle some last-minute setup here.

	getConfig ()

	getDbType ()
	Does the script need different DB access? By default, we give Maintenance scripts normal rights to the DB.

	getName ()
	Get the script's name.

	globals ()
	Potentially debug globals.

	isQuiet ()

	loadParamsAndArgs ( $self=null, $opts=null, $args=null)
	Process command line arguments $mOptions becomes an array with keys set to the option names $mArgs becomes a zero-based array containing the non-option arguments.

	loadSettings ()
	Generic setup for most installs.

	loadWithArgv ( $argv)
	Load params and arguments from a given array of command-line arguments.

	memoryLimit ()
	Normally we disable the memory_limit when running admin scripts.

	outputChanneled ( $msg, $channel=null)
	Message outputter with channeled message support.

	purgeRedundantText ( $delete=true)
	Support function for cleaning up redundant text records.

	runChild ( $maintClass, $classFile=null)
	Run a child maintenance script.

	setAgentAndTriggers ()
	Set triggers like when to try to run deferred updates.

	setConfig (Config $config)

	setDB (IMaintainableDatabase $db)
	Sets database object to be returned by getDB().

	setup ()
	Do some sanity checking and basic setup.

	updateSearchIndex ( $maxLockTime, $callback, $dbw, $results)
	Perform a search index update with locking.

	updateSearchIndexForPage ( $dbw, $pageId)
	Update the searchindex table for a given pageid.

	validateParamsAndArgs ()
	Run some validation checks on the params, etc.

Private Member Functions
	getCategory ()

	getNamespaces ()

	getPrefix ()

	getRename ()

	getReplacement ()

	getReplacements ()

	getReply ( $question)

	getSummary ( $target, $replacement)

	getTarget ()

	getUser ()

	listNamespaces ()

	listTitles ( $titles, $target, $replacement, $regex, $rename)

	localSetup ()

	replaceTitles ( $titles, $target, $replacement, $useRegex, $rename)

	shouldContinueByDefault ()

	showFileFormat ()

	useRegex ()

Private Attributes
	$category

	$defaultContinue

	$doAnnounce

	$namespaces

	$prefix

	$rename

	$replacement

	$target

	$titles

	$user

	$useRegex

Additional Inherited Members
Static Public Member Functions inherited from Maintenance
static	getTermSize ()
	Get the terminal size as a two-element array where the first element is the width (number of columns) and the second element is the height (number of rows).

static	posix_isatty ( $fd)
	Wrapper for posix_isatty() We default as considering stdin a tty (for nice readline methods) but treating stout as not a tty to avoid color codes.

static	readconsole ( $prompt='> ')
	Prompt the console for input.

static	requireTestsAutoloader ()
	Call this to set up the autoloader to allow classes to be used from the tests directory.

static	setLBFactoryTriggers (LBFactory $LBFactory, Config $config)

static	shouldExecute ()
	Should we execute the maintenance script, or just allow it to be included as a standalone class? It checks that the call stack only includes this function and "requires" (meaning was called from the file scope)

Public Attributes inherited from Maintenance
resource	$fileHandle
	Used when creating separate schema files.

array	$orderedOptions = []
	Used to read the options in the order they were passed.

const	DB_ADMIN = 2

const	DB_NONE = 0
	Constants for DB access type.

const	DB_STD = 1

const	STDIN_ALL = 'all'

Protected Member Functions inherited from Maintenance
	activateProfiler ()
	Activate the profiler (assuming $wgProfiler is set)

	addArg ( $arg, $description, $required=true)
	Add some args that are needed.

	addDefaultParams ()
	Add the default parameters to the scripts.

	addDescription ( $text)
	Set the description text.

	addOption ( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
	Add a parameter to the script.

	adjustMemoryLimit ()
	Adjusts PHP's memory limit to better suit our needs, if needed.

	afterFinalSetup ()
	Execute a callback function at the end of initialisation.

	beginTransaction (IDatabase $dbw, $fname)
	Begin a transcation on a DB.

	commitTransaction (IDatabase $dbw, $fname)
	Commit the transcation on a DB handle and wait for replica DBs to catch up.

	countDown ( $seconds)
	Count down from $seconds to zero on the terminal, with a one-second pause between showing each number.

	deleteOption ( $name)
	Remove an option.

	error ( $err, $die=0)
	Throw an error to the user.

	fatalError ( $msg, $exitCode=1)
	Output a message and terminate the current script.

	getArg ( $argId=0, $default=null)
	Get an argument.

	getBatchSize ()
	Returns batch size.

	getDB ( $db, $groups=[], $dbDomain=false)
	Returns a database to be used by current maintenance script.

	getDir ()
	Get the maintenance directory.

	getOption ( $name, $default=null)
	Get an option, or return the default.

	getStdin ( $len=null)
	Return input from stdin.

	hasArg ( $argId=0)
	Does a given argument exist?

	hasOption ( $name)
	Checks to see if a particular option exists.

	loadSpecialVars ()
	Handle the special variables that are global to all scripts.

	maybeHelp ( $force=false)
	Maybe show the help.

	output ( $out, $channel=null)
	Throw some output to the user.

	parseIntList ( $text)
	Utility function to parse a string (perhaps from a command line option) into a list of integers (perhaps some kind of numeric IDs).

	requireExtension ( $name)
	Indicate that the specified extension must be loaded before the script can run.

	rollbackTransaction (IDatabase $dbw, $fname)
	Rollback the transcation on a DB handle.

	setAllowUnregisteredOptions ( $allow)
	Sets whether to allow unregistered options, which are options passed to a script that do not match an expected parameter.

	setBatchSize ( $s=0)
	Set the batch size.

	supportsOption ( $name)
	Checks to see if a particular option in supported.

Protected Attributes inherited from Maintenance
	$mAllowUnregisteredOptions = false

	$mArgList = []

	$mArgs = []

int	$mBatchSize = null
	Batch size.

	$mDbPass

	$mDbUser

	$mDescription = ''

	$mInputLoaded = false

	$mOptions = []

array[]	$mParams = []
	Array of desired/allowed params.

	$mQuiet = false

	$mSelf

	$mShortParamsMap = []

Detailed Description

Maintenance script that replaces text in pages.

@SuppressWarnings(StaticAccess) @SuppressWarnings(LongVariable)

Definition at line 46 of file replaceAll.php.

Constructor & Destructor Documentation

◆ __construct()

ReplaceAll::__construct ( )

Default constructor.

Children should call this first if implementing their own constructors

Reimplemented from Maintenance.

Definition at line 59 of file replaceAll.php.

References Maintenance\addArg(), Maintenance\addDescription(), Maintenance\addOption(), and Maintenance\requireExtension().

Member Function Documentation

◆ execute()

ReplaceAll::execute ( )

Do the actual work.All child classes will need to implement this

Returns: bool|null|void True for success, false for failure. Not returning a value, or returning null, is also interpreted as success. Returning false for failure will cause doMaintenance.php to exit the process with a non-zero exit status.

Reimplemented from Maintenance.

Definition at line 347 of file replaceAll.php.

References $replacement, $res, $target, $titles, $useRegex, $wgShowExceptionDetails, ReplaceTextSearch\doSearchQuery(), Maintenance\error(), ReplaceTextSearch\getMatchingTitles(), Maintenance\getOption(), getReply(), listTitles(), localSetup(), replaceTitles(), shouldContinueByDefault(), and useRegex().

◆ getCategory()

ReplaceAll::getCategory ( )

private

Definition at line 255 of file replaceAll.php.

Referenced by localSetup().

◆ getNamespaces()

ReplaceAll::getNamespaces ( )

private

Definition at line 222 of file replaceAll.php.

References $namespaces, MWNamespace\getCanonicalNamespaces(), Maintenance\getOption(), and NS_MAIN.

Referenced by localSetup().

◆ getPrefix()

ReplaceAll::getPrefix ( )

private

Definition at line 259 of file replaceAll.php.

Referenced by localSetup().

◆ getRename()

ReplaceAll::getRename ( )

private

Definition at line 267 of file replaceAll.php.

References Maintenance\hasOption().

Referenced by localSetup().

◆ getReplacement()

ReplaceAll::getReplacement ( )

private

Definition at line 125 of file replaceAll.php.

References Maintenance\error(), and Maintenance\getArg().

Referenced by localSetup().

◆ getReplacements()

ReplaceAll::getReplacements ( )

private

Definition at line 133 of file replaceAll.php.

References $file, $line, Maintenance\getOption(), true, and useRegex().

Referenced by localSetup().

◆ getReply()

ReplaceAll::getReply ( $question )

private

Definition at line 309 of file replaceAll.php.

References Maintenance\readconsole(), and shouldContinueByDefault().

Referenced by execute().

◆ getSummary()

ReplaceAll::getSummary	(		$target,
			$replacement )

private

Definition at line 176 of file replaceAll.php.

References $replacement, $target, Maintenance\getOption(), and wfMessage().

Referenced by replaceTitles().

◆ getTarget()

ReplaceAll::getTarget ( )

private

Definition at line 117 of file replaceAll.php.

References Maintenance\error(), and Maintenance\getArg().

Referenced by localSetup().

◆ getUser()

ReplaceAll::getUser ( )

private

Definition at line 101 of file replaceAll.php.

References $user, Maintenance\error(), and Maintenance\getOption().

Referenced by localSetup().

◆ listNamespaces()

ReplaceAll::listNamespaces ( )

private

Definition at line 187 of file replaceAll.php.

References MWNamespace\getCanonicalNamespaces().

Referenced by localSetup().

◆ listTitles()

ReplaceAll::listTitles	(	$titles,
		$target,
		$replacement,
		$regex,
		$rename )

private

Definition at line 271 of file replaceAll.php.

References $rename, $replacement, $target, $title, $titles, ReplaceTextSearch\getReplacedTitle(), and Maintenance\output().

Referenced by execute().

◆ localSetup()

ReplaceAll::localSetup ( )

private

Definition at line 321 of file replaceAll.php.

References getCategory(), getNamespaces(), Maintenance\getOption(), getPrefix(), getRename(), getReplacement(), getReplacements(), getTarget(), getUser(), listNamespaces(), showFileFormat(), and useRegex().

Referenced by execute().

◆ replaceTitles()

ReplaceAll::replaceTitles	(	$titles,
		$target,
		$replacement,
		$useRegex,
		$rename )

private

Definition at line 283 of file replaceAll.php.

References $doAnnounce, $job, $rename, $replacement, $target, $title, $titles, $useRegex, Maintenance\error(), and getSummary().

Referenced by execute().

◆ shouldContinueByDefault()

ReplaceAll::shouldContinueByDefault ( )

private

Definition at line 166 of file replaceAll.php.

References $defaultContinue, Maintenance\getOption(), and true.

Referenced by execute(), and getReply().

◆ showFileFormat()

ReplaceAll::showFileFormat ( )

private

Definition at line 199 of file replaceAll.php.

Referenced by localSetup().

◆ useRegex()

ReplaceAll::useRegex ( )

private

Definition at line 263 of file replaceAll.php.

References Maintenance\getOption().

Referenced by execute(), getReplacements(), and localSetup().

Member Data Documentation

◆ $category

ReplaceAll::$category

private

Definition at line 51 of file replaceAll.php.

◆ $defaultContinue

ReplaceAll::$defaultContinue

private

Definition at line 55 of file replaceAll.php.

Referenced by shouldContinueByDefault().

◆ $doAnnounce

ReplaceAll::$doAnnounce

private

Definition at line 56 of file replaceAll.php.

Referenced by replaceTitles().

◆ $namespaces

ReplaceAll::$namespaces

private

Definition at line 50 of file replaceAll.php.

Referenced by getNamespaces().

◆ $prefix

ReplaceAll::$prefix

private

Definition at line 52 of file replaceAll.php.

◆ $rename

ReplaceAll::$rename

private

Definition at line 57 of file replaceAll.php.

Referenced by listTitles(), and replaceTitles().

◆ $replacement

ReplaceAll::$replacement

private

Definition at line 49 of file replaceAll.php.

Referenced by execute(), getSummary(), listTitles(), and replaceTitles().

◆ $target

ReplaceAll::$target

private

Definition at line 48 of file replaceAll.php.

Referenced by execute(), getSummary(), listTitles(), and replaceTitles().

◆ $titles

ReplaceAll::$titles

private

Definition at line 54 of file replaceAll.php.

Referenced by execute(), listTitles(), and replaceTitles().

◆ $user

ReplaceAll::$user

private

Definition at line 47 of file replaceAll.php.

Referenced by getUser().

◆ $useRegex

ReplaceAll::$useRegex

private

Definition at line 53 of file replaceAll.php.

Referenced by execute(), and replaceTitles().

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

extensions/ReplaceText/maintenance/replaceAll.php

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ execute()

◆ getCategory()

◆ getNamespaces()

◆ getPrefix()

◆ getRename()

◆ getReplacement()

◆ getReplacements()

◆ getReply()

◆ getSummary()

◆ getTarget()

◆ getUser()

◆ listNamespaces()

◆ listTitles()

◆ localSetup()

◆ replaceTitles()

◆ shouldContinueByDefault()

◆ showFileFormat()

◆ useRegex()

Member Data Documentation

◆ $category

◆ $defaultContinue

◆ $doAnnounce

◆ $namespaces

◆ $prefix

◆ $rename

◆ $replacement

◆ $target

◆ $titles

◆ $user

◆ $useRegex