htmleditorcontrol
extends htmleditor
in package
HTML Editor Control - displays wysiwyg editor widget
Tags
Table of Contents
- $accesskey : mixed
- $class : mixed
- $cols : mixed
- $default : mixed
- $disabled : mixed
- $flip : mixed
- $focus : mixed
- $horizontal : mixed
- $horizontal_top : mixed
- $id : mixed
- $inError : mixed
- $is_hidden : mixed
- $jsHooks : mixed
- $maxlength : mixed
- $module : mixed
- $multiple : mixed
- $name : mixed
- $placeholder : mixed
- $required : mixed
- $rows : mixed
- $tabindex : mixed
- $toolbar : mixed
- $type : mixed
- __construct() : mixed
- __get() : null
- Generic magic method
- __isset() : bool
- Generic magic method
- __set() : mixed
- Generic magic method We MUST create/set non-existing properties for Exponent code to work
- __unset() : mixed
- Generic magic method
- controlToHTML() : string
- Place the editable control on the edit form
- convertData() : string
- Convert a foreign value to fit the exp control
- form() : mixed
- getFieldDefinition() : mixed
- isSimpleControl() : mixed
- isStatic() : bool
- Is this a Static Control? Used to determine if control has field data behind it
- name() : mixed
- onRegister() : bool
- Event hook for when control is registered on a form
- onUnRegister() : bool
- Event hook for when control is un-registered (removed) on a form
- parseData() : string
- Parse the control value for storage in database
- templateFormat() : mixed
- toHTML() : string
- Place the control in the form with label and description
- update() : mixed
- useGeneric() : bool
- Use the Generic Control instead? Used to determine if control is actually a generic control
Properties
$accesskey
public
mixed
$accesskey
= ""
$class
public
mixed
$class
= ""
$cols
public
mixed
$cols
= 38
$default
public
mixed
$default
= ""
$disabled
public
mixed
$disabled
= \false
$flip
public
mixed
$flip
= \false
$focus
public
mixed
$focus
= \false
$horizontal
public
mixed
$horizontal
= \false
$horizontal_top
public
mixed
$horizontal_top
= \false
$id
public
mixed
$id
= \null
$inError
public
mixed
$inError
= 0
$is_hidden
public
mixed
$is_hidden
= \false
$jsHooks
public
mixed
$jsHooks
= array()
$maxlength
public
mixed
$maxlength
= ""
$module
public
mixed
$module
= ""
$multiple
public
mixed
$multiple
= \false
$name
public
mixed
$name
= ""
$placeholder
public
mixed
$placeholder
= ""
$required
public
mixed
$required
= \false
$rows
public
mixed
$rows
= 5
$tabindex
public
mixed
$tabindex
= -1
$toolbar
public
mixed
$toolbar
= ""
$type
public
mixed
$type
= 'text'
Methods
__construct()
public
__construct([mixed $default = "" ][, mixed $rows = 5 ][, mixed $cols = 38 ]) : mixed
Parameters
- $default : mixed = ""
- $rows : mixed = 5
- $cols : mixed = 38
Return values
mixed —__get()
Generic magic method
public
__get( $property) : null
Parameters
Return values
null —__isset()
Generic magic method
public
__isset( $property) : bool
Parameters
Return values
bool —__set()
Generic magic method We MUST create/set non-existing properties for Exponent code to work
public
__set( $property, $value) : mixed
Parameters
Return values
mixed —__unset()
Generic magic method
public
__unset( $property) : mixed
Parameters
Return values
mixed —controlToHTML()
Place the editable control on the edit form
public
controlToHTML( $name, $label) : string
Parameters
Return values
string —convertData()
Convert a foreign value to fit the exp control
public
static convertData( $name, $values) : string
Parameters
Tags
Return values
string —form()
public
static form(mixed $object) : mixed
Parameters
- $object : mixed
Return values
mixed —getFieldDefinition()
public
static getFieldDefinition() : mixed
Return values
mixed —isSimpleControl()
public
static isSimpleControl() : mixed
Return values
mixed —isStatic()
Is this a Static Control? Used to determine if control has field data behind it
public
static isStatic() : bool
Return values
bool —name()
public
static name() : mixed
Return values
mixed —onRegister()
Event hook for when control is registered on a form
public
onRegister( &$form) : bool
Parameters
Return values
bool —onUnRegister()
Event hook for when control is un-registered (removed) on a form
public
onUnRegister( &$form) : bool
Parameters
Return values
bool —parseData()
Parse the control value for storage in database
public
static parseData(string $name, array<string|int, mixed> $values[, bool $for_db = false ]) : string
Parameters
- $name : string
- $values : array<string|int, mixed>
- $for_db : bool = false
Tags
Return values
string —templateFormat()
public
static templateFormat(mixed $db_data, mixed $ctl) : mixed
Parameters
- $db_data : mixed
- $ctl : mixed
Return values
mixed —toHTML()
Place the control in the form with label and description
public
toHTML( $label, $name) : string
Parameters
Return values
string —update()
public
static update(mixed $values, mixed $object) : mixed
Parameters
- $values : mixed
- $object : mixed
Return values
mixed —useGeneric()
Use the Generic Control instead? Used to determine if control is actually a generic control
public
static useGeneric() : bool