Editor
Implements \Joomla\Event\DispatcherAwareInterfaceEditor class to handle WYSIWYG editors
| since |
1.5 |
|---|---|
| package |
Joomla CMS |
Methods
__construct
Constructor
__construct(string editor = 'none', \Joomla\Event\DispatcherInterface dispatcher = null) : mixed
Arguments
- editor
stringThe editor name- dispatcher
\Joomla\Event\DispatcherInterfaceThe event dispatcher we're going to use
Response
mixed
_loadEditor
Load the editor
_loadEditor(array config = array()) : mixed
| since |
1.5 |
|---|
Arguments
- config
arrayAssociative array of editor config parameters
Response
mixed
display
Display the editor area.
display(string name, string html, string width, string height, int col, int row, bool buttons = true, string id = null, string asset = null, object author = null, array params = array()) : string
| 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
arrayAssociative array of editor parameters.
Response
string
getButtons
Get the editor extended buttons (usually from plugins)
getButtons(string editor, mixed buttons = true) : array
| 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
getInstance
Returns the global Editor object, only creating it if it doesn't already exist.
getInstance(string editor = 'none') : \Joomla\CMS\Editor\Editor
| since |
1.5 |
|---|
Arguments
- editor
stringThe editor to use.
Response
\Joomla\CMS\Editor\EditorThe Editor object.
initialise
Initialise the editor
initialise() : void
| since |
1.5 |
|---|