Class FormFieldRichTextEditor

__construct()

__construct(string $id, string $label, string $value, array<mixed,string> $field_options = array(), array<mixed,\FormFieldConstraint> $constraints = array()) 

Constructs a rich text edit field.

In addition to the parameters of the FormMultiLineEdit ones, there is the formatter which is an instance of the ContentFormattingFactory which ensures the formatting. The default value corresponds to the user's default configuration and will be the one to use 99% of the time.

Parameters

string	$id	Field id
string	$label	Field label
string	$value	Default value
array<mixed,string>	$field_options	options
array<mixed,\FormFieldConstraint>	$constraints	The constraints

• Inherited from \FormFieldRichTextEditor

Tags

None found

display()

display() : string

{@inheritdoc}

Returns

string —

The html code for the textarea.

• Inherited from \FormFieldRichTextEditor

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() 

{@inheritdoc}

• Inherited from \FormFieldRichTextEditor

Tags

None found

set_value()

set_value( $value) 

{@inheritdoc}

Parameters

$value

• Inherited from \FormFieldRichTextEditor

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() 

{@inheritdoc}

• Inherited from \FormFieldRichTextEditor

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

get_onblur_validations()

get_onblur_validations() 

• Inherited from \FormFieldRichTextEditor

Tags

None found

compute_options()

compute_options(array $field_options) 

Parameters

array

$field_options

• Inherited from \FormFieldRichTextEditor

Tags

None found

get_default_template()

get_default_template() : \Template

Returns

\Template

abstract

• Inherited from \AbstractFormField

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_js_specialization_code()

get_js_specialization_code() 

• Inherited from \AbstractFormField

Tags

None found

assign_textarea_template_variables()

assign_textarea_template_variables(\Template $template) 

Parameters

\Template

$template

• Inherited from \FormFieldMultiLineTextEditor

Tags

None found

get_related_fields()

get_related_fields() 

• Inherited from \AbstractFormField

Tags

None found

assign_editor()

assign_editor(\Template $template) 

Parameters

\Template

$template

• Inherited from \FormFieldRichTextEditor

Tags

None found

get_preview_button_code()

get_preview_button_code() 

• Inherited from \FormFieldRichTextEditor

Tags

None found

get_reset_button_code()

get_reset_button_code() 

• Inherited from \FormFieldRichTextEditor

Tags

None found

parse_value()

parse_value( $value) 

Parameters

$value

• Inherited from \FormFieldRichTextEditor

Tags

None found

get_raw_value()

get_raw_value() 

• Inherited from \FormFieldRichTextEditor

Tags

None found

set_raw_value()

set_raw_value( $value) 

Parameters

$value

• Inherited from \FormFieldRichTextEditor

Tags

None found

unparse_value()

unparse_value( $value) 

Parameters

$value

• Inherited from \FormFieldRichTextEditor

Tags

None found