Page MenuHomeWickedGov Phorge
Files F4166823

DisplayGroupSynchronizationInfo.php
No OneTemporary
Actions

Size
7 KB
Referenced Files
None
Subscribers
None

DisplayGroupSynchronizationInfo.php
View Options

<?php
declare( strict_types = 1 );
namespace MediaWiki\Extension\Translate\Synchronization;
use MediaWiki\Html\Html;
use MediaWiki\Language\Language;
use MediaWiki\Linker\LinkRenderer;
use MediaWiki\Title\Title;
use MessageLocalizer;
/**
* Display Group synchronization related information
* @author Abijeet Patro
* @license GPL-2.0-or-later
* @since 2021.02
*/
class DisplayGroupSynchronizationInfo {
private MessageLocalizer $localizer;
private LinkRenderer $linkRenderer;
public function __construct( MessageLocalizer $localizer, LinkRenderer $linkRenderer ) {
$this->localizer = $localizer;
$this->linkRenderer = $linkRenderer;
}
/** @param string[] $groupsInSync */
public function getGroupsInSyncHtml( array $groupsInSync, string $wrapperClass ): string {
sort( $groupsInSync );
if ( !$groupsInSync ) {
return Html::rawElement(
'p',
[ 'class' => $wrapperClass ],
$this->localizer->msg( 'translate-smg-no-groups-in-sync' )->escaped()
. $this->addGroupSyncHelp( $wrapperClass )
);
}
$htmlGroupItems = [];
foreach ( $groupsInSync as $groupId ) {
$htmlGroupItems[] = Html::element( 'li', [], $groupId );
}
return $this->getGroupSyncInfoHtml(
$wrapperClass,
'translate-smg-groups-in-sync',
'translate-smg-groups-in-sync-list',
Html::rawElement( 'ul', [], implode( '', $htmlGroupItems ) ),
$this->addGroupSyncHelp( $wrapperClass )
);
}
public function getHtmlForGroupsWithError(
GroupSynchronizationCache $groupSynchronizationCache,
string $wrapperClass,
Language $currentLang
): string {
$groupsWithErrors = $groupSynchronizationCache->getGroupsWithErrors();
if ( !$groupsWithErrors ) {
return '';
}
$htmlGroupItems = [];
foreach ( $groupsWithErrors as $groupId ) {
$groupErrorResponse = $groupSynchronizationCache->getGroupErrorInfo( $groupId );
$htmlGroupItems[] = $this->getHtmlForGroupErrors( $groupErrorResponse, $currentLang, $wrapperClass );
}
return $this->getGroupSyncInfoHtml(
$wrapperClass . ' js-group-sync-groups-with-error',
'translate-smg-groups-with-error-title',
'translate-smg-groups-with-error-desc',
implode( '', $htmlGroupItems )
);
}
private function addGroupSyncHelp( string $wrapperClass ): string {
return Html::element(
'a',
[
'href' => 'https://www.mediawiki.org/wiki/Special:MyLanguage/Help:Extension:Translate/' .
'Group_management#Strong_synchronization',
'target' => '_blank',
'class' => "{$wrapperClass}__help",
],
'[' . $this->localizer->msg( 'translate-smg-strong-sync-help' )->text() . ']'
);
}
private function getGroupSyncInfoHtml(
string $className,
string $summaryMsgKey,
string $descriptionMsgKey,
string $htmlContent,
?string $preHtmlContent = null
): string {
$output = Html::openElement( 'div', [ 'class' => $className ] );
if ( $preHtmlContent ) {
$output .= $preHtmlContent;
}
$output .= Html::openElement( 'details' );
$output .= Html::element( 'summary', [], $this->localizer->msg( $summaryMsgKey )->text() );
$output .= Html::element( 'p', [], $this->localizer->msg( $descriptionMsgKey )->text() );
$output .= $htmlContent;
$output .= Html::closeElement( 'details' );
$output .= Html::closeElement( 'div' );
return $output;
}
private function getHtmlForGroupErrors(
GroupSynchronizationResponse $groupErrorResponse,
Language $language,
string $wrapperClass
): string {
$groupId = $groupErrorResponse->getGroupId();
$output = Html::openElement(
'details',
[ 'class' => "{$wrapperClass}__group_errors js-group-sync-group-errors" ]
);
$groupResolveAction = Html::linkButton(
$this->localizer->msg( 'translate-smg-group-action-resolve' )->text(),
[
'class' => "{$wrapperClass}__resolve-action js-group-sync-group-resolve",
'href' => '#',
'data-group-id' => $groupId,
]
);
$output .= Html::rawElement(
'summary',
[],
$groupId . ' ' .
Html::rawElement(
'span',
[ 'class' => "{$wrapperClass}__sync-actions" ],
$this->localizer->msg( 'parentheses' )
->rawParams( $groupResolveAction )->escaped()
)
);
$errorMessages = $groupErrorResponse->getRemainingMessages();
$output .= Html::openElement( 'ol' );
foreach ( $errorMessages as $message ) {
$output .= Html::rawElement(
'li',
[ 'class' => "{$wrapperClass}__message-error js-group-sync-message-error" ],
$this->getErrorMessageHtml( $groupId, $message, $language, $wrapperClass )
);
}
$output .= Html::closeElement( 'ol' );
$output .= Html::closeElement( 'details' );
return $output;
}
private function getErrorMessageHtml(
string $groupId,
MessageUpdateParameter $message,
Language $language,
string $wrapperClass
): string {
$messageTitle = Title::newFromText( $message->getPageName() );
$actions = [];
if ( $messageTitle->exists() ) {
$output = $this->linkRenderer->makeLink( $messageTitle, $message->getPageName() );
$actions[] = $this->linkRenderer->makeLink(
$messageTitle,
$this->localizer->msg( 'translate-smg-group-message-action-history' )->text(),
[],
[ 'action' => 'history' ]
);
} else {
$output = $this->linkRenderer->makeBrokenLink( $messageTitle, $message->getPageName() );
}
$actions[] = Html::linkButton(
$this->localizer->msg( 'translate-smg-group-action-resolve' )->text(),
[
'class' => "{$wrapperClass}__resolve-action js-group-sync-message-resolve",
'href' => '#',
'data-group-id' => $groupId,
'data-msg-title' => $message->getPageName(),
]
);
$output .= ' ' . Html::rawElement(
'span',
[ 'class' => "{$wrapperClass}__sync-actions" ],
$this->localizer->msg( 'parentheses' )
->rawParams( $language->pipeList( $actions ) )->escaped()
);
$output .= $this->getMessageInfoHtml( $message, $language );
return $output;
}
private function getMessageInfoHtml( MessageUpdateParameter $message, Language $language ): string {
$output = Html::openElement( 'dl' );
$tags = [];
if ( $message->isFuzzy() ) {
$tags[] = $this->localizer->msg( 'translate-smg-group-message-tag-outdated' )->text();
}
if ( $message->isRename() ) {
$tags[] = $this->localizer->msg( 'translate-smg-group-message-tag-rename' )->text();
}
if ( $tags ) {
$output .= $this->getMessagePropHtml(
$this->localizer->msg( 'translate-smg-group-message-tag-label' )
->numParams( count( $tags ) )->text(),
implode( $this->localizer->msg( 'pipe-separator' )->text(), $tags )
);
}
$output .= $this->getMessagePropHtml(
$this->localizer->msg( 'translate-smg-group-message-message-content' )->text(),
$message->getContent()
);
if ( $message->isRename() ) {
$output .= $this->getMessagePropHtml(
$this->localizer->msg( 'translate-smg-group-message-message-target' )->text(),
$message->getTargetValue()
);
$output .= $this->getMessagePropHtml(
$this->localizer->msg( 'translate-smg-group-message-message-replacement' )->text(),
$message->getReplacementValue()
);
$otherLangs = $message->getOtherLangs();
if ( $otherLangs ) {
$output .= $this->getMessagePropHtml(
$this->localizer->msg( 'translate-smg-group-message-message-other-langs' )->text(),
implode(
$this->localizer->msg( 'comma-separator' )->text(),
array_keys( $otherLangs )
)
);
}
}
$output .= Html::closeElement( 'dl' );
return $output;
}
private function getMessagePropHtml( string $label, string $value ): string {
return Html::element( 'dt', [], $label ) . Html::element( 'dd', [], $value );
}
}

File Metadata

Mime Type
text/x-php
Expires
Aug 20 2026, 03:50 (11 w, 3 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
3b/72/0fad33cfb50af1d4bc9fffc22af0
Default Alt Text
DisplayGroupSynchronizationInfo.php (7 KB)

Event Timeline