Detailed Description

HTML single checkbox input type.

Class for a single "checkbox". If the boolean input is required it has to be clicked to sumbit the form succesfully. It may e.g. be used for specific terms a user has to accept to register.

See Also
depage::htmlform::elements::multiple

Usage

<?php
$form = new depage\htmlform\htmlform('myform');
// add a boolean field
$form->addBoolean('newsletter', array(
'label' => 'I want to receive news by mail',
));
// add a required boolean field
$form->addBoolean('acceptTerms', array(
'label' => 'I accept the following terms',
'required' => true,
));
// process form
$form->process();
// Display the form.
echo ($form);

Definition at line 48 of file boolean.php.

Inheritance diagram for boolean:

Public Member Functions

 __toString ()
 Renders element to HTML. More...
 
 validate ()
 validates boolean input element value More...
 
 setValue ($newValue)
 set the boolean element value 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...
 
- 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...
 

Additional Inherited Members

- Data Fields inherited from element
 $valid
 Contains element validation status/result. 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...
 

Member Function Documentation

__toString ( )

Renders element to HTML.

Returns
string HTML-rendered element

Definition at line 71 of file boolean.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 59 of file boolean.php.

setValue (   $newValue)

set the boolean element value

Sets the current input elements' value. Converts it to boolean if necessary.

Parameters
mixed$newValuenew element value
Returns
bool $this->value converted value

Definition at line 124 of file boolean.php.

validate ( )

validates boolean input element value

Overrides input::validate(). Checks if the value of the current input element is valid according to it's validator object. In case of boolean the value has to be true if field is required.

Returns
bool $this->valid validation result

Definition at line 101 of file boolean.php.


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