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

Class: HTML_QuickForm_header

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

Class Overview

HTML_Common
   |
   --HTML_QuickForm_element
      |
      --HTML_QuickForm_static
         |
         --HTML_QuickForm_header

A pseudo-element used for adding headers to form


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 38]
A pseudo-element used for adding headers to form
  • Author: Alexey Borzov <avb@php.net>
  • Version: Release: 3.2.14
  • Since: 3.0


[ Top ]


Method Detail

HTML_QuickForm_header (Constructor)   [line 50]

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

Class constructor
  • Access: public

Parameters:

string   $elementName   —  Header name
string   $text   —  Header text

[ Top ]

accept   [line 68]

void accept( HTML_QuickForm_Renderer &$renderer, [bool $sc1 = false], [bool $sc2 = null])

Accepts a renderer
  • Access: public

Overrides HTML_QuickForm_element::accept() (Accepts a renderer)

Parameters:

bool   $sc1   —  unused, for signature compatibility
bool   $sc2   —  unused, for signature compatibility
HTML_QuickForm_Renderer   &$renderer   —  renderer object

[ Top ]


Documentation generated on Mon, 11 Mar 2019 15:59:47 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.