Inheritance diagram for CheckLanguageCLI:

Public Member Functions
	__construct (array $options)

	execute ()
	Execute the script.

	outputWiki ()
	Output the checks results as wiki text.

Protected Member Functions
	checkLanguage ( $code)
	Check a language.

	defaultChecks ()
	Get the default checks.

	doChecks ()
	Execute the checks.

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

	formatKey ( $key, $code)
	Format a message key.

	getCheckBlacklist ()
	Get the check blacklist.

	getChecks ()
	Get all checks.

	getDescriptions ()
	Get all check descriptions.

	getTotalCount ()
	Get total count for each check non-messages check.

	help ()
	Get help.

	isCheckBlacklisted ( $check, $code, $message)
	Verify whether a check is blacklisted.

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

	nonMessageChecks ()
	Get the checks which check other things than messages.

	outputText ()
	Output the checks results as plain text.

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

◆ __construct()

CheckLanguageCLI::__construct ( array $options )

Parameters

array $options Options for script.

Definition at line 45 of file checkLanguage.inc.

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

Member Function Documentation

◆ checkLanguage()

CheckLanguageCLI::checkLanguage ( $code )

protected

Check a language.

Parameters

string $code The language code.

Exceptions

MWException

Returns: array The results.

Reimplemented in CheckExtensionsCLI.

Definition at line 383 of file checkLanguage.inc.

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

Referenced by doChecks(), and help().

◆ defaultChecks()

CheckLanguageCLI::defaultChecks ( )

protected

Get the default checks.

Returns: array A list of the default checks.

Reimplemented in CheckExtensionsCLI.

Definition at line 98 of file checkLanguage.inc.

Referenced by __construct().

◆ doChecks()

CheckLanguageCLI::doChecks ( )

protected

Execute the checks.

Definition at line 293 of file checkLanguage.inc.

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

Referenced by execute(), and CheckExtensionsCLI\execute().

◆ easyChecks()

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.

Reimplemented in CheckExtensionsCLI.

Definition at line 122 of file checkLanguage.inc.

Referenced by __construct().

◆ execute()

CheckLanguageCLI::execute ( )

Execute the script.

Reimplemented in CheckExtensionsCLI.

Definition at line 274 of file checkLanguage.inc.

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

◆ formatKey()

CheckLanguageCLI::formatKey	(		$key,
			$code )

protected

Format a message key.

Parameters

string	$key	The message key.
string	$code	The language code.

Returns: string The formatted message key.

Definition at line 415 of file checkLanguage.inc.

References $code.

Referenced by outputText(), and outputWiki().

◆ getCheckBlacklist()

CheckLanguageCLI::getCheckBlacklist ( )

protected

Get the check blacklist.

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

Definition at line 328 of file checkLanguage.inc.

References $checkBlacklist.

Referenced by isCheckBlacklisted().

◆ getChecks()

CheckLanguageCLI::getChecks ( )

protected

Get all checks.

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

Definition at line 133 of file checkLanguage.inc.

Referenced by checkLanguage().

◆ getDescriptions()

CheckLanguageCLI::getDescriptions ( )

protected

Get all check descriptions.

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

Definition at line 180 of file checkLanguage.inc.

Referenced by outputText().

◆ getTotalCount()

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 163 of file checkLanguage.inc.

Referenced by outputText().

◆ help()

CheckLanguageCLI::help ( )

protected

Get help.

Returns: string The help string.

Reimplemented in CheckExtensionsCLI.

Definition at line 212 of file checkLanguage.inc.

References $1, broken, check, checkLanguage(), code, complete, contains, file, form, help(), in, language(), line, links, list, messages, output(), pages, project, settings, used, values, and were.

Referenced by __construct(), and help().

◆ isCheckBlacklisted()

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

protected

Verify whether a check is blacklisted.

Parameters

string	$check	Check name
string	$code	Language code
string \| bool	$message	Message name, or False for a whole language

Returns: bool Whether the check is blacklisted

Definition at line 353 of file checkLanguage.inc.

References $code, and getCheckBlacklist().

Referenced by checkLanguage(), and doChecks().

◆ isEmpty()

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 538 of file checkLanguage.inc.

References $messages, and $results.

Referenced by CheckExtensionsCLI\checkLanguage().

◆ nonMessageChecks()

CheckLanguageCLI::nonMessageChecks ( )

protected

Get the checks which check other things than messages.

Returns: array A list of the non-message checks.

Reimplemented in CheckExtensionsCLI.

Definition at line 111 of file checkLanguage.inc.

Referenced by outputText(), and outputWiki().

◆ outputText()

CheckLanguageCLI::outputText ( )

protected

Output the checks results as plain text.

Definition at line 431 of file checkLanguage.inc.

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

Referenced by CheckExtensionsCLI\checkLanguage(), and execute().

◆ outputWiki()

CheckLanguageCLI::outputWiki ( )

Output the checks results as wiki text.

Definition at line 476 of file checkLanguage.inc.

References $code, $messages, $results, $rows, formatKey(), SpecialVersion\getVersion(), nonMessageChecks(), and style.

Referenced by CheckExtensionsCLI\checkLanguage(), and execute().

Member Data Documentation

◆ $checkAll

CheckLanguageCLI::$checkAll = false

protected

Definition at line 33 of file checkLanguage.inc.

◆ $checks

CheckLanguageCLI::$checks = []

protected

Definition at line 35 of file checkLanguage.inc.

Referenced by doChecks().

◆ $code

CheckLanguageCLI::$code = null

protected

Definition at line 28 of file checkLanguage.inc.

Referenced by checkLanguage(), CheckExtensionsCLI\checkLanguage(), doChecks(), formatKey(), isCheckBlacklisted(), outputText(), and outputWiki().

◆ $doLinks

CheckLanguageCLI::$doLinks = false

protected

Definition at line 30 of file checkLanguage.inc.

◆ $includeExif

CheckLanguageCLI::$includeExif = false

private

Definition at line 40 of file checkLanguage.inc.

◆ $L

CheckLanguageCLI::$L = null

protected

Definition at line 36 of file checkLanguage.inc.

Referenced by checkLanguage(), and outputText().

◆ $level

CheckLanguageCLI::$level = 2

protected

Definition at line 29 of file checkLanguage.inc.

◆ $linksPrefix

CheckLanguageCLI::$linksPrefix = ''

protected

Definition at line 31 of file checkLanguage.inc.

◆ $output

CheckLanguageCLI::$output = 'plain'

protected

Definition at line 34 of file checkLanguage.inc.

◆ $results

CheckLanguageCLI::$results = []

protected

Definition at line 38 of file checkLanguage.inc.

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

◆ $wikiCode

CheckLanguageCLI::$wikiCode = 'en'

protected

Definition at line 32 of file checkLanguage.inc.

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

maintenance/language/checkLanguage.inc

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkLanguage()

◆ defaultChecks()

◆ doChecks()

◆ easyChecks()

◆ execute()

◆ formatKey()

◆ getCheckBlacklist()

◆ getChecks()

◆ getDescriptions()

◆ getTotalCount()

◆ help()

◆ isCheckBlacklisted()

◆ isEmpty()

◆ nonMessageChecks()

◆ outputText()

◆ outputWiki()

Member Data Documentation

◆ $checkAll

◆ $checks

◆ $code

◆ $doLinks

◆ $includeExif

◆ $L

◆ $level

◆ $linksPrefix

◆ $output

◆ $results

◆ $wikiCode