Référence de la classe Editor

Graphe d'héritage de Editor:

Fonctions membres publiques
	__construct ($editor='none', DispatcherInterface $dispatcher=null)
	initialise ()
	display ($name, $html, $width, $height, $col, $row, $buttons=true, $id=null, $asset=null, $author=null, $params=array())
	getButtons ($editor, $buttons=true)
Fonctions membres publiques hérités de DispatcherAwareInterface
	setDispatcher (DispatcherInterface $dispatcher)

Fonctions membres publiques statiques
static	getInstance ($editor='none')

Fonctions membres protégées
	_loadEditor ($config=array())

Attributs protégés
	$_editor = null
	$_name = null
	$asset = null
	$author = null

Attributs protégés statiques
static	$instances = array()

Description détaillée

Editor class to handle WYSIWYG editors

Depuis

1.5

Documentation des constructeurs et destructeur

__construct()

__construct	(		$editor = 'none',
		DispatcherInterface	$dispatcher = null
	)

Constructor

Paramètres

string	$editor	The editor name
DispatcherInterface	$dispatcher	The event dispatcher we're going to use

Références $buttons, $editor, $result, AbstractEvent\getArgument(), Factory\getContainer(), Joomla\CMS\Application\getDispatcher(), null, et Joomla\Event\setDispatcher().

Documentation des fonctions membres

_loadEditor()

_loadEditor (   $config = array() )

protected

Load the editor

Paramètres

array

$config

Associative array of editor config parameters

Renvoie

mixed

Depuis

1.5

Références $config, $name, $params, $path, Text\_(), Log\add(), Joomla\CMS\Application\getDispatcher(), InputFilter\getInstance(), PluginHelper\getPlugin(), PluginHelper\importPlugin(), JPATH_PLUGINS, null, et Log\WARNING.

display()

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

Display the editor area.

Paramètres

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 %).
integer	$col	The number of columns for the textarea.
integer	$row	The number of rows for the textarea.
boolean	$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.

Renvoie

string

Depuis

1.5

Références $author, $buttons, $height, $html, $id, $name, $params, $width, Text\_(), Factory\getApplication(), et null.

getButtons()

getButtons	(		$editor,
			$buttons = true
	)

Get the editor extended buttons (usually from plugins)

Paramètres

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.

Renvoie

array

Depuis

1.5

Références $button, $buttons, $className, $editor, $result, Joomla\CMS\Application\getDispatcher(), PluginHelper\getPlugin(), et PluginHelper\importPlugin().

getInstance()

static getInstance (   $editor = 'none' )

static

Returns the global Editor object, only creating it if it doesn't already exist.

Paramètres

string

$editor

The editor to use.

Renvoie

Editor The Editor object.

Depuis

1.5

Références $editor.

Référencé par EditorField\getEditor().

initialise()

initialise

(

)

Initialise the editor

Renvoie

void

Depuis

1.5

Références null.

Documentation des champs

$_editor

$_editor = null

protected

$_name

$_name = null

protected

$asset

$asset = null

protected

$author

$author = null

protected

$instances

$instances = array()

staticprotected

---

La documentation de cette classe a été générée à partir du fichier suivant :

• Editor.php