RemoteServer

class \TYPO3\CMS\Workspaces\Controller\Remote\RemoteServer

Uses
LogDataTrait

Class RemoteServer

Table of Contents

Properties

$differenceHandler  : DiffUtility|null
$gridDataService  : GridDataService
$stagesService  : StagesService
$workspaceService  : WorkspaceService

Methods

__construct()  : mixed
checkIntegrity()  : array
Checks integrity of elements before performing actions on them.
getRowDetails()  : array
Fetch further information to current selected workspace record.
getWorkspaceInfos()  : array
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
Gets affected elements on publishing/swapping actions.
getBackendUser()  : BackendUserAuthentication
getCommentsForRecord()  : array
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
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
Gets the fields suitable for being displayed in new and delete diff views
prepareFileReferenceDifferences()  : array|null
Prepares difference view for file references.
unserializeLogData()  : array|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

Parameters

$parameters : stdClass

Return values

array

getRowDetails()

Fetch further information to current selected workspace record.

public getRowDetails(stdClass $parameter) : array

Parameters

$parameter : stdClass

Return values

array —

$data

getWorkspaceInfos()

Get List of workspace changes

public getWorkspaceInfos(stdClass $parameter) : array

Parameters

$parameter : stdClass

Return values

array —

$data

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 $substitutes) : string

Replaces a string with placeholders (%s or {myPlaceholder}) with its substitutes.

Parameters

$detailString : string
$substitutes : array

Return values

string

getAffectedElements()

Gets affected elements on publishing/swapping actions.

protected getAffectedElements(stdClass $parameters) : array

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

getCommentsForRecord()

Prepares all comments of the stage change history entries for returning the JSON structure

protected getCommentsForRecord(array $historyEntries, array $additionalChangesFromLog) : array

Parameters

$historyEntries : array
$additionalChangesFromLog : array

this is not in use since 2022 anymore, and can be removed in TYPO3 v13.0 the latest.

Return values

array

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

Parameters

$table : string
$uid : int

Return values

array

getSuitableFields()

Gets the fields suitable for being displayed in new and delete diff views

protected getSuitableFields(string $table, int $uid) : array

Parameters

$table : string
$uid : int

Return values

array

prepareFileReferenceDifferences()

Prepares difference view for file references.

protected prepareFileReferenceDifferences(FileReference[] $liveFileReferences, FileReference[] $versionFileReferences[, bool|false $useThumbnails = false ]) : array|null

Parameters

$liveFileReferences : FileReference[]
$versionFileReferences : FileReference[]
$useThumbnails : bool|false = false

Return values

array|null

unserializeLogData()

Useful for handling old serialized data, which might have been migrated to JSON encoded properties already.

protected unserializeLogData(mixed $logData) : array|null

Parameters

$logData : mixed

Return values

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