Path

ez components / documentation / api reference / 2008.2.2 / document

eZ Components 2008.2.2

Document: ezcDocumentRstIncludeDirective

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

Class: ezcDocumentRstIncludeDirective

Visitor for RST include directives [source]

Implemented Interfaces

Parents

ezcDocumentRstDirective
   |
   --ezcDocumentRstIncludeDirective

Inherited Member Variables

From ezcDocumentRstDirective:
protected  ezcDocumentRstDirective::$ast
protected  ezcDocumentRstDirective::$node
protected  ezcDocumentRstDirective::$path
protected  ezcDocumentRstDirective::$visitor

Method Summary

protected string getFile( $file )
Check and return file
public void toDocbook( $document, $root )
Transform directive to docbook
public void toXhtml( $document, $root )
Transform directive to HTML

Inherited Methods

From ezcDocumentRstDirective :
public void ezcDocumentRstDirective::__construct()
Construct directive from AST and node
public void ezcDocumentRstDirective::setSourceVisitor()
Set the calling vaisitor
public abstract void ezcDocumentRstDirective::toDocbook()
Transform directive to docbook

Methods

getFile

string getFile( string $file )
Check and return file
Check for the files location, and return the absolute path to the file, or thorw an exception, if the file could not be found.

Parameters

Name Type Description
$file string  

toDocbook

void toDocbook( $document, $root )
Transform directive to docbook
Create a docbook XML structure at the directives position in the document.

Parameters

Name Type Description
$document DOMDocument  
$root DOMElement  

Redefinition of

Method Description
ezcDocumentRstDirective::toDocbook() Transform directive to docbook

toXhtml

void toXhtml( $document, $root )
Transform directive to HTML
Create a XHTML structure at the directives position in the document.

Parameters

Name Type Description
$document DOMDocument  
$root DOMElement  

Last updated: Mon, 30 Mar 2009