FormComment
class FormComment extends FormTextarea
Class FormComment
Constants
deprecated WYSIWYGToolbar_Basic |
|
WYSIWYGToolbar_Auto |
Primary Toolbars used in XELOS |
WYSIWYGToolbar_NoImgNoHTML |
|
WYSIWYGToolbar_NoHTML |
|
WYSIWYGToolbar_Full |
|
CODEEditor_Language_JAVASCRIPT |
Commonly used CodeMirror modes, refer to JSLIB directory for more modes |
CODEEditor_Language_LESS |
|
CODEEditor_Language_CSS |
|
CODEEditor_Language_HTML |
|
CODEEditor_Language_PHP |
|
CODEEditor_Language_PHPONLY |
|
CODEEditor_Language_MARKDOWN |
|
Properties
protected array | $config | from FormBase | |
bool | $save_requires_edit_var | from FormBase | |
Form | $form | from FormComponent | |
protected | $field_disable_save | Set to false if this field is not "saveable", e.g. static test |
from FormBase |
$REQUEST_VARS | from FormComponent | ||
$name | from FormComponent | ||
callable|bool | $db_handler | from FormComponent |
Methods
Display field
Display field in print mode
Return Dom Selector for this field within the current form (This is NOT necessary unique if you are having 2 forms with identical names in form and field names
Get Element Visibility Class Formerly known as tag class
Does this component use combined input fields which required special handling from form?
Initializes the form base
Checks if the field is hidden by a tag. It is important when validating
No description
Use markers to enable users refer to variables when writing text. Markers will automatically be written in ###marker### Syntax Using Template Markers can break highlighting or validation on Editor Modes
Show Custom Error Message for this field
Display Textarea as codeeditor (CodeMirror)
Field is to be loaded from and saved to database.
Field is considered to be translatable. This is usually determined automatically reading the instance configuration of the calling instance
Should content be saved as markdown?
Consider Field as required
Display Textarea as WYSIWYG Editor
Set Field label
Set max chars for this field Array Syntax: maxlength
Set HTML5 Placeholder Attribute, usually visible when no data has been entered into the field
Manipulate another fields data when the value of the current field changes.
Add Custom HTML before the field element
Enables submission of the Form if the user presses CTRL+ENTER in the textarea
Set Visibility Dependency if you want your field only to be shown if another field has a specify value Array Syntax: tag, tag_source
Set field to be the event source for another dependent field. Changes of this fields values will trigger events to their dependent fields and change their visibility in the frontend
Add Document Index Entries which should be available as insert in editor.
Details
in
FormBase at line 31
__construct()
FormBase constructor.
The constructor is able to set an array of properties options
in
FormBase at line 200
append(string $name, mixed $value, bool|string $key = false)
No description
in
FormBase at line 185
void
concat(string $name, string $value)
No description
in
FormBase at line 170
mixed
destroy($name)
No description
at line 36
string
display_field(string $fieldName, bool $default_value = false)
Display field
in
FormTextarea at line 505
string
display_field_print(string $fieldname, string $default_value = false)
Display field in print mode
in
FormBase at line 76
mixed
get(string $name)
No description
in
FormBase at line 83
array
getConfig()
No description
in
FormTextarea at line 689
getDocumentSelector()
No description
in
FormComponent at line 583
string
getDomSelector()
Return Dom Selector for this field within the current form (This is NOT necessary unique if you are having 2 forms with identical names in form and field names
in
FormComponent at line 595
protected string
getElementVisibilityClass()
Get Element Visibility Class Formerly known as tag class
in
FormComponent at line 496
bool
getIsVisible()
Determine visibilty based on user input on dependent fields
in
FormTextarea at line 668
array
getWYSIWYGCustomInserts()
No description
in
FormTextarea at line 660
DocumentIndex[]|ModelCollection
getWYSIWYGInserts()
No description
in
FormComponent at line 168
string
get_description()
No description
in
FormComponent at line 274
mixed
get_display_value()
returns the displayed value
in
FormBase at line 219
array
get_group(string $prefix)
No description
in
FormComponent at line 149
string
get_help_tooltip_icon()
No description
in
FormBase at line 91
array
get_properties()
No description
in
FormComponent at line 47
array|bool
get_validation_options()
No description
in
FormComponent at line 187
get_value()
No description
in
FormComponent at line 39
bool
hasCombinedInputFields()
Does this component use combined input fields which required special handling from form?
at line 14
init_obj()
Initializes the form base
in
FormComponent at line 544
$this
insertAfter(FormComponent $formComponent = null)
Insert this field after the specified field
in
FormComponent at line 529
$this
insertBefore(FormComponent $formComponent = null)
Insert this field before the specified field
in
FormComponent at line 369
bool
isReadonly()
Returns TRUE if field is readonly, FALSE otherwise.
in
FormBase at line 239
bool
is_displayed()
Checks if the field is hidden by a tag. It is important when validating
in
FormComponent at line 257
void
post_process()
No description
in
FormTextarea at line 97
void
process()
Process e.g. file upload, resize etc.
in
FormComponent at line 198
string
render(string|false $name = false, string|false $value = false)
No description
in
FormTextarea at line 51
mixed
save()
No description
in
FormTextarea at line 109
savePreProcess()
No description
in
FormBase at line 103
$this
set(string $name, mixed $value)
No description
in
FormComponent at line 391
$this
setCSSClassName(string $class = null)
Set Field Row CSS class name
in
FormTextarea at line 551
$this
setCSSStyle(string $style = '')
Set Custom CSS Style
in
FormTextarea at line 642
FormTextarea
setCodeEditorTemplateMarkers(array $placeholders = [])
Use markers to enable users refer to variables when writing text. Markers will automatically be written in ###marker### Syntax Using Template Markers can break highlighting or validation on Editor Modes
in
FormTextarea at line 517
FormTextarea
setCols(int $cols = null)
Set HTML Cols attribute
in
FormComponent at line 559
$this
setCustomErrorText(string $error_msg)
Show Custom Error Message for this field
in
FormComponent at line 380
$this
setDefaultValue(mixed $value = null)
Set Field default value
in
FormComponent at line 413
$this
setDescriptionText(string $description = null)
Set Field Help Text
in
FormTextarea at line 683
setDocumentSelector($documentSelectorFieldId)
No description
in
FormComponent at line 573
$this
setGridClass(string $gridClass = null)
Set Flexbox Grid Class
in
FormComponent at line 402
$this
setHelpText(string $help = null)
Set Field Help Text
in
FormTextarea at line 630
FormTextarea
setIsCodeEditor(bool $bool = true, string $language = self::CODEEditor_Language_JAVASCRIPT)
Display Textarea as codeeditor (CodeMirror)
in
FormComponent at line 336
$this
setIsDBField(bool $bool = true)
Field is to be loaded from and saved to database.
in
FormComponent at line 349
$this
setIsI18NField(bool $bool = true)
Field is considered to be translatable. This is usually determined automatically reading the instance configuration of the calling instance
in
FormTextarea at line 607
FormTextarea
setIsMarkdown(bool $isMarkdown = true, bool $allow_html = false, bool $allow_images = false, string $renderHTMLField = null)
Should content be saved as markdown?
in
FormComponent at line 360
$this
setIsReadonly(bool $bool = true)
Consider Field as readonly
in
FormComponent at line 325
$this
setIsRequired(bool $bool = true, bool $onlyRequiredIfVisible = true)
Consider Field as required
in
FormTextarea at line 584
FormTextarea
setIsWYSIWYG(bool $bool = true, string|null $toolbarSet = FormTextarea::WYSIWYGToolbar_Auto, bool $attachedToolbar = true)
Display Textarea as WYSIWYG Editor
in
FormComponent at line 311
$this
setLabel(string $label = '', string $icon_class = '', int $width_in_px = null)
Set Field label
in
FormTextarea at line 540
$this
setMaxlength(int $length = null)
Set max chars for this field Array Syntax: maxlength
in
FormTextarea at line 562
$this
setPlaceholder(string $title = '')
Set HTML5 Placeholder Attribute, usually visible when no data has been entered into the field
in
FormComponent at line 448
$this
setPopulateField(FormComponent $target, string $dataURL = null)
Manipulate another fields data when the value of the current field changes.
Common usage: Populate a second select once user chooses from the first select
in
FormComponent at line 424
$this
setPrefixHTML(string $html = null)
Add Custom HTML before the field element
in
FormTextarea at line 528
FormTextarea
setRows(int $rows = null)
Set HTML Rows attribute
in
FormTextarea at line 492
FormTextarea
setSubmitOnCtrlEnter(bool $bool)
Enables submission of the Form if the user presses CTRL+ENTER in the textarea
in
FormComponent at line 435
$this
setSuffixHTML(string $html = null)
Add Custom HTML after the field element
in
FormTextarea at line 474
FormTextarea
setUseMention(bool $bool)
No description
in
FormTextarea at line 482
FormTextarea
setUseTag(bool $bool)
No description
in
FormComponent at line 462
$this
setVisibilityDependsOn(FormComponent $formComponent = null, array $matchingValues = [])
Set Visibility Dependency if you want your field only to be shown if another field has a specify value Array Syntax: tag, tag_source
in
FormComponent at line 486
$this
setVisibilityIsSource(bool $bool = true)
Set field to be the event source for another dependent field. Changes of this fields values will trigger events to their dependent fields and change their visibility in the frontend
Fields are automatically set to be a source if used in a call of setVisibilityDependsOn()
Array Syntax: tag_source
in
FormTextarea at line 678
$this
setWYSIWYGCustomInserts(array $inserts)
No description
in
FormTextarea at line 652
FormTextarea
setWYSIWYGInserts(DocumentIndex[]|ModelCollection $documentIndexes)
Add Document Index Entries which should be available as insert in editor.
NOTE: When using the setDocumentSelector() all documents from the Selector will automatically be available
in
FormComponent at line 265
set_display_value(mixed $value)
set the displayed value
in
FormBase at line 155
void
set_properties(array $array)
No description
in
FormComponent at line 31
set_request_vars($request)
No description
in
FormTextarea at line 29
bool|string
validate()
No description