belayoutwizard 

This page describes the text type with renderType='belayoutwizard'.

The according database field is generated automatically.

The renderType = 'belayoutwizard' is a special renderType to display the backend layout wizard when editing records of table backend_layout in the backend. It is stored a custom syntax representing the page layout in the database.

Table of contents:

Example: Backend layout editor 

The backend layout wizard

The backend layout wizard

EXT:frontend/Configuration/TCA/backend_layout.php 
<?php

return [
  'ctrl' => [
    'title' => 'LLL:EXT:frontend/Resources/Private/Language/locallang_tca.xlf:backend_layout',
    'label' => 'title',
    'descriptionColumn' => 'description',
    'tstamp' => 'tstamp',
    'crdate' => 'crdate',
    'versioningWS' => true,
    'groupName' => 'system',
    'sortby' => 'sorting',
    'delete' => 'deleted',
    'enablecolumns' => [
      'disabled' => 'hidden',
    ],
    'typeicon_classes' => [
      'default' => 'mimetypes-x-backend_layout',
    ],
    'selicon_field' => 'icon',
    'security' => [
      'ignorePageTypeRestriction' => true,
    ],
  ],
  'columns' => [
    'title' => [
      'label' => 'LLL:EXT:frontend/Resources/Private/Language/locallang_tca.xlf:backend_layout.title',
      'config' => [
        'type' => 'input',
        'size' => 25,
        'max' => 255,
        'required' => true,
      ],
    ],
    'config' => [
      'label' => 'LLL:EXT:frontend/Resources/Private/Language/locallang_tca.xlf:backend_layout.config',
      'config' => [
        'type' => 'text',
        'renderType' => 'belayoutwizard',
      ],
    ],
    'icon' => [
      'label' => 'LLL:EXT:frontend/Resources/Private/Language/locallang_tca.xlf:backend_layout.icon',
      'exclude' => true,
      'config' => [
        'type' => 'file',
        'allowed' => 'common-image-types',
        'relationship' => 'manyToOne',
        'appearance' => [
          'createNewRelationLinkTitle' => 'LLL:EXT:frontend/Resources/Private/Language/locallang_ttc.xlf:images.addFileReference',
        ],
      ],
    ],
  ],
  'types' => [
    '1' => [
      'showitem' => '
        --div--;core.form.tabs:general,
          title,icon,config,
        --div--;core.form.tabs:access,
          hidden,
        --div--;core.form.tabs:notes,
          description,
        --div--;core.form.tabs:extended,
      ',
    ],
  ],
];
Copied!

Properties of the TCA column type text, render type belayoutwizard 

Name Type Scope
default
 string Display / Proc.
fieldInformation
fieldWizard
defaultLanguageDifferences
 array
localizationStateSelector
 array
otherLanguageContent
 array
searchable
 boolean Display
default
Type
string
TCA path
$GLOBALS['TCA'][$table]['columns'][$field]['config']['default']
Scope
Display / Proc.

Default value set if a new record is created. If empty, no text-belayout gets selected.

fieldInformation

For details see fieldInformation.

fieldWizard
defaultLanguageDifferences
Type
array
TCA path
$GLOBALS['TCA'][$table]['columns'][$field]['config']['fieldWizard']['defaultLanguageDifferences']

For details see defaultLanguageDifferences.

localizationStateSelector
Type
array
TCA path
$GLOBALS['TCA'][$table]['columns'][$field]['config']['fieldWizard']['localizationStateSelector']

For details see localizationStateSelector.

otherLanguageContent
Type
array
TCA path
$GLOBALS['TCA'][$table]['columns'][$field]['config']['fieldWizard']['otherLanguageContent']

For details see otherLanguageContent.

searchable
Type
boolean
Default
true
TCA path
$GLOBALS['TCA'][$table]['columns'][$field]['config']['searchable']
Scope
Display

New in version 14.0

TYPO3 now automatically includes all fields of suitable types in backend search operations in the Content > Records module.

This option can be used to explicitly exclude fields from being searchable, instead of having to list them in the now removed option $GLOBALS['TCA'][$table]['ctrl']['searchFields'].

By default, all fields of type text with rendertype belayoutwizard are considered searchable.

To exclude a field from being searchable, set the following in the field's TCA configuration:

EXT:my_extension/Configuration/TCA/Overrides/132-tx_myextension_conference-embed_code.php 
<?php

use TYPO3\CMS\Core\Utility\ExtensionManagementUtility;

defined('TYPO3') or die();

ExtensionManagementUtility::addTCAcolumns('tx_myextension_conference', [
  'embed_code' => [
    'label' => 'my_extension.db:conference.embed_code',
    'config' => [
      'type' => 'text',
      'renderType' => 'codeEditor',
      'format' => 'html',
      'rows' => 7,
      'appearance' => [
        'lineWrapping' => true,
      ],
      'behaviour' => [
        'allowLanguageSynchronization' => true,
      ],
      'searchable' => false,
    ],
  ],
]);
ExtensionManagementUtility::addToAllTCAtypes(
  'tx_myextension_conference',
  'embed_code',
  '',
  'after:description',
);
Copied!