HTML_QuickForm_xbutton Class Reference

Inheritance diagram for HTML_QuickForm_xbutton:

Collaboration diagram for HTML_QuickForm_xbutton:

Public Member Functions
	HTML_QuickForm_xbutton ($elementName=null, $elementContent=null, $attributes=null)
	toHtml ()
	getFrozenHtml ()
	freeze ()
	setName ($name)
	getName ()
	setValue ($value)
	getValue ()
	setContent ($content)
	onQuickFormEvent ($event, $arg, &$caller)
	exportValue (&$submitValues, $assoc=false)
Data Fields
	$_content

---

Detailed Description

Class for HTML 4.0 <button> element

Author:

Alexey Borzov <avb@php.net>

Since:

3.2.3 public

Definition at line 30 of file xbutton.php.

---

Member Function Documentation

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

Reimplemented from HTML_QuickForm_element.

Definition at line 136 of file xbutton.php.

Here is the call graph for this function:

freeze

(

)

Freeze the element so that only its value is returned

public

Returns:

void

Reimplemented from HTML_QuickForm_element.

Definition at line 68 of file xbutton.php.

getFrozenHtml

(

)

Returns the value of field without HTML tags

Since:

1.0 public

Returns:

string

Reimplemented from HTML_QuickForm_element.

Definition at line 62 of file xbutton.php.

Here is the call graph for this function:

getName

(

)

Returns the element name

Since:

1.0 public

Returns:

string

Reimplemented from HTML_QuickForm_element.

Definition at line 82 of file xbutton.php.

Here is the call graph for this function:

getValue

(

)

Returns the value of the form element

Since:

1.0 public

Returns:

mixed

Reimplemented from HTML_QuickForm_element.

Definition at line 96 of file xbutton.php.

Here is the call graph for this function:

HTML_QuickForm_xbutton	(	$	elementName = null,
		$	elementContent = null,
		$	attributes = null
	)

Class constructor

Parameters:

string	Button name
string	Button content (HTML to add between <button></button> tags)
mixed	Either a typical HTML attribute string or an associative array public

Definition at line 47 of file xbutton.php.

Here is the call graph for this function:

onQuickFormEvent	(	$	event,
		$	arg,
		&$	caller
	)

Called by HTML_QuickForm whenever form event is made on this element

Parameters:

string	$event	Name of event
mixed	$arg	event arguments
object	$caller	calling object

Since:

1.0 public

Returns:

void

Reimplemented from HTML_QuickForm_element.

Definition at line 113 of file xbutton.php.

Here is the call graph for this function:

setContent

(

$

content

)

Sets the contents of the button element

Parameters:

string

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

Definition at line 107 of file xbutton.php.

Here is the caller graph for this function:

setName

(

$

name

)

Sets the input field name

Parameters:

string

$name

Input field name attribute

Since:

1.0 public

Returns:

void

Reimplemented from HTML_QuickForm_element.

Definition at line 74 of file xbutton.php.

Here is the call graph for this function:

setValue

(

$

value

)

Sets the value of the form element

Parameters:

string

$value

Default value of the form element

Since:

1.0 public

Returns:

void

Reimplemented from HTML_QuickForm_element.

Definition at line 88 of file xbutton.php.

Here is the call graph for this function:

Here is the caller graph for this function:

toHtml

(

)

Abstract method. Must be extended to return the objects HTML

public

Returns:

string

Reimplemented from HTML_Common.

Definition at line 56 of file xbutton.php.

Here is the call graph for this function:

Here is the caller graph for this function:

---

Field Documentation

$_content

Definition at line 37 of file xbutton.php.

---

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

• C:/xampp/htdocs/moodle/lib/pear/HTML/QuickForm/xbutton.php