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

Class: HTML_QuickForm_link

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

Class Overview

HTML_Common
   |
   --HTML_QuickForm_element
      |
      --HTML_QuickForm_static
         |
         --HTML_QuickForm_link

HTML class for a link type field


Author(s):

Version:

  • Release: 3.2.14

Methods


Inherited Variables

Inherited Methods

Class: HTML_QuickForm_static

HTML_QuickForm_static::HTML_QuickForm_static()
Class constructor
HTML_QuickForm_static::exportValue()
We override this here because we don't want any values from static elements
HTML_QuickForm_static::getFrozenHtml()
Returns the value of field without HTML tags
HTML_QuickForm_static::getName()
Returns the element name
HTML_QuickForm_static::onQuickFormEvent()
Called by HTML_QuickForm whenever form event is made on this element
HTML_QuickForm_static::setName()
Sets the element name
HTML_QuickForm_static::setText()
Sets the text
HTML_QuickForm_static::setValue()
Sets the text (uses the standard setValue call to emulate a form element.
HTML_QuickForm_static::toHtml()
Returns the static text element 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 link type field


[ Top ]


Method Detail

HTML_QuickForm_link (Constructor)   [line 68]

void HTML_QuickForm_link( [ $elementName = null], [string $elementLabel = null], [string $href = null], [string $text = null], [mixed $attributes = null])

Class constructor
  • Since: 1.0
  • Throws:
  • Access: public

Parameters:

string   $elementLabel     (optional)Link label
string   $href     (optional)Link href
string   $text     (optional)Link display text
mixed   $attributes     (optional)Either a typical HTML attribute string or an associative array
   $elementName     

[ Top ]

getFrozenHtml   [line 192]

string getFrozenHtml( )

Returns the value of field without HTML tags (in this case, value is changed to a mask)
  • Since: 1.0
  • Throws:
  • Access: public

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

getName   [line 105]

string getName( )

Returns the element name
  • Since: 1.0
  • Throws:
  • Access: public

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

getValue   [line 138]

void getValue( )

Returns the value of the form element
  • Since: 1.0
  • Throws:
  • Access: public

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

setHref   [line 156]

void setHref( string $href)

Sets the links href
  • Since: 1.0
  • Throws:
  • Access: public

Parameters:

string   $href     

[ Top ]

setName   [line 89]

void setName( string $name)

Sets the input field name
  • Since: 1.0
  • Throws:
  • Access: public

Overrides HTML_QuickForm_static::setName() (Sets the element name)

Parameters:

string   $name     Input field name attribute

[ Top ]

setValue   [line 122]

void setValue( string $value)

Sets value for textarea element
  • Since: 1.0
  • Throws:
  • Access: public

Overrides HTML_QuickForm_static::setValue() (Sets the text (uses the standard setValue call to emulate a form element.)

Parameters:

string   $value     Value for password element

[ Top ]

toHtml   [line 172]

string toHtml( )

Returns the textarea element in HTML
  • Since: 1.0
  • Throws:
  • Access: public

Overrides HTML_QuickForm_static::toHtml() (Returns the static text element in HTML)
[ Top ]


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