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

Inheritance diagram for FindHooks:

Collaboration diagram for FindHooks:

Public Member Functions
	__construct ()
	execute ()
	getDbType ()
	Does the script need different DB access? By default, we give Maintenance scripts normal rights to the DB.
Private Member Functions
	getBadHooksFromFile ($file)
	Get bad hooks (where the hook name could not be determined) from a PHP file.
	getBadHooksFromPath ($path)
	Get bad hooks from the source code.
	getHooksFromDoc ($doc)
	Get the hook documentation, either locally or from MediaWiki.org.
	getHooksFromFile ($file)
	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.
	getHooksFromPath ($path)
	Get hooks from the source code.
	printArray ($msg, $arr, $sort=true)
	Nicely output the array.

Detailed Description

Maintenance script that compares documented and actually present mismatches.

Definition at line 44 of file findHooks.php.

Constructor & Destructor Documentation

FindHooks::__construct ( )

Reimplemented from Maintenance.

Definition at line 45 of file findHooks.php.

References Maintenance\addOption().

Member Function Documentation

FindHooks::execute ( )

Reimplemented from Maintenance.

Definition at line 55 of file findHooks.php.

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

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

References $file, array(), and as.

Referenced by 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 219 of file findHooks.php.

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

Referenced by execute().

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