The document handler for the eZ Publish 3 XML document markup.
Source for this file: /Document/src/document/xml/ezxml.php
ezcDocument | --ezcDocumentXmlBase | --ezcDocumentEzXml
Version: | //autogen// |
From ezcDocumentXmlBase | |
---|---|
protected |
ezcDocumentXmlBase::$document
|
From ezcDocument | |
protected |
ezcDocument::$errors
|
protected |
ezcDocument::$options
|
protected |
ezcDocument::$path
|
public void |
createFromDocbook(
$document
)
Create document from docbook document |
public ezcDocumentDocbook |
getAsDocbook(
)
Return document compiled to the docbook format |
public mixed |
validateFile(
$file
)
Validate the input file |
public mixed |
validateString(
$string
)
Validate the input string |
From ezcDocumentXmlBase | |
---|---|
public DOMDocument |
ezcDocumentXmlBase::getDomDocument()
Get DOMDocument |
public void |
ezcDocumentXmlBase::loadDomDocument()
Construct directly from DOMDocument |
public void |
ezcDocumentXmlBase::loadString()
Create document from input string |
public string |
ezcDocumentXmlBase::save()
Return document as string |
public void |
ezcDocumentXmlBase::setDomDocument()
Set DOMDocument |
From ezcDocument | |
public ezcDocument |
ezcDocument::__construct()
Construct new document |
public abstract void |
ezcDocument::createFromDocbook()
Create document from docbook document |
public abstract ezcDocumentDocbook |
ezcDocument::getAsDocbook()
Return document compiled to the docbook format |
public array |
ezcDocument::getErrors()
Return list of errors occured during visiting the document. |
public string |
ezcDocument::getPath()
Get document base path |
public void |
ezcDocument::loadFile()
Create document from file |
public abstract void |
ezcDocument::loadString()
Create document from input string |
public abstract string |
ezcDocument::save()
Return document as string |
public void |
ezcDocument::setPath()
Set document base path |
public void |
ezcDocument::triggerError()
Trigger visitor error |
Create document from docbook document
A document of the docbook format is provided and the internal document structure should be created out of this.
This method is required for all formats to have one central format, so that each format can be compiled into each other format using docbook as an intermediate format.
You may of course just call an existing converter for this conversion.
Name | Type | Description |
---|---|---|
$document |
ezcDocumentDocbook |
Method | Description |
---|---|
ezcDocument::createFromDocbook() |
Create document from docbook document |
Return document compiled to the docbook format
The internal document structure is compiled to the docbook format and the resulting docbook document is returned.
This method is required for all formats to have one central format, so that each format can be compiled into each other format using docbook as an intermediate format.
You may of course just call an existing converter for this conversion.
Method | Description |
---|---|
ezcDocument::getAsDocbook() |
Return document compiled to the docbook format |
Validate the input file
Validate the input file against the specification of the current document format.
Returns true, if the validation succeded, and an array with ezcDocumentValidationError objects otherwise.
Name | Type | Description |
---|---|---|
$file |
string |
Method | Description |
---|---|
ezcDocumentValidation::validateFile() |
Validate the input file |
Validate the input string
Validate the input string against the specification of the current document format.
Returns true, if the validation succeded, and an array with ezcDocumentValidationError objects otherwise.
Name | Type | Description |
---|---|---|
$string |
string |
Method | Description |
---|---|
ezcDocumentValidation::validateString() |
Validate the input string |