Class: HTML_QuickForm2_Controller_DefaultAction

Source Location: /HTML_QuickForm2-2.1.0/HTML/QuickForm2/Controller/DefaultAction.php

Class Overview

HTML_Common2
   |
   --HTML_QuickForm2_Node
      |
      --HTML_QuickForm2_Element
         |
         --HTML_QuickForm2_Element_Input
            |
            --HTML_QuickForm2_Element_InputImage
               |
               --HTML_QuickForm2_Controller_DefaultAction

A hidden button used to submit the form when the user presses Enter

Author(s):

Alexey Borzov <avb at php.net>
Bertrand Mansion <golgote at mamasam.com>

Version:

Release: 2.1.0

Inherited Variables

Inherited Methods

Class: HTML_QuickForm2_Element_InputImage

HTML_QuickForm2_Element_InputImage::getRawValue(): Returns the element's value
HTML_QuickForm2_Element_InputImage::setValue(): Image button's value cannot be set via this method
HTML_QuickForm2_Element_InputImage::toggleFrozen(): Image buttons can not be frozen
HTML_QuickForm2_Element_InputImage::updateValue()
HTML_QuickForm2_Element_InputImage::__toString(): Returns the HTML representation of the element

Class: HTML_QuickForm2_Element_Input

HTML_QuickForm2_Element_Input::getFrozenHtml(): Returns the field's value without HTML tags
HTML_QuickForm2_Element_Input::getRawValue()
HTML_QuickForm2_Element_Input::getType()
HTML_QuickForm2_Element_Input::onAttributeChange()
HTML_QuickForm2_Element_Input::setValue()
HTML_QuickForm2_Element_Input::__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 44]
A hidden button used to submit the form when the user presses Enter

This element is used by HTML_QuickForm2_Controller_Page::setDefaultAction() to define the action that will take place if the user presses Enter on one of the form elements instead of explicitly clicking one of the submit buttons. Injecting a hidden <input type="image" /> element is about the only cross-browser way to achieve this.

Author: Alexey Borzov <avb@php.net>
Author: Bertrand Mansion <golgote@mamasam.com>
Version: Release: 2.1.0
Link: http://muffinresearch.co.uk/archives/2005/12/08/fun-with-multiple-submit-buttons/
Link: http://www.alanflavell.org.uk/www/formquestion.html
Link: https://pear.php.net/package/HTML_QuickForm2
License: BSD 3-Clause License

[ Top ]

Class Variables

$attributes = array('type' => 'image', 'id' => 'qf:default-action')

[line 47]

Access: protected

Type:	mixed
Overrides:	Array

[ Top ]

Method Detail

onAttributeChange [line 55]

void onAttributeChange(
string
$name, [string
$value = null])

Disallow changing the 'id' attribute

Access: protected

Overrides HTML_QuickForm2_Element_Input::onAttributeChange() (parent method not documented)

Parameters:

string	`$name`	—	Attribute name
string	`$value`	—	Attribute value, null if attribute is being removed

[ Top ]

render [line 78]

HTML_QuickForm2_Renderer render(
HTML_QuickForm2_Renderer
$renderer)

This element is rendered using renderHidden() method

renderHidden() is used to

prevent using the standard element template as this button is expected to be hidden
render it above all other submit buttons since hidden elements are usually at the top of the form

Access: public

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

Parameters:

HTML_QuickForm2_Renderer $renderer —

[ Top ]