JavaFFS Class Reference
[File format support]

JavaFFS class implements support for Java properties files. More...

Inheritance diagram for JavaFFS:
Inheritance graph
[legend]
Collaboration diagram for JavaFFS:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 supportsFuzzy ()
 Query the capabilities of this FFS.
 getFileExtensions ()
 Return the commonly used file extensions for these formats.
 __construct (FileBasedMessageGroup $group)
 readFromVariable ($data)

Static Public Member Functions

static writeRow ($key, $sep, $value)
 Writes well-formed properties file row with key and value.
static readRow ($line, $sep)
 Parses non-empty properties file row to key and value.

Public Attributes

 $messages = $this->group->getMangler()->mangle( $messages )

Protected Member Functions

 doHeader (MessageCollection $collection)
 doAuthors (MessageCollection $collection)

Protected Attributes

 $keySeparator = '='

Detailed Description

JavaFFS class implements support for Java properties files.

This class reads and writes only utf-8 files. Java projects need to run native2ascii on them before using them.

This class adds a new item into FILES section of group configuration: keySeparator which defaults to '='.

Definition at line 12 of file JavaFFS.php.


Constructor & Destructor Documentation

JavaFFS::__construct ( FileBasedMessageGroup group  ) 
Parameters:
$group FileBasedMessageGroup

Reimplemented from SimpleFFS.

Definition at line 26 of file JavaFFS.php.


Member Function Documentation

JavaFFS::doAuthors ( MessageCollection collection  )  [protected]
Parameters:
$collection MessageCollection
Returns:
string

Definition at line 242 of file JavaFFS.php.

JavaFFS::doHeader ( MessageCollection collection  )  [protected]
Parameters:
$collection MessageCollection
Returns:
string

Definition at line 222 of file JavaFFS.php.

Here is the call graph for this function:

JavaFFS::getFileExtensions (  ) 

Return the commonly used file extensions for these formats.

Include the dot.

Returns:
string[]
Since:
2013-04

Reimplemented from SimpleFFS.

Definition at line 17 of file JavaFFS.php.

JavaFFS::readFromVariable ( data  ) 
Parameters:
$data array
Returns:
array
Exceptions:
MWException 

Reimplemented from SimpleFFS.

Definition at line 41 of file JavaFFS.php.

Here is the call graph for this function:

static JavaFFS::readRow ( line,
sep 
) [static]

Parses non-empty properties file row to key and value.

Parameters:
string $line
string $sep
Returns:
string
Since:
2012-03-28

Definition at line 165 of file JavaFFS.php.

Referenced by readFromVariable(), and JavaFFSTest::testRowRoundtrip().

JavaFFS::supportsFuzzy (  ) 

Query the capabilities of this FFS.

Allowed values are:

  • yes
  • write (ignored on read)
  • no (stripped on write)
    Returns:
    string
    Since:
    2013-03-05

Reimplemented from SimpleFFS.

Definition at line 13 of file JavaFFS.php.

static JavaFFS::writeRow ( key,
sep,
value 
) [static]

Writes well-formed properties file row with key and value.

Parameters:
string $key
string $sep
string $value
Returns:
string
Since:
2012-03-28

Definition at line 147 of file JavaFFS.php.

Referenced by JavaFFSTest::testRowRoundtrip().


Member Data Documentation

JavaFFS::$keySeparator = '=' [protected]

Definition at line 21 of file JavaFFS.php.

JavaFFS::$messages = $this->group->getMangler()->mangle( $messages )

Definition at line 90 of file JavaFFS.php.

Referenced by readFromVariable().


The documentation for this class was generated from the following file:
Generated on Tue Oct 29 00:00:46 2013 for MediaWiki Translate Extension by  doxygen 1.6.3