‪TYPO3CMS  11.5
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
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 ()
 
array checkIntegrity (\stdClass $parameters)
 
array getWorkspaceInfos ($parameter)
 
array getRowDetails ($parameter)
 

Protected Member Functions

array getCommentsForRecord (array $historyEntries, array $additionalChangesFromLog)
 
 getStageChangesFromSysLog (string $table, int $uid)
 
 getBackendUser ()
 
 getLanguageService ()
 
DiffUtility getDifferenceHandler ()
 
IntegrityService createIntegrityService (array $affectedElements)
 
array getAffectedElements (\stdClass $parameters)
 
int null validateLanguageParameter (\stdClass $parameters)
 
int getCurrentWorkspace ()
 
array getSuitableFields (string $table, int $uid)
 
- ‪Protected Member Functions inherited from ‪TYPO3\CMS\Core\Log\LogDataTrait
array null unserializeLogData ($logData)
 
string formatLogDetails (string $detailString, $substitutes)
 

Protected Attributes

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

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 48 of file RemoteServer.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Workspaces\Controller\Remote\RemoteServer::__construct ( )

Definition at line 67 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.

Parameters
\stdClass$parameters
Returns
‪array

Definition at line 80 of file RemoteServer.php.

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

◆ createIntegrityService()

IntegrityService 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
Returns
‪IntegrityService
See also
‪getAffectedElements

Definition at line 507 of file RemoteServer.php.

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

◆ getAffectedElements()

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

Parameters
\stdClass$parameters
Returns
‪array

Definition at line 523 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

Definition at line 475 of file RemoteServer.php.

References $GLOBALS.

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

◆ getCommentsForRecord()

array 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$historyEntries
array$additionalChangesFromLog‪this is not in use since 2022 anymore, and can be removed in TYPO3 v13.0 the latest.
Returns
‪array

Definition at line 404 of file RemoteServer.php.

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

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

◆ getCurrentWorkspace()

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

Gets the current workspace ID.

Returns
‪int The current workspace ID

Definition at line 571 of file RemoteServer.php.

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

◆ getDifferenceHandler()

DiffUtility TYPO3\CMS\Workspaces\Controller\Remote\RemoteServer::getDifferenceHandler ( )
protected

Gets the difference handler, parsing differences based on sentences.

Returns
‪DiffUtility

Definition at line 490 of file RemoteServer.php.

References TYPO3\CMS\Workspaces\Controller\Remote\RemoteServer\$differenceHandler.

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

◆ getLanguageService()

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

Definition at line 480 of file RemoteServer.php.

References $GLOBALS.

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

◆ getRowDetails()

array TYPO3\CMS\Workspaces\Controller\Remote\RemoteServer::getRowDetails (   $parameter)

Fetch further information to current selected workspace record.

Parameters
\stdClass$parameter
Returns
‪array $data

Definition at line 125 of file RemoteServer.php.

References $GLOBALS, TYPO3\CMS\Core\Type\Enumeration\cast(), TYPO3\CMS\Core\Versioning\VersionState\DELETE_PLACEHOLDER, TYPO3\CMS\Workspaces\Controller\Remote\RemoteServer\getBackendUser(), TYPO3\CMS\Workspaces\Controller\Remote\RemoteServer\getCommentsForRecord(), TYPO3\CMS\Workspaces\Controller\Remote\RemoteServer\getDifferenceHandler(), TYPO3\CMS\Workspaces\Controller\Remote\RemoteServer\getLanguageService(), TYPO3\CMS\Workspaces\Controller\Remote\RemoteServer\getStageChangesFromSysLog(), TYPO3\CMS\Workspaces\Controller\Remote\RemoteServer\getSuitableFields(), TYPO3\CMS\Core\Versioning\VersionState\NEW_PLACEHOLDER, TYPO3\CMS\Core\Imaging\Icon\SIZE_SMALL, and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

◆ 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 445 of file RemoteServer.php.

References TYPO3\CMS\Core\Database\Connection\PARAM_INT, and TYPO3\CMS\Core\Database\Connection\PARAM_STR.

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

◆ getSuitableFields()

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

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

Parameters
string$table
int$uid
Returns
‪array

Definition at line 583 of file RemoteServer.php.

References $GLOBALS, 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)

Get List of workspace changes

Parameters
\stdClass$parameter
Returns
‪array $data

Definition at line 96 of file RemoteServer.php.

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

◆ validateLanguageParameter()

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

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

Parameters
\stdClass$parameters
Returns
‪int|null

Definition at line 557 of file RemoteServer.php.

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

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

Member Data Documentation

◆ $differenceHandler

DiffUtility null TYPO3\CMS\Workspaces\Controller\Remote\RemoteServer::$differenceHandler
protected

Definition at line 65 of file RemoteServer.php.

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

◆ $gridDataService

GridDataService TYPO3\CMS\Workspaces\Controller\Remote\RemoteServer::$gridDataService
protected

Definition at line 53 of file RemoteServer.php.

◆ $stagesService

StagesService TYPO3\CMS\Workspaces\Controller\Remote\RemoteServer::$stagesService
protected

Definition at line 57 of file RemoteServer.php.

◆ $workspaceService

WorkspaceService TYPO3\CMS\Workspaces\Controller\Remote\RemoteServer::$workspaceService
protected

Definition at line 61 of file RemoteServer.php.