A

append() - Method in class Dom_Repeat

Append a repeating region to the document.

appendDoc() - Method in class Dom_Template

Append documents before the $var element

appendHeadElement() - Method in class Dom_Template

Appends an element to the widgets of the HTML head element.

appendHiddenElement() - Method in class Dom_Form

Append a hidden element to a form.

appendOptGroup() - Method in class Dom_FormSelect

Append an 'OptGroup' to the base node or the optGroup

appendOption() - Method in class Dom_FormSelect

Append an 'Option' to this 'Select' object If no value is supplied the text parameter is used as the value.

appendTemplate() - Method in class Dom_Template

Append a template before the $var element This wil also grab any headers in the $template.

C

cleanXml() - Method in class Dom_Template

Get the xml and return the cleaned string A good place to clean any nasty html entities and other non valid XML/XHTML elements

clearSelected() - Method in class Dom_FormSelect

Clear all selected elements

clearSelectedFunction() - Method in class Dom_FormSelect

Find the opt group node with the name

D

disable() - Method in class Dom_FormElement

Disable this allement, add a disable attribute to the node

Dom_Form() - Class in package Template

The form package make an API available for rendering a form and its elements The form package currently does not fully support element arrays.

Dom_FormElement() - Class in package Template

All form elements must use this class/interface.

Dom_FormInput() - Class in package Template

A class that handle a forms input element.

Dom_FormSelect() - Class in package Template

A class that handle a forms select element.

Dom_FormTextarea() - Class in package Template

A class that handles a forms textarea element.

Dom_Renderer() - Class in package Util

For all classes that render dom templates.

Dom_RendererInterface() - Interface in package Util

For all classes that render DOM Templates.

Dom_Repeat() - Class in package Template

A repeat region is a sub template of a parent templates nodes.

Dom_Template() - Class in package Template

A PHP5 DOM Template Library TODO: Add documentation on how to use this lib NOTE: Var attribute values cannot begin with '__' because they are reserved for the template system's internal functions.

E

elementExists() - Method in class Dom_Form

Check if a repeat,choice,var,form (template property) exists.

enableMultiple() - Method in class Dom_FormSelect

Set the select list to handle multiple selections NOTE: When multiple is dissabled and multiple elements are selected it behaviour is unknown and browser specific.

F

findOptGroup() - Method in class Dom_FormSelect

Find the opt group node with the name

findOption() - Method in class Dom_FormSelect

Find an option node

findSelected() - Method in class Dom_FormSelect

Find the selected values to this select box

G

getAttr() - Method in class Dom_Template

Retreive the text contained within an attribute of a node.

getAttribute() - Method in class Dom_FormElement

Set the name of this element

getBodyElement() - Method in class Dom_Template

Return the body node.

getDocument() - Method in class Dom_Template

Return a parsed Dom document.

getElementById() - Method in class Dom_Template

Get a DOMElement from the document based on its unique ID ID attributes should be unique for XHTML documents, multiple names are ignored and only the first node found is returned.

getElementNames() - Method in class Dom_Form

Get an array containing the form element names

getForm() - Method in class Dom_Template

Return a form object from the document.

getFormElement() - Method in class Dom_Form

Return the form element with the name.

getFormElementList() - Method in class Dom_Form

Get an array of form elements with the name value Used for radioboxes and multi select lists

getHeaderList() - Method in class Dom_Template

Return the current list of header nodes

getHiddenElements() - Method in class Dom_Form

Get an array of the hidden elements in this form

getId() - Method in class Dom_Form

getName() - Method in class Dom_FormElement

Get the name of this element

getNextSibling() - Method in class Dom_Template

?? Used by the repeat region.

getNode() - Method in class Dom_FormElement

Get the DomElement node for this form element

getNumFormElements() - Method in class Dom_Form

Return the number of elements in an element namespace

getRepeat() - Method in class Dom_Template

Get a repeating region from a document.

getRepeatElement() - Method in class Dom_Template

Get a repeat element node from the document.

getTemplate() - Method in class Dom_RendererInterface

Get the Dom_Template

getText() - Method in class Dom_Template

Get the text inside a var node.

getTitleText() - Method in class Dom_Template

Gets the page title text.

getType() - Method in class Dom_FormElement

Return the form element type attribute

getValue() - Method in class Dom_FormTextarea

Get the current text in the textarea

getVarElement() - Method in class Dom_Template

Get a var element node from the document.

I

init() - Method in class Dom_Template

A private method to initalise the template.

insertDoc() - Method in class Dom_Template

Insert a doc into a var in this objects doc The DOMDocument will replace the var tag

insertHTML() - Method in class Dom_Template

Insert some HTML formatted text into a dom node.

insertTemplate() - Method in class Dom_Template

Insert a template into a var in this objects doc The DOMDocument will replace the var tag This will also grab any headers in the supplied template.

isChecked() - Method in class Dom_FormInput

Get the checked state of this element

isDisabled() - Method in class Dom_FormElement

get the disabled state of this node

isMultiple() - Method in class Dom_FormSelect

Return if this is a multiple select or not.

isParsed() - Method in class Dom_Template

Get the parsed state of the template.

K

keyExists() - Method in class Dom_Template

Check if a repeat,choice,var,form (template property) Exists.

L

load() - Method in class Dom_Template

Make a template from an xml file

loadXml() - Method in class Dom_Template

Make a template from an xml string

O

objectToString() - Method in class Dom_Template

Return a string from an object.

optGroupExists() - Method in class Dom_FormSelect

Check if the opt group exists

P

preInit() - Method in class Dom_Template

This function is used when subclassing the template implement this function to capture nodes.

R

removeChildren() - Method in class Dom_Template

Removes all children from a node.

removeOptions() - Method in class Dom_FormSelect

Clear this 'select' element of all its 'option' elements.

replaceAttr() - Method in class Dom_Template

Replace an attribute value.

replaceHTML() - Method in class Dom_Template

Insert some HTML formatted text into a var node.

replaceText() - Method in class Dom_Template

Replace the text of one or more var nodes

S

setAction() - Method in class Dom_Form

Set a URL that defines where to send the data when the submit button is pushed.

setAttribute() - Method in class Dom_FormElement

Set the attribute name and value

setChecked() - Method in class Dom_FormInput

Set the checked attribute of an element

setCheckedByValue() - Method in class Dom_Form

Set/unset the checkboxes and radioboxes.

setChoice() - Method in class Dom_Template

Set a choice node to become visible in a document.

setHeaderList() - Method in class Dom_Template

Set the current list of header nodes

setMethod() - Method in class Dom_Form

The HTTP method for sending data to the action URL.

setName() - Method in class Dom_FormElement

Set the name of this element

setNextSibling() - Method in class Dom_Template

??? Used by the repeat region.

setTarget() - Method in class Dom_Form

Set the method used by the form.

setTemplate() - Method in class Dom_RendererInterface

Set the Dom_Template

setTitleText() - Method in class Dom_Template

Sets the document title text if available.

setValue() - Method in class Dom_FormTextarea

Set the value of this form element

show() - Method in class Dom_RendererInterface

Execute the renderer.

T

toString() - Method in class Dom_Template

Recive the document in the format of 'xml' or 'html'.

U

unsetChoice() - Method in class Dom_Template

Set a choice node to become invisible in a document.

useTextNodes() - Method in class Dom_FormSelect

Use Text Nodes, Set to True by default

This document was generated by PHPDoctor: The PHP Documentation Creator