Exponent v2.4.3
Back to top  

htmleditorcontrol

Extends \htmleditor

Text Editor Control - displays text area widget

package

Default

Methods

__construct

__construct( $default = "",  $rows = 5,  $cols = 38)
inherited

Arguments

$default

$rows

$cols

Place the editable control on the edit form

controlToHTML( $name,  $label) : string
inherited

Arguments

$name

$label

Response

string

Convert a foreign value to fit the exp control

convertData( $name,  $values) : string
inherited static
static

Arguments

$name

$values

Response

string

Create the Form to edit the control settings

form( $object)
inherited static

Arguments

$object

returns the table field definition for this control

getFieldDefinition() : array
inherited static
static

Response

array

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

isSimpleControl() : boolean
inherited static

Response

boolean

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

isStatic() : boolean
inherited static

Response

boolean

name

name()
inherited static

Event hook for when control is registered on a form

onRegister( &$form) : boolean
inherited

Arguments

$form

Response

boolean

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

onUnRegister( &$form) : boolean
inherited

Arguments

$form

Response

boolean

Parse the control value for storage in database

parseData(string $name, array $values, boolean $for_db = false) : string
inherited static
static

Arguments

$name

string

$values

array

$for_db

boolean

Response

string

Format the control's data for user display

templateFormat( $db_data,  $ctl) : string
inherited static

Arguments

$db_data

$ctl

Response

string

Place the control in the form with label and description

toHTML( $label,  $name) : string
inherited

Arguments

$label

$name

Response

string

Update the control settings

update( $values,  $object)
inherited static

Arguments

$values

$object

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

useGeneric() : boolean
inherited static

Response

boolean

Properties

module

module :
inherited

Type(s)

toolbar

toolbar :
inherited

Type(s)

placeholder

placeholder :
inherited

Type(s)

rows

rows :
inherited

Type(s)

cols

cols :
inherited

Type(s)

maxlength

maxlength :
inherited

Type(s)

id

id :
inherited

Type(s)

name

name :
inherited

Type(s)

accesskey

accesskey :
inherited

Type(s)

class

class :
inherited

Type(s)

default

default :
inherited

Type(s)

disabled

disabled :
inherited

Type(s)

required

required :
inherited

Type(s)

multiple

multiple :
inherited

Type(s)

flip

flip :
inherited

Type(s)

is_hidden

is_hidden :
inherited

Type(s)

focus

focus :
inherited

Type(s)

tabindex

tabindex :
inherited

Type(s)

inError

inError :
inherited

Type(s)

type

type :
inherited

Type(s)

horizontal

horizontal :
inherited

Type(s)

jsHooks

jsHooks :
inherited

Type(s)