Class RenderableObject

Description

RenderableObject class This object should be inherited by all classes which are intended to output content for the client browser.

Located in /renderable.php (line 53)


	
			
Direct descendents
Class Description
 class block Block
 class blocklet The blocklet is simply a part of a block. It is almost a 'paragraph' of
 class blockeditor Block Editor
 class Link Clickable link
 class catalogitem A class which encpasulates an item which can be in the catalog.
 class catalog This class encapsulates a media catalog, which is a collection of catalogitem objects.
 class configuration Configuration This is for accessing generic configuration files which store useful crappola like GST rate, file paths etc. This object features dynamically creatable/deletable configuration fields.
 class webdebugger The debugger class. Responsible for accumulating, filtering and then
 class StylableObject StylableObject This is a virtual class representing something which can have its look changed by applying styles and/or classnames to it.
 class HVmenu HVMenu class This module is being retained for legacy applications which still use the core javascript system (version 5.41) which was written by Ger Versluis 24 December 2001.
 class image Image class A class for managing a standard image.
 class clickable_image Clickable Image class A class for managing a clickable image. A clickable image is one which redirects to a given URL when clicked on.
 class hover Hover class Provides and image which changes to a second image when the mouse is over the top of it, using onmouseover and onmouseout events.
 class layout Layout A layout can be simply viewed as a table definition. The table cells can contain blocks, and so this entity is provided to allow control of how blocks of content can be arranged on a webpage.
 class layouteditor Layouteditor
 class menuitem Standard menu item. Takes a link object as the item in the menu.
 class menuoption The menuoption is a class which contains the properties of a single option on a menu.
 class enc_qualifier A class which encapsulates a scheme qualifier. A qualifier is an attribute which is used in a metadata tag to qualify or refine it.
 class metadata_scheme A class which encapsulates a metadata scheme. This is a set of
 class metadata_element A class which encapsulates a metadata element. This is the actual object which will be rendered into the end-user content (eg. the webpage), and contains everything necessary for that process.
 class pages Pages class
 class organisation The organisation class manages a single set of information related to a "organisation". This is an identity distinct from the system-oriented uuser record, and is intended to be a generic mechanism for storing data on human beings.
 class contactinfo The contactinfo class manages a single set of contact information which might be associated with a person or thing.
 class page_section The page section class
 class recmaintainer The record maintainer class.
 class tag A renderable tag of some kind. Basically a tag is a language construct designed to render at least an identifying name and a value. More specific variants might add other properties, and control the way the tag is actually rendered.
 class treemenu A hierarchical menu renderer which does not use Javascript to implement the menuoption display.
 class WMLelement WMLelement class Manage WML elements. This is a virtual class used for all WML elements.
 class WMLdeck WMLDeck class Manage WML Decks of cards.
 class Xmenu XMenu class A Generic Javascript Menu. This class provides a multi-level menu implemented in cross-browser Javascript. It should be compatible with Netscape 4, Netscape 6, and IE 4+.
 class story A class which encapsulates a story or article item. Provides methods to get/save to database, edit the story in a popup window, and view it.
Method Summary
 RenderableObject RenderableObject ()
 void html ([mixed $parm = ""])
 void render ([mixed $parm = ""])
 void wml ([mixed $parm = ""])
 void wmlup ([mixed $parm = ""])
 void xml ([mixed $parm = ""])
Methods
Constructor RenderableObject (line 60)

Constructor Create a renderable object. Any object which you want to be able to deliver content to a device such as a web browser or wap phone etc. should inherit this class.

RenderableObject RenderableObject ()
html (line 88)

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.

void html ([mixed $parm = ""])
  • mixed $parm: Optional parameter to pass to method

Redefined in descendants as:
render (line 110)

Render output

Render in the appropriate way for the browser type. In this instance we define the 'type' of the browser based on the kind of content it is expecting back. Note that this does not determine the actual "make" of the browser (Internet Explorer, Netscape etc.) since a given "make" of browser can deal with all sorts of content types..

void render ([mixed $parm = ""])
  • mixed $parm: Optional parameter to pass to method

Redefined in descendants as:
wml (line 69)

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.

void wml ([mixed $parm = ""])
  • mixed $parm: Optional parameter to pass to method

Redefined in descendants as:
wmlup (line 79)

Return output suitable for normal wap-capable device which has Phone.com extensions. This method must be over-ridden by a method of the same name in the descendant class which renders output to wap devices.

void wmlup ([mixed $parm = ""])
  • mixed $parm: Optional parameter to pass to method

Redefined in descendants as:
  • menu::wmlup() : This renders the menu as WML (w/Phone.com extns) in a paged mode with a number of menuitems/page defined by $wrap_threshold.
xml (line 97)

Return output suitable for XML-capable devices or agents.

This method must be over-ridden by a method of the same name in the descendant class which renders XML output.

void xml ([mixed $parm = ""])
  • mixed $parm: Optional parameter to pass to method

Documentation generated by phpDocumentor 1.3.0RC3