T3editor Class Reference

Inheritance diagram for T3editor:

Public Member Functions
	setMode ($mode)
	setAjaxSaveType ($ajaxSaveType)
	setModeByFile ($file)
	setModeByType ($type)
	getMode ()
	isEnabled ()
	__construct ()
	getCodeEditor ($name, $class= '', $content= '', $additionalParams= '', $alt= '', array $hiddenfields=array())
	getPlugins (ServerRequestInterface $request, ResponseInterface $response)

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

Protected Member Functions
	getPreparedTemplate ()
	getParserfileByMode ($mode)
	getStylesheetByMode ($mode)
	getPageRenderer ()

Protected Attributes
	$mode = ''
	$ajaxSaveType = ''
	$editorCounter = 0
	$relExtPath = ''
	$codemirrorPath = 'sysext/t3editor/Resources/Public/JavaScript/Contrib/codemirror/js/'
	$codeCompletionComponents = array('TsRef', 'CompletionResult', 'TsParser', 'TsCodeCompletion')

Detailed Description

Provides a javascript-driven code editor with syntax highlighting for TS, HTML, CSS and more

Definition at line 25 of file T3editor.php.

Constructor & Destructor Documentation

__construct

(

)

Creates a new instance of the class

Definition at line 175 of file T3editor.php.

References $GLOBALS.

Member Function Documentation

getCodeEditor	(		$name,
			$class = '',
			$content = '',
			$additionalParams = '',
			$alt = '',
		array	$hiddenfields = array()
	)

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 305 of file T3editor.php.

References $GLOBALS, T3editor\getParserfileByMode(), T3editor\getPreparedTemplate(), and T3editor\getStylesheetByMode().

getMode

(

)

Get mode

Returns

string

Definition at line 157 of file T3editor.php.

References T3editor\$mode.

getPageRenderer ( )

protected

Returns

PageRenderer

Definition at line 406 of file T3editor.php.

References GeneralUtility\makeInstance().

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 T3editor.php.

References T3editor\$mode.

Referenced by T3editor\getCodeEditor().

getPlugins	(	ServerRequestInterface	$request,
		ResponseInterface	$response
	)

Gets plugins that are defined at $TYPO3_CONF_VARS['EXTCONF']['t3editor']['plugins'] Called by AjaxRequestHandler

Parameters

ServerRequestInterface	$request
ResponseInterface	$response

Returns

ResponseInterface

Definition at line 392 of file T3editor.php.

References $GLOBALS, and MessageInterface\getBody().

getPreparedTemplate ( )

protected

Get the template code, prepared for javascript (no line breaks, quoted in single quotes)

Returns

string The template code, prepared to use in javascript

Definition at line 210 of file T3editor.php.

References GeneralUtility\getFileAbsFileName(), and GeneralUtility\getUrl().

Referenced by T3editor\getCodeEditor().

getStylesheetByMode (   $mode )

protected

Determine the correct css file for given mode

Parameters

string

$mode

Returns

string css file name

Definition at line 260 of file T3editor.php.

References T3editor\$mode.

Referenced by T3editor\getCodeEditor().

isEnabled

(

)

Returns

bool TRUE if the t3editor is enabled

Deprecated:

since TYPO3 CMS 7, will be removed in TYPO3 CMS 8

Definition at line 166 of file T3editor.php.

References GeneralUtility\logDeprecatedFunction().

setAjaxSaveType

(

$ajaxSaveType

)

Set the AJAX save type

Parameters

string

$ajaxSaveType

Returns

Definition at line 92 of file T3editor.php.

References T3editor\$ajaxSaveType.

setMode

(

$mode

)

sets the type of code to edit (::MODE_TYPOSCRIPT, ::MODE_JAVASCRIPT)

Parameters

$mode

string Expects one of the predefined constants

Returns

Definition at line 80 of file T3editor.php.

References T3editor\$mode.

Referenced by T3editor\setModeByType().

setModeByFile

(

$file

)

Set mode by file

Parameters

string

$file

Returns

string

Definition at line 104 of file T3editor.php.

References T3editor\setModeByType(), and GeneralUtility\split_fileref().

setModeByType

(

$type

)

Set mode by type

Parameters

string

$type

Returns

void

Definition at line 117 of file T3editor.php.

References T3editor\$mode, and T3editor\setMode().

Referenced by T3editor\setModeByFile().

Member Data Documentation

$ajaxSaveType = ''

protected

Definition at line 44 of file T3editor.php.

Referenced by T3editor\setAjaxSaveType().

$codeCompletionComponents = array('TsRef', 'CompletionResult', 'TsParser', 'TsCodeCompletion')

protected

Definition at line 72 of file T3editor.php.

$codemirrorPath = 'sysext/t3editor/Resources/Public/JavaScript/Contrib/codemirror/js/'

protected

Definition at line 65 of file T3editor.php.

$editorCounter = 0

protected

Definition at line 51 of file T3editor.php.

$mode = ''

protected

Definition at line 39 of file T3editor.php.

Referenced by T3editor\getMode(), T3editor\getParserfileByMode(), T3editor\getStylesheetByMode(), T3editor\setMode(), and T3editor\setModeByType().

$relExtPath = ''

protected

Definition at line 58 of file T3editor.php.

const MODE_CSS = 'css'

Definition at line 29 of file T3editor.php.

const MODE_HTML = 'html'

Definition at line 31 of file T3editor.php.

const MODE_JAVASCRIPT = 'javascript'

Definition at line 28 of file T3editor.php.

const MODE_MIXED = 'mixed'

Definition at line 34 of file T3editor.php.

Referenced by T3editorElement\render().

const MODE_PHP = 'php'

Definition at line 32 of file T3editor.php.

const MODE_SPARQL = 'sparql'

Definition at line 33 of file T3editor.php.

const MODE_TYPOSCRIPT = 'typoscript'

Definition at line 27 of file T3editor.php.

Referenced by TypoScriptTemplateInfoHook\getT3editor().

const MODE_XML = 'xml'

Definition at line 30 of file T3editor.php.