Exponent v2.7.2

htmleditor extends texteditorcontrol
in package

HTML Editor Control - displays wysiwyg editor widget

Tags
subpackage

Control

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
Create the Form to edit the control settings
getFieldDefinition()  : array<string|int, mixed>
returns the table field definition for this control
isSimpleControl()  : bool
Is this a Simple Control? Used to determine if control is available for the Forms (design) module
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()  : mixed
templateFormat()  : string
Format the control's data for user display
toHTML()  : string
Place the control in the form with label and description
update()  : mixed
Update the control settings
useGeneric()  : bool
Use the Generic Control instead? Used to determine if control is actually a generic control

Properties

$horizontal_top

public mixed $horizontal_top = \false

Methods

__construct()

public __construct([mixed $default = "" ][, mixed $module = "" ][, mixed $rows = 20 ][, mixed $cols = 60 ][, mixed $toolbar = "" ][, mixed $height = 300 ]) : mixed
Parameters
$default : mixed = ""
$module : mixed = ""
$rows : mixed = 20
$cols : mixed = 60
$toolbar : mixed = ""
$height : mixed = 300
Return values
mixed

__get()

Generic magic method

public __get( $property) : null
Parameters
$property :
Return values
null

__isset()

Generic magic method

public __isset( $property) : bool
Parameters
$property :
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
$property :
$value :
Return values
mixed

__unset()

Generic magic method

public __unset( $property) : mixed
Parameters
$property :
Return values
mixed

controlToHTML()

Place the editable control on the edit form

public controlToHTML(mixed $name, mixed $label) : string
Parameters
$name : mixed
$label : mixed
Return values
string

convertData()

Convert a foreign value to fit the exp control

public static convertData( $name,  $values) : string
Parameters
$name :
$values :
Tags
static
Return values
string

form()

Create the Form to edit the control settings

public static form( $object) : mixed
Parameters
$object :
Return values
mixed

getFieldDefinition()

returns the table field definition for this control

public static getFieldDefinition() : array<string|int, mixed>
Tags
static
Return values
array<string|int, mixed>

isSimpleControl()

Is this a Simple Control? Used to determine if control is available for the Forms (design) module

public static isSimpleControl() : bool
Return values
bool

isStatic()

Is this a Static Control? Used to determine if control has field data behind it

public static isStatic() : bool
Return values
bool

onRegister()

Event hook for when control is registered on a form

public onRegister( &$form) : bool
Parameters
$form :
Return values
bool

onUnRegister()

Event hook for when control is un-registered (removed) on a form

public onUnRegister( &$form) : bool
Parameters
$form :
Return values
bool

parseData()

public static parseData(mixed $name, mixed $values[, mixed $for_db = false ]) : mixed
Parameters
$name : mixed
$values : mixed
$for_db : mixed = false
Return values
mixed

templateFormat()

Format the control's data for user display

public static templateFormat( $db_data,  $ctl) : string
Parameters
$db_data :
$ctl :
Return values
string

toHTML()

Place the control in the form with label and description

public toHTML( $label,  $name) : string
Parameters
$label :
$name :
Return values
string

update()

Update the control settings

public static update( $values,  $object) : mixed
Parameters
$values :
$object :
Return values
mixed

useGeneric()

Use the Generic Control instead? Used to determine if control is actually a generic control

public static useGeneric() : bool
Return values
bool

Search results