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

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

Public Member Functions
	__construct (private readonly IconFactory $iconFactory,)
array	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
string	wrapInHelp (array $overloadHelpText=[])
‪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	$defaultFieldWizard
‪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

Creates a widget with check box elements.

This is rendered for config type=select, renderType=selectCheckBox

Definition at line 30 of file SelectCheckBoxElement.php.

Constructor & Destructor Documentation

__construct()

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

(

private readonly IconFactory

$iconFactory

)

Definition at line 64 of file SelectCheckBoxElement.php.

Member Function Documentation

render()

array TYPO3\CMS\Backend\Form\Element\SelectCheckBoxElement::render

(

)

Render check boxes

Returns

‪array As defined in initializeResultArray() of AbstractNode

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

Definition at line 73 of file SelectCheckBoxElement.php.

References TYPO3\CMS\Backend\Form\Element\AbstractFormElement\appendValueToLabelInDebugMode(), TYPO3\CMS\Core\Page\JavaScriptModuleInstruction\create(), TYPO3\CMS\Backend\Form\Utility\FormEngineUtility\getIconHtml(), TYPO3\CMS\Backend\Form\Element\AbstractFormElement\getLanguageService(), TYPO3\CMS\Core\Utility\StringUtility\getUniqueId(), TYPO3\CMS\Backend\Form\AbstractNode\getValidationDataAsJsonString(), TYPO3\CMS\Backend\Form\AbstractNode\initializeResultArray(), TYPO3\CMS\Backend\Form\AbstractNode\mergeChildReturnIntoExistingResult(), TYPO3\CMS\Backend\Form\Element\AbstractFormElement\renderFieldInformation(), TYPO3\CMS\Backend\Form\Element\AbstractFormElement\renderFieldWizard(), TYPO3\CMS\Backend\Form\Element\SelectCheckBoxElement\wrapInHelp(), and TYPO3\CMS\Backend\Form\Element\AbstractFormElement\wrapWithFieldsetAndLegend().

wrapInHelp()

string TYPO3\CMS\Backend\Form\Element\SelectCheckBoxElement::wrapInHelp ( array  $overloadHelpText = [] )

protected

A function that creates an icon with a help text. If a user clicks on the icon, the help text will show up as tooltip

Parameters

array

$overloadHelpText

‪Array with text to overload help text

Returns

‪string the HTML code ready to render

Definition at line 284 of file SelectCheckBoxElement.php.

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

Member Data Documentation

$defaultFieldInformation

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

protected

Initial value:

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

Default field information enabled for this element.

Definition at line 36 of file SelectCheckBoxElement.php.

$defaultFieldWizard

array TYPO3\CMS\Backend\Form\Element\SelectCheckBoxElement::$defaultFieldWizard

protected

Initial value:

= array( 
        'localizationStateSelector' => [
            'renderType' => 'localizationStateSelector',
        ],
        'otherLanguageContent' => [
            'renderType' => 'otherLanguageContent',
            'after' => [
                'localizationStateSelector',
            ],
        ],
        'defaultLanguageDifferences' => [
            'renderType' => 'defaultLanguageDifferences',
            'after' => [
                'otherLanguageContent',
            ],
        ],
     )

Default field wizards enabled for this element.

Definition at line 46 of file SelectCheckBoxElement.php.