Detailed Description

HTML-single-choice input type i.e. radio and select.

Class for radio-like HTML elements. Has the same return value, regardless of skin type (radio or select).

Usage

<?php
$form = new depage\htmlform\htmlform('myform');
// add single-element (radio is the default skin)
$form->addSingle('listOne', array(
'label' => 'Language',
'list' => array(
'en' => 'English',
'es' => 'Spanish',
'fr' => 'French',
),
));
// add a single-element with select-skin
$form->addSingle('listTwo', array(
'label' => 'Language',
'skin' => 'select',
'list' => array(
'en' => 'English',
'es' => 'Spanish',
'fr' => 'French',
),
));
// process form
$form->process();
// Display the form.
echo ($form);

Definition at line 55 of file single.php.

Inheritance diagram for single:

Public Member Functions

 __construct ($name, $parameters, $form)
 single class constructor More...
 
 __toString ()
 Renders element to HTML. More...
 
- Public Member Functions inherited from input
 __construct ($name, $parameters, $form)
 input class constructor More...
 
 validate ()
 Validates input element. More...
 
 isEmpty ()
 says wether the element value is empty More...
 
 setValue ($newValue)
 set the input element value More...
 
 getValue ()
 Returns the current input elements' value. More...
 
 getLabel ()
 Returns the current input elements' label. More...
 
 clearValue ()
 resets the value to null More...
 
 setDefaultValue ($newDefaultValue)
 set the initial input element value More...
 
 setAutofocus ($autofocus=true)
 Sets the HTML autofocus-attribute of the current input element. More...
 
 setRequired ($required=true)
 Sets the HTML required-attribute of the current input element. More...
 
 setDisabled ($disabled=true)
 Sets the HTML disabled-attribute of the current input element. 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...
 

Protected Member Functions

 setDefaults ()
 collects initial values across subclasses More...
 
 htmlList ($options=null, $value=null)
 Renders HTML - option list part of select/radio single element. More...
 
 typeCastValue ()
 Converts value to element specific type. More...
 
- Protected Member Functions inherited from input
 setDefaults ()
 Sets the default values for input elements. More...
 
 validatorCall ()
 custom validator call hook More...
 
 typeCastValue ()
 converts element value More...
 
 htmlClasses ()
 Returns string of the elements' HTML-classes, separated by spaces. More...
 
 htmlMarker ()
 Returns elements' required-indicator. More...
 
 htmlInputAttributes ()
 Returns string of HTML attributes for input element. More...
 
 htmlWrapperAttributes ()
 Returns string of HTML attributes for element wrapper paragraph. More...
 
 htmlValue ()
 Returns HTML-rendered element value. More...
 
 htmlErrorMessage ()
 Returns HTML-rendered error message. More...
 
 htmlHelpMessage ()
 Returns HTML-rendered helpMessage. 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

 $list = array()
 Contains list of selectable options. More...
 
- Protected Attributes inherited from input
 $type
 Input element type - HTML input type attribute. More...
 
 $label
 Input element - HTML label. More...
 
 $marker
 Input element - HTML marker text that marks required fields. More...
 
 $required
 True if the input element is required to hold a value to be valid. More...
 
 $disabled
 wether a input element will be disabled More...
 
 $formName
 Name of the parent HTML form. Used to identify the element once it's rendered. More...
 
 $value = null
 Input elements's value. More...
 
 $validator
 Holds validator object reference. More...
 
 $class
 class for paragraph More...
 
 $classes
 HTML classes attribute for rendering the input element. More...
 
 $autofocus = false
 HTML autofocus attribute. More...
 
 $autocapitalize
 HTML autocapitalize attribute. More...
 
 $autocorrect
 HTML autocorrect attribute. More...
 
 $autocomplete
 HTML autocomplete attribute. More...
 
 $pattern
 HTML pattern attribute. More...
 
 $errorMessage
 Message that gets displayed in case of invalid input. More...
 
 $helpMessage
 Extra help message. More...
 
 $helpMessageHtml
 Extra hep message in html format. 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...
 

Additional Inherited Members

- Data Fields inherited from element
 $valid
 Contains element validation status/result. More...
 

Constructor & Destructor Documentation

__construct (   $name,
  $parameters,
  $form 
)

single class constructor

Parameters
string$nameelement name
array$parameterselement parameters, HTML attributes, validator specs etc.
object$formparent form object
Returns
void

Definition at line 70 of file single.php.

Member Function Documentation

__toString ( )

Renders element to HTML.

Returns
string HTML rendered element

Definition at line 146 of file single.php.

htmlList (   $options = null,
  $value = null 
)
protected

Renders HTML - option list part of select/radio single element.

Works recursively in case of select-optgroups. If no parameters are parsed, it uses the list attribute of this element.

Parameters
array$optionslist elements and subgroups
string$valuevalue to be marked as selected
Returns
string $list options-part of the HTML-select-element

Definition at line 105 of file single.php.

setDefaults ( )
protected

collects initial values across subclasses

The constructor loops through these and creates settable class attributes at runtime. It's a compact mechanism for initialising a lot of variables.

Returns
void

Definition at line 86 of file single.php.

typeCastValue ( )
protected

Converts value to element specific type.

Returns
void

Definition at line 183 of file single.php.

Field Documentation

$list = array()
protected

Contains list of selectable options.

Definition at line 60 of file single.php.


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