Class: XML_XUL_Element

Source Location: /XML_XUL-0.8.3/XUL/Element.php

Class Overview

XML/XUL/Element.php

Author(s):

Stephan Schmidt <schst at php.net>

Variables

Methods

Child classes:

XML_XUL_Element_Columns: XML/XUL/Element/Columns.php

XML_XUL_Element_Checkbox: XML/XUL/Element/Checkbox.php

XML_XUL_Element_Tabpanels: XML/XUL/Element/Tabpanels.php

XML_XUL_Element_Colorpicker: XML/XUL/Element/Colorpicker.php

XML_XUL_Element_Spacer: XML/XUL/Element/Spacer.php

XML_XUL_Element_Statusbarpanel: XML/XUL/Element/Statusbarpanel.php

XML_XUL_Element_Treeitem: XML/XUL/Element/Treeitem.php

XML_XUL_Element_Listitem: XML/XUL/Element/Listitem.php

XML_XUL_Element_Menubar: XML/XUL/Element/Menubar.php

XML_XUL_Element_Radio: XML/XUL/Element/Radio.php

XML_XUL_Element_Html: XML/XUL/Element/Html.php

XML_XUL_Element_Dialog: XML/XUL/Element/Dialog.php

XML_XUL_Element_Toolbarbutton: XML/XUL/Element/Toolbarbutton.php

XML_XUL_Element_Autorepeatbutton: XML/XUL/Element/Autorepeatbutton.php

XML_XUL_Element_Arrowscrollbox: XML/XUL/Element/Arrowscrollbox.php

XML_XUL_Element_Tabbox: XML/XUL/Element/Tabbox.php

XML_XUL_Element_Box: XML/XUL/Element/Box.php

XML_XUL_Element_Toolbarseparator: XML/XUL/Element/Toolbarseparator.php

XML_XUL_Element_Tabpanel: XML/XUL/Element/Tabpanel.php

XML_XUL_Element_Treecol: XML/XUL/Element/Treecol.php

XML_XUL_Element_Description: XML/XUL/Element/Description.php

XML_XUL_Element_Listcol: XML/XUL/Element/Listcol.php

XML_XUL_Element_Popupset: XML/XUL/Element/Popupset.php

XML_XUL_Element_Browser: XML/XUL/Element/Browser.php

XML_XUL_Element_Vbox: XML/XUL/Element/Vbox.php

XML_XUL_Element_Column: XML/XUL/Element/Column.php

XML_XUL_Element_Rows: XML/XUL/Element/Rows.php

XML_XUL_Element_Dialogheader: XML/XUL/Element/Dialogheader.php

XML_XUL_Element_Menulist: XML/XUL/Element/Menulist.php

XML_XUL_Element_Listheader: XML/XUL/Element/Listheaderer.php

XML_XUL_Element_Stack: XML/XUL/Element/Stack.php

XML_XUL_Element_Tab: XML/XUL/Element/Tab.php

XML_XUL_Element_Caption: XML/XUL/Element/Caption.php

XML_XUL_Element_Separator: XML/XUL/Element/Separator.php

XML_XUL_Element_Treechildren: XML/XUL/Element/Treechildren.php

XML_XUL_Element_Broadcaster: XML/XUL/Element/Broadcaster.php

XML_XUL_Element_Row: XML/XUL/Element/Row.php

XML_XUL_Element_Textbox: XML/XUL/Element/Textbox.php

XML_XUL_Element_Listhead: XML/XUL/Element/Listhead.php

XML_XUL_Element_Treecell: XML/XUL/Element/Treecell.php

XML_XUL_Element_Menuitem: XML/XUL/Element/Menuitem.php

XML_XUL_Element_Broadcasterset: XML/XUL/Element/Broadcastersetset.php

XML_XUL_Element_Listbox: XML/XUL/Element/Listbox.php

XML_XUL_Element_Label: XML/XUL/Element/Label.php

XML_XUL_Element_Editor: XML/XUL/Element/Editor.php

XML_XUL_Element_Radiogroup: XML/XUL/Element/Radiogroup.php

XML_XUL_Element_Listcols: XML/XUL/Element/Listcols.php

XML_XUL_Element_Treerow: XML/XUL/Element/Treerow.php

XML_XUL_Element_Tooltip: XML/XUL/Element/Tooltip.php

XML_XUL_Element_Menupopup: XML/XUL/Element/Menupopup.php

XML_XUL_Element_Image: XML/XUL/Element/Image.php

XML_XUL_Element_Splitter: XML/XUL/Element/Splitter.php

XML_XUL_Element_Tabs: XML/XUL/Element/Tabs.php

XML_XUL_Element_Deck: XML/XUL/Element/Deck.php

XML_XUL_Element_Groupbox: XML/XUL/Element/Groupbox.php

XML_XUL_Element_Iframe: XML/XUL/Element/Iframe.php

XML_XUL_Element_Treecols: XML/XUL/Element/Treecols.php

XML_XUL_Element_Progressmeter: XML/XUL/Element/Progressmeter.php

XML_XUL_Element_Button: XML/XUL/Element/Button.php

XML_XUL_Element_Menuseparator: XML/XUL/Element/Menuseparator.php

XML_XUL_Element_Window: XML/XUL/Element/Window.php

XML_XUL_Element_Tree: XML/XUL/Element/Tree.php

XML_XUL_Element_Listcell: XML/XUL/Element/Listcell.php

XML_XUL_Element_Action: XML/XUL/Element/Action.php

XML_XUL_Element_Statusbar: XML/XUL/Element/Statusbar.php

XML_XUL_Element_Grippy: XML/XUL/Element/Grippy.php

XML_XUL_Element_Grid: XML/XUL/Element/Grid.php

XML_XUL_Element_Toolbox: XML/XUL/Element/Toolbox.php

XML_XUL_Element_Hbox: XML/XUL/Element/Hbox.php

XML_XUL_Element_Script: XML/XUL/Element/Script.php

XML_XUL_Element_Menu: XML/XUL/Element/Menu.php

XML_XUL_Element_Toolbar: XML/XUL/Element/Toolbar.php

XML_XUL_Element_Popup: XML/XUL/Element/Popup.php

XML_XUL_Element_Overlay: XML/XUL/Element/Overlay.php

Inherited Variables

Inherited Methods

Class Details

[line 62]
XML/XUL/Element.php

Base class for all elements

Author: Stephan Schmidt <schst@php.net>

[ Top ]

Class Variables

$attributes = array()

[line 94]

attributes of the element

Access: public

Type:

array

[ Top ]

$cdata =

[line 110]

cdata of the element

Access: public

Type:

string

[ Top ]

$childNodes = array()

[line 102]

childNodes of the element

Access: public

Type:

array

[ Top ]

$elementName =

[line 70]

element name

Access: public

Type:

string

[ Top ]

$isRoot = false

[line 127]

indicates whether the element is the root element

Access: public

Type:

boolean

[ Top ]

$replaceEntities = true

[line 287]

flag to indicate whether xml entities should be replaced

Access: public

Type:

boolean

[ Top ]

Method Detail

XML_XUL_Element (Constructor) [line 297]

XML_XUL_Element XML_XUL_Element(
[array
$attributes = array()], [string
$cdata = null], [boolean
$autoBuild = true])

constructor

Access: public

Parameters:

array	`$attributes`	—	attributes of the element
string	`$cdata`	—	cdata of the element (used by caption, et al)
boolean	`$autoBuild`	—	autobuild flag

[ Top ]

addDescription [line 677]

object XML_XUL_Element_Description &addDescription(
string
$text, [array
$atts = array()])

add a description element

This can be used by a lot of elements, thus it has been placed in the base class.

See: XML_XUL_Element_Description
Access: public

Parameters:

string	`$text`	—	text for the description
array	`$atts`	—	additional attributes

[ Top ]

appendChild [line 416]

void appendChild(
object
&$obj)

add a child object

Access: public

Parameters:

object &$obj —

[ Top ]

cloneElement [line 492]

object XML_XUL_Element &cloneElement(
[boolean
$recursive = false])

clone the element

This method will return a copy of the element without the id and the childNodes

Access: public

Parameters:

boolean $recursive — whether children should be cloned, too.

[ Top ]

firstChild [line 638]

object XML_XUL_Element &firstChild(
)

get the first child of the element

If the element has no childNodes, null will be returned.

Access: public

[ Top ]

getAttribute [line 402]

mixed getAttribute(
string
$name)

get an attribute

Return: attribute value
Access: public

Parameters:

string $name — attribute name

[ Top ]

getDebug [line 694]

string getDebug(
[integer
$indent = ''], [
$last = false])

get a debug info about the element as string.

Use this instead of a print_r on the tree.

Access: public

Parameters:

integer	`$indent`	—	nesting depth, no need to pass this
	`$last`	—

[ Top ]

getElementById [line 520]

object XML_XUL_Element &getElementById(
string
$id)

get an element by its id

You should not need to call this method directly

Return: or false if the element does not exist
Access: public

Parameters:

string $id — id

[ Top ]

getElementname [line 356]

string getElementname(
)

get the element's tag name

Return: tag name of the element
Access: public

[ Top ]

getElementsByTagname [line 549]

array &getElementsByTagname(
string
$tagname)

get a nodelist of elements by their tagname

Return: array containing XML_XUL_Element objects
Access: public

Parameters:

string $tagname — id

[ Top ]

getId [line 342]

string getId(
)

get the element's id

Return: id of the element
Access: public

[ Top ]

lastChild [line 655]

object XML_XUL_Element &lastChild(
)

get last first child of the element

If the element has no childNodes, null will be returned.

Access: public

[ Top ]

serialize [line 440]

string serialize(
)

serialize the element

Return: string representation of the element and all of its childNodes
Access: public

Overridden in child classes as:

XML_XUL_Element_Html::serialize(): serialize the element

[ Top ]

setAttribute [line 390]

void setAttribute(
string
$name, mixed
$value)

set an attribute

Access: public

Parameters:

string	`$name`	—	attribute name
mixed	`$value`	—	attribute value

[ Top ]

setAttributes [line 378]

void setAttributes(
array
$attribs)

sets several attributes at once

Access: public

Parameters:

array $attribs — attributes

[ Top ]

setCData [line 367]

void setCData(
string
$data)

sets cdata of the element

Access: public

Parameters:

string $data — data

[ Top ]

setDocument [line 309]

void setDocument(
object XML_XUL_Document
&$doc)

set the reference to the document

Access: public

Parameters:

object XML_XUL_Document &$doc — document

[ Top ]

setHtmlNamespace [line 331]

void setHtmlNamespace(
string
$ns)

set the namespace for XHTML element

Access: public

Parameters:

string $ns —

[ Top ]

setNamespace [line 320]

void setNamespace(
string
$ns)

set the namespace

Access: public

Parameters:

string $ns —

[ Top ]

toXML [line 429]

string toXML(
)

create a string representation of the element

This is just an alias for serialize()

Return: string representation of the element and all of its childNodes
Access: public

[ Top ]

validateAttributes [line 581]

boolean validateAttributes(
)

validate the element's attributes

Uses the definitions of common attributes as well as the attribute definitions of the element.

Return: true on succes, PEAR_Error otherwise
Access: public

[ Top ]