TYPO3\CMS\Workspaces\Controller\Remote\MassActionHandler Class Reference

Public Member Functions
	__construct ()
array	getMassStageActions ()
array	publishWorkspace (\stdClass $parameters)
array	flushWorkspace (\stdClass $parameters)

Public Attributes
const	MAX_RECORDS_TO_PROCESS = 30

Protected Member Functions
int	initPublishData ($workspace, $swap, $language=null)
int	initFlushData ($workspace, $language=null)
int	processData ()
int null	validateLanguageParameter (\stdClass $parameters)
int	getCurrentWorkspace ()
BackendUserAuthentication	getBackendUser ()
LanguageService	getLanguageService ()

Protected Attributes
WorkspaceService	$workspaceService

Private Attributes
string	$pathToLocallang = 'LLL:EXT:workspaces/Resources/Private/Language/locallang.xlf'

Detailed Description

Class encapsulates all actions which are triggered for all elements within the current workspace.

This is a specific Backend Controller implementation and is not considered part of the Public TYPO3 API.

Definition at line 28 of file MassActionHandler.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Workspaces\Controller\Remote\MassActionHandler::__construct

(

)

Definition at line 42 of file MassActionHandler.php.

Member Function Documentation

flushWorkspace()

array TYPO3\CMS\Workspaces\Controller\Remote\MassActionHandler::flushWorkspace

(

\stdClass

$parameters

)

Flushes the current workspace.

Parameters

\stdClass

$parameters

Returns

‪array

Definition at line 113 of file MassActionHandler.php.

References TYPO3\CMS\Workspaces\Controller\Remote\MassActionHandler\getBackendUser(), TYPO3\CMS\Workspaces\Controller\Remote\MassActionHandler\getCurrentWorkspace(), TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\getSessionData(), TYPO3\CMS\Workspaces\Controller\Remote\MassActionHandler\initFlushData(), TYPO3\CMS\Workspaces\Controller\Remote\MassActionHandler\processData(), and TYPO3\CMS\Workspaces\Controller\Remote\MassActionHandler\validateLanguageParameter().

getBackendUser()

BackendUserAuthentication TYPO3\CMS\Workspaces\Controller\Remote\MassActionHandler::getBackendUser ( )

protected

Returns

‪BackendUserAuthentication

Definition at line 260 of file MassActionHandler.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Workspaces\Controller\Remote\MassActionHandler\flushWorkspace(), TYPO3\CMS\Workspaces\Controller\Remote\MassActionHandler\getMassStageActions(), TYPO3\CMS\Workspaces\Controller\Remote\MassActionHandler\initFlushData(), TYPO3\CMS\Workspaces\Controller\Remote\MassActionHandler\initPublishData(), TYPO3\CMS\Workspaces\Controller\Remote\MassActionHandler\processData(), and TYPO3\CMS\Workspaces\Controller\Remote\MassActionHandler\publishWorkspace().

getCurrentWorkspace()

int TYPO3\CMS\Workspaces\Controller\Remote\MassActionHandler::getCurrentWorkspace ( )

protected

Gets the current workspace ID.

Returns

‪int The current workspace ID

Definition at line 252 of file MassActionHandler.php.

Referenced by TYPO3\CMS\Workspaces\Controller\Remote\MassActionHandler\flushWorkspace(), TYPO3\CMS\Workspaces\Controller\Remote\MassActionHandler\getMassStageActions(), and TYPO3\CMS\Workspaces\Controller\Remote\MassActionHandler\publishWorkspace().

getLanguageService()

LanguageService TYPO3\CMS\Workspaces\Controller\Remote\MassActionHandler::getLanguageService ( )

protected

Returns

‪LanguageService

Definition at line 268 of file MassActionHandler.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Workspaces\Controller\Remote\MassActionHandler\getMassStageActions().

getMassStageActions()

array TYPO3\CMS\Workspaces\Controller\Remote\MassActionHandler::getMassStageActions

(

)

Get list of available mass workspace actions.

Returns

‪array $data

Definition at line 52 of file MassActionHandler.php.

References TYPO3\CMS\Workspaces\Controller\Remote\MassActionHandler\getBackendUser(), TYPO3\CMS\Workspaces\Controller\Remote\MassActionHandler\getCurrentWorkspace(), TYPO3\CMS\Workspaces\Controller\Remote\MassActionHandler\getLanguageService(), TYPO3\CMS\Workspaces\Service\WorkspaceService\LIVE_WORKSPACE_ID, TYPO3\CMS\Workspaces\Service\WorkspaceService\SELECT_ALL_WORKSPACES, and TYPO3\CMS\Core\Localization\LanguageService\sL().

initFlushData()

int TYPO3\CMS\Workspaces\Controller\Remote\MassActionHandler::initFlushData (   $workspace,   $language = null  )

protected

Initializes the command map to be used for flushing.

Parameters

int	$workspace
int	$language

Returns

‪int

Definition at line 166 of file MassActionHandler.php.

References TYPO3\CMS\Workspaces\Controller\Remote\MassActionHandler\getBackendUser(), and TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\setAndSaveSessionData().

Referenced by TYPO3\CMS\Workspaces\Controller\Remote\MassActionHandler\flushWorkspace().

initPublishData()

int TYPO3\CMS\Workspaces\Controller\Remote\MassActionHandler::initPublishData (   $workspace,   $swap,   $language = null  )

protected

Initializes the command map to be used for publishing.

Parameters

int	$workspace
bool	$swap
int	$language

Returns

‪int

Definition at line 143 of file MassActionHandler.php.

References TYPO3\CMS\Workspaces\Controller\Remote\MassActionHandler\getBackendUser(), and TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\setAndSaveSessionData().

Referenced by TYPO3\CMS\Workspaces\Controller\Remote\MassActionHandler\publishWorkspace().

processData()

int TYPO3\CMS\Workspaces\Controller\Remote\MassActionHandler::processData ( )

protected

Processes the data.

Returns

‪int

Definition at line 187 of file MassActionHandler.php.

References $errors, TYPO3\CMS\Workspaces\Controller\Remote\MassActionHandler\getBackendUser(), TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\getSessionData(), and TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\setAndSaveSessionData().

Referenced by TYPO3\CMS\Workspaces\Controller\Remote\MassActionHandler\flushWorkspace(), and TYPO3\CMS\Workspaces\Controller\Remote\MassActionHandler\publishWorkspace().

publishWorkspace()

array TYPO3\CMS\Workspaces\Controller\Remote\MassActionHandler::publishWorkspace

(

\stdClass

$parameters

)

Publishes the current workspace.

Parameters

\stdClass

$parameters

Returns

‪array

Definition at line 84 of file MassActionHandler.php.

References TYPO3\CMS\Workspaces\Controller\Remote\MassActionHandler\getBackendUser(), TYPO3\CMS\Workspaces\Controller\Remote\MassActionHandler\getCurrentWorkspace(), TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\getSessionData(), TYPO3\CMS\Workspaces\Controller\Remote\MassActionHandler\initPublishData(), TYPO3\CMS\Workspaces\Controller\Remote\MassActionHandler\processData(), and TYPO3\CMS\Workspaces\Controller\Remote\MassActionHandler\validateLanguageParameter().

validateLanguageParameter()

int null TYPO3\CMS\Workspaces\Controller\Remote\MassActionHandler::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 238 of file MassActionHandler.php.

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

Referenced by TYPO3\CMS\Workspaces\Controller\Remote\MassActionHandler\flushWorkspace(), and TYPO3\CMS\Workspaces\Controller\Remote\MassActionHandler\publishWorkspace().

Member Data Documentation

$pathToLocallang

string TYPO3\CMS\Workspaces\Controller\Remote\MassActionHandler::$pathToLocallang = 'LLL:EXT:workspaces/Resources/Private/Language/locallang.xlf'

private

Path to the locallang file

Definition at line 36 of file MassActionHandler.php.

$workspaceService

WorkspaceService TYPO3\CMS\Workspaces\Controller\Remote\MassActionHandler::$workspaceService

protected

Definition at line 40 of file MassActionHandler.php.

MAX_RECORDS_TO_PROCESS

const TYPO3\CMS\Workspaces\Controller\Remote\MassActionHandler::MAX_RECORDS_TO_PROCESS = 30

Definition at line 30 of file MassActionHandler.php.