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. More...

Inheritance diagram for PopulateChangeTagDef:

[legend]

Collaboration diagram for PopulateChangeTagDef:

[legend]

Public Member Functions
	__construct ()
	Default constructor.

Public Member Functions inherited from LoggedUpdateMaintenance
	execute ()
	Do the actual work.

Public Member Functions inherited from Maintenance
function	__construct ()

	checkRequiredExtensions ()
	Verify that the required extensions are installed.

	cleanupChanneled ()
	Clean up channeled output.

	clearParamsAndArgs ()
	Clear all params and arguments.

function	execute ()

	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 (IDatabase $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.

Protected Member Functions
	doDBUpdates ()
	Do the actual work.

	getUpdateKey ()
	Get the update key name to go in the update log table.

Protected Member Functions inherited from LoggedUpdateMaintenance
	updateSkippedMessage ()
	Message to show that the update was done already and was just skipped.

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=[], $wiki=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.

	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
Wikimedia Rdbms ILBFactory	$lbFactory

Protected Attributes inherited from Maintenance
	$mAllowUnregisteredOptions = false

	$mArgList = []

	$mArgs = []

int	$mBatchSize = null
	Batch size.

	$mDbPass

	$mDbUser

	$mDescription = ''

	$mInputLoaded = false

	$mOptions = []

	$mParams = []

	$mQuiet = false

	$mSelf

	$mShortParamsMap = []

Private Member Functions
	backpopulateChangeTagId ()

	backpopulateChangeTagPerTag ( $tagName, $tagId)

	setUserDefinedTags ()

	updateCountTag ()

	updateCountTagId ()

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'

Detailed Description

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 Populate and improve accuracy of change_tag_def statistics.

Definition at line 26 of file populateChangeTagDef.php.

Constructor & Destructor Documentation

◆ __construct()

PopulateChangeTagDef::__construct ( )

Default constructor.

Children should call this first if implementing their own constructors

Reimplemented from LoggedUpdateMaintenance.

Definition at line 30 of file populateChangeTagDef.php.

References Maintenance\addDescription(), Maintenance\addOption(), and Maintenance\setBatchSize().

Member Function Documentation

◆ backpopulateChangeTagId()

PopulateChangeTagDef::backpopulateChangeTagId ( )

private

Definition at line 185 of file populateChangeTagDef.php.

References $dbr, as, backpopulateChangeTagPerTag(), and DB_REPLICA.

Referenced by doDBUpdates().

◆ backpopulateChangeTagPerTag()

PopulateChangeTagDef::backpopulateChangeTagPerTag	(	$tagName,
		$tagId
	)

private

Definition at line 200 of file populateChangeTagDef.php.

References $dbr, DB_MASTER, DB_REPLICA, Maintenance\getBatchSize(), Maintenance\getOption(), Maintenance\hasOption(), and Maintenance\output().

Referenced by backpopulateChangeTagId().

◆ doDBUpdates()

PopulateChangeTagDef::doDBUpdates ( )

protected

Do the actual work.

All child classes will need to implement this. Return true to log the update as done or false (usually on failure).

Returns: bool

Reimplemented from LoggedUpdateMaintenance.

Definition at line 45 of file populateChangeTagDef.php.

References backpopulateChangeTagId(), DB_REPLICA, Maintenance\getBatchSize(), Maintenance\getOption(), Maintenance\hasOption(), Maintenance\setBatchSize(), setUserDefinedTags(), updateCountTag(), and updateCountTagId().

◆ getUpdateKey()

PopulateChangeTagDef::getUpdateKey ( )

protected

Get the update key name to go in the update log table.

Returns: string

Reimplemented from LoggedUpdateMaintenance.

Definition at line 246 of file populateChangeTagDef.php.

◆ setUserDefinedTags()

PopulateChangeTagDef::setUserDefinedTags ( )

private

Definition at line 74 of file populateChangeTagDef.php.

References $dbr, DB_MASTER, DB_REPLICA, Maintenance\hasOption(), and Maintenance\output().

Referenced by doDBUpdates().

◆ updateCountTag()

PopulateChangeTagDef::updateCountTag ( )

private

Definition at line 145 of file populateChangeTagDef.php.

References $dbr, $res, as, DB_MASTER, DB_REPLICA, Maintenance\hasOption(), and Maintenance\output().

Referenced by doDBUpdates().

◆ updateCountTagId()

PopulateChangeTagDef::updateCountTagId ( )

private

Definition at line 111 of file populateChangeTagDef.php.

References $dbr, $res, as, DB_MASTER, DB_REPLICA, Maintenance\hasOption(), and Maintenance\output().

Referenced by doDBUpdates().

Member Data Documentation

◆ $lbFactory

Wikimedia Rdbms ILBFactory PopulateChangeTagDef::$lbFactory

protected

Definition at line 28 of file populateChangeTagDef.php.

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

maintenance/populateChangeTagDef.php

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ backpopulateChangeTagId()

◆ backpopulateChangeTagPerTag()

◆ doDBUpdates()

◆ getUpdateKey()

◆ setUserDefinedTags()

◆ updateCountTag()

◆ updateCountTagId()

Member Data Documentation

◆ $lbFactory