Structures_Form
[ class tree: Structures_Form ] [ index: Structures_Form ] [ all elements ]
Packages:
Structures_Form


Classes:
Structures_Form
Files:
Alpha.php
AlphaNumeric.php
Base.php
ElementInterface.php
ElementSetInterface.php
Exception.php
Form.php
GroupInterface.php
LengthRange.php
Numeric.php
NumericRange.php
Regex.php
RendererInterface.php
Required.php
RuleInterface.php

Element index for package Structures_Form

[ a ] [ b ] [ c ] [ d ] [ e ] [ f ] [ g ] [ i ] [ l ] [ m ] [ n ] [ r ] [ s ] [ u ] [ v ] [ _ ]

_

__construct
in file Form.php, method Structures_Form::__construct()
    Constructor. Sets the callbacks then registers any default element or rule types.
top

a

addElement
in file GroupInterface.php, method Structures_Form_GroupInterface::addElement()
    Adds an element to the group.
addElement
in file Form.php, method Structures_Form::addElement()
    Creates and adds an element to the form.
addElementObject
in file Form.php, method Structures_Form::addElementObject()
    Adds an element to the form.
addElementObjectToGroup
in file Form.php, method Structures_Form::addElementObjectToGroup()
    Adds an element object to a group.
addElementToGroup
in file Form.php, method Structures_Form::addElementToGroup()
    Adds an element to a group.
addEventHandler
in file ElementInterface.php, method Structures_Form_ElementInterface::addEventHandler()
    Adds an event handler for the element.
addRule
in file Form.php, method Structures_Form::addRule()
    Associates a rule with a form element.
addRuleToObject
in file Form.php, method Structures_Form::addRuleToObject()
    Associates a rule with a form element object.
Alpha.php
procedural page Alpha.php
AlphaNumeric.php
procedural page AlphaNumeric.php
top

b

Base.php
procedural page Base.php
top

c

clearValue
in file ElementInterface.php, method Structures_Form_ElementInterface::clearValue()
    Clears the current value of the element.
clearValues
in file Form.php, method Structures_Form::clearValues()
    Clears the values of all form elements (if possible).
createElement
in file Form.php, method Structures_Form::createElement()
    Creates an element but does not add it to the form.
createRule
in file Form.php, method Structures_Form::createRule()
    Creates a rule object.
top

d

$defaultRenderer
in file Form.php, variable Structures_Form::$defaultRenderer
    The default renderer class defined by the element set.
$defaultRendererPath
in file Form.php, variable Structures_Form::$defaultRendererPath
    The path to the default renderer defined by the element set.
$defaults
in file Form.php, variable Structures_Form::$defaults
    The default values for the form elements.
defaultErrorCallback
in file Form.php, method Structures_Form::defaultErrorCallback()
    Simply passes the error array on to the renderer.
DEFAULT_ERRORCALLBACK
in file Form.php, class constant Structures_Form::DEFAULT_ERRORCALLBACK
    Defaults
disbandGroup
in file Form.php, method Structures_Form::disbandGroup()
    Disbands a group.
top

e

$elements
in file Form.php, variable Structures_Form::$elements
    The form elements.
$errorCallback
in file Form.php, variable Structures_Form::$errorCallback
    The callback for error handling.
$errorMsgs
in file Form.php, variable Structures_Form::$errorMsgs
    An array relating error codes to error messages.
elementExists
in file Form.php, method Structures_Form::elementExists()
    Returns whether or not the given element is associated with this form.
elementExists
in file GroupInterface.php, method Structures_Form_GroupInterface::elementExists()
    Returns whether or not an element with the given name exists in the group.
elementObjectExists
in file Form.php, method Structures_Form::elementObjectExists()
    Returns whether or not the element object is associated with this form.
ELEMENTSET_PATH
in file Form.php, class constant Structures_Form::ELEMENTSET_PATH
    ElementSet constants.
ELEMENTSET_PREFIX
in file Form.php, class constant Structures_Form::ELEMENTSET_PREFIX
ERROR_ADD_ELEMENT_DOUBLEADD
in file Form.php, class constant Structures_Form::ERROR_ADD_ELEMENT_DOUBLEADD
    Error constants.
ERROR_ADD_RULE_DOUBLEADD
in file Form.php, class constant Structures_Form::ERROR_ADD_RULE_DOUBLEADD
ERROR_LACKSINTERFACE_ELEMENT
in file Form.php, class constant Structures_Form::ERROR_LACKSINTERFACE_ELEMENT
ERROR_LACKSINTERFACE_ELEMENTSET
in file Form.php, class constant Structures_Form::ERROR_LACKSINTERFACE_ELEMENTSET
ERROR_LACKSINTERFACE_GROUP
in file Form.php, class constant Structures_Form::ERROR_LACKSINTERFACE_GROUP
ERROR_LACKSINTERFACE_RENDERER
in file Form.php, class constant Structures_Form::ERROR_LACKSINTERFACE_RENDERER
ERROR_LACKSINTERFACE_RULE
in file Form.php, class constant Structures_Form::ERROR_LACKSINTERFACE_RULE
ERROR_NONEXISTENT_CALLBACK
in file Form.php, class constant Structures_Form::ERROR_NONEXISTENT_CALLBACK
ERROR_NONEXISTENT_CLASS
in file Form.php, class constant Structures_Form::ERROR_NONEXISTENT_CLASS
ERROR_NONEXISTENT_ELEMENT
in file Form.php, class constant Structures_Form::ERROR_NONEXISTENT_ELEMENT
ERROR_NONEXISTENT_FILE
in file Form.php, class constant Structures_Form::ERROR_NONEXISTENT_FILE
ERROR_REGISTRATION_ELEMENT
in file Form.php, class constant Structures_Form::ERROR_REGISTRATION_ELEMENT
ERROR_REGISTRATION_ELEMENT_DOUBLEREG
in file Form.php, class constant Structures_Form::ERROR_REGISTRATION_ELEMENT_DOUBLEREG
ERROR_REGISTRATION_RULE
in file Form.php, class constant Structures_Form::ERROR_REGISTRATION_RULE
ERROR_REGISTRATION_RULE_DOUBLEREG
in file Form.php, class constant Structures_Form::ERROR_REGISTRATION_RULE_DOUBLEREG
ERROR_RENDER_FAILURE
in file Form.php, class constant Structures_Form::ERROR_RENDER_FAILURE
ERROR_UNREGISTERED_ELEMENT
in file Form.php, class constant Structures_Form::ERROR_UNREGISTERED_ELEMENT
ERROR_UNREGISTERED_RULE
in file Form.php, class constant Structures_Form::ERROR_UNREGISTERED_RULE
ERROR_UNREGISTRATION_ELEMENT
in file Form.php, class constant Structures_Form::ERROR_UNREGISTRATION_ELEMENT
ERROR_UNREGISTRATION_ELEMENTINUSE
in file Form.php, class constant Structures_Form::ERROR_UNREGISTRATION_ELEMENTINUSE
ERROR_UNREGISTRATION_RULE
in file Form.php, class constant Structures_Form::ERROR_UNREGISTRATION_RULE
ERROR_UNREGISTRATION_RULEINUSE
in file Form.php, class constant Structures_Form::ERROR_UNREGISTRATION_RULEINUSE
ElementInterface.php
procedural page ElementInterface.php
ElementSetInterface.php
procedural page ElementSetInterface.php
Exception.php
procedural page Exception.php
top

f

freeze
in file ElementInterface.php, method Structures_Form_ElementInterface::freeze()
    Freezes the element so that its value may not be changed.
Form.php
procedural page Form.php
top

g

getAllElements
in file GroupInterface.php, method Structures_Form_GroupInterface::getAllElements()
    Returns an array containing all elements in the group.
getAllElements
in file Form.php, method Structures_Form::getAllElements()
    Returns an array of all elements.
getDefaultRenderer
in file Form.php, method Structures_Form::getDefaultRenderer()
    Creates a default renderer object.
getDefaultRenderer
in file ElementSetInterface.php, method Structures_Form_ElementSetInterface::getDefaultRenderer()
    Returns an array of data defining the default renderer.
getDefaults
in file Form.php, method Structures_Form::getDefaults()
    Returns the array of default values.
getElement
in file GroupInterface.php, method Structures_Form_GroupInterface::getElement()
    Returns an element from a group.
getElement
in file Form.php, method Structures_Form::getElement()
    Returns the form element with the given name.
getElementsByType
in file Form.php, method Structures_Form::getElementsByType()
    Returns all of the elements in the form of the given type.
getElementSet
in file ElementSetInterface.php, method Structures_Form_ElementSetInterface::getElementSet()
    Returns an array of element names, classes and files.
getErrorCallback
in file Form.php, method Structures_Form::getErrorCallback()
    Returns the error callback.
getErrorMessage
in file Form.php, method Structures_Form::getErrorMessage()
    Returns an error message for the given error code.
getGroup
in file Form.php, method Structures_Form::getGroup()
    Returns the group element.
getGroupElements
in file Form.php, method Structures_Form::getGroupElements()
    Returns an array containing the names of the elements in the given group.
getGroups
in file Form.php, method Structures_Form::getGroups()
    Returns an array containing all groups.
getLabel
in file ElementInterface.php, method Structures_Form_ElementInterface::getLabel()
    Returns the GtkLabel that identifies the element.
getName
in file ElementInterface.php, method Structures_Form_ElementInterface::getName()
    Returns the element's name.
getPosition
in file Form.php, method Structures_Form::getPosition()
    Returns the current position of the element.
getRenderedForm
in file Form.php, method Structures_Form::getRenderedForm()
    Returns the most recently rendered widget.
getRequiredNote
in file Form.php, method Structures_Form::getRequiredNote()
    Returns the current required note.
getRequiredSymbol
in file Form.php, method Structures_Form::getRequiredSymbol()
    Returns the current required symbol.
getSubmitCallback
in file Form.php, method Structures_Form::getSubmitCallback()
    Returns the submit callback.
getType
in file ElementInterface.php, method Structures_Form_ElementInterface::getType()
    Returns the element type.
getValue
in file Form.php, method Structures_Form::getValue()
    Returns the current value for the given element.
getValue
in file ElementInterface.php, method Structures_Form_ElementInterface::getValue()
    Returns element's value.
getValues
in file Form.php, method Structures_Form::getValues()
    Returns the current value for all elements in an associative array.
groupExists
in file Form.php, method Structures_Form::groupExists()
    Returns whether or not the given group exists in this form.
GroupInterface.php
procedural page GroupInterface.php
top

i

insertElement
in file Form.php, method Structures_Form::insertElement()
    Inserts an element object at the given location.
isElementRegistered
in file Form.php, method Structures_Form::isElementRegistered()
    Returns whether or not an element type is registered.
isFrozen
in file ElementInterface.php, method Structures_Form_ElementInterface::isFrozen()
    Returns whether or not the element is currently frozen.
isGroup
in file Form.php, method Structures_Form::isGroup()
    Returns whether or not the element is a group.
isIncludable
in file Form.php, method Structures_Form::isIncludable()
    Returns whether or not a path is in the include path.
isRequired
in file Form.php, method Structures_Form::isRequired()
    Returns whether or not an element is required.
isRuleApplied
in file Form.php, method Structures_Form::isRuleApplied()
    Returns whether or not the give rule is currently associated with any form elements.
isRuleAppliedToElement
in file Form.php, method Structures_Form::isRuleAppliedToElement()
    Returns whether or not the given rule is applied to the given element.
isRuleRegistered
in file Form.php, method Structures_Form::isRuleRegistered()
    Returns whether or not a rule is registered.
top

l

LengthRange.php
procedural page LengthRange.php
top

m

moveElement
in file Form.php, method Structures_Form::moveElement()
    Moves an element object from its current position to the given position.
top

n

Numeric.php
procedural page Numeric.php
NumericRange.php
procedural page NumericRange.php
top

r

$registeredElements
in file Form.php, variable Structures_Form::$registeredElements
    The registered element types.
$registeredRules
in file Form.php, variable Structures_Form::$registeredRules
    The registered rules.
$renderedForm
in file Form.php, variable Structures_Form::$renderedForm
    The rendered form.
$renderer
in file Form.php, variable Structures_Form::$renderer
    The object responsible for displaying the form.
$requiredNote
in file Form.php, variable Structures_Form::$requiredNote
    A note identifying the required field marker.
$requiredSymbol
in file Form.php, variable Structures_Form::$requiredSymbol
    A symbol identifying the required fields.
$rules
in file Form.php, variable Structures_Form::$rules
    The rules to be applied to each element.
registerDefaultRules
in file Form.php, method Structures_Form::registerDefaultRules()
    Registers the default rule types.
registerElement
in file Form.php, method Structures_Form::registerElement()
    Registers an element type with this form.
registerElementSet
in file Form.php, method Structures_Form::registerElementSet()
    Registers a set of elements.
registerRule
in file Form.php, method Structures_Form::registerRule()
    Registers a rule class with the form.
removeElement
in file GroupInterface.php, method Structures_Form_GroupInterface::removeElement()
    Removes an element from the group.
removeElement
in file Form.php, method Structures_Form::removeElement()
    Removes an element from the form by name.
removeElementFromGroup
in file Form.php, method Structures_Form::removeElementFromGroup()
    Removes an element from a group.
removeElementObject
in file Form.php, method Structures_Form::removeElementObject()
    Removes an element object from the form.
removeElementObjectFromGroup
in file Form.php, method Structures_Form::removeElementObjectFromGroup()
    Removes an element object from a group.
removeRule
in file Form.php, method Structures_Form::removeRule()
    Removes a rule from an element.
removeRuleFromObject
in file Form.php, method Structures_Form::removeRuleFromObject()
    Removes a rule from a form element object.
render
in file RendererInterface.php, method Structures_Form_RendererInterface::render()
    Returns the rendered form.
render
in file Form.php, method Structures_Form::render()
    Returns a container widget holding the form elements.
REQUIRED_RULE
in file Form.php, class constant Structures_Form::REQUIRED_RULE
    The name of the rule defining required elements.
restoreDefaults
in file Form.php, method Structures_Form::restoreDefaults()
    Restores the elements to their default values.
ruleExists
in file Form.php, method Structures_Form::ruleExists()
    Returns whether or not a rule with the given name already exists.
RendererInterface.php
procedural page RendererInterface.php
Regex.php
procedural page Regex.php
Required.php
procedural page Required.php
RuleInterface.php
procedural page RuleInterface.php
top

s

$submitCallback
in file Form.php, variable Structures_Form::$submitCallback
    The method to call after values are collected from a submitted form.
$submitObjects
in file Form.php, variable Structures_Form::$submitObjects
    Send the widgets to the callback instead of the values.
setDefaultRenderer
in file Form.php, method Structures_Form::setDefaultRenderer()
    Creates a default renderer and sets it as the current renderer.
setDefaults
in file Form.php, method Structures_Form::setDefaults()
    Sets the values of the elements and make the given values the defautls.
setElements
in file RendererInterface.php, method Structures_Form_RendererInterface::setElements()
    Sets the elements that make up the form.
setErrorCallback
in file Form.php, method Structures_Form::setErrorCallback()
    Sets the error callback.
setErrors
in file RendererInterface.php, method Structures_Form_RendererInterface::setErrors()
    Sets the errors to be displayed.
setForm
in file RendererInterface.php, method Structures_Form_RendererInterface::setForm()
    Sets the form.
setLabel
in file ElementInterface.php, method Structures_Form_ElementInterface::setLabel()
    Sets the label that identifies the element.
setName
in file ElementInterface.php, method Structures_Form_ElementInterface::setName()
    Sets the element name.
setRenderer
in file Form.php, method Structures_Form::setRenderer()
    Sets a renderer object.
setRequiredNote
in file RendererInterface.php, method Structures_Form_RendererInterface::setRequiredNote()
    Sets the string to be used as the note indicating what the required symbol means.
setRequiredNote
in file Form.php, method Structures_Form::setRequiredNote()
    Sets the require note.
setRequiredSymbol
in file Form.php, method Structures_Form::setRequiredSymbol()
    Sets the require symbol.
setRequiredSymbol
in file RendererInterface.php, method Structures_Form_RendererInterface::setRequiredSymbol()
    Sets the string to be used as the note indicating what the required symbol means.
setValue
in file ElementInterface.php, method Structures_Form_ElementInterface::setValue()
    Sets an element's value.
setValue
in file Form.php, method Structures_Form::setValue()
    Sets the value for the given element.
setValues
in file Form.php, method Structures_Form::setValues()
    Sets the values for the form elements.
Structures_Form
in file Form.php, class Structures_Form
    A package designed to make creating input forms easy for PHP-GTK 2 packages and applications.
Structures_Form_ElementInterface
in file ElementInterface.php, class Structures_Form_ElementInterface
    An interface to enforce consistency among all elements used in a Structures_Form.
Structures_Form_ElementSetInterface
in file ElementSetInterface.php, class Structures_Form_ElementSetInterface
    An interface to make loading element sets consistent.
Structures_Form_GroupInterface
in file GroupInterface.php, class Structures_Form_GroupInterface
    An interface to enforce consistency among all group elements used in a Structures_Form.
Structures_Form_RendererInterface
in file RendererInterface.php, class Structures_Form_RendererInterface
    An interface to enforce consistency among all group elements used in a Structures_Form.
Structures_Form_RuleInterface
in file RuleInterface.php, class Structures_Form_RuleInterface
    An interface to enforce consistency among all group elements used in a Structures_Form.
submit
in file Form.php, method Structures_Form::submit()
    Collects submitted values and calls the callback or error callback.
swapElementSet
in file Form.php, method Structures_Form::swapElementSet()
    Changes the UI of the form from the current set of elements to the given element set.
top

u

unfreeze
in file ElementInterface.php, method Structures_Form_ElementInterface::unfreeze()
    Unfreezes the element so that its value may not be changed.
unRegisterElement
in file Form.php, method Structures_Form::unRegisterElement()
    Unregisters an element type with a form.
unRegisterRule
in file Form.php, method Structures_Form::unRegisterRule()
    Unregisters a rule with the form.
top

v

validate
in file RuleInterface.php, method Structures_Form_RuleInterface::validate()
    Validates a value against the rule.
validate
in file Form.php, method Structures_Form::validate()
    Validates the values of the form against the applied rules.
top
Documentation generated on Mon, 11 Mar 2019 14:44:12 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.