Translate extension for MediaWiki
 
Loading...
Searching...
No Matches
MediaWiki\Extension\Translate\MessageGroupProcessing\TranslatableBundle Class Reference

Translatable bundle represents a message group where its translatable content is defined on a wiki page. More...

Inheritance diagram for MediaWiki\Extension\Translate\MessageGroupProcessing\TranslatableBundle:
MediaWiki\Extension\Translate\MessageBundleTranslation\MessageBundle MediaWiki\Extension\Translate\PageTranslation\TranslatablePage

Public Member Functions

 getTitle ()
 Return the title of the page where the translatable bundle is defined.
 
 getMessageGroupId ()
 Return the message group id for the bundle Note that the message group id may refer to a message group that does not exist.
 
 getTranslationPages ()
 Return the available translation pages for the bundle.
 
 getTranslationUnitPages (?string $code=null)
 Return the available translation units for the bundle.
 
 isMoveable ()
 Check if this translatable bundle is moveable.
 
 isDeletable ()
 Check if this is a deletable translatable bundle.
 

Protected Member Functions

 getTranslationUnitPagesByTitle (Title $title, ?string $code=null)
 

Detailed Description

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
Niklas Laxström
Since
2022.03 @license GPL-2.0-or-later

Definition at line 22 of file TranslatableBundle.php.

Member Function Documentation

◆ getMessageGroupId()

MediaWiki\Extension\Translate\MessageGroupProcessing\TranslatableBundle::getMessageGroupId ( )
abstract

Return the message group id for the bundle Note that the message group id may refer to a message group that does not exist.

Reimplemented in MediaWiki\Extension\Translate\MessageBundleTranslation\MessageBundle, and MediaWiki\Extension\Translate\PageTranslation\TranslatablePage.

◆ getTitle()

MediaWiki\Extension\Translate\MessageGroupProcessing\TranslatableBundle::getTitle ( )
abstract

Return the title of the page where the translatable bundle is defined.

Reimplemented in MediaWiki\Extension\Translate\MessageBundleTranslation\MessageBundle, and MediaWiki\Extension\Translate\PageTranslation\TranslatablePage.

◆ getTranslationPages()

MediaWiki\Extension\Translate\MessageGroupProcessing\TranslatableBundle::getTranslationPages ( )
abstract

◆ getTranslationUnitPages()

MediaWiki\Extension\Translate\MessageGroupProcessing\TranslatableBundle::getTranslationUnitPages ( ?string $code = null)
abstract

◆ getTranslationUnitPagesByTitle()

MediaWiki\Extension\Translate\MessageGroupProcessing\TranslatableBundle::getTranslationUnitPagesByTitle ( Title $title,
?string $code = null )
protected

Definition at line 52 of file TranslatableBundle.php.

◆ isDeletable()

MediaWiki\Extension\Translate\MessageGroupProcessing\TranslatableBundle::isDeletable ( )
abstract

◆ isMoveable()

MediaWiki\Extension\Translate\MessageGroupProcessing\TranslatableBundle::isMoveable ( )
abstract

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