Page MenuHomeWickedGov Phorge
Files F4147706

TranslatableBundle.php
No OneTemporary
Actions

Size
3 KB
Referenced Files
None
Subscribers
None

TranslatableBundle.php
View Options

<?php
declare( strict_types = 1 );
namespace MediaWiki\Extension\Translate\MessageGroupProcessing;
use MediaWiki\Extension\Translate\MessageLoading\MessageHandle;
use MediaWiki\MediaWikiServices;
use MediaWiki\Page\PageReference;
use MediaWiki\Title\Title;
/**
* Translatable bundle represents a message group where its translatable content is
* defined on a wiki page.
*
* This interface was created to support moving message bundles using the code developed for
* moving translatable pages.
*
* See also WikiMessageGroup which is not considered to be a translatable bundle.
* @author Abijeet Patro
* @author Niklas Laxström
* @since 2022.03
* @license GPL-2.0-or-later
*/
abstract class TranslatableBundle {
/** Return the title of the page where the translatable bundle is defined */
abstract public function getTitle(): Title;
/**
* Return the message group id for the bundle
* Note that the message group id may refer to a message group that does not exist.
*/
abstract public function getMessageGroupId(): string;
/**
* Return the available translation pages for the bundle
* @see Translation page: https://www.mediawiki.org/wiki/Help:Extension:Translate/Glossary
* @return Title[]
*/
abstract public function getTranslationPages(): array;
/**
* Return the available translation units for the bundle
* @see Translation unit: https://www.mediawiki.org/wiki/Help:Extension:Translate/Glossary
* @return Title[]
*/
abstract public function getTranslationUnitPages( ?string $code = null ): array;
/** Check if this translatable bundle is moveable */
abstract public function isMoveable(): bool;
/** Check if this is a deletable translatable bundle */
abstract public function isDeletable(): bool;
protected function getTranslationUnitPagesByTitle( PageReference $title, ?string $code = null ): array {
$mwServices = MediaWikiServices::getInstance();
$dbw = $mwServices->getDBLoadBalancer()->getConnection( DB_PRIMARY );
$base = $mwServices->getTitleFormatter()->getPrefixedDBkey( $title );
// Including the / used as separator
$baseLength = strlen( $base ) + 1;
if ( $code === null ) {
$like = $dbw->buildLike( "$base/", $dbw->anyString() );
} else {
$like = $dbw->buildLike( "$base/", $dbw->anyString(), "/$code" );
}
$res = $dbw->newSelectQueryBuilder()
->select( [ 'page_namespace', 'page_title' ] )
->from( 'page' )
->where( [
'page_namespace' => NS_TRANSLATIONS,
'page_title ' . $like
] )
->caller( __METHOD__ )
->fetchResultSet();
// Only include pages which belong to this translatable page.
// Problematic cases are when pages Foo and Foo/bar are both
// translatable. Then when querying for Foo, we also get units
// belonging to Foo/bar.
$units = [];
foreach ( $res as $row ) {
$title = Title::newFromRow( $row );
// Strip the language code and the name of the
// translatable to get plain translation unit id
$handle = new MessageHandle( $title );
$key = substr( $handle->getKey(), $baseLength );
if ( str_contains( $key, '/' ) ) {
// Probably belongs to translatable subpage
continue;
}
// We have a match :)
$units[] = $title;
}
return $units;
}
}

File Metadata

Mime Type
text/x-php
Expires
Aug 19 2026, 18:30 (6 w, 1 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
84/a7/0c5a9ec75358befa3e967dd53a03
Default Alt Text
TranslatableBundle.php (3 KB)

Event Timeline