PHPBoost Framework A.P.I.

FormField

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 2.0 - 2009 04 28 Contributor: Arnaud GENET elenwii@phpboost.com Located at: builder/form/field/FormField.class.php

This class manage radio input fields.

FormField implements FormElement

Direct known implementers

AbstractFormField

Indirect known implementers

AbstractFormFieldChoice, FormFieldActionLink, FormFieldCheckbox, FormFieldColorPicker, FormFieldCSRFToken, FormFieldDate, FormFieldDateTime, FormFieldDecimalNumberEditor, FormFieldEditors, FormFieldFilePicker, FormFieldFree, FormFieldGroups, FormFieldActionLinkList, FormFieldHidden, FormFieldHTML, FormFieldLabel, FormFieldLangsSelect, FormFieldMailEditor, FormFieldMemberCaution, FormFieldMemberSanction, FormFieldMultiLineTextEditor, FormFieldMultipleAutocompleter, FormFieldMultipleCheckbox, FormFieldAjaxCompleter, FormFieldMultipleFilePicker, FormFieldMultipleSelectChoice, FormFieldNumberEditor, FormFieldPasswordEditor, FormFieldPossibleValues, FormFieldRadioChoice, FormFieldRangeEditor, FormFieldRanksSelect, FormFieldRichTextEditor, FormFieldSearch, FormFieldAjaxSearchUserAutoComplete, FormFieldSelectSources, FormFieldShortMultiLineTextEditor, FormFieldSimpleSelectChoice, FormFieldTelEditor, FormFieldTextEditor, FormFieldThemesSelect, FormFieldTimezone, FormFieldUploadFile, FormFieldUploadPictureFile, FormFieldUrlEditor, FormFieldAjaxUserAutoComplete, FormFieldAuthorizationsSetter, FormFieldBooleanInformation, FormFieldCaptcha, FormFieldCategoriesSelect

Methods summary
`public string`	# `get_id( )` Returns the id. Returns the id. Returns string
`public string`	# `get_label( )` Returns the label Returns the label Returns string
`public`	# `set_id( string $id )` Sets the id Sets the id Parameters `$id` The id.
`public`	# `set_form_id( string $prefix )` Sets the id prefix Sets the id prefix Parameters `$prefix` The new id prefix.
`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
`public mixed`	# `get_value( )` Returns mixed
`public`	# `set_value( string $value )` Sets the value Sets the value Parameters `$value` The value
`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.
`public string`	# `get_html_id( )` Returns the effective HTML id. Returns the effective HTML id. Returns string
`public boolean`	# `is_disabled( )` Tells whether the field is disabled Tells whether the field is disabled Returns boolean
`public`	# `disable( )` Disabled the field Disabled the field
`public`	# `enable( )` Enables the field Enables the field
`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
`public`	# `get_validation_error_message( )` Returns validation error message. Returns 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
`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
`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
`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
`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

Methods inherited from HTMLElement
`display()`

Direct known implementers

Indirect known implementers

Returns

Returns

Parameters

Parameters

Parameters

Returns

Parameters

Returns

Returns

Returns

Parameters

Parameters

Returns

Returns