Search

Projects

Classes

Methods

⇦ Back to Joomla project (class list)

Class Editor - list of methods

Editor class to handle WYSIWYG editors
Package: Joomla\CMS\Editor
Copyright: (C) 2005 Open Source Matters, Inc.
License: GNU General Public License version 2 or later; see LICENSE.txt
Located at: Joomla/Editor/Editor.php
Project: Joomla

Method Summary

public
__construct
(mixed $editor = 'none', \Joomla\Event\DispatcherInterface $dispatcher = null)

Constructor
Parameters
  • string $editor The editor name
  • \Joomla\Event\DispatcherInterface $dispatcher The event dispatcher we're going to use
Show source code of this method: __construct Source Code

public static \Joomla\CMS\Editor\Editor
(mixed $editor = 'none')

Returns the global Editor object, only creating it if it doesn't already exist.
Parameters
  • string $editor The editor to use.
Returns
  • \Joomla\CMS\Editor\Editor The Editor object.
Since
  • 1.5
Show source code of this method: getInstance Source Code

public void
()

Initialise the editor
Returns
  • void
Since
  • 1.5
Show source code of this method: initialise Source Code

public string
(mixed $name, mixed $html, mixed $width, mixed $height, mixed $col, mixed $row, mixed $buttons = true, mixed $id = null, mixed $asset = null, mixed $author = null, mixed $params = array())

Display the editor area.
Parameters
  • string $name The control name.
  • string $html The contents of the text area.
  • string $width The width of the text area (px or %).
  • string $height The height of the text area (px or %).
  • int $col The number of columns for the textarea.
  • int $row The number of rows for the textarea.
  • bool $buttons True and the editor buttons will be displayed.
  • string $id An optional ID for the textarea (note: since 1.6). If not supplied the name is used.
  • string $asset The object asset
  • object $author The author.
  • array $params Associative array of editor parameters.
Returns
  • string
Since
  • 1.5
Show source code of this method: display Source Code

public array
(mixed $editor, mixed $buttons = true)

Get the editor extended buttons (usually from plugins)
Parameters
  • string $editor The name of the editor.
  • 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
Show source code of this method: getButtons Source Code

protected mixed
_loadEditor
(mixed $config = array())

Load the editor
Parameters
  • array $config Associative array of editor config parameters
Returns
  • mixed
Since
  • 1.5
Show source code of this method: _loadEditor Source Code

Properties Summary

protected object
$_editor
Editor Plugin object
Since
  • 1.5
protected string
$_name
Editor Plugin name
Since
  • 1.5
protected string
$asset
Object asset
Since
  • 1.6
protected string
$author
Object author
Since
  • 1.6
protected static \Joomla\CMS\Editor\Editor[]
$instances
Editor instances container.
Since
  • 2.5

Tags Summary

Since
1.5