Zeta Components Manual :: Docs For Class ezcDocumentDocbookToRstConverterOptions
Document::ezcDocumentDocbookToRstConverterOptions
Class ezcDocumentDocbookToRstConverterOptions
Class containing the basic options for the ezcDocumentEzp3Xml class
Source for this file: /Document/src/options/converter_docbook_rst.php
ezcBaseOptions | --ezcDocumentConverterOptions | --ezcDocumentDocbookToRstConverterOptions
| Version: | //autogen// |
Properties
| array | read/write |
$headerTypes
Array of special characters to use fore headings in RST output. If two chracters are given, the heading will be rendered with an over and underline. |
| int | read/write |
$itemListCharacter
Character used for item lists. Defaults to -, valid are also: *, +, •, ‣, ⃠wrapped at the given position. Defaults to 78. |
| int | read/write |
$wordWrap
Maximum number of characters per line. The contents will be wrapped at the given position. Defaults to 78. |
Inherited Member Variables
| From ezcDocumentConverterOptions | |
|---|---|
| protected |
ezcDocumentConverterOptions::$properties
|
Method Summary
| public ezcDocumentDocbookToRstConverterOptions |
__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
ezcDocumentDocbookToRstConverterOptions
__construct(
[
$options
= array()] )
Constructs an object with the specified values.
Parameters:
| Name | Type | Description |
|---|---|---|
$options |
array(string=>mixed) |
Exceptions:
| Type | Description |
|---|---|
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. |
Documentation generated by phpDocumentor 1.4.3