Class FormFieldSelectSources

__construct()

__construct(string $id, string $label, array $value = array(), 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.

Parameters

string	$id	Field identifier
string	$label	Field label
array	$value	Field value
array	$field_options	Map associating the parameters values to the parameters names.
array	$constraints	List of the constraints which must be checked when the form is been validated

• Inherited from \FormFieldSelectSources

Tags

None found

get_id()

get_id() : string

Returns the id.

Returns

string

• Inherited from \AbstractFormField

Tags

None found

set_id()

set_id(string $id) 

Sets the id

Parameters

string

$id

The id.

• Inherited from \AbstractFormField

Tags

None found

get_form_id()

get_form_id() 

{@inheritdoc}

• Inherited from \AbstractFormField

Tags

None found

set_form_id()

set_form_id( $form_id) 

Sets the id prefix

Parameters

$form_id

• Inherited from \AbstractFormField

Tags

None found

set_fieldset_id()

set_fieldset_id( $fieldset_id) 

Sets the if of the fieldset which contains the field

Parameters

$fieldset_id

id of the fieldset

• Inherited from \AbstractFormField

Tags

None found

get_label()

get_label() : string

Returns the label

Returns

string —

The label

• Inherited from \AbstractFormField

Tags

None found

set_label()

set_label(string $label) 

Sets the label

Parameters

string

$label

The label

• Inherited from \AbstractFormField

Tags

None found

get_description()

get_description() : string

Returns the description

Returns

string —

the description

• Inherited from \AbstractFormField

Tags

None found

set_description()

set_description(string $description) 

Sets the description

Parameters

string

$description

The description

• Inherited from \AbstractFormField

Tags

None found

get_value()

get_value() : mixed

Returns

mixed

• Inherited from \AbstractFormField

Tags

None found

set_value()

set_value(string $value) 

Sets the value

Parameters

string

$value

The value

• Inherited from \AbstractFormField

Tags

None found

is_required()

is_required() : true

Tells whether the field is required

Returns

true —

if it is, false otherwise

• Inherited from \AbstractFormField

Tags

None found

set_required()

set_required(boolean $required) 

Changes the fact that the field is required or not.

Parameters

boolean

$required

true if it's required, false otherwise

• Inherited from \AbstractFormField

Tags

None found

validate()

validate() : boolean

Validates the field by cheching if all the constraints are satisfied.

Returns

boolean —

true if the form is valid

• Inherited from \AbstractFormField

Tags

None found

get_validation_error_message()

get_validation_error_message() 

Returns validation error message.

• Inherited from \AbstractFormField

Tags

None found

set_validation_error_message()

set_validation_error_message(string $error_message) 

Set the validation error message.

Parameters

string

$error_message

The message to set

• Inherited from \AbstractFormField

Tags

None found

retrieve_value()

retrieve_value() 

Tries to retrieve the value in the HTTP request's parameters.

• Inherited from \FormFieldSelectSources

Tags

None found

get_html_id()

get_html_id() : string

Returns the effective HTML id.

Returns

string

• Inherited from \AbstractFormField

Tags

None found

add_constraint()

add_constraint(\FormFieldConstraint $constraint) 

Adds a constraint to the field constraints.

Parameters

\FormFieldConstraint

$constraint

The constraint to add

• Inherited from \AbstractFormField

Tags

None found

add_form_constraint()

add_form_constraint(\FormConstraint $constraint) 

Add javascript code on the onblur field parameter that makes validation

Parameters

\FormConstraint

$constraint

• Inherited from \AbstractFormField

Tags

None found

has_constraints()

has_constraints() : boolean

Return true if the field has one or more constraints, false otherwise.

Returns

boolean

• Inherited from \AbstractFormField

Tags

None found

get_js_validations()

get_js_validations() : string

Returns the javascript onsubmit code.

Returns

string —

The javascript code that makes the validation when the form is submitted

• Inherited from \AbstractFormField

Tags

None found

get_onblur_validation()

get_onblur_validation() 

• Inherited from \AbstractFormField

Tags

None found

add_event()

add_event( $event,  $handler) 

Parameters

	$event
	$handler

• Inherited from \AbstractFormField

Tags

None found

is_disabled()

is_disabled() : boolean

Tells whether the field is disabled

Returns

boolean

• Inherited from \AbstractFormField

Tags

None found

disable()

disable() 

Disabled the field

• Inherited from \AbstractFormField

Tags

None found

enable()

enable() 

Enables the field

• Inherited from \AbstractFormField

Tags

None found

is_select_to_list()

is_select_to_list() 

• Inherited from \AbstractFormField

Tags

None found

transformed_select()

transformed_select() 

• Inherited from \AbstractFormField

Tags

None found

not_transformed_select()

not_transformed_select() 

• Inherited from \AbstractFormField

Tags

None found

is_readonly()

is_readonly() 

• Inherited from \AbstractFormField

Tags

None found

set_readonly()

set_readonly( $readonly) 

Parameters

$readonly

• Inherited from \AbstractFormField

Tags

None found

is_hidden()

is_hidden() 

• Inherited from \AbstractFormField

Tags

None found

set_hidden()

set_hidden( $hidden) 

Parameters

$hidden

• Inherited from \AbstractFormField

Tags

None found

has_pattern()

has_pattern() 

• Inherited from \AbstractFormField

Tags

None found

set_pattern()

set_pattern( $pattern) 

Parameters

$pattern

• Inherited from \AbstractFormField

Tags

None found

has_placeholder()

has_placeholder() 

• Inherited from \AbstractFormField

Tags

None found

set_placeholder()

set_placeholder( $placeholder) 

Parameters

$placeholder

• Inherited from \AbstractFormField

Tags

None found

set_template()

set_template(\Template $template) 

Parameters

\Template

$template

• Inherited from \AbstractFormField

Tags

None found

display()

display() 

• Inherited from \FormFieldSelectSources

Tags

None found

compute_options()

compute_options(array $field_options) 

Parameters

array

$field_options

• Inherited from \FormFieldSelectSources

Tags

None found

assign_common_template_variables()

assign_common_template_variables(\Template $template) 

Parameters

\Template

$template

• Inherited from \AbstractFormField

Tags

None found

get_css_class()

get_css_class() 

• Inherited from \AbstractFormField

Tags

None found

set_css_class()

set_css_class( $css_class) 

Parameters

$css_class

• Inherited from \AbstractFormField

Tags

None found

get_css_field_class()

get_css_field_class() 

• Inherited from \AbstractFormField

Tags

None found

set_css_field_class()

set_css_field_class( $css_field_class) 

Parameters

$css_field_class

• Inherited from \AbstractFormField

Tags

None found

get_css_form_field_class()

get_css_form_field_class() 

• Inherited from \AbstractFormField

Tags

None found

set_css_form_field_class()

set_css_form_field_class( $css_form_field_class) 

Parameters

$css_form_field_class

• Inherited from \AbstractFormField

Tags

None found

set_disabled()

set_disabled( $disabled) 

Parameters

$disabled

• Inherited from \AbstractFormField

Tags

None found

set_select_to_list()

set_select_to_list( $select_to_list) 

Parameters

$select_to_list

• Inherited from \AbstractFormField

Tags

None found

get_template_to_use()

get_template_to_use() : \Template

Returns

\Template

• Inherited from \AbstractFormField

Tags

None found

get_default_template()

get_default_template() : \Template

Returns

\Template

• Inherited from \FormFieldSelectSources

Tags

None found

get_js_specialization_code()

get_js_specialization_code() 

• Inherited from \AbstractFormField

Tags

None found

get_related_fields()

get_related_fields() 

• Inherited from \AbstractFormField

Tags

None found