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

	execute ()
	Do the actual work. More...

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

Public Member Functions inherited from Maintenance
	cleanupChanneled ()
	Clean up channeled output. More...

	clearParamsAndArgs ()
	Clear all params and arguments. More...

	finalSetup ()
	Handle some last-minute setup here. More...

	getName ()
	Get the script's name. More...

	globals ()
	Potentially debug globals. More...

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

	loadSettings ()
	Generic setup for most installs. More...

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

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

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

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

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

	setup ()
	Do some sanity checking and basic setup. More...

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

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

Static Protected Attributes
static	$ignore = array( 'testRunLegacyHooks' )

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

	getBadHooksFromPath ( $path)
	Get bad hooks from the source code. More...

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

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

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

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

	getHooksFromPath ( $path)
	Get hooks from the source code. More...

	printArray ( $msg, $arr, $sort=true)
	Nicely output the array. More...

Additional Inherited Members
Static Public Member Functions inherited from Maintenance
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. More...

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

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

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

	$mDbPass

const	DB_ADMIN = 2

const	DB_NONE = 0
	Constants for DB access type. More...

const	DB_STD = 1

const	STDIN_ALL = 'all'

Protected Member Functions inherited from Maintenance
	addArg ( $arg, $description, $required=true)
	Add some args that are needed. More...

	addDefaultParams ()
	Add the default parameters to the scripts. More...

	addDescription ( $text)
	Set the description text. More...

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

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

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

	deleteOption ( $name)
	Remove an option. More...

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

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

&	getDB ( $db, $groups=array(), $wiki=false)
	Returns a database to be used by current maintenance script. More...

	getDir ()
	Get the maintenance directory. More...

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

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

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

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

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

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

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

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

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

Protected Attributes inherited from Maintenance
	$mArgList = array()

	$mArgs = array()

int	$mBatchSize = null
	Batch size. More...

	$mDbUser

	$mDescription = ''

	$mInputLoaded = false

	$mOptions = array()

	$mParams = array()

	$mQuiet = false

	$mSelf

	$mShortParamsMap = array()

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 50 of file findHooks.php.

References 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 60 of file findHooks.php.

References $dir, $IP, array(), as, getBadHooksFromPath(), getHooksFromDoc(), getHooksFromPath(), global, Maintenance\output(), and printArray().

◆ getBadHooksFromFile()

FindHooks::getBadHooksFromFile ( $file )

private

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

Parameters

$file string Full filename to the PHP file.

Returns: array of bad wfRunHooks() lines

Definition at line 221 of file findHooks.php.

References $file, array(), and as.

Referenced by getBadHooksFromPath().

◆ getBadHooksFromPath()

FindHooks::getBadHooksFromPath ( $path )

private

Get bad hooks from the source code.

Parameters

$path Directory where the include files can be found

Returns: array of bad wfRunHooks() lines

Definition at line 238 of file findHooks.php.

References $file, $path, array(), and getBadHooksFromFile().

Referenced by execute().

◆ 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: Integer

Reimplemented from Maintenance.

Definition at line 56 of file findHooks.php.

References Maintenance\DB_NONE.

◆ getHooksFromDoc()

FindHooks::getHooksFromDoc ( $doc )

private

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

Returns: array of documented hooks

Definition at line 135 of file findHooks.php.

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

Referenced by execute().

◆ getHooksFromFile()

FindHooks::getHooksFromFile ( $file )

private

Get hooks from a PHP file.

Parameters

$file string Full filename to the PHP file.

Returns: array of hooks found.

Definition at line 190 of file findHooks.php.

References $file, and array().

Referenced by getHooksFromPath().

◆ getHooksFromLocalDoc()

FindHooks::getHooksFromLocalDoc ( $doc )

private

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

Parameters

$doc	string: filename to look in

Returns: array of documented hooks

Definition at line 148 of file findHooks.php.

References array().

Referenced by getHooksFromDoc().

◆ getHooksFromOnlineDoc()

FindHooks::getHooksFromOnlineDoc ( )

private

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

Returns: array of documented hooks

Definition at line 159 of file findHooks.php.

References $matches, array(), as, and Http\get().

Referenced by getHooksFromDoc().

◆ getHooksFromPath()

FindHooks::getHooksFromPath ( $path )

private

Get hooks from the source code.

Parameters

$path Directory where the include files can be found

Returns: array of hooks found.

Definition at line 202 of file findHooks.php.

References $file, $path, array(), and getHooksFromFile().

Referenced by execute().

◆ printArray()

FindHooks::printArray	(	$msg,
		$arr,
		$sort = `true`
	)

private

Nicely output the array.

Parameters

$msg	String: a message to show before the value
$arr	Array: an array
$sort	Boolean: whether to sort the array (Default: true)

Definition at line 259 of file findHooks.php.

References $ignore, $sort, as, and Maintenance\output().

Referenced by execute().

Member Data Documentation

◆ $ignore

FindHooks::$ignore = array( 'testRunLegacyHooks' )

staticprotected

Definition at line 48 of file findHooks.php.

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

maintenance/findHooks.php

Public Member Functions

Static Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ execute()

◆ getBadHooksFromFile()

◆ getBadHooksFromPath()

◆ getDbType()

◆ getHooksFromDoc()

◆ getHooksFromFile()

◆ getHooksFromLocalDoc()

◆ getHooksFromOnlineDoc()

◆ getHooksFromPath()

◆ printArray()

Member Data Documentation

◆ $ignore