Docs For Class HTML

void HTML_Form(
string
$action, [string
$method = 'get'], [string
$name = ''], [string
$target = ''], [string
$enctype = ''], [string
$attr = ''])

Constructor

Access: public

Parameters:

string	`$action`	—	the string naming file or URI to which the form should be submitted
string	`$method`	—	a string indicating the submission method ('get' or 'post')
string	`$name`	—	a string used in the <form>'s 'name' attribute
string	`$target`	—	a string used in the <form>'s 'target' attribute
string	`$enctype`	—	a string indicating the submission's encoding
string	`$attr`	—	a string of additional attributes to be put in the element (example: 'id="foo"')

[ Top ]

void addBlank(
int
$i, [string
$title = ''], [string
$thattr = HTML_FORM_TH_ATTR], [string
$tdattr = HTML_FORM_TD_ATTR])

Adds a blank row to the list of fields to be processed by display()

See: HTML_Form::display(), HTML_Form::displayBlank(), HTML_Form::displayBlankRow(), HTML_Form::returnBlank(), HTML_Form::returnBlankRow()
Access: public

Parameters:

int	`$i`	—	the number of rows to create. Ignored if $title is used.
string	`$title`	—	a string to be used as the label for the row
string	`$thattr`	—	a string of additional attributes to be put in the <th> element (example: 'class="foo"')
string	`$tdattr`	—	a string of additional attributes to be put in the <td> element (example: 'class="foo"')

[ Top ]

void addCheckbox(
string
$name, string
$title, [bool
$default = false], [string
$attr = ''], [string
$thattr = HTML_FORM_TH_ATTR], [string
$tdattr = HTML_FORM_TD_ATTR])

Adds a checkbox input to the list of fields to be processed by display()

See: HTML_Form::display(), HTML_Form::displayCheckbox(), HTML_Form::displayCheckboxRow(), HTML_Form::returnCheckbox(), HTML_Form::returnCheckboxRow()
Access: public

Parameters:

string	`$name`	—	the string used in the 'name' attribute
string	`$title`	—	the string used as the label
bool	`$default`	—	a bool indicating if item should be checked
string	`$attr`	—	a string of additional attributes to be put in the element (example: 'id="foo"')
string	`$thattr`	—	a string of additional attributes to be put in the <th> element (example: 'class="foo"')
string	`$tdattr`	—	a string of additional attributes to be put in the <td> element (example: 'class="foo"')

[ Top ]

void addFile(
string
$name, string
$title, [int
$maxsize = HTML_FORM_MAX_FILE_SIZE], [int
$size = HTML_FORM_TEXT_SIZE], [string
$accept = ''], [string
$attr = ''], [string
$thattr = HTML_FORM_TH_ATTR], [string
$tdattr = HTML_FORM_TD_ATTR])

Adds a file upload input to the list of fields to be processed by display()

See: HTML_Form::display(), HTML_Form::displayFile(), HTML_Form::displayFileRow(), HTML_Form::returnFile(), HTML_Form::returnFileRow(), HTML_Form::returnMultipleFiles()
Access: public

Parameters:

string	`$name`	—	the string used in the 'name' attribute
string	`$title`	—	the string used as the label
int	`$maxsize`	—	an integer determining how large (in bytes) a submitted file can be.
int	`$size`	—	an integer used in the 'size' attribute
string	`$accept`	—	a string saying which MIME types are allowed
string	`$attr`	—	a string of additional attributes to be put in the element (example: 'id="foo"')
string	`$thattr`	—	a string of additional attributes to be put in the <th> element (example: 'class="foo"')
string	`$tdattr`	—	a string of additional attributes to be put in the <td> element (example: 'class="foo"')

[ Top ]

void addHidden(
string
$name, string
$value, [string
$attr = ''])

Adds a hiden input to the list of fields to be processed by display()

See: HTML_Form::display(), HTML_Form::displayHidden(), HTML_Form::returnHidden()
Access: public

Parameters:

string	`$name`	—	the string used in the 'name' attribute
string	`$value`	—	the string used for the item's value
string	`$attr`	—	a string of additional attributes to be put in the element (example: 'id="foo"')

[ Top ]

void addImage(
string
$name, string
$title, string
$src, [string
$attr = ''], [string
$thattr = HTML_FORM_TH_ATTR], [string
$tdattr = HTML_FORM_TD_ATTR])

Adds an image input to the list of fields to be processed by display()

See: HTML_Form::display(), HTML_Form::displayImage(), HTML_Form::displayImageRow(), HTML_Form::returnImage(), HTML_Form::returnImageRow()
Access: public

Parameters:

string	`$name`	—	the string used in the 'name' attribute
string	`$title`	—	the string used as the label
string	`$src`	—	the string denoting the path to the image. Can be a relative path or full URI.
string	`$attr`	—	a string of additional attributes to be put in the element (example: 'id="foo"')
string	`$thattr`	—	a string of additional attributes to be put in the <th> element (example: 'class="foo"')
string	`$tdattr`	—	a string of additional attributes to be put in the <td> element (example: 'class="foo"')

[ Top ]

void addPassword(
string
$name, string
$title, [mixed
$default = null], [int
$size = HTML_FORM_PASSWD_SIZE], [int
$maxlength = 0], [string
$attr = ''], [string
$thattr = HTML_FORM_TH_ATTR], [string
$tdattr = HTML_FORM_TD_ATTR])

Adds a combined password input and password confirmation input to the list of fields to be processed by display()

See: HTML_Form::addPasswordOne(), HTML_Form::display(), HTML_Form::displayPassword(), HTML_Form::displayPasswordRow(), HTML_Form::returnPassword(), HTML_Form::returnPasswordRow(), HTML_Form::displayPasswordOneRow(), HTML_Form::returnPasswordOneRow()
Access: public

Parameters:

string	`$name`	—	the string used in the 'name' attribute
string	`$title`	—	the string used as the label
mixed	`$default`	—	a default value for the element
int	`$size`	—	an integer used in the 'size' attribute
int	`$maxlength`	—	an integer used in the 'maxlength' attribute
string	`$attr`	—	a string of additional attributes to be put in the element (example: 'id="foo"')
string	`$thattr`	—	a string of additional attributes to be put in the <th> element (example: 'class="foo"')
string	`$tdattr`	—	a string of additional attributes to be put in the <td> element (example: 'class="foo"')

[ Top ]

void addPasswordOne(
string
$name, string
$title, [mixed
$default = null], [int
$size = HTML_FORM_PASSWD_SIZE], [int
$maxlength = 0], [string
$attr = ''], [string
$thattr = HTML_FORM_TH_ATTR], [string
$tdattr = HTML_FORM_TD_ATTR])

Adds a password input to the list of fields to be processed by display()

See: HTML_Form::addPassword(), HTML_Form::display(), HTML_Form::displayPassword(), HTML_Form::displayPasswordRow(), HTML_Form::returnPassword(), HTML_Form::returnPasswordRow(), HTML_Form::displayPasswordOneRow(), HTML_Form::returnPasswordOneRow()
Access: public

Parameters:

string	`$name`	—	the string used in the 'name' attribute
string	`$title`	—	the string used as the label
mixed	`$default`	—	a default value for the element
int	`$size`	—	an integer used in the 'size' attribute
int	`$maxlength`	—	an integer used in the 'maxlength' attribute
string	`$attr`	—	a string of additional attributes to be put in the element (example: 'id="foo"')
string	`$thattr`	—	a string of additional attributes to be put in the <th> element (example: 'class="foo"')
string	`$tdattr`	—	a string of additional attributes to be put in the <td> element (example: 'class="foo"')

[ Top ]

void addPlaintext(
string
$title, [string
$text = '&nbsp;'], [string
$thattr = HTML_FORM_TH_ATTR], [string
$tdattr = HTML_FORM_TD_ATTR])

Adds a row of text to the list of fields to be processed by display()

See: HTML_Form::display(), HTML_Form::displayPlaintext(), HTML_Form::displayPlaintextRow(), HTML_Form::returnPlaintext(), HTML_Form::returnPlaintextRow()
Access: public

Parameters:

string	`$title`	—	the string used as the label
string	`$text`	—	a string to be displayed
string	`$thattr`	—	a string of additional attributes to be put in the <th> element (example: 'class="foo"')
string	`$tdattr`	—	a string of additional attributes to be put in the <td> element (example: 'class="foo"')

[ Top ]

void addRadio(
string
$name, string
$title, string
$value, [bool
$default = false], [string
$attr = ''], [string
$thattr = HTML_FORM_TH_ATTR], [string
$tdattr = HTML_FORM_TD_ATTR])

Adds a radio input to the list of fields to be processed by display()

See: HTML_Form::display(), HTML_Form::displayRadio(), HTML_Form::displayRadioRow(), HTML_Form::returnRadio(), HTML_Form::returnRadioRow()
Access: public

Parameters:

string	`$name`	—	the string used in the 'name' attribute
string	`$title`	—	the string used as the label
string	`$value`	—	the string used for the item's value
bool	`$default`	—	a bool indicating if item should be checked
string	`$attr`	—	a string of additional attributes to be put in the element (example: 'id="foo"')
string	`$thattr`	—	a string of additional attributes to be put in the <th> element (example: 'class="foo"')
string	`$tdattr`	—	a string of additional attributes to be put in the <td> element (example: 'class="foo"')

[ Top ]

void addReset(
[string
$title = 'Discard Changes'], [string
$attr = ''], [string
$thattr = HTML_FORM_TH_ATTR], [string
$tdattr = HTML_FORM_TD_ATTR])

Adds a reset button to the list of fields to be processed by display()

NOTE: Unusual parameter order.

See: HTML_Form::display(), HTML_Form::displayReset(), HTML_Form::displayResetRow(), HTML_Form::returnReset(), HTML_Form::returnResetRow()
Access: public

Parameters:

string	`$title`	—	a string that appears on the button
string	`$attr`	—	a string of additional attributes to be put in the element (example: 'id="foo"')
string	`$thattr`	—	a string of additional attributes to be put in the <th> element (example: 'class="foo"')
string	`$tdattr`	—	a string of additional attributes to be put in the <td> element (example: 'class="foo"')

[ Top ]

void addSelect(
string
$name, string
$title, array
$entries, [mixed
$default = null], [int
$size = 1], [string
$blank = ''], [bool
$multiple = false], [string
$attr = ''], [string
$thattr = HTML_FORM_TH_ATTR], [string
$tdattr = HTML_FORM_TD_ATTR])

Adds a select list to the list of fields to be processed by display()

NOTE: In order for defaults to be automatically selected in the output, the PHP data types of the $default must match the data types of the keys in the $entries array.

See: HTML_Form::display(), HTML_Form::displaySelect(), HTML_Form::displaySelectRow(), HTML_Form::returnSelect(), HTML_Form::returnSelectRow()
Access: public

Parameters:

string	`$name`	—	the string used in the 'name' attribute
string	`$title`	—	the string used as the label
array	`$entries`	—	an array containing the <options> to be listed. The array's keys become the option values and the array's values become the visible text.
mixed	`$default`	—	a default value for the element
int	`$size`	—	an integer saying how many rows should be
string	`$blank`	—	if this string is present, an <option> will be added to the top of the list that will contain the given text in the visible portion and an empty string as the value
bool	`$multiple`	—	a bool saying if multiple choices are allowed
string	`$attr`	—	a string of additional attributes to be put in the element (example: 'id="foo"')
string	`$thattr`	—	a string of additional attributes to be put in the <th> element (example: 'class="foo"')
string	`$tdattr`	—	a string of additional attributes to be put in the <td> element (example: 'class="foo"')

[ Top ]

void addSubmit(
[string
$name = 'submit'], [string
$title = 'Submit Changes'], [string
$attr = ''], [string
$thattr = HTML_FORM_TH_ATTR], [string
$tdattr = HTML_FORM_TD_ATTR])

Adds a submit button to the list of fields to be processed by display()

See: HTML_Form::display(), HTML_Form::displaySubmit(), HTML_Form::displaySubmitRow(), HTML_Form::returnSubmit(), HTML_Form::returnSubmitRow()
Access: public

Parameters:

string	`$name`	—	a string used in the 'name' attribute
string	`$title`	—	a string that appears on the button
string	`$attr`	—	a string of additional attributes to be put in the element (example: 'id="foo"')
string	`$thattr`	—	a string of additional attributes to be put in the <th> element (example: 'class="foo"')
string	`$tdattr`	—	a string of additional attributes to be put in the <td> element (example: 'class="foo"')

[ Top ]

void addText(
string
$name, string
$title, [mixed
$default = null], [int
$size = HTML_FORM_TEXT_SIZE], [int
$maxlength = 0], [string
$attr = ''], [string
$thattr = HTML_FORM_TH_ATTR], [string
$tdattr = HTML_FORM_TD_ATTR])

Adds a text input to the list of fields to be processed by display()

See: HTML_Form::display(), HTML_Form::displayText(), HTML_Form::displayTextRow(), HTML_Form::returnText(), HTML_Form::returnTextRow()
Access: public

Parameters:

string	`$name`	—	the string used in the 'name' attribute
string	`$title`	—	the string used as the label
mixed	`$default`	—	a default value for the element
int	`$size`	—	an integer used in the 'size' attribute
int	`$maxlength`	—	an integer used in the 'maxlength' attribute
string	`$attr`	—	a string of additional attributes to be put in the element (example: 'id="foo"')
string	`$thattr`	—	a string of additional attributes to be put in the <th> element (example: 'class="foo"')
string	`$tdattr`	—	a string of additional attributes to be put in the <td> element (example: 'class="foo"')

[ Top ]

void addTextarea(
string
$name, string
$title, [mixed
$default = null], [int
$width = HTML_FORM_TEXTAREA_WT], [int
$height = HTML_FORM_TEXTAREA_HT], [int
$maxlength = 0], [string
$attr = ''], [string
$thattr = HTML_FORM_TH_ATTR], [string
$tdattr = HTML_FORM_TD_ATTR])

Adds a textarea input to the list of fields to be processed by display()

See: HTML_Form::display(), HTML_Form::displayTextarea(), HTML_Form::displayTextareaRow(), HTML_Form::returnTextarea(), HTML_Form::returnTextareaRow()
Access: public

Parameters:

string	`$name`	—	the string used in the 'name' attribute
string	`$title`	—	the string used as the label
mixed	`$default`	—	a default value for the element
int	`$width`	—	an integer saying how many characters wide the item should be
int	`$height`	—	an integer saying how many rows tall the item should be
int	`$maxlength`	—	an integer used in the 'maxlength' attribute
string	`$attr`	—	a string of additional attributes to be put in the element (example: 'id="foo"')
string	`$thattr`	—	a string of additional attributes to be put in the <th> element (example: 'class="foo"')
string	`$tdattr`	—	a string of additional attributes to be put in the <td> element (example: 'class="foo"')

[ Top ]

void display(
[string
$attr = ''], [string
$caption = ''], [string
$capattr = ''])

Prints a complete form with all fields you specified via the add*() methods

If you did not specify a field's default value (via the $default parameter to the add*() method in question), this method will automatically insert the user input found in $_GET/$_POST. This behavior can be disabled via setDefaultFromInput(false).

The $_GET/$_POST input is automatically escaped via htmlspecialchars(). This behavior can be disabled via setEscapeDefaultFromInput(false).

If the $_GET/$_POST superglobal doesn't exist, then $HTTP_GET_VARS/$HTTP_POST_VARS is used.

NOTE: can NOT be called statically.

See: HTML_Form::end(), HTML_Form::returnEnd(), HTML_Form::setDefaultFromInput(), HTML_Form::setEscapeDefaultFromInput()
Access: public

Parameters:

string	`$attr`	—	a string of additional attributes to be put in the <table> tag (example: 'class="foo"')
string	`$caption`	—	if present, a <caption> is added to the table
string	`$capattr`	—	a string of additional attributes to be put in the <caption> tag (example: 'class="foo"')

[ Top ]

void displayBlank(
)

Prints  

See: HTML_Form::displayBlankRow(), HTML_Form::addBlank(), HTML_Form::returnBlank(), HTML_Form::returnBlankRow()
Access: public

[ Top ]

void displayBlankRow(
int
$i, [string
$title = ''], [string
$thattr = HTML_FORM_TH_ATTR], [string
$tdattr = HTML_FORM_TD_ATTR])

Prints a blank row in the table

See: HTML_Form::displayBlank(), HTML_Form::addBlank(), HTML_Form::returnBlank(), HTML_Form::returnBlankRow()
Access: public

Parameters:

int	`$i`	—	the number of rows to create. Ignored if $title is used.
string	`$title`	—	a string to be used as the label for the row
string	`$thattr`	—	a string of additional attributes to be put in the <th> element (example: 'class="foo"')
string	`$tdattr`	—	a string of additional attributes to be put in the <td> element (example: 'class="foo"')

[ Top ]

void displayCheckbox(
string
$name, [bool
$default = false], [string
$attr = ''])

Prints a checkbox input

See: HTML_Form::displayCheckboxRow(), HTML_Form::addCheckbox(), HTML_Form::returnCheckbox(), HTML_Form::returnCheckboxRow()
Access: public

Parameters:

string	`$name`	—	the string used in the 'name' attribute
bool	`$default`	—	a bool indicating if item should be checked
string	`$attr`	—	a string of additional attributes to be put in the element (example: 'id="foo"')

[ Top ]

void displayCheckboxRow(
string
$name, string
$title, [bool
$default = false], [string
$attr = ''], [string
$thattr = HTML_FORM_TH_ATTR], [string
$tdattr = HTML_FORM_TD_ATTR])

Prints a checkbox input inside a table row

See: HTML_Form::displayCheckboxRow(), HTML_Form::addCheckbox(), HTML_Form::returnCheckbox(), HTML_Form::returnCheckboxRow()
Access: public

Parameters:

string	`$name`	—	the string used in the 'name' attribute
string	`$title`	—	the string used as the label
bool	`$default`	—	a bool indicating if item should be checked
string	`$attr`	—	a string of additional attributes to be put in the element (example: 'id="foo"')
string	`$thattr`	—	a string of additional attributes to be put in the <th> element (example: 'class="foo"')
string	`$tdattr`	—	a string of additional attributes to be put in the <td> element (example: 'class="foo"')

[ Top ]

void displayFile(
string
$name, [int
$maxsize = HTML_FORM_MAX_FILE_SIZE], [int
$size = HTML_FORM_TEXT_SIZE], [string
$accept = ''], [string
$attr = ''])

Prints a file upload input

See: HTML_Form::displayFileRow(), HTML_Form::addFile(), HTML_Form::returnFile(), HTML_Form::returnFileRow(), HTML_Form::returnMultipleFiles()
Access: public

Parameters:

string	`$name`	—	the string used in the 'name' attribute
int	`$maxsize`	—	an integer determining how large (in bytes) a submitted file can be.
int	`$size`	—	an integer used in the 'size' attribute
string	`$accept`	—	a string saying which MIME types are allowed
string	`$attr`	—	a string of additional attributes to be put in the element (example: 'id="foo"')

[ Top ]

void displayFileRow(
string
$name, string
$title, [int
$maxsize = HTML_FORM_MAX_FILE_SIZE], [int
$size = HTML_FORM_TEXT_SIZE], [string
$accept = ''], [string
$attr = ''], [string
$thattr = HTML_FORM_TH_ATTR], [string
$tdattr = HTML_FORM_TD_ATTR])

Prints a file upload input inside a table row

See: HTML_Form::displayFile(), HTML_Form::addFile(), HTML_Form::returnFile(), HTML_Form::returnFileRow(), HTML_Form::returnMultipleFiles()
Access: public

Parameters:

string	`$name`	—	the string used in the 'name' attribute
string	`$title`	—	the string used as the label
int	`$maxsize`	—	an integer determining how large (in bytes) a submitted file can be.
int	`$size`	—	an integer used in the 'size' attribute
string	`$accept`	—	a string saying which MIME types are allowed
string	`$attr`	—	a string of additional attributes to be put in the element (example: 'id="foo"')
string	`$thattr`	—	a string of additional attributes to be put in the <th> element (example: 'class="foo"')
string	`$tdattr`	—	a string of additional attributes to be put in the <td> element (example: 'class="foo"')

[ Top ]

void displayHidden(
string
$name, string
$value, [string
$attr = ''])

Prints a hiden input

See: HTML_Form::returnHidden(), HTML_Form::addHidden()
Access: public

Parameters:

string	`$name`	—	the string used in the 'name' attribute
string	`$value`	—	the string used for the item's value
string	`$attr`	—	a string of additional attributes to be put in the element (example: 'id="foo"')

[ Top ]

void displayImage(
string
$name, string
$src, [string
$attr = ''])

Prints an image input

See: HTML_Form::displayImageRow(), HTML_Form::addImage(), HTML_Form::returnImage(), HTML_Form::returnImageRow()
Since: Method available since Release 1.1.0
Access: public

Parameters:

string	`$name`	—	the string used in the 'name' attribute
string	`$src`	—	the string denoting the path to the image. Can be a relative path or full URI.
string	`$attr`	—	a string of additional attributes to be put in the element (example: 'id="foo"')

[ Top ]

void displayImageRow(
string
$name, string
$title, string
$src, [string
$attr = ''], [string
$thattr = HTML_FORM_TH_ATTR], [string
$tdattr = HTML_FORM_TD_ATTR])

Prints an image input inside a table row

See: HTML_Form::displayImage(), HTML_Form::addImage(), HTML_Form::returnImage(), HTML_Form::returnImageRow()
Since: Method available since Release 1.1.0
Access: public

Parameters:

string	`$name`	—	the string used in the 'name' attribute
string	`$title`	—	the string used as the label
string	`$src`	—	the string denoting the path to the image. Can be a relative path or full URI.
string	`$attr`	—	a string of additional attributes to be put in the element (example: 'id="foo"')
string	`$thattr`	—	a string of additional attributes to be put in the <th> element (example: 'class="foo"')
string	`$tdattr`	—	a string of additional attributes to be put in the <td> element (example: 'class="foo"')

[ Top ]

void displayPassword(
string
$name, [mixed
$default = null], [int
$size = HTML_FORM_PASSWD_SIZE], [int
$maxlength = 0], [string
$attr = ''])

Prints a password input

See: HTML_Form::displayPasswordRow(), HTML_Form::addPassword(), HTML_Form::returnPassword(), HTML_Form::returnPasswordRow()
Access: public

Parameters:

string	`$name`	—	the string used in the 'name' attribute
mixed	`$default`	—	a default value for the element
int	`$size`	—	an integer used in the 'size' attribute
int	`$maxlength`	—	an integer used in the 'maxlength' attribute
string	`$attr`	—	a string of additional attributes to be put in the element (example: 'id="foo"')

[ Top ]

void displayPasswordOneRow(
string
$name, string
$title, [mixed
$default = null], [int
$size = HTML_FORM_PASSWD_SIZE], [int
$maxlength = 0], [string
$attr = ''], [string
$thattr = HTML_FORM_TH_ATTR], [string
$tdattr = HTML_FORM_TD_ATTR])

Prints a password input inside a table row

See: HTML_Form::displayPasswordRow(), HTML_Form::displayPassword(), HTML_Form::addPassword(), HTML_Form::returnPassword(), HTML_Form::returnPasswordRow(), HTML_Form::returnPasswordOneRow()
Access: public

Parameters:

string	`$name`	—	the string used in the 'name' attribute
string	`$title`	—	the string used as the label
mixed	`$default`	—	a default value for the element
int	`$size`	—	an integer used in the 'size' attribute
int	`$maxlength`	—	an integer used in the 'maxlength' attribute
string	`$attr`	—	a string of additional attributes to be put in the element (example: 'id="foo"')
string	`$thattr`	—	a string of additional attributes to be put in the <th> element (example: 'class="foo"')
string	`$tdattr`	—	a string of additional attributes to be put in the <td> element (example: 'class="foo"')

[ Top ]

void displayPasswordRow(
string
$name, string
$title, [mixed
$default = null], [int
$size = HTML_FORM_PASSWD_SIZE], [int
$maxlength = 0], [string
$attr = ''], [string
$thattr = HTML_FORM_TH_ATTR], [string
$tdattr = HTML_FORM_TD_ATTR])

Prints a combined password input and password confirmation input inside a table row

See: HTML_Form::displayPasswordOneRow(), HTML_Form::displayPassword(), HTML_Form::addPassword(), HTML_Form::returnPassword(), HTML_Form::returnPasswordRow()
Access: public

Parameters:

string	`$name`	—	the string used in the 'name' attribute
string	`$title`	—	the string used as the label
mixed	`$default`	—	a default value for the element
int	`$size`	—	an integer used in the 'size' attribute
int	`$maxlength`	—	an integer used in the 'maxlength' attribute
string	`$attr`	—	a string of additional attributes to be put in the element (example: 'id="foo"')
string	`$thattr`	—	a string of additional attributes to be put in the <th> element (example: 'class="foo"')
string	`$tdattr`	—	a string of additional attributes to be put in the <td> element (example: 'class="foo"')

[ Top ]

void displayPlaintext(
[string
$text = '&nbsp;'])

Prints the text provided

See: HTML_Form::displayPlaintextRow(), HTML_Form::addPlaintext(), HTML_Form::returnPlaintext(), HTML_Form::returnPlaintextRow()
Access: public

Parameters:

string $text — a string to be displayed

[ Top ]

void displayPlaintextRow(
string
$title, [string
$text = '&nbsp;'], [string
$thattr = 'align="right valign="top""'], [string
$tdattr = HTML_FORM_TD_ATTR])

Prints the text provided inside a table row

See: HTML_Form::displayPlaintext(), HTML_Form::addPlaintext(), HTML_Form::returnPlaintext(), HTML_Form::returnPlaintextRow()
Access: public

Parameters:

string	`$title`	—	the string used as the label
string	`$text`	—	a string to be displayed
string	`$thattr`	—	a string of additional attributes to be put in the <th> element (example: 'class="foo"')
string	`$tdattr`	—	a string of additional attributes to be put in the <td> element (example: 'class="foo"')

[ Top ]

void displayRadio(
string
$name, string
$value, [bool
$default = false], [string
$attr = ''])

Prints a radio input

See: HTML_Form::displayRadioRow(), HTML_Form::addRadio(), HTML_Form::returnRadio(), HTML_Form::returnRadioRow()
Access: public

Parameters:

string	`$name`	—	the string used in the 'name' attribute
string	`$value`	—	the string used for the item's value
bool	`$default`	—	a bool indicating if item should be checked
string	`$attr`	—	a string of additional attributes to be put in the element (example: 'id="foo"')

[ Top ]

void displayRadioRow(
string
$name, string
$title, string
$value, [bool
$default = false], [string
$attr = ''], [string
$thattr = HTML_FORM_TH_ATTR], [string
$tdattr = HTML_FORM_TD_ATTR])

Prints a radio input inside a table row

See: HTML_Form::displayRadio(), HTML_Form::addRadio(), HTML_Form::returnRadio(), HTML_Form::returnRadioRow()
Access: public

Parameters:

string	`$name`	—	the string used in the 'name' attribute
string	`$title`	—	the string used as the label
string	`$value`	—	the string used for the item's value
bool	`$default`	—	a bool indicating if item should be checked
string	`$attr`	—	a string of additional attributes to be put in the element (example: 'id="foo"')
string	`$thattr`	—	a string of additional attributes to be put in the <th> element (example: 'class="foo"')
string	`$tdattr`	—	a string of additional attributes to be put in the <td> element (example: 'class="foo"')

[ Top ]

void displayReset(
[string
$title = 'Clear contents'], [string
$attr = ''])

Prints a reset button

NOTE: Unusual parameter order.

See: HTML_Form::displayResetRow(), HTML_Form::addReset(), HTML_Form::returnReset(), HTML_Form::returnResetRow()
Access: public

Parameters:

string	`$title`	—	a string that appears on the button
string	`$attr`	—	a string of additional attributes to be put in the element (example: 'id="foo"')

[ Top ]

void displayResetRow(
[string
$title = 'Clear contents'], [string
$attr = ''], [string
$thattr = HTML_FORM_TH_ATTR], [string
$tdattr = HTML_FORM_TD_ATTR])

Prints a reset button inside a table row

NOTE: Unusual parameter order.

See: HTML_Form::displayReset(), HTML_Form::addReset(), HTML_Form::returnReset(), HTML_Form::returnResetRow()
Access: public

Parameters:

string	`$title`	—	a string that appears on the button
string	`$attr`	—	a string of additional attributes to be put in the element (example: 'id="foo"')
string	`$thattr`	—	a string of additional attributes to be put in the <th> element (example: 'class="foo"')
string	`$tdattr`	—	a string of additional attributes to be put in the <td> element (example: 'class="foo"')

[ Top ]

void displaySelect(
string
$name, array
$entries, [mixed
$default = null], [int
$size = 1], [string
$blank = ''], [bool
$multiple = false], [string
$attr = ''])

Prints a select list

NOTE: In order for defaults to be automatically selected in the output, the PHP data types of the $default must match the data types of the keys in the $entries array.

See: HTML_Form::displaySelectRow(), HTML_Form::addSelect(), HTML_Form::returnSelect(), HTML_Form::returnSelectRow()
Access: public

Parameters:

string	`$name`	—	the string used in the 'name' attribute
array	`$entries`	—	an array containing the <options> to be listed. The array's keys become the option values and the array's values become the visible text.
mixed	`$default`	—	a default value for the element
int	`$size`	—	an integer saying how many rows should be
string	`$blank`	—	if this string is present, an <option> will be added to the top of the list that will contain the given text in the visible portion and an empty string as the value
bool	`$multiple`	—	a bool saying if multiple choices are allowed
string	`$attr`	—	a string of additional attributes to be put in the element (example: 'id="foo"')

[ Top ]

void displaySelectRow(
string
$name, string
$title, array
$entries, [mixed
$default = null], [int
$size = 1], [string
$blank = ''], [bool
$multiple = false], [string
$attr = ''], [string
$thattr = HTML_FORM_TH_ATTR], [string
$tdattr = HTML_FORM_TD_ATTR])

Prints a select list inside a table row

NOTE: In order for defaults to be automatically selected in the output, the PHP data types of the $default must match the data types of the keys in the $entries array.

See: HTML_Form::displaySelect(), HTML_Form::addSelect(), HTML_Form::returnSelect(), HTML_Form::returnSelectRow()
Access: public

Parameters:

string	`$name`	—	the string used in the 'name' attribute
string	`$title`	—	the string used as the label
array	`$entries`	—	an array containing the <options> to be listed. The array's keys become the option values and the array's values become the visible text.
mixed	`$default`	—	a default value for the element
int	`$size`	—	an integer saying how many rows should be
string	`$blank`	—	if this string is present, an <option> will be added to the top of the list that will contain the given text in the visible portion and an empty string as the value
bool	`$multiple`	—	a bool saying if multiple choices are allowed
string	`$attr`	—	a string of additional attributes to be put in the element (example: 'id="foo"')
string	`$thattr`	—	a string of additional attributes to be put in the <th> element (example: 'class="foo"')
string	`$tdattr`	—	a string of additional attributes to be put in the <td> element (example: 'class="foo"')

[ Top ]

void displaySubmit(
[string
$title = 'Submit Changes'], [string
$name = 'submit'], [string
$attr = ''])

Prints a submit button

NOTE: Unusual parameter order.

See: HTML_Form::displaySubmit(), HTML_Form::addSubmit(), HTML_Form::returnSubmit(), HTML_Form::returnSubmitRow()
Access: public

Parameters:

string	`$title`	—	a string that appears on the button
string	`$name`	—	a string used in the 'name' attribute
string	`$attr`	—	a string of additional attributes to be put in the element (example: 'id="foo"')

[ Top ]

void displaySubmitRow(
[string
$name = 'submit'], [string
$title = 'Submit Changes'], [string
$attr = ''], [string
$thattr = HTML_FORM_TH_ATTR], [string
$tdattr = HTML_FORM_TD_ATTR])

Prints a submit button inside a table row

See: HTML_Form::displaySubmit(), HTML_Form::addSubmit(), HTML_Form::returnSubmit(), HTML_Form::returnSubmitRow()
Access: public

Parameters:

string	`$name`	—	a string used in the 'name' attribute
string	`$title`	—	a string that appears on the button
string	`$attr`	—	a string of additional attributes to be put in the element (example: 'id="foo"')
string	`$thattr`	—	a string of additional attributes to be put in the <th> element (example: 'class="foo"')
string	`$tdattr`	—	a string of additional attributes to be put in the <td> element (example: 'class="foo"')

[ Top ]

void displayText(
string
$name, [mixed
$default = null], [int
$size = HTML_FORM_TEXT_SIZE], [int
$maxlength = 0], [string
$attr = ''])

Prints a text input element

See: HTML_Form::displayTextRow(), HTML_Form::addText(), HTML_Form::returnText(), HTML_Form::returnTextRow()
Access: public

Parameters:

string	`$name`	—	the string used in the 'name' attribute
mixed	`$default`	—	a default value for the element
int	`$size`	—	an integer used in the 'size' attribute
int	`$maxlength`	—	an integer used in the 'maxlength' attribute
string	`$attr`	—	a string of additional attributes to be put in the element (example: 'id="foo"')

[ Top ]

void displayTextarea(
string
$name, [mixed
$default = null], [int
$width = 40], [int
$height = 5], [int
$maxlength = ''], [string
$attr = ''])

Prints a textarea input

See: HTML_Form::displayTextareaRow(), HTML_Form::addTextarea(), HTML_Form::returnTextarea(), HTML_Form::returnTextareaRow()
Access: public

Parameters:

string	`$name`	—	the string used in the 'name' attribute
mixed	`$default`	—	a default value for the element
int	`$width`	—	an integer saying how many characters wide the item should be
int	`$height`	—	an integer saying how many rows tall the item should be
int	`$maxlength`	—	an integer used in the 'maxlength' attribute
string	`$attr`	—	a string of additional attributes to be put in the element (example: 'id="foo"')

[ Top ]

void displayTextareaRow(
string
$name, string
$title, [mixed
$default = null], [int
$width = 40], [int
$height = 5], [int
$maxlength = 0], [string
$attr = ''], [string
$thattr = HTML_FORM_TH_ATTR], [string
$tdattr = HTML_FORM_TD_ATTR])

Prints a textarea input inside a table row

See: HTML_Form::displayTextareaRow(), HTML_Form::addTextarea(), HTML_Form::returnTextarea(), HTML_Form::returnTextareaRow()
Access: public

Parameters:

string	`$name`	—	the string used in the 'name' attribute
string	`$title`	—	the string used as the label
mixed	`$default`	—	a default value for the element
int	`$width`	—	an integer saying how many characters wide the item should be
int	`$height`	—	an integer saying how many rows tall the item should be
int	`$maxlength`	—	an integer used in the 'maxlength' attribute
string	`$attr`	—	a string of additional attributes to be put in the element (example: 'id="foo"')
string	`$thattr`	—	a string of additional attributes to be put in the <th> element (example: 'class="foo"')
string	`$tdattr`	—	a string of additional attributes to be put in the <td> element (example: 'class="foo"')

[ Top ]

void displayTextRow(
string
$name, string
$title, [mixed
$default = null], [int
$size = HTML_FORM_TEXT_SIZE], [int
$maxlength = 0], [string
$attr = ''], [string
$thattr = HTML_FORM_TH_ATTR], [string
$tdattr = HTML_FORM_TD_ATTR])

Prints a text input element inside a table row

See: HTML_Form::displayText(), HTML_Form::addText(), HTML_Form::returnText(), HTML_Form::returnTextRow()
Access: public

Parameters:

string	`$name`	—	the string used in the 'name' attribute
string	`$title`	—	the string used as the label
mixed	`$default`	—	a default value for the element
int	`$size`	—	an integer used in the 'size' attribute
int	`$maxlength`	—	an integer used in the 'maxlength' attribute
string	`$attr`	—	a string of additional attributes to be put in the element (example: 'id="foo"')
string	`$thattr`	—	a string of additional attributes to be put in the <th> element (example: 'class="foo"')
string	`$tdattr`	—	a string of additional attributes to be put in the <td> element (example: 'class="foo"')

[ Top ]

void end(
)

Prints the ending tags for the table and form

NOTE: can NOT be called statically.

See: HTML_Form::display(), HTML_Form::start(), HTML_Form::returnEnd()
Access: public

[ Top ]

string returnBlank(
)

Produce a string containing  

See: HTML_Form::displayBlank(), HTML_Form::displayBlankRow(), HTML_Form::returnBlankRow(), HTML_Form::addBlank()
Since: Method available since Release 1.1.0
Access: public

[ Top ]

string returnBlankRow(
int
$i, [string
$title = ''], [string
$thattr = HTML_FORM_TH_ATTR], [string
$tdattr = HTML_FORM_TD_ATTR])

Produce a string containing a blank row in the table

See: HTML_Form::displayBlank(), HTML_Form::displayBlankRow(), HTML_Form::returnBlank(), HTML_Form::addBlank()
Since: Method available since Release 1.1.0
Access: public

Parameters:

int	`$i`	—	the number of rows to create. Ignored if $title is used.
string	`$title`	—	a string to be used as the label for the row
string	`$thattr`	—	a string of additional attributes to be put in the <th> element (example: 'class="foo"')
string	`$tdattr`	—	a string of additional attributes to be put in the <td> element (example: 'class="foo"')

[ Top ]

string returnCheckbox(
string
$name, [bool
$default = false], [string
$attr = ''])

Produce a string containing a checkbox input

See: HTML_Form::displayCheckbox(), HTML_Form::displayCheckboxRow(), HTML_Form::returnCheckboxRow(), HTML_Form::addCheckbox()
Access: public

Parameters:

string	`$name`	—	the string used in the 'name' attribute
bool	`$default`	—	a bool indicating if item should be checked
string	`$attr`	—	a string of additional attributes to be put in the element (example: 'id="foo"')

[ Top ]

string returnCheckboxRow(
string
$name, string
$title, [bool
$default = false], [string
$attr = ''], [string
$thattr = HTML_FORM_TH_ATTR], [string
$tdattr = HTML_FORM_TD_ATTR])

Produce a string containing a checkbox input inside a table row

See: HTML_Form::displayCheckbox(), HTML_Form::displayCheckboxRow(), HTML_Form::returnCheckbox(), HTML_Form::addCheckbox()
Access: public

Parameters:

string	`$name`	—	the string used in the 'name' attribute
string	`$title`	—	the string used as the label
bool	`$default`	—	a bool indicating if item should be checked
string	`$attr`	—	a string of additional attributes to be put in the element (example: 'id="foo"')
string	`$thattr`	—	a string of additional attributes to be put in the <th> element (example: 'class="foo"')
string	`$tdattr`	—	a string of additional attributes to be put in the <td> element (example: 'class="foo"')

[ Top ]

string returnEnd(
)

Produces a string containing the opening tags for the form and table

NOTE: can NOT be called statically.

See: HTML_Form::display(), HTML_Form::returnStart(), HTML_Form::start()
Access: public

[ Top ]

string returnFile(
[string
$name = 'userfile'], [int
$maxsize = HTML_FORM_MAX_FILE_SIZE], [int
$size = HTML_FORM_TEXT_SIZE], [string
$accept = ''], [string
$attr = ''])

Produce a string containing a file upload input

See: HTML_Form::displayFile(), HTML_Form::displayFileRow(), HTML_Form::returnFileRow(), HTML_Form::addFile(), HTML_Form::returnMultipleFiles()
Access: public

Parameters:

string	`$name`	—	the string used in the 'name' attribute
int	`$maxsize`	—	an integer determining how large (in bytes) a submitted file can be.
int	`$size`	—	an integer used in the 'size' attribute
string	`$accept`	—	a string saying which MIME types are allowed
string	`$attr`	—	a string of additional attributes to be put in the element (example: 'id="foo"')

[ Top ]

string returnFileRow(
string
$name, string
$title, [int
$maxsize = HTML_FORM_MAX_FILE_SIZE], [int
$size = HTML_FORM_TEXT_SIZE], [string
$accept = ''], [string
$attr = ''], [string
$thattr = HTML_FORM_TH_ATTR], [string
$tdattr = HTML_FORM_TD_ATTR])

Produce a string containing a file upload input inside a table row

See: HTML_Form::displayFile(), HTML_Form::displayFileRow(), HTML_Form::returnFile(), HTML_Form::addFile(), HTML_Form::returnMultipleFiles()
Access: public

Parameters:

string	`$name`	—	the string used in the 'name' attribute
string	`$title`	—	the string used as the label
int	`$maxsize`	—	an integer determining how large (in bytes) a submitted file can be.
int	`$size`	—	an integer used in the 'size' attribute
string	`$accept`	—	a string saying which MIME types are allowed
string	`$attr`	—	a string of additional attributes to be put in the element (example: 'id="foo"')
string	`$thattr`	—	a string of additional attributes to be put in the <th> element (example: 'class="foo"')
string	`$tdattr`	—	a string of additional attributes to be put in the <td> element (example: 'class="foo"')

[ Top ]

string returnHidden(
string
$name, string
$value, [string
$attr = ''])

Produce a string containing a hiden input

See: HTML_Form::displayHidden(), HTML_Form::addHidden()
Access: public

Parameters:

string	`$name`	—	the string used in the 'name' attribute
string	`$value`	—	the string used for the item's value
string	`$attr`	—	a string of additional attributes to be put in the element (example: 'id="foo"')

[ Top ]

string returnImage(
string
$name, string
$src, [string
$attr = ''])

Produce a string containing an image input

See: HTML_Form::displayImage(), HTML_Form::displayImageRow(), HTML_Form::returnImageRow(), HTML_Form::addImage()
Since: Method available since Release 1.1.0
Access: public

Parameters:

string	`$name`	—	the string used in the 'name' attribute
string	`$src`	—	the string denoting the path to the image. Can be a relative path or full URI.
string	`$attr`	—	a string of additional attributes to be put in the element (example: 'id="foo"')

[ Top ]

string returnImageRow(
string
$name, string
$title, string
$src, [string
$attr = ''], [string
$thattr = HTML_FORM_TH_ATTR], [string
$tdattr = HTML_FORM_TD_ATTR])

Produce a string containing an image input inside a table row

See: HTML_Form::displayImage(), HTML_Form::displayImageRow(), HTML_Form::returnImage(), HTML_Form::addImage()
Since: Method available since Release 1.1.0
Access: public

Parameters:

string	`$name`	—	the string used in the 'name' attribute
string	`$title`	—	the string used as the label
string	`$src`	—	the string denoting the path to the image. Can be a relative path or full URI.
string	`$attr`	—	a string of additional attributes to be put in the element (example: 'id="foo"')
string	`$thattr`	—	a string of additional attributes to be put in the <th> element (example: 'class="foo"')
string	`$tdattr`	—	a string of additional attributes to be put in the <td> element (example: 'class="foo"')

[ Top ]

string returnMultipleFiles(
[string
$name = 'userfile[]'], [int
$maxsize = HTML_FORM_MAX_FILE_SIZE], [int
$files = 3], [int
$size = HTML_FORM_TEXT_SIZE], [string
$accept = ''], [string
$attr = ''])

Produce a string containing a file upload input

See: HTML_Form::displayFile(), HTML_Form::displayFileRow(), HTML_Form::returnFile(), HTML_Form::returnFileRow(), HTML_Form::addFile()
Access: public

Parameters:

string	`$name`	—	the string used in the 'name' attribute
int	`$maxsize`	—	an integer determining how large (in bytes) a submitted file can be.
int	`$files`	—	an integer of how many file inputs to show
int	`$size`	—	an integer used in the 'size' attribute
string	`$accept`	—	a string saying which MIME types are allowed
string	`$attr`	—	a string of additional attributes to be put in the element (example: 'id="foo"')

[ Top ]

string returnPassword(
string
$name, [mixed
$default = null], [int
$size = HTML_FORM_PASSWD_SIZE], [int
$maxlength = 0], [string
$attr = ''])

Produce a string containing a password input

See: HTML_Form::displayPassword(), HTML_Form::displayPasswordRow(), HTML_Form::returnPasswordRow(), HTML_Form::addPassword()
Access: public

Parameters:

string	`$name`	—	the string used in the 'name' attribute
mixed	`$default`	—	a default value for the element
int	`$size`	—	an integer used in the 'size' attribute
int	`$maxlength`	—	an integer used in the 'maxlength' attribute
string	`$attr`	—	a string of additional attributes to be put in the element (example: 'id="foo"')

[ Top ]

string returnPasswordOneRow(
string
$name, string
$title, [mixed
$default = null], [int
$size = HTML_FORM_PASSWD_SIZE], [int
$maxlength = 0], [string
$attr = ''], [string
$thattr = HTML_FORM_TH_ATTR], [string
$tdattr = HTML_FORM_TD_ATTR])

Produce a string containing a password input inside a table row

See: HTML_Form::displayPassword(), HTML_Form::displayPasswordRow(), HTML_Form::returnPassword(), HTML_Form::addPassword(), HTML_Form::displayPasswordOneRow()
Access: public

Parameters:

string	`$name`	—	the string used in the 'name' attribute
string	`$title`	—	the string used as the label
mixed	`$default`	—	a default value for the element
int	`$size`	—	an integer used in the 'size' attribute
int	`$maxlength`	—	an integer used in the 'maxlength' attribute
string	`$attr`	—	a string of additional attributes to be put in the element (example: 'id="foo"')
string	`$thattr`	—	a string of additional attributes to be put in the <th> element (example: 'class="foo"')
string	`$tdattr`	—	a string of additional attributes to be put in the <td> element (example: 'class="foo"')

[ Top ]

string returnPasswordRow(
string
$name, string
$title, [mixed
$default = null], [int
$size = HTML_FORM_PASSWD_SIZE], [int
$maxlength = 0], [string
$attr = ''], [string
$thattr = HTML_FORM_TH_ATTR], [string
$tdattr = HTML_FORM_TD_ATTR])

Produce a string containing a combined password input and password confirmation input inside a table row

See: HTML_Form::displayPassword(), HTML_Form::displayPasswordRow(), HTML_Form::returnPassword(), HTML_Form::addPassword()
Access: public

Parameters:

string	`$name`	—	the string used in the 'name' attribute
string	`$title`	—	the string used as the label
mixed	`$default`	—	a default value for the element
int	`$size`	—	an integer used in the 'size' attribute
int	`$maxlength`	—	an integer used in the 'maxlength' attribute
string	`$attr`	—	a string of additional attributes to be put in the element (example: 'id="foo"')
string	`$thattr`	—	a string of additional attributes to be put in the <th> element (example: 'class="foo"')
string	`$tdattr`	—	a string of additional attributes to be put in the <td> element (example: 'class="foo"')

[ Top ]

string returnPlaintext(
[string
$text = '&nbsp;'])

Produce a string containing the text provided

See: HTML_Form::displayPlaintext(), HTML_Form::displayPlaintextRow(), HTML_Form::returnPlaintextRow(), HTML_Form::addPlaintext()
Access: public

Parameters:

string $text — a string to be displayed

[ Top ]

string returnPlaintextRow(
string
$title, [string
$text = '&nbsp;'], [string
$thattr = HTML_FORM_TH_ATTR], [string
$tdattr = HTML_FORM_TD_ATTR])

Produce a string containing the text provided inside a table row

See: HTML_Form::displayPlaintext(), HTML_Form::displayPlaintextRow(), HTML_Form::returnPlaintext(), HTML_Form::addPlaintext()
Access: public

Parameters:

string	`$title`	—	the string used as the label
string	`$text`	—	a string to be displayed
string	`$thattr`	—	a string of additional attributes to be put in the <th> element (example: 'class="foo"')
string	`$tdattr`	—	a string of additional attributes to be put in the <td> element (example: 'class="foo"')

[ Top ]

string returnRadio(
string
$name, string
$value, [bool
$default = false], [string
$attr = ''])

Produce a string containing a radio input

See: HTML_Form::displayRadio(), HTML_Form::displayRadioRow(), HTML_Form::returnRadioRow(), HTML_Form::addRadio()
Since: Method available since Release 1.1.0
Access: public

Parameters:

string	`$name`	—	the string used in the 'name' attribute
string	`$value`	—	the string used for the item's value
bool	`$default`	—	a bool indicating if item should be checked
string	`$attr`	—	a string of additional attributes to be put in the element (example: 'id="foo"')

[ Top ]

string returnRadioRow(
string
$name, string
$title, string
$value, [bool
$default = false], [string
$attr = ''], [string
$thattr = HTML_FORM_TH_ATTR], [string
$tdattr = HTML_FORM_TD_ATTR])

Produce a string containing a radio input inside a table row

See: HTML_Form::displayRadio(), HTML_Form::displayRadioRow(), HTML_Form::returnRadio(), HTML_Form::addRadio()
Since: Method available since Release 1.1.0
Access: public

Parameters:

string	`$name`	—	the string used in the 'name' attribute
string	`$title`	—	the string used as the label
string	`$value`	—	the string used for the item's value
bool	`$default`	—	a bool indicating if item should be checked
string	`$attr`	—	a string of additional attributes to be put in the element (example: 'id="foo"')
string	`$thattr`	—	a string of additional attributes to be put in the <th> element (example: 'class="foo"')
string	`$tdattr`	—	a string of additional attributes to be put in the <td> element (example: 'class="foo"')

[ Top ]

string returnReset(
[string
$title = 'Clear contents'], [string
$attr = ''])

Produce a string containing a reset button

NOTE: Unusual parameter order.

See: HTML_Form::displayReset(), HTML_Form::displayResetRow(), HTML_Form::returnResetRow(), HTML_Form::addReset()
Access: public

Parameters:

string	`$title`	—	a string that appears on the button
string	`$attr`	—	a string of additional attributes to be put in the element (example: 'id="foo"')

[ Top ]

string returnResetRow(
[string
$title = 'Clear contents'], [string
$attr = ''], [string
$thattr = HTML_FORM_TH_ATTR], [string
$tdattr = HTML_FORM_TD_ATTR])

Produce a string containing a reset button inside a table row

NOTE: Unusual parameter order.

See: HTML_Form::displayReset(), HTML_Form::displayResetRow(), HTML_Form::returnReset(), HTML_Form::addReset()
Access: public

Parameters:

string	`$title`	—	a string that appears on the button
string	`$attr`	—	a string of additional attributes to be put in the element (example: 'id="foo"')
string	`$thattr`	—	a string of additional attributes to be put in the <th> element (example: 'class="foo"')
string	`$tdattr`	—	a string of additional attributes to be put in the <td> element (example: 'class="foo"')

[ Top ]

string returnSelect(
string
$name, array
$entries, [mixed
$default = null], [int
$size = 1], [string
$blank = ''], [bool
$multiple = false], [string
$attr = ''])

Produce a string containing a select list

NOTE: In order for defaults to be automatically selected in the output, the PHP data types of the $default must match the data types of the keys in the $entries array.

See: HTML_Form::displaySelect(), HTML_Form::displaySelectRow(), HTML_Form::returnSelectRow(), HTML_Form::addSelect()
Access: public

Parameters:

string	`$name`	—	the string used in the 'name' attribute
array	`$entries`	—	an array containing the <options> to be listed. The array's keys become the option values and the array's values become the visible text.
mixed	`$default`	—	a default value for the element
int	`$size`	—	an integer saying how many rows should be
string	`$blank`	—	if this string is present, an <option> will be added to the top of the list that will contain the given text in the visible portion and an empty string as the value
bool	`$multiple`	—	a bool saying if multiple choices are allowed
string	`$attr`	—	a string of additional attributes to be put in the element (example: 'id="foo"')

[ Top ]

string returnSelectRow(
string
$name, string
$title, array
$entries, [mixed
$default = null], [int
$size = 1], [string
$blank = ''], [bool
$multiple = false], [string
$attr = ''], [string
$thattr = HTML_FORM_TH_ATTR], [string
$tdattr = HTML_FORM_TD_ATTR])

Produce a string containing a select list inside a table row

NOTE: In order for defaults to be automatically selected in the output, the PHP data types of the $default must match the data types of the keys in the $entries array.

See: HTML_Form::displaySelect(), HTML_Form::displaySelectRow(), HTML_Form::returnSelect(), HTML_Form::addSelect()
Access: public

Parameters:

string	`$name`	—	the string used in the 'name' attribute
string	`$title`	—	the string used as the label
array	`$entries`	—	an array containing the <options> to be listed. The array's keys become the option values and the array's values become the visible text.
mixed	`$default`	—	a default value for the element
int	`$size`	—	an integer saying how many rows should be
string	`$blank`	—	if this string is present, an <option> will be added to the top of the list that will contain the given text in the visible portion and an empty string as the value
bool	`$multiple`	—	a bool saying if multiple choices are allowed
string	`$attr`	—	a string of additional attributes to be put in the element (example: 'id="foo"')
string	`$thattr`	—	a string of additional attributes to be put in the <th> element (example: 'class="foo"')
string	`$tdattr`	—	a string of additional attributes to be put in the <td> element (example: 'class="foo"')

[ Top ]

string returnStart(
[bool
$multipartformdata = false])

Produces a string containing the opening tags for the form and table

NOTE: can NOT be called statically.

See: HTML_Form::display(), HTML_Form::returnEnd(), HTML_Form::start()
Access: public

Parameters:

bool $multipartformdata — a bool indicating if the form should be submitted in multipart format

[ Top ]

string returnSubmit(
[string
$title = 'Submit Changes'], [string
$name = 'submit'], [string
$attr = ''])

Produce a string containing a submit button

NOTE: Unusual parameter order.

See: HTML_Form::displaySubmit(), HTML_Form::displaySubmitRow(), HTML_Form::returnSubmitRow(), HTML_Form::addSubmit()
Access: public

Parameters:

string	`$title`	—	a string that appears on the button
string	`$name`	—	a string used in the 'name' attribute
string	`$attr`	—	a string of additional attributes to be put in the element (example: 'id="foo"')

[ Top ]

string returnSubmitRow(
[string
$name = 'submit'], [string
$title = 'Submit Changes'], [string
$attr = ''], [string
$thattr = HTML_FORM_TH_ATTR], [string
$tdattr = HTML_FORM_TD_ATTR])

Produce a string containing a submit button inside a table row

See: HTML_Form::displaySubmit(), HTML_Form::displaySubmitRow(), HTML_Form::returnSubmit(), HTML_Form::addSubmit()
Access: public

Parameters:

string	`$name`	—	a string used in the 'name' attribute
string	`$title`	—	a string that appears on the button
string	`$attr`	—	a string of additional attributes to be put in the element (example: 'id="foo"')
string	`$thattr`	—	a string of additional attributes to be put in the <th> element (example: 'class="foo"')
string	`$tdattr`	—	a string of additional attributes to be put in the <td> element (example: 'class="foo"')

[ Top ]

string returnText(
string
$name, [mixed
$default = null], [int
$size = HTML_FORM_TEXT_SIZE], [int
$maxlength = 0], [string
$attr = ''])

Produce a string containing a text input

See: HTML_Form::displayText(), HTML_Form::displayTextRow(), HTML_Form::returnTextRow(), HTML_Form::addText()
Access: public

Parameters:

string	`$name`	—	the string used in the 'name' attribute
mixed	`$default`	—	a default value for the element
int	`$size`	—	an integer used in the 'size' attribute
int	`$maxlength`	—	an integer used in the 'maxlength' attribute
string	`$attr`	—	a string of additional attributes to be put in the element (example: 'id="foo"')

[ Top ]

string returnTextarea(
string
$name, [mixed
$default = null], [int
$width = 40], [int
$height = 5], [int
$maxlength = 0], [string
$attr = ''])

Produce a string containing a textarea input

See: HTML_Form::displayTextarea(), HTML_Form::displayTextareaRow(), HTML_Form::returnTextareaRow(), HTML_Form::addTextarea()
Access: public

Parameters:

string	`$name`	—	the string used in the 'name' attribute
mixed	`$default`	—	a default value for the element
int	`$width`	—	an integer saying how many characters wide the item should be
int	`$height`	—	an integer saying how many rows tall the item should be
int	`$maxlength`	—	an integer used in the 'maxlength' attribute
string	`$attr`	—	a string of additional attributes to be put in the element (example: 'id="foo"')

[ Top ]

string returnTextareaRow(
string
$name, string
$title, [mixed
$default = null], [int
$width = 40], [int
$height = 5], [int
$maxlength = 0], [string
$attr = ''], [string
$thattr = HTML_FORM_TH_ATTR], [string
$tdattr = HTML_FORM_TD_ATTR])

Produce a string containing a textarea input inside a table row

See: HTML_Form::displayTextarea(), HTML_Form::displayTextareaRow(), HTML_Form::returnTextareaRow(), HTML_Form::addTextarea()
Access: public

Parameters:

string	`$name`	—	the string used in the 'name' attribute
string	`$title`	—	the string used as the label
mixed	`$default`	—	a default value for the element
int	`$width`	—	an integer saying how many characters wide the item should be
int	`$height`	—	an integer saying how many rows tall the item should be
int	`$maxlength`	—	an integer used in the 'maxlength' attribute
string	`$attr`	—	a string of additional attributes to be put in the element (example: 'id="foo"')
string	`$thattr`	—	a string of additional attributes to be put in the <th> element (example: 'class="foo"')
string	`$tdattr`	—	a string of additional attributes to be put in the <td> element (example: 'class="foo"')

[ Top ]

string returnTextRow(
string
$name, string
$title, [mixed
$default = null], [int
$size = HTML_FORM_TEXT_SIZE], [int
$maxlength = 0], [string
$attr = ''], [string
$thattr = HTML_FORM_TH_ATTR], [string
$tdattr = HTML_FORM_TD_ATTR])

Produce a string containing a text input inside a table row

See: HTML_Form::displayText(), HTML_Form::displayTextRow(), HTML_Form::returnText(), HTML_Form::addText()
Access: public

Parameters:

string	`$name`	—	the string used in the 'name' attribute
string	`$title`	—	the string used as the label
mixed	`$default`	—	a default value for the element
int	`$size`	—	an integer used in the 'size' attribute
int	`$maxlength`	—	an integer used in the 'maxlength' attribute
string	`$attr`	—	a string of additional attributes to be put in the element (example: 'id="foo"')
string	`$thattr`	—	a string of additional attributes to be put in the <th> element (example: 'class="foo"')
string	`$tdattr`	—	a string of additional attributes to be put in the <td> element (example: 'class="foo"')

[ Top ]

void setDefaultFromInput(
boolean
$bool)

Enables/Disables $_GET/$_POST user input data showing up in fields when a $default hasn't been set

The default is TRUE.

See: HTML_Form::setEscapeDefaultFromInput()
Since: Method available since Release 1.3.0

Parameters:

boolean $bool — TRUE to use $_GET/$_POST for the default, FALSE to default to an empty string

[ Top ]

void setEscapeDefaultFromInput(
boolean
$bool)

Enables/Disables escaping of the $_GET/$_POST data that shows up in fields when a $default hasn't been set

The default is TRUE.

Uses htmlspecialchars() for the escaping.

See: HTML_Form::setDefaultFromInput()
Since: Method available since Release 1.3.0

Parameters:

boolean $bool — TRUE to escape, FALSE to disable escaping

[ Top ]

void start(
[bool
$multipartformdata = false])

Prints the opening tags for the form and table

NOTE: can NOT be called statically.

See: HTML_Form::display(), HTML_Form::end(), HTML_Form::returnStart()
Access: public

Parameters:

bool $multipartformdata — a bool indicating if the form should be submitted in multipart format

[ Top ]

Class: HTML_Form

Class Overview

Author(s):

Version:

Copyright:

Variables

Methods

Inherited Variables

Inherited Methods

Class Details

Class Variables

$action =

$attr =

$enctype =

$fields =

$method =

$name =

$storageObject =

$target =

Method Detail

HTML_Form (Constructor) [line 248]

Parameters:

addBlank [line 676]

Parameters:

addCheckbox [line 425]

Parameters:

addFile [line 708]

Parameters:

addHidden [line 651]

Parameters:

addImage [line 627]

Parameters:

addPassword [line 359]

Parameters:

addPasswordOne [line 394]

Parameters:

addPlaintext [line 737]

Parameters:

addRadio [line 596]

Parameters:

addReset [line 521]

Parameters:

addSelect [line 563]

Parameters:

addSubmit [line 491]

Parameters:

addText [line 323]

Parameters:

addTextarea [line 460]

Parameters:

display [line 2585]

Parameters:

displayBlank [line 1396]

displayBlankRow [line 1421]

Parameters:

displayCheckbox [line 961]

Parameters:

displayCheckboxRow [line 988]

Parameters:

displayFile [line 1448]

Parameters:

displayFileRow [line 1481]

Parameters:

displayHidden [line 1321]

Parameters:

displayImage [line 1268]

Parameters:

displayImageRow [line 1297]

Parameters:

displayPassword [line 862]

Parameters:

displayPasswordOneRow [line 933]

Parameters:

displayPasswordRow [line 896]

Parameters:

displayPlaintext [line 1505]

Parameters:

displayPlaintextRow [line 1529]

Parameters:

displayRadio [line 1347]