Référence de la classe JEditor

Graphe d'héritage de JEditor:

Graphe de collaboration de JEditor:

Liste de tous les membres

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 inherited from JObject
	__toString ()
	def ($property, $default=null)
	get ($property, $default=null)
	getProperties ($public=true)
	getError ($i=null, $toString=true)
	getErrors ()
	set ($property, $value=null)
	setProperties ($properties)
	setError ($error)
	toString ()

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 inherited from JObject
	$_errors = array()

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

---

Documentation des constructeurs et destructeur

JEditor::__construct

(

$editor = 'none'

)

Constructor

Paramètres:

string

$editor

The editor name

Réimplémentée à partir de JObject.

---

Documentation des fonctions membres

JEditor::_loadEditor (   $config = array() )

protected

Load the editor

Paramètres:

array

$config

Associative array of editor config paramaters

Renvoie:

mixed

Depuis:

11.1

Références $config, $message, $name, $params, $path, JText\_(), JFile\exists(), JFilterInput\getInstance(), JPluginHelper\getPlugin(), JPluginHelper\importPlugin(), jimport(), JPATH_PLUGINS, et JError\raiseWarning().

Voici le graphe d'appel pour cette fonction :

JEditor::attach

(

$observer

)

Attach an observer object

Paramètres:

object

$observer

An observer object to attach

Renvoie:

void

Depuis:

11.1

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

JEditor::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:

11.1

Références $key.

JEditor::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:

11.1

Références $asset, $author, $buttons, $height, $html, $id, $name, $params, $return, $row, $width, et null.

JEditor::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:

11.1

Références $buttons, JPluginHelper\getPlugin(), et JPluginHelper\importPlugin().

Voici le graphe d'appel pour cette fonction :

JEditor::getContent

(

$editor

)

Get the editor contents

Paramètres:

string

$editor

The name of the editor control

Renvoie:

string

Depuis:

11.1

Références $return.

static JEditor::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:

object JEditor The Editor object.

Depuis:

11.1

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

Voici le graphe des appelants de cette fonction :

JEditor::getState

(

)

Get the state of the JEditor object

Renvoie:

mixed The state of the object.

Depuis:

11.1

JEditor::initialise

(

)

Initialise the editor

Renvoie:

void

Depuis:

11.1

Références $return, et JFactory\getDocument().

Voici le graphe d'appel pour cette fonction :

JEditor::save

(

$editor

)

Save the editor content

Paramètres:

string

$editor

The name of the editor control

Renvoie:

string

Depuis:

11.1

Références $return.

JEditor::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:

11.1

Références $html, et $return.

---

Documentation des données membres

JEditor::$_editor = null

protected

JEditor::$_methods = array()

protected

JEditor::$_name = null

protected

JEditor::$_observers = array()

protected

JEditor::$_state = null

protected

JEditor::$asset = null

protected

JEditor::$author = null

protected

JEditor::$instances = array()

staticprotected

---

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

• html/editor.php