Maintenance script that compares documented and actually present mismatches. More...

Inheritance diagram for FindHooks:

Collaboration diagram for FindHooks:

[legend]

Public Member Functions
	__construct ()
	Default constructor.

	execute ()
	Do the actual work.

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

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 ()

	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.

Public Attributes
const	FIND_NON_RECURSIVE = 0

const	FIND_RECURSIVE = 1

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'

Static Protected Attributes
static	$ignore = [ 'Test' ]

Private Member Functions
	getBadHooksFromFile ( $filePath)
	Get bad hooks (where the hook name could not be determined) from a PHP file.

	getHooksFromDir ( $dir, $recurse=0)
	Get hooks from a directory of PHP files.

	getHooksFromDoc ( $doc)
	Get the hook documentation, either locally or from MediaWiki.org.

	getHooksFromFile ( $filePath)
	Get hooks from a PHP file.

	getHooksFromLocalDoc ( $doc)
	Get hooks from a local file (for example docs/hooks.txt)

	getHooksFromOnlineDoc ()
	Get hooks from www.mediawiki.org using the API.

	getHooksFromOnlineDocCategory ( $title)

	printArray ( $msg, $arr)
	Nicely sort an print an array.

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)

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

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

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

Protected Attributes inherited from Maintenance
	$mArgList = []

	$mArgs = []

int	$mBatchSize = null
	Batch size.

	$mDbPass

	$mDbUser

	$mDescription = ''

	$mInputLoaded = false

	$mOptions = []

	$mParams = []

	$mQuiet = false

	$mSelf

	$mShortParamsMap = []

Detailed Description

Maintenance script that compares documented and actually present mismatches.

Definition at line 44 of file findHooks.php.

Constructor & Destructor Documentation

◆ __construct()

FindHooks::__construct ( )

Default constructor.

Children should call this first if implementing their own constructors

Reimplemented from Maintenance.

Definition at line 53 of file findHooks.php.

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

Member Function Documentation

◆ execute()

FindHooks::execute ( )

Do the actual work.

All child classes will need to implement this

Reimplemented from Maintenance.

Definition at line 63 of file findHooks.php.

References $args, $IP, $ret, Maintenance\fatalError(), getBadHooksFromFile(), getHooksFromDir(), getHooksFromDoc(), getHooksFromFile(), output(), and printArray().

◆ getBadHooksFromFile()

FindHooks::getBadHooksFromFile ( $filePath )

private

Get bad hooks (where the hook name could not be determined) from a PHP file.

Parameters

string $filePath Full filename to the PHP file.

Returns: array Array of bad wfRunHooks() lines

Definition at line 292 of file findHooks.php.

Referenced by execute(), and getHooksFromDir().

◆ getDbType()

FindHooks::getDbType ( )

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

Sometimes, a script needs admin rights access for a reason and sometimes they want no access. Subclasses should override and return one of the following values, as needed: Maintenance::DB_NONE - For no DB access at all Maintenance::DB_STD - For normal DB access, default Maintenance::DB_ADMIN - For admin DB access

Returns: int

Reimplemented from Maintenance.

Definition at line 59 of file findHooks.php.

References Maintenance\DB_NONE.

◆ getHooksFromDir()

FindHooks::getHooksFromDir	(		$dir,
			$recurse = 0 )

private

Get hooks from a directory of PHP files.

Parameters

string	$dir	Directory path to start at
int	$recursive	Pass self::FIND_RECURSIVE

Returns: array Array: key => hook name; value => array of arguments or string 'unknown'

Definition at line 311 of file findHooks.php.

References getBadHooksFromFile(), and getHooksFromFile().

Referenced by execute().

◆ getHooksFromDoc()

FindHooks::getHooksFromDoc ( $doc )

private

Get the hook documentation, either locally or from MediaWiki.org.

Parameters

string $doc

Returns: array Array: key => hook name; value => array of arguments or string 'unknown'

Definition at line 155 of file findHooks.php.

References getHooksFromLocalDoc(), getHooksFromOnlineDoc(), and Maintenance\hasOption().

Referenced by execute().

◆ getHooksFromFile()

FindHooks::getHooksFromFile ( $filePath )

private

Get hooks from a PHP file.

Parameters

string $filePath Full file path to the PHP file.

Returns: array Array: key => hook name; value => array of arguments or string 'unknown'

Definition at line 243 of file findHooks.php.

References $args.

Referenced by execute(), and getHooksFromDir().

◆ getHooksFromLocalDoc()

FindHooks::getHooksFromLocalDoc ( $doc )

private

Get hooks from a local file (for example docs/hooks.txt)

Parameters

string $doc Filename to look in

Returns: array Array: key => hook name; value => array of arguments or string 'unknown'

Definition at line 168 of file findHooks.php.

References $args.

Referenced by getHooksFromDoc().

◆ getHooksFromOnlineDoc()

FindHooks::getHooksFromOnlineDoc ( )

private

Get hooks from www.mediawiki.org using the API.

Returns: array Array: key => hook name; value => string 'unknown'

Definition at line 197 of file findHooks.php.

References getHooksFromOnlineDocCategory().

Referenced by getHooksFromDoc().

◆ getHooksFromOnlineDocCategory()

FindHooks::getHooksFromOnlineDocCategory ( $title )

private

Parameters

string $title

Returns: array

Definition at line 207 of file findHooks.php.

References $params, $retval, Http\get(), and wfAppendQuery().

Referenced by getHooksFromOnlineDoc().

◆ printArray()

FindHooks::printArray	(		$msg,
			$arr )

private

Nicely sort an print an array.

Parameters

string	$msg	A message to show before the value
array	$arr

Definition at line 343 of file findHooks.php.

References output().

Referenced by execute().

Member Data Documentation

◆ $ignore

FindHooks::$ignore = [ 'Test' ]

staticprotected

Definition at line 51 of file findHooks.php.

◆ FIND_NON_RECURSIVE

const FindHooks::FIND_NON_RECURSIVE = 0

Definition at line 45 of file findHooks.php.

◆ FIND_RECURSIVE

const FindHooks::FIND_RECURSIVE = 1

Definition at line 46 of file findHooks.php.

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

maintenance/findHooks.php

Public Member Functions

Public Attributes

Static Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ execute()

◆ getBadHooksFromFile()

◆ getDbType()

◆ getHooksFromDir()

◆ getHooksFromDoc()

◆ getHooksFromFile()

◆ getHooksFromLocalDoc()

◆ getHooksFromOnlineDoc()

◆ getHooksFromOnlineDocCategory()

◆ printArray()

Member Data Documentation

◆ $ignore

◆ FIND_NON_RECURSIVE

◆ FIND_RECURSIVE