Class JEditor

JEditor class to handle WYSIWYG editors

JObject

JEditor

Package: Joomla\Libraries\Editor
Copyright: Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
License: General Public License version 2 or later; see LICENSE.txt
Since: 1.5
Located at cms/editor/editor.php

Methods summary

`public`	# `__construct( string $editor = 'none' )` Constructor Constructor Parameters `$editor` `string` - $editor The editor name Overrides `JObject::__construct`
`public static JEditor`	# `getInstance( string $editor = 'none' )` Returns the global Editor object, only creating it if it doesn't already exist. Returns the global Editor object, only creating it if it doesn't already exist. Parameters `$editor` `string` - $editor The editor to use. Returns `JEditor` - The Editor object. Since 1.5
`public mixed`	# `getState( )` Get the state of the JEditor object Get the state of the JEditor object Returns `mixed` - The state of the object. Since 1.5
`public`	# `attach( array\|object $observer )` Attach an observer object Attach an observer object Parameters `$observer` `array\|object` - $observer An observer object to attach or an array with handler and event keys Since 1.5
`public boolean`	# `detach( object $observer )` Detach an observer object Detach an observer object Parameters `$observer` `object` - $observer An observer object to detach. Returns `boolean` - True if the observer object was detached. Since 1.5
`public`	# `initialise( )` Initialise the editor Initialise the editor Since 1.5
`public string`	# `display( string $name, string $html, string $width, string $height, integer $col, integer $row, boolean $buttons = true, string $id = null, string $asset = null, object $author = null, array $params = array() )` Display the editor area. Display the editor area. Parameters `$name` `string` - $name The control name. `$html` `string` - $html The contents of the text area. `$width` `string` - $width The width of the text area (px or %). `$height` `string` - $height The height of the text area (px or %). `$col` `integer` - $col The number of columns for the textarea. `$row` `integer` - $row The number of rows for the textarea. `$buttons` `boolean` - $buttons True and the editor buttons will be displayed. `$id` `string` - $id An optional ID for the textarea (note: since 1.6). If not supplied the name is used. `$asset` `string` - $asset The object asset `$author` `object` - $author The author. `$params` `array` - $params Associative array of editor parameters. Returns `string` Since 1.5
`public string`	# `save( string $editor )` Save the editor content Save the editor content Deprecated 4.0 Bind functionality to form submit through javascript Parameters `$editor` `string` - $editor The name of the editor control Returns `string` Since 1.5
`public string`	# `getContent( string $editor )` Get the editor contents Get the editor contents Deprecated 4.0 Use Joomla.editors API, see core.js Parameters `$editor` `string` - $editor The name of the editor control Returns `string` Since 1.5
`public string`	# `setContent( string $editor, string $html )` Set the editor contents Set the editor contents Deprecated 4.0 Use Joomla.editors API, see core.js Parameters `$editor` `string` - $editor The name of the editor control `$html` `string` - $html The contents of the text area Returns `string` Since 1.5
`public array`	# `getButtons( string $editor, mixed $buttons = true )` Get the editor extended buttons (usually from plugins) Get the editor extended buttons (usually from plugins) Parameters `$editor` `string` - $editor The name of the editor. `$buttons` `mixed` - $buttons Can be boolean or array, if boolean defines if the buttons are displayed, if array defines a list of buttons not to show. Returns `array` Since 1.5
`protected mixed`	# `_loadEditor( array $config = array() )` Load the editor Load the editor Parameters `$config` `array` - $config Associative array of editor config parameters Returns `mixed` Since 1.5

Methods inherited from JObject

__toString(), def(), get(), getError(), getErrors(), getProperties(), set(), setError(), setProperties()

Magic methods summary

Properties summary

`protected array`	`$_observers`	# An array of Observer objects to notify An array of Observer objects to notify Since 1.5
`protected mixed`	`$_state`	# The state of the observable object The state of the observable object Since 1.5
`protected array`	`$_methods`	# A multi dimensional array of [function][] = key for observers A multi dimensional array of [function][] = key for observers Since 1.5
`protected object`	`$_editor`	# Editor Plugin object Editor Plugin object Since 1.5
`protected string`	`$_name`	# Editor Plugin name Editor Plugin name Since 1.5
`protected string`	`$asset`	# Object asset Object asset Since 1.6
`protected string`	`$author`	# Object author Object author Since 1.6
`protected static JEditor[]`	`$instances`	# JEditor instances container. JEditor instances container. Since 2.5

Properties inherited from JObject

$_errors

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JEditor

Methods summary

Parameters

Overrides

Parameters

Returns

Since

Returns

Since

Parameters

Since

Parameters

Returns

Since

Since

Parameters

Returns

Since

Deprecated

Parameters

Returns

Since

Deprecated

Parameters

Returns

Since

Deprecated

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Methods inherited from JObject

Magic methods summary

Properties summary

Since

Since

Since

Since

Since

Since

Since

Since

Properties inherited from JObject