Class WMLdo_element

Description

WMLdo_element class Do Element Class: Extends element to make a virtual class which has descendants which are contained by a 'do' construct.

A Do element is essentially a kind of clickable link which does something when the user clicks on it. What it does depends on "type" of the DO. This virtual class is inherited by child classes which implement the various different types of DO.

Located in /wml-defs.php (line 182)

RenderableObject
   |
   --WMLelement
      |
      --WMLdo_element
Direct descendents
Class Description
 class WMLprev WMLprev class Extends the Do Element Class. Provide the Do element of type = 'prev'.
 class WMLrefresh WMLrefresh class Extends the Do Element Class. Provide the Do element of type = 'refresh'.
 class WMLgo WMLgo class Extends the Do Element Class. Provide the Do element of type = 'accept'.
Variable Summary
 mixed $label
 mixed $name
 mixed $optional
 mixed $type
Method Summary
 WMLdo_element WMLdo_element (string $type, string $name, [string $label = ""], [bool $optional = false], [string $ontimerhref = ""])
 string html ()
 string wml ()
Variables
mixed $label = "" (line 188)

Label for the Do element

mixed $name = "" (line 186)

Name of the DO element

mixed $optional = false (line 190)

True if optional

mixed $type (line 184)

Type of DO element: 'accept', 'prev', 'help', 'reset', 'options', or 'delete'

Inherited Variables

Inherited from WMLelement

WMLelement::$body
Methods
Constructor WMLdo_element (line 201)

Constructor Create a new do element object.

WMLdo_element WMLdo_element (string $type, string $name, [string $label = ""], [bool $optional = false], [string $ontimerhref = ""])
  • string $type: Type of do element.
  • string $name: Name of this Do element
  • string $label: Label for this DO element
  • bool $optional: True if DO element is optional
  • string $ontimerhref: URL for ontimer event to redirect to
html (line 233)

Produce main HTML for DO element

  • return: HTML for the DO element
string html ()

Redefinition of:
RenderableObject::html()
Return output suitable for normal HTML-capable device. This method must be over-ridden by a method of the same name in the descendant class which renders output to web browsers.

Redefined in descendants as:
  • WMLprev::html() : Return HTML content Use render() to render this element in your page.
  • WMLrefresh::html() : Return HTML content Use render() to render this element in your page.
  • WMLgo::html() : Return HTML content Use render() to render this element in your page.
wml (line 216)

Produce main WML for DO element This is a common utility method to render the DO WML once the details (body) has been filled in by the child class of this one.

  • return: WML for the DO element
string wml ()

Redefinition of:
RenderableObject::wml()
Return output suitable for normal wap-capable device. This method must be over-ridden by a method of the same name in the descendant class which renders output to wap devices.

Redefined in descendants as:
  • WMLprev::wml() : Return WML content Use render() to render this element in your page.
  • WMLrefresh::wml() : Return WML content Use render() to render this element in your page.
  • WMLgo::wml() : Return WML content Use render() to render this element in your page.

Inherited Methods

Inherited From WMLelement

 WMLelement::WMLelement()
 WMLelement::insert()
 WMLelement::insert_para()
 WMLelement::insert_paragraph()
 WMLelement::insert_para_scrubbed()

Inherited From RenderableObject

 RenderableObject::RenderableObject()
 RenderableObject::html()
 RenderableObject::render()
 RenderableObject::wml()
 RenderableObject::wmlup()
 RenderableObject::xml()

Documentation generated by phpDocumentor 1.3.0RC3