Class: AbstractDocument

Source Location: /util/AbstractDocument.php

Class AbstractDocument

Class Overview

Implements interfaces:

Namespaces

AbstractDocument class.

This class can use the PEAR:XML_Beautifier to pimp up the xml output strings. If you want to use it, you should do something like:

define("ODP_USE_XML_BEAUTIFIER", "yes");
require 'OpenDocumentPHP/AbstractDocument.php';

Located in /util/AbstractDocument.php [line 89]

DOMDocument
   |
   --AbstractDocument

Author(s):

Norman Markgraf (nmarkgraf(at)user.sourceforge.net)

Information Tags:

Version:	Release: @package_version@
Copyright:	Copyright in 2006, 2007 by The OpenDocumentPHP Team
Link:	http://opendocumentphp.org
Since:	0.5.0 - 08. Feb. 2007
License:	GNU General Public License 2.0.

Properties

$root
$xpath

Methods

[ Top ]

Direct descendents

Child Class	Description
SettingsDocument	SettingsDocument class.
StylesDocument	StylesDocument class.
ManifestDocument	ManifestDocument class
MetaDocument	MetaDocument class.
ContentDocument	ContentDocument class.

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From DOMDocument (Internal Class)

constructor __construct ( )

adoptNode ( )

appendChild ( )

C14N ( )

C14NFile ( )

cloneNode ( )

compareDocumentPosition ( )

createAttribute ( )

createAttributeNS ( )

createCDATASection ( )

createComment ( )

createDocumentFragment ( )

createElement ( )

createElementNS ( )

createEntityReference ( )

createProcessingInstruction ( )

createTextNode ( )

getElementById ( )

getElementsByTagName ( )

getElementsByTagNameNS ( )

getFeature ( )

getNodePath ( )

getUserData ( )

hasAttributes ( )

hasChildNodes ( )

importNode ( )

insertBefore ( )

isDefaultNamespace ( )

isEqualNode ( )

isSameNode ( )

isSupported ( )

load ( )

loadHTML ( )

loadHTMLFile ( )

loadXML ( )

lookupNamespaceUri ( )

lookupPrefix ( )

normalize ( )

normalizeDocument ( )

registerNodeClass ( )

relaxNGValidate ( )

relaxNGValidateSource ( )

removeChild ( )

renameNode ( )

replaceChild ( )

save ( )

saveHTML ( )

saveHTMLFile ( )

saveXML ( )

schemaValidate ( )

schemaValidateSource ( )

setUserData ( )

validate ( )

xinclude ( )

[ Top ]

Property Summary

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

[ Top ]

Method Summary

AbstractDocument	__construct()	Constructor method.
DOMElement	createDCElement()	Create an DOMElement in the DC namespace with tag $tag.
ODPElement	createDefaultStyleElement()	Create an ODPElement as '<style:default-style>'.
ODPElement	createGraphicPropertiesElement()	Create an ODPElement as '<style:graphic-properties>'.
DOMElement	createManifestElement()	Create an DOMElement in the Manifest namespace with tag $tag.
DOMElement	createMetaElement()	Create an DOMElement in the Meta namespace with tag $tag.
DOMElement	createOfficeElement()	Create an DOMElement in the Office namespace with tag $tag.
ODPElement	createParagraphPropertiesElement()	Create an ODPElement as '<style:paragraph-properties>'.
DOMElement	createStyleElement()	Create an DOMElement in the Meta namespace with tag $tag.
ODPElement	createStyleStyleElement()	Create an ODPElement as '<style:style>'.
ODPElement	createTextPropertiesElement()	Create an ODPElement as '<style:text-properties>'.
mixed	getElementNS()	Retrieve the value of an element by its namespace and tag.
void	initXpath()	Initialize xpath. You must do this before using xpath.
void	loadHTML()	This function is not needed, so we always return false!
void	loadHTMLFile()	This function is not needed, so we always return false!
void	saveHTML()	This function is not needed, so we always return false!
void	saveHTMLFile()	This function is not needed, so we always return false!
void	saveXML()	Dumps the internal XML tree back into a string.
void	_setRoot()	Set the root Element of this document.

[ Top ]

Properties

DOMElement $root [line 97]

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

API Tags:

Access:

protected

Information Tags:

Since:

0.5.0 - 08. Feb. 2007

Redefined in descendants as:

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

[ Top ]

DOMXpath $xpath = null [line 103]

API Tags:

Access:

protected

Information Tags:

Since:

0.5.2 - 26. Feb. 2007

[ Top ]

Methods

Constructor __construct [line 109]

AbstractDocument __construct(
[
$documentRoot = NULL] 
)

Constructor method.

Parameters:

$documentRoot:

Information Tags:

Since:

0.5.0 - 08. Feb. 2007

Redefinition of:

DOMDocument::constructor __construct ( )

Redefined in descendants as:

SettingsDocument::__construct() : Constructor method.
StylesDocument::__construct() : Constructor method.
ManifestDocument::__construct() : Constructor
MetaDocument::__construct() : Construtor method.
ContentDocument::__construct() : Constructor method.

[ Top ]

createDCElement [line 324]

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

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

Parameters:

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

API Tags:

Access:

protected

Information Tags:

Since:

0.5.2 - 05. Mar. 2007

[ Top ]

createDefaultStyleElement [line 402]

ODPElement createDefaultStyleElement(
)

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

API Tags:

Access:

public

Information Tags:

Since:

0.5.2 - 19. Mar. 2007

[ Top ]

createGraphicPropertiesElement [line 378]

ODPElement createGraphicPropertiesElement(
)

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

API Tags:

Access:

public

Information Tags:

Since:

0.5.2 - 16. Mar. 2007

[ Top ]

createManifestElement [line 336]

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

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

Parameters:

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

API Tags:

Access:

protected

Information Tags:

Since:

0.5.2 - 05. Mar. 2007

[ Top ]

createMetaElement [line 300]

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

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

Parameters:

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

API Tags:

Access:

protected

Information Tags:

Since:

0.5.2 - 05. Mar. 2007

[ Top ]

createOfficeElement [line 288]

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="" />

Parameters:

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

API Tags:

Access:

protected

Information Tags:

Since:

0.5.2 - 05. Mar. 2007

[ Top ]

createParagraphPropertiesElement [line 362]

ODPElement createParagraphPropertiesElement(
)

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

API Tags:

Access:

public

Information Tags:

Since:

0.5.2 - 16. Mar. 2007

[ Top ]

createStyleElement [line 312]

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

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

Parameters:

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

API Tags:

Access:

protected

Information Tags:

Since:

0.5.2 - 05. Mar. 2007

[ Top ]

createStyleStyleElement [line 418]

ODPElement createStyleStyleElement(
)

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

API Tags:

Access:

public

Information Tags:

Since:

0.5.2 - 19. Mar. 2007

[ Top ]

createTextPropertiesElement [line 346]

ODPElement createTextPropertiesElement(
)

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

API Tags:

Access:

public

Information Tags:

Since:

0.5.2 - 16. Mar. 2007

[ Top ]

getElementNS [line 154]

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

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

Parameters:

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

API Tags:

Return:	The value of the element as string or the boolean 'false', if no element was found.
Access:	public

Information Tags:

Since:

0.5.0 - 08. Feb. 2007

[ Top ]

initXpath [line 254]

void initXpath(
)

Initialize xpath. You must do this before using xpath.

API Tags:

Access:

protected

Information Tags:

Since:

0.5.2 - 26. Feb. 2007

[ Top ]

loadHTML [line 218]

void loadHTML(

$source 
)

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

Parameters:

$source:

API Tags:

Access:

public

Information Tags:

Since:

0.5.0 - 08. Feb. 2007

Redefinition of:

DOMDocument::loadHTML ( )

[ Top ]

loadHTMLFile [line 227]

void loadHTMLFile(

$filename 
)

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

Parameters:

$filename:

API Tags:

Access:

public

Information Tags:

Since:

0.5.0 - 08. Feb. 2007

Redefinition of:

DOMDocument::loadHTMLFile ( )

[ Top ]

saveHTML [line 236]

void saveHTML(
)

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

API Tags:

Access:

public

Information Tags:

Since:

0.5.0 - 08. Feb. 2007

Redefinition of:

DOMDocument::saveHTML ( )

[ Top ]

saveHTMLFile [line 245]

void saveHTMLFile(

$filename 
)

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

Parameters:

$filename:

API Tags:

Access:

public

Information Tags:

Since:

0.5.0 - 08. Feb. 2007

Redefinition of:

DOMDocument::saveHTMLFile ( )

[ Top ]

saveXML [line 175]

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.

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.

API Tags:

Access:

public

Information Tags:

Since:

0.5.0 - 08. Feb. 2007

Redefinition of:

DOMDocument::saveXML ( )

Redefined in descendants as:

StylesDocument::saveXML()

[ Top ]

_setRoot [line 137]

void _setRoot(
[
$documentRoot = null] 
)

Set the root Element of this document.

Parameters:

$documentRoot:

API Tags:

Access:

protected

Information Tags:

Since:

0.5.1 - 08. Feb. 2007

Redefined in descendants as:

ManifestDocument::_setRoot()

[ Top ]

Documentation generated on Wed, 18 Jun 2008 06:27:19 +0200 by phpDocumentor 1.3.2

	OpenDocumentPHP util

[ class tree: OpenDocumentPHP ] [ index: OpenDocumentPHP ] [ all elements ]