wikimedia/mediawiki-extensions-TemplateData
1
0
Fork 0
mirror of https://gerrit.wikimedia.org/r/mediawiki/extensions/TemplateData synced 2024-11-27 17:20:01 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge "Inject localizer service into HTML formatter class"

Browse source
This commit is contained in:
jenkins-bot 2022-02-02 11:54:05 +00:00 committed by Gerrit Code Review
parent 606ed3642b 94573e1152
commit deeea30725
3 changed files with 56 additions and 22 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
includes/TemplateDataBlob.php
View file

@ -231,8 +231,8 @@ class TemplateDataBlob {
* @return string
*/
public function getHtml( Language $lang ): string {
$formatter = new TemplateDataHtmlFormatter();
return $formatter->getHtml( $this->getDataInLanguage( $lang->getCode() ), $lang );
$formatter = new TemplateDataHtmlFormatter( new TemplateDataMessageLocalizer( $lang ) );
return $formatter->getHtml( $this->getDataInLanguage( $lang->getCode() ) );
}
/**

49
includes/TemplateDataHtmlFormatter.php
View file

@ -3,18 +3,27 @@
namespace MediaWiki\Extension\TemplateData;
use Html;
use Language;
use MessageLocalizer;
use stdClass;
class TemplateDataHtmlFormatter {
/** @var MessageLocalizer */
private $localizer;
/**
* @param MessageLocalizer $localizer
*/
public function __construct( MessageLocalizer $localizer ) {
$this->localizer = $localizer;
}
/**
* @param stdClass $data
* @param Language $lang
*
* @return string
*/
public function getHtml( stdClass $data, Language $lang ): string {
public function getHtml( stdClass $data ): string {
if ( is_string( $data->format ) && isset( TemplateDataValidator::PREDEFINED_FORMATS[$data->format] ) ) {
// The following icon names are used here:
// * template-format-block
@ -35,13 +44,13 @@ class TemplateDataHtmlFormatter {
]
],
$data->description ??
wfMessage( 'templatedata-doc-desc-empty' )->inLanguage( $lang )->text()
$this->localizer->msg( 'templatedata-doc-desc-empty' )->text()
)
. '</header>'
. '<table class="wikitable mw-templatedata-doc-params' . $sorting . '">'
. Html::rawElement( 'caption', [],
Html::element( 'p', [],
wfMessage( 'templatedata-doc-params' )->inLanguage( $lang )->text()
$this->localizer->msg( 'templatedata-doc-params' )->text()
)
. ( $formatMsg !== null ?
Html::rawElement( 'p', [],
@ -53,7 +62,7 @@ class TemplateDataHtmlFormatter {
// * templatedata-doc-format-block
// * templatedata-doc-format-custom
// * templatedata-doc-format-inline
wfMessage( 'templatedata-doc-format-' . $formatMsg )->inLanguage( $lang )->text()
$this->localizer->msg( 'templatedata-doc-format-' . $formatMsg )->text()
)
) :
''
@ -61,16 +70,16 @@ class TemplateDataHtmlFormatter {
)
. '<thead><tr>'
. Html::element( 'th', [ 'colspan' => 2 ],
wfMessage( 'templatedata-doc-param-name' )->inLanguage( $lang )->text()
$this->localizer->msg( 'templatedata-doc-param-name' )->text()
)
. Html::element( 'th', [],
wfMessage( 'templatedata-doc-param-desc' )->inLanguage( $lang )->text()
$this->localizer->msg( 'templatedata-doc-param-desc' )->text()
)
. Html::element( 'th', [],
wfMessage( 'templatedata-doc-param-type' )->inLanguage( $lang )->text()
$this->localizer->msg( 'templatedata-doc-param-type' )->text()
)
. Html::element( 'th', [],
wfMessage( 'templatedata-doc-param-status' )->inLanguage( $lang )->text()
$this->localizer->msg( 'templatedata-doc-param-status' )->text()
)
. '</tr></thead>'
. '<tbody>';
@ -83,7 +92,7 @@ class TemplateDataHtmlFormatter {
'class' => 'mw-templatedata-doc-muted',
'colspan' => 7
],
wfMessage( 'templatedata-doc-no-params-set' )->inLanguage( $lang )->text()
$this->localizer->msg( 'templatedata-doc-no-params-set' )->text()
)
. '</tr>';
}
@ -95,7 +104,7 @@ class TemplateDataHtmlFormatter {
$aliases = '';
if ( count( $param->aliases ) ) {
foreach ( $param->aliases as $alias ) {
$aliases .= wfMessage( 'word-separator' )->inLanguage( $lang )->escaped()
$aliases .= $this->localizer->msg( 'word-separator' )->escaped()
. Html::element( 'code', [ 'class' => 'mw-templatedata-doc-param-alias' ],
$alias
);
@ -106,13 +115,13 @@ class TemplateDataHtmlFormatter {
if ( $param->suggestedvalues ) {
$suggestedValues = '';
foreach ( $param->suggestedvalues as $suggestedValue ) {
$suggestedValues .= wfMessage( 'word-separator' )->inLanguage( $lang )->escaped()
$suggestedValues .= $this->localizer->msg( 'word-separator' )->escaped()
. Html::element( 'code', [ 'class' => 'mw-templatedata-doc-param-alias' ],
$suggestedValue
);
}
$suggestedValuesLine .= Html::element( 'dt', [],
wfMessage( 'templatedata-doc-param-suggestedvalues' )->inLanguage( $lang )->text()
$this->localizer->msg( 'templatedata-doc-param-suggestedvalues' )->text()
) . Html::rawElement( 'dd', [], $suggestedValues );
}
@ -141,28 +150,28 @@ class TemplateDataHtmlFormatter {
],
Html::element( 'p', [],
$param->description ??
wfMessage( 'templatedata-doc-param-desc-empty' )->inLanguage( $lang )->text()
$this->localizer->msg( 'templatedata-doc-param-desc-empty' )->text()
)
. Html::rawElement( 'dl', [],
// Suggested Values
$suggestedValuesLine .
// Default
( $param->default !== null ? ( Html::element( 'dt', [],
wfMessage( 'templatedata-doc-param-default' )->inLanguage( $lang )->text()
$this->localizer->msg( 'templatedata-doc-param-default' )->text()
)
. Html::element( 'dd', [],
$param->default
) ) : '' )
// Example
. ( $param->example !== null ? ( Html::element( 'dt', [],
wfMessage( 'templatedata-doc-param-example' )->inLanguage( $lang )->text()
$this->localizer->msg( 'templatedata-doc-param-example' )->text()
)
. Html::element( 'dd', [],
$param->example
) ) : '' )
// Auto value
. ( $param->autovalue !== null ? ( Html::element( 'dt', [],
wfMessage( 'templatedata-doc-param-autovalue' )->inLanguage( $lang )->text()
$this->localizer->msg( 'templatedata-doc-param-autovalue' )->text()
)
. Html::rawElement( 'dd', [],
Html::element( 'code', [], $param->autovalue )
@ -185,7 +194,7 @@ class TemplateDataHtmlFormatter {
// templatedata-doc-param-type-url, templatedata-doc-param-type-wiki-file-name,
// templatedata-doc-param-type-wiki-page-name, templatedata-doc-param-type-wiki-template-name,
// templatedata-doc-param-type-wiki-user-name
wfMessage( 'templatedata-doc-param-type-' . $param->type )->inLanguage( $lang )->text()
$this->localizer->msg( 'templatedata-doc-param-type-' . $param->type )->text()
)
// Status
. Html::element( 'td',
@ -207,7 +216,7 @@ class TemplateDataHtmlFormatter {
// templatedata-doc-param-status-optional
// templatedata-doc-param-status-required
// templatedata-doc-param-status-suggested
wfMessage( "templatedata-doc-param-status-$status" )->inLanguage( $lang )->text()
$this->localizer->msg( "templatedata-doc-param-status-$status" )->text()
)
. '</tr>';
}

25
includes/TemplateDataMessageLocalizer.php Normal file
View file

@ -0,0 +1,25 @@
<?php
namespace MediaWiki\Extension\TemplateData;
use Language;
use MessageLocalizer;
class TemplateDataMessageLocalizer implements MessageLocalizer {
/** @var Language */
private $language;
/**
* @param Language $language
*/
public function __construct( Language $language ) {
$this->language = $language;
}
/** @inheritDoc */
public function msg( $key, ...$params ) {
return wfMessage( $key, ...$params )->inLanguage( $this->language );
}
}