Class: HTML_QuickForm_xbutton

Source Location: /pear/HTML/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@php.net>

Version:

Methods

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: HTML_Common

HTML_Common::HTML_Common(): Class constructor
HTML_Common::apiVersion(): Returns the current API version
HTML_Common::charset(): Sets the charset to use by htmlspecialchars() function
HTML_Common::display(): Displays the HTML to the screen
HTML_Common::getAttribute(): Returns the value of the given attribute
HTML_Common::getAttributes(): Returns the assoc array (default) or string of attributes
HTML_Common::getComment(): Returns the HTML comment
HTML_Common::getTabOffset(): Returns the tabOffset
HTML_Common::removeAttribute(): Removes an attribute
HTML_Common::setAttribute(): Sets the value of the attribute
HTML_Common::setAttributes(): Sets the HTML attributes
HTML_Common::setComment(): Sets the HTML comment to be displayed at the beginning of the HTML string
HTML_Common::setLineEnd(): Sets the line end style to Windows, Mac, Unix or a custom string.
HTML_Common::setTab(): Sets the string used to indent HTML
HTML_Common::setTabOffset(): Sets the tab offset
HTML_Common::toHtml(): Abstract method. Must be extended to return the objects HTML
HTML_Common::updateAttributes(): Updates the passed attributes without changing the other existing attributes

Class Details

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

Tags:

author:	Alexey Borzov <avb@php.net>
version:	1.3
since:	3.2.3
access:	public

[ Top ]

Class Methods

constructor HTML_QuickForm_xbutton [line 47]

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

Class constructor

Tags:

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 ]

method exportValue [line 136]

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 ]

method freeze [line 68]

void freeze(
)

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

[ Top ]

method getFrozenHtml [line 62]

void getFrozenHtml(
)

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

[ Top ]

method getName [line 82]

void getName(
)

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

[ Top ]

method getValue [line 96]

void getValue(
)

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

[ Top ]

method onQuickFormEvent [line 113]

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 ]

method setContent [line 107]

void setContent(
string
$content)

Sets the contents of the button element

Parameters:

string

$content

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

[ Top ]

method setName [line 74]

void setName(

$name)

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

Parameters:

$name

[ Top ]

method setValue [line 88]

void setValue(

$value)

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

Parameters:

$value

[ Top ]

method toHtml [line 56]

void toHtml(
)

Overrides HTML_Common::toHtml() (Abstract method. Must be extended to return the objects HTML)

[ Top ]

Documentation generated on Sun, 08 Jan 2012 17:52:07 +0100 by phpDocumentor 1.4.3