Class: HTML_QuickForm_link

Source Location: /main/inc/lib/pear/HTML/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):

Adam Daniel <adaniel1@eesus.jnj.com>
Bertrand Mansion <bmansion@mamasam.com>

Version:

Variables

$_text

Methods

Inherited Variables

Class: HTML_QuickForm_element

HTML_QuickForm_element::$_flagFrozen
HTML_QuickForm_element::$_label
HTML_QuickForm_element::$_persistantFreeze
HTML_QuickForm_element::$_type

Class: HTML_Common

HTML_Common::$_attributes
HTML_Common::$_comment
HTML_Common::$_lineEnd
HTML_Common::$_tab
HTML_Common::$_tabOffset

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
HTML_QuickForm_element::_findValue(): Tries to find the element value from the values array
HTML_QuickForm_element::_generateId(): Automatically generates and assigns an 'id' attribute for the element.
HTML_QuickForm_element::_getPersistantData(): Used by getFrozenHtml() to pass the element's value if _persistantFreeze is on
HTML_QuickForm_element::_prepareValue(): Used by exportValue() to prepare the value for returning

Class: HTML_Common

HTML_Common::HTML_Common(): Class constructor
HTML_Common::apiVersion(): Returns the current API version
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::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
HTML_Common::_getAttrKey(): Returns the array key for the given non-name-value pair attribute
HTML_Common::_getAttrString(): Returns an HTML formatted attribute string
HTML_Common::_getLineEnd(): Returns the lineEnd
HTML_Common::_getTab(): Returns a string containing the unit for indenting HTML
HTML_Common::_getTabs(): Returns a string containing the offset for the whole HTML code
HTML_Common::_parseAttributes(): Returns a valid atrributes array from either a string or array
HTML_Common::_removeAttr(): Removes the given attribute from the given array
HTML_Common::_updateAttrArray(): Updates the attributes in $attr1 with the values in $attr2 without changing the other existing attributes

Class Details

[line 32]
HTML class for a link type field

Tags:

author:	Adam Daniel <adaniel1@eesus.jnj.com>
author:	Bertrand Mansion <bmansion@mamasam.com>
version:	1.0
since:	PHP4.04pl1
access:	public

[ Top ]

Class Variables

$_text = ""

[line 42]

Link display text

Tags:

since:	1.0
access:	private

Type:	string
Overrides:	Array

[ Top ]

Class Methods

constructor HTML_QuickForm_link [line 60]

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

Class constructor

Tags:

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 ]

method getFrozenHtml [line 184]

string getFrozenHtml(
)

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

Tags:

since:	1.0
throws:
access:	public

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

[ Top ]

method getName [line 97]

string getName(
)

Returns the element name

Tags:

since:	1.0
throws:
access:	public

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

[ Top ]

method getValue [line 130]

void getValue(
)

Returns the value of the form element

Tags:

since:	1.0
throws:
access:	public

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

[ Top ]

method setHref [line 148]

void setHref(
string
$href)

Sets the links href

Tags:

since:	1.0
throws:
access:	public

Parameters:

string

$href

[ Top ]

method setName [line 81]

void setName(
string
$name)

Sets the input field name

Tags:

since:	1.0
throws:
access:	public

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

Parameters:

string

$name

Input field name attribute

[ Top ]

method setValue [line 114]

void setValue(
string
$value)

Sets value for textarea element

Tags:

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 ]

method toHtml [line 164]

string toHtml(
)

Returns the textarea element in HTML

Tags:

since:	1.0
throws:
access:	public

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

[ Top ]

Documentation generated on Thu, 12 Jun 2008 13:59:31 -0500 by phpDocumentor 1.4.1