Path

ez components / documentation / api reference / latest / document


eZ Components latest

Document: ezcDocumentDocbookToOdtConverterOptions

[ Tutorial ] [ Conversion ] [ Styles ] [ Class tree ] [ Element index ] [ ChangeLog ] [ Credits ]

Class: ezcDocumentDocbookToOdtConverterOptions

Class containing the basic options for the ezcDocumentToOdtConverter. [source]

Parents

ezcBaseOptions
   |
   --ezcDocumentConverterOptions
      |
      --ezcDocumentDocbookToOdtConverterOptions

Properties

string read/write  $lengthMeasure
Default length measure unit to use for measures defined in DocBook without a unit. Valid values are: "cm", "mm", "in", "pt", "pc" and "px".
ezcDocumentOdtStyler read/write  $styler
Styler to use for generating ODTs. By default, an ezcDocumentOdtPcssStyler is used.
string read/write  $template
The base ODT template file to load for generated ODTs. The default template resides in /data/template.fodt in the component directory.

Member Variables

public array(string) $validLengthMeasures = array(
'cm', 'mm', 'in', 'pt', 'pc', 'px'
)

Valid length measures.

Inherited Member Variables

From ezcDocumentConverterOptions:
protected  ezcDocumentConverterOptions::$properties

Method Summary

public ezcDocumentDocbookToOdtConverterOptions __construct( [$options = array()] )
Constructs an object with the specified values.

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

ezcDocumentDocbookToOdtConverterOptions __construct( [ $options = array()] )
Constructs an object with the specified values.

Parameters

Name Type Description
$options array(string=>mixed)  

Throws

ClassDescription
ezcBaseValueException if $options contains a property with a value not allowed
ezcBasePropertyNotFoundException if $options contains a property not defined

Redefinition of

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

Last updated: Mon, 21 Dec 2009