Page MenuHomeWickedGov Phorge
Files F5967795

GettextDocumentationAid.php
No OneTemporary
Actions

Size
2 KB
Referenced Files
None
Subscribers
None

GettextDocumentationAid.php
View Options

<?php
declare( strict_types = 1 );
namespace MediaWiki\Extension\Translate\TranslatorInterface\Aid;
use FileBasedMessageGroup;
use MediaWiki\Extension\Translate\FileFormatSupport\GettextFormat;
use MediaWiki\Extension\Translate\TranslatorInterface\TranslationHelperException;
use MediaWiki\MediaWikiServices;
/**
* Translation aid that provides Gettext documentation.
* @ingroup TranslationAids
* @author Niklas Laxström
* @license GPL-2.0-or-later
* @since 2013-01-01
*/
class GettextDocumentationAid extends TranslationAid {
public function getData(): array {
// We need to get the primary group to get the correct file
// So $group can be different from $this->group
$group = $this->handle->getGroup();
if ( !$group instanceof FileBasedMessageGroup ) {
throw new TranslationHelperException( 'Not a FileBasedMessageGroup group' );
}
$fileFormat = $group->getFFS();
if ( !$fileFormat instanceof GettextFormat ) {
throw new TranslationHelperException( 'Group is not using GettextFormat' );
}
$cache = $group->getMessageGroupCache( $group->getSourceLanguage() );
if ( !$cache->exists() ) {
throw new TranslationHelperException( 'Definitions are not cached' );
}
$extra = $cache->getExtra();
$contLang = MediaWikiServices::getInstance()->getContentLanguage();
$messageKey = $contLang->lcfirst( $this->handle->getKey() );
$messageKey = str_replace( ' ', '_', $messageKey );
$help = $extra['TEMPLATE'][$messageKey]['comments'] ?? null;
if ( !$help ) {
throw new TranslationHelperException( "No comments found for key '$messageKey'" );
}
$conf = $group->getConfiguration();
if ( isset( $conf['BASIC']['codeBrowser'] ) ) {
$pattern = $conf['BASIC']['codeBrowser'];
$pattern = str_replace( '%FILE%', '\1', $pattern );
$pattern = str_replace( '%LINE%', '\2', $pattern );
$pattern = "[$pattern \\1:\\2]";
} else {
$pattern = "\\1:\\2";
}
$out = '';
foreach ( $help as $type => $lines ) {
if ( $type === ':' ) {
$files = '';
foreach ( $lines as $line ) {
$files .= ' ' . preg_replace( '/([^ :]+):(\d+)/', $pattern, $line );
}
$out .= "<nowiki>#:</nowiki> $files<br />";
} else {
foreach ( $lines as $line ) {
$out .= "<nowiki>#$type</nowiki> $line<br />";
}
}
}
$html = $this->context->getOutput()->parseAsContent( $out );
return [
'language' => $contLang->getCode(),
// @todo Provide raw data when possible
// 'value' => $help,
'html' => $html,
];
}
}

File Metadata

Mime Type
text/x-php
Expires
Sat, Oct 3, 12:38 (3 d, 8 h ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
33/e9/98af9c0c48447319d28810f07f75
Default Alt Text
GettextDocumentationAid.php (2 KB)

Event Timeline