\Pluf_Form_Field_Boolean

Boolean field

Manage and deserial boolean fields from input form

Summary

Methods

Properties

Constants

__construct()
clean()
setDefaultEmpty()
multiClean()
widgetAttrs()

$class
$widget
$label
$required
$help_text
$initial
$choices
$hidden_widget
$value
$multiple

No constants found

No protected methods found

$empty_values

N/A

No private methods found

No private properties found

N/A

File: core/src/Pluf/Form/Field/Boolean.php
Package: Default
Class hierarchy: \Pluf_Form_Field

\Pluf_Form_Field_Boolean

Properties

$class

$class :

Store the name of the class.

Type

$widget

$widget :

Widget.

The way to "present" the field to the user.

Type

$label

$label :

Type

$required

$required :

< The label of the field.

Type

$help_text

$help_text :

< Allowed to be blank.

Type

$initial

$initial :

< Help text for the field.

Type

$choices

$choices :

< Default value when empty.

Type

$hidden_widget

$hidden_widget :

Type

$value

$value :

Type

$multiple

$multiple :

Returning multiple values (select multiple etc.)

Type

$empty_values

$empty_values :

Type

Methods

__construct()

__construct(  $params = array())

Constructor.

Example: $field = new Your_Field(array('required'=>true, 'widget'=>'Pluf_Form_Widget_TextInput', 'initial'=>'your name here', 'label'=>__('Your name'), 'help_text'=>__('You are?'));

Parameters

$params

clean()

clean(  $value) : mixed

Validate some possible input for the field.

Parameters

$value

Returns

mixed —

Cleaned data or throw a Pluf_Form_Invalid exception.

setDefaultEmpty()

setDefaultEmpty(  $value) : mixed

Set the default empty value for a field.

Parameters

$value

Returns

mixed —

Value

multiClean()

multiClean(  $value) : array

Multi-clean a value.

If you are getting multiple values, you need to go through all of them and validate them against the requirements. This will do that for you. Basically, it is cloning the field, marking it as not multiple and validate each value. It will throw an exception in case of failure.

If you are implementing your own field which could be filled by a "multiple" widget, you need to perform a check on $this->multiple.

Parameters

$value

Returns

array —

Values

widgetAttrs()

widgetAttrs(  $widget) : array

Returns the HTML attributes to add to the field.

Parameters

$widget

Returns

array —

HTML attributes.