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.

Internal

This class is not part of the TYPO3 Core API yet.

Table of Contents

Methods

getColumn()  : array<string|int, mixed>|null
Get configuration for a specific field in legacy format.
getColumns()  : array<string, array<string|int, mixed>>
Get all column configurations in legacy format.
getDbColumnSettingKeys()  : array<string|int, string>
getDefault()  : mixed
getJsonFieldSettingKeys()  : array<string|int, string>
getPersistentUpdateFieldNames()  : array<string|int, 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.
getShowitem()  : string
Get the showitem string (merged from TCA and legacy global).
isDbColumnSetting()  : bool
isJsonFieldSetting()  : bool

Methods

getColumn()

Get configuration for a specific field in legacy format.

public getColumn(string $fieldName) : array<string|int, mixed>|null
Parameters
$fieldName : string
Return values
array<string|int, mixed>|null

getColumns()

Get all column configurations in legacy format.

public getColumns() : array<string, array<string|int, mixed>>

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

Return values
array<string, array<string|int, mixed>>

getDbColumnSettingKeys()

public getDbColumnSettingKeys() : array<string|int, string>
Return values
array<string|int, string>

getDefault()

public getDefault(string $key) : mixed
Parameters
$key : string

getJsonFieldSettingKeys()

public getJsonFieldSettingKeys() : array<string|int, string>
Return values
array<string|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() : array<string|int, string>
Return values
array<string|int, string>

getShowitem()

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

public getShowitem() : 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 

        

        
    




    

    

                            

            

                            
    

        On this page

        
    


            

                    

        

    

        

            
Search results