Path

ez components / documentation / api reference / 2009.1.1 / translation

eZ Components 2009.1.1

Translation: ezcTranslationTsBackendOptions

[ Tutorial ] [ Linguist format ] [ Class tree ] [ Element index ] [ ChangeLog ] [ Credits ]

Class: ezcTranslationTsBackendOptions

Struct class to store the options of the ezcTranslationTsBackend class. [source]
This class stores the options for the ezcTranslationTsBackend class.

Parents

ezcBaseOptions
   |
   --ezcTranslationTsBackendOptions

Properties

string read/write  $format
Format for the translation file's name. In this format string the special place holder [LOCALE] will be replaced with the requested locale's name. For example a format of "translations/[LOCALE].xml" will result in the filename for the translation file to be "translations/nl_NL.xml" if the nl_NL locale is requested.
bool read/write  $keepObsolete
When this option is set to "true" the reader will not drop translation messages with the "obsolete" type set.
string read/write  $location
Path to the directory that contains all TS .xml files.

Inherited Member Variables

From ezcBaseOptions:
protected  ezcBaseOptions::$properties

Method Summary

public ezcTranslationTsBackendOptions __construct( [$array = array()] )
Constructs a new options class.

Inherited Methods

From ezcBaseOptions :
public ezcBaseOptions ezcBaseOptions::__construct()
Construct a new options object.
public void ezcBaseOptions::merge()
Merge an array into the actual options object.
public bool ezcBaseOptions::offsetExists()
Returns if an option exists.
public mixed ezcBaseOptions::offsetGet()
Returns an option value.
public void ezcBaseOptions::offsetSet()
Set an option.
public void ezcBaseOptions::offsetUnset()
Unset an option.

Methods

__construct

ezcTranslationTsBackendOptions __construct( [array(string=>mixed) $array = array()] )
Constructs a new options class.
It also sets the default values of the format property

Parameters

Name Type Description
$array array(string=>mixed) The initial options to set.

Throws

ClassDescription
ezcBasePropertyNotFoundException If a the value for the property options is not an instance of
ezcBaseValueException If a the value for a property is out of range.

Redefinition of

Method Description
ezcBaseOptions::__construct() Construct a new options object.

Last updated: Mon, 27 Jul 2009