Function __global->form_input_huge_comcode
Definitions
sources/form_templates.php
- Get the Tempcode for a huge Comcode-enabled text input (textarea). These need extra space to fit.This function is also used as an automatic replacement for form_input_text_comcode if WYSIWYG is available (as WYSIWYG needs more space too).
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
- Returns: object
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $pretty_name | mixed | No | No | required parameter | N/A | N/A | A human intelligible name for this input field, provided in plain-text format (string or Tempcode) |
| $description | mixed | No | No | required parameter | N/A | N/A | A description for this input field, provided in HTML format (string or Tempcode) |
| $name | ID_TEXT | No | No | required parameter | N/A | N/A | The name which this input field is for |
| $default | string | No | No | required parameter | N/A | N/A | The default value for this input field |
| $required | boolean | No | No | required parameter | N/A | N/A | Whether this is a required input field |
| $tabindex | ?integer | No | No | Null | N/A | N/A | The tab index of the field (null: not specified) |
| $rows | integer | No | No | 20 | N/A | N/A | The number of rows to use |
| $description_side | mixed | No | No | Blank (empty string) | N/A | N/A | A secondary side description for this input field, provided in HTML format (string or Tempcode) |
| $default_parsed | ?Tempcode | No | No | Null | N/A | N/A | The parsed Comcode. (null: calculate) |
| $scrolls | boolean | No | No | False | N/A | N/A | Whether the field scrolls |
| $force_non_wysiwyg | boolean | No | No | False | N/A | N/A | Force non-WYSIWYG and non default-Comcode parsing |
Returns
- The input field
- Type: Tempcode
- Set: N/A
- Range: N/A
Preview
Code (PHP)
/**
* Get the Tempcode for a huge Comcode-enabled text input (textarea). These need extra space to fit.This function is also used as an automatic replacement for form_input_text_comcode if WYSIWYG is available (as WYSIWYG needs more space too).
*
* @param mixed $pretty_name A human intelligible name for this input field, provided in plain-text format (string or Tempcode)
* @param mixed $description A description for this input field, provided in HTML format (string or Tempcode)
* @param ID_TEXT $name The name which this input field is for
* @param string $default The default value for this input field
* @param boolean $required Whether this is a required input field
* @param ?integer $tabindex The tab index of the field (null: not specified)
* @param integer $rows The number of rows to use
* @param mixed $description_side A secondary side description for this input field, provided in HTML format (string or Tempcode)
* @param ?Tempcode $default_parsed The parsed Comcode. (null: calculate)
* @param boolean $scrolls Whether the field scrolls
* @param boolean $force_non_wysiwyg Force non-WYSIWYG and non default-Comcode parsing
* @return Tempcode The input field
*/
function form_input_huge_comcode($pretty_name, $description, string $name, string $default, bool $required, ?int $tabindex = null, int $rows = 20, $description_side = '', ?object $default_parsed = null, bool $scrolls = false, bool $force_non_wysiwyg = false) : object
* Get the Tempcode for a huge Comcode-enabled text input (textarea). These need extra space to fit.This function is also used as an automatic replacement for form_input_text_comcode if WYSIWYG is available (as WYSIWYG needs more space too).
*
* @param mixed $pretty_name A human intelligible name for this input field, provided in plain-text format (string or Tempcode)
* @param mixed $description A description for this input field, provided in HTML format (string or Tempcode)
* @param ID_TEXT $name The name which this input field is for
* @param string $default The default value for this input field
* @param boolean $required Whether this is a required input field
* @param ?integer $tabindex The tab index of the field (null: not specified)
* @param integer $rows The number of rows to use
* @param mixed $description_side A secondary side description for this input field, provided in HTML format (string or Tempcode)
* @param ?Tempcode $default_parsed The parsed Comcode. (null: calculate)
* @param boolean $scrolls Whether the field scrolls
* @param boolean $force_non_wysiwyg Force non-WYSIWYG and non default-Comcode parsing
* @return Tempcode The input field
*/
function form_input_huge_comcode($pretty_name, $description, string $name, string $default, bool $required, ?int $tabindex = null, int $rows = 20, $description_side = '', ?object $default_parsed = null, bool $scrolls = false, bool $force_non_wysiwyg = false) : object
