RemoteServer uses LogDataTrait
Read onlyYes
This is a specific Backend Controller implementation and is not considered part of the Public TYPO3 API.
Attributes
- #[Autoconfigure]
- $public: true
Table of Contents
Properties
- $avatar : Avatar
- $connectionPool : ConnectionPool
- $eventDispatcher : EventDispatcherInterface
- $flexFormValueFormatter : FlexFormValueFormatter
- $gridDataService : GridDataService
- $iconFactory : IconFactory
- $stagesService : StagesService
- $tcaDatabaseRecord : TcaDatabaseRecord
- $workspaceService : WorkspaceService
Methods
- __construct() : mixed
- checkIntegrity() : array<string|int, mixed>
- Checks integrity of elements before performing actions on them.
- getRowDetails() : array<string|int, mixed>
- Fetch further information to current selected workspace record.
- getWorkspaceInfos() : array<string|int, mixed>
- Get List of workspace changes
- createIntegrityService() : IntegrityService
- Creates a new instance of the integrity service for the given set of affected elements.
- formatLogDetails() : string
- Replaces a string with placeholders (%s or {myPlaceholder}) with its substitutes.
- formatLogDetailsStatic() : string
- Static version for ViewHelpers etc.
- formatValue() : string
- getAffectedElements() : array<string|int, mixed>
- Gets affected elements on publishing/swapping actions.
- getBackendUser() : BackendUserAuthentication
- getCommentsForRecord() : array<string|int, mixed>
- Prepares all comments of the stage change history entries for returning the JSON structure
- getCurrentWorkspace() : int
- Gets the current workspace ID.
- getLanguageService() : LanguageService
- getStageChangesFromSysLog() : array<string|int, mixed>
- Find all stage changes from sys_log that do not have a historyId. Can safely be removed in future TYPO3 versions as this fallback layer only makes sense in TYPO3 v11 when old records want to have a history.
- getSuitableFields() : array<string|int, mixed>
- Gets the fields suitable for being displayed in new and delete diff views
- prepareFileReferenceDifferences() : array<string|int, mixed>|null
- Prepares difference view for file references.
- unserializeLogData() : array<string|int, mixed>|null
- Useful for handling old serialized data, which might have been migrated to JSON encoded properties already.
- validateLanguageParameter() : int|null
- Validates whether the submitted language parameter can be interpreted as integer value.
Properties
$avatar
protected
Avatar
$avatar
$connectionPool
protected
ConnectionPool
$connectionPool
$eventDispatcher
protected
EventDispatcherInterface
$eventDispatcher
$flexFormValueFormatter
protected
FlexFormValueFormatter
$flexFormValueFormatter
$gridDataService
protected
GridDataService
$gridDataService
$iconFactory
protected
IconFactory
$iconFactory
$stagesService
protected
StagesService
$stagesService
$tcaDatabaseRecord
protected
TcaDatabaseRecord
$tcaDatabaseRecord
$workspaceService
protected
WorkspaceService
$workspaceService
Methods
__construct()
public
__construct(GridDataService $gridDataService, StagesService $stagesService, WorkspaceService $workspaceService, EventDispatcherInterface $eventDispatcher, FormDataCompiler $formDataCompiler, FlexFormValueFormatter $flexFormValueFormatter, DiffUtility $diffUtility, IconFactory $iconFactory, Avatar $avatar, ConnectionPool $connectionPool, TcaDatabaseRecord $tcaDatabaseRecord) : mixed
Parameters
- $gridDataService : GridDataService
- $stagesService : StagesService
- $workspaceService : WorkspaceService
- $eventDispatcher : EventDispatcherInterface
- $formDataCompiler : FormDataCompiler
- $flexFormValueFormatter : FlexFormValueFormatter
- $diffUtility : DiffUtility
- $iconFactory : IconFactory
- $avatar : Avatar
- $connectionPool : ConnectionPool
- $tcaDatabaseRecord : TcaDatabaseRecord
checkIntegrity()
Checks integrity of elements before performing actions on them.
public
checkIntegrity(stdClass $parameters) : array<string|int, mixed>
Parameters
- $parameters : stdClass
Return values
array<string|int, mixed>getRowDetails()
Fetch further information to current selected workspace record.
public
getRowDetails(stdClass $parameter, ServerRequestInterface $request) : array<string|int, mixed>
Parameters
- $parameter : stdClass
- $request : ServerRequestInterface
Return values
array<string|int, mixed> —$data
getWorkspaceInfos()
Get List of workspace changes
public
getWorkspaceInfos(stdClass $parameter, ServerRequestInterface $request) : array<string|int, mixed>
Parameters
- $parameter : stdClass
- $request : ServerRequestInterface
Return values
array<string|int, mixed> —$data
createIntegrityService()
Creates a new instance of the integrity service for the given set of affected elements.
protected
createIntegrityService(array<string|int, CombinedRecord> $affectedElements) : IntegrityService
Parameters
- $affectedElements : array<string|int, CombinedRecord>
Tags
Return values
IntegrityServiceformatLogDetails()
Replaces a string with placeholders (%s or {myPlaceholder}) with its substitutes.
protected
formatLogDetails(string $detailString, mixed $substitutes) : string
Parameters
- $detailString : string
- $substitutes : mixed
Return values
stringformatLogDetailsStatic()
Static version for ViewHelpers etc.
protected
static formatLogDetailsStatic(string $detailString, array<string|int, mixed> $substitutes) : string
Replaces a string with placeholders (%s or {myPlaceholder}) with its substitutes.
Parameters
- $detailString : string
- $substitutes : array<string|int, mixed>
Return values
stringformatValue()
protected
formatValue(string $table, string $fieldName, string $value, int $uid, array<string|int, mixed> $tcaConfiguration) : string
Parameters
- $table : string
- $fieldName : string
- $value : string
- $uid : int
- $tcaConfiguration : array<string|int, mixed>
Return values
stringgetAffectedElements()
Gets affected elements on publishing/swapping actions.
protected
getAffectedElements(stdClass $parameters) : array<string|int, mixed>
Affected elements have a dependency, e.g. translation overlay and the default origin record - thus, the default record would be affected if the translation overlay shall be published.
Parameters
- $parameters : stdClass
Return values
array<string|int, mixed>getBackendUser()
protected
getBackendUser() : BackendUserAuthentication
Return values
BackendUserAuthenticationgetCommentsForRecord()
Prepares all comments of the stage change history entries for returning the JSON structure
protected
getCommentsForRecord(array<string|int, mixed> $historyEntries, array<string|int, mixed> $additionalChangesFromLog) : array<string|int, mixed>
Parameters
- $historyEntries : array<string|int, mixed>
- $additionalChangesFromLog : array<string|int, mixed>
-
this is not in use since 2022 anymore, and can be removed in TYPO3 v13.0 the latest.
Return values
array<string|int, mixed>getCurrentWorkspace()
Gets the current workspace ID.
protected
getCurrentWorkspace() : int
Return values
intgetLanguageService()
protected
getLanguageService() : LanguageService
Return values
LanguageServicegetStageChangesFromSysLog()
Find all stage changes from sys_log that do not have a historyId. Can safely be removed in future TYPO3 versions as this fallback layer only makes sense in TYPO3 v11 when old records want to have a history.
protected
getStageChangesFromSysLog(string $table, int $uid) : array<string|int, mixed>
Parameters
- $table : string
- $uid : int
Return values
array<string|int, mixed>getSuitableFields()
Gets the fields suitable for being displayed in new and delete diff views
protected
getSuitableFields(string $table, int $uid, ServerRequestInterface $request) : array<string|int, mixed>
Parameters
- $table : string
- $uid : int
- $request : ServerRequestInterface
Return values
array<string|int, mixed>prepareFileReferenceDifferences()
Prepares difference view for file references.
protected
prepareFileReferenceDifferences(array<string|int, FileReference> $liveFileReferences, array<string|int, FileReference> $versionFileReferences[, bool|false $useThumbnails = false ]) : array<string|int, mixed>|null
Parameters
- $liveFileReferences : array<string|int, FileReference>
- $versionFileReferences : array<string|int, FileReference>
- $useThumbnails : bool|false = false
Return values
array<string|int, mixed>|nullunserializeLogData()
Useful for handling old serialized data, which might have been migrated to JSON encoded properties already.
protected
unserializeLogData(mixed $logData) : array<string|int, mixed>|null
Parameters
- $logData : mixed
Return values
array<string|int, mixed>|nullvalidateLanguageParameter()
Validates whether the submitted language parameter can be interpreted as integer value.
protected
validateLanguageParameter(stdClass $parameters) : int|null
Parameters
- $parameters : stdClass