TYPO3 CMS  TYPO3_6-2
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
TYPO3\CMS\Workspaces\ExtDirect\ActionHandler Class Reference
Inheritance diagram for TYPO3\CMS\Workspaces\ExtDirect\ActionHandler:
TYPO3\CMS\Workspaces\ExtDirect\AbstractHandler Tx_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)
 
 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 ($nextStageId)
 
 getReceipientsOfStage ($stage)
 
 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

Author
Workspaces Team (http://forge.typo3.org/projects/show/typo3v4-workspaces)

Definition at line 25 of file ActionHandler.php.

Constructor & Destructor Documentation

◆ __construct()

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

Creates this object.

Definition at line 35 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
integer$uid
Returns
void
Todo:
What about reporting errors back to the ExtJS interface? /olly/

Definition at line 90 of file ActionHandler.php.

References $uid, 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 119 of file ActionHandler.php.

References $result, 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
integer$uidThe 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 45 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
integer$uid
Returns
array

Definition at line 55 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 835 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
integer$stage
Returns
string

Definition at line 723 of file ActionHandler.php.

References $result, and TYPO3\CMS\Workspaces\ExtDirect\ActionHandler\getStageService().

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

◆ getFlushCommands()

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

Get flush commands

Parameters
array|

Definition at line 165 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 147 of file ActionHandler.php.

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

◆ getReceipientsOfStage()

TYPO3\CMS\Workspaces\ExtDirect\ActionHandler::getReceipientsOfStage (   $stage)
protected

Gets all assigned recipients of a particular stage.

Parameters
integer$stage
Returns
array

Definition at line 679 of file ActionHandler.php.

References $result, 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
arraylist of recipients
stringgiven user string of additional recipients
integerstage id
Returns
array

Definition at line 308 of file ActionHandler.php.

References $GLOBALS, TYPO3\CMS\Workspaces\ExtDirect\ActionHandler\$stageService, 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 (   $nextStageId)
protected

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

Parameters
$nextStageId
Returns
array

Definition at line 611 of file ActionHandler.php.

References $GLOBALS, $result, TYPO3\CMS\Workspaces\ExtDirect\ActionHandler\getDefaultCommentOfStage(), TYPO3\CMS\Workspaces\ExtDirect\ActionHandler\getReceipientsOfStage(), and TYPO3\CMS\Workspaces\ExtDirect\ActionHandler\getStageService().

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

Definition at line 733 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\getSentToStageWindow(), TYPO3\CMS\Workspaces\ExtDirect\ActionHandler\sendPageToNextStage(), TYPO3\CMS\Workspaces\ExtDirect\ActionHandler\sendPageToPreviousStage(), TYPO3\CMS\Workspaces\ExtDirect\ActionHandler\sendToNextStageWindow(), and TYPO3\CMS\Workspaces\ExtDirect\ActionHandler\sendToPrevStageWindow().

◆ loadColumnModel()

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

Definition at line 193 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
object$model
Returns
void

Definition at line 181 of file ActionHandler.php.

References $GLOBALS.

◆ saveLanguageSelection()

TYPO3\CMS\Workspaces\ExtDirect\ActionHandler::saveLanguageSelection (   $language)

Saves the selected language.

Parameters
integer | string$language
Returns
void

Definition at line 207 of file ActionHandler.php.

References $GLOBALS.

◆ sendPageToNextStage()

TYPO3\CMS\Workspaces\ExtDirect\ActionHandler::sendPageToNextStage (   $id)
Parameters
integer$idCurrent Page id to select Workspace items from.
Returns
array
Author
Michael Klapper devel.nosp@m.opme.nosp@m.nt@mo.nosp@m.rpho.nosp@m.do.co.nosp@m.m

Definition at line 766 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
integer$idCurrent page id to process items to previous stage.
Returns
array
Author
Michael Klapper devel.nosp@m.opme.nosp@m.nt@mo.nosp@m.rpho.nosp@m.do.co.nosp@m.m

Definition at line 747 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 482 of file ActionHandler.php.

References $result, $uid, TYPO3\CMS\Workspaces\ExtDirect\ActionHandler\getRecipientList(), and TYPO3\CMS\Workspaces\ExtDirect\ActionHandler\setTemporaryWorkspace().

◆ 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
integer$uid
string$table
integer$t3ver_oid
Returns
array

Definition at line 223 of file ActionHandler.php.

References $result, $uid, TYPO3\CMS\Workspaces\ExtDirect\AbstractHandler\getErrorResponse(), TYPO3\CMS\Workspaces\ExtDirect\ActionHandler\getSentToStageWindow(), TYPO3\CMS\Workspaces\ExtDirect\ActionHandler\getStageService(), 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 528 of file ActionHandler.php.

References $result, $uid, TYPO3\CMS\Workspaces\ExtDirect\ActionHandler\getRecipientList(), 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
integer$uid
string$table
Returns
array

Definition at line 256 of file ActionHandler.php.

References $result, $uid, TYPO3\CMS\Workspaces\ExtDirect\AbstractHandler\getErrorResponse(), TYPO3\CMS\Workspaces\ExtDirect\ActionHandler\getSentToStageWindow(), TYPO3\CMS\Workspaces\ExtDirect\ActionHandler\getStageService(), 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 573 of file ActionHandler.php.

References $result, and TYPO3\CMS\Workspaces\ExtDirect\ActionHandler\getRecipientList().

◆ sendToSpecificStageWindow()

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

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

Parameters
integer$nextStageId
Returns
array

Definition at line 292 of file ActionHandler.php.

References $result, and 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
Author
Michael Klapper devel.nosp@m.opme.nosp@m.nt@mo.nosp@m.rpho.nosp@m.do.co.nosp@m.m

Definition at line 404 of file ActionHandler.php.

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

◆ setTemporaryWorkspace()

TYPO3\CMS\Workspaces\ExtDirect\ActionHandler::setTemporaryWorkspace (   $workspaceId)
protected
Parameters
integer$workspaceId
Returns
integer Id of the original workspace
Exceptions

Definition at line 816 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
integer$t3ver_oid
integer$orig_uid
Returns
void
Todo:
What about reporting errors back to the ExtJS interface? /olly/

Definition at line 68 of file ActionHandler.php.

References 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
integer$id
Returns
array Contains the visibility state and label of the stage change buttons.
Author
Michael Klapper devel.nosp@m.opme.nosp@m.nt@mo.nosp@m.rpho.nosp@m.do.co.nosp@m.m

Definition at line 787 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 109 of file ActionHandler.php.

References $uid.

Member Data Documentation

◆ $stageService

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

Definition at line 30 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().