TYPO3\CMS\Core\TypoScript\ConfigurationForm Class Reference

Inheritance diagram for TYPO3\CMS\Core\TypoScript\ConfigurationForm:

Public Member Functions
	ext_initTSstyleConfig ($configTemplate, $pathRel, $pathAbs, $backPath='')
	ext_setValueArray ($theConstants, $valueArray)
	ext_getCategoriesForModMenu ()
	ext_makeHelpInformationForCategory ($cat)
	ext_getForm ($cat, $theConstants, $script='', $addFields='', $extKey='', $addFormTag=true)
	ext_displayExample ()
	ext_mergeIncomingWithExisting ($arr)
	ext_getKeyImage ($key)
	ext_getTSCE_config_image ($imgConf)
	ext_fNandV ($params)
	ext_putValueInConf ($key, $var)
	ext_removeValueInConf ($key)
Public Member Functions inherited from TYPO3\CMS\Core\TypoScript\ExtendedTemplateService
	substituteConstants ($all)
	substituteConstantsCallBack ($matches)
	substituteCMarkers ($all)
	ext_getSetup ($theSetup, $theKey)
	ext_getObjTree ($arr, $depth_in, $depthData, $parentType='', $parentValue='', $alphaSort='0')
	lineNumberToScript (array $lnArr)
	makeHtmlspecialchars ($theValue)
	ext_getSearchKeys ($arr, $depth_in, $searchString, $keyArray)
	ext_getRootlineNumber ($pid)
	ext_process_hierarchyInfo (array $depthDataArr, &$pointer)
	ext_outputTS (array $config, $lineNumbers=false, $comments=false, $crop=false, $syntaxHL=false, $syntaxHLBlockmode=0)
	ext_fixed_lgd ($string, $chars)
	ext_lnBreakPointWrap ($lineNumber, $str)
	ext_formatTS ($input, $ln, $comments=true, $crop=false)
	ext_getFirstTemplate ($id, $template_uid=0)
	ext_getAllTemplates ($id)
	ext_compareFlatSetups ($default)
	ext_categorizeEditableConstants ($editConstArray)
	ext_getCategoryLabelArray ()
	ext_getTypeData ($type)
	ext_getTSCE_config ($category)
	ext_getKeyImage ($key)
	ext_getTSCE_config_image ($imgConf)
	ext_fNandV ($params)
	ext_regObjectPositions ($constants)
	ext_regObjects ($pre)
	ext_putValueInConf ($key, $var)
	ext_removeValueInConf ($key)
	ext_depthKeys ($arr, $settings)
	ext_procesInput ($http_post_vars, $http_post_files, $theConstants, $tplRow)
	ext_prevPageWithTemplate ($id, $perms_clause)
Public Member Functions inherited from TYPO3\CMS\Core\TypoScript\TemplateService
	getProcessExtensionStatics ()
	setProcessExtensionStatics ($processExtensionStatics)
	setVerbose ($verbose)
	init ()
	getCurrentPageData ()
	runThroughTemplates ($theRootLine, $start_template_uid=0)
	processTemplate ($row, $idList, $pid, $templateID='', $templateParent='', $includePath='')
	updateRootlineData ($fullRootLine)
	includeStaticTypoScriptSources ($idList, $templateID, $pid, $row)
	addExtensionStatics ($idList, $templateID, $pid, $row)
	prependStaticExtra ($subrow)
	versionOL (&$row)
	processIncludes ()
	flattenSetup ($setupArray, $prefix)
	substituteConstants ($all)
	substituteConstantsCallBack ($matches)
	splitConfArray ($conf, $splitCount)
	getFileName ($fileFromSetup)
	printTitle ($pageTitle, $noTitle=false, $showTitleFirst=false, $pageTitleSeparator='')
	fileContent ($fileName)
	wrap ($content, $wrap)
	removeQueryString ($url)
	getRootlineLevel ($list)
	linkData ($page, $oTarget, $no_cache, $script, $overrideArray=null, $addParams='', $typeOverride='', $targetDomain='')
	getFromMPmap ($pageId=0)
	initMPmap_create ($id, $MP_array=[], $level=0)

Public Attributes
	$categories = []
	$ext_dontCheckIssetValues = 1
	$ext_CEformName = 'tsStyleConfigForm'
	$ext_printAll = true
	$ext_incomingValues = []
Public Attributes inherited from TYPO3\CMS\Core\TypoScript\ExtendedTemplateService
	$edit_divider = '###MOD_TS:EDITABLE_CONSTANTS###'
	$HTMLcolorList = 'aqua,beige,black,blue,brown,fuchsia,gold,gray,green,lime,maroon,navy,olive,orange,purple,red,silver,tan,teal,turquoise,yellow,white'
	$categories
	$subCategories
	$backend_info = true
	$ext_inBrace = 0
	$tsbrowser_searchKeys = []
	$tsbrowser_depthKeys = []
	$constantMode = ''
	$regexMode = ''
	$fixedLgd = ''
	$ext_lineNumberOffset = 0
	$ext_localGfxPrefix = ''
	$ext_localWebGfxPrefix = ''
	$ext_expandAllNotes = 0
	$ext_noPMicons = 0
	$ext_noSpecialCharsOnLabels = 0
	$ext_listOfTemplatesArr = []
	$ext_lineNumberOffset_mode = ''
	$ext_dontCheckIssetValues = 0
	$ext_printAll = 0
	$ext_CEformName = 'forms[0]'
	$doNotSortCategoriesBeforeMakingForm = false
	$templateTitles = []
	$clearList_const_temp
	$clearList_setup_temp
	$bType = ''
	$linkObjects = false
	$helpConfig = []
	$changed = false
	$raw = []
	$rawP = 0
	$lastComment = ''
Public Attributes inherited from TYPO3\CMS\Core\TypoScript\TemplateService
	$tt_track = true
	$forceTemplateParsing = false
	$matchAlternative = []
	$matchAll = false
	$backend_info = false
	$ext_constants_BRP = 0
	$ext_config_BRP = 0
	$ext_regLinenumbers = false
	$ext_regComments = false
	$tempPath = 'typo3temp/'
	$whereClause = ''
	$debug = false
	$allowedPaths = []
	$simulationHiddenOrTime = 0
	$loaded = false
	$setup = []
	$flatSetup = []
	$config = []
	$constants = []
	$hierarchyInfo = []
	$hierarchyInfoToRoot = []
	$nextLevel = 0
	$rootId
	$rootLine
	$absoluteRootLine
	$outermostRootlineIndexWithTemplate = 0
	$rowSum
	$sitetitle = ''
	$sections
	$sectionsMatch
	$clearList_const = []
	$clearList_setup = []
	$parserErrors = []
	$setup_constants = []
	$fileCache = []
	$frames = []
	$MPmap = ''

Protected Attributes
	$ext_realValues = []
	$ext_backPath = ''
Protected Attributes inherited from TYPO3\CMS\Core\TypoScript\ExtendedTemplateService
	$categoryLabels = []
	$lnToScript = null
	$objReg = []
Protected Attributes inherited from TYPO3\CMS\Core\TypoScript\TemplateService
	$verbose = false
	$templateIncludePaths = []
	$extensionStaticsProcessed = false
	$processExtensionStatics = false
	$isDefaultTypoScriptAdded = false
	$processIncludesHasBeenRun = false

Additional Inherited Members
Static Public Member Functions inherited from TYPO3\CMS\Core\TypoScript\TemplateService
static	sortedKeyList ($setupArr, $acceptOnlyProperties=false)
Protected Member Functions inherited from TYPO3\CMS\Core\TypoScript\ExtendedTemplateService
	getRootLine ()
	getDatabaseConnection ()
	getLanguageService ()
	getDocumentTemplate ()
Protected Member Functions inherited from TYPO3\CMS\Core\TypoScript\TemplateService
	getTypoScriptSourceFileContent ($filePath, $baseName)
	mergeConstantsFromIncludedTsConfigFiles ($filesToInclude, $TSdataArray)
	addDefaultTypoScript ()
	getDatabaseConnection ()
	getTypoScriptFrontendController ()
	getTimeTracker ()

Detailed Description

Provides a simplified layer for making Constant Editor style configuration forms

Definition at line 23 of file ConfigurationForm.php.

Member Function Documentation

ext_displayExample()

TYPO3\CMS\Core\TypoScript\ConfigurationForm::ext_displayExample

(

)

Display example

Returns

string

Definition at line 160 of file ConfigurationForm.php.

Referenced by TYPO3\CMS\Core\TypoScript\ConfigurationForm\ext_getForm().

ext_fNandV()

TYPO3\CMS\Core\TypoScript\ConfigurationForm::ext_fNandV

(

$params

)

Parameters

array

$params

Returns

array

Definition at line 213 of file ConfigurationForm.php.

References $params.

ext_getCategoriesForModMenu()

TYPO3\CMS\Core\TypoScript\ConfigurationForm::ext_getCategoriesForModMenu

(

)

Returns

array

Definition at line 109 of file ConfigurationForm.php.

References TYPO3\CMS\Core\TypoScript\ExtendedTemplateService\ext_getCategoryLabelArray().

ext_getForm()

TYPO3\CMS\Core\TypoScript\ConfigurationForm::ext_getForm	(		$cat,
			$theConstants,
			$script = '',
			$addFields = '',
			$extKey = '',
			$addFormTag = true
	)

Get the form for extension configuration

Parameters

string	$cat
array	$theConstants
string	$script
string	$addFields
string	$extKey
bool	$addFormTag	Adds opening <form> tag to the output, if TRUE

Returns

string The form

Definition at line 134 of file ConfigurationForm.php.

References TYPO3\CMS\Core\TypoScript\ConfigurationForm\ext_displayExample(), TYPO3\CMS\Core\TypoScript\ConfigurationForm\ext_makeHelpInformationForCategory(), TYPO3\CMS\Core\TypoScript\ExtendedTemplateService\getLanguageService(), TYPO3\CMS\Core\Utility\GeneralUtility\linkThisScript(), TYPO3\CMS\Core\Utility\GeneralUtility\quoteJSvalue(), and TYPO3\CMS\Core\Utility\GeneralUtility\wrapJS().

ext_getKeyImage()

TYPO3\CMS\Core\TypoScript\ConfigurationForm::ext_getKeyImage

(

$key

)

Parameters

string

$key

Returns

string

Deprecated:

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

Definition at line 191 of file ConfigurationForm.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\logDeprecatedFunction().

ext_getTSCE_config_image()

TYPO3\CMS\Core\TypoScript\ConfigurationForm::ext_getTSCE_config_image

(

$imgConf

)

Parameters

string

$imgConf

Returns

string

Definition at line 201 of file ConfigurationForm.php.

ext_initTSstyleConfig()

TYPO3\CMS\Core\TypoScript\ConfigurationForm::ext_initTSstyleConfig	(		$configTemplate,
			$pathRel,
			$pathAbs,
			$backPath = ''
	)

Parameters

string	$configTemplate
string	$pathRel	PathRel is the path relative to the typo3/ directory
string	$pathAbs	PathAbs is the absolute path from root
string	$backPath	BackPath is the backReference from current position to typo3/ dir

Returns

array

Definition at line 67 of file ConfigurationForm.php.

ext_makeHelpInformationForCategory()

TYPO3\CMS\Core\TypoScript\ConfigurationForm::ext_makeHelpInformationForCategory

(

$cat

)

Parameters

string

$cat

Returns

void

Definition at line 118 of file ConfigurationForm.php.

References TYPO3\CMS\Core\TypoScript\ExtendedTemplateService\ext_getTSCE_config().

Referenced by TYPO3\CMS\Core\TypoScript\ConfigurationForm\ext_getForm().

ext_mergeIncomingWithExisting()

TYPO3\CMS\Core\TypoScript\ConfigurationForm::ext_mergeIncomingWithExisting

(

$arr

)

Merge incoming with existing

Parameters

array

$arr

Returns

array

Definition at line 177 of file ConfigurationForm.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance(), and TYPO3\CMS\Core\Utility\ArrayUtility\mergeRecursiveWithOverrule().

ext_putValueInConf()

TYPO3\CMS\Core\TypoScript\ConfigurationForm::ext_putValueInConf	(		$key,
			$var
	)

Parameters

string	$key
string	$var

Returns

void

Definition at line 232 of file ConfigurationForm.php.

ext_removeValueInConf()

TYPO3\CMS\Core\TypoScript\ConfigurationForm::ext_removeValueInConf

(

$key

)

Parameters

string

$key

Returns

void

Definition at line 241 of file ConfigurationForm.php.

ext_setValueArray()

TYPO3\CMS\Core\TypoScript\ConfigurationForm::ext_setValueArray	(		$theConstants,
			$valueArray
	)

Ext set value array

Parameters

array	$theConstants
array	$valueArray

Returns

array

Definition at line 87 of file ConfigurationForm.php.

References TYPO3\CMS\Core\TypoScript\TemplateService\$flatSetup, TYPO3\CMS\Core\TypoScript\ExtendedTemplateService\ext_categorizeEditableConstants(), and TYPO3\CMS\Core\TypoScript\TemplateService\flattenSetup().

Member Data Documentation

$categories

TYPO3\CMS\Core\TypoScript\ConfigurationForm::$categories = []

Definition at line 28 of file ConfigurationForm.php.

$ext_backPath

TYPO3\CMS\Core\TypoScript\ConfigurationForm::$ext_backPath = ''

protected

Definition at line 58 of file ConfigurationForm.php.

$ext_CEformName

TYPO3\CMS\Core\TypoScript\ConfigurationForm::$ext_CEformName = 'tsStyleConfigForm'

Definition at line 38 of file ConfigurationForm.php.

$ext_dontCheckIssetValues

TYPO3\CMS\Core\TypoScript\ConfigurationForm::$ext_dontCheckIssetValues = 1

Definition at line 33 of file ConfigurationForm.php.

$ext_incomingValues

TYPO3\CMS\Core\TypoScript\ConfigurationForm::$ext_incomingValues = []

Definition at line 48 of file ConfigurationForm.php.

$ext_printAll

TYPO3\CMS\Core\TypoScript\ConfigurationForm::$ext_printAll = true

Definition at line 43 of file ConfigurationForm.php.

$ext_realValues

TYPO3\CMS\Core\TypoScript\ConfigurationForm::$ext_realValues = []

protected

Definition at line 53 of file ConfigurationForm.php.