PHPBoost Framework A.P.I.

AbstractFormField

Abstract Package: Builder\Form\field Copyright: © 2005-2019 PHPBoost License: GNU/GPL-3.0 Author: Benoit SAUTEL ben.popeye@phpboost.com Version: PHPBoost 5.2 - last update: 2018 05 31 Since: PHPBoost 3.0 - 2010 01 08 Contributor: Julien BRISWALTER j1.seth@phpboost.com Contributor: Arnaud GENET elenwii@phpboost.com Located at: builder/form/field/AbstractFormField.class.php

Abstract class that proposes a default implementation for the FormField interface.

AbstractFormField implements FormField

Direct known subclasses

AbstractFormFieldChoice, FormFieldActionLink, FormFieldHidden, FormFieldHTML, FormFieldLabel, FormFieldMultiLineTextEditor, FormFieldMultipleAutocompleter, FormFieldMultipleCheckbox, FormFieldMultipleFilePicker, FormFieldMultipleSelectChoice, FormFieldNumberEditor, FormFieldPasswordEditor, FormFieldActionLinkList, FormFieldPossibleValues, FormFieldSelectSources, FormFieldTextEditor, FormFieldUploadFile, FormFieldAuthorizationsSetter, FormFieldCaptcha, FormFieldCheckbox, FormFieldColorPicker, FormFieldDate, FormFieldFilePicker, FormFieldFree

Indirect known subclasses

FormFieldAjaxCompleter, FormFieldAjaxSearchUserAutoComplete, FormFieldLangsSelect, FormFieldMailEditor, FormFieldMemberCaution, FormFieldMemberSanction, FormFieldRadioChoice, FormFieldRangeEditor, FormFieldRanksSelect, FormFieldRichTextEditor, FormFieldSearch, FormFieldShortMultiLineTextEditor, FormFieldAjaxUserAutoComplete, FormFieldSimpleSelectChoice, FormFieldTelEditor, FormFieldThemesSelect, FormFieldTimezone, FormFieldUploadPictureFile, FormFieldUrlEditor, FormFieldBooleanInformation, FormFieldCategoriesSelect, FormFieldCSRFToken, FormFieldDateTime, FormFieldDecimalNumberEditor, FormFieldEditors, FormFieldGroups

Methods summary
`protected`	# `__construct( string $id, string $label, mixed $value, array $field_options = array(), array $constraints = array() )` Constructs and set parameters to the field. The specific parameters of this abstract class (common with many fields) are the following: description at which you must associate the description of the field class which corresponds to the HTML class of the field required which tells whether this field must be completed. If it's the case, it will display a * beside the label and will add a non empty constraint to the constraints. None of these parameters is required. Constructs and set parameters to the field. The specific parameters of this abstract class (common with many fields) are the following: description at which you must associate the description of the field class which corresponds to the HTML class of the field required which tells whether this field must be completed. If it's the case, it will display a * beside the label and will add a non empty constraint to the constraints. None of these parameters is required. Parameters `$id` Field identifier `$label` Field label `$value` Field value `$field_options` Map associating the parameters values to the parameters names. `$constraints` List of the constraints which must be checked when the form is been validated
`public string`	# `get_id( )` Returns the id. Returns the id. Returns string Implementation of `FormField::get_id()`
`public`	# `set_id( string $id )` Sets the id Sets the id Parameters `$id` The id. Implementation of `FormField::set_id()`
`public`	# `get_form_id( )`
`public`	# `set_form_id( string $form_id )` Sets the id prefix Sets the id prefix Parameters `$form_id` $prefix The new id prefix. Implementation of `FormField::set_form_id()`
`public`	# `set_fieldset_id( $fieldset_id )` Sets the if of the fieldset which contains the field Sets the if of the fieldset which contains the field Parameters `$fieldset_id` of the fieldset Implementation of `FormField::set_fieldset_id()`
`public string`	# `get_label( )` Returns the label Returns the label Returns string The label Implementation of `FormField::get_label()`
`public`	# `set_label( string $label )` Sets the label Sets the label Parameters `$label` The label
`public string`	# `get_description( )` Returns the description Returns the description Returns string the description
`public`	# `set_description( string $description )` Sets the description Sets the description Parameters `$description` The description
`public mixed`	# `get_value( )` Returns mixed Implementation of `FormField::get_value()`
`public`	# `set_value( string $value )` Sets the value Sets the value Parameters `$value` The value Implementation of `FormField::set_value()`
`public true`	# `is_required( )` Tells whether the field is required Tells whether the field is required Returns true if it is, false otherwise
`public`	# `set_required( boolean $required )` Changes the fact that the field is required or not. Changes the fact that the field is required or not. Parameters `$required` true if it's required, false otherwise
`public boolean`	# `validate( )` Validates the field by cheching if all the constraints are satisfied. Validates the field by cheching if all the constraints are satisfied. Returns boolean true if the form is valid Implementation of `FormField::validate()`
`public`	# `get_validation_error_message( )` Returns validation error message. Returns validation error message. Implementation of `FormField::get_validation_error_message()`
`public`	# `set_validation_error_message( string $error_message )` Set the validation error message. Set the validation error message. Parameters `$error_message` The message to set Implementation of `FormField::set_validation_error_message()`
`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. Implementation of `FormField::retrieve_value()`
`public string`	# `get_html_id( )` Returns the effective HTML id. Returns the effective HTML id. Returns string Implementation of `FormField::get_html_id()`
`public`	# `add_constraint( FormFieldConstraint $constraint )` Adds a constraint to the field constraints. Adds a constraint to the field constraints. Parameters `$constraint` The constraint to add Implementation of `FormField::add_constraint()`
`public`	# `add_form_constraint( FormConstraint $constraint )` Add javascript code on the onblur field parameter that makes validation Add javascript code on the onblur field parameter that makes validation Implementation of `FormField::add_form_constraint()`
`public boolean`	# `has_constraints( )` Return true if the field has one or more constraints, false otherwise. Return true if the field has one or more constraints, false otherwise. Returns boolean Implementation of `FormField::has_constraints()`
`public string`	# `get_js_validations( )` Returns the javascript onsubmit code. Returns the javascript onsubmit code. Returns string The javascript code that makes the validation when the form is submitted Implementation of `FormField::get_js_validations()`
`public`	# `get_onblur_validation( )`
`public`	# `add_event( $event, $handler )`
`protected`	# `compute_options( array & $field_options )`
`protected`	# `assign_common_template_variables( Template $template )`
`protected`	# `get_css_class( )`
`protected`	# `set_css_class( $css_class )`
`protected`	# `get_css_field_class( )`
`protected`	# `set_css_field_class( $css_field_class )`
`protected`	# `get_css_form_field_class( )`
`protected`	# `set_css_form_field_class( $css_form_field_class )`
`public boolean`	# `is_disabled( )` Tells whether the field is disabled Tells whether the field is disabled Returns boolean Implementation of `FormField::is_disabled()`
`public`	# `disable( )` Disabled the field Disabled the field Implementation of `FormField::disable()`
`public`	# `enable( )` Enables the field Enables the field Implementation of `FormField::enable()`
`protected`	# `set_disabled( $disabled )`
`public`	# `is_readonly( )`
`public`	# `set_readonly( $readonly )`
`public`	# `is_hidden( )`
`public`	# `set_hidden( $hidden )`
`public`	# `has_pattern( )`
`public`	# `set_pattern( $pattern )`
`public`	# `has_placeholder( )`
`public`	# `set_placeholder( $placeholder )`
`public`	# `set_template( Template $template )`
`protected Template`	# `get_template_to_use( )` Returns `Template`
`abstract protected Template`	# `get_default_template( )` Returns `Template`
`protected`	# `get_js_specialization_code( )`

Methods inherited from HTMLElement
`display()`

Properties summary
`protected string`	`$id`	# `''`
`protected string`	`$label`	# `''`
`protected string`	`$description`	# `''`
`protected string`	`$value`	# `null`
`protected boolean`	`$disabled`	# `false`
`protected boolean`	`$hidden`	# `false`
`protected boolean`	`$readonly`	# `false`
`protected string`	`$css_class`	# `''`
`protected string`	`$css_field_class`	# `''`
`protected string`	`$css_form_field_class`	# `''`
`protected string`	`$required`	# `false`
`protected string`	`$pattern`	# `''`
`protected string`	`$placeholder`	# `''`
`protected string`	`$validation_error_message`	# `''`
`protected FormFieldConstraint[]`	`$constraints`	# `array()`
`protected FormConstraint[]`	`$form_constraints`	# `array()`
`protected Template`	`$template`	# `null`
`protected string[string]`	`$events`	# `array()`

Direct known subclasses

Indirect known subclasses

Parameters

Returns

Implementation of

Parameters

Implementation of

Parameters

Implementation of

Parameters

Implementation of

Returns

Implementation of

Parameters

Returns

Parameters

Returns

Implementation of

Parameters

Implementation of

Returns

Parameters

Returns

Implementation of

Implementation of

Parameters

Implementation of

Implementation of

Returns

Implementation of

Parameters

Implementation of

Implementation of

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of

Implementation of

Implementation of

Returns

Returns