HTML_QuickForm
[ class tree: HTML_QuickForm ] [ index: HTML_QuickForm ] [ all elements ]

Class: HTML_QuickForm_submit

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

Class Overview

HTML_Common
   |
   --HTML_QuickForm_element
      |
      --HTML_QuickForm_input
         |
         --HTML_QuickForm_submit

HTML class for a submit type element


Author(s):

Version:

  • Release: 3.2.14

Methods


Inherited Variables

Inherited Methods

Class: HTML_QuickForm_input

HTML_QuickForm_input::HTML_QuickForm_input()
Class constructor
HTML_QuickForm_input::exportValue()
We don't need values from button-type elements (except submit) and files
HTML_QuickForm_input::getName()
Returns the element name
HTML_QuickForm_input::getValue()
Returns the value of the form element
HTML_QuickForm_input::onQuickFormEvent()
Called by HTML_QuickForm whenever form event is made on this element
HTML_QuickForm_input::setName()
Sets the input field name
HTML_QuickForm_input::setType()
Sets the element type
HTML_QuickForm_input::setValue()
Sets the value of the form element
HTML_QuickForm_input::toHtml()
Returns the input field in HTML

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 40]
HTML class for a submit type element


[ Top ]


Method Detail

HTML_QuickForm_submit (Constructor)   [line 54]

void HTML_QuickForm_submit( [string $elementName = null], [string $value = null], [mixed $attributes = null])

Class constructor
  • Since: 1.0
  • Access: public

Parameters:

string   $elementName     Input field name attribute
string   $value     Input field value
mixed   $attributes     Either a typical HTML attribute string or an associative array

[ Top ]

exportValue   [line 82]

void exportValue( &$submitValues, [ $assoc = false])

Only return the value if it is found within $submitValues (i.e. if

this particular submit button was clicked)


Overrides HTML_QuickForm_input::exportValue() (We don't need values from button-type elements (except submit) and files)

Parameters:

   &$submitValues     
   $assoc     

[ Top ]

freeze   [line 70]

void freeze( )

Freeze the element so that only its value is returned
  • Access: public

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


Documentation generated on Thu, 20 Nov 2014 16:00:23 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.