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

Class: HTML_QuickForm_static

Source Location: /HTML_QuickForm-3.2.13/QuickForm/static.php

Class Overview

HTML_Common
   |
   --HTML_QuickForm_element
      |
      --HTML_QuickForm_static

HTML class for static data


Author(s):

Version:

  • Release: 3.2.13

Methods


Child classes:

HTML_QuickForm_header
A pseudo-element used for adding headers to form
HTML_QuickForm_html
A pseudo-element used for adding raw HTML to form
HTML_QuickForm_link
HTML class for a link type field

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]
HTML class for static data


[ Top ]


Method Detail

HTML_QuickForm_static (Constructor)   [line 60]

void HTML_QuickForm_static( [ $elementName = null], [string $elementLabel = null], [string $text = null])

Class constructor
  • Access: public

Parameters:

string   $elementLabel     (optional)Label
string   $text     (optional)Display text
   $elementName     

[ Top ]

exportValue   [line 194]

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

We override this here because we don't want any values from static elements

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

Parameters:

   &$submitValues     
   $assoc     

[ Top ]

getFrozenHtml   [line 150]

string getFrozenHtml( )

Returns the value of field without HTML tags
  • Access: public

Overridden in child classes as:

HTML_QuickForm_link::getFrozenHtml()
Returns the value of field without HTML tags (in this case, value is changed to a mask)

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

getName   [line 92]

string getName( )

Returns the element name
  • Access: public

Overridden in child classes as:

HTML_QuickForm_link::getName()
Returns the element name

Overrides HTML_QuickForm_element::getName() (Returns the element name)
[ Top ]

onQuickFormEvent   [line 169]

void onQuickFormEvent( string $event, mixed $arg, object &$caller)

Called by HTML_QuickForm whenever form event is made on this element
  • Since: 1.0
  • Throws:
  • Access: public

Overrides HTML_QuickForm_element::onQuickFormEvent() (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

[ Top ]

setName   [line 78]

void setName( string $name)

Sets the element name
  • Access: public

Overridden in child classes as:

HTML_QuickForm_link::setName()
Sets the input field name

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

Parameters:

string   $name     Element name

[ Top ]

setText   [line 107]

void setText( string $text)

Sets the text
  • Access: public

Parameters:

string   $text     

[ Top ]

setValue   [line 122]

void setValue( string $text)

Sets the text (uses the standard setValue call to emulate a form element.
  • Access: public

Overridden in child classes as:

HTML_QuickForm_link::setValue()
Sets value for textarea element

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

Parameters:

string   $text     

[ Top ]

toHtml   [line 136]

string toHtml( )

Returns the static text element in HTML
  • Access: public

Overridden in child classes as:

HTML_QuickForm_link::toHtml()
Returns the textarea element in HTML

[ Top ]


Documentation generated on Sat, 01 Oct 2011 09:00:20 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.