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

Class: HTML_QuickForm2_Element_Script

Source Location: /HTML_QuickForm2-2.0.2/HTML/QuickForm2/Element/Script.php

Class Overview

HTML_Common2
   |
   --HTML_QuickForm2_Node
      |
      --HTML_QuickForm2_Element
         |
         --HTML_QuickForm2_Element_Static
            |
            --HTML_QuickForm2_Element_Script

Class for adding inline javascript to the form


Author(s):

Version:

  • Release: 2.0.2

Methods


Inherited Variables

Inherited Methods

Class: HTML_QuickForm2_Element_Static

HTML_QuickForm2_Element_Static::__construct()
Class constructor
HTML_QuickForm2_Element_Static::getContent()
Returns the contents of the static element
HTML_QuickForm2_Element_Static::getJavascriptTriggers()
HTML_QuickForm2_Element_Static::getJavascriptValue()
HTML_QuickForm2_Element_Static::getRawValue()
Static elements have no value
HTML_QuickForm2_Element_Static::getType()
HTML_QuickForm2_Element_Static::onAttributeChange()
Intercepts setting 'name' and 'id' attributes
HTML_QuickForm2_Element_Static::setContent()
Sets the contents of the static element
HTML_QuickForm2_Element_Static::setName()
Sets the element's name
HTML_QuickForm2_Element_Static::setTagName()
Sets the name of the HTML tag to wrap around static element's content
HTML_QuickForm2_Element_Static::setValue()
Static element's content can also be set via this method
HTML_QuickForm2_Element_Static::toggleFrozen()
Static element can not be frozen
HTML_QuickForm2_Element_Static::updateValue()
Called when the element needs to update its value from form's data sources
HTML_QuickForm2_Element_Static::__toString()

Class: HTML_QuickForm2_Element

HTML_QuickForm2_Element::applyFilters()
Applies recursive and non-recursive filters on element value
HTML_QuickForm2_Element::getJavascriptTriggers()
HTML_QuickForm2_Element::getJavascriptValue()
Returns Javascript code for getting the element's value
HTML_QuickForm2_Element::getPersistentContent()
Generates hidden form field containing the element's value
HTML_QuickForm2_Element::render()
Renders the element using the given renderer
HTML_QuickForm2_Element::setName()
HTML_QuickForm2_Element::updateValue()
Called when the element needs to update its value from form's data sources

Class: HTML_QuickForm2_Node

HTML_QuickForm2_Node::__construct()
Class constructor
HTML_QuickForm2_Node::addFilter()
Adds a filter
HTML_QuickForm2_Node::addRecursiveFilter()
Adds a recursive filter
HTML_QuickForm2_Node::addRule()
Adds a validation rule
HTML_QuickForm2_Node::applyFilter()
Helper function for applying filter callback to a value
HTML_QuickForm2_Node::applyFilters()
Applies non-recursive filters on element value
HTML_QuickForm2_Node::createRule()
Creates a validation rule
HTML_QuickForm2_Node::generateId()
Generates an id for the element
HTML_QuickForm2_Node::getContainer()
Returns the element containing current
HTML_QuickForm2_Node::getData()
Returns the element options
HTML_QuickForm2_Node::getDataSources()
Returns the data sources for this element
HTML_QuickForm2_Node::getError()
Returns the error message for the element
HTML_QuickForm2_Node::getId()
Returns the element's id
HTML_QuickForm2_Node::getJavascriptTriggers()
Returns IDs of form fields that should trigger "live" Javascript validation
HTML_QuickForm2_Node::getJavascriptValue()
Returns Javascript code for getting the element's value
HTML_QuickForm2_Node::getLabel()
Returns the element's label(s)
HTML_QuickForm2_Node::getName()
Returns the element's name
HTML_QuickForm2_Node::getRawValue()
Returns the element's value without filters applied
HTML_QuickForm2_Node::getType()
Returns the element's type
HTML_QuickForm2_Node::getValue()
Returns the element's value, possibly with filters applied
HTML_QuickForm2_Node::isRequired()
Checks whether an element is required
HTML_QuickForm2_Node::onAttributeChange()
Intercepts setting 'name' and 'id' attributes
HTML_QuickForm2_Node::persistentFreeze()
Changes the element's persistent freeze behaviour
HTML_QuickForm2_Node::removeRule()
Removes a validation rule
HTML_QuickForm2_Node::render()
Renders the element using the given renderer
HTML_QuickForm2_Node::renderClientRules()
Adds element's client-side validation rules to a builder object
HTML_QuickForm2_Node::setContainer()
Adds the link to the element containing current
HTML_QuickForm2_Node::setError()
Sets the error message to the element
HTML_QuickForm2_Node::setId()
Sets the element's id
HTML_QuickForm2_Node::setLabel()
Sets the element's label(s)
HTML_QuickForm2_Node::setName()
Sets the element's name
HTML_QuickForm2_Node::setValue()
Sets the element's value
HTML_QuickForm2_Node::storeId()
Stores the explicitly given id to prevent duplicate id generation
HTML_QuickForm2_Node::toggleFrozen()
Changes the element's frozen status
HTML_QuickForm2_Node::updateValue()
Called when the element needs to update its value from form's data sources
HTML_QuickForm2_Node::validate()
Performs the server-side validation

Class Details

[line 67]
Class for adding inline javascript to the form

Unlike scripts added to HTML_QuickForm2_JavascriptBuilder this is intended for "volatile" scripts that can not be put into the separate .js files and should always be rebuilt when the form is rendered. A good example is setting the default values and corresponding visible options for HTML_QuickForm2_Element_Hierselect



[ Top ]


Method Detail

getType   [line 69]

void getType( )

  • Access: public

Overrides HTML_QuickForm2_Element_Static::getType() (parent method not documented)
[ Top ]

render   [line 94]

HTML_QuickForm2_Renderer render( HTML_QuickForm2_Renderer $renderer)

Renders the element as the "hidden" one

Overrides HTML_QuickForm2_Element::render() (Renders the element using the given renderer)

Parameters:

HTML_QuickForm2_Renderer   $renderer     

[ Top ]

__toString   [line 79]

string __toString( )

Returns the element's content wrapped in <script></script> tags
  • Access: public

Overrides HTML_QuickForm2_Element_Static::__toString() (parent method not documented)
[ Top ]


Documentation generated on Sat, 28 Jun 2014 09:30:29 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.