Inheritance diagram for TYPO3\CMS\Workspaces\Service\WorkspaceService:

Public Member Functions
	getAvailableWorkspaces ()

	getCurrentWorkspace ()

	getCmdArrayForPublishWS ($wsid, $doSwap, $pageId=0, $language=null)

	getCmdArrayForFlushWS ($wsid, $flush=true, $pageId=0, $language=null)

	selectVersionsInWorkspace ($wsid, $filter=0, $stage=-99, $pageId=-1, $recursionLevel=0, $selectionType='tables_select', $language=null)

	canCreatePreviewLink ($pageUid, $workspaceUid)

	generateWorkspacePreviewLink ($uid)

	generateWorkspacePreviewLinksForAllLanguages ($uid)

	getLivePageUid ($uid)

	hasPageRecordVersions ($workspace, $pageId)

Static Public Member Functions
static	getWorkspaceTitle ($wsId)

static	isOldStyleWorkspaceUsed ()

static	isNewPage ($id, $language=0)

static	viewSingleRecord ($table, $uid, array $liveRecord=null, array $versionRecord=null)

Public Attributes
const	TABLE_WORKSPACE = 'sys_workspace'

const	SELECT_ALL_WORKSPACES = -98

const	LIVE_WORKSPACE_ID = 0

Protected Member Functions
	selectAllVersionsFromPages ($table, $pageList, $wsid, $filter, $stage, $language=null)

	getMoveToPlaceHolderFromPages ($table, $pageList, $wsid, $filter, $stage)

	filterPermittedElements ($recs, $table)

	isPageAccessibleForCurrentUser ($table, array $record)

	isLanguageAccessibleForCurrentUser ($table, array $record)

	getDatabaseConnection ()

	getObjectManager ()

Protected Attributes
	$pageCache = []

	$versionsOnPageCache = []

Detailed Description

Workspace service

Definition at line 26 of file WorkspaceService.php.

Member Function Documentation

◆ canCreatePreviewLink()

TYPO3\CMS\Workspaces\Service\WorkspaceService::canCreatePreviewLink	(	$pageUid,
		$workspaceUid
	)

Determine whether this page for the current

Parameters

int	$pageUid
int	$workspaceUid

Returns: bool

Definition at line 613 of file WorkspaceService.php.

References $GLOBALS, TYPO3\CMS\Core\Type\Enumeration\cast(), TYPO3\CMS\Core\Versioning\VersionState\DELETE_PLACEHOLDER, TYPO3\CMS\Backend\Utility\BackendUtility\getRecord(), TYPO3\CMS\Core\Utility\GeneralUtility\inList(), and TYPO3\CMS\Backend\Utility\BackendUtility\workspaceOL().

◆ filterPermittedElements()

TYPO3\CMS\Workspaces\Service\WorkspaceService::filterPermittedElements	(	$recs,
		$table
	)

protected

Remove all records which are not permitted for the user

Parameters

array	$recs
string	$table

Returns: array

Definition at line 429 of file WorkspaceService.php.

References TYPO3\CMS\Workspaces\Service\WorkspaceService\isLanguageAccessibleForCurrentUser(), and TYPO3\CMS\Workspaces\Service\WorkspaceService\isPageAccessibleForCurrentUser().

Referenced by TYPO3\CMS\Workspaces\Service\WorkspaceService\selectVersionsInWorkspace().

◆ generateWorkspacePreviewLink()

TYPO3\CMS\Workspaces\Service\WorkspaceService::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 637 of file WorkspaceService.php.

References $GLOBALS, $uid, TYPO3\CMS\Core\Utility\GeneralUtility\_GET(), TYPO3\CMS\Core\Utility\GeneralUtility\_GETset(), TYPO3\CMS\Workspaces\Service\WorkspaceService\getCurrentWorkspace(), TYPO3\CMS\Workspaces\Service\WorkspaceService\getLivePageUid(), TYPO3\CMS\Workspaces\Service\WorkspaceService\getObjectManager(), TYPO3\CMS\Core\Utility\GeneralUtility\implodeArrayForUrl(), and TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

Referenced by TYPO3\CMS\Workspaces\Service\WorkspaceService\generateWorkspacePreviewLinksForAllLanguages().

◆ generateWorkspacePreviewLinksForAllLanguages()

TYPO3\CMS\Workspaces\Service\WorkspaceService::generateWorkspacePreviewLinksForAllLanguages ( $uid )

Generate workspace preview links for all available languages of a page

Parameters

int $uid

Returns: array

Definition at line 683 of file WorkspaceService.php.

References $uid, and TYPO3\CMS\Workspaces\Service\WorkspaceService\generateWorkspacePreviewLink().

◆ getAvailableWorkspaces()

TYPO3\CMS\Workspaces\Service\WorkspaceService::getAvailableWorkspaces ( )

retrieves the available workspaces from the database and checks whether they're available to the current BE user

Returns: array array of worspaces available to the current user

Definition at line 47 of file WorkspaceService.php.

References $GLOBALS, and TYPO3\CMS\Backend\Utility\BackendUtility\deleteClause().

Referenced by TYPO3\CMS\Workspaces\Service\WorkspaceService\getCurrentWorkspace().

◆ getCmdArrayForFlushWS()

TYPO3\CMS\Workspaces\Service\WorkspaceService::getCmdArrayForFlushWS	(	$wsid,
		$flush = `true`,
		$pageId = `0`,
		$language = `null`
	)

Building tcemain CMD-array for releasing all versions in a workspace.

Parameters

int	$wsid	Real workspace ID, cannot be ONLINE (zero).
bool	$flush	Run Flush (TRUE) or ClearWSID (FALSE) command
int	$pageId	The page id
int	$language	Select specific language only

Returns: array Command array for tcemain

Definition at line 158 of file WorkspaceService.php.

References TYPO3\CMS\Workspaces\Service\WorkspaceService\selectVersionsInWorkspace().

◆ getCmdArrayForPublishWS()

TYPO3\CMS\Workspaces\Service\WorkspaceService::getCmdArrayForPublishWS	(	$wsid,
		$doSwap,
		$pageId = `0`,
		$language = `null`
	)

Building tcemain CMD-array for swapping all versions in a workspace.

Parameters

int	$wsid	Real workspace ID, cannot be ONLINE (zero).
bool	$doSwap	If set, then the currently online versions are swapped into the workspace in exchange for the offline versions. Otherwise the workspace is emptied.
int	$pageId	The page id
int	$language	Select specific language only

Returns: array Command array for tcemain

Definition at line 123 of file WorkspaceService.php.

References TYPO3\CMS\Backend\Utility\BackendUtility\getRecord(), TYPO3\CMS\Workspaces\Service\WorkspaceService\selectVersionsInWorkspace(), and TYPO3\CMS\Workspaces\Service\StagesService\STAGE_PUBLISH_ID.

◆ getCurrentWorkspace()

TYPO3\CMS\Workspaces\Service\WorkspaceService::getCurrentWorkspace ( )

Gets the current workspace ID.

Returns: int The current workspace ID

Definition at line 71 of file WorkspaceService.php.

References $GLOBALS, and TYPO3\CMS\Workspaces\Service\WorkspaceService\getAvailableWorkspaces().

Referenced by TYPO3\CMS\Workspaces\Service\WorkspaceService\generateWorkspacePreviewLink().

◆ getDatabaseConnection()

TYPO3\CMS\Workspaces\Service\WorkspaceService::getDatabaseConnection ( )

protected

Returns: DatabaseConnection

Definition at line 773 of file WorkspaceService.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Workspaces\Service\WorkspaceService\getMoveToPlaceHolderFromPages(), TYPO3\CMS\Workspaces\Service\WorkspaceService\hasPageRecordVersions(), and TYPO3\CMS\Workspaces\Service\WorkspaceService\selectAllVersionsFromPages().

◆ getLivePageUid()

TYPO3\CMS\Workspaces\Service\WorkspaceService::getLivePageUid ( $uid )

Find the Live-Uid for a given page, the results are cached at run-time to avoid too many database-queries

Exceptions

Definition at line 704 of file WorkspaceService.php.

References $uid, and TYPO3\CMS\Backend\Utility\BackendUtility\getRecord().

Referenced by TYPO3\CMS\Workspaces\Service\WorkspaceService\generateWorkspacePreviewLink().

◆ getMoveToPlaceHolderFromPages()

TYPO3\CMS\Workspaces\Service\WorkspaceService::getMoveToPlaceHolderFromPages	(	$table,
		$pageList,
		$wsid,
		$filter,
		$stage
	)

protected

Find all moved records at their new position.

Parameters

string	$table
string	$pageList
int	$wsid
int	$filter
int	$stage

Returns: array

Definition at line 316 of file WorkspaceService.php.

References $GLOBALS, $uid, TYPO3\CMS\Core\Versioning\VersionState\DEFAULT_STATE, TYPO3\CMS\Backend\Utility\BackendUtility\deleteClause(), TYPO3\CMS\Workspaces\Service\WorkspaceService\getDatabaseConnection(), TYPO3\CMS\Core\Utility\GeneralUtility\intExplode(), TYPO3\CMS\Backend\Utility\BackendUtility\isTableWorkspaceEnabled(), TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance(), TYPO3\CMS\Core\Versioning\VersionState\MOVE_PLACEHOLDER, and TYPO3\CMS\Core\Versioning\VersionState\MOVE_POINTER.

Referenced by TYPO3\CMS\Workspaces\Service\WorkspaceService\selectVersionsInWorkspace().

◆ getObjectManager()

TYPO3\CMS\Workspaces\Service\WorkspaceService::getObjectManager ( )

protected

Returns

Definition at line 781 of file WorkspaceService.php.

References $GLOBALS, TYPO3\CMS\Backend\Utility\BackendUtility\getRecordsByField(), and TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

Referenced by TYPO3\CMS\Workspaces\Service\WorkspaceService\generateWorkspacePreviewLink().

◆ getWorkspaceTitle()

static TYPO3\CMS\Workspaces\Service\WorkspaceService::getWorkspaceTitle ( $wsId )

static

Find the title for the requested workspace.

Parameters

int $wsId

Returns: string

Exceptions

Definition at line 94 of file WorkspaceService.php.

References $GLOBALS, and TYPO3\CMS\Backend\Utility\BackendUtility\getRecord().

Referenced by TYPO3\CMS\Workspaces\Service\GridDataService\generateGridListFromVersions(), TYPO3\CMS\Backend\Controller\PageTreeNavigationController\getWorkspaceInfo(), TYPO3\CMS\Workspaces\Controller\ReviewController\registerButtons(), TYPO3\CMS\Workspaces\ExtDirect\ToolbarMenu\setWorkspace(), and TYPO3\CMS\Workspaces\Controller\AjaxController\switchWorkspaceAction().

◆ hasPageRecordVersions()

TYPO3\CMS\Workspaces\Service\WorkspaceService::hasPageRecordVersions	(	$workspace,
		$pageId
	)

Checks if a page has record versions according to a given workspace

Parameters

int	$workspace
int	$pageId

Returns: bool

Definition at line 724 of file WorkspaceService.php.

References $GLOBALS, TYPO3\CMS\Backend\Utility\BackendUtility\deleteClause(), TYPO3\CMS\Workspaces\Service\WorkspaceService\getDatabaseConnection(), and TYPO3\CMS\Core\Versioning\VersionState\MOVE_POINTER.

◆ isLanguageAccessibleForCurrentUser()

TYPO3\CMS\Workspaces\Service\WorkspaceService::isLanguageAccessibleForCurrentUser	(		$table,
		array	$record
	)

protected

Check current be users language access on given record.

Parameters

string	$table	Name of the table
array	$record	Record row to be checked

Returns: bool

Definition at line 471 of file WorkspaceService.php.

References $GLOBALS, and TYPO3\CMS\Backend\Utility\BackendUtility\isTableLocalizable().

Referenced by TYPO3\CMS\Workspaces\Service\WorkspaceService\filterPermittedElements().

◆ isNewPage()

static TYPO3\CMS\Workspaces\Service\WorkspaceService::isNewPage	(	$id,
		$language = `0`
	)

static

Determine whether a specific page is new and not yet available in the LIVE workspace

Parameters

int	$id	Primary key of the page to check
int	$language	Language for which to check the page

Returns: bool

Definition at line 509 of file WorkspaceService.php.

References $GLOBALS, TYPO3\CMS\Core\Type\Enumeration\cast(), TYPO3\CMS\Backend\Utility\BackendUtility\deleteClause(), TYPO3\CMS\Backend\Utility\BackendUtility\getRecord(), and TYPO3\CMS\Core\Versioning\VersionState\NEW_PLACEHOLDER.

Referenced by TYPO3\CMS\Workspaces\Controller\PreviewController\initializeAction().

◆ isOldStyleWorkspaceUsed()

static TYPO3\CMS\Workspaces\Service\WorkspaceService::isOldStyleWorkspaceUsed ( )

static

Trivial check to see if the user already migrated his workspaces to the new style (either manually or with the migrator scripts)

Returns: bool

Definition at line 487 of file WorkspaceService.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Workspaces\Controller\ReviewController\singleIndexAction().

◆ isPageAccessibleForCurrentUser()

TYPO3\CMS\Workspaces\Service\WorkspaceService::isPageAccessibleForCurrentUser	(		$table,
		array	$record
	)

protected

Checking access to the page the record is on, respecting ignored root level restrictions

Parameters

string	$table	Name of the table
array	$record	Record row to be checked

Returns: bool

Definition at line 449 of file WorkspaceService.php.

References $GLOBALS, TYPO3\CMS\Backend\Utility\BackendUtility\getRecord(), and TYPO3\CMS\Backend\Utility\BackendUtility\isRootLevelRestrictionIgnored().

Referenced by TYPO3\CMS\Workspaces\Service\WorkspaceService\filterPermittedElements().

◆ selectAllVersionsFromPages()

TYPO3\CMS\Workspaces\Service\WorkspaceService::selectAllVersionsFromPages	(	$table,
		$pageList,
		$wsid,
		$filter,
		$stage,
		$language = `null`
	)

protected

Find all versionized elements except moved records.

Parameters

string	$table
string	$pageList
int	$wsid
int	$filter
int	$stage
int	$language

Returns: array

Definition at line 246 of file WorkspaceService.php.

References $GLOBALS, TYPO3\CMS\Core\Utility\MathUtility\canBeInterpretedAsInteger(), TYPO3\CMS\Backend\Utility\BackendUtility\deleteClause(), TYPO3\CMS\Workspaces\Service\WorkspaceService\getDatabaseConnection(), TYPO3\CMS\Backend\Utility\BackendUtility\isRootLevelRestrictionIgnored(), TYPO3\CMS\Backend\Utility\BackendUtility\isTableLocalizable(), and TYPO3\CMS\Core\Versioning\VersionState\MOVE_POINTER.

Referenced by TYPO3\CMS\Workspaces\Service\WorkspaceService\selectVersionsInWorkspace().

◆ selectVersionsInWorkspace()

TYPO3\CMS\Workspaces\Service\WorkspaceService::selectVersionsInWorkspace	(	$wsid,
		$filter = `0`,
		$stage = `-99`,
		$pageId = `-1`,
		$recursionLevel = `0`,
		$selectionType = `'tables_select'`,
		$language = `null`
	)

Select all records from workspace pending for publishing Used from backend to display workspace overview User for auto-publishing for selecting versions for publication

Parameters

int	$wsid	Workspace ID. If -99, will select ALL versions from ANY workspace. If -98 will select all but ONLINE. >=-1 will select from the actual workspace
int	$filter	Lifecycle filter: 1 = select all drafts (never-published), 2 = select all published one or more times (archive/multiple), anything else selects all.
int	$stage	Stage filter: -99 means no filtering, otherwise it will be used to select only elements with that stage. For publishing, that would be "10
int	$pageId	Page id: Live page for which to find versions in workspace!
int	$recursionLevel	Recursion Level - select versions recursive - parameter is only relevant if $pageId != -1
string	$selectionType	How to collect records for "listing" or "modify" these tables. Support the permissions of each type of record, see ::check.
int	$language	Select specific language only

Returns: array Array of all records uids etc. First key is table name, second key incremental integer. Records are associative arrays with uid and t3ver_oidfields. The pid of the online record is found as "livepid" the pid of the offline record is found in "wspid

Definition at line 192 of file WorkspaceService.php.

References $GLOBALS, TYPO3\CMS\Workspaces\Service\WorkspaceService\filterPermittedElements(), TYPO3\CMS\Workspaces\Service\WorkspaceService\getMoveToPlaceHolderFromPages(), and TYPO3\CMS\Workspaces\Service\WorkspaceService\selectAllVersionsFromPages().

Referenced by TYPO3\CMS\Workspaces\Service\WorkspaceService\getCmdArrayForFlushWS(), and TYPO3\CMS\Workspaces\Service\WorkspaceService\getCmdArrayForPublishWS().

◆ viewSingleRecord()

static TYPO3\CMS\Workspaces\Service\WorkspaceService::viewSingleRecord	(		$table,
			$uid,
		array	$liveRecord = `null`,
		array	$versionRecord = `null`
	)

static

Generates a view link for a page.

Parameters

string	$table	Table to be used
int	$uid	Uid of the version(!) record
array	$liveRecord	Optional live record data
array	$versionRecord	Optional version record data

Returns: string

Definition at line 541 of file WorkspaceService.php.

References $GLOBALS, $uid, TYPO3\CMS\Core\Utility\GeneralUtility\callUserFunction(), TYPO3\CMS\Core\Type\Enumeration\cast(), TYPO3\CMS\Backend\Utility\BackendUtility\getLiveVersionIdOfRecord(), TYPO3\CMS\Backend\Utility\BackendUtility\getLiveVersionOfRecord(), TYPO3\CMS\Backend\Utility\BackendUtility\getMovePlaceholder(), TYPO3\CMS\Backend\Utility\BackendUtility\getPagesTSconfig(), TYPO3\CMS\Backend\Utility\BackendUtility\getRecord(), TYPO3\CMS\Backend\Utility\BackendUtility\isTableLocalizable(), TYPO3\CMS\Core\Versioning\VersionState\MOVE_POINTER, and TYPO3\CMS\Backend\Utility\BackendUtility\viewOnClick().

Referenced by TYPO3\CMS\Workspaces\Service\GridDataService\generateGridListFromVersions().

Member Data Documentation

◆ $pageCache

TYPO3\CMS\Workspaces\Service\WorkspaceService::$pageCache = []

protected

Definition at line 31 of file WorkspaceService.php.

◆ $versionsOnPageCache

TYPO3\CMS\Workspaces\Service\WorkspaceService::$versionsOnPageCache = []

protected

Definition at line 36 of file WorkspaceService.php.

◆ LIVE_WORKSPACE_ID

const TYPO3\CMS\Workspaces\Service\WorkspaceService::LIVE_WORKSPACE_ID = 0

Definition at line 40 of file WorkspaceService.php.

Referenced by TYPO3\CMS\Workspaces\ExtDirect\MassActionHandler\getMassStageActions().

◆ SELECT_ALL_WORKSPACES

const TYPO3\CMS\Workspaces\Service\WorkspaceService::SELECT_ALL_WORKSPACES = -98

Definition at line 39 of file WorkspaceService.php.

Referenced by TYPO3\CMS\Workspaces\Controller\ReviewController\fullIndexAction(), TYPO3\CMS\Workspaces\ExtDirect\MassActionHandler\getMassStageActions(), TYPO3\CMS\Workspaces\Controller\ReviewController\getModuleUri(), TYPO3\CMS\Workspaces\ExtDirect\ExtDirectServer\getStageActions(), TYPO3\CMS\Workspaces\Controller\ReviewController\prepareWorkspaceTabs(), and TYPO3\CMS\Workspaces\Controller\ReviewController\registerButtons().

◆ TABLE_WORKSPACE

const TYPO3\CMS\Workspaces\Service\WorkspaceService::TABLE_WORKSPACE = 'sys_workspace'

Definition at line 38 of file WorkspaceService.php.

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ canCreatePreviewLink()

◆ filterPermittedElements()

◆ generateWorkspacePreviewLink()

◆ generateWorkspacePreviewLinksForAllLanguages()

◆ getAvailableWorkspaces()

◆ getCmdArrayForFlushWS()

◆ getCmdArrayForPublishWS()

◆ getCurrentWorkspace()

◆ getDatabaseConnection()

◆ getLivePageUid()

◆ getMoveToPlaceHolderFromPages()

◆ getObjectManager()

◆ getWorkspaceTitle()

◆ hasPageRecordVersions()

◆ isLanguageAccessibleForCurrentUser()

◆ isNewPage()

◆ isOldStyleWorkspaceUsed()

◆ isPageAccessibleForCurrentUser()

◆ selectAllVersionsFromPages()

◆ selectVersionsInWorkspace()

◆ viewSingleRecord()

Member Data Documentation

◆ $pageCache

◆ $versionsOnPageCache

◆ LIVE_WORKSPACE_ID

◆ SELECT_ALL_WORKSPACES

◆ TABLE_WORKSPACE