Class cWYSIWYGEditor

Base class for all WYSIWYG editors

Direct known subclasses

Abstract
Package: Core\Backend
Copyright: four for business AG <www.4fb.de>
License: http://www.contenido.org/license/LIZENZ.txt
Author: Timo Hummel
Located at classes/class.wysiwyg_editor.php

Methods summary
`public`	# `__construct( string $editorName, string $editorContent )` Constructor to create an instance of this class. Constructor to create an instance of this class. Parameters `$editorName` `string` $editorName `$editorContent` `string` $editorContent
`protected`	# `_setEditorContent( string $sEditorContent )` Parameters `$sEditorContent` `string` $sEditorContent
`protected`	# `_setEditor( string $sEditor )` Parameters `$sEditor` `string` $sEditor
`public`	# `setSetting( string $type, string $key, boolean $value, boolean $forceSetting = false )` Sets given setting if setting was not yet defined. Overwriting defined setting can be achieved with $forceSetting = true. Sets given setting if setting was not yet defined. Overwriting defined setting can be achieved with $forceSetting = true. Parameters `$type` `string` $key of setting to set `$key` `string` $value of setting to set `$value` `boolean` $forceSetting [optional] to overwrite defined setting `$forceSetting` `boolean` $type Normally unused (counterpart of cTinyMCE4Editor::setSetting)
`protected`	# `_unsetSetting( string $key )` Parameters `$key` `string` $key
`protected string`	# `_getEditorPath( )` Returns `string`
`protected`	# `_setEditorName( string $sEditorName )` Parameters `$sEditorName` `string` $sEditorName
`protected`	# `getScripts( )` Throws `cBadMethodCallException` if this method is not overridden in the subclass
`protected`	# `getEditor( )` Throws `cBadMethodCallException` if this method is not overridden in the subclass
`public static string`	# `getCurrentWysiwygEditorName( )` Find out which WYSIWYG editor is currently chosen Find out which WYSIWYG editor is currently chosen Returns `string` The name of current WYSIWYG editor
`public static array`	# `saveConfig( array $config )` 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. 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`

Properties summary
`protected static string`	`$_configPrefix`	`'[\'wysiwyg\']'`	# Access key under which the wysiwyg editor settings will be stored Access key under which the wysiwyg editor settings will be stored
`protected string`	`$_sPath`		#
`protected string`	`$_sEditor`		#
`protected string`	`$_sEditorName`		#
`protected string`	`$_sEditorContent`		#
`protected array`	`$_aSettings`		#

Packages

Classes

Functions

Class cWYSIWYGEditor

Direct known subclasses

Parameters

Parameters

Parameters

Parameters

Parameters

Returns

Parameters

Throws

Throws

Returns

Parameters

Returns

Throws