ActionHandler
This is a specific Backend Controller implementation and is not considered part of the Public TYPO3 API.
Table of Contents
Properties
Methods
- __construct() : mixed
- Creates this object.
- deleteSingleRecord() : mixed
- Deletes a single record.
- discardStagesFromPage() : array<string|int, mixed>
- Discard all items from given page id.
- executeSelectionAction() : array<string|int, mixed>
- Executes an action (publish, discard) to a selection set.
- generateWorkspacePreviewLink() : string
- Generates a workspace preview link.
- generateWorkspacePreviewLinksForAllLanguages() : array<string|int, mixed>
- Generates workspace preview links for all available languages of a page.
- getRecipientList() : array<string|int, mixed>
- 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<string|int, mixed>
- sendPageToPreviousStage() : array<string|int, mixed>
- Send all available workspace records to the previous stage.
- sendToNextStageExecute() : array<string|int, mixed>
- Gets an object with this structure:
- sendToNextStageWindow() : array<string|int, mixed>
- Gets the dialog window to be displayed before a record can be sent to the next stage.
- sendToPrevStageExecute() : array<string|int, mixed>
- Gets an object with this structure:
- sendToPrevStageWindow() : array<string|int, mixed>
- Gets the dialog window to be displayed before a record can be sent to the previous stage.
- sendToSpecificStageExecute() : array<string|int, mixed>
- Gets an object with this structure:
- sendToSpecificStageWindow() : array<string|int, mixed>
- Gets the dialog window to be displayed before a record can be sent to a specific stage.
- sentCollectionToStage() : array<string|int, mixed>
- 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<string|int, mixed>
- Gets an error response to be shown in the grid component.
- getFlushCommands() : array<string|int, mixed>
- Get flush commands
- getLanguageService() : LanguageService
- getPublishCommands() : array<string|int, mixed>
- Get publish commands
- getRecipientsOfStage() : array<string|int, mixed>
- Gets all assigned recipients of a particular stage.
- getSentToStageWindow() : array<string|int, mixed>
- Gets the dialog window to be displayed before a record can be sent to a stage.
- processTcaCmd() : array<string|int, mixed>
- Process TCA command map array.
Properties
$stageService
protected
StagesService
$stageService
$workspaceService
protected
WorkspaceService
$workspaceService
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
discardStagesFromPage()
Discard all items from given page id.
public
discardStagesFromPage(int $pageId) : array<string|int, mixed>
Parameters
- $pageId : int
Return values
array<string|int, mixed>executeSelectionAction()
Executes an action (publish, discard) to a selection set.
public
executeSelectionAction(stdClass $parameter) : array<string|int, mixed>
Parameters
- $parameter : stdClass
Return values
array<string|int, mixed>generateWorkspacePreviewLink()
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<string|int, mixed>
Parameters
- $uid : int
Return values
array<string|int, mixed>getRecipientList()
Gets a merged variant of recipient defined by uid and custom ones.
public
getRecipientList(array<string|int, mixed> $uidOfRecipients, string $additionalRecipients, int $stageId) : array<string|int, mixed>
Parameters
- $uidOfRecipients : array<string|int, mixed>
-
list of recipients
- $additionalRecipients : string
-
given user string of additional recipients
- $stageId : int
-
stage id
Tags
Return values
array<string|int, mixed>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
saveColumnModel()
Saves the selected columns to be shown to the preferences of the current backend user.
public
saveColumnModel(array<string|int, stdClass> $model) : mixed
Parameters
- $model : array<string|int, stdClass>
sendPageToNextStage()
public
sendPageToNextStage(int $id) : array<string|int, mixed>
Parameters
- $id : int
-
Current Page id to select Workspace items from.
Return values
array<string|int, mixed>sendPageToPreviousStage()
Send all available workspace records to the previous stage.
public
sendPageToPreviousStage(int $id) : array<string|int, mixed>
Parameters
- $id : int
-
Current page id to process items to previous stage.
Return values
array<string|int, mixed>sendToNextStageExecute()
Gets an object with this structure:
public
sendToNextStageExecute(stdClass $parameters) : array<string|int, mixed>
affects: object table t3ver_oid nextStage uid recipients: array with uids additional: string comments: string
Parameters
- $parameters : stdClass
Return values
array<string|int, mixed>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<string|int, mixed>
Parameters
- $uid : int
- $table : string
- $t3ver_oid : int
Return values
array<string|int, mixed>sendToPrevStageExecute()
Gets an object with this structure:
public
sendToPrevStageExecute(stdClass $parameters) : array<string|int, mixed>
affects: object table t3ver_oid nextStage recipients: array with uids additional: string comments: string
Parameters
- $parameters : stdClass
Return values
array<string|int, mixed>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<string|int, mixed>
Parameters
- $uid : int
- $table : string
Return values
array<string|int, mixed>sendToSpecificStageExecute()
Gets an object with this structure:
public
sendToSpecificStageExecute(stdClass $parameters) : array<string|int, mixed>
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<string|int, mixed>sendToSpecificStageWindow()
Gets the dialog window to be displayed before a record can be sent to a specific stage.
public
sendToSpecificStageWindow(int $nextStageId, array<string|int, mixed>|array<string|int, stdClass> $elements) : array<string|int, mixed>
Parameters
- $nextStageId : int
- $elements : array<string|int, mixed>|array<string|int, stdClass>
Return values
array<string|int, mixed>sentCollectionToStage()
Push the given element collection to the next workspace stage.
public
sentCollectionToStage(stdClass $parameters) : array<string|int, mixed>
$parameters->additional = your@mail.com
$parameters->affects->__TABLENAME__
$parameters->comments
$parameters->recipients
$parameters->stageId
Parameters
- $parameters : stdClass
Return values
array<string|int, mixed>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
stringgetBackendUser()
protected
getBackendUser() : BackendUserAuthentication
Return values
BackendUserAuthenticationgetCurrentWorkspace()
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
stringgetErrorResponse()
Gets an error response to be shown in the grid component.
protected
getErrorResponse(string $errorLabel[, int $errorCode = 0 ][, bool $successFlagValue = false ]) : array<string|int, mixed>
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<string|int, mixed>getFlushCommands()
Get flush commands
protected
getFlushCommands(array<string|int, mixed>|array<string|int, stdClass> $selection) : array<string|int, mixed>
Parameters
- $selection : array<string|int, mixed>|array<string|int, stdClass>
Return values
array<string|int, mixed>getLanguageService()
protected
getLanguageService() : LanguageService
Return values
LanguageServicegetPublishCommands()
Get publish commands
protected
getPublishCommands(array<string|int, mixed>|array<string|int, stdClass> $selection) : array<string|int, mixed>
Parameters
- $selection : array<string|int, mixed>|array<string|int, stdClass>
Return values
array<string|int, mixed>getRecipientsOfStage()
Gets all assigned recipients of a particular stage.
protected
getRecipientsOfStage(StageRecord|int $stageRecord) : array<string|int, mixed>
Parameters
- $stageRecord : StageRecord|int
Return values
array<string|int, mixed>getSentToStageWindow()
Gets the dialog window to be displayed before a record can be sent to a stage.
protected
getSentToStageWindow(StageRecord|int $nextStage) : array<string|int, mixed>
Parameters
- $nextStage : StageRecord|int
Return values
array<string|int, mixed>processTcaCmd()
Process TCA command map array.
protected
processTcaCmd(array<string|int, mixed> $cmdMapArray) : array<string|int, mixed>
Parameters
- $cmdMapArray : array<string|int, mixed>