VersionModuleController Class Reference

Inheritance diagram for VersionModuleController:

Public Member Functions
	__construct ()
	menuConfig ()
	main ()
	printContent ()
	versioningMgm ()
	pageSubContent ($pid, $c=0)
	lookForOwnVersions ($table, $uid)
	adminLinks ($table, $row)
	mainAction (ServerRequestInterface $request, ResponseInterface $response)
Public Member Functions inherited from BaseScriptClass
	init ()
	menuConfig ()
	mergeExternalItems ($modName, $menuKey, $menuArr)
	handleExternalFunctionValue ($MM_key= 'function', $MS_value=null)
	getExternalItemConfig ($modName, $menuKey, $value= '')
	checkExtObj ()
	checkSubExtObj ()
	extObjHeader ()
	extObjContent ()

Public Attributes
	$MCONF = array()
	$MOD_MENU = array()
	$MOD_SETTINGS = array()
	$doc
	$content
	$showWorkspaceCol = 0
	$formatWorkspace_cache = array()
	$formatCount_cache = array()
	$targets = array()
	$pageModule = ''
	$publishAccess = false
	$stageIndex = array()
	$recIndex = array()
Public Attributes inherited from BaseScriptClass
	$MCONF = array()
	$id
	$CMD
	$perms_clause
	$MOD_MENU
	$MOD_SETTINGS = array()
	$modTSconfig
	$modMenu_type = ''
	$modMenu_dontValidateList = ''
	$modMenu_setDefaultList = ''
	$extClassConf
	$content = ''
	$doc
	$extObj

Protected Member Functions
	getButtons ()
Protected Member Functions inherited from BaseScriptClass
	getLanguageService ()
	getBackendUser ()
	getDatabaseConnection ()
	getPageRenderer ()

Protected Attributes
	$moduleName = 'web_txversionM1'
	$moduleTemplate
Protected Attributes inherited from BaseScriptClass
	$pageRenderer = null

Detailed Description

Versioning module, including workspace management

Definition at line 29 of file VersionModuleController.php.

Constructor & Destructor Documentation

__construct

(

)

Initialize language files

Definition at line 127 of file VersionModuleController.php.

References $GLOBALS, and GeneralUtility\makeInstance().

Member Function Documentation

adminLinks	(		$table,
			$row
	)

Administrative links for a table / record

Parameters

string	$table	Table name
array	$row	Record for which administrative links are generated.

Returns

string HTML link tags.

Definition at line 523 of file VersionModuleController.php.

References $GLOBALS, VersionModuleController\$pageModule, BackendUtility\BEgetRootLine(), GeneralUtility\getIndpEnv(), BackendUtility\getLinkToDataHandlerAction(), BackendUtility\isModuleSetInTBE_MODULES(), Icon\SIZE_SMALL, and BackendUtility\viewOnClick().

Referenced by VersionModuleController\pageSubContent(), and VersionModuleController\versioningMgm().

getButtons ( )

protected

Create the panel of buttons for submitting the form or otherwise perform operations.

Returns

array All available buttons as an assoc. array

Definition at line 242 of file VersionModuleController.php.

References $GLOBALS, BackendUtility\BEgetRootLine(), GeneralUtility\getIndpEnv(), Icon\SIZE_SMALL, and BackendUtility\viewOnClick().

Referenced by VersionModuleController\main().

lookForOwnVersions	(		$table,
			$uid
	)

Look for number of versions of a record

Parameters

string	$table	Table name
int	$uid	Record uid

Returns

int Number of versions for record, FALSE if none.

Definition at line 507 of file VersionModuleController.php.

References BackendUtility\selectVersionsOfRecord().

Referenced by VersionModuleController\pageSubContent().

main

(

)

Main function of the module. Write the content to $this->content

Returns

void

Definition at line 150 of file VersionModuleController.php.

References VersionModuleController\$content, $GLOBALS, VersionModuleController\$moduleName, GeneralUtility\_GP(), VersionModuleController\getButtons(), BackendUtility\getFuncMenu(), GeneralUtility\getIndpEnv(), BackendUtility\getRecord(), BackendUtility\isModuleSetInTBE_MODULES(), GeneralUtility\makeInstance(), BackendUtility\readPageAccess(), and VersionModuleController\versioningMgm().

Referenced by VersionModuleController\mainAction().

mainAction	(	ServerRequestInterface	$request,
		ResponseInterface	$response
	)

Injects the request object for the current request and gathers all data.

Parameters

ServerRequestInterface	$request	the current request
ResponseInterface	$response	the prepared response

Returns

ResponseInterface the response with the content

Definition at line 568 of file VersionModuleController.php.

References $response, MessageInterface\getBody(), BaseScriptClass\init(), and VersionModuleController\main().

menuConfig

(

)

Initialize menu configuration

Returns

void

Definition at line 139 of file VersionModuleController.php.

References GeneralUtility\_GP(), and BackendUtility\getModuleData().

pageSubContent	(		$pid,
			$c = 0
	)

Recursively look for children for page version with $pid

Parameters

int	$pid	UID of page record for which to look up sub-elements following that version
int	$c	Counter, do not set (limits to 100 levels)

Returns

string Table with content if any

Definition at line 454 of file VersionModuleController.php.

References VersionModuleController\$content, $GLOBALS, VersionModuleController\adminLinks(), BackendUtility\deleteClause(), BackendUtility\getRecordTitle(), VersionModuleController\lookForOwnVersions(), ArrayUtility\removeArrayEntryByValue(), and Icon\SIZE_SMALL.

Referenced by VersionModuleController\versioningMgm().

printContent

(

)

Outputs accumulated module content to browser.

Returns

void

Deprecated:

since TYPO3 CMS 7, will be removed in TYPO3 CMS 8

Definition at line 231 of file VersionModuleController.php.

References VersionModuleController\$content, and GeneralUtility\logDeprecatedFunction().

versioningMgm

(

)

Management of versions for record

Returns

void

Definition at line 280 of file VersionModuleController.php.

References VersionModuleController\$content, $GLOBALS, GeneralUtility\_POST(), VersionModuleController\adminLinks(), GeneralUtility\getIndpEnv(), BackendUtility\getLinkToDataHandlerAction(), BackendUtility\getRecord(), BackendUtility\getRecordTitle(), GeneralUtility\inList(), GeneralUtility\makeInstance(), VersionModuleController\pageSubContent(), BackendUtility\selectVersionsOfRecord(), and Icon\SIZE_SMALL.

Referenced by VersionModuleController\main().

Member Data Documentation

$content

Definition at line 62 of file VersionModuleController.php.

Referenced by VersionModuleController\main(), VersionModuleController\pageSubContent(), VersionModuleController\printContent(), and VersionModuleController\versioningMgm().

$doc

Definition at line 57 of file VersionModuleController.php.

$formatCount_cache = array()

Definition at line 79 of file VersionModuleController.php.

$formatWorkspace_cache = array()

Definition at line 74 of file VersionModuleController.php.

$MCONF = array()

Definition at line 36 of file VersionModuleController.php.

$MOD_MENU = array()

Definition at line 43 of file VersionModuleController.php.

$MOD_SETTINGS = array()

Definition at line 50 of file VersionModuleController.php.

$moduleName = 'web_txversionM1'

protected

Definition at line 115 of file VersionModuleController.php.

Referenced by VersionModuleController\main().

$moduleTemplate

protected

Definition at line 122 of file VersionModuleController.php.

$pageModule = ''

Definition at line 91 of file VersionModuleController.php.

Referenced by VersionModuleController\adminLinks().

$publishAccess = false

Definition at line 98 of file VersionModuleController.php.

$recIndex = array()

Definition at line 108 of file VersionModuleController.php.

$showWorkspaceCol = 0

Definition at line 69 of file VersionModuleController.php.

$stageIndex = array()

Definition at line 103 of file VersionModuleController.php.

$targets = array()

Definition at line 84 of file VersionModuleController.php.