MediaWiki
1.28.0
|
Maintenance script to check syntax of all PHP files in MediaWiki. More...
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 (IDatabase $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... | |
Public Attributes | |
$mFailures = [] | |
$mNoStyleCheckPaths = [] | |
$mWarnings = [] | |
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' |
Private Member Functions | |
addDirectoryContent ($dir) | |
Add all suitable files in given directory or its subdirectories to the file list. More... | |
addFileOrDir ($path) | |
Add given file to file list, or, if it's a directory, add its content. More... | |
addPath ($path) | |
Add given path to file list, searching it in include path if needed. More... | |
buildFileList () | |
Build the list of files we'll check for syntax errors. More... | |
checkEvilToken ($file, $tokens, $evilToken, $desc) | |
checkFileWithCli ($file) | |
Check a file for syntax errors using php -l. More... | |
checkForMistakes ($file) | |
Check a file for non-fatal coding errors, such as byte-order marks in the beginning or pointless ?> closing tags at the end. More... | |
checkRegex ($file, $text, $regex, $desc) | |
getGitModifiedFiles ($path) | |
Returns a list of tracked files in a Git work tree differing from the master branch. More... | |
isSuitableFile ($file) | |
Returns true if $file is of a type we can check. More... | |
Private Attributes | |
$mFiles = [] | |
$mIgnorePaths = [] | |
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 | requireTestsAutoloader () |
Call this to set up the autoloader to allow classes to be used from the tests directory. More... | |
static | setLBFactoryTriggers (LBFactory $LBFactory) |
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... | |
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=[], $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... | |
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... | |
setBatchSize ($s=0) | |
Set the batch size. More... | |
validateParamsAndArgs () | |
Run some validation checks on the params, etc. More... | |
Protected Attributes inherited from Maintenance | |
$mArgList = [] | |
$mArgs = [] | |
int | $mBatchSize = null |
Batch size. More... | |
$mDbUser | |
$mDescription = '' | |
$mInputLoaded = false | |
$mOptions = [] | |
$mParams = [] | |
$mQuiet = false | |
$mSelf | |
$mShortParamsMap = [] | |
Maintenance script to check syntax of all PHP files in MediaWiki.
Definition at line 31 of file checkSyntax.php.
CheckSyntax::__construct | ( | ) |
Definition at line 37 of file checkSyntax.php.
References Maintenance\addDescription(), and Maintenance\addOption().
|
private |
Add all suitable files in given directory or its subdirectories to the file list.
string | $dir | Directory to process |
Definition at line 272 of file checkSyntax.php.
References $dir, as, and isSuitableFile().
Referenced by addFileOrDir(), and buildFileList().
|
private |
Add given file to file list, or, if it's a directory, add its content.
string | $path |
Definition at line 255 of file checkSyntax.php.
References $path, and addDirectoryContent().
Referenced by addPath().
|
private |
Add given path to file list, searching it in include path if needed.
string | $path |
Definition at line 244 of file checkSyntax.php.
References $IP, $path, addFileOrDir(), and global.
Referenced by buildFileList().
|
private |
Build the list of files we'll check for syntax errors.
Definition at line 83 of file checkSyntax.php.
References $dirs, $files, $IP, $path, addDirectoryContent(), addPath(), as, Maintenance\error(), getGitModifiedFiles(), Maintenance\getOption(), global, Maintenance\hasOption(), isSuitableFile(), and Maintenance\output().
Referenced by execute().
|
private |
Definition at line 336 of file checkSyntax.php.
References $tokens, and Maintenance\output().
Referenced by checkForMistakes().
|
private |
Check a file for syntax errors using php -l.
string | $file | Path to a file to check for syntax errors |
Definition at line 289 of file checkSyntax.php.
References $res, Maintenance\output(), and wfEscapeShellArg().
Referenced by execute().
|
private |
Check a file for non-fatal coding errors, such as byte-order marks in the beginning or pointless ?> closing tags at the end.
string | $file | String Path to a file to check for errors |
Definition at line 307 of file checkSyntax.php.
References $tokens, as, checkEvilToken(), and checkRegex().
Referenced by execute().
|
private |
Definition at line 324 of file checkSyntax.php.
References Maintenance\output().
Referenced by checkForMistakes().
CheckSyntax::execute | ( | ) |
Definition at line 65 of file checkSyntax.php.
References as, buildFileList(), checkFileWithCli(), checkForMistakes(), Maintenance\hasOption(), and Maintenance\output().
CheckSyntax::getDbType | ( | ) |
Definition at line 61 of file checkSyntax.php.
References Maintenance\DB_NONE.
|
private |
Returns a list of tracked files in a Git work tree differing from the master branch.
string | $path | Path to the repository |
Definition at line 170 of file checkSyntax.php.
References $output, $path, $retval, Maintenance\error(), global, wfEscapeShellArg(), and wfShellExec().
Referenced by buildFileList().
|
private |
Returns true if $file is of a type we can check.
string | $file |
Definition at line 223 of file checkSyntax.php.
Referenced by addDirectoryContent(), and buildFileList().
CheckSyntax::$mFailures = [] |
Definition at line 34 of file checkSyntax.php.
|
private |
Definition at line 34 of file checkSyntax.php.
|
private |
Definition at line 35 of file checkSyntax.php.
CheckSyntax::$mNoStyleCheckPaths = [] |
Definition at line 35 of file checkSyntax.php.
CheckSyntax::$mWarnings = [] |
Definition at line 34 of file checkSyntax.php.