TYPO3  7.6
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
RichTextElement Class Reference
Inheritance diagram for RichTextElement:
AbstractFormElement AbstractNode NodeInterface

Public Member Functions

 render ()
 
- Public Member Functions inherited from AbstractFormElement
 __construct (NodeFactory $nodeFactory, array $data)
 
- Public Member Functions inherited from AbstractNode
 __construct (NodeFactory $nodeFactory, array $data)
 
 render ()
 

Protected Member Functions

 getRteInitJsCode ()
 
 getContentCssFileNames ()
 
 isPluginEnabled ($pluginId)
 
 buildJSClassesArray ()
 
 hasCircularDependency (&$classesArray, $requiringClass, $initialClass, $recursionLevel=0)
 
 buildNestedJSArray ($conf)
 
 writeTemporaryFile ($label, $fileExtension= 'js', $contents= '')
 
 getJSToolbarArray ()
 
 getFullFileName ($filename)
 
 addOnSubmitJavaScriptCode ()
 
 isFrontendEditActive ()
 
 clientInfo ()
 
 logDeprecatedProperty ($deprecatedProperty, $useProperty, $version)
 
 RTEtsConfigParams ()
 
 cleanList ($str)
 
 isInFullScreenMode ()
 
 getLanguageService ()
 
 getBackendUserAuthentication ()
 
 getDatabaseConnection ()
 
- Protected Member Functions inherited from AbstractFormElement
 isWizardsDisabled ()
 
 formMaxWidth ($size=48)
 
 getClipboardElements ($allowed, $mode)
 
 getLanguageService ()
 
- Protected Member Functions inherited from AbstractNode
 initializeResultArray ()
 
 mergeChildReturnIntoExistingResult (array $existing, array $childReturn)
 
 getValidationDataAsDataAttribute (array $config)
 
 getValidationDataAsJsonString (array $config)
 

Protected Attributes

 $resultArray
 
 $pidOfPageRecord
 
 $pidOfVersionedMotherRecord
 
 $vanillaRteTsConfig
 
 $processedRteConfiguration
 
 $domIdentifier
 
 $defaultExtras
 
 $client
 
 $language
 
 $contentTypo3Language
 
 $contentISOLanguage
 
 $contentLanguageUid
 
 $defaultToolbarOrder
 
 $convertToolbarForHtmlAreaArray
 
 $toolbar = array()
 
 $toolbarOrderArray = array()
 
 $pluginButton = array()
 
 $pluginLabel = array()
 
 $pluginEnabledArray = array()
 
 $pluginEnabledCumulativeArray = array()
 
 $registeredPlugins = array()
 
- Protected Attributes inherited from AbstractFormElement
 $defaultInputWidth = 30
 
 $minimumInputWidth = 10
 
 $maxInputWidth = 50
 
 $clipboard = null
 
 $iconFactory
 
- Protected Attributes inherited from AbstractNode
 $data = array()
 

Detailed Description

Render rich text editor in FormEngine

Definition at line 37 of file RichTextElement.php.

Member Function Documentation

addOnSubmitJavaScriptCode ( )
protected

Return the Javascript code for copying the HTML code from the editor into the hidden input field.

Returns
void

Definition at line 1125 of file RichTextElement.php.

Referenced by RichTextElement\render().

buildJSClassesArray ( )
protected

Return JS arrays of classes configuration

Returns
string JS classes arrays

Definition at line 816 of file RichTextElement.php.

buildNestedJSArray (   $conf)
protected

Translate Page TS Config array in JS nested array definition Replace 0 values with false Unquote regular expression values Replace empty arrays with empty objects

Parameters
array$conf,:Page TSConfig configuration array
Returns
string nested JS array definition

Definition at line 934 of file RichTextElement.php.

cleanList (   $str)
protected

Clean list

Parameters
string$strString to clean
Returns
string Cleaned string

Definition at line 1276 of file RichTextElement.php.

clientInfo ( )
protected

Client Browser Information

Returns
array Contains keys "user agent", "browser", "version", "system"

Definition at line 1151 of file RichTextElement.php.

Referenced by RichTextElement\render().

getBackendUserAuthentication ( )
protected
Returns
BackendUserAuthentication

Definition at line 1334 of file RichTextElement.php.

Referenced by RichTextElement\render().

getContentCssFileNames ( )
protected

Get the name of the contentCSS files to use

Returns
array An array of full file name of the content css files to use

Definition at line 778 of file RichTextElement.php.

getDatabaseConnection ( )
protected
Returns
DatabaseConnection

Definition at line 1342 of file RichTextElement.php.

getFullFileName (   $filename)
protected

Make a file name relative to the PATH_site or to the PATH_typo3

Parameters
string$filename,:a file name of the form EXT:.... or relative to the PATH_site
Returns
string the file name relative to the PATH_site if in frontend or relative to the PATH_typo3 if in backend

Definition at line 1101 of file RichTextElement.php.

Referenced by RichTextElement\getRteInitJsCode(), and RichTextElement\render().

getJSToolbarArray ( )
protected

Return the JS code of the toolbar configuration for the HTMLArea editor

Returns
string The JS code as nested JS arrays

Definition at line 1041 of file RichTextElement.php.

getLanguageService ( )
protected
Returns
LanguageService

Definition at line 1326 of file RichTextElement.php.

getRteInitJsCode ( )
protected

Return RTE initialization inline JavaScript code

Returns
string RTE initialization inline JavaScript code

Definition at line 604 of file RichTextElement.php.

References $GLOBALS, GeneralUtility\createVersionNumberedFilename(), ExtensionManagementUtility\extRelPath(), and RichTextElement\getFullFileName().

Referenced by RichTextElement\render().

hasCircularDependency ( $classesArray,
  $requiringClass,
  $initialClass,
  $recursionLevel = 0 
)
protected

Check for possible circularity in classes dependencies

Parameters
array$classesArray,:reference to the array of classes dependencies
string$requiringClass,:class requiring at some iteration level from the initial requiring class
string$initialClass,:initial class from which a circular relationship is being searched
int$recursionLevel,:depth of recursive call
Returns
bool TRUE, if a circular relationship is found

Definition at line 905 of file RichTextElement.php.

isFrontendEditActive ( )
protected

Checks if frontend editing is active.

Returns
bool TRUE if frontend editing is active

Definition at line 1141 of file RichTextElement.php.

isInFullScreenMode ( )
protected

True if RTE is in full screen mode / called via wizard controller

Returns
bool

Definition at line 1318 of file RichTextElement.php.

isPluginEnabled (   $pluginId)
protected

Return TRUE, if the plugin can be loaded

Parameters
string$pluginId,:The identification string of the plugin
Returns
bool TRUE if the plugin can be loaded

Definition at line 806 of file RichTextElement.php.

logDeprecatedProperty (   $deprecatedProperty,
  $useProperty,
  $version 
)
protected

Log usage of deprecated Page TS Config Property

Parameters
string$deprecatedProperty,:Name of deprecated property
string$useProperty,:Name of property to use instead
string$version,:Version of TYPO3 in which the property will be removed
Returns
void

Definition at line 1225 of file RichTextElement.php.

render ( )
RTEtsConfigParams ( )
protected

A list of parameters that is mostly given as GET/POST to other RTE controllers.

Returns
string

Definition at line 1255 of file RichTextElement.php.

writeTemporaryFile (   $label,
  $fileExtension = 'js',
  $contents = '' 
)
protected

Writes contents in a file in typo3temp and returns the file name

Parameters
string$label,:A label to insert at the beginning of the name of the file
string$fileExtension,:The file extension of the file, defaulting to 'js'
string$contents,:The contents to write into the file
Returns
string The name of the file written to typo3temp
Exceptions
\RuntimeExceptionIf writing to file failed

Definition at line 952 of file RichTextElement.php.

Member Data Documentation

$client
protected

Definition at line 110 of file RichTextElement.php.

$contentISOLanguage
protected

Definition at line 131 of file RichTextElement.php.

$contentLanguageUid
protected

Definition at line 138 of file RichTextElement.php.

$contentTypo3Language
protected

Definition at line 124 of file RichTextElement.php.

$convertToolbarForHtmlAreaArray
protected
Initial value:
= array(
'space' => 'space',
'bar' => 'separator',
'linebreak' => 'linebreak'
)

Definition at line 152 of file RichTextElement.php.

$defaultExtras
protected

Definition at line 103 of file RichTextElement.php.

$defaultToolbarOrder
protected

Definition at line 145 of file RichTextElement.php.

$domIdentifier
protected

Definition at line 96 of file RichTextElement.php.

$language
protected

Definition at line 117 of file RichTextElement.php.

$pidOfPageRecord
protected

Definition at line 52 of file RichTextElement.php.

$pidOfVersionedMotherRecord
protected

Definition at line 62 of file RichTextElement.php.

$pluginButton = array()
protected

Definition at line 177 of file RichTextElement.php.

$pluginEnabledArray = array()
protected

Definition at line 191 of file RichTextElement.php.

Referenced by RichTextElement\render().

$pluginEnabledCumulativeArray = array()
protected

Definition at line 198 of file RichTextElement.php.

$pluginLabel = array()
protected

Definition at line 184 of file RichTextElement.php.

$processedRteConfiguration
protected

Definition at line 89 of file RichTextElement.php.

$registeredPlugins = array()
protected

Definition at line 205 of file RichTextElement.php.

$resultArray
protected

Definition at line 44 of file RichTextElement.php.

Referenced by RichTextElement\render().

$toolbar = array()
protected

Definition at line 163 of file RichTextElement.php.

$toolbarOrderArray = array()
protected

Definition at line 170 of file RichTextElement.php.

$vanillaRteTsConfig
protected

Definition at line 81 of file RichTextElement.php.