TYPO3\CMS\Backend\Form\FlexFormsHelper Class Reference

Inheritance diagram for TYPO3\CMS\Backend\Form\FlexFormsHelper:

Public Member Functions
	modifyFlexFormDS (array $dataStructure, $table, $tableField, array $tableRow, array $tableConf)
	modifySingleFlexFormSheet (array $sheet, $table, $tableField, array $tableRow, array $sheetConf, array $nonExcludeFields)
Public Member Functions inherited from TYPO3\CMS\Backend\Form\FormEngine
	__construct ()
	initDefaultBEmode ()
	getSoloField ($table, $row, $theFieldToReturn)
	getMainFields ($table, array $row, $depth=0, array $overruleTypesArray=array())
	getListedFields ($table, $row, $list)
	getPaletteFields ($table, $row, $palette, $header='', $itemList='', $collapsedHeader=NULL)
	getSingleField_SW ($table, $field, $row, &$PA)
	getSingleField_typeInput ($table, $field, $row, &$PA)
	getSingleField_typeText ($table, $field, $row, &$PA)
	getSingleField_typeCheck ($table, $field, $row, &$PA)
	getSingleField_typeRadio ($table, $field, $row, &$PA)
	getSingleField_typeSelect ($table, $field, $row, &$PA)
	getSelectItems ($table, $fieldName, array $row, array $PA)
	getSingleField_typeSelect_single ($table, $field, $row, &$PA, $config, $selItems, $nMV_label)
	getSingleField_typeSelect_checkbox ($table, $field, $row, &$PA, $config, $selItems, $nMV_label)
	getSingleField_typeSelect_singlebox ($table, $field, $row, &$PA, $config, $selItems, $nMV_label)
	getSingleField_typeSelect_multiple ($table, $field, $row, &$PA, $config, $selItems, $nMV_label)
	getSingleField_typeNone ($table, $field, $row, &$PA)
	getSingleField_typeNone_render ($config, $itemValue)
	getSingleField_typeFlex_langMenu ($languages, $elName, $selectedLanguage, $multi=TRUE)
	getSingleField_typeFlex_sheetMenu ($sArr, $elName, $sheetKey)
	getSingleField_typeUnknown ($table, $field, $row, &$PA)
	getSingleField_typeUser ($table, $field, $row, &$PA)
	formatValue ($config, $itemValue)
	getRTypeNum ($table, $row)
	rearrange ($fields)
	getExcludeElements ($table, $row, $typeNum)
	getFieldsToAdd ($table, $row, $typeNum)
	mergeFieldsWithAddedFields ($fields, $fieldsToAdd, $table='')
	setTSconfig ($table, $row, $field='')
	overrideFieldConf ($fieldConfig, $TSconfig)
	getSpecConfForField ($table, $row, $field)
	getSpecConfFromString ($extraString, $defaultExtras)
	loadPaletteElements ($table, $row, $palette, $itemList='')
	getLanguageOverlayRawValue ($table, $row, $field, $fieldConf)
	renderDefaultLanguageContent ($table, $field, $row, $item)
	renderDefaultLanguageDiff ($table, $field, $row, $item)
	renderVDEFDiff ($vArray, $vDEFkey)
	dbFileIcons ($fName, $mode, $allowed, $itemArray, $selector='', $params=array(), $onFocus='', $table='', $field='', $uid='', $config=array())
	getClipboardElements ($allowed, $mode)
	getClickMenu ($str, $table, $uid=0)
	renderWizards ($itemKinds, $wizConf, $table, $row, $field, &$PA, $itemName, $specConf, $RTE=FALSE)
	getIcon ($icon)
	optionTagStyle ($iconString)
	optgroupTagStyle ($iconString)
	extractValuesOnlyFromValueLabelList ($itemFormElValue)
	wrapOpenPalette ($header, $table, $row, $palette, $retFunc)
	wrapPaletteField ($code, $table, $row, $palette, $collapsed)
	checkBoxParams ($itemName, $thisValue, $c, $iCount, $addFunc='')
	elName ($itemName)
	thisReturnUrl ()
	getSingleHiddenField ($table, $field, $row)
	formWidth ($size=48, $textarea=FALSE)
	formWidthText ($size=48, $wrap='')
	formElStyle ($type)
	formElClass ($type)
	formElStyleClassValue ($type, $class=FALSE)
	insertDefStyle ($type, $additionalClass='')
	getDynTabMenu ($parts, $idString, $dividersToTabsBehaviour=1)
	initItemArray ($fieldValue)
	addItems ($items, $iArray)
	addSelectOptionsToItemArray ($items, $fieldValue, $TSconfig, $field)
	addSelectOptionsToItemArray_makeModuleData ($value)
	setNewBEDesign ()
	intoTemplate ($inArr, $altTemplate='')
	addUserTemplateMarkers ($marker, $table, $field, $row, &$PA)
	wrapLabels ($str)
	wrapTotal ($c, $rec, $table)
	replaceTableWrap ($arr, $rec, $table)
	wrapBorder (&$out_array, &$out_pointer)
	rplColorScheme ($inTemplate)
	getDivider ()
	printPalette ($palArr)
	setColorScheme ($scheme)
	resetSchemes ()
	storeSchemes ()
	restoreSchemes ()
	JStop ()
	JSbottom ($formname='forms[0]', $update=FALSE)
	dbFileCon ($formObj='document.forms[0]')
	printNeededJSFunctions_top ()
	loadJavascriptLib ($lib)
	getDefaultRecord ($table, $pid=0)
	getRecordPath ($table, $rec)
	readPerms ()
	sL ($str)
	getLL ($str)
	isPalettesCollapsed ($table, $palette)
	getTSCpid ($table, $uid, $pid)
	doLoadTableDescr ($table)
	getAvailableLanguages ($onlyIsoCoded=TRUE, $setDefault=TRUE)
	previewFieldValue ($value, $config, $field='')
	getAdditionalPreviewLanguages ()
	pushToDynNestedStack ($type, $ident)
	popFromDynNestedStack ($type=NULL, $ident=NULL)
	getDynNestedStack ($json=FALSE, $skipFirst=FALSE)
	addStyleSheet ($key, $href, $title='', $relation='stylesheet')

Static Public Member Functions
static	compareArraysByFirstValue (array $array1, array $array2)
Static Public Member Functions inherited from TYPO3\CMS\Backend\Form\FormEngine
static	getHiddenTokenField ($formName='securityToken', $tokenName='formToken')

Protected Member Functions
	getFlexFormNonExcludeFields ($table, $tableField, $extIdent)
Protected Member Functions inherited from TYPO3\CMS\Backend\Form\FormEngine
	renderNullValueWidget ($table, $field, array $row, array $PA)
	isDisabledNullValueField ($table, $field, array $row, array $PA)
	getIconHtml ($icon, $alt='', $title='')
	formWidthAsArray ($size=48, $textarea=FALSE)
	getPageRenderer ()
	isNewRecord ($table, $row)
	getMergeBehaviourIcon ($l10nMode)
	registerRequiredProperty ($type, $name, $value)
	registerNestedElement ($itemName, $setLevel=TRUE)
	getPlaceholderAttribute ($table, $field, array $config, array $row)
	getBackendUserAuthentication ()
	getControllerDocumentTemplate ()
	getDatabaseConnection ()
	getLanguageService ()
	getDocumentTemplate ()

Protected Attributes
	$removeSelectConfig
Protected Attributes inherited from TYPO3\CMS\Backend\Form\FormEngine
	$cache_getTSCpid = array()
	$form_additionalTextareaStyleWidth = 23
	$prependFormFieldNamesActive = 'control[active]'
	$paletteFieldTemplate = ''
	$multiSelectFilterCount = 0
	$suggest

Additional Inherited Members
Public Attributes inherited from TYPO3\CMS\Backend\Form\FormEngine
	$palFieldArr = array()
	$disableWizards = FALSE
	$isPalettedoc = FALSE
	$paletteMargin = 1
	$defStyle = ''
	$cachedTSconfig = array()
	$cachedTSconfig_fieldLevel = array()
	$cachedLanguageFlag = array()
	$cachedAdditionalPreviewLanguages = NULL
	$transformedRow = array()
	$extJSCODE = ''
	$printNeededJS = array()
	$hiddenFieldAccum = array()
	$TBE_EDITOR_fieldChanged_func = ''
	$loadMD5_JS = TRUE
	$defaultLanguageData = array()
	$defaultLanguageData_diff = array()
	$additionalPreviewLanguageData = array()
	$backPath = ''
	$returnUrl = ''
	$doSaveFieldName = ''
	$palettesCollapsed = FALSE
	$disableRTE = FALSE
	$globalShowHelp = TRUE
	$localizationMode = ''
	$fieldOrder = ''
	$doPrintPalette = TRUE
	$clipObj = NULL
	$enableClickMenu = FALSE
	$enableTabMenu = FALSE
	$renderReadonly = FALSE
	$form_rowsToStylewidth = 9.58
	$form_largeComp = 1.33
	$charsPerRow = 40
	$maxTextareaWidth = 48
	$maxInputWidth = 48
	$defaultMultipleSelectorStyle = 'width:310px;'
	$prependFormFieldNames = 'data'
	$prependCmdFieldNames = 'cmd'
	$prependFormFieldNames_file = 'data_files'
	$formName = 'editform'
	$allowOverrideMatrix = array()
	$perms_clause = ''
	$perms_clause_set = FALSE
	$edit_showFieldHelp = FALSE
	$edit_docModuleUpload = FALSE
	$clientInfo = array()
	$RTEenabled = FALSE
	$RTEenabled_notReasons = ''
	$RTEcounter = 0
	$colorScheme = array()
	$classScheme = array()
	$defColorScheme = array()
	$defClassScheme = array()
	$fieldStyle = NULL
	$borderStyle = NULL
	$commentMessages = array()
	$totalWrap = '<hr />|<hr />'
	$fieldTemplate = '<strong>###FIELD_NAME###</strong><br />###FIELD_ITEM###<hr />'
	$sectionWrap = ''
	$palFieldTemplateHeader = ''
	$palFieldTemplate = ''
	$palettesRendered = array()
	$hiddenFieldListArr = array()
	$requiredFields = array()
	$requiredAdditional = array()
	$requiredElements = array()
	$requiredNested = array()
	$renderDepth = 0
	$savedSchemes = array()
	$dynNestedStack = array()
	$additionalCode_pre = array()
	$additionalJS_pre = array()
	$additionalJS_post = array()
	$additionalJS_submit = array()
	$additionalJS_delete = array()
	$inline
	$hookObjectsMainFields = array()
	$hookObjectsSingleField = array()
	$extraFormHeaders = array()
	$templateFile = ''

Detailed Description

Contains FlexForm manipulation methods as part of the TCEforms

Author

Kai Vogel <kai.vogel(at)speedprogs.de>

Definition at line 24 of file FlexFormsHelper.php.

Member Function Documentation

compareArraysByFirstValue()

static TYPO3\CMS\Backend\Form\FlexFormsHelper::compareArraysByFirstValue ( array  $array1, array  $array2  )

static

Compare two arrays by their first value

Parameters

array	$array1	First array
array	$array2	Second array

Returns

integer Negative int if first array is lower, zero if both are identical, and positive if second is higher

Definition at line 269 of file FlexFormsHelper.php.

getFlexFormNonExcludeFields()

TYPO3\CMS\Backend\Form\FlexFormsHelper::getFlexFormNonExcludeFields (   $table,   $tableField,   $extIdent  )

protected

Get FlexForm non-exclude-fields for current backend user

Parameters

string	$table	The table name
string	$tableField	The field name
string	$extIdent	The extension identifier

Returns

array All non_exclude_fields from FlexForms

See also

::getSingleField_typeFlex()

Definition at line 245 of file FlexFormsHelper.php.

References $GLOBALS, and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

Referenced by TYPO3\CMS\Backend\Form\FlexFormsHelper\modifyFlexFormDS().

modifyFlexFormDS()

TYPO3\CMS\Backend\Form\FlexFormsHelper::modifyFlexFormDS	(	array	$dataStructure,
			$table,
			$tableField,
		array	$tableRow,
		array	$tableConf
	)

Modify the Data Structure of a FlexForm field via TSconfig and group access lists

Parameters

array	$dataStructure	The data structure of the FlexForm field
string	$table	The table name of the record
string	$tableField	The field name
array	$tableRow	The record data
array	$tableConf	Additional configuration options

Returns

array Modified FlexForm DS

See also

::getSingleField_typeFlex()

Definition at line 65 of file FlexFormsHelper.php.

References TYPO3\CMS\Backend\Form\FlexFormsHelper\getFlexFormNonExcludeFields(), TYPO3\CMS\Backend\Form\FlexFormsHelper\modifySingleFlexFormSheet(), TYPO3\CMS\Core\Utility\GeneralUtility\removeDotsFromTS(), TYPO3\CMS\Core\Utility\GeneralUtility\resolveAllSheetsInDS(), TYPO3\CMS\Backend\Form\FormEngine\setTSconfig(), and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

modifySingleFlexFormSheet()

TYPO3\CMS\Backend\Form\FlexFormsHelper::modifySingleFlexFormSheet	(	array	$sheet,
			$table,
			$tableField,
		array	$tableRow,
		array	$sheetConf,
		array	$nonExcludeFields
	)

Modify a single FlexForm sheet according to given configuration

Parameters

array	$sheet	Flexform sheet to manipulate
string	$table	The table name
string	$tableField	The field name
array	$tableRow	The record data
array	$sheetConf	Sheet configuration
array	$nonExcludeFields	Non-exclude-fields for this sheet

Returns

array Modified sheet

See also

::modifyFlexFormDS()

Definition at line 148 of file FlexFormsHelper.php.

References $GLOBALS, TYPO3\CMS\Backend\Form\FormEngine\addItems(), TYPO3\CMS\Backend\Form\FormEngine\addSelectOptionsToItemArray(), TYPO3\CMS\Backend\Form\FormEngine\initItemArray(), TYPO3\CMS\Core\Utility\GeneralUtility\keepItemsInArray(), TYPO3\CMS\Core\Utility\ArrayUtility\mergeRecursiveWithOverrule(), TYPO3\CMS\Backend\Form\FormEngine\setTSconfig(), and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

Referenced by TYPO3\CMS\Backend\Form\FlexFormsHelper\modifyFlexFormDS().

Member Data Documentation

$removeSelectConfig

TYPO3\CMS\Backend\Form\FlexFormsHelper::$removeSelectConfig

protected

Initial value:

= array(
        'itemsProcFunc',
        'foreign_table',
        'foreign_table_where',
        'foreign_table_prefix',
        'foreign_table_loadIcons',
        'neg_foreign_table',
        'neg_foreign_table_where',
        'neg_foreign_table_prefix',
        'neg_foreign_table_loadIcons',
        'neg_foreign_table_imposeValueField',
        'fileFolder',
        'fileFolder_extList',
        'fileFolder_recursions',
        'MM',
        'MM_opposite_field',
        'MM_match_fields',
        'MM_insert_fields',
        'MM_table_where',
        'MM_hasUidField',
        'special'
    )

Definition at line 31 of file FlexFormsHelper.php.