Joomla CMS  3.10.11 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.10.11 et du framework Joomla Platform intégré
Référence de la classe PlgEditorCodemirror
+ Graphe d'héritage de PlgEditorCodemirror:

Fonctions membres publiques

 onInit ()
 
 onSave ($id)
 
 onGetContent ($id)
 
 onSetContent ($id, $content)
 
 onGetInsertMethod ()
 
 onDisplay ( $name, $content, $width, $height, $col, $row, $buttons=true, $id=null, $asset=null, $author=null, $params=array())
 

Fonctions membres protégées

 displayButtons ($name, $buttons, $asset, $author)
 
 getFontInfo ($font)
 
 loadKeyMap ($keyMap)
 

Attributs protégés

 $autoloadLanguage = true
 
 $modeAlias = array()
 

Description détaillée

CodeMirror Editor Plugin.

Depuis
1.6

Documentation des fonctions membres

◆ displayButtons()

displayButtons (   $name,
  $buttons,
  $asset,
  $author 
)
protected

Displays the editor buttons.

Paramètres
string$nameButton name.
mixed$buttons[array with button objects | boolean true to display buttons]
mixed$assetUnused.
mixed$authorUnused.
Renvoie
string HTML

Références $asset, $author, $buttons, $name, $results, et $return.

◆ getFontInfo()

getFontInfo (   $font)
protected

Gets font info from the json data file

Paramètres
string$fontA key from the $fonts array.
Renvoie
object

Références null.

◆ loadKeyMap()

loadKeyMap (   $keyMap)
protected

Loads a keyMap file

Paramètres
string$keyMapThe name of a keyMap file to load.
Renvoie
void

Références $basePath, et JDEBUG.

◆ onDisplay()

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

Display the editor area.

Paramètres
string$nameThe control name.
string$contentThe contents of the text area.
string$widthThe width of the text area (px or %).
string$heightThe height of the text area (px or %).
int$colThe number of columns for the textarea.
int$rowThe number of rows for the textarea.
boolean$buttonsTrue and the editor buttons will be displayed.
string$idAn optional ID for the textarea (note: since 1.6). If not supplied the name is used.
string$assetNot used.
object$authorNot used.
array$paramsAssociative array of editor parameters.
Renvoie
string HTML

Références $asset, $author, $buttons, $content, $dispatcher, $displayData, $height, $id, $name, $options, $params, $results, $row, $width, JEventDispatcher\getInstance(), et JDEBUG.

◆ onGetContent()

onGetContent (   $id)

Get the editor content.

Paramètres
string$idThe id of the editor field.
Renvoie
string Javascript
Obsolète:
4.0 Use directly the returned code

Références $id, et json_encode.

◆ onGetInsertMethod()

onGetInsertMethod ( )

Adds the editor specific insert method.

Renvoie
void
Obsolète:
4.0 Code is loaded in the init script

Références getDocument.

◆ onInit()

onInit ( )

Initialises the Editor.

Renvoie
void

Références $dispatcher, $displayData, $doc, getDocument, et JEventDispatcher\getInstance().

◆ onSave()

onSave (   $id)

Copy editor content to form field.

Paramètres
string$idThe id of the editor field.
Renvoie
string Javascript
Obsolète:
4.0 Code executes directly on submit

Références $id, et json_encode.

◆ onSetContent()

onSetContent (   $id,
  $content 
)

Set the editor content.

Paramètres
string$idThe id of the editor field.
string$contentThe content to set.
Renvoie
string Javascript
Obsolète:
4.0 Use directly the returned code

Références $content, $id, et json_encode.

Documentation des champs

◆ $autoloadLanguage

$autoloadLanguage = true
protected

◆ $modeAlias

$modeAlias = array()
protected

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