step Class Reference

Detailed Description

Steps break up forms into separate consecutive parts.

Example form

Definition at line 17 of file step.php.

Inheritance diagram for step:

Public Member Functions

 __toString ()
 renders step container to HTML More...
 
- Public Member Functions inherited from fieldset
 addElement ($type, $name, $parameters)
 Generates sub-elements. More...
 
 __toString ()
 Renders the fieldset to HTML code. More...
 
- Public Member Functions inherited from container
 __construct ($name, $parameters, $form)
 container class constructor More...
 
 __call ($function, $arguments)
 HTML escaping and add subelements. More...
 
 addChildElements ()
 Sub-element generator hook. More...
 
 addHtml ($html)
 Adds a new custom HTML element to the container. More...
 
 addStepNav ($parameter=array())
 Adds automatic step navigation to output. More...
 
 validate ()
 Validates container and its contents. More...
 
 setRequired ($required=true)
 Sets required-attribute. More...
 
 getElements ($includeFieldsets=false)
 Returns containers subelements. More...
 
 getElement ($name)
 Gets subelement by name. More...
 
 clearValue ()
 Deletes values of all child elements. More...
 
- Public Member Functions inherited from element
 __construct ($name, $parameters, $form)
 element class constructor More...
 
 __call ($function, $arguments)
 HTML escaping. More...
 
 clearValue ()
 resets the value to null More...
 
 getName ()
 Returns the element name. More...
 

Additional Inherited Members

- Data Fields inherited from element
 $valid
 Contains element validation status/result. More...
 
- Protected Member Functions inherited from fieldset
 setDefaults ()
 collects initial values across subclasses. More...
 
 htmlClasses ()
 Returns string of the elements' HTML-classes, separated by spaces. More...
 
- Protected Member Functions inherited from container
 addElement ($type, $name, $parameters)
 Generates sub-elements. More...
 
- Protected Member Functions inherited from element
 setDefaults ()
 Collects initial values across subclasses. More...
 
 checkParameters ($parameters)
 checks element parameters More...
 
 log ($argument, $type=null)
 error & warning logger More...
 
 htmlEscape ($options=array())
 Escapes HTML in strings and arrays of strings. More...
 
- Protected Attributes inherited from fieldset
 $form
 parent HTML form. More...
 
- Protected Attributes inherited from container
 $elements = array()
 References to input elements and fieldsets. More...
 
 $elementsAndHtml = array()
 Input element, fieldset and custom HTML object references. More...
 
 $form
 Parent form object reference. More...
 
- Protected Attributes inherited from element
 $name
 Element name. More...
 
 $validated = false
 True if the element has been validated before. More...
 
 $log
 Log object reference. More...
 

Member Function Documentation

__toString ( )

renders step container to HTML

If the step contains elements it calls their rendering methods. (unlike fieldsets, steps themselves aren't rendered)

Returns
string $renderedElement HTML rendered element

Definition at line 27 of file step.php.


The documentation for this class was generated from the following file: