Editor
Implements DispatcherAwareInterfaceEditor class to handle WYSIWYG editors
| since |
1.5 |
|---|---|
| package |
Joomla CMS |
Methods
__construct
Constructor
__construct( editor = 'none', \Joomla\Event\DispatcherInterface dispatcher = null) :
Arguments
- editor
stringThe editor name- dispatcher
DispatcherInterfaceThe event dispatcher we're going to use
Response
mixed
_loadEditor
Load the editor
_loadEditor(mixed||string|int config = []) :
| since |
1.5 |
|---|
Arguments
- config
array<string|int, mixed>Associative array of editor config parameters
Response
mixed
display
Display the editor area.
display( name, html, width, height, col, row, buttons = true, id = null, asset = null, author = null, mixed||string|int params = []) :
| since |
1.5 |
|---|
Arguments
- name
stringThe control name.- html
stringThe contents of the text area.- width
stringThe width of the text area (px or %).- height
stringThe height of the text area (px or %).- col
intThe number of columns for the textarea.- row
intThe number of rows for the textarea.- buttons
boolTrue and the editor buttons will be displayed.- id
stringAn optional ID for the textarea (note: since 1.6). If not supplied the name is used.- asset
stringThe object asset- author
objectThe author.- params
array<string|int, mixed>Associative array of editor parameters.
Response
string
getButtons
Get the editor extended buttons (usually from plugins)
getButtons( editor, buttons = true) : mixed||string|int
| since |
1.5 |
|---|
Arguments
- editor
stringThe name of the editor.- buttons
mixedCan be boolean or array, if boolean defines if the buttons are displayed, if array defines a list of buttons not to show.
Response
array<string|int, mixed>
getInstance
Returns the global Editor object, only creating it if it doesn't already exist.
getInstance( editor = 'none') : \Joomla\CMS\Editor\Editor
initialise
Initialise the editor
initialise() :
| since |
1.5 |
|---|
Response
void
Properties
_editor
Editor Plugin object
| since |
1.5 |
|---|
Type(s)
object
_name
Editor Plugin name
| since |
1.5 |
|---|
Type(s)
string
asset
Object asset
| since |
1.6 |
|---|
Type(s)
string
author
Object author
| since |
1.6 |
|---|
Type(s)
string