Docs For Class HTML

HTML_Common HTML_Common(
[mixed
$attributes = null], [int
$tabOffset = 0])

Class constructor

Tags:

access:

public

Parameters:

mixed	$attributes	Associative array of table tag attributes or HTML attributes name="value" pairs
int	$tabOffset	Indent offset in tabs

[ Top ]

double apiVersion(
)

Returns the current API version

Tags:

access:

public

Overridden in child classes as:

HTML_QuickForm_element::apiVersion(): Returns the current API version

HTML_QuickForm_select::apiVersion(): Returns the current API version

HTML_Table::apiVersion(): Returns the API version

HTML_QuickForm::apiVersion(): Returns the current API version

[ Top ]

void display(
)

Displays the HTML to the screen

Tags:

access:

public

Overridden in child classes as:

SortableTable::display(): Displays the table, complete with navigation buttons to browse through the data-pages.

FormValidator::display(): Display the form.

CatForm::display()

DataForm::display()

UserForm::display()

EvalForm::display()

[ Top ]

void getAttribute(
string
$attr)

Returns the value of the given attribute

Tags:

since:	1.5
throws:
access:	public

Parameters:

string

$attr

Attribute name

[ Top ]

mixed getAttributes(
[bool
$asString = false])

Returns the assoc array (default) or string of attributes

Tags:

return:	attributes
since:	1.6
access:	public

Parameters:

bool

$asString

Whether to return the attributes as string

[ Top ]

string getComment(
)

Returns the HTML comment

Tags:

since:	1.5
access:	public

[ Top ]

int getTabOffset(
)

Returns the tabOffset

Tags:

since:	1.5
access:	public

[ Top ]

void removeAttribute(
string
$attr)

Removes an attribute

Tags:

since:	1.4
throws:
access:	public

Parameters:

string

$attr

Attribute name

[ Top ]

void setAttributes(
mixed
$attributes)

Sets the HTML attributes

Tags:

access:

public

Parameters:

mixed

$attributes

Either a typical HTML attribute string or an associative array

[ Top ]

void setComment(
string
$comment)

Sets the HTML comment to be displayed at the beginning of the HTML string

Tags:

since:	1.4
access:	public

Parameters:

string

$comment

[ Top ]

void setLineEnd(
string
$style)

Sets the line end style to Windows, Mac, Unix or a custom string.

Tags:

since:	1.7
access:	public

Parameters:

string

$style

"win", "mac", "unix" or custom string.

[ Top ]

void setTab(
string
$string)

Sets the string used to indent HTML

Tags:

since:	1.7
access:	public

Parameters:

string

$string

String used to indent ("\11", "\t", ' ', etc.).

[ Top ]

void setTabOffset(
int
$offset)

Sets the tab offset

Tags:

access:

public

Parameters:

int

$offset

[ Top ]

string toHtml(
)

Abstract method. Must be extended to return the objects HTML

Tags:

abstract:
access:	public

Overridden in child classes as:

HTML_QuickForm_xbutton::toHtml()

HTML_QuickForm_group::toHtml(): Returns Html for the group

HTML_QuickForm_hierselect::toHtml()

HTML_QuickForm_date::toHtml()

HTML_QuickForm_datepicker::toHtml(): HTML code to display this datepicker

HTML_QuickForm_datepickerdate::toHtml(): HTML code to display this datepicker

HTML_QuickForm_receivers::toHtml(): HTML representation

HTML_QuickForm_textarea::toHtml(): Returns the textarea element in HTML

HTML_QuickForm_html_editor::toHtml(): Return the HTML editor in HTML

HTML_QuickForm_input::toHtml(): Returns the input field in HTML

HTML_QuickForm_radio::toHtml(): Returns the radio element in HTML

HTML_QuickForm_autocomplete::toHtml(): Returns Html for the autocomplete input text element

HTML_QuickForm_checkbox::toHtml(): Returns the checkbox element in HTML

HTML_QuickForm_advcheckbox::toHtml(): Returns the checkbox element in HTML and the additional hidden element in HTML

HTML_QuickForm_select::toHtml(): Returns the SELECT in HTML

HTML_QuickForm_hiddenselect::toHtml(): Returns the SELECT in HTML

HTML_QuickForm_advmultiselect::toHtml(): Returns the HTML generated for the advanced mutliple select component

HTML_QuickForm_static::toHtml(): Returns the static text element in HTML

HTML_QuickForm_link::toHtml(): Returns the textarea element in HTML

HTML_Table::toHtml(): Returns the table structure as HTML

HTML_Table_Storage::toHtml(): Returns the table rows as HTML

HTML_QuickForm::toHtml(): Returns an HTML version of the form

[ Top ]

void updateAttributes(
mixed
$attributes)

Updates the passed attributes without changing the other existing attributes

Tags:

access:

public

Parameters:

mixed

$attributes

Either a typical HTML attribute string or an associative array

[ Top ]

array _getAttrKey(
string
$attr, array
$attributes)

Returns the array key for the given non-name-value pair attribute

Tags:

return:	key
since:	1.0
throws:
access:	private

Parameters:

string	$attr	Attribute
array	$attributes	Array of attribute

[ Top ]

string _getAttrString(
array
$attributes)

Returns an HTML formatted attribute string

Tags:

access:

private

Parameters:

array

$attributes

[ Top ]

string _getLineEnd(
)

Returns the lineEnd

Tags:

since:	1.7
throws:
access:	private

[ Top ]

string _getTab(
)

Returns a string containing the unit for indenting HTML

Tags:

since:	1.7
access:	private

[ Top ]

string _getTabs(
)

Returns a string containing the offset for the whole HTML code

Tags:

access:

private

[ Top ]

void _parseAttributes(
mixed
$attributes)

Returns a valid atrributes array from either a string or array

Tags:

access:

private

Parameters:

mixed

$attributes

Either a typical HTML attribute string or an associative array

[ Top ]

void _removeAttr(
string
$attr, 
&$attributes, array
$attributes)

Removes the given attribute from the given array

Tags:

since:	1.4
throws:
access:	public

Parameters:

string	$attr	Attribute name
array	$attributes	Attribute array
	&$attributes

[ Top ]

array _updateAttrArray(

&$attr1, array
$attr2, array
$attr1)

Updates the attributes in $attr1 with the values in $attr2 without changing the other existing attributes

Tags:

access:

private

Parameters:

array	$attr1	Original attributes array
array	$attr2	New attributes array
	&$attr1

[ Top ]

Class: HTML_Common

Class Overview

Author(s):

Version:

Variables

Methods

Child classes:

Class Details

Tags:

Class Variables

$_attributes = array()

Tags:

$_comment = ''

Tags:

$_lineEnd = "\12"

Tags:

$_tab = "\11"

Tags:

$_tabOffset = 0

Tags:

Class Methods

constructor HTML_Common [line 76]

Tags:

Parameters:

method apiVersion [line 87]

Tags:

method display [line 413]

Tags:

method getAttribute [line 250]

Tags:

Parameters:

method getAttributes [line 277]

Tags:

Parameters:

method getComment [line 391]

Tags:

method getTabOffset [line 353]

Tags:

method removeAttribute [line 305]

Tags:

Parameters:

method setAttributes [line 264]

Tags:

Parameters:

method setComment [line 379]

Tags:

Parameters:

method setLineEnd [line 318]

Tags:

Parameters:

method setTab [line 366]

Tags:

Parameters:

method setTabOffset [line 341]

Tags:

Parameters:

method toHtml [line 403]

Tags:

method updateAttributes [line 291]

Tags:

Parameters:

method _getAttrKey [line 197]

Tags:

Parameters:

method _getAttrString [line 134]

Tags:

Parameters:

method _getLineEnd [line 100]

Tags:

method _getTab [line 112]

Tags:

method _getTabs [line 123]

Tags:

method _parseAttributes [line 151]

Tags:

Parameters:

method _removeAttr [line 233]

Tags:

Parameters:

method _updateAttrArray [line 213]