UserSettingsSchema

readonly class \TYPO3\CMS\Core\Authentication\UserSettingsSchema

Provides unified access to backend user settings configuration.

This class consolidates access to user settings from both:

  • TCA at $GLOBALS['TCA']['be_users']['columns']['user_settings']
  • Legacy $GLOBALS['TYPO3_USER_SETTINGS'] (deprecated)

TCA is the preferred source. Legacy global is supported for backward compatibility.

Table of Contents

Methods

getColumn()  : array|null
Get configuration for a specific field in legacy format.
getColumns()  : array<string, array>
Get all column configurations in legacy format.
getDbColumnSettingKeys()  : string[]
getDefault()  : mixed
getJsonFieldSettingKeys()  : array<int, string>
getPersistentUpdateFieldNames()  : string[]
Returns field names that should trigger a JS persistent storage update when their value changes in User Settings, so JS components can react immediately without a page reload.
getRawShowitem()  : string
Get the raw showitem string (merged from TCA and legacy global).
getTca()  : array
Returns a "fake TCA" for the be_users_settings pseudo-table.
getTcaFieldName()  : string
Returns a partitioned field name for use in TCA.
getTcaShowitem()  : string
Get the partitioned showitem string to be used as virtual TCA.
isDbColumnSetting()  : bool
isJsonFieldSetting()  : bool
resolveInheritFromParent()  : array
Resolves inheritFromParent for a TCA column by merging with the parent be_users TCA column configuration. Returns TCA format (without legacy conversion).

Methods

getColumn()

Get configuration for a specific field in legacy format.

public getColumn(string $fieldName) : array|null

Parameters

$fieldName : string

Return values

array|null

getColumns()

Get all column configurations in legacy format.

public getColumns() : array<string, array>

This merges TCA-based config with legacy global, preferring TCA.

Return values

array<string, array>

getDbColumnSettingKeys()

public getDbColumnSettingKeys() : string[]

Return values

string[]

getDefault()

public getDefault(string $key) : mixed

Parameters

$key : string

getJsonFieldSettingKeys()

public getJsonFieldSettingKeys() : array<int, string>

Return values

array<int, string>

getPersistentUpdateFieldNames()

Returns field names that should trigger a JS persistent storage update when their value changes in User Settings, so JS components can react immediately without a page reload.

public getPersistentUpdateFieldNames() : string[]

Return values

string[]

getRawShowitem()

Get the raw showitem string (merged from TCA and legacy global).

public getRawShowitem() : string

Return values

string

getTca()

Returns a "fake TCA" for the be_users_settings pseudo-table.

public getTca() : array

Return values

array

getTcaFieldName()

Returns a partitioned field name for use in TCA.

public getTcaFieldName(string $fieldName) : string
  • e.g. be_users__password, reflecting be_users values
  • e.g. user_settings__titleLen, reflecting JSON values

Parameters

$fieldName : string

Return values

string

getTcaShowitem()

Get the partitioned showitem string to be used as virtual TCA.

public getTcaShowitem() : string

Return values

string

isDbColumnSetting()

public isDbColumnSetting(string $key) : bool

Parameters

$key : string

Return values

bool

isJsonFieldSetting()

public isJsonFieldSetting(string $key) : bool

Parameters

$key : string

Return values

bool

resolveInheritFromParent()

Resolves inheritFromParent for a TCA column by merging with the parent be_users TCA column configuration. Returns TCA format (without legacy conversion).

public resolveInheritFromParent(string $fieldName, array $tcaConfig) : array

Parameters

$fieldName : string
$tcaConfig : array

Return values

array
On this page