Class: SettingsDocument

Source Location: /settings/SettingsDocument.php

Class SettingsDocument

Class Overview

SettingsDocument class.

OpenDocumentPHP does not support the settings document right now. But it is in the OpenDocument documentation, so we have build a wrapper class for it.

Because of that, no real functionality is added. Feel free to change it. ;-)

Located in /settings/SettingsDocument.php [line 72]

DOMDocument
   |
   --AbstractDocument
      |
      --SettingsDocument

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.

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From AbstractDocument

AbstractDocument::$root

AbstractDocument::$xpath

Inherited From AbstractDocument

AbstractDocument::__construct()

Constructor method.

AbstractDocument::createDCElement()

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

AbstractDocument::createDefaultStyleElement()

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

AbstractDocument::createGraphicPropertiesElement()

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

AbstractDocument::createManifestElement()

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

AbstractDocument::createMetaElement()

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

AbstractDocument::createOfficeElement()

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

AbstractDocument::createParagraphPropertiesElement()

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

AbstractDocument::createStyleElement()

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

AbstractDocument::createStyleStyleElement()

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

AbstractDocument::createTextPropertiesElement()

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

AbstractDocument::getElementNS()

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

AbstractDocument::initXpath()

Initialize xpath. You must do this before using xpath.

AbstractDocument::loadHTML()

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

AbstractDocument::loadHTMLFile()

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

AbstractDocument::saveHTML()

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

AbstractDocument::saveHTMLFile()

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

AbstractDocument::saveXML()

Dumps the internal XML tree back into a string.

AbstractDocument::_setRoot()

Set the root Element of this document.

[ Top ]

Method Summary

SettingsDocument	__construct()	Constructor method.
void	loadXML()	Loads a settings document into this SettingsDocument object.

[ Top ]

Properties

Methods

Constructor __construct [line 105]

SettingsDocument __construct(
)

Constructor method.

We construct an empty settings document here. It should look like:

<?xml version="1.0" encoding="UTF-8"?>
<office:document-settings xmlns:office="urn:oasis:names:tc:opendocument:xmlns:office:1.0" office:version="1.0">
<office:settings/>
</office:document-settings>

This is in general not a valid document, because the <office:settings> tag needs some children (one or more config items). If there are no such children the saveXML() method will remove the <office:settings/> tag to match the RelaxNG specification. So currently the saved settings.xml should look more like:

<?xml version="1.0" encoding="UTF-8"?>
<office:document-settings xmlns:office="urn:oasis:names:tc:opendocument:xmlns:office:1.0" office:version="1.0" /

Information Tags:

Since:

0.5.0 - 08. Feb. 2007

Redefinition of:

AbstractDocument::__construct(): Constructor method.

[ Top ]

loadXML [line 145]

void loadXML(

$source 
)

Loads a settings document into this SettingsDocument object.

Parameters:

$source:

API Tags:

Access:

public

Information Tags:

Since:

0.5.2 - 22. Feb. 2007

[ Top ]

Documentation generated on Wed, 18 Jun 2008 06:31:56 +0200 by phpDocumentor 1.3.2

	OpenDocumentPHP settings

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