PHPBoost Framework A.P.I.

FormFieldCheckbox

Package: Builder\Form\field Copyright: © 2005-2019 PHPBoost License: GNU/GPL-3.0 Author: Regis VIARRE crowkait@phpboost.com Version: PHPBoost 5.2 - last update: 2016 10 24 Since: PHPBoost 3.0 - 2009 04 28 Contributor: Julien BRISWALTER j1.seth@phpboost.com Contributor: Arnaud GENET elenwii@phpboost.com Located at: builder/form/field/FormFieldCheckbox.class.php

The class FormCheckBox represents a checkbox field in a form. It corresponds to a boolean.

FormFieldCheckbox

Methods summary
`public`	# `__construct( string $id, string $label, boolean $checked = self::UNCHECKED, array $field_options = array(), array $constraints = array() )` Constructs a FormFieldCheckbox. Constructs a FormFieldCheckbox. Parameters `$id` Field identifier `$label` Field label `$checked` FormFieldCheckbox::CHECKED if it's checked by default or FormFieldCheckbox::UNCHECKED if not checked. `$field_options` Map containing the options `$constraints` The constraints checked during the validation Overrides `AbstractFormField::__construct()`
`public string`	# `display( )` Return the element Return the element Returns string
`public boolean`	# `is_checked( )` Tells whether the checkbox is checked Tells whether the checkbox is checked Returns boolean
`public`	# `retrieve_value( )` Tries to retrieve the value in the HTTP request's parameters. Tries to retrieve the value in the HTTP request's parameters. Overrides `AbstractFormField::retrieve_value()`
`protected Template`	# `get_default_template( )` Returns `Template`

Methods inherited from AbstractFormField
add_constraint(), add_event(), add_form_constraint(), assign_common_template_variables(), compute_options(), disable(), enable(), get_css_class(), get_css_field_class(), get_css_form_field_class(), get_description(), get_form_id(), get_html_id(), get_id(), get_js_specialization_code(), get_js_validations(), get_label(), get_onblur_validation(), get_template_to_use(), get_validation_error_message(), get_value(), has_constraints(), has_pattern(), has_placeholder(), is_disabled(), is_hidden(), is_readonly(), is_required(), set_css_class(), set_css_field_class(), set_css_form_field_class(), set_description(), set_disabled(), set_fieldset_id(), set_form_id(), set_hidden(), set_id(), set_label(), set_pattern(), set_placeholder(), set_readonly(), set_required(), set_template(), set_validation_error_message(), set_value(), validate()

Constants summary
`boolean`	`CHECKED`	# `true`
`boolean`	`UNCHECKED`	# `false`

Properties inherited from AbstractFormField
`$constraints, $css_class, $css_field_class, $css_form_field_class, $description, $disabled, $events, $form_constraints, $hidden, $id, $label, $pattern, $placeholder, $readonly, $required, $template, $validation_error_message, $value`