Référence de la classe Editor

Graphe d'héritage de Editor:

Fonctions membres publiques
	__construct ($editor='none')
	getState ()
	attach ($observer)
	detach ($observer)
	initialise ()
	display ($name, $html, $width, $height, $col, $row, $buttons=true, $id=null, $asset=null, $author=null, $params=array())
	save ($editor)
	getContent ($editor)
	setContent ($editor, $html)
	getButtons ($editor, $buttons=true)

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

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

Attributs protégés
	$_observers = array()
	$_state = null
	$_methods = array()
	$_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'

)

Constructor

Paramètres

string

$editor

The editor name

Références $editor.

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 Editor\$_name, $config, $name, $params, $path, Editor\initialise(), JPATH_PLUGINS, et null.

Référencé par Editor\display(), Editor\getContent(), Editor\save(), et Editor\setContent().

attach()

attach

(

$observer

)

Attach an observer object

Paramètres

array | object

$observer

An observer object to attach or an array with handler and event keys

Renvoie

void

Depuis

1.5

Références $check, $class, et $key.

detach()

detach

(

$observer

)

Detach an observer object

Paramètres

object

$observer

An observer object to detach.

Renvoie

boolean True if the observer object was detached.

Depuis

1.5

Références $key.

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 Editor\$asset, Editor\$author, $buttons, $height, $html, $id, $name, $params, $results, $return, $row, $width, Editor\_loadEditor(), 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, et $editor.

getContent()

getContent

(

$editor

)

Get the editor contents

Paramètres

string

$editor

The name of the editor control

Renvoie

string

Depuis

1.5

Obsolète:

4.0 Use Joomla.editors API, see core.js

Références $editor, $results, $return, et Editor\_loadEditor().

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(), et Factory\getEditor().

getState()

getState

(

)

Get the state of the Editor object

Renvoie

mixed The state of the object.

Depuis

1.5

Références Editor\$_state.

initialise()

initialise

(

)

Initialise the editor

Renvoie

void

Depuis

1.5

Obsolète:

4.0 This function will not load any custom tag from 4.0 forward, use JHtml::script

Références $document, $results, $return, getDocument, et null.

Référencé par Editor\_loadEditor().

save()

save

(

$editor

)

Save the editor content

Paramètres

string

$editor

The name of the editor control

Renvoie

string

Depuis

1.5

Obsolète:

4.0 Bind functionality to form submit through javascript

Références $editor, $results, $return, Editor\_loadEditor(), et null.

setContent()

setContent	(		$editor,
			$html
	)

Set the editor contents

Paramètres

string	$editor	The name of the editor control
string	$html	The contents of the text area

Renvoie

string

Depuis

1.5

Obsolète:

4.0 Use Joomla.editors API, see core.js

Références $editor, $html, $results, $return, et Editor\_loadEditor().

Documentation des champs

$_editor

$_editor = null

protected

$_methods

$_methods = array()

protected

$_name

$_name = null

protected

Référencé par Editor\_loadEditor().

$_observers

$_observers = array()

protected

$_state

$_state = null

protected

Référencé par Editor\getState().

$asset

$asset = null

protected

Référencé par Editor\display().

$author

$author = null

protected

Référencé par Editor\display().

$instances

$instances = array()

staticprotected

---

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

• Editor.php