TYPO3\CMS\Workspaces\ExtDirect\ActionHandler Class Reference

Inheritance diagram for TYPO3\CMS\Workspaces\ExtDirect\ActionHandler:

Public Member Functions
	__construct ()
	generateWorkspacePreviewLink ($uid)
	generateWorkspacePreviewLinksForAllLanguages ($uid)
	swapSingleRecord ($table, $t3ver_oid, $orig_uid)
	deleteSingleRecord ($table, $uid)
	viewSingleRecord ($table, $uid)
	executeSelectionAction ($parameter)
	saveColumnModel ($model)
	loadColumnModel ()
	saveLanguageSelection ($language)
	sendToNextStageWindow ($uid, $table, $t3ver_oid)
	sendToPrevStageWindow ($uid, $table)
	sendToSpecificStageWindow ($nextStageId, array $elements)
	getRecipientList (array $uidOfRecipients, $additionalRecipients, $stageId)
	sentCollectionToStage (\stdClass $parameters)
	sendToNextStageExecute (\stdClass $parameters)
	sendToPrevStageExecute (\stdClass $parameters)
	sendToSpecificStageExecute (\stdClass $parameters)
	sendPageToPreviousStage ($id)
	sendPageToNextStage ($id)
	updateStageChangeButtons ($id)

Protected Member Functions
	getPublishSwapCommands (array $selection, $swapIntoWorkspace)
	getFlushCommands (array $selection)
	getSentToStageWindow ($nextStage)
	getReceipientsOfStage ($stageRecord)
	getDefaultCommentOfStage ($stage)
	getStageService ()
	setTemporaryWorkspace ($workspaceId)
	getBackendUser ()
Protected Member Functions inherited from TYPO3\CMS\Workspaces\ExtDirect\AbstractHandler
	getCurrentWorkspace ()
	getErrorResponse ($errorLabel, $errorCode=0, $successFlagValue=false)
	getWorkspaceService ()
	validateLanguageParameter (\stdClass $parameters)
	getAffectedElements (\stdClass $parameters)

Protected Attributes
	$stageService

Detailed Description

ExtDirect action handler

Definition at line 26 of file ActionHandler.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Workspaces\ExtDirect\ActionHandler::__construct

(

)

Creates this object.

Definition at line 36 of file ActionHandler.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

Member Function Documentation

deleteSingleRecord()

TYPO3\CMS\Workspaces\ExtDirect\ActionHandler::deleteSingleRecord	(		$table,
			$uid
	)

Deletes a single record.

Parameters

string	$table
int	$uid

Returns

void

Todo:

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

Definition at line 95 of file ActionHandler.php.

References $uid, TYPO3\CMS\Backend\Utility\BackendUtility\getRecord(), and TYPO3\CMS\Workspaces\ExtDirect\ActionHandler\setTemporaryWorkspace().

executeSelectionAction()

TYPO3\CMS\Workspaces\ExtDirect\ActionHandler::executeSelectionAction

(

$parameter

)

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

Parameters

\stdClass

$parameter

Returns

array

Definition at line 126 of file ActionHandler.php.

References TYPO3\CMS\Workspaces\ExtDirect\ActionHandler\getFlushCommands(), and TYPO3\CMS\Workspaces\ExtDirect\ActionHandler\getPublishSwapCommands().

generateWorkspacePreviewLink()

TYPO3\CMS\Workspaces\ExtDirect\ActionHandler::generateWorkspacePreviewLink

(

$uid

)

Generates a workspace preview link.

Parameters

int

$uid

The ID of the record to be linked

Returns

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

Definition at line 47 of file ActionHandler.php.

References $uid, and TYPO3\CMS\Workspaces\ExtDirect\AbstractHandler\getWorkspaceService().

generateWorkspacePreviewLinksForAllLanguages()

TYPO3\CMS\Workspaces\ExtDirect\ActionHandler::generateWorkspacePreviewLinksForAllLanguages

(

$uid

)

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

Parameters

int

$uid

Returns

array

Definition at line 58 of file ActionHandler.php.

References $uid, and TYPO3\CMS\Workspaces\ExtDirect\AbstractHandler\getWorkspaceService().

getBackendUser()

TYPO3\CMS\Workspaces\ExtDirect\ActionHandler::getBackendUser ( )

protected

Returns

Definition at line 859 of file ActionHandler.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Workspaces\ExtDirect\ActionHandler\setTemporaryWorkspace().

getDefaultCommentOfStage()

TYPO3\CMS\Workspaces\ExtDirect\ActionHandler::getDefaultCommentOfStage (   $stage )

protected

Gets the default comment of a particular stage.

Parameters

int

$stage

Returns

string

Definition at line 744 of file ActionHandler.php.

References TYPO3\CMS\Workspaces\ExtDirect\ActionHandler\getStageService().

getFlushCommands()

TYPO3\CMS\Workspaces\ExtDirect\ActionHandler::getFlushCommands ( array  $selection )

protected

Get flush commands

Parameters

array|

Definition at line 174 of file ActionHandler.php.

Referenced by TYPO3\CMS\Workspaces\ExtDirect\ActionHandler\executeSelectionAction().

getPublishSwapCommands()

TYPO3\CMS\Workspaces\ExtDirect\ActionHandler::getPublishSwapCommands ( array  $selection,   $swapIntoWorkspace  )

protected

Get publish swap commands

Parameters

array|

Definition at line 155 of file ActionHandler.php.

Referenced by TYPO3\CMS\Workspaces\ExtDirect\ActionHandler\executeSelectionAction().

getReceipientsOfStage()

TYPO3\CMS\Workspaces\ExtDirect\ActionHandler::getReceipientsOfStage (   $stageRecord )

protected

Gets all assigned recipients of a particular stage.

Parameters

StageRecord | int

$stageRecord

Returns

array

Definition at line 707 of file ActionHandler.php.

References TYPO3\CMS\Workspaces\Domain\Record\WorkspaceRecord\get(), TYPO3\CMS\Workspaces\ExtDirect\AbstractHandler\getCurrentWorkspace(), TYPO3\CMS\Workspaces\ExtDirect\ActionHandler\getStageService(), and TYPO3\CMS\Core\Utility\GeneralUtility\validEmail().

Referenced by TYPO3\CMS\Workspaces\ExtDirect\ActionHandler\getSentToStageWindow().

getRecipientList()

TYPO3\CMS\Workspaces\ExtDirect\ActionHandler::getRecipientList	(	array	$uidOfRecipients,
			$additionalRecipients,
			$stageId
	)

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

Parameters

array	$uidOfRecipients	list of recipients
string	$additionalRecipients	given user string of additional recipients
int	$stageId	stage id

Returns

array

Exceptions

Definition at line 337 of file ActionHandler.php.

References $GLOBALS, TYPO3\CMS\Workspaces\ExtDirect\ActionHandler\$stageService, TYPO3\CMS\Workspaces\Domain\Record\WorkspaceRecord\get(), TYPO3\CMS\Workspaces\ExtDirect\AbstractHandler\getCurrentWorkspace(), TYPO3\CMS\Backend\Utility\BackendUtility\getRecord(), TYPO3\CMS\Workspaces\ExtDirect\ActionHandler\getStageService(), TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance(), TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode(), and TYPO3\CMS\Core\Utility\GeneralUtility\validEmail().

Referenced by TYPO3\CMS\Workspaces\ExtDirect\ActionHandler\sendToNextStageExecute(), TYPO3\CMS\Workspaces\ExtDirect\ActionHandler\sendToPrevStageExecute(), TYPO3\CMS\Workspaces\ExtDirect\ActionHandler\sendToSpecificStageExecute(), and TYPO3\CMS\Workspaces\ExtDirect\ActionHandler\sentCollectionToStage().

getSentToStageWindow()

TYPO3\CMS\Workspaces\ExtDirect\ActionHandler::getSentToStageWindow (   $nextStage )

protected

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

Parameters

StageRecord | int

$nextStageId

Returns

array

Definition at line 654 of file ActionHandler.php.

References $GLOBALS, TYPO3\CMS\Workspaces\Domain\Record\WorkspaceRecord\get(), TYPO3\CMS\Workspaces\ExtDirect\AbstractHandler\getCurrentWorkspace(), and TYPO3\CMS\Workspaces\ExtDirect\ActionHandler\getReceipientsOfStage().

Referenced by TYPO3\CMS\Workspaces\ExtDirect\ActionHandler\sendPageToNextStage(), TYPO3\CMS\Workspaces\ExtDirect\ActionHandler\sendPageToPreviousStage(), TYPO3\CMS\Workspaces\ExtDirect\ActionHandler\sendToNextStageWindow(), TYPO3\CMS\Workspaces\ExtDirect\ActionHandler\sendToPrevStageWindow(), and TYPO3\CMS\Workspaces\ExtDirect\ActionHandler\sendToSpecificStageWindow().

getStageService()

TYPO3\CMS\Workspaces\ExtDirect\ActionHandler::getStageService ( )

protected

Gets an instance of the Stage service.

Returns

StagesService

Definition at line 755 of file ActionHandler.php.

References TYPO3\CMS\Workspaces\ExtDirect\ActionHandler\$stageService, and TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

Referenced by TYPO3\CMS\Workspaces\ExtDirect\ActionHandler\getDefaultCommentOfStage(), TYPO3\CMS\Workspaces\ExtDirect\ActionHandler\getReceipientsOfStage(), TYPO3\CMS\Workspaces\ExtDirect\ActionHandler\getRecipientList(), TYPO3\CMS\Workspaces\ExtDirect\ActionHandler\sendPageToNextStage(), and TYPO3\CMS\Workspaces\ExtDirect\ActionHandler\sendPageToPreviousStage().

loadColumnModel()

TYPO3\CMS\Workspaces\ExtDirect\ActionHandler::loadColumnModel

(

)

Definition at line 204 of file ActionHandler.php.

References $GLOBALS.

saveColumnModel()

TYPO3\CMS\Workspaces\ExtDirect\ActionHandler::saveColumnModel

(

$model

)

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

Parameters

\stdClass

$model

Returns

void

Definition at line 191 of file ActionHandler.php.

References $GLOBALS.

saveLanguageSelection()

TYPO3\CMS\Workspaces\ExtDirect\ActionHandler::saveLanguageSelection

(

$language

)

Saves the selected language.

Parameters

int | string

$language

Returns

void

Definition at line 219 of file ActionHandler.php.

References $GLOBALS.

sendPageToNextStage()

TYPO3\CMS\Workspaces\ExtDirect\ActionHandler::sendPageToNextStage

(

$id

)

Parameters

int

$id

Current Page id to select Workspace items from.

Returns

array

Definition at line 788 of file ActionHandler.php.

References TYPO3\CMS\Workspaces\ExtDirect\ActionHandler\getSentToStageWindow(), TYPO3\CMS\Workspaces\ExtDirect\ActionHandler\getStageService(), and TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

sendPageToPreviousStage()

TYPO3\CMS\Workspaces\ExtDirect\ActionHandler::sendPageToPreviousStage

(

$id

)

Send all available workspace records to the previous stage.

Parameters

int

$id

Current page id to process items to previous stage.

Returns

array

Definition at line 769 of file ActionHandler.php.

References TYPO3\CMS\Workspaces\ExtDirect\ActionHandler\getSentToStageWindow(), TYPO3\CMS\Workspaces\ExtDirect\ActionHandler\getStageService(), and TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

sendToNextStageExecute()

TYPO3\CMS\Workspaces\ExtDirect\ActionHandler::sendToNextStageExecute

(

\stdClass

$parameters

)

Gets an object with this structure:

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

Parameters

stdClass

$parameters

Returns

array

Definition at line 522 of file ActionHandler.php.

References $uid, TYPO3\CMS\Workspaces\ExtDirect\ActionHandler\getRecipientList(), TYPO3\CMS\Backend\Utility\BackendUtility\getRecord(), TYPO3\CMS\Workspaces\ExtDirect\ActionHandler\setTemporaryWorkspace(), and TYPO3\CMS\Workspaces\Service\StagesService\STAGE_PUBLISH_EXECUTE_ID.

sendToNextStageWindow()

TYPO3\CMS\Workspaces\ExtDirect\ActionHandler::sendToNextStageWindow	(		$uid,
			$table,
			$t3ver_oid
	)

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

Parameters

int	$uid
string	$table
int	$t3ver_oid

Returns

array

Definition at line 236 of file ActionHandler.php.

References $uid, TYPO3\CMS\Workspaces\Domain\Record\WorkspaceRecord\get(), TYPO3\CMS\Workspaces\ExtDirect\AbstractHandler\getErrorResponse(), TYPO3\CMS\Backend\Utility\BackendUtility\getRecord(), TYPO3\CMS\Workspaces\ExtDirect\ActionHandler\getSentToStageWindow(), and TYPO3\CMS\Workspaces\ExtDirect\ActionHandler\setTemporaryWorkspace().

sendToPrevStageExecute()

TYPO3\CMS\Workspaces\ExtDirect\ActionHandler::sendToPrevStageExecute

(

\stdClass

$parameters

)

Gets an object with this structure:

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

Parameters

stdClass

$parameters

Returns

array

Definition at line 569 of file ActionHandler.php.

References $uid, TYPO3\CMS\Workspaces\ExtDirect\ActionHandler\getRecipientList(), TYPO3\CMS\Backend\Utility\BackendUtility\getRecord(), and TYPO3\CMS\Workspaces\ExtDirect\ActionHandler\setTemporaryWorkspace().

sendToPrevStageWindow()

TYPO3\CMS\Workspaces\ExtDirect\ActionHandler::sendToPrevStageWindow	(		$uid,
			$table
	)

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

Parameters

int	$uid
string	$table

Returns

array

Definition at line 271 of file ActionHandler.php.

References $uid, TYPO3\CMS\Workspaces\Domain\Record\WorkspaceRecord\get(), TYPO3\CMS\Workspaces\ExtDirect\AbstractHandler\getErrorResponse(), TYPO3\CMS\Backend\Utility\BackendUtility\getRecord(), TYPO3\CMS\Workspaces\ExtDirect\ActionHandler\getSentToStageWindow(), and TYPO3\CMS\Workspaces\ExtDirect\ActionHandler\setTemporaryWorkspace().

sendToSpecificStageExecute()

TYPO3\CMS\Workspaces\ExtDirect\ActionHandler::sendToSpecificStageExecute

(

\stdClass

$parameters

)

Gets an object with this structure:

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

\stdClass

$parameters

Returns

array

Definition at line 615 of file ActionHandler.php.

References TYPO3\CMS\Workspaces\ExtDirect\ActionHandler\getRecipientList(), TYPO3\CMS\Backend\Utility\BackendUtility\getRecord(), and TYPO3\CMS\Workspaces\Service\StagesService\STAGE_PUBLISH_EXECUTE_ID.

sendToSpecificStageWindow()

TYPO3\CMS\Workspaces\ExtDirect\ActionHandler::sendToSpecificStageWindow	(		$nextStageId,
		array	$elements
	)

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

Parameters

int	$nextStageId
	array|

Definition at line 312 of file ActionHandler.php.

References TYPO3\CMS\Workspaces\ExtDirect\ActionHandler\getSentToStageWindow().

sentCollectionToStage()

TYPO3\CMS\Workspaces\ExtDirect\ActionHandler::sentCollectionToStage

(

\stdClass

$parameters

)

Push the given element collection to the next workspace stage.

$parameters->additional = your@.nosp@m.mail.nosp@m..com $parameters->affects->__TABLENAME__ $parameters->comments $parameters->receipients $parameters->stageId

Parameters

stdClass

$parameters

Returns

array

Definition at line 443 of file ActionHandler.php.

References TYPO3\CMS\Workspaces\ExtDirect\ActionHandler\getRecipientList(), TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance(), and TYPO3\CMS\Workspaces\Service\StagesService\STAGE_PUBLISH_EXECUTE_ID.

setTemporaryWorkspace()

TYPO3\CMS\Workspaces\ExtDirect\ActionHandler::setTemporaryWorkspace (   $workspaceId )

protected

Parameters

int

$workspaceId

Returns

int Id of the original workspace

Exceptions

Definition at line 839 of file ActionHandler.php.

References TYPO3\CMS\Workspaces\ExtDirect\ActionHandler\getBackendUser().

Referenced by TYPO3\CMS\Workspaces\ExtDirect\ActionHandler\deleteSingleRecord(), TYPO3\CMS\Workspaces\ExtDirect\ActionHandler\sendToNextStageExecute(), TYPO3\CMS\Workspaces\ExtDirect\ActionHandler\sendToNextStageWindow(), TYPO3\CMS\Workspaces\ExtDirect\ActionHandler\sendToPrevStageExecute(), TYPO3\CMS\Workspaces\ExtDirect\ActionHandler\sendToPrevStageWindow(), and TYPO3\CMS\Workspaces\ExtDirect\ActionHandler\swapSingleRecord().

swapSingleRecord()

TYPO3\CMS\Workspaces\ExtDirect\ActionHandler::swapSingleRecord	(		$table,
			$t3ver_oid,
			$orig_uid
	)

Swaps a single record.

Parameters

string	$table
int	$t3ver_oid
int	$orig_uid

Returns

void

Todo:

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

Definition at line 72 of file ActionHandler.php.

References TYPO3\CMS\Backend\Utility\BackendUtility\getRecord(), and TYPO3\CMS\Workspaces\ExtDirect\ActionHandler\setTemporaryWorkspace().

updateStageChangeButtons()

TYPO3\CMS\Workspaces\ExtDirect\ActionHandler::updateStageChangeButtons

(

$id

)

Fetch the current label and visible state of the buttons.

Parameters

int

$id

Returns

array Contains the visibility state and label of the stage change buttons.

Definition at line 809 of file ActionHandler.php.

References $GLOBALS, TYPO3\CMS\Workspaces\ExtDirect\ActionHandler\$stageService, and TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

viewSingleRecord()

TYPO3\CMS\Workspaces\ExtDirect\ActionHandler::viewSingleRecord	(		$table,
			$uid
	)

Generates a view link for a page.

Parameters

string	$table
string	$uid

Returns

string

Definition at line 115 of file ActionHandler.php.

References $uid.

Member Data Documentation

$stageService

TYPO3\CMS\Workspaces\ExtDirect\ActionHandler::$stageService

protected

Definition at line 31 of file ActionHandler.php.

Referenced by TYPO3\CMS\Workspaces\ExtDirect\ActionHandler\getRecipientList(), TYPO3\CMS\Workspaces\ExtDirect\ActionHandler\getStageService(), and TYPO3\CMS\Workspaces\ExtDirect\ActionHandler\updateStageChangeButtons().