MediaWiki  1.28.0
CheckLanguageCLI Class Reference
Inheritance diagram for CheckLanguageCLI:

Public Member Functions

 __construct (array $options)
 Constructor. More...
 
 execute ()
 Execute the script. More...
 
 outputWiki ()
 Output the checks results as wiki text. More...
 

Protected Member Functions

 checkLanguage ($code)
 Check a language. More...
 
 defaultChecks ()
 Get the default checks. More...
 
 doChecks ()
 Execute the checks. More...
 
 easyChecks ()
 Get the checks that can easily be treated by non-speakers of the language. More...
 
 formatKey ($key, $code)
 Format a message key. More...
 
 getCheckBlacklist ()
 Get the check blacklist. More...
 
 getChecks ()
 Get all checks. More...
 
 getDescriptions ()
 Get all check descriptions. More...
 
 getTotalCount ()
 Get total count for each check non-messages check. More...
 
 help ()
 Get help. More...
 
 isCheckBlacklisted ($check, $code, $message)
 Verify whether a check is blacklisted. More...
 
 isEmpty ()
 Check if there are any results for the checks, in any language. More...
 
 nonMessageChecks ()
 Get the checks which check other things than messages. More...
 
 outputText ()
 Output the checks results as plain text. More...
 

Protected Attributes

 $checkAll = false
 
 $checks = []
 
 $code = null
 
 $doLinks = false
 
 $L = null
 
 $level = 2
 
 $linksPrefix = ''
 
 $output = 'plain'
 
 $results = []
 
 $wikiCode = 'en'
 

Private Attributes

 $includeExif = false
 

Detailed Description

Definition at line 27 of file checkLanguage.inc.

Constructor & Destructor Documentation

CheckLanguageCLI::__construct ( array  $options)

Constructor.

Parameters
array$optionsOptions for script.

Definition at line 46 of file checkLanguage.inc.

References $wgLanguageCode, code, defaultChecks(), easyChecks(), global, help(), and output().

Member Function Documentation

CheckLanguageCLI::checkLanguage (   $code)
protected

Check a language.

Parameters
string$codeThe language code.
Exceptions
MWException
Returns
array The results.

Definition at line 385 of file checkLanguage.inc.

References $code, $L, $results, as, getChecks(), and isCheckBlacklisted().

Referenced by doChecks(), and help().

CheckLanguageCLI::defaultChecks ( )
protected

Get the default checks.

Returns
array A list of the default checks.

Definition at line 99 of file checkLanguage.inc.

Referenced by __construct().

CheckLanguageCLI::doChecks ( )
protected

Execute the checks.

Definition at line 294 of file checkLanguage.inc.

References $checks, $code, $messages, $results, as, checkLanguage(), code, and isCheckBlacklisted().

Referenced by execute().

CheckLanguageCLI::easyChecks ( )
protected

Get the checks that can easily be treated by non-speakers of the language.

Returns
array A list of the easy checks.

Definition at line 123 of file checkLanguage.inc.

Referenced by __construct().

CheckLanguageCLI::execute ( )

Execute the script.

Definition at line 275 of file checkLanguage.inc.

References doChecks(), output(), outputText(), and outputWiki().

CheckLanguageCLI::formatKey (   $key,
  $code 
)
protected

Format a message key.

Parameters
string$keyThe message key.
string$codeThe language code.
Returns
string The formatted message key.

Definition at line 417 of file checkLanguage.inc.

References $code.

Referenced by outputText().

CheckLanguageCLI::getCheckBlacklist ( )
protected

Get the check blacklist.

Returns
array The list of checks which should not be executed.

Definition at line 329 of file checkLanguage.inc.

References $checkBlacklist, global, and Hooks\run().

Referenced by isCheckBlacklisted().

CheckLanguageCLI::getChecks ( )
protected

Get all checks.

Returns
array An array of all check names mapped to their function names.

Definition at line 134 of file checkLanguage.inc.

Referenced by checkLanguage().

CheckLanguageCLI::getDescriptions ( )
protected

Get all check descriptions.

Returns
array An array of all check names mapped to their descriptions.

Definition at line 181 of file checkLanguage.inc.

Referenced by outputText().

CheckLanguageCLI::getTotalCount ( )
protected

Get total count for each check non-messages check.

Returns
array An array of all check names mapped to a two-element array: function name to get the total count and language code or null for checked code.

Definition at line 164 of file checkLanguage.inc.

Referenced by outputText().

CheckLanguageCLI::help ( )
protected

Get help.

Returns
string The help string.

Definition at line 213 of file checkLanguage.inc.

References add, and(), are, broken, by, check, checkLanguage(), code, complete, content, display, errors, file, following, form, headers, in, is(), line, links, list, message, messages, names, not, of, on, or, other(), output(), page, pages, project, settings, Special, that, the, Makefile\translate(), used, values, well, were, and wiki.

Referenced by __construct().

CheckLanguageCLI::isCheckBlacklisted (   $check,
  $code,
  $message 
)
protected

Verify whether a check is blacklisted.

Parameters
string$checkCheck name
string$codeLanguage code
string | bool$messageMessage name, or False for a whole language
Returns
bool Whether the check is blacklisted

Definition at line 355 of file checkLanguage.inc.

References $code, as, and getCheckBlacklist().

Referenced by checkLanguage(), and doChecks().

CheckLanguageCLI::isEmpty ( )
protected

Check if there are any results for the checks, in any language.

Returns
bool True if there are any results, false if not.

Definition at line 540 of file checkLanguage.inc.

References $messages, $results, and as.

CheckLanguageCLI::nonMessageChecks ( )
protected

Get the checks which check other things than messages.

Returns
array A list of the non-message checks.

Definition at line 112 of file checkLanguage.inc.

Referenced by outputText(), and outputWiki().

CheckLanguageCLI::outputText ( )
protected

Output the checks results as plain text.

Definition at line 433 of file checkLanguage.inc.

References $code, $count, $L, $messages, $results, $value, as, formatKey(), getDescriptions(), getTotalCount(), and nonMessageChecks().

Referenced by execute().

CheckLanguageCLI::outputWiki ( )

Output the checks results as wiki text.

Definition at line 478 of file checkLanguage.inc.

References $code, $messages, $results, as, and nonMessageChecks().

Referenced by execute().

Member Data Documentation

CheckLanguageCLI::$checkAll = false
protected

Definition at line 33 of file checkLanguage.inc.

CheckLanguageCLI::$checks = []
protected

Definition at line 35 of file checkLanguage.inc.

Referenced by doChecks().

CheckLanguageCLI::$code = null
protected
CheckLanguageCLI::$doLinks = false
protected

Definition at line 30 of file checkLanguage.inc.

CheckLanguageCLI::$includeExif = false
private

Definition at line 40 of file checkLanguage.inc.

CheckLanguageCLI::$L = null
protected

Definition at line 36 of file checkLanguage.inc.

Referenced by checkLanguage(), and outputText().

CheckLanguageCLI::$level = 2
protected

Definition at line 29 of file checkLanguage.inc.

CheckLanguageCLI::$linksPrefix = ''
protected

Definition at line 31 of file checkLanguage.inc.

CheckLanguageCLI::$output = 'plain'
protected

Definition at line 34 of file checkLanguage.inc.

CheckLanguageCLI::$results = []
protected

Definition at line 38 of file checkLanguage.inc.

Referenced by checkLanguage(), doChecks(), isEmpty(), outputText(), and outputWiki().

CheckLanguageCLI::$wikiCode = 'en'
protected

Definition at line 32 of file checkLanguage.inc.


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