A helper class added to work with configuration values of the Translate Extension. More...

Public Member Functions
	getValidationExclusionFile ()

	getTranslateAuthorExclusionList ()

	getDisabledTargetLanguages ()

	isTargetLanguageDisabled (MessageGroup $group, string $languageCode, ?string &$reason=null)
	Helper to validate MessageGroup::getTranslatableLanguage against site configuration.

	canSeeExcludedLanguageStats (Authority $authority, int $translated, int $fuzzy)
	Whether an excluded language group with existing translations should be visible to the given user.

	isAuthorExcluded (MessageGroup\|string $group, string $languageCode, string $username)

Detailed Description

A helper class added to work with configuration values of the Translate Extension.

Also used temporarily to simplify deprecation of old configuration variables. New variable names, if set, are given preference over the old ones. See: https://phabricator.wikimedia.org/T277965

Author: Abijeet Patro. @license GPL-2.0-or-later

Since: 2021.06

Definition at line 20 of file ConfigHelper.php.

Member Function Documentation

◆ canSeeExcludedLanguageStats()

MediaWiki\Extension\Translate\Utilities\ConfigHelper::canSeeExcludedLanguageStats	(	Authority	$authority,
		int	$translated,
		int	$fuzzy )

Whether an excluded language group with existing translations should be visible to the given user.

Users with the 'pagetranslation' right (i.e. translation admins) can see disabled-language groups that already have translations; everyone else has them hidden as before.

Parameters

Authority	$authority	The current user.
int	$translated	Number of translated messages.
int	$fuzzy	Number of fuzzy messages.

Definition at line 89 of file ConfigHelper.php.

◆ getDisabledTargetLanguages()

MediaWiki\Extension\Translate\Utilities\ConfigHelper::getDisabledTargetLanguages ( )

Definition at line 32 of file ConfigHelper.php.

◆ getTranslateAuthorExclusionList()

MediaWiki\Extension\Translate\Utilities\ConfigHelper::getTranslateAuthorExclusionList ( )

Definition at line 27 of file ConfigHelper.php.

◆ getValidationExclusionFile()

MediaWiki\Extension\Translate\Utilities\ConfigHelper::getValidationExclusionFile ( )

Returns: bool|string

Definition at line 22 of file ConfigHelper.php.

◆ isAuthorExcluded()

MediaWiki\Extension\Translate\Utilities\ConfigHelper::isAuthorExcluded	(	MessageGroup\|string	$group,
		string	$languageCode,
		string	$username )

Definition at line 100 of file ConfigHelper.php.

◆ isTargetLanguageDisabled()

MediaWiki\Extension\Translate\Utilities\ConfigHelper::isTargetLanguageDisabled	(	MessageGroup	$group,
		string	$languageCode,
		?string &	$reason = null )

Helper to validate MessageGroup::getTranslatableLanguage against site configuration.