Docs For Class mosHTML

mosHTML

Description

Utility class for all HTML drawing classes

since: 1.0
static:

Located in /utilities/presentation/html.php (line 22)

Method Summary

void BackButton (mixed &$params, [mixed $hide_js = NULL])

void cleanText (mixed &$text)

void CloseButton (mixed &$params, [mixed $hide_js = NULL])

void emailCloaking (mixed $mail, [mixed $mailto = 1], [mixed $text = ''], [mixed $email = 1])

string idBox (int $rowNum, int $recId, [boolean $checkedOut = false], [string $name = 'cid'])

void Iframe (string $url, string $name, [array $attribs = null], integer $ssl)

void Image (string $url, string $alt, [array $attribs = null])

string integerSelectList (int $start, int $end, int $inc, string $tag_name, string $tag_attribs, mixed $selected, [string $format = ""])

void Link (string $url, string $text, [array $attribs = null], integer $ssl)

void makeOption (mixed $value, [mixed $text = ''], [mixed $value_name = 'value'], [mixed $text_name = 'text'])

string monthSelectList (string $tag_name, string $tag_attribs, mixed $selected)

void PrintIcon (mixed &$row, mixed &$params, mixed $hide_js, mixed $link, [mixed $status = NULL])

string radioList (array &$arr, string $tag_name, string $tag_attribs, [mixed $selected = null], [string $key = 'value'], [string $text = 'text'], [mixed $idtag = false])

void Script (string $url, [string $attribs = null], array 2)

string selectList (array &$arr, string $tag_name, string $tag_attribs, string $key, string $text, [mixed $selected = NULL], [mixed $idtag = false], [mixed $flag = false])

void sortIcon (mixed $text, mixed $base_href, mixed $field, [mixed $state = 'none'])

string treeSelectList (array &$src_list, array $src_id, array $tgt_list, array $tag_name, string $tag_attribs, string $key, string $text, string $selected, mixed 8)

HTML WarningIcon (string $warning, [string $title = 'Joomla Warning'])

void writableCell (mixed $folder)

string yesnoRadioList (string $tag_name, string $tag_attribs, mixed $selected, [mixed $yes = 'yes'], [mixed $no = 'no'], [mixed $id = false])

string yesnoSelectList (string $tag_name, string $tag_attribs, mixed $selected, [mixed $yes = 'yes'], [mixed $no = 'no'])

void _encoding_converter (mixed $text)

void _implode_assoc ([mixed $inner_glue = "="], [mixed $outer_glue = "\n"], [mixed $array = null], [mixed $keepOuterKey = false])

Methods

BackButton (line 444)

Writes Back Button

void BackButton (mixed &$params, [mixed $hide_js = NULL])

cleanText (line 460)

Cleans text of all formating and scripting code

void cleanText (mixed &$text)

CloseButton (line 426)

Writes Close Button

void CloseButton (mixed &$params, [mixed $hide_js = NULL])

emailCloaking (line 518)

simple Javascript Cloaking

email cloacking by default replaces an email with a mailto link with email cloacked

void emailCloaking (mixed $mail, [mixed $mailto = 1], [mixed $text = ''], [mixed $email = 1])

idBox (line 363)

string idBox (int $rowNum, int $recId, [boolean $checkedOut = false], [string $name = 'cid'])

int $rowNum: The row index
int $recId: The record id
boolean $checkedOut
string $name: The name of the form element

Iframe (line 95)

Write a <iframe></iframe> element

since: 1.1

void Iframe (string $url, string $name, [array $attribs = null], integer $ssl)

string $url: The relative URL to use for the src attribute
string $name: The target attribute to use
array $attribs: An associative array of attributes to add
integer $ssl: Set the SSL functionality

Image (line 53)

Write a <img></amg> element

since: 1.1

void Image (string $url, string $alt, [array $attribs = null])

string $url: The relative URL to use for the src attribute
string $alt: The target attribute to use
array $attribs: An associative array of attributes to add

integerSelectList (line 194)

Writes a select list of integers

return: HTML for the select list

string integerSelectList (int $start, int $end, int $inc, string $tag_name, string $tag_attribs, mixed $selected, [string $format = ""])

int $start: The start integer
int $end: The end integer
int $inc: The increment
string $tag_name: The value of the HTML name attribute
string $tag_attribs: Additional HTML attributes for the <select> tag
mixed $selected: The key that is selected
string $format: The printf format to be applied to the number

Link (line 33)

Write a <a></a> element

since: 1.1

void Link (string $url, string $text, [array $attribs = null], integer $ssl)

string $url: The relative URL to use for the href attribute
string $text: The target attribute to use
array $attribs: An associative array of attributes to add
integer $ssl: Set the SSL functionality

makeOption (line 108)

void makeOption (mixed $value, [mixed $text = ''], [mixed $value_name = 'value'], [mixed $text_name = 'text'])

monthSelectList (line 215)

Writes a select list of month names based on Language settings

return: HTML for the select list values

string monthSelectList (string $tag_name, string $tag_attribs, mixed $selected)

string $tag_name: The value of the HTML name attribute
string $tag_attribs: Additional HTML attributes for the <select> tag
mixed $selected: The key that is selected

PrintIcon (line 476)

Writes Print icon

void PrintIcon (mixed &$row, mixed &$params, mixed $hide_js, mixed $link, [mixed $status = NULL])

radioList (line 306)

Generates an HTML radio list

return: HTML for the select list

string radioList (array &$arr, string $tag_name, string $tag_attribs, [mixed $selected = null], [string $key = 'value'], [string $text = 'text'], [mixed $idtag = false])

array &$arr: An array of objects
string $tag_name: The value of the HTML name attribute
string $tag_attribs: Additional HTML attributes for the <select> tag
mixed $selected: The key that is selected
string $key: The name of the object variable for the option value
string $text: The name of the object variable for the option text

Script (line 74)

Write a <script></script> element

since: 1.1

void Script (string $url, [string $attribs = null], array 2)

array 2: An associative array of attributes to add
string $url: The relative URL to use for the src attribute
string $attribs: The target attribute to use

selectList (line 136)

Generates an HTML select list

return: HTML for the select list

string selectList (array &$arr, string $tag_name, string $tag_attribs, string $key, string $text, [mixed $selected = NULL], [mixed $idtag = false], [mixed $flag = false])

array &$arr: An array of objects
string $tag_name: The value of the HTML name attribute
string $tag_attribs: Additional HTML attributes for the <select> tag
string $key: The name of the object variable for the option value
string $text: The name of the object variable for the option text
mixed $selected: The key that is selected

sortIcon (line 371)

void sortIcon (mixed $text, mixed $base_href, mixed $field, [mixed $state = 'none'])

treeSelectList (line 247)

Generates an HTML select list from a tree based query list

return: HTML for the select list

string treeSelectList (array &$src_list, array $src_id, array $tgt_list, array $tag_name, string $tag_attribs, string $key, string $text, string $selected, mixed 8)

mixed 8: The key that is selected
array &$src_list: Source array with id and parent fields
array $src_id: The id of the current list item
array $tgt_list: Target array. May be an empty array.
array $tag_name: An array of objects
string $tag_attribs: The value of the HTML name attribute
string $key: Additional HTML attributes for the <select> tag
string $text: The name of the object variable for the option value
string $selected: The name of the object variable for the option text

WarningIcon (line 409)

Utility function to provide Warning Icons

return: code for Warning
since: 1.1

HTML WarningIcon (string $warning, [string $title = 'Joomla Warning'])

string $warning: Warning text
string $title: Box title

writableCell (line 115)

void writableCell (mixed $folder)

yesnoRadioList (line 347)

Writes a yes/no radio list

return: HTML for the radio list

string yesnoRadioList (string $tag_name, string $tag_attribs, mixed $selected, [mixed $yes = 'yes'], [mixed $no = 'no'], [mixed $id = false])

string $tag_name: The value of the HTML name attribute
string $tag_attribs: Additional HTML attributes for the <select> tag
mixed $selected: The key that is selected

yesnoSelectList (line 287)

Writes a yes/no select list

return: HTML for the select list values

string yesnoSelectList (string $tag_name, string $tag_attribs, mixed $selected, [mixed $yes = 'yes'], [mixed $no = 'no'])

string $tag_name: The value of the HTML name attribute
string $tag_attribs: Additional HTML attributes for the <select> tag
mixed $selected: The key that is selected

_encoding_converter (line 568)

void _encoding_converter (mixed $text)

_implode_assoc (line 579)

void _implode_assoc ([mixed $inner_glue = "="], [mixed $outer_glue = "\n"], [mixed $array = null], [mixed $keepOuterKey = false])

Documentation generated on Sat, 4 Feb 2006 14:23:55 +0100 by phpDocumentor 1.3.0RC4