TYPO3\CMS\T3editor\Form\Element\T3editorElement Class Reference

Inheritance diagram for TYPO3\CMS\T3editor\Form\Element\T3editorElement:

Public Member Functions
	render ()
	setMode ($mode)
	getMode ()
Public Member Functions inherited from TYPO3\CMS\Backend\Form\Element\AbstractFormElement
	__construct (NodeFactory $nodeFactory, array $data)
Public Member Functions inherited from TYPO3\CMS\Backend\Form\AbstractNode
	__construct (NodeFactory $nodeFactory, array $data)
	render ()

Public Attributes
const	MODE_CSS = 'css'
const	MODE_HTML = 'html'
const	MODE_JAVASCRIPT = 'javascript'
const	MODE_MIXED = 'mixed'
const	MODE_PHP = 'php'
const	MODE_SPARQL = 'sparql'
const	MODE_TYPOSCRIPT = 'typoscript'
const	MODE_XML = 'xml'

Protected Member Functions
	initJavascriptCode ()
	getHTMLCodeForEditor ($name, $class='', $content='', $additionalParams='', $alt='', array $hiddenfields=[])
	getParserfileByMode ($mode)
	getStylesheetByMode ($mode)
	getLanguageService ()
	getBackendUserAuthentication ()
Protected Member Functions inherited from TYPO3\CMS\Backend\Form\Element\AbstractFormElement
	isWizardsDisabled ()
	formMaxWidth ($size=48)
	getClipboardElements ($allowed, $mode)
	getLanguageService ()
Protected Member Functions inherited from TYPO3\CMS\Backend\Form\AbstractNode
	initializeResultArray ()
	mergeChildReturnIntoExistingResult (array $existing, array $childReturn)
	getValidationDataAsDataAttribute (array $config)
	getValidationDataAsJsonString (array $config)

Protected Attributes
	$allowedModes
	$resultArray
	$mode = ''
	$editorCounter = 0
	$relExtPath = ''
	$codemirrorPath = 'Resources/Public/JavaScript/Contrib/codemirror/js/'
	$codeCompletionComponents = ['TsRef', 'CompletionResult', 'TsParser', 'TsCodeCompletion']
Protected Attributes inherited from TYPO3\CMS\Backend\Form\Element\AbstractFormElement
	$defaultInputWidth = 30
	$minimumInputWidth = 10
	$maxInputWidth = 50
	$clipboard = null
	$iconFactory
Protected Attributes inherited from TYPO3\CMS\Backend\Form\AbstractNode
	$data = []

Detailed Description

t3editor FormEngine widget

Definition at line 28 of file T3editorElement.php.

Member Function Documentation

getBackendUserAuthentication()

TYPO3\CMS\T3editor\Form\Element\T3editorElement::getBackendUserAuthentication ( )

protected

Returns

BackendUserAuthentication

Definition at line 306 of file T3editorElement.php.

References $GLOBALS.

getHTMLCodeForEditor()

TYPO3\CMS\T3editor\Form\Element\T3editorElement::getHTMLCodeForEditor (   $name,   $class = '',   $content = '',   $additionalParams = '',   $alt = '', array  $hiddenfields = []  )

protected

Generates HTML with code editor

Parameters

string	$name	Name attribute of HTML tag
string	$class	Class attribute of HTML tag
string	$content	Content of the editor
string	$additionalParams	Any additional editor parameters
string	$alt	Alt attribute
array	$hiddenfields

Returns

string Generated HTML code for editor

Definition at line 180 of file T3editorElement.php.

References TYPO3\CMS\T3editor\Form\Element\T3editorElement\$codemirrorPath, TYPO3\CMS\T3editor\Form\Element\T3editorElement\$editorCounter, TYPO3\CMS\T3editor\Form\Element\T3editorElement\$relExtPath, TYPO3\CMS\Core\Utility\GeneralUtility\getFileAbsFileName(), TYPO3\CMS\T3editor\Form\Element\T3editorElement\getLanguageService(), TYPO3\CMS\T3editor\Form\Element\T3editorElement\getParserfileByMode(), TYPO3\CMS\T3editor\Form\Element\T3editorElement\getStylesheetByMode(), and TYPO3\CMS\Core\Utility\GeneralUtility\getUrl().

Referenced by TYPO3\CMS\T3editor\Form\Element\T3editorElement\render().

getLanguageService()

TYPO3\CMS\T3editor\Form\Element\T3editorElement::getLanguageService ( )

protected

Returns

LanguageService

Definition at line 298 of file T3editorElement.php.

References $GLOBALS.

Referenced by TYPO3\CMS\T3editor\Form\Element\T3editorElement\getHTMLCodeForEditor(), and TYPO3\CMS\T3editor\Form\Element\T3editorElement\render().

getMode()

TYPO3\CMS\T3editor\Form\Element\T3editorElement::getMode

(

)

Get mode

Returns

string

Definition at line 151 of file T3editorElement.php.

References TYPO3\CMS\T3editor\Form\Element\T3editorElement\$mode.

getParserfileByMode()

TYPO3\CMS\T3editor\Form\Element\T3editorElement::getParserfileByMode (   $mode )

protected

Determine the correct parser js file for given mode

Parameters

string

$mode

Returns

string Parser file name

Definition at line 224 of file T3editorElement.php.

References TYPO3\CMS\T3editor\Form\Element\T3editorElement\$mode.

Referenced by TYPO3\CMS\T3editor\Form\Element\T3editorElement\getHTMLCodeForEditor().

getStylesheetByMode()

TYPO3\CMS\T3editor\Form\Element\T3editorElement::getStylesheetByMode (   $mode )

protected

Determine the correct css file for given mode

Parameters

string

$mode

Returns

string css file name

Definition at line 261 of file T3editorElement.php.

References TYPO3\CMS\T3editor\Form\Element\T3editorElement\$mode.

Referenced by TYPO3\CMS\T3editor\Form\Element\T3editorElement\getHTMLCodeForEditor().

initJavascriptCode()

TYPO3\CMS\T3editor\Form\Element\T3editorElement::initJavascriptCode ( )

protected

Init the JavaScript code (header part) for editor

Definition at line 159 of file T3editorElement.php.

Referenced by TYPO3\CMS\T3editor\Form\Element\T3editorElement\render().

render()

TYPO3\CMS\T3editor\Form\Element\T3editorElement::render

(

)

Render t3editor element

Returns

array As defined in initializeResultArray() of AbstractNode

Implements TYPO3\CMS\Backend\Form\NodeInterface.

Definition at line 94 of file T3editorElement.php.

References TYPO3\CMS\T3editor\Form\Element\T3editorElement\$codemirrorPath, TYPO3\CMS\T3editor\Form\Element\T3editorElement\$resultArray, TYPO3\CMS\Core\Utility\ExtensionManagementUtility\extRelPath(), TYPO3\CMS\Core\Utility\MathUtility\forceIntegerInRange(), TYPO3\CMS\T3editor\Form\Element\T3editorElement\getHTMLCodeForEditor(), TYPO3\CMS\T3editor\Form\Element\T3editorElement\getLanguageService(), TYPO3\CMS\Backend\Form\AbstractNode\initializeResultArray(), TYPO3\CMS\T3editor\Form\Element\T3editorElement\initJavascriptCode(), TYPO3\CMS\T3editor\T3editor\MODE_MIXED, TYPO3\CMS\Core\Utility\GeneralUtility\quoteJSvalue(), and TYPO3\CMS\T3editor\Form\Element\T3editorElement\setMode().

setMode()

TYPO3\CMS\T3editor\Form\Element\T3editorElement::setMode

(

$mode

)

Sets the type of code to edit, use one of the predefined constants

Parameters

string

$mode

Expects one of the predefined constants

Exceptions

Definition at line 138 of file T3editorElement.php.

References TYPO3\CMS\T3editor\Form\Element\T3editorElement\$mode.

Referenced by TYPO3\CMS\T3editor\Form\Element\T3editorElement\render().

Member Data Documentation

$allowedModes

TYPO3\CMS\T3editor\Form\Element\T3editorElement::$allowedModes

protected

Initial value:

= [
        self::MODE_CSS,
        self::MODE_HTML,
        self::MODE_JAVASCRIPT,
        self::MODE_MIXED,
        self::MODE_PHP,
        self::MODE_SPARQL,
        self::MODE_TYPOSCRIPT,
        self::MODE_XML,
    ]

Definition at line 42 of file T3editorElement.php.

$codeCompletionComponents

TYPO3\CMS\T3editor\Form\Element\T3editorElement::$codeCompletionComponents = ['TsRef', 'CompletionResult', 'TsParser', 'TsCodeCompletion']

protected

Definition at line 87 of file T3editorElement.php.

$codemirrorPath

TYPO3\CMS\T3editor\Form\Element\T3editorElement::$codemirrorPath = 'Resources/Public/JavaScript/Contrib/codemirror/js/'

protected

Definition at line 80 of file T3editorElement.php.

Referenced by TYPO3\CMS\T3editor\Form\Element\T3editorElement\getHTMLCodeForEditor(), and TYPO3\CMS\T3editor\Form\Element\T3editorElement\render().

$editorCounter

TYPO3\CMS\T3editor\Form\Element\T3editorElement::$editorCounter = 0

protected

Definition at line 68 of file T3editorElement.php.

Referenced by TYPO3\CMS\T3editor\Form\Element\T3editorElement\getHTMLCodeForEditor().

$mode

TYPO3\CMS\T3editor\Form\Element\T3editorElement::$mode = ''

protected

Definition at line 61 of file T3editorElement.php.

Referenced by TYPO3\CMS\T3editor\Form\Element\T3editorElement\getMode(), TYPO3\CMS\T3editor\Form\Element\T3editorElement\getParserfileByMode(), TYPO3\CMS\T3editor\Form\Element\T3editorElement\getStylesheetByMode(), and TYPO3\CMS\T3editor\Form\Element\T3editorElement\setMode().

$relExtPath

TYPO3\CMS\T3editor\Form\Element\T3editorElement::$relExtPath = ''

protected

Definition at line 75 of file T3editorElement.php.

Referenced by TYPO3\CMS\T3editor\Form\Element\T3editorElement\getHTMLCodeForEditor().

$resultArray

TYPO3\CMS\T3editor\Form\Element\T3editorElement::$resultArray

protected

Definition at line 56 of file T3editorElement.php.

Referenced by TYPO3\CMS\T3editor\Form\Element\T3editorElement\render().

MODE_CSS

const TYPO3\CMS\T3editor\Form\Element\T3editorElement::MODE_CSS = 'css'

Definition at line 30 of file T3editorElement.php.

MODE_HTML

const TYPO3\CMS\T3editor\Form\Element\T3editorElement::MODE_HTML = 'html'

Definition at line 31 of file T3editorElement.php.

MODE_JAVASCRIPT

const TYPO3\CMS\T3editor\Form\Element\T3editorElement::MODE_JAVASCRIPT = 'javascript'

Definition at line 32 of file T3editorElement.php.

MODE_MIXED

const TYPO3\CMS\T3editor\Form\Element\T3editorElement::MODE_MIXED = 'mixed'

Definition at line 33 of file T3editorElement.php.

MODE_PHP

const TYPO3\CMS\T3editor\Form\Element\T3editorElement::MODE_PHP = 'php'

Definition at line 34 of file T3editorElement.php.

MODE_SPARQL

const TYPO3\CMS\T3editor\Form\Element\T3editorElement::MODE_SPARQL = 'sparql'

Definition at line 35 of file T3editorElement.php.

MODE_TYPOSCRIPT

const TYPO3\CMS\T3editor\Form\Element\T3editorElement::MODE_TYPOSCRIPT = 'typoscript'

Definition at line 36 of file T3editorElement.php.

MODE_XML

const TYPO3\CMS\T3editor\Form\Element\T3editorElement::MODE_XML = 'xml'

Definition at line 37 of file T3editorElement.php.