RemoteServer uses LogDataTrait

Class RemoteServer

Internal

This is a specific Backend Controller implementation and is not considered part of the Public TYPO3 API.

Table of Contents

Properties

$differenceHandler  : DiffUtility|null
$gridDataService  : GridDataService
$stagesService  : StagesService
$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.
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.
getDifferenceHandler()  : DiffUtility
Gets the difference handler, parsing differences based on sentences.
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

Methods

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) : array<string|int, mixed>
Parameters
$parameter : stdClass
Return values
array<string|int, mixed> —

$data

getWorkspaceInfos()

Get List of workspace changes

public getWorkspaceInfos(stdClass $parameter) : array<string|int, mixed>
Parameters
$parameter : stdClass
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
see
getAffectedElements
Return values
IntegrityService

formatLogDetails()

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
string

formatLogDetailsStatic()

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
string

getAffectedElements()

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>

getCommentsForRecord()

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
int —

The current workspace ID

getDifferenceHandler()

Gets the difference handler, parsing differences based on sentences.

protected getDifferenceHandler() : DiffUtility
Return values
DiffUtility

getStageChangesFromSysLog()

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) : array<string|int, mixed>
Parameters
$table : string
$uid : int
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>|null

unserializeLogData()

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>|null

validateLanguageParameter()

Validates whether the submitted language parameter can be interpreted as integer value.

protected validateLanguageParameter(stdClass $parameters) : int|null
Parameters
$parameters : stdClass
Return values
int|null 

        

        
    




    

    

                            

            

                            
    

        On this page

        
    


            

                    

        

    

        

            
Search results