HTML_QuickForm2

[ ] [ ] [ ]

Packages:
HTML_QuickForm2
apidoc

Classes:

HTML_QuickForm2
HTML_QuickForm2_Container
HTML_QuickForm2_ContainerIterator
HTML_QuickForm2_Container_Fieldset
HTML_QuickForm2_Container_Group
HTML_QuickForm2_Container_Repeat
HTML_QuickForm2_Container_Repeat_JavascriptBuilder
HTML_QuickForm2_Controller
HTML_QuickForm2_Controller_Action_Back
HTML_QuickForm2_Controller_Action_Direct
HTML_QuickForm2_Controller_Action_Display
HTML_QuickForm2_Controller_Action_Jump
HTML_QuickForm2_Controller_Action_Next
HTML_QuickForm2_Controller_Action_Submit
HTML_QuickForm2_Controller_DefaultAction
HTML_QuickForm2_Controller_Page
HTML_QuickForm2_Controller_SessionContainer
HTML_QuickForm2_DataSource_Array
HTML_QuickForm2_DataSource_Session
HTML_QuickForm2_DataSource_SuperGlobal
HTML_QuickForm2_Element
HTML_QuickForm2_Element_Button
HTML_QuickForm2_Element_Date
HTML_QuickForm2_Element_Hierselect
HTML_QuickForm2_Element_Input
HTML_QuickForm2_Element_InputButton
HTML_QuickForm2_Element_InputCheckable
HTML_QuickForm2_Element_InputCheckbox
HTML_QuickForm2_Element_InputFile
HTML_QuickForm2_Element_InputHidden
HTML_QuickForm2_Element_InputImage
HTML_QuickForm2_Element_InputPassword
HTML_QuickForm2_Element_InputRadio
HTML_QuickForm2_Element_InputReset
HTML_QuickForm2_Element_InputSubmit
HTML_QuickForm2_Element_InputText
HTML_QuickForm2_Element_Script
HTML_QuickForm2_Element_Select
HTML_QuickForm2_Element_Select_Optgroup
HTML_QuickForm2_Element_Select_OptionContainer
HTML_QuickForm2_Element_Select_OptionIterator
HTML_QuickForm2_Element_Static
HTML_QuickForm2_Element_Textarea
HTML_QuickForm2_Exception
HTML_QuickForm2_Factory
HTML_QuickForm2_InvalidArgumentException
HTML_QuickForm2_JavascriptBuilder
HTML_QuickForm2_Loader
HTML_QuickForm2_MessageProvider_Default
HTML_QuickForm2_MessageProvider_Strftime
HTML_QuickForm2_Node
HTML_QuickForm2_NotFoundException
HTML_QuickForm2_Renderer
HTML_QuickForm2_Renderer_Array
HTML_QuickForm2_Renderer_Callback
HTML_QuickForm2_Renderer_Default
HTML_QuickForm2_Renderer_Plugin
HTML_QuickForm2_Renderer_Proxy
HTML_QuickForm2_Renderer_Stub
HTML_QuickForm2_Rule
HTML_QuickForm2_Rule_Callback
HTML_QuickForm2_Rule_Compare
HTML_QuickForm2_Rule_Each
HTML_QuickForm2_Rule_Email
HTML_QuickForm2_Rule_Empty
HTML_QuickForm2_Rule_Length
HTML_QuickForm2_Rule_MaxFileSize
HTML_QuickForm2_Rule_MimeType
HTML_QuickForm2_Rule_Nonempty
HTML_QuickForm2_Rule_NotCallback
HTML_QuickForm2_Rule_NotRegex
HTML_QuickForm2_Rule_Regex
HTML_QuickForm2_Rule_Required

HTML_QuickForm2
   HTML_QuickForm2_Element_DualSelect
   HTML_QuickForm2_Renderer_Default_DualSelectPlugin
   PageBar
   PageBaz
   PageFirst
   PageFoo
   PageSecond
   PageThird
   SimpleDisplay
   SimplePage
   TabbedDisplay
   TabbedPage
   WizardDisplay

Files:

Action.php
array-twig.php
Array.php
Array.php
Back.php
basic-elements.php
builtin-rules.php
Button.php
Callback.php
Callback.php
Compare.php
Container.php
ContainerIterator.php
Controller.php
DataSource.php
Date.php
default-renderer.php
Default.php
Default.php
DefaultAction.php
Direct.php
Display.php
dualselect.php
Each.php
Element.php
Email.php
Empty.php
Exception.php
Factory.php
Fieldset.php
Group.php
hierselect-ajax.php
hierselect-server.php
Hierselect.php
Input.php
InputButton.php
InputCheckable.php
InputCheckbox.php
InputFile.php
InputHidden.php
InputImage.php
InputPassword.php
InputRadio.php
InputReset.php
InputSubmit.php
InputText.php
InvalidArgumentException.php
JavascriptBuilder.php
JavascriptBuilder.php
Jump.php
Length.php
Loader.php
MaxFileSize.php
MessageProvider.php
MimeType.php
Next.php
Node.php
Nonempty.php
NotCallback.php
NotFoundException.php
NotRegex.php
NullAware.php
Optgroup.php
OptionContainer.php
OptionIterator.php
Page.php
Plugin.php
Proxy.php
QuickForm2.php
Regex.php
Renderer.php
repeat.php
Repeat.php
Required.php
Rule.php
Script.php
Select.php
Session.php
SessionContainer.php
simple.php
Static.php
Strftime.php
Stub.php
Submit.php
Submit.php
SuperGlobal.php
tabbed.php
Textarea.php
wizard.php

Class: HTML_QuickForm2_Element_InputHidden

Source Location: /HTML_QuickForm2-2.1.0/HTML/QuickForm2/Element/InputHidden.php

Class Overview

HTML_Common2
   |
   --HTML_QuickForm2_Node
      |
      --HTML_QuickForm2_Element
         |
         --HTML_QuickForm2_Element_Input
            |
            --HTML_QuickForm2_Element_InputHidden

Class for <input type="hidden" /> elements

Author(s):

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

Version:

Release: 2.1.0

Variables

$attributes

Methods

Inherited Variables

Class: HTML_QuickForm2_Element_Input

HTML_QuickForm2_Element_Input::$watchedAttributes

Class: HTML_QuickForm2_Node

HTML_QuickForm2_Node::$container
HTML_QuickForm2_Node::$data
HTML_QuickForm2_Node::$error
HTML_QuickForm2_Node::$filters
HTML_QuickForm2_Node::$frozen
HTML_QuickForm2_Node::$ids
HTML_QuickForm2_Node::$persistent
HTML_QuickForm2_Node::$recursiveFilters
HTML_QuickForm2_Node::$rules

Inherited Methods

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 38]
Class for <input type="hidden" /> elements

Author: Bertrand Mansion <golgote@mamasam.com>
Author: Alexey Borzov <avb@php.net>
Version: Release: 2.1.0
Link: https://pear.php.net/package/HTML_QuickForm2
License: BSD 3-Clause License

[ Top ]

Class Variables

$attributes = array('type' => 'hidden')

[line 40]

Access: protected

Type:

mixed

[ Top ]

Method Detail

render [line 73]

void render(
HTML_QuickForm2_Renderer
$renderer)

Access: public

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

Parameters:

HTML_QuickForm2_Renderer $renderer —

[ Top ]

setError [line 63]

HTML_QuickForm2_Element_InputHidden setError(
[string|null
$error = null])

Disallows setting an error message on hidden elements

Throws: HTML_QuickForm2_InvalidArgumentException if $error is not empty
Access: public

Overrides HTML_QuickForm2_Node::setError() (Sets the error message to the element)

Parameters:

string|null $error —

[ Top ]

toggleFrozen [line 50]

bool toggleFrozen(
[bool
$freeze = null])

Hidden elements can not be frozen

Return: Always returns false
Access: public

Overrides HTML_QuickForm2_Node::toggleFrozen() (Changes the element's frozen status)

Parameters:

bool $freeze — Whether element should be frozen or editable. This parameter is ignored in case of hidden elements

[ Top ]

Documentation generated on Wed, 10 Apr 2019 08:56:09 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.