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 PlgEditorTinymce
+ Graphe d'héritage de PlgEditorTinymce:

Fonctions membres publiques

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

Fonctions membres publiques statiques

static getKnownButtons ()
 
static getToolbarPreset ()
 

Fonctions membres protégées statiques

static getGlobalFilters ()
 

Attributs protégés

 $_basePath = 'media/editors/tinymce'
 
 $autoloadLanguage = true
 
 $app = null
 

Fonctions membres privées

 _toogleButton ($name)
 
 tinyButtons ($name, $excluded)
 
 getPluginId ()
 
 onDisplayLegacy ( $name, $content, $width, $height, $col, $row, $buttons=true, $id=null, $asset=null, $author=null, $params=array())
 

Description détaillée

TinyMCE Editor Plugin

Depuis
1.5

Documentation des fonctions membres

◆ _toogleButton()

_toogleButton (   $name)
private

Get the toggle editor button

Paramètres
string$nameEditor name
Renvoie
string

Références $name.

◆ getGlobalFilters()

static getGlobalFilters ( )
staticprotected

Get the global text filters to arbitrary text as per settings for current user groups

Renvoie
JFilterInput
Depuis
3.6

Références $attributes, $config, $filter, $filters, $user, et elseif.

◆ getKnownButtons()

static getKnownButtons ( )
static

Return list of known TinyMCE buttons

Renvoie
array
Depuis
3.7.0

Références $buttons.

Référencé par JFormFieldTinymceBuilder\getLayoutData().

◆ getPluginId()

getPluginId ( )
private

Gets the plugin extension id.

Renvoie
int The plugin id.
Depuis
3.7.0

Références $db, et $query.

◆ getToolbarPreset()

static getToolbarPreset ( )
static

Return toolbar presets

Renvoie
array
Depuis
3.7.0

Référencé par JFormFieldTinymceBuilder\getLayoutData().

◆ 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 name of the editor area.
string$contentThe content of the field.
string$widthThe width of the editor area.
string$heightThe height of the editor area.
int$colThe number of columns for the editor area.
int$rowThe number of rows for the editor area.
boolean$buttonsTrue and the editor buttons will be displayed.
string$idAn optional ID for the textarea. If not supplied the name is used.
string$assetThe object asset
object$authorThe author.
array$paramsAssociative array of editor parameters.
Renvoie
string

Shrink the buttons if not on a mobile or if mobile view is off. If mobile view is on force into simple mode and enlarge the buttons

Références $app, $asset, $author, $buttons, $content, $db, $description, $doc, $editor, $filter, $height, $id, $lang, $language, $link, $name, $options, $params, $query, $row, $separator, $template, $title, $user, $width, HTMLHelper\_(), elseif, getDocument, JPATH_ROOT, JPATH_SITE, et null.

◆ onDisplayLegacy()

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

Display the editor area.

Paramètres
string$nameThe name of the editor area.
string$contentThe content of the field.
string$widthThe width of the editor area.
string$heightThe height of the editor area.
int$colThe number of columns for the editor area.
int$rowThe number of rows for the editor area.
boolean$buttonsTrue and the editor buttons will be displayed.
string$idAn optional ID for the textarea. If not supplied the name is used.
string$assetThe object asset
object$authorThe author.
array$paramsAssociative array of editor parameters.
Renvoie
string
Depuis
3.7.0
Obsolète:
4.0

Shrink the buttons if not on a mobile or if mobile view is off. If mobile view is on force into simple mode and enlarge the buttons

Références $app, $buttons, $content, $db, $description, $doc, $editor, $filter, $height, $id, $lang, $language, $link, $mode, $name, $options, $params, $query, $row, $template, $title, $user, $width, HTMLHelper\_(), elseif, getDocument, JPATH_ROOT, JPATH_SITE, json_encode, et null.

◆ onGetContent()

onGetContent (   $id)

TinyMCE WYSIWYG Editor - get the editor content

Paramètres
string$idThe name of the editor
Depuis
1.5
Renvoie
string
Obsolète:
4.0 Use directly the returned code

Références $id, et json_encode.

◆ onGetInsertMethod()

onGetInsertMethod (   $name)

Inserts html code into the editor

Paramètres
string$nameThe name of the editor
Depuis
1.5
Renvoie
string
Obsolète:
3.5 tinyMCE (API v4) will get the content automatically from the text area

◆ onInit()

onInit ( )

Initialises the Editor.

Renvoie
void
Depuis
1.5

◆ onSave()

onSave (   $id)

TinyMCE WYSIWYG Editor - copy editor content to form field

Paramètres
string$idThe name of the editor
Depuis
1.5
Renvoie
void
Obsolète:
4.0 Use directly the returned code

◆ onSetContent()

onSetContent (   $id,
  $html 
)

TinyMCE WYSIWYG Editor - set the editor content

Paramètres
string$idThe name of the editor
string$htmlThe html to place in the editor
Depuis
1.5
Renvoie
string
Obsolète:
4.0 Use directly the returned code

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

◆ tinyButtons()

tinyButtons (   $name,
  $excluded 
)
private

Get the XTD buttons and render them inside tinyMCE

Paramètres
string$namethe id of the editor field
string$excludedthe buttons that should be hidden
Renvoie
array

Références $button, $buttons, $href, $i, $icon, $name, $onclick, $options, $title, et null.

Documentation des champs

◆ $_basePath

$_basePath = 'media/editors/tinymce'
protected

Base path for editor files

Depuis
3.5

◆ $app

$app = null
protected

◆ $autoloadLanguage

$autoloadLanguage = true
protected

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