ActionHandler

class \TYPO3\CMS\Workspaces\Controller\Remote\ActionHandler

Table of Contents

Properties

$stageService  : StagesService
$workspaceService  : WorkspaceService

Methods

__construct()  : mixed
Creates this object.
deleteSingleRecord()  : mixed
Deletes a single record.
discardStagesFromPage()  : array
Discard all items from given page id.
executeSelectionAction()  : array
Executes an action (publish, discard) to a selection set.
generateWorkspacePreviewLink()  : string
Generates a workspace preview link.
generateWorkspacePreviewLinksForAllLanguages()  : array
Generates workspace preview links for all available languages of a page.
getRecipientList()  : array
Gets a merged variant of recipient defined by uid and custom ones.
loadColumnModel()  : mixed
publishSingleRecord()  : mixed
Publishes a single record.
saveColumnModel()  : mixed
Saves the selected columns to be shown to the preferences of the current backend user.
sendPageToNextStage()  : array
sendPageToPreviousStage()  : array
Send all available workspace records to the previous stage.
sendToNextStageExecute()  : array
Gets an object with this structure:
sendToNextStageWindow()  : array
Gets the dialog window to be displayed before a record can be sent to the next stage.
sendToPrevStageExecute()  : array
Gets an object with this structure:
sendToPrevStageWindow()  : array
Gets the dialog window to be displayed before a record can be sent to the previous stage.
sendToSpecificStageExecute()  : array
Gets an object with this structure:
sendToSpecificStageWindow()  : array
Gets the dialog window to be displayed before a record can be sent to a specific stage.
sentCollectionToStage()  : array
Push the given element collection to the next workspace stage.
updateStageChangeButtons()  : string
Fetch the current label and visible state of the buttons.
viewSingleRecord()  : string
Generates a view link for a page.
getBackendUser()  : BackendUserAuthentication
getCurrentWorkspace()  : int
Gets the current workspace ID.
getDefaultCommentOfStage()  : string
Gets the default comment of a particular stage.
getErrorResponse()  : array
Gets an error response to be shown in the grid component.
getFlushCommands()  : array
Get flush commands
getLanguageService()  : LanguageService
getPublishCommands()  : array
Get publish commands
getRecipientsOfStage()  : array
Gets all assigned recipients of a particular stage.
getSentToStageWindow()  : array
Gets the dialog window to be displayed before a record can be sent to a stage.
processTcaCmd()  : array
Process TCA command map array.

Properties

Methods

__construct()

Creates this object.

public __construct() : mixed

deleteSingleRecord()

Deletes a single record.

public deleteSingleRecord(string $table, int $uid) : mixed

Parameters

$table : string
$uid : int

Tags

todo

What about reporting errors back to the interface? /olly/

discardStagesFromPage()

Discard all items from given page id.

public discardStagesFromPage(int $pageId) : array

Parameters

$pageId : int

Return values

array

executeSelectionAction()

Executes an action (publish, discard) to a selection set.

public executeSelectionAction(stdClass $parameter) : array

Parameters

$parameter : stdClass

Return values

array

Generates a workspace preview link.

public generateWorkspacePreviewLink(int $uid) : string

Parameters

$uid : int

The ID of the record to be linked

Return values

string —

the full domain including the protocol http:// or https://, but without the trailing '/'

generateWorkspacePreviewLinksForAllLanguages()

Generates workspace preview links for all available languages of a page.

public generateWorkspacePreviewLinksForAllLanguages(int $uid) : array

Parameters

$uid : int

Return values

array

getRecipientList()

Gets a merged variant of recipient defined by uid and custom ones.

public getRecipientList(array $uidOfRecipients, string $additionalRecipients, int $stageId) : array

Parameters

$uidOfRecipients : array

list of recipients

$additionalRecipients : string

given user string of additional recipients

$stageId : int

stage id

Tags

throws
InvalidArgumentException

Return values

array

loadColumnModel()

public loadColumnModel() : mixed

publishSingleRecord()

Publishes a single record.

public publishSingleRecord(string $table, int $t3ver_oid, int $orig_uid) : mixed

Parameters

$table : string
$t3ver_oid : int
$orig_uid : int

Tags

todo

What about reporting errors back to the interface? /olly/

saveColumnModel()

Saves the selected columns to be shown to the preferences of the current backend user.

public saveColumnModel(stdClass[] $model) : mixed

Parameters

$model : stdClass[]

sendPageToNextStage()

public sendPageToNextStage(int $id) : array

Parameters

$id : int

Current Page id to select Workspace items from.

Return values

array

sendPageToPreviousStage()

Send all available workspace records to the previous stage.

public sendPageToPreviousStage(int $id) : array

Parameters

$id : int

Current page id to process items to previous stage.

Return values

array

sendToNextStageExecute()

Gets an object with this structure:

public sendToNextStageExecute(stdClass $parameters) : array

affects: object table t3ver_oid nextStage uid recipients: array with uids additional: string comments: string

Parameters

$parameters : stdClass

Return values

array

sendToNextStageWindow()

Gets the dialog window to be displayed before a record can be sent to the next stage.

public sendToNextStageWindow(int $uid, string $table, int $t3ver_oid) : array

Parameters

$uid : int
$table : string
$t3ver_oid : int

Return values

array

sendToPrevStageExecute()

Gets an object with this structure:

public sendToPrevStageExecute(stdClass $parameters) : array

affects: object table t3ver_oid nextStage recipients: array with uids additional: string comments: string

Parameters

$parameters : stdClass

Return values

array

sendToPrevStageWindow()

Gets the dialog window to be displayed before a record can be sent to the previous stage.

public sendToPrevStageWindow(int $uid, string $table) : array

Parameters

$uid : int
$table : string

Return values

array

sendToSpecificStageExecute()

Gets an object with this structure:

public sendToSpecificStageExecute(stdClass $parameters) : array

affects: object elements: array 0: object table t3ver_oid uid 1: object table t3ver_oid uid nextStage recipients: array with uids additional: string comments: string

Parameters

$parameters : stdClass

Return values

array

sendToSpecificStageWindow()

Gets the dialog window to be displayed before a record can be sent to a specific stage.

public sendToSpecificStageWindow(int $nextStageId, array|stdClass[] $elements) : array

Parameters

$nextStageId : int
$elements : array|stdClass[]

Return values

array

sentCollectionToStage()

Push the given element collection to the next workspace stage.

public sentCollectionToStage(stdClass $parameters) : array
$parameters->additional = your@mail.com $parameters->affects->__TABLENAME__ $parameters->comments $parameters->recipients $parameters->stageId

Parameters

$parameters : stdClass

Return values

array

updateStageChangeButtons()

Fetch the current label and visible state of the buttons.

public updateStageChangeButtons(int $id) : string

Parameters

$id : int

Return values

string —

The pre-rendered HTML for the stage buttons

viewSingleRecord()

Generates a view link for a page.

public viewSingleRecord(string $table, string $uid) : string

Parameters

$table : string
$uid : string

Return values

string

getCurrentWorkspace()

Gets the current workspace ID.

protected getCurrentWorkspace() : int

Return values

int —

The current workspace ID

getDefaultCommentOfStage()

Gets the default comment of a particular stage.

protected getDefaultCommentOfStage(int $stage) : string

Parameters

$stage : int

Return values

string

getErrorResponse()

Gets an error response to be shown in the grid component.

protected getErrorResponse(string $errorLabel[, int $errorCode = 0 ][, bool $successFlagValue = false ]) : array

Parameters

$errorLabel : string

Name of the label in the locallang.xlf file

$errorCode : int = 0

The error code to be used

$successFlagValue : bool = false

Value of the success flag to be delivered back (might be FALSE in most cases)

Return values

array

getFlushCommands()

Get flush commands

protected getFlushCommands(array|stdClass[] $selection) : array

Parameters

$selection : array|stdClass[]

Return values

array

getPublishCommands()

Get publish commands

protected getPublishCommands(array|stdClass[] $selection) : array

Parameters

$selection : array|stdClass[]

Return values

array

getRecipientsOfStage()

Gets all assigned recipients of a particular stage.

protected getRecipientsOfStage(StageRecord|int $stageRecord) : array

Parameters

$stageRecord : StageRecord|int

Return values

array

getSentToStageWindow()

Gets the dialog window to be displayed before a record can be sent to a stage.

protected getSentToStageWindow(StageRecord|int $nextStage) : array

Parameters

$nextStage : StageRecord|int

Return values

array

processTcaCmd()

Process TCA command map array.

protected processTcaCmd(array $cmdMapArray) : array

Parameters

$cmdMapArray : array

Return values

array
On this page