MediaWiki  master
FindHooks Class Reference

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

Inheritance diagram for FindHooks:
Collaboration diagram for FindHooks:

Public Member Functions

 __construct ()
 
 execute ()
 
 getDbType ()
 
- Public Member Functions inherited from Maintenance
 __construct ()
 Default constructor. More...
 
 checkRequiredExtensions ()
 Verify that the required extensions are installed. More...
 
 cleanupChanneled ()
 Clean up channeled output. More...
 
 clearParamsAndArgs ()
 Clear all params and arguments. More...
 
 execute ()
 Do the actual work. More...
 
 finalSetup ()
 Handle some last-minute setup here. More...
 
 getConfig ()
 
 getDbType ()
 Does the script need different DB access? By default, we give Maintenance scripts normal rights to the DB. 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...
 
 loadWithArgv ( $argv)
 Load params and arguments from a given array of command-line arguments. 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...
 
 setAgentAndTriggers ()
 Set triggers like when to try to run deferred updates. More...
 
 setConfig (Config $config)
 
 setDB (IMaintainableDatabase $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...
 
 validateParamsAndArgs ()
 Run some validation checks on the params, etc. More...
 

Public Attributes

const FIND_NON_RECURSIVE = 0
 
const FIND_RECURSIVE = 1
 
- Public Attributes inherited from Maintenance
resource $fileHandle
 Used when creating separate schema files. More...
 
 $mDbPass
 
array $orderedOptions = []
 Used to read the options in the order they were passed. More...
 
const DB_ADMIN = 2
 
const DB_NONE = 0
 Constants for DB access type. More...
 
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. More...
 
 getHooksFromDir ( $dir, $recurse=0)
 Get hooks from a directory of PHP files. More...
 
 getHooksFromDoc ( $doc)
 Get the hook documentation, either locally or from MediaWiki.org. More...
 
 getHooksFromFile ( $filePath)
 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...
 
 getHooksFromOnlineDocCategory ( $title)
 
 printArray ( $msg, $arr)
 Nicely sort an print an array. More...
 

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). More...
 
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 requireTestsAutoloader ()
 Call this to set up the autoloader to allow classes to be used from the tests directory. More...
 
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) More...
 
- Protected Member Functions inherited from Maintenance
 activateProfiler ()
 Activate the profiler (assuming $wgProfiler is set) More...
 
 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, $multiOccurrence=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...
 
 beginTransaction (IDatabase $dbw, $fname)
 Begin a transcation on a DB. More...
 
 commitTransaction (IDatabase $dbw, $fname)
 Commit the transcation on a DB handle and wait for replica DBs to catch up. More...
 
 countDown ( $seconds)
 Count down from $seconds to zero on the terminal, with a one-second pause between showing each number. More...
 
 deleteOption ( $name)
 Remove an option. More...
 
 error ( $err, $die=0)
 Throw an error to the user. More...
 
 fatalError ( $msg, $exitCode=1)
 Output a message and terminate the current script. More...
 
 getArg ( $argId=0, $default=null)
 Get an argument. More...
 
 getBatchSize ()
 Returns batch size. More...
 
 getDB ( $db, $groups=[], $dbDomain=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 option 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...
 
 requireExtension ( $name)
 Indicate that the specified extension must be loaded before the script can run. More...
 
 rollbackTransaction (IDatabase $dbw, $fname)
 Rollback the transcation on a DB handle. More...
 
 setAllowUnregisteredOptions ( $allow)
 Sets whether to allow unregistered options, which are options passed to a script that do not match an expected parameter. More...
 
 setBatchSize ( $s=0)
 Set the batch size. More...
 
 supportsOption ( $name)
 Checks to see if a particular option in supported. More...
 
- Protected Attributes inherited from Maintenance
 $mAllowUnregisteredOptions = false
 
 $mArgList = []
 
 $mArgs = []
 
int $mBatchSize = null
 Batch size. More...
 
 $mDbUser
 
 $mDescription = ''
 
 $mInputLoaded = false
 
 $mOptions = []
 
array [] $mParams = []
 Array of desired/allowed params. More...
 
 $mQuiet = false
 
 $mSelf
 
 $mShortParamsMap = []
 

Detailed Description

Maintenance script that compares documented and actually present mismatches.

Definition at line 46 of file findHooks.php.

Constructor & Destructor Documentation

◆ __construct()

FindHooks::__construct ( )

Definition at line 55 of file findHooks.php.

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

Member Function Documentation

◆ execute()

◆ getBadHooksFromFile()

FindHooks::getBadHooksFromFile (   $filePath)
private

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

Parameters
string$filePathFull filename to the PHP file.
Returns
array Array of source code lines

Definition at line 294 of file findHooks.php.

References $content.

Referenced by execute(), and getHooksFromDir().

◆ getDbType()

FindHooks::getDbType ( )

Definition at line 61 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$dirDirectory path to start at
int$recursePass self::FIND_RECURSIVE
Returns
array Array: key => hook name; value => array of arguments or string 'unknown'

Definition at line 312 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 157 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$filePathFull file path to the PHP file.
Returns
array Array: key => hook name; value => array of arguments or string 'unknown'

Definition at line 245 of file findHooks.php.

References $args, and $content.

Referenced by execute(), and getHooksFromDir().

◆ getHooksFromLocalDoc()

FindHooks::getHooksFromLocalDoc (   $doc)
private

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

Parameters
string$docFilename to look in
Returns
array Array: key => hook name; value => array of arguments or string 'unknown'

Definition at line 170 of file findHooks.php.

References $args, and $content.

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

References getHooksFromOnlineDocCategory().

Referenced by getHooksFromDoc().

◆ getHooksFromOnlineDocCategory()

FindHooks::getHooksFromOnlineDocCategory (   $title)
private
Parameters
string$title
Returns
array

Definition at line 209 of file findHooks.php.

References FormatJson\decode(), and wfAppendQuery().

Referenced by getHooksFromOnlineDoc().

◆ printArray()

FindHooks::printArray (   $msg,
  $arr 
)
private

Nicely sort an print an array.

Parameters
string$msgA message to show before the value
array$arr

Definition at line 345 of file findHooks.php.

References Maintenance\output().

Referenced by execute().

Member Data Documentation

◆ $ignore

FindHooks::$ignore = [ 'Test' ]
staticprotected

Definition at line 53 of file findHooks.php.

◆ FIND_NON_RECURSIVE

const FindHooks::FIND_NON_RECURSIVE = 0

Definition at line 47 of file findHooks.php.

◆ FIND_RECURSIVE

const FindHooks::FIND_RECURSIVE = 1

Definition at line 48 of file findHooks.php.


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