Translate extension for MediaWiki
 
Loading...
Searching...
No Matches
MediaWiki\Extension\Translate\FileFormatSupport\AndroidXmlFormat Class Reference

Support for XML translation format used by Android. More...

Inheritance diagram for MediaWiki\Extension\Translate\FileFormatSupport\AndroidXmlFormat:
MediaWiki\Extension\Translate\FileFormatSupport\SimpleFormat MediaWiki\Extension\Translate\FileFormatSupport\FileFormatSupport

Public Member Functions

 __construct (FileBasedMessageGroup $group)
 
 supportsFuzzy ()
 Query the capabilities of this FFS.
 
 getFileExtensions ()
 Return the commonly used file extensions for these formats.
 
 readFromVariable (string $data)
 Parse the message data given as a string in the SimpleFormat format and return it as an array of AUTHORS and MESSAGES.
 
 isContentEqual (?string $a, ?string $b)
 Checks whether two strings are equal.
 
- Public Member Functions inherited from MediaWiki\Extension\Translate\FileFormatSupport\SimpleFormat
 setGroup (FileBasedMessageGroup $group)
 
 getGroup ()
 
 setWritePath (string $target)
 Set the file's location in the system.
 
 getWritePath ()
 Get the file's location in the system.
 
 exists ( $code=false)
 Returns true if the file for this message group in a given language exists.
 
 read (string $languageCode)
 Reads messages from the file in a given language and returns an array of AUTHORS, MESSAGES and possibly other properties.
 
 write (MessageCollection $collection)
 Write the collection to file.
 
 writeIntoVariable (MessageCollection $collection)
 Read a collection and return it as a SimpleFormat formatted string.
 
 filterAuthors (array $authors, string $code)
 Remove excluded authors.
 
 shouldOverwrite (string $a, string $b)
 Allows to skip writing the export output into a file.
 
 isGroupFfsReadable ()
 Check if the file format of the current group is readable by the file format system.
 

Protected Member Functions

 writeReal (MessageCollection $collection)
 
- Protected Member Functions inherited from MediaWiki\Extension\Translate\FileFormatSupport\SimpleFormat
 tryReadSource (string $filename, MessageCollection $collection)
 This tries to pick up external authors in the source files so that they are not lost if those authors are not among those who have translated in the wiki.
 
 tryReadFile (string $filename)
 Read the contents of $filename and return it as a string.
 

Additional Inherited Members

- Protected Attributes inherited from MediaWiki\Extension\Translate\FileFormatSupport\SimpleFormat
FileBasedMessageGroup $group
 
string $writePath = null
 
 $extra
 

Detailed Description

Support for XML translation format used by Android.

Author
Niklas Laxström @license GPL-2.0-or-later

Definition at line 20 of file AndroidXmlFormat.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Extension\Translate\FileFormatSupport\AndroidXmlFormat::__construct ( FileBasedMessageGroup $group)

Member Function Documentation

◆ getFileExtensions()

MediaWiki\Extension\Translate\FileFormatSupport\AndroidXmlFormat::getFileExtensions ( )

Return the commonly used file extensions for these formats.

Include the dot.

Returns
string[]

Reimplemented from MediaWiki\Extension\Translate\FileFormatSupport\SimpleFormat.

Definition at line 32 of file AndroidXmlFormat.php.

◆ isContentEqual()

MediaWiki\Extension\Translate\FileFormatSupport\AndroidXmlFormat::isContentEqual ( ?string $a,
?string $b )

Checks whether two strings are equal.

Sometimes same content might have multiple representations. The main case are inline plurals, which in some formats require expansion at export time.

Reimplemented from MediaWiki\Extension\Translate\FileFormatSupport\SimpleFormat.

Definition at line 196 of file AndroidXmlFormat.php.

◆ readFromVariable()

MediaWiki\Extension\Translate\FileFormatSupport\AndroidXmlFormat::readFromVariable ( string $data)

Parse the message data given as a string in the SimpleFormat format and return it as an array of AUTHORS and MESSAGES.

Exceptions
InvalidArgumentException

Reimplemented from MediaWiki\Extension\Translate\FileFormatSupport\SimpleFormat.

Definition at line 36 of file AndroidXmlFormat.php.

◆ supportsFuzzy()

MediaWiki\Extension\Translate\FileFormatSupport\AndroidXmlFormat::supportsFuzzy ( )

Query the capabilities of this FFS.

Allowed values are:

  • yes
  • write (ignored on read)
  • no (stripped on write)

Reimplemented from MediaWiki\Extension\Translate\FileFormatSupport\SimpleFormat.

Definition at line 28 of file AndroidXmlFormat.php.

◆ writeReal()

MediaWiki\Extension\Translate\FileFormatSupport\AndroidXmlFormat::writeReal ( MessageCollection $collection)
protected

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