Class: ODPElement

Source Location: /util/ODPElement.php

Class Overview

DOMElement
   |
   --ODPElement

ODPElement class.

Author(s):

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

Version:

$Revision: 146 $

Copyright:

Constants

Methods

Child classes:

GraphicProperties: GraphicProperties class.

TableRowProperties: TableRowProperties class.

TextProperties: TextProperties class.

ParagraphProperties: ParagraphProperties class.

DefaultStyle: DefaultStyle class.

Inherited Methods

Class: DOMElement (Internal Class)

constructor __construct ( )
appendChild ( )
C14N ( )
C14NFile ( )
cloneNode ( )
compareDocumentPosition ( )
getAttribute ( )
getAttributeNode ( )
getAttributeNodeNS ( )
getAttributeNS ( )
getElementsByTagName ( )
getElementsByTagNameNS ( )
getFeature ( )
getNodePath ( )
getUserData ( )
hasAttribute ( )
hasAttributeNS ( )
hasAttributes ( )
hasChildNodes ( )
insertBefore ( )
isDefaultNamespace ( )
isEqualNode ( )
isSameNode ( )
isSupported ( )
lookupNamespaceUri ( )
lookupPrefix ( )
normalize ( )
removeAttribute ( )
removeAttributeNode ( )
removeAttributeNS ( )
removeChild ( )
replaceChild ( )
setAttribute ( )
setAttributeNode ( )
setAttributeNodeNS ( )
setAttributeNS ( )
setIdAttribute ( )
setIdAttributeNode ( )
setIdAttributeNS ( )
setUserData ( )

Class Details

[line 37]
ODPElement class.

Tags:

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

[ Top ]

Class Methods

method appendChild [line 277]

void appendChild(

$child)

Set attribute with namespace.

Tags:

since:	0.5.2 - 07.03.2007
access:	public

Overrides DOMElement::appendChild ( ) (parent method not documented)

Parameters:

$child

[ Top ]

method getAttributeNS [line 349]

void getAttributeNS(
string
$namespace, string
$tag, [string
$value = null])

Retrieve an attribute with namespace, tag and value.

If a default value is given and the attribute does not exists, it will be created.

Tags:

since:	0.5.2 - 19.03.2007
access:	public

Overrides DOMElement::getAttributeNS ( ) (parent method not documented)

Parameters:

string	$namespace
string	$tag
string	$value	Default value

[ Top ]

method getChildNS [line 309]

bool getChildNS(

$namespace, 
$tag)

Retrieve a child by its namespace and tag from the current node.

Tags:

return:	True, if there is such an element else false.
since:	0.5.2 - 05.03.2007
access:	public

Parameters:

	$namespace
	$tag

[ Top ]

method getDrawAttribute [line 438]

void getDrawAttribute(

$tagname, [
$value = null])

Retrieve a draw attribute of the current element.

'<... draw:$tagname="$ret"...>'

Tags:

since:	0.5.2 - 21.03.2007
access:	public

Parameters:

	$tagname
	$value

[ Top ]

method getElement [line 164]

void getElement(
)

Return this element as uncovered DOMElement.

Tags:

since:	0.5.2 - 07.03.2007
access:	public

[ Top ]

method getElementByTagNameNS [line 198]

DOMElement getElementByTagNameNS(
string
$namespace, string
$tag)

Retrieve (first) element by given tagname and namespace.

Tags:

return:	First found element if there is one,
since:	0.5.2 - 07.03.2007
access:	public

Parameters:

string	$namespace
string	$tag

[ Top ]

method getElementsByTagNameNS [line 180]

DOMNodeList getElementsByTagNameNS(
string
$namespace, string
$tag)

Retrieve elements by given tagname and namespace.

Tags:

return:	List of all found elements.
since:	0.5.2 - 16.03.2007
access:	public

Overrides DOMElement::getElementsByTagNameNS ( ) (parent method not documented)

Parameters:

string	$namespace
string	$tag

[ Top ]

method getStyleAttribute [line 414]

void getStyleAttribute(

$tagname, [
$value = null])

Retrieve a style attribute of the current element.

'<... style:$tagname="$ret"...>'

Tags:

since:	0.5.2 - 19.03.2007
access:	public

Parameters:

	$tagname
	$value

[ Top ]

method hasAttributeNS [line 216]

void hasAttributeNS(

$namespace, 
$tag)

Check if this element has an attribute with given namespace and tagname.

Tags:

since:	0.5.2 - 07.03.2007
access:	public

Overrides DOMElement::hasAttributeNS ( ) (parent method not documented)

Parameters:

	$namespace
	$tag

[ Top ]

method hasChildNS [line 298]

bool hasChildNS(

$namespace, 
$tag)

Check if the current element has a child $tag with $namespace.

Tags:

return:	True, if there is such an element else false.
since:	0.5.2 - 05.03.2007
access:	public

Parameters:

	$namespace
	$tag

[ Top ]

constructor __construct [line 141]

ODPElement __construct(
mixed
$tagelem, [string
$value = NULL], [string
$namespace = NULL])

Constructor.

This is a workaround, because DOMElements are not realy PHP classes.

Tags:

since:

0.5.2 - 07.03.2007

Overrides DOMElement::constructor __construct ( ) (parent method not documented)

Parameters:

mixed	$tagelem	Either a DOMElement or a string
string	$value
string	$namespace

[ Top ]

method putAttributeNS [line 330]

mixed putAttributeNS(

$namespace, 
$tag, 
$value)

Put an attribute with namespace, tag and value.

If an old attribute exists, it will be removed first.

Tags:

return:	True if there was no old attibute, else the old attribute node.
since:	0.5.2 - 05.03.2007
access:	public

Parameters:

	$namespace
	$tag
	$value

[ Top ]

method putDrawAttribute [line 428]

mixed putDrawAttribute(
string
$tagname, string
$value)

Put (set with remove old) a draw attribute to the current ODPElement.

'<... draw:$tagname="$value"...>'

Tags:

return:	True if there was no old attibute, else the old attribute node.
since:	0.5.2 - 21.03.2007
access:	public

Parameters:

string	$tagname	Tagname without prefix.
string	$value	Value of the attribute.

[ Top ]

method putFOAttribute [line 390]

mixed putFOAttribute(
string
$tagname, string
$value)

Put (set with remove old) a FO attribute to the current ODPElement.

'<... fo:$tagname="$value"...>'

Tags:

return:	True if there was no old attibute, else the old attribute node.
since:	0.5.2 - 16.03.2007
access:	public

Parameters:

string	$tagname	Tagname without prefix.
string	$value	Value of the attribute.

[ Top ]

method putStyleAttribute [line 404]

mixed putStyleAttribute(
string
$tagname, string
$value)

Put (set with remove old) a sytle attribute to the current ODPElement.

'<... style:$tagname="$value"...>'

Tags:

return:	True if there was no old attibute, else the old attribute node.
since:	0.5.2 - 16.03.2007
access:	public

Parameters:

string	$tagname	Tagname without prefix.
string	$value	Value of the attribute.

[ Top ]

method removeAttributeNS [line 231]

void removeAttributeNS(

$namespace, 
$tag)

Set attribute with namespace.

Tags:

since:	0.5.2 - 07.03.2007
access:	public

Overrides DOMElement::removeAttributeNS ( ) (parent method not documented)

Parameters:

	$namespace
	$tag

[ Top ]

method setAttributeNS [line 246]

void setAttributeNS(

$namespace, 
$tag, 
$value)

Set attribute with namespace.

Tags:

since:	0.5.2 - 07.03.2007
access:	public

Overrides DOMElement::setAttributeNS ( ) (parent method not documented)

Parameters:

	$namespace
	$tag
	$value

[ Top ]

method setManifestAttribute [line 376]

mixed setManifestAttribute(

$tag, string
$value, string
$tagname)

Set a Manifest attribute to the current ODPElement.

'<... manifest:$tagname="$value"...>'

Tags:

return:	True if there was no old attibute, else the old attribute node.
since:	0.5.2 - 16.03.2007
access:	public

Parameters:

string	$tagname	Tagname without prefix.
string	$value	Value of the attribute.
	$tag

[ Top ]

Class Constants

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

[line 93]

namespace OpenDocument animation

[ Top ]

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

[line 73]

namespace OpenDocument chart

[ Top ]

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

[line 81]

namespace OpenDocument config

[ Top ]

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

[line 113]

namespace Dublin Core

[ Top ]

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

[line 89]

namespace OpenDocument dr3d

[ Top ]

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

[line 61]

namespace OpenDocument draw

[ Top ]

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

[line 105]

namespace OpenDocument fo (formation objects)

[ Top ]

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

[line 77]

namespace OpenDocument form

[ Top ]

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

[line 49]

namespace OpenDocument manifest

[ Top ]

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

[line 125]

namespace MathML

[ Top ]

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

[line 41]

namespace OpenDocument meta

[ Top ]

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

[line 69]

namespace OpenDocument number

[ Top ]

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

[line 45]

namespace OpenDocument office

[ Top ]

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

[line 85]

namespace OpenDocument presentation

[ Top ]

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

[line 97]

namespace OpenDocument script

[ Top ]

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

[line 109]

namespace OpenDocument smil

[ Top ]

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

[line 53]

namespace OpenDocument style

[ Top ]

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

[line 101]

namespace OpenDocument svg

[ Top ]

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

[line 65]

namespace OpenDocument table

[ Top ]

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

[line 57]

namespace OpenDocument text

[ Top ]

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

[line 121]

namespace XForms

[ Top ]

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

[line 117]

namespace XLink

[ Top ]

Documentation generated on Tue, 12 Jun 2007 10:00:18 +0200 by phpDocumentor 1.3.2