TYPO3\CMS\Backend\Form\Element\BackendLayoutWizardElement Class Reference

Inheritance diagram for TYPO3\CMS\Backend\Form\Element\BackendLayoutWizardElement:

Public Member Functions
	__construct (private readonly TypoScriptStringFactory $typoScriptStringFactory,)
	render ()
‪Public Member Functions inherited from ‪TYPO3\CMS\Backend\Form\Element\AbstractFormElement
	injectNodeFactory (NodeFactory $nodeFactory)
‪Public Member Functions inherited from ‪TYPO3\CMS\Backend\Form\AbstractNode
	setData (array $data)

Protected Member Functions
	initializeWizard ()
‪Protected Member Functions inherited from ‪TYPO3\CMS\Backend\Form\Element\AbstractFormElement
array	renderFieldInformation ()
array	renderFieldControl ()
array	renderFieldWizard ()
	renderLabel (string $for)
	wrapWithFieldsetAndLegend (string $innerHTML)
	hasNullCheckboxButNoPlaceholder ()
	hasNullCheckboxWithPlaceholder ()
string	formatValue ($format, $itemValue, $formatOptions=[])
int	formMaxWidth ($size=48)
	resolveJavaScriptEvaluation (array $resultArray, string $name, ?object $evalObject)
string	checkBoxParams (string $itemName, int $formElementValue, int $checkbox, int $checkboxesCount, array $fieldChangeFuncs=[], bool $invert=false)
	calculateColumnMarkup (int $cols)
	appendValueToLabelInDebugMode (string|int $label, string|int $value)
	getLanguageService ()
	getBackendUser ()
‪Protected Member Functions inherited from ‪TYPO3\CMS\Backend\Form\AbstractNode
	initializeResultArray ()
array	mergeChildReturnIntoExistingResult (array $existing, array $childReturn, bool $mergeHtml=true)
	getValidationDataAsJsonString (array $config)

Protected Attributes
array	$defaultFieldInformation
array	$rows = []
int	$colCount = 0
int	$rowCount = 0
‪Protected Attributes inherited from ‪TYPO3\CMS\Backend\Form\Element\AbstractFormElement
int	$defaultInputWidth = 30
int	$minimumInputWidth = 10
int	$maxInputWidth = 50
NodeFactory	$nodeFactory
‪Protected Attributes inherited from ‪TYPO3\CMS\Backend\Form\AbstractNode
array	$data = []
array	$defaultFieldInformation = array( )
array	$defaultFieldControl = array( )
array	$defaultFieldWizard = array( )

Detailed Description

Backend layout element. This is used when editing backend_layout records. It renders the layout wizard to manage rows and columns and shows the pseudo TypoScript result.

Note this element does not support fancy TypoScript features like @import lines and special ":=" value manipulation functions. When backend_layouts want to use these, they shouldn't use table record based backend_layouts, but register backend layouts using the BackendLayout/DataProviderInterface to store them in files, which obsoletes table record based backend_layouts and with it this FormEngine element class.

This class is a TYPO3 Backend implementation and is not considered part of the Public TYPO3 API.

Definition at line 38 of file BackendLayoutWizardElement.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Backend\Form\Element\BackendLayoutWizardElement::__construct

(

private readonly TypoScriptStringFactory

$typoScriptStringFactory

)

Definition at line 54 of file BackendLayoutWizardElement.php.

Member Function Documentation

initializeWizard()

TYPO3\CMS\Backend\Form\Element\BackendLayoutWizardElement::initializeWizard ( )

protected

Definition at line 137 of file BackendLayoutWizardElement.php.

References TYPO3\CMS\Backend\Form\Element\BackendLayoutWizardElement\$colCount, TYPO3\CMS\Backend\Form\AbstractNode\$data, TYPO3\CMS\Backend\Form\Element\BackendLayoutWizardElement\$rowCount, and TYPO3\CMS\Backend\Form\Element\BackendLayoutWizardElement\$rows.

Referenced by TYPO3\CMS\Backend\Form\Element\BackendLayoutWizardElement\render().

render()

TYPO3\CMS\Backend\Form\Element\BackendLayoutWizardElement::render

(

)

Handler for single nodes

Returns

‪array As defined in initializeResultArray() of AbstractNode

Reimplemented from TYPO3\CMS\Backend\Form\AbstractNode.

Definition at line 58 of file BackendLayoutWizardElement.php.

References $tca, TYPO3\CMS\Core\Page\JavaScriptModuleInstruction\create(), TYPO3\CMS\Backend\Form\Element\AbstractFormElement\getLanguageService(), TYPO3\CMS\Backend\Form\AbstractNode\initializeResultArray(), TYPO3\CMS\Backend\Form\Element\BackendLayoutWizardElement\initializeWizard(), TYPO3\CMS\Core\Utility\GeneralUtility\inList(), TYPO3\CMS\Backend\Form\AbstractNode\mergeChildReturnIntoExistingResult(), TYPO3\CMS\Backend\Form\Element\AbstractFormElement\renderFieldInformation(), TYPO3\CMS\Backend\Form\Element\AbstractFormElement\renderFieldWizard(), and TYPO3\CMS\Backend\Form\Element\AbstractFormElement\wrapWithFieldsetAndLegend().

Member Data Documentation

$colCount

int TYPO3\CMS\Backend\Form\Element\BackendLayoutWizardElement::$colCount = 0

protected

Definition at line 51 of file BackendLayoutWizardElement.php.

Referenced by TYPO3\CMS\Backend\Form\Element\BackendLayoutWizardElement\initializeWizard().

$defaultFieldInformation

array TYPO3\CMS\Backend\Form\Element\BackendLayoutWizardElement::$defaultFieldInformation

protected

Initial value:

= array( 
        'tcaDescription' => [
            'renderType' => 'tcaDescription',
        ],
     )

Default field information enabled for this element.

Definition at line 44 of file BackendLayoutWizardElement.php.

$rowCount

int TYPO3\CMS\Backend\Form\Element\BackendLayoutWizardElement::$rowCount = 0

protected

Definition at line 52 of file BackendLayoutWizardElement.php.

Referenced by TYPO3\CMS\Backend\Form\Element\BackendLayoutWizardElement\initializeWizard().

$rows

array TYPO3\CMS\Backend\Form\Element\BackendLayoutWizardElement::$rows = []

protected

Definition at line 50 of file BackendLayoutWizardElement.php.

Referenced by TYPO3\CMS\Backend\Form\Element\BackendLayoutWizardElement\initializeWizard().