Path

ez components / documentation / api reference / 2009.2.1 / document

eZ Components 2009.2.1

Document: ezcDocumentDocbookToOdtConverter

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

Class: ezcDocumentDocbookToOdtConverter

Converter for docbook to ODT with a PHP callback based mechanism, for fast and easy PHP based extensible transformations. [source]
This converter does not support the full docbook standard, but only a subset commonly used in the document component.

Parents

ezcDocumentConverter
   |
   --ezcDocumentElementVisitorConverter
      |
      --ezcDocumentDocbookToOdtConverter

Member Variables

protected ezcDocumentOdtTextProcessor $textProcessor
Text node processor.

Inherited Member Variables

From ezcDocumentElementVisitorConverter:
protected  ezcDocumentElementVisitorConverter::$defaultNamespace
protected  ezcDocumentElementVisitorConverter::$storage
protected  ezcDocumentElementVisitorConverter::$visitorElementHandler
From ezcDocumentConverter:
protected  ezcDocumentConverter::$options
protected  ezcDocumentConverter::$properties

Method Summary

public void __construct( [$options = null] )
Construct converter
public ezcDocumentOdt convert( $source )
Converts the given DocBook $source to an ODT document.
protected ezcDocumentDocument createDocument( $content )
Create document from structure
public ezcDocumentOdtImageLocator getImageLocator( )
Returns the image locator for the current conversion.
protected mixed initializeDocument( )
Initialize destination document
protected mixed visitText( $node, $root )
Visit text node.

Inherited Methods

From ezcDocumentElementVisitorConverter :
public ezcDocumentDocument ezcDocumentElementVisitorConverter::convert()
Convert documents between two formats
protected abstract ezcDocumentDocument ezcDocumentElementVisitorConverter::createDocument()
Create document from structure
protected abstract mixed ezcDocumentElementVisitorConverter::initializeDocument()
Initialize destination document
public void ezcDocumentElementVisitorConverter::setElementHandler()
Set custom element handler
public mixed ezcDocumentElementVisitorConverter::visitChildren()
Recursively visit children of a document node.
protected void ezcDocumentElementVisitorConverter::visitElement()
Visit DOMElement nodes.
public mixed ezcDocumentElementVisitorConverter::visitNode()
Visit a single document node
protected abstract mixed ezcDocumentElementVisitorConverter::visitText()
Visit text node.
From ezcDocumentConverter :
public ezcDocumentConverter ezcDocumentConverter::__construct()
Construct new document
public abstract ezcDocument ezcDocumentConverter::convert()
Convert documents between two formats
public array ezcDocumentConverter::getErrors()
Return list of errors occured during visiting the document.
public void ezcDocumentConverter::triggerError()
Trigger parser error

Methods

__construct

void __construct( [ezcDocumentDocbookToOdtConverterOptions $options = null] )
Construct converter
Construct converter from XSLT file, which is used for the actual

Parameters

Name Type Description
$options ezcDocumentDocbookToOdtConverterOptions  

Redefinition of

Method Description
ezcDocumentConverter::__construct() Construct new document

convert

ezcDocumentOdt convert( ezcDocumentDocbook $source )
Converts the given DocBook $source to an ODT document.
This method receives a DocBook $source document and returns the converters ODT document.

Parameters

Name Type Description
$source ezcDocumentDocbook  

Redefinition of

Method Description
ezcDocumentElementVisitorConverter::convert() Convert documents between two formats

createDocument

ezcDocumentDocument createDocument( mixed $content )
Create document from structure
Build a ezcDocumentDocument object from the structure created during the visiting process.

Parameters

Name Type Description
$content mixed  

Redefinition of

Method Description
ezcDocumentElementVisitorConverter::createDocument() Create document from structure

getImageLocator

ezcDocumentOdtImageLocator getImageLocator( )
Returns the image locator for the current conversion.

initializeDocument

mixed initializeDocument( )
Initialize destination document
Initialize the structure which the destination document could be build with. This may be an initial DOMDocument with some default elements, or a string, or something else.

Redefinition of

Method Description
ezcDocumentElementVisitorConverter::initializeDocument() Initialize destination document

visitText

mixed visitText( $node, mixed $root )
Visit text node.
Visit a text node in the source document and transform it to the destination result

Parameters

Name Type Description
$node DOMText  
$root mixed  

Redefinition of

Method Description
ezcDocumentElementVisitorConverter::visitText() Visit text node.

Last updated: Tue, 23 Mar 2010