Richtext
Prepare richtext configuration. Used in DataHandler and FormEngine
Internal class for the time being - may change / vanish any time
Tags
Table of Contents
Methods
- getConfiguration() : array<string|int, mixed>
- This is an intermediate class / method to retrieve RTE configuration until all core places use data providers to do that.
- addFlattenedPageTsConfig() : array<string|int, mixed>
- Add all PageTS.RTE options keys to configuration without dots
- convertPlainArrayToTypoScriptArray() : array<string|int, mixed>
- Returns an array with Typoscript the old way (with dot) Since the functionality in YAML is without the dots, but the new configuration is used without the dots this functionality adds also an explicit = 1 to the arrays
- getPageTsConfiguration() : array<string|int, mixed>
- Load PageTS configuration for the RTE
- getRtePageTsConfigOfPid() : array<string|int, mixed>
- Return RTE section of page TS
- loadConfigurationFromPreset() : array<string|int, mixed>
- Load a configuration preset from an external resource (currently only YAML is supported).
Methods
getConfiguration()
This is an intermediate class / method to retrieve RTE configuration until all core places use data providers to do that.
public
getConfiguration(string $table, string $field, int $pid, string $recordType, array<string|int, mixed> $tcaFieldConf) : array<string|int, mixed>
Parameters
- $table : string
-
The table the field is in
- $field : string
-
Field name
- $pid : int
-
Real page id
- $recordType : string
-
Record type value
- $tcaFieldConf : array<string|int, mixed>
-
['config'] section of TCA field
Return values
array<string|int, mixed>addFlattenedPageTsConfig()
Add all PageTS.RTE options keys to configuration without dots
protected
addFlattenedPageTsConfig(array<string|int, mixed> $typoScriptArray) : array<string|int, mixed>
We need to keep the dotted keys for backwards compatibility like ext:rtehtmlarea
Parameters
- $typoScriptArray : array<string|int, mixed>
-
TypoScriptArray
Return values
array<string|int, mixed> —array with config without dots added
convertPlainArrayToTypoScriptArray()
Returns an array with Typoscript the old way (with dot) Since the functionality in YAML is without the dots, but the new configuration is used without the dots this functionality adds also an explicit = 1 to the arrays
protected
convertPlainArrayToTypoScriptArray(array<string|int, mixed> $plainArray) : array<string|int, mixed>
Parameters
- $plainArray : array<string|int, mixed>
-
An array
Return values
array<string|int, mixed> —array with TypoScript as usual (with dot)
getPageTsConfiguration()
Load PageTS configuration for the RTE
protected
getPageTsConfiguration(string $table, string $field, int $pid, string $recordType) : array<string|int, mixed>
Return RTE section of page TS, taking into account overloading via table, field and record type
Parameters
- $table : string
-
The table the field is in
- $field : string
-
Field name
- $pid : int
-
Real page id
- $recordType : string
-
Record type value
Return values
array<string|int, mixed>getRtePageTsConfigOfPid()
Return RTE section of page TS
protected
getRtePageTsConfigOfPid(int $pid) : array<string|int, mixed>
Parameters
- $pid : int
-
Page ts of given pid
Return values
array<string|int, mixed> —RTE section of pageTs of given pid
loadConfigurationFromPreset()
Load a configuration preset from an external resource (currently only YAML is supported).
protected
loadConfigurationFromPreset([string $presetName = '' ]) : array<string|int, mixed>
This is the default behaviour and can be overridden by pageTSconfig.
Parameters
- $presetName : string = ''
Return values
array<string|int, mixed> —the parsed configuration