MediaWiki\Extension\Translate\Statistics\StatsTable Class Reference

Implements generation of HTML stats table. More...

Public Member Functions
	__construct (LinkRenderer $linkRenderer, ConfigHelper $configHelper, MessageLocalizer $messageLocalizer, Language $language)
	element (string $in, string $bgcolor='', string $sort='')
	Statistics table element (heading or regular cell)
	getBackgroundColor (float $percentage, bool $fuzzy=false)
	setMainColumnHeader (Message $msg)
	addExtraColumn (Message $column)
	createHeader ()
	makeTotalRow (Message $message, array $stats)
	Makes a row with aggregate numbers.
	makeNumberColumns (array $stats)
	Makes partial row from completion numbers.
	makeWorkflowStateCell (?string $state, MessageGroup $group, string $language)
	formatPercentage ( $num, string $to='floor')
	Makes a nice print from plain float.
	makeGroupLink (MessageGroup $group, string $code, array $params)
	Gets the name of group linked to translation tool.
	isExcluded (MessageGroup $group, string $code)
	Check whether translations in given group in given language has been disabled.

Protected Attributes
TitleValue	$translate
Language	$language
string	$mainColumnHeader
array	$extraColumns = []

Detailed Description

Implements generation of HTML stats table.

Author

Siebrand Mazeland

Niklas Laxström @license GPL-2.0-or-later

Definition at line 26 of file StatsTable.php.

Constructor & Destructor Documentation

__construct()

MediaWiki\Extension\Translate\Statistics\StatsTable::__construct	(	LinkRenderer	$linkRenderer,
		ConfigHelper	$configHelper,
		MessageLocalizer	$messageLocalizer,
		Language	$language )

Definition at line 36 of file StatsTable.php.

Member Function Documentation

addExtraColumn()

MediaWiki\Extension\Translate\Statistics\StatsTable::addExtraColumn

(

Message

$column

)

Definition at line 109 of file StatsTable.php.

createHeader()

MediaWiki\Extension\Translate\Statistics\StatsTable::createHeader

(

)

Returns

string HTML

Definition at line 125 of file StatsTable.php.

element()

MediaWiki\Extension\Translate\Statistics\StatsTable::element	(	string	$in,
		string	$bgcolor = '',
		string	$sort = '' )

Statistics table element (heading or regular cell)

Parameters

string	$in	Element contents.
string	$bgcolor	Backround color in ABABAB format.
string	$sort	Value used for sorting.

Returns

string Html td element.

Definition at line 56 of file StatsTable.php.

formatPercentage()

MediaWiki\Extension\Translate\Statistics\StatsTable::formatPercentage	(		$num,
		string	$to = 'floor' )

Makes a nice print from plain float.

Parameters

int | float	$num
string	$to	floor or ceil

Returns

string Plain text

Definition at line 248 of file StatsTable.php.

getBackgroundColor()

MediaWiki\Extension\Translate\Statistics\StatsTable::getBackgroundColor	(	float	$percentage,
		bool	$fuzzy = false )

Definition at line 72 of file StatsTable.php.

isExcluded()

MediaWiki\Extension\Translate\Statistics\StatsTable::isExcluded	(	MessageGroup	$group,
		string	$code )

Check whether translations in given group in given language has been disabled.

Parameters

MessageGroup	$group	Message group
string	$code	Language code

Definition at line 297 of file StatsTable.php.

makeGroupLink()

MediaWiki\Extension\Translate\Statistics\StatsTable::makeGroupLink	(	MessageGroup	$group,
		string	$code,
		array	$params )

Gets the name of group linked to translation tool.

Parameters

MessageGroup	$group
string	$code	Language code
array	$params	Any extra query parameters.

Returns

string HTML

Definition at line 277 of file StatsTable.php.

makeNumberColumns()

MediaWiki\Extension\Translate\Statistics\StatsTable::makeNumberColumns

(

array

$stats

)

Makes partial row from completion numbers.

Returns

string HTML

Definition at line 165 of file StatsTable.php.

makeTotalRow()

MediaWiki\Extension\Translate\Statistics\StatsTable::makeTotalRow	(	Message	$message,
		array	$stats )

Makes a row with aggregate numbers.

Parameters

Message	$message
array	$stats	( total, translate, fuzzy )

Returns

string HTML

Definition at line 152 of file StatsTable.php.

makeWorkflowStateCell()

MediaWiki\Extension\Translate\Statistics\StatsTable::makeWorkflowStateCell	(	?string	$state,
		MessageGroup	$group,
		string	$language )

Definition at line 212 of file StatsTable.php.

setMainColumnHeader()

MediaWiki\Extension\Translate\Statistics\StatsTable::setMainColumnHeader

(

Message

$msg

)

Definition at line 100 of file StatsTable.php.

Member Data Documentation

$extraColumns

array MediaWiki\Extension\Translate\Statistics\StatsTable::$extraColumns = []

protected

Definition at line 34 of file StatsTable.php.

$language

Language MediaWiki\Extension\Translate\Statistics\StatsTable::$language

protected

Definition at line 31 of file StatsTable.php.

$mainColumnHeader

string MediaWiki\Extension\Translate\Statistics\StatsTable::$mainColumnHeader

protected

Definition at line 32 of file StatsTable.php.

$translate

TitleValue MediaWiki\Extension\Translate\Statistics\StatsTable::$translate

protected

Definition at line 27 of file StatsTable.php.

---

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

• src/Statistics/StatsTable.php