Class: HTML_QuickForm_xbutton

Source Location: /HTML_QuickForm-3.2.14/QuickForm/xbutton.php

Class Overview

HTML_Common
   |
   --HTML_QuickForm_element
      |
      --HTML_QuickForm_xbutton

Class for HTML 4.0 <button> element

Author(s):

Alexey Borzov <avb at php.net>

Version:

Release: 3.2.14

Methods

Inherited Variables

Inherited Methods

Class: HTML_QuickForm_element

HTML_QuickForm_element::HTML_QuickForm_element(): Class constructor
HTML_QuickForm_element::accept(): Accepts a renderer
HTML_QuickForm_element::apiVersion(): Returns the current API version
HTML_QuickForm_element::exportValue(): Returns a 'safe' element's value
HTML_QuickForm_element::freeze(): Freeze the element so that only its value is returned
HTML_QuickForm_element::getFrozenHtml(): Returns the value of field without HTML tags
HTML_QuickForm_element::getLabel(): Returns display text for the element
HTML_QuickForm_element::getName(): Returns the element name
HTML_QuickForm_element::getType(): Returns element type
HTML_QuickForm_element::getValue(): Returns the value of the form element
HTML_QuickForm_element::isFrozen(): Returns whether or not the element is frozen
HTML_QuickForm_element::onQuickFormEvent(): Called by HTML_QuickForm whenever form event is made on this element
HTML_QuickForm_element::setLabel(): Sets display text for the element
HTML_QuickForm_element::setName(): Sets the input field name
HTML_QuickForm_element::setPersistantFreeze(): Sets wether an element value should be kept in an hidden field when the element is frozen or not
HTML_QuickForm_element::setValue(): Sets the value of the form element
HTML_QuickForm_element::unfreeze(): Unfreezes the element so that it becomes editable

Class Details

[line 38]
Class for HTML 4.0 <button> element

Author: Alexey Borzov <avb@php.net>
Version: Release: 3.2.14
Since: 3.2.3

[ Top ]

Method Detail

HTML_QuickForm_xbutton (Constructor) [line 55]

HTML_QuickForm_xbutton HTML_QuickForm_xbutton(
[string
$elementName = null], [string
$elementContent = null], [mixed
$attributes = null])

Class constructor

Access: public

Parameters:

string	`$elementName`	—	Button name
string	`$elementContent`	—	Button content (HTML to add between <button></button> tags)
mixed	`$attributes`	—	Either a typical HTML attribute string or an associative array

[ Top ]

exportValue [line 144]

void exportValue(

&$submitValues, [
$assoc = false])

Returns a 'safe' element's value

The value is only returned if the button's type is "submit" and if this particlular button was clicked

Overrides HTML_QuickForm_element::exportValue() (Returns a 'safe' element's value)

Parameters:

	`&$submitValues`	—
	`$assoc`	—

[ Top ]

freeze [line 76]

void freeze(
)

Overrides HTML_QuickForm_element::freeze() (Freeze the element so that only its value is returned)

[ Top ]

getFrozenHtml [line 70]

void getFrozenHtml(
)

Overrides HTML_QuickForm_element::getFrozenHtml() (Returns the value of field without HTML tags)

[ Top ]

getName [line 90]

void getName(
)

Overrides HTML_QuickForm_element::getName() (Returns the element name)

[ Top ]

getValue [line 104]

void getValue(
)

Overrides HTML_QuickForm_element::getValue() (Returns the value of the form element)

[ Top ]

onQuickFormEvent [line 121]

void onQuickFormEvent(

$event, 
$arg, 
&$caller)

Overrides HTML_QuickForm_element::onQuickFormEvent() (Called by HTML_QuickForm whenever form event is made on this element)

Parameters:

	`$event`	—
	`$arg`	—
	`&$caller`	—

[ Top ]

setContent [line 115]

void setContent(
string
$content)

Sets the contents of the button element

Parameters:

string $content — Button content (HTML to add between <button></button> tags)

[ Top ]

setName [line 82]

void setName(

$name)

Overrides HTML_QuickForm_element::setName() (Sets the input field name)

Parameters:

$name —

[ Top ]

setValue [line 96]

void setValue(

$value)

Overrides HTML_QuickForm_element::setValue() (Sets the value of the form element)

Parameters:

$value —

[ Top ]

toHtml [line 64]

void toHtml(
)

[ Top ]