IniFFS Class Reference

IniFFS currently parses and generates flat ini files with language code as header key. More...

Inheritance diagram for IniFFS:

Public Member Functions
	supportsFuzzy ()
	Query the capabilities of this FFS.
	getFileExtensions ()
	Return the commonly used file extensions for these formats.
	readFromVariable ( $data)
Public Member Functions inherited from SimpleFFS
	__construct (FileBasedMessageGroup $group)
	setGroup (FileBasedMessageGroup $group)
	getGroup ()
	setWritePath ( $writePath)
	getWritePath ()
	exists ( $code=false)
	Returns true if the file for this message group in a given language exists.
	read ( $code)
	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 SimpleFFS formatted string.
	filterAuthors (array $authors, $code)
	Remove excluded authors.
	isContentEqual ( $a, $b)
	Checks whether two strings are equal.
	shouldOverwrite ( $a, $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.

Static Public Member Functions
static	isValid ( $data)

Protected Member Functions
	writeReal (MessageCollection $collection)
Protected Member Functions inherited from SimpleFFS
	tryReadSource ( $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 ( $filename)
	Read the contents of $filename and return it as a string.

Additional Inherited Members
Protected Attributes inherited from SimpleFFS
	$group
	$writePath
	$extra
	Stores the FILES section of the YAML configuration, which can be accessed for extra FFS class specific options.

Detailed Description

IniFFS currently parses and generates flat ini files with language code as header key.

Since

2012-11-19

Definition at line 20 of file IniFFS.php.

Member Function Documentation

getFileExtensions()

IniFFS::getFileExtensions

(

)

Return the commonly used file extensions for these formats.

Include the dot.

Returns

string[]

Since

2013-04

Reimplemented from SimpleFFS.

Definition at line 40 of file IniFFS.php.

isValid()

static IniFFS::isValid ( $data )

static

Definition at line 21 of file IniFFS.php.

readFromVariable()

IniFFS::readFromVariable

(

$data

)

Parameters

string

$data

Returns

array Parsed data.

Reimplemented from SimpleFFS.

Definition at line 48 of file IniFFS.php.

supportsFuzzy()

IniFFS::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 36 of file IniFFS.php.

writeReal()

IniFFS::writeReal ( MessageCollection $collection )

protected

Parameters

MessageCollection

$collection

Returns

string

Reimplemented from SimpleFFS.

Definition at line 73 of file IniFFS.php.

---

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

• ffs/IniFFS.php