Inheritance diagram for HTML_Common:

Public Member Functions
	HTML_Common ($attributes=null, $tabOffset=0)
	apiVersion ()
	_getLineEnd ()
	_getTab ()
	_getTabs ()
	_getAttrString ($attributes)
	_parseAttributes ($attributes)
	_getAttrKey ($attr, $attributes)
	_updateAttrArray (&$attr1, $attr2)
	_removeAttr ($attr, &$attributes)
	getAttribute ($attr)
	setAttributes ($attributes)
	getAttributes ($asString=false)
	updateAttributes ($attributes)
	removeAttribute ($attr)
	setLineEnd ($style)
	setTabOffset ($offset)
	getTabOffset ()
	setTab ($string)
	setComment ($comment)
	getComment ()
	toHtml ()
	display ()
Data Fields
	$_attributes = array()
	$_tabOffset = 0
	$_tab = "\11"
	$_lineEnd = "\12"
	$_comment = ''

Detailed Description

Base class for all HTML classes

Author:: Adam Daniel <adaniel1@eesus.jnj.com>

Version:: 1.7

Since:: PHP 4.0.3pl1

Definition at line 39 of file Common.php.

Member Function Documentation

_getAttrKey	(	$	attr,
		$	attributes
	)

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

Parameters:

string	$attr	Attribute
array	$attributes	Array of attribute

Since:: 1.0 private

Returns:: bool

Exceptions:

Definition at line 207 of file Common.php.

_getAttrString ( $ attributes )

Returns an HTML formatted attribute string

Parameters:

array $attributes

Returns:: string private

Definition at line 144 of file Common.php.

Here is the caller graph for this function:

_getLineEnd ( )

Returns the lineEnd

Since:: 1.7 private

Returns:: string

Exceptions:

Definition at line 110 of file Common.php.

_getTab ( )

Returns a string containing the unit for indenting HTML

Since:: 1.7 private

Returns:: string

Definition at line 122 of file Common.php.

Here is the caller graph for this function:

_getTabs ( )

Returns a string containing the offset for the whole HTML code

Returns:: string private

Definition at line 133 of file Common.php.

Here is the call graph for this function:

Here is the caller graph for this function:

_parseAttributes ( $ attributes )

Returns a valid atrributes array from either a string or array

Parameters:

mixed $attributes Either a typical HTML attribute string or an associative array private

Definition at line 161 of file Common.php.

Here is the caller graph for this function:

_removeAttr	(	$	attr,
		&$	attributes
	)

Removes the given attribute from the given array

Parameters:

string	$attr	Attribute name
array	$attributes	Attribute array

Since:: 1.4 private

Returns:: void

Exceptions:

Definition at line 242 of file Common.php.

Here is the caller graph for this function:

_updateAttrArray	(	&$	attr1,
		$	attr2
	)

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

Parameters:

array	$attr1	Original attributes array
array	$attr2	New attributes array private

Definition at line 222 of file Common.php.

Here is the caller graph for this function:

apiVersion ( )

Returns the current API version public

Returns:: double

Reimplemented in HTML_QuickForm, HTML_QuickForm_element, and HTML_QuickForm_select.

Definition at line 97 of file Common.php.

display ( )

Displays the HTML to the screen

public

Reimplemented in HTML_QuickForm_DHTMLRulesTableless.

Definition at line 422 of file Common.php.

Here is the call graph for this function:

getAttribute ( $ attr )

Returns the value of the given attribute

Parameters:

string $attr Attribute name

Since:: 1.5 public

Returns:: void

Exceptions:

Definition at line 259 of file Common.php.

Here is the caller graph for this function:

getAttributes ( $ asString = false )

Returns the assoc array (default) or string of attributes

Parameters:

bool	Whether to return the attributes as string

Since:: 1.6 public

Returns:: mixed attributes

Definition at line 286 of file Common.php.

Here is the call graph for this function:

Here is the caller graph for this function:

getComment ( )

Returns the HTML comment

Since:: 1.5 public

Returns:: string

Definition at line 400 of file Common.php.

Here is the caller graph for this function:

getTabOffset ( )

Returns the tabOffset

Since:: 1.5 public

Returns:: int

Definition at line 362 of file Common.php.

HTML_Common	(	$	attributes = `null`,
		$	tabOffset = `0`
	)

Class constructor

Parameters:

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

Definition at line 86 of file Common.php.

Here is the call graph for this function:

Here is the caller graph for this function:

removeAttribute ( $ attr )

Removes an attribute

Parameters:

string $attr Attribute name

Since:: 1.4 public

Returns:: void

Exceptions:

Definition at line 314 of file Common.php.

Here is the call graph for this function:

Here is the caller graph for this function:

setAttributes ( $ attributes )

Sets the HTML attributes

Parameters:

mixed $attributes Either a typical HTML attribute string or an associative array public

Definition at line 273 of file Common.php.

Here is the call graph for this function:

Here is the caller graph for this function:

setComment ( $ comment )

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

Parameters:

string

Since:: 1.4 public

Returns:: void

Definition at line 388 of file Common.php.

setLineEnd ( $ style )

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

Parameters:

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

Since:: 1.7 public

Returns:: void

Definition at line 327 of file Common.php.

setTab ( $ string )

Sets the string used to indent HTML

Since:: 1.7

Parameters:

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

Returns:: void

Definition at line 375 of file Common.php.

setTabOffset ( $ offset )

Sets the tab offset

Parameters:

int $offset public

Definition at line 350 of file Common.php.

Here is the caller graph for this function:

toHtml ( )

Abstract method. Must be extended to return the objects HTML

public

Returns:: string

Reimplemented in HTML_QuickForm_select, HTML_QuickForm_date, MoodleQuickForm_selectgroups, HTML_QuickForm_group, HTML_QuickForm_hierselect, MoodleQuickForm_tags, MoodleQuickForm_date_time_selector, HTML_QuickForm_advcheckbox, HTML_QuickForm_textarea, MoodleQuickForm_date_selector, MoodleQuickForm_duration, HTML_QuickForm_link, HTML_QuickForm_input, MoodleQuickForm_editor, HTML_QuickForm_radio, HTML_QuickForm_static, HTML_QuickForm_checkbox, HTML_QuickForm_autocomplete, MoodleQuickForm_filemanager, MoodleQuickForm_advcheckbox, MoodleQuickForm_rubriceditor, MoodleQuickForm_grading, MoodleQuickForm_checkbox, MoodleQuickForm_wikifiletable, HTML_QuickForm_hiddenselect, MoodleQuickForm_radio, HTML_QuickForm_xbutton, MoodleQuickForm_recaptcha, MoodleQuickForm_htmleditor, MoodleQuickForm_textarea, MoodleQuickForm_wikieditor, MoodleQuickForm_filepicker, MoodleQuickForm_searchableselector, MoodleQuickForm_warning, MoodleQuickForm_selectwithlink, MoodleQuickForm_passwordunmask, MoodleQuickForm_url, MoodleQuickForm_text, MoodleQuickForm_select, and MoodleQuickForm_submitlink.

Definition at line 412 of file Common.php.

Here is the caller graph for this function:

updateAttributes ( $ attributes )

Updates the passed attributes without changing the other existing attributes

Parameters:

mixed $attributes Either a typical HTML attribute string or an associative array public

Definition at line 300 of file Common.php.

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$_attributes = array()

Definition at line 46 of file Common.php.

$_comment = ''

Definition at line 77 of file Common.php.

$_lineEnd = "\12"

Definition at line 69 of file Common.php.

$_tab = "\11"

Definition at line 61 of file Common.php.

$_tabOffset = 0

Definition at line 53 of file Common.php.

The documentation for this class was generated from the following file:

C:/xampp/htdocs/moodle/lib/pear/HTML/Common.php

Public Member Functions

Data Fields

Detailed Description

Member Function Documentation

Field Documentation