Public Member Functions | |
| __construct ($name, $args=[]) | |
| getConfig () | |
 Public Member Functions inherited from PKP\components\forms\Field | |
| getEmptyValue () | |
| validate () | |
Data Fields | |
| $component = 'field-rich-textarea' | |
| $init | |
| $plugins = 'paste,link,noneditable' | |
| $preparedContent | |
| $renderPreparedContent = false | |
| $size | |
| $toolbar = 'bold italic superscript subscript | link' | |
| $uploadUrl | |
| $wordLimit = 0 | |
| Data Fields inherited from PKP\components\forms\Field | |
| $component | |
| $default | |
| $description | |
| $groupId | |
| $helpSection | |
| $helpTopic | |
| $isMultilingual = false | |
| $isRequired = false | |
| $label = '' | |
| $name | |
| $showWhen | |
| $tooltip | |
| $value | |
Detailed Description
Definition at line 15 of file FieldRichTextarea.inc.php.
Constructor & Destructor Documentation
◆ __construct()
| PKP\components\forms\FieldRichTextarea::__construct | ( | $name, | |
$args = [] |
|||
| ) |
Initialize the form field
- Parameters
-
$name string $args array [ @option label string|object @option groupId string @option isRequired boolean @option isMultilingual boolean ]
Reimplemented from PKP\components\forms\Field.
Definition at line 70 of file FieldRichTextarea.inc.php.
References PKP\components\forms\Field\$name.
Member Function Documentation
◆ getConfig()
| PKP\components\forms\FieldRichTextarea::getConfig | ( | ) |
Get a configuration object representing this field to be passed to the UI Library
- Returns
- array
Reimplemented from PKP\components\forms\Field.
Definition at line 77 of file FieldRichTextarea.inc.php.
References PKP\components\forms\FieldRichTextarea\$init, PKP\components\forms\FieldRichTextarea\$plugins, PKP\components\forms\FieldRichTextarea\$preparedContent, PKP\components\forms\FieldRichTextarea\$renderPreparedContent, PKP\components\forms\FieldRichTextarea\$size, PKP\components\forms\FieldRichTextarea\$toolbar, PKP\components\forms\FieldRichTextarea\$uploadUrl, and PKP\components\forms\FieldRichTextarea\$wordLimit.
Field Documentation
◆ $component
| PKP\components\forms\FieldRichTextarea::$component = 'field-rich-textarea' |
Which UI Library component this field represents
Definition at line 17 of file FieldRichTextarea.inc.php.
◆ $init
| array FieldRichTextarea::$init |
Optional. An assoc array of init properties to pass to TinyMCE
Definition at line 23 of file FieldRichTextarea.inc.php.
Referenced by PKP\components\forms\FieldRichTextarea\getConfig().
◆ $plugins
| array FieldRichTextarea::$plugins = 'paste,link,noneditable' |
Optional. A list of required plugins.
Definition at line 29 of file FieldRichTextarea.inc.php.
Referenced by PKP\components\forms\FieldRichTextarea\getConfig().
◆ $preparedContent
| array FieldRichTextarea::$preparedContent |
Optional. A key/value list of content that can be inserted from a TinyMCE button.
Definition at line 35 of file FieldRichTextarea.inc.php.
Referenced by PKP\components\forms\FieldRichTextarea\getConfig().
◆ $renderPreparedContent
| boolean FieldRichTextarea::$renderPreparedContent = false |
Whether the $preparedContent properties should be replaced in the field's initial value.
Definition at line 41 of file FieldRichTextarea.inc.php.
Referenced by PKP\components\forms\FieldRichTextarea\getConfig().
◆ $size
| string FieldRichTextarea::$size |
Optional. A preset size option.
Definition at line 47 of file FieldRichTextarea.inc.php.
Referenced by PKP\components\forms\FieldRichTextarea\getConfig().
◆ $toolbar
| string FieldRichTextarea::$toolbar = 'bold italic superscript subscript | link' |
Optional. A preset toolbar configuration.
Definition at line 53 of file FieldRichTextarea.inc.php.
Referenced by PKP\components\forms\FieldRichTextarea\getConfig().
◆ $uploadUrl
| string FieldRichTextarea::$uploadUrl |
Optional. The API endpoint to upload images to. Only include if image uploads are supported here.
Definition at line 59 of file FieldRichTextarea.inc.php.
Referenced by PKP\components\forms\FieldRichTextarea\getConfig().
◆ $wordLimit
| integer FieldRichTextarea::$wordLimit = 0 |
Optional. When a word limit is specified a word counter will be shown
Definition at line 65 of file FieldRichTextarea.inc.php.
Referenced by PKP\components\forms\FieldRichTextarea\getConfig().
The documentation for this class was generated from the following file:
