Class: ODPElement

Source Location: /util/ODPElement.php

Class ODPElement

Class Overview

Implements interfaces:

Namespaces

ODPElement class.

Located in /util/ODPElement.php [line 64]

DOMElement
   |
   --ODPElement

Author(s):

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

API Tags:

Abstract:

Information Tags:

Version:	Release: @package_version@
Copyright:	Copyright in 2006, 2007 by OpenDocumentPHP Team
Link:	http://opendocumentphp.org
Since:	0.5.2 - 05. Mar. 2007
License:	GNU General Public License 2.0.

Methods

[ Top ]

Direct descendents

Child Class	Description
AutomaticStylesFragment	AutomaticStylesFragment class.
FontFaceDeclFragment	FontFaceDeclFragment class.
FontFace	FontFace class.
GraphicProperties	GraphicProperties class.
TableRowProperties	TableRowProperties class.
TextProperties	TextProperties class.
ParagraphProperties	ParagraphProperties class.
TableProperties	TableProperties class.
TableColumnProperties	TableColumnProperties class.
MasterStylesFragment	MasterStylesFragment class.
DefaultStyle	DefaultStyle class.
StylesFragment	SytlesFragment class.
Script	Script class.
UserFieldDecl	UserFieldDecl class.
UserFieldDecls	UserFieldDecls class.
UserFieldGet	UserFieldGet class.
Paragraph	Paragraph class.
TextFragment	TextFragment class.
TableCell	TableCell class.
SpreadsheetFragment	SpreadsheetFragment class.
TableFragment	TableFragment class.
BodyFragment	BodyFragment class.
ScriptsFragment	ScriptsFragment class.

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From 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 ( )

[ Top ]

Method Summary

ODPElement	__construct()	Constructor.
void	appendChild()	Set attribute with namespace.
void	getAttributeNS()	Retrieve an attribute with namespace, tag and value.
bool	getChildNS()	Retrieve a child by its namespace and tag from the current node.
void	getDrawAttribute()	Retrieve a draw attribute of the current element.
void	getElement()	Return this element as uncovered DOMElement.
DOMElement	getElementByTagNameNS()	Retrieve (first) element by given tagname and namespace.
DOMNodeList	getElementsByTagNameNS()	Retrieve elements by given tagname and namespace.
void	getStyleAttribute()	Retrieve a style attribute of the current element.
void	hasAttributeNS()	Check if this element has an attribute with given namespace and tagname.
bool	hasChildNS()	Check if the current element has a child $tag with $namespace.
mixed	putAttributeNS()	Put an attribute with namespace, tag and value.
mixed	putDrawAttribute()	Put (set with remove old) a draw attribute to the current ODPElement.
mixed	putFOAttribute()	Put (set with remove old) a FO attribute to the current ODPElement.
mixed	putStyleAttribute()	Put (set with remove old) a sytle attribute to the current ODPElement.
void	removeAttributeNS()	Set attribute with namespace.
void	setAttributeNS()	Set attribute with namespace.
mixed	setManifestAttribute()	Set a Manifest attribute to the current ODPElement.

[ Top ]

Methods

Constructor __construct [line 85]

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

Constructor.

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

Parameters:

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

Information Tags:

Since:

0.5.2 - 07. Mar. 2007

Redefinition of:

DOMElement::constructor __construct ( )

Redefined in descendants as:

AutomaticStylesFragment::__construct() : Constructor method.
FontFaceDeclFragment::__construct() : Constructor method.
FontFace::__construct() : Constructor method.
GraphicProperties::__construct() : Constructor method.
TableRowProperties::__construct() : Constructor method.
TextProperties::__construct() : Constructor method.
ParagraphProperties::__construct() : Constructor method.
TableProperties::__construct() : Constructor method.
TableColumnProperties::__construct() : Constructor method.
MasterStylesFragment::__construct() : Constructor method.
DefaultStyle::__construct() : Constructor method.
Style::__construct() : Constructor method.
StylesFragment::__construct() : Constructor method.
Script::__construct() : Constructor method.
UserFieldDecl::__construct() : Constructor method.
UserFieldDecls::__construct() : Constructor method.
UserFieldGet::__construct() : Constructor method.
Paragraph::__construct() : Constructor method.
Heading::__construct() : Constructor method.
TextFragment::__construct() : Constructor method.
TableCell::__construct()
SpreadsheetFragment::__construct() : Constructor method.
TableFragment::__construct() : Constructor method.
BodyFragment::__construct() : Constructor method.
ScriptsFragment::__construct() : Constructor method.

[ Top ]

appendChild [line 244]

void appendChild(

$child 
)

Set attribute with namespace.

Parameters:

$child:

API Tags:

Access:

public

Information Tags:

Since:

0.5.2 - 07. Mar. 2007

Redefinition of:

DOMElement::appendChild ( )

[ Top ]

getAttributeNS [line 342]

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.

Parameters:

string	$namespace:
string	$tag:
string	$value:	Default value

API Tags:

Access:

public

Information Tags:

Since:

0.5.2 - 19. Mar. 2007

Redefinition of:

DOMElement::getAttributeNS ( )

[ Top ]

getChildNS [line 298]

bool getChildNS(

$namespace, 
$tag 
)

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

Parameters:

	$namespace:
	$tag:

API Tags:

Return:	True, if there is such an element else false.
Access:	public

Information Tags:

Since:

0.5.2 - 05. Mar. 2007

[ Top ]

getDrawAttribute [line 447]

void getDrawAttribute(

$tagname, [
$value = null] 
)

Retrieve a draw attribute of the current element.

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

Parameters:

	$tagname:
	$value:

API Tags:

Access:

public

Information Tags:

Since:

0.5.2 - 21. Mar. 2007

[ Top ]

getElement [line 114]

void getElement(
)

Return this element as uncovered DOMElement.

API Tags:

Access:

public

Information Tags:

Since:

0.5.2 - 07. Mar. 2007

[ Top ]

getElementByTagNameNS [line 152]

DOMElement getElementByTagNameNS(
string
$namespace, string
$tag 
)

Retrieve (first) element by given tagname and namespace.

Parameters:

string	$namespace:
string	$tag:

API Tags:

Return:	First found element if there is one,
Access:	public

Information Tags:

Since:

0.5.2 - 07. Mar. 2007

[ Top ]

getElementsByTagNameNS [line 132]

DOMNodeList getElementsByTagNameNS(
string
$namespace, string
$tag 
)

Retrieve elements by given tagname and namespace.

Parameters:

string	$namespace:
string	$tag:

API Tags:

Return:	List of all found elements.
Access:	public

Information Tags:

Since:

0.5.2 - 16. Mar. 2007

Redefinition of:

DOMElement::getElementsByTagNameNS ( )

[ Top ]

getStyleAttribute [line 419]

void getStyleAttribute(

$tagname, [
$value = null] 
)

Retrieve a style attribute of the current element.

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

Parameters:

	$tagname:
	$value:

API Tags:

Access:

public

Information Tags:

Since:

0.5.2 - 19. Mar. 2007

[ Top ]

hasAttributeNS [line 178]

void hasAttributeNS(

$namespace, 
$tag 
)

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

Parameters:

	$namespace:
	$tag:

API Tags:

Access:

public

Information Tags:

Since:

0.5.2 - 07. Mar. 2007

Redefinition of:

DOMElement::hasAttributeNS ( )

[ Top ]

hasChildNS [line 285]

bool hasChildNS(

$namespace, 
$tag 
)

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

Parameters:

	$namespace:
	$tag:

API Tags:

Return:	True, if there is such an element else false.
Access:	public

Information Tags:

Since:

0.5.2 - 05. Mar. 2007

[ Top ]

putAttributeNS [line 321]

mixed putAttributeNS(

$namespace, 
$tag, 
$value 
)

Put an attribute with namespace, tag and value.

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

Parameters:

	$namespace:
	$tag:
	$value:

API Tags:

Return:	True if there was no old attibute, else the old attribute node.
Access:	public

Information Tags:

Since:

0.5.2 - 05. Mar. 2007

[ Top ]

putDrawAttribute [line 435]

mixed putDrawAttribute(
string
$tagname, string
$value 
)

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

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

Parameters:

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

API Tags:

Return:	True if there was no old attibute, else the old attribute node.
Access:	public

Information Tags:

Since:

0.5.2 - 21. Mar. 2007

[ Top ]

putFOAttribute [line 391]

mixed putFOAttribute(
string
$tagname, string
$value 
)

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

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

Parameters:

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

API Tags:

Return:	True if there was no old attibute, else the old attribute node.
Access:	public

Information Tags:

Since:

0.5.2 - 16. Mar. 2007

[ Top ]

putStyleAttribute [line 407]

mixed putStyleAttribute(
string
$tagname, string
$value 
)

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

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

Parameters:

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

API Tags:

Return:	True if there was no old attibute, else the old attribute node.
Access:	public

Information Tags:

Since:

0.5.2 - 16. Mar. 2007

[ Top ]

removeAttributeNS [line 195]

void removeAttributeNS(

$namespace, 
$tag 
)

Set attribute with namespace.

Parameters:

	$namespace:
	$tag:

API Tags:

Access:

public

Information Tags:

Since:

0.5.2 - 07. Mar. 2007

Redefinition of:

DOMElement::removeAttributeNS ( )

[ Top ]

setAttributeNS [line 212]

void setAttributeNS(

$namespace, 
$tag, 
$value 
)

Set attribute with namespace.

Parameters:

	$namespace:
	$tag:
	$value:

API Tags:

Access:

public

Information Tags:

Since:

0.5.2 - 07. Mar. 2007

Redefinition of:

DOMElement::setAttributeNS ( )

[ Top ]

setManifestAttribute [line 375]

mixed setManifestAttribute(

$tag, string
$value, string
$tagname 
)

Set a Manifest attribute to the current ODPElement.

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

Parameters:

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

API Tags:

Return:	True if there was no old attibute, else the old attribute node.
Access:	public

Information Tags:

Since:

0.5.2 - 16. Mar. 2007

[ Top ]

Documentation generated on Wed, 18 Jun 2008 06:30:22 +0200 by phpDocumentor 1.3.2

	OpenDocumentPHP util

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