Class: AbstractDocument

author:	Norman Markgraf (nmarkgraf(at)user.sourceforge.net)
version:	$Revision: 161 $
copyright:	Copyright in 2006, 2007 by The OpenDocumentPHP Team
since:	0.5.0 - 08.02.2007
license:	GNU General Public License 2.0.

[ Top ]

Class Variables

$root =

[line 135]

Link to the DOMElement which is the root of this DOM document.

Tags:

since:	0.5.0 - 08.02.2007
access:	protected

Type:

DOMElement

[ Top ]

$xpath = null

[line 141]

Tags:

since:	0.5.2 - 26.02.2007
access:	protected

Type:

DOMXpath

[ Top ]

Class Methods

constructor __construct [line 147]

AbstractDocument __construct(
[
$documentRoot = NULL])

Constructor method.

Parameters:

$documentRoot

[ Top ]

method createDCElement [line 349]

DOMElement createDCElement(
string
$tag, [string
$value = null])

Create an DOMElement in the DC namespace with tag $tag.

Tags:

since:	0.5.2 - 05.03.2007
access:	protected

Parameters:

string	$tag	Tag of the new DOMElement
string	$value	If seted, this is the node value.

[ Top ]

method createDefaultStyleElement [line 427]

ODPElement createDefaultStyleElement(
)

Create an ODPElement as '<style:default-style>'.

Tags:

since:	0.5.2 - 19.03.2007
access:	public

[ Top ]

method createGraphicPropertiesElement [line 403]

ODPElement createGraphicPropertiesElement(
)

Create an ODPElement as '<style:graphic-properties>'.

Tags:

since:	0.5.2 - 16.03.2007
access:	public

[ Top ]

method createManifestElement [line 361]

DOMElement createManifestElement(
string
$tag, [string
$value = null])

Create an DOMElement in the Manifest namespace with tag $tag.

Tags:

since:	0.5.2 - 05.03.2007
access:	protected

Parameters:

string	$tag	Tag of the new DOMElement
string	$value	If seted, this is the node value.

[ Top ]

method createMetaElement [line 316]

DOMElement createMetaElement(
string
$tag, [string
$value = null])

Create an DOMElement in the Meta namespace with tag $tag.

Tags:

since:	0.5.2 - 05.03.2007
access:	protected

Parameters:

string	$tag	Tag of the new DOMElement
string	$value	If seted, this is the node value.

[ Top ]

method createOfficeElement [line 304]

DOMElement createOfficeElement(
string
$tag, string
$value)

Create an DOMElement in the Office namespace with tag $tag.

Example:

$this->createOfficeElement('document');

will create an DOMElement like:

<office:document xmlns:office="" />

Tags:

since:	0.5.2 - 05.03.2007
access:	protected

Parameters:

string	$tag	Tag of the new DOMElement
string	$value	If seted, this is the node value.

[ Top ]

method createParagraphPropertiesElement [line 387]

ODPElement createParagraphPropertiesElement(
)

Create an ODPElement as '<style:paragraph-properties>'.

Tags:

since:	0.5.2 - 16.03.2007
access:	public

[ Top ]

method createStyleElement [line 328]

DOMElement createStyleElement(
string
$tag, [string
$value = null])

Create an DOMElement in the Meta namespace with tag $tag.

Tags:

since:	0.5.2 - 05.03.2007
access:	protected

Parameters:

string	$tag	Tag of the new DOMElement
string	$value	If seted, this is the node value.

[ Top ]

method createStyleStyleElement [line 443]

ODPElement createStyleStyleElement(
)

Create an ODPElement as '<style:style>'.

Tags:

since:	0.5.2 - 19.03.2007
access:	public

[ Top ]

method createTextPropertiesElement [line 371]

ODPElement createTextPropertiesElement(
)

Create an ODPElement as '<style:text-properties>'.

Tags:

since:	0.5.2 - 16.03.2007
access:	public

[ Top ]

method getElementNS [line 195]

mixed getElementNS(
string
$namespace, 
$element, string
$elemet)

Retrieve the value of an element by its namespace and tag.

Tags:

return:	The value of the element as string or the boolean 'false', if no element was found.
since:	0.5.0 - 08.02.2007
access:	public

Parameters:

string	$namespace	Namespace of the element.
string	$elemet	Tag of the element.
	$element

[ Top ]

method initXpath [line 270]

void initXpath(
)

Initialize xpath. You must do this before using xpath.

Tags:

since:	0.5.2 - 26.02.2007
access:	protected

[ Top ]

method loadHTML [line 234]

void loadHTML(

$source)

This function is not needed, so we always return false!

Tags:

since:	0.5.0 - 08.02.2007
access:	public

Overrides DOMDocument::loadHTML ( ) (parent method not documented)

Parameters:

$source

[ Top ]

method loadHTMLFile [line 243]

void loadHTMLFile(

$filename)

This function is not needed, so we always return false!

Tags:

since:	0.5.0 - 08.02.2007
access:	public

Overrides DOMDocument::loadHTMLFile ( ) (parent method not documented)

Parameters:

$filename

[ Top ]

method saveHTML [line 252]

void saveHTML(
)

This function is not needed, so we always return false!

Tags:

since:	0.5.0 - 08.02.2007
access:	public

Overrides DOMDocument::saveHTML ( ) (parent method not documented)

[ Top ]

method saveHTMLFile [line 261]

void saveHTMLFile(

$filename)

This function is not needed, so we always return false!

Tags:

since:	0.5.0 - 08.02.2007
access:	public

Overrides DOMDocument::saveHTMLFile ( ) (parent method not documented)

Parameters:

$filename

[ Top ]

method saveXML [line 216]

void saveXML(
[DOMNode
$node = NULL], [int
$options = NULL])

Dumps the internal XML tree back into a string.

Creates an XML document from the DOM representation. This function is usually called after building a new DOM document from scratch.

Tags:

since:	0.5.0 - 08.02.2007
access:	public

Overridden in child classes as:

StylesDocument::saveXML()

Overrides DOMDocument::saveXML ( ) (parent method not documented)

Parameters:

DOMNode	$node	Use this parameter to output only a specific node without XML declaration rather than the entire document.
int	$options	Additional Options. Currently only LIBXML_NOEMPTYTAG is supported.

[ Top ]

method _setRoot [line 178]

void _setRoot(
[
$documentRoot = NULL])

Set the root Element of this document.

Tags:

since:	0.5.1 - 08.02.2007
access:	protected

Overridden in child classes as:

ManifestDocument::_setRoot()

Parameters:

$documentRoot

[ Top ]

Class Constants

ANIM = 'urn:oasis:names:tc:opendocument:xmlns:animation:1.0'

[line 95]

namespace OpenDocument animation

[ Top ]

CHART = 'urn:oasis:names:tc:opendocument:xmlns:chart:1.0'

[line 75]

namespace OpenDocument chart

[ Top ]

CONFIG = 'urn:oasis:names:tc:opendocument:xmlns:config:1.0'

[line 83]

namespace OpenDocument config

[ Top ]

DC = 'http://purl.org/dc/elements/1.1/'

[line 115]

namespace Dublin Core

[ Top ]

DR3D = 'urn:oasis:names:tc:opendocument:xmlns:dr3d:1.0'

[line 91]

namespace OpenDocument dr3d

[ Top ]

DRAW = 'urn:oasis:names:tc:opendocument:xmlns:drawing:1.0'

[line 63]

namespace OpenDocument draw

[ Top ]

FO = 'urn:oasis:names:tc:opendocument:xmlns:xsl-fo-compatible:1.0'

[line 107]

namespace OpenDocument fo (formation objects)

[ Top ]

FORM = 'urn:oasis:names:tc:opendocument:xmlns:form:1.0'

[line 79]

namespace OpenDocument form

[ Top ]

MANIFEST = 'urn:oasis:names:tc:opendocument:xmlns:manifest:1.0'

[line 51]

namespace OpenDocument manifest

[ Top ]

MATHML = 'http://www.w3.org/1998/Math/MathML'

[line 127]

namespace MathML

[ Top ]

META = 'urn:oasis:names:tc:opendocument:xmlns:meta:1.0'

[line 43]

namespace OpenDocument meta

[ Top ]

NUMBER = 'urn:oasis:names:tc:opendocument:xmlns:datastyle:1.0'

[line 71]

namespace OpenDocument number

[ Top ]

OFFICE = 'urn:oasis:names:tc:opendocument:xmlns:office:1.0'

[line 47]

namespace OpenDocument office

[ Top ]

PRESENTATION = 'urn:oasis:names:tc:opendocument:xmlns:presentation:1.0'

[line 87]

namespace OpenDocument presentation

[ Top ]

SCRIPT = 'urn:oasis:names:tc:opendocument:xmlns:script:1.0'

[line 99]

namespace OpenDocument script

[ Top ]

SMIL = 'urn:oasis:names:tc:opendocument:xmlns:smil-compatible:1.0'

[line 111]

namespace OpenDocument smil

[ Top ]

STYLE = 'urn:oasis:names:tc:opendocument:xmlns:style:1.0'

[line 55]

namespace OpenDocument style

[ Top ]

SVG = 'urn:oasis:names:tc:opendocument:xmlns:svg-compatible:1.0'

[line 103]

namespace OpenDocument svg

[ Top ]

TABLE = 'urn:oasis:names:tc:opendocument:xmlns:table:1.0'

[line 67]

namespace OpenDocument table

[ Top ]

TEXT = 'urn:oasis:names:tc:opendocument:xmlns:text:1.0'

[line 59]

namespace OpenDocument text

[ Top ]

XFORMS = 'http://www.w3.org/2002/xforms'

[line 123]

namespace XForms

[ Top ]

XLINK = 'http://www.w3.org/1999/xlink'

[line 119]

namespace XLink

[ Top ]

Documentation generated on Tue, 12 Jun 2007 09:59:21 +0200 by phpDocumentor 1.3.2