Class cTinyMCE4Editor

The object cTinyMCE4Editor is a wrapper class to the TinyMCE WYSIWYG Editor.

Attributes can be defined to generate JavaScript options and functions to initialise the global tinymce object in file ./contenido/external/wysiwyg/tinymce4/contenido/templates/template.tinymce_tpl.html.

All settings accepted by tinyMCE and its plugins may be specified using system, client, group or user property/setting.

The following parameters will be always set on initialization (even, if they have been specified as property. They can be set using setSetting later on, if needed):

document_base_url
cleanup_callback (-> XHTML)
file_browser_callback
external_link_list_url
external_image_list_url

The following settings are only used in CONTENIDO:

contenido_toolbar_mode: full, simple, mini, custom
contenido_lists: link,image
contenido_height_html
contenido_height_head

See backend.customizing.html for details

cWYSIWYGEditor

cTinyMCE4Editor

Package: Core\Backend
Copyright: four for business AG <www.4fb.de>
License: http://www.contenido.org/license/LIZENZ.txt
Author: Thomas Stauer
Located at external/wysiwyg/tinymce4/contenido/classes/class.tinymce4.editor.php

Methods summary
`public`	# `__construct( string $editorName, string $editorContent )` Parameters `$editorName` `string` $editorName `$editorContent` `string` $editorContent Overrides `cWYSIWYGEditor::__construct()`
`public string`	# `convertFormat( string $sInput )` Parameters `$sInput` `string` $sInput Returns `string`
`public`	# `setUserDefinedStyles( string $sType )` Parameters `$sType` `string` $sType
`public`	# `setLists( string $sType )` The special name "contenido_lists" The special name "contenido_lists" Parameters `$sType` `string` $sType CMS type where XHTML mode setting wil be applies
`public`	# `setXHTMLMode( string $sType, string $bEnabled = true )` Turn XHTML mode on or off Turn XHTML mode on or off Parameters `$sType` `string` $sType CMS type where XHTML mode setting wil be applies `$bEnabled` `string` $bEnabled Whether to turn on XHTML mode
`private`	# `setGZIPMode( string $bEnabled = true )` Set if editor should be loaded using tinymce4's gzip compression Set if editor should be loaded using tinymce4's gzip compression Parameters `$bEnabled` `string` $bEnabled
`public boolean`	# `getGZIPMode( )` Returns `boolean` if editor is loaded using gzip compression
`public`	# `setToolbar( string $cmsType, string $mode = "" )` For compatibility also accepts "tinymce-toolbar-mode", "tinymce-toolbar1-3" and "tinymce4-plugins". For compatibility also accepts "tinymce-toolbar-mode", "tinymce-toolbar1-3" and "tinymce4-plugins". Parameters `$cmsType` `string` $cmsType `$mode` `string` $mode
`public`	# `cleanURLs( string $cmsType )` Parameters `$cmsType` `string` $cmsType
`public string`	# `addPath( string $file )` Parameters `$file` `string` $file Returns `string`
`public`	# `setBaseURL( string $baseUrl )` Parameters `$baseUrl` `string` $baseUrl
`public string`	# `getScripts( )` Returns `string` Throws `cBadMethodCallException` if this method is not overridden in the subclass Overrides `cWYSIWYGEditor::getScripts()`
`public string`	# `getEditor( )` Returns `string` Throws `cBadMethodCallException` if this method is not overridden in the subclass Overrides `cWYSIWYGEditor::getEditor()`
`public`	# `setSetting( string $type, string $key, string $value, boolean $forceSetting = false )` Sets given setting if setting was not yet defined. Overwriting defined setting can be achieved with $bForceSetting = true. Sets given setting if setting was not yet defined. Overwriting defined setting can be achieved with $bForceSetting = true. Parameters `$type` `string` $type CMS type where setting should apply `$key` `string` $key of setting to set `$value` `string` $value of setting to set `$forceSetting` `boolean` $forceSetting to overwrite defined setting Overrides `cWYSIWYGEditor::setSetting()`
`protected`	# `_unsetSetting( string $key = '' )` Variadic function to unset a setting using multiple key values. Variadic function to unset a setting using multiple key values. Parameters `$key` `string` $key Normaly unused (counterpart of cWYSIWYGEditor::_unsetSetting) Overrides `cWYSIWYGEditor::_unsetSetting()`
`public string`	# `getConfigInlineEdit( )` Returns `string`
`public array`	# `getConfigFullscreen( )` Returns `array`
`public string`	# `getPlugins( )` Function to obtain a comma separated list of plugins that are tried to be loaded. Function to obtain a comma separated list of plugins that are tried to be loaded. Returns `string` plugins the plugins
`public string`	# `getThemes( )` Function to obtain a comma separated list of themes that are tried to be loaded. Function to obtain a comma separated list of themes that are tried to be loaded. Returns `string` themes the themes
`public static array`	# `saveConfig( array $config )` Saves configuration of WYSIWYG editor into a file. Saves configuration of WYSIWYG editor into a file. This function does not validate input! This has to be done by classes that extend cWYSIWYGEditor because this class does not know what each WYSIWYG editor expects. Parameters `$config` `array` $config Array with configuration values for the current WYSIWYG editor to save Returns `array` Array with values that were not accepted Throws `cInvalidArgumentException` Overrides `cWYSIWYGEditor::saveConfig()`

Methods inherited from cWYSIWYGEditor
`_getEditorPath(), _setEditor(), _setEditorContent(), _setEditorName(), getCurrentWysiwygEditorName()`

Properties summary
`private string`	`$_baseURL`		# Stores base url of page Stores base url of page
`private boolean`	`$_useGZIP`	`false`	# Stores, if GZIP compression will be used Stores, if GZIP compression will be used
`private array`	`$_cmsTypes`	`array()`	# Shortcut to content types tinymce is mapped to Shortcut to content types tinymce is mapped to
`protected static string`	`$_configPrefix`	`'[\'wysiwyg\'][\'tinymce4\']'`	# Access key under which the wysiwyg editor settings will be stored Access key under which the wysiwyg editor settings will be stored

Properties inherited from cWYSIWYGEditor
`$_aSettings, $_sEditor, $_sEditorContent, $_sEditorName, $_sPath`

Packages

Classes

Functions

Class cTinyMCE4Editor

Parameters

Overrides

Parameters

Returns

Parameters

Parameters

Parameters

Parameters

Returns

Parameters

Parameters

Parameters

Returns

Parameters

Returns

Throws

Overrides

Returns

Throws

Overrides

Parameters

Overrides

Parameters

Overrides

Returns

Returns

Returns

Returns

Parameters

Returns

Throws

Overrides