Overview

Packages

  • CONTENIDO
  • Core
    • Authentication
    • Backend
    • Cache
    • CEC
    • Chain
    • ContentType
    • Database
    • Debug
    • Exception
    • Frontend
      • Search
      • URI
      • Util
    • GenericDB
      • Model
    • GUI
      • HTML
    • I18N
    • LayoutHandler
    • Log
    • Security
    • Session
    • Util
    • Validation
    • Versioning
    • XML
  • Module
    • ContentRssCreator
    • ContentSitemapHtml
    • ContentSitemapXml
    • ContentUserForum
    • NavigationTop
    • ScriptCookieDirective
  • mpAutoloaderClassMap
  • None
  • Plugin
    • ContentAllocation
    • CronjobOverview
    • FormAssistant
    • FrontendLogic
    • FrontendUsers
    • Linkchecker
    • ModRewrite
    • Newsletter
    • Repository
      • FrontendNavigation
      • KeywordDensity
    • SearchSolr
    • SmartyWrapper
    • UrlShortener
    • UserForum
    • Workflow
  • PluginManager
  • Setup
    • Form
    • GUI
    • Helper
      • Environment
      • Filesystem
      • MySQL
      • PHP
    • UpgradeJob

Classes

  • cAjaxRequest
  • cAutoload
  • cBackend
  • cEffectiveSetting
  • cGuiScrollListAlltranslations
  • cHTMLValidator
  • cMailer
  • cModuleFileTranslation
  • cModuleHandler
  • cModuleSearch
  • cModuleSynchronizer
  • cModuleTemplateHandler
  • CodeMirror
  • cPasswordRequest
  • cPermission
  • cRegistry
  • cSystemPurge
  • cSystemtest
  • cTinymce4Configuration
  • cTinyMCE4Editor
  • cTinyMCEEditor
  • cWYSIWYGEditor
  • FrontendList
  • HtmlParser
  • TODOBackendList
  • TreeItem
  • UploadList
  • UploadSearchResultList

Functions

  • addArtspec
  • addSortImages
  • backToMainArea
  • buildArticleSelect
  • buildCategorySelect
  • buildCategorySelectRights
  • buildHeapTable
  • buildStackString
  • buildTree
  • buildUserOrGroupPermsFromRequest
  • callPluginStore
  • cApiCatGetLevelNode
  • cApiImageCheckCachedImageValidity
  • cApiImageCheckImageEditingPosibility
  • cApiImageGetCacheFileName
  • cApiImageGetTargetDimensions
  • cApiImageIsAnimGif
  • cApiImgScale
  • cApiImgScaleGetMD5CacheFile
  • cApiImgScaleHQ
  • cApiImgScaleImageMagick
  • cApiImgScaleLQ
  • cApiIsImageMagickAvailable
  • cApiStrCleanURLCharacters
  • cApiStrNormalizeLineEndings
  • cApiStrRecodeString
  • cApiStrReplaceDiacritics
  • cApiStrTrimAfterWord
  • cApiStrTrimHard
  • cApiStrTrimSentence
  • cDeprecated
  • cDie
  • cError
  • checkLangInClients
  • checkPathInformation
  • cInclude
  • compareUrlStrings
  • conChangeTemplateForCat
  • conCopyArticle
  • conCopyArtLang
  • conCopyContainerConf
  • conCopyContent
  • conCopyMetaTags
  • conCopyTemplateConfiguration
  • conCreateLocationString
  • conDeeperCategoriesArray
  • conDeleteart
  • conEditArt
  • conEditFirstTime
  • conFetchCategoryTree
  • conFlagOnOffline
  • conGenerateCode
  • conGenerateCodeForAllArts
  • conGenerateCodeForAllArtsInCategory
  • conGenerateCodeForAllartsUsingLayout
  • conGenerateCodeForAllartsUsingMod
  • conGenerateCodeForAllArtsUsingTemplate
  • conGenerateCodeForArtInAllCategories
  • conGenerateCodeForClient
  • conGenerateKeywords
  • conGetAvailableMetaTagTypes
  • conGetCategoryArticleId
  • conGetCategoryAssignments
  • conGetContainerConfiguration
  • conGetContentFromArticle
  • conGetHtmlTranslationTable
  • conGetMetaValue
  • conGetTemplateConfigurationIdForArticle
  • conGetTemplateConfigurationIdForCategory
  • conGetTopmostCat
  • conGetUsedModules
  • conHtmlentities
  • conHtmlEntityDecode
  • conHtmlSpecialChars
  • conIsLocked
  • conLock
  • conLockBulkEditing
  • conMakeArticleIndex
  • conMakeCatOnline
  • conMakeInlineScript
  • conMakeOnline
  • conMakeOnlineBulkEditing
  • conMakePublic
  • conMakeStart
  • conMoveArticles
  • conPhp54Check
  • conRemoveOldCategoryArticle
  • conSaveContentEntry
  • conSetCodeFlag
  • conSetCodeFlagBulkEditing
  • conSetMetaValue
  • conSyncArticle
  • copyRightsForElement
  • createBulkEditingFunction
  • createRandomName
  • createRightsForElement
  • cWarning
  • dbGetColumns
  • dbGetIndexes
  • dbGetPrimaryKeyName
  • dbTableExists
  • dbUpgradeTable
  • defineIfNotDefined
  • deleteArtspec
  • deleteRightsForElement
  • deleteSystemProperty
  • displayDatetime
  • emptyLogFile
  • endAndLogTiming
  • extractNumber
  • generateDisplayFilePath
  • generateJs
  • getAllClientsAndLanguages
  • getArtLang
  • getArtspec
  • getAvailableContentTypes
  • getCanonicalDay
  • getCanonicalMonth
  • getDirectorySize
  • getEffectiveSetting
  • getEffectiveSettingsByType
  • getEncodingByLanguage
  • getFileContents
  • getFileInformation
  • getFileType
  • getGroupOrUserName
  • getIDForArea
  • getJsHelpContext
  • getLanguageNamesByClient
  • getLanguagesByClient
  • getmicrotime
  • getNamedFrame
  • getParam
  • getParentAreaId
  • getSearchResults
  • getStrExpandCollapseButton
  • getSystemProperties
  • getSystemPropertiesByType
  • getSystemProperty
  • getTemplateSelect
  • getUplExpandCollapseButton
  • htmldecode
  • htmlentities_iso88592
  • humanReadableSize
  • includePlugins
  • insertEmptyStrRow
  • ipMatch
  • isAlphanumeric
  • isArchive
  • isArtInMultipleUse
  • isFunctionDisabled
  • isGroup
  • isIPv4
  • isRunningFromWeb
  • isStartArticle
  • isUtf8
  • isValidMail
  • langActivateDeactivateLanguage
  • langDeleteLanguage
  • langEditLanguage
  • langGetTextDirection
  • langNewLanguage
  • langRenameLanguage
  • layDeleteLayout
  • layEditLayout
  • machineReadableSize
  • mailLogBulkEditingFunctions
  • mailLogDecodeAddresses
  • markSubMenuItem
  • mask
  • modDeleteModule
  • modEditModule
  • phpInfoToHtml
  • plugin_include
  • prCreateURLNameLocationString
  • prDeleteCacheFileContent
  • prGetCacheFileContent
  • prResolvePathViaCategoryNames
  • prResolvePathViaURLNames
  • prWriteCacheFileContent
  • putFileContents
  • recursiveCopy
  • removeFileInformation
  • renderBackendBreadcrumb
  • renderLabel
  • renderSelectProperty
  • renderTextProperty
  • saveGroupRights
  • saveRights
  • scanDirectory
  • scanPlugins
  • sendEncodingHeader
  • set_magic_quotes_gpc
  • setArtspecDefault
  • setArtspecOnline
  • setSystemProperty
  • showTree
  • startTiming
  • statCreateLocationString
  • statDisplayTopChooser
  • statDisplayYearlyTopChooser
  • statGetAvailableMonths
  • statGetAvailableYears
  • statResetStatistic
  • statsArchive
  • statsDisplayInfo
  • statsOverviewAll
  • statsOverviewTop
  • statsOverviewTopYear
  • statsOverviewYear
  • strAssignTemplate
  • strBuildSqlValues
  • strCheckTreeForErrors
  • strCopyCategory
  • strCopyTree
  • strDeeperCategoriesArray
  • strDeleteCategory
  • strHasArticles
  • strHasStartArticle
  • strMakePublic
  • strMakeVisible
  • strMoveCatTargetallowed
  • strMoveDownCategory
  • strMoveSubtree
  • strMoveUpCategory
  • strNewCategory
  • strNewTree
  • strNextBackwards
  • strNextDeeper
  • strNextDeeperAll
  • strNextPost
  • strOrderedPostTreeList
  • strRemakeTreeTable
  • strRenameCategory
  • strRenameCategoryAlias
  • strSortPrePost
  • strSyncCategory
  • systemHavePerm
  • tplAutoFillModules
  • tplBrowseLayoutForContainers
  • tplcfgDuplicate
  • tplDeleteTemplate
  • tplDuplicateTemplate
  • tplEditTemplate
  • tplGetContainerDefault
  • tplGetContainerMode
  • tplGetContainerName
  • tplGetContainerNumbersInLayout
  • tplGetContainerTypes
  • tplGetInUsedData
  • tplIsTemplateInUse
  • tplPreparseLayout
  • tplProcessSendContainerConfiguration
  • updateClientCache
  • updateFileInformation
  • uplCreateFriendlyName
  • uplDirectoryListRecursive
  • uplGetDirectoriesToExclude
  • uplGetFileExtension
  • uplGetFileIcon
  • uplGetFileTypeDescription
  • uplGetThumbnail
  • uplHasFiles
  • uplHasSubdirs
  • uplmkdir
  • uplRecursiveDBDirectoryList
  • uplRecursiveDirectoryList
  • uplRenameDirectory
  • uplSearch
  • uplSyncDirectory
  • uplSyncDirectoryDBFS
  • Overview
  • Package
  • Class
  • Tree
  • Deprecated
  • Todo

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
Extended by 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 $sEditorName, string $sEditorContent )

Parameters

$sEditorName
string
$sEditorName
$sEditorContent
string
$sEditorContent

Overrides

cWYSIWYGEditor::__construct()
public
# convertFormat( mixed $sInput )
public
# setUserDefinedStyles( mixed $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( mixed $cmsType, mixed $sMode = "" )

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"

public
# cleanURLs( mixed $cmsType )
public
# addPath( mixed $sFile )
public
# setBaseURL( mixed $sBaseUrl )
public
# _getScripts( )

Throws

cBadMethodCallException
if this method is not overridden in the subclass

Overrides

cWYSIWYGEditor::_getScripts()
public
# _getEditor( )

Throws

cBadMethodCallException
if this method is not overridden in the subclass

Overrides

cWYSIWYGEditor::_getEditor()
protected
# _setSetting( string $sType, string $sKey, string $sValue, boolean $bForceSetting = 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

$sType
string
$sType CMS type where setting should apply
$sKey
string
$sKey of setting to set
$sValue
string
$sValue of setting to set
$bForceSetting
boolean
$bForceSetting to overwrite defined setting

Overrides

cWYSIWYGEditor::_setSetting()
protected
# _unsetSetting( )

Variadic function to unset a setting using multiple key values

Variadic function to unset a setting using multiple key values

Overrides

cWYSIWYGEditor::_unsetSetting()
public
# getConfigInlineEdit( )
public
# getConfigFullscreen( )
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 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
Array with configuration values for the current WYSIWYG editor to save

Returns

array
Array with values that were not accepted

Overrides

cWYSIWYGEditor::saveConfig()
Methods inherited from cWYSIWYGEditor
_getEditorPath(), _setEditor(), _setEditorContent(), _setEditorName(), getCurrentWysiwygEditorName()
Properties summary
private mixed $_sBaseURL
#

Stores base url of page

Stores base url of page

private boolean $_bUseGZIP 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 $_sConfigPrefix '[\'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
CMS CONTENIDO 4.9.8 API documentation generated by ApiGen 2.8.0