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

FileFormat class that implements support for gettext file format. More...

Inheritance diagram for MediaWiki\Extension\Translate\FileFormatSupport\GettextFormat:
MediaWiki\Extension\Translate\FileFormatSupport\SimpleFormat MediaWiki\Extension\Translate\MessageGroupConfiguration\MetaYamlSchemaExtender MediaWiki\Extension\Translate\FileFormatSupport\FileFormatSupport

Public Member Functions

 supportsFuzzy ()
 Query the capabilities of this FFS.
 
 getFileExtensions ()
 Return the commonly used file extensions for these formats.
 
 setOfflineMode (bool $value)
 
 read ( $languageCode)
 @inheritDoc
 
 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.
 
 generateKeyFromItem (array $item, string $algorithm='simple')
 Generates unique key for each message.
 
- Public Member Functions inherited from MediaWiki\Extension\Translate\FileFormatSupport\SimpleFormat
 __construct (FileBasedMessageGroup $group)
 
 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.
 
 isContentEqual (?string $a, ?string $b)
 Checks whether two strings are equal.
 
 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

- Static Public Member Functions inherited from MediaWiki\Extension\Translate\MessageGroupConfiguration\MetaYamlSchemaExtender
static getExtraSchema ()
 Return a data structure that will be merged with the base schema.
 
- Protected Attributes inherited from MediaWiki\Extension\Translate\FileFormatSupport\SimpleFormat
FileBasedMessageGroup $group
 
string $writePath = null
 
 $extra
 

Detailed Description

FileFormat class that implements support for gettext file format.

Author
Niklas Laxström
Siebrand Mazeland

Definition at line 28 of file GettextFormat.php.

Member Function Documentation

◆ generateKeyFromItem()

MediaWiki\Extension\Translate\FileFormatSupport\GettextFormat::generateKeyFromItem ( array $item,
string $algorithm = 'simple' )

Generates unique key for each message.

Changing this WILL BREAK ALL existing pages!

Parameters
array$itemAs returned by parseGettextSection
string$algorithmAlgorithm used to generate message keys: simple or legacy

Definition at line 300 of file GettextFormat.php.

◆ getFileExtensions()

MediaWiki\Extension\Translate\FileFormatSupport\GettextFormat::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 36 of file GettextFormat.php.

◆ read()

MediaWiki\Extension\Translate\FileFormatSupport\GettextFormat::read ( $languageCode)

@inheritDoc

Definition at line 45 of file GettextFormat.php.

◆ readFromVariable()

MediaWiki\Extension\Translate\FileFormatSupport\GettextFormat::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 57 of file GettextFormat.php.

◆ setOfflineMode()

MediaWiki\Extension\Translate\FileFormatSupport\GettextFormat::setOfflineMode ( bool $value)

Definition at line 40 of file GettextFormat.php.

◆ supportsFuzzy()

MediaWiki\Extension\Translate\FileFormatSupport\GettextFormat::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 32 of file GettextFormat.php.

◆ writeReal()

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

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