Class: HTML_QuickForm2_Element_InputSubmit

Source Location: /HTML_QuickForm2-0.1.0/QuickForm2/Element/InputSubmit.php

Class Overview

HTML_Common2
   |
   --HTML_QuickForm2_Node
      |
      --HTML_QuickForm2_Element
         |
         --HTML_QuickForm2_Element_Input
            |
            --HTML_QuickForm2_Element_InputSubmit

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

Author(s):

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

Version:

Release: 0.1.0

Variables

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::$frozen
HTML_QuickForm2_Node::$ids
HTML_QuickForm2_Node::$label
HTML_QuickForm2_Node::$persistent

Inherited Methods

Class: HTML_QuickForm2_Element_Input

HTML_QuickForm2_Element_Input::getFrozenHtml(): Returns the field's value without HTML tags
HTML_QuickForm2_Element_Input::getType()
HTML_QuickForm2_Element_Input::getValue()
HTML_QuickForm2_Element_Input::onAttributeChange()
HTML_QuickForm2_Element_Input::setValue()
HTML_QuickForm2_Element_Input::__toString()

Class: HTML_QuickForm2_Element

HTML_QuickForm2_Element::getId()
HTML_QuickForm2_Element::getName()
HTML_QuickForm2_Element::getPersistentContent(): Generates hidden form field containing the element's value
HTML_QuickForm2_Element::onAttributeChange()
HTML_QuickForm2_Element::setId()
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::generateId(): Generates an id for the element
HTML_QuickForm2_Node::getContainer(): Returns the element containing current
HTML_QuickForm2_Node::getDataSources(): Returns the data sources for this element
HTML_QuickForm2_Node::getId(): Returns the element's id
HTML_QuickForm2_Node::getLabel(): Returns the element's label(s)
HTML_QuickForm2_Node::getName(): Returns the element's name
HTML_QuickForm2_Node::getType(): Returns the element's type
HTML_QuickForm2_Node::getValue(): Returns the element's value
HTML_QuickForm2_Node::persistentFreeze(): Changes the element's persistent freeze behaviour
HTML_QuickForm2_Node::setContainer(): Adds the link to the element containing current
HTML_QuickForm2_Node::setId(): Sets the elements 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

Class Details

[line 60]
Class for <input type="submit" /> elements

Author: Bertrand Mansion <golgote@mamasam.com>
Author: Alexey Borzov <avb@php.net>
Version: Release: 0.1.0

[ Top ]

Class Variables

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

[line 62]

Access: protected

Type:

mixed

[ Top ]

$submitValue = null

[line 68]

Element's submit value

Access: protected

Type:

string

[ Top ]

Method Detail

getValue [line 101]

string|null getValue(
)

Returns the element's value

The value is only returned if the form was actually submitted and this submit button was clicked. Returns null in all other cases

Access: public

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

[ Top ]

setValue [line 88]

void setValue(
mixed
$value)

Submit's value cannot be set via this method

Access: public

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

Parameters:

mixed $value — Element's value, this parameter is ignored

[ Top ]

toggleFrozen [line 78]

bool toggleFrozen(
[bool
$freeze = null])

Submit buttons 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 submit elements

[ Top ]

updateValue [line 106]

void updateValue(
)

Access: protected

Overrides HTML_QuickForm2_Element::updateValue() (Called when the element needs to update its value from form's data sources)

[ Top ]