‪TYPO3CMS  ‪main
TYPO3\CMS\Workspaces\Controller\Remote\RemoteServer Class Reference
Inheritance diagram for TYPO3\CMS\Workspaces\Controller\Remote\RemoteServer:
TYPO3\CMS\Core\Log\LogDataTrait

Public Member Functions

 __construct (protected readonly GridDataService $gridDataService, protected readonly StagesService $stagesService, protected readonly WorkspaceService $workspaceService, protected readonly EventDispatcherInterface $eventDispatcher, private readonly FormDataCompiler $formDataCompiler, protected readonly FlexFormValueFormatter $flexFormValueFormatter,)
 
array checkIntegrity (\stdClass $parameters)
 
array getWorkspaceInfos ($parameter, ServerRequestInterface $request)
 
array getRowDetails ($parameter, ServerRequestInterface $request)
 

Protected Member Functions

 formatValue (string $table, string $fieldName, string $value, int $uid, array $tcaConfiguration)
 
 getCommentsForRecord (array $historyEntries, array $additionalChangesFromLog)
 
 getStageChangesFromSysLog (string $table, int $uid)
 
 getBackendUser ()
 
 getLanguageService ()
 
 createIntegrityService (array $affectedElements)
 
 getAffectedElements (\stdClass $parameters)
 
 validateLanguageParameter (\stdClass $parameters)
 
 getCurrentWorkspace ()
 
 getSuitableFields (string $table, int $uid, ServerRequestInterface $request)
 
- ‪Protected Member Functions inherited from ‪TYPO3\CMS\Core\Log\LogDataTrait
 unserializeLogData (mixed $logData)
 
 formatLogDetails (string $detailString, mixed $substitutes)
 

Additional Inherited Members

- ‪Static Protected Member Functions inherited from ‪TYPO3\CMS\Core\Log\LogDataTrait
static formatLogDetailsStatic (string $detailString, array $substitutes)
 

Detailed Description

Class RemoteServer

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

Definition at line 55 of file RemoteServer.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Workspaces\Controller\Remote\RemoteServer::__construct ( protected readonly GridDataService  $gridDataService,
protected readonly StagesService  $stagesService,
protected readonly WorkspaceService  $workspaceService,
protected readonly EventDispatcherInterface  $eventDispatcher,
private readonly FormDataCompiler  $formDataCompiler,
protected readonly FlexFormValueFormatter  $flexFormValueFormatter 
)

Definition at line 58 of file RemoteServer.php.

Member Function Documentation

◆ checkIntegrity()

array TYPO3\CMS\Workspaces\Controller\Remote\RemoteServer::checkIntegrity ( \stdClass  $parameters)

Checks integrity of elements before performing actions on them.

Returns
‪array

Definition at line 72 of file RemoteServer.php.

References TYPO3\CMS\Workspaces\Controller\Remote\RemoteServer\createIntegrityService(), and TYPO3\CMS\Workspaces\Controller\Remote\RemoteServer\getAffectedElements().

◆ createIntegrityService()

TYPO3\CMS\Workspaces\Controller\Remote\RemoteServer::createIntegrityService ( array  $affectedElements)
protected

Creates a new instance of the integrity service for the given set of affected elements.

Parameters
CombinedRecord[]$affectedElements
See also
getAffectedElements

Definition at line 471 of file RemoteServer.php.

Referenced by TYPO3\CMS\Workspaces\Controller\Remote\RemoteServer\checkIntegrity().

◆ formatValue()

TYPO3\CMS\Workspaces\Controller\Remote\RemoteServer::formatValue ( string  $table,
string  $fieldName,
string  $value,
int  $uid,
array  $tcaConfiguration 
)
protected

◆ getAffectedElements()

TYPO3\CMS\Workspaces\Controller\Remote\RemoteServer::getAffectedElements ( \stdClass  $parameters)
protected

Gets affected elements on publishing/swapping actions. 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.

Definition at line 484 of file RemoteServer.php.

References TYPO3\CMS\Workspaces\Domain\Model\CombinedRecord\create(), TYPO3\CMS\Workspaces\Controller\Remote\RemoteServer\getCurrentWorkspace(), and TYPO3\CMS\Workspaces\Controller\Remote\RemoteServer\validateLanguageParameter().

Referenced by TYPO3\CMS\Workspaces\Controller\Remote\RemoteServer\checkIntegrity().

◆ getBackendUser()

TYPO3\CMS\Workspaces\Controller\Remote\RemoteServer::getBackendUser ( )
protected

◆ getCommentsForRecord()

TYPO3\CMS\Workspaces\Controller\Remote\RemoteServer::getCommentsForRecord ( array  $historyEntries,
array  $additionalChangesFromLog 
)
protected

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

Parameters
array$additionalChangesFromLog‪this is not in use since 2022 anymore, and can be removed in TYPO3 v13.0 the latest.

Definition at line 383 of file RemoteServer.php.

References TYPO3\CMS\Core\Log\LogDataTrait\unserializeLogData().

Referenced by TYPO3\CMS\Workspaces\Controller\Remote\RemoteServer\getRowDetails().

◆ getCurrentWorkspace()

TYPO3\CMS\Workspaces\Controller\Remote\RemoteServer::getCurrentWorkspace ( )
protected

◆ getLanguageService()

TYPO3\CMS\Workspaces\Controller\Remote\RemoteServer::getLanguageService ( )
protected

◆ getRowDetails()

◆ getStageChangesFromSysLog()

TYPO3\CMS\Workspaces\Controller\Remote\RemoteServer::getStageChangesFromSysLog ( string  $table,
int  $uid 
)
protected

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.

Definition at line 424 of file RemoteServer.php.

References TYPO3\CMS\Webhooks\Message\$uid, and TYPO3\CMS\Core\Database\Connection\PARAM_INT.

Referenced by TYPO3\CMS\Workspaces\Controller\Remote\RemoteServer\getRowDetails().

◆ getSuitableFields()

TYPO3\CMS\Workspaces\Controller\Remote\RemoteServer::getSuitableFields ( string  $table,
int  $uid,
ServerRequestInterface  $request 
)
protected

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

Definition at line 535 of file RemoteServer.php.

References $GLOBALS, TYPO3\CMS\Webhooks\Message\$uid, and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

Referenced by TYPO3\CMS\Workspaces\Controller\Remote\RemoteServer\getRowDetails().

◆ getWorkspaceInfos()

array TYPO3\CMS\Workspaces\Controller\Remote\RemoteServer::getWorkspaceInfos (   $parameter,
ServerRequestInterface  $request 
)

Get List of workspace changes

Parameters
\stdClass$parameter
Returns
‪array $data

Definition at line 88 of file RemoteServer.php.

References TYPO3\CMS\Core\Utility\MathUtility\canBeInterpretedAsInteger(), and TYPO3\CMS\Workspaces\Controller\Remote\RemoteServer\getCurrentWorkspace().

◆ validateLanguageParameter()

TYPO3\CMS\Workspaces\Controller\Remote\RemoteServer::validateLanguageParameter ( \stdClass  $parameters)
protected

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

Definition at line 515 of file RemoteServer.php.

References TYPO3\CMS\Core\Utility\MathUtility\canBeInterpretedAsInteger().

Referenced by TYPO3\CMS\Workspaces\Controller\Remote\RemoteServer\getAffectedElements().