Inheritance diagram for tx_version_cm1:

Collaboration diagram for tx_version_cm1:

Public Member Functions
	main (&$backRef, $menuItems, $table, $uid)
	includeLL ()
	menuConfig ()
	main ()
	printContent ()
	versioningMgm ()
	pageSubContent ($pid, $c=0)
	lookForOwnVersions ($table, $uid)
	adminLinks ($table, $row)
	workspaceMgm ()
	workspaceMenu ()
	displayWorkspaceOverview ()
	displayWorkspaceOverview_list ($pArray)
	displayWorkspaceOverview_setInPageArray (&$pArray, $table, $row)
	displayWorkspaceOverview_allStageCmd ()
	formatVerId ($verId)
	formatWorkspace ($wsid)
	formatCount ($count)
	versionsInOtherWS ($table, $uid)
	showStageChangeLog ($table, $id, $stageCommands)
	subElements ($uid, $treeLevel, $origId=0)
	subElements_getNonPageRecords ($tN, $uid, &$recList)
	subElements_renderItem (&$tCell, $tN, $uid, $rec, $origId, $iconMode, $HTMLdata)
	markupNewOriginals ()
	createDiffView ($table, $diff_1_record, $diff_2_record)
	displayWorkspaceOverview_stageCmd ($table, &$rec_off)
	displayWorkspaceOverview_commandLinks ($table, &$rec_on, &$rec_off, $vType)
	displayWorkspaceOverview_commandLinksSub ($table, $rec, $origId)
	publishAction ()
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
	$be_user_Array = array()
	$stageIndex = array()
	$recIndex = array()
Protected Member Functions
	getButtons ()
Protected Attributes
	$showDraftWorkspace = FALSE

Detailed Description

Definition at line 54 of file class.tx_version_cm1.php.

Member Function Documentation

tx_version_cm1::adminLinks	(	$	table,
		$	row
	)

Administrative links for a table / record

Parameters:

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

Returns:: string HTML link tags.

Definition at line 625 of file index.php.

References $BE_USER, $GLOBALS, $pageModule, $row, t3lib_BEfunc\BEgetRootLine(), t3lib_BEfunc\editOnClick(), t3lib_iconWorks\getSpriteIcon(), t3lib_extMgm\isLoaded(), t3lib_BEfunc\isModuleSetInTBE_MODULES(), and t3lib_BEfunc\viewOnClick().

Referenced by versioningMgm().

tx_version_cm1::createDiffView	(	$	table,
		$	diff_1_record,
		$	diff_2_record
	)

Create visual difference view of two records. Using t3lib_diff library

Parameters:

string	Table name
array	New version record (green)
array	Old version record (red)

Returns:: array Array with two keys (0/1) with HTML content / percentage integer (if -1, then it means N/A) indicating amount of change

Definition at line 1485 of file index.php.

tx_version_cm1::displayWorkspaceOverview ( )

Rendering the overview of versions in the current workspace

Returns:: string HTML (table)

See also:: ws/index.php for sister function!

Definition at line 769 of file index.php.

Referenced by workspaceMgm().

tx_version_cm1::displayWorkspaceOverview_allStageCmd ( )

Links to stage change of a version

Parameters:

string	Table name
array	Offline record (version)

Returns:: string HTML content, mainly link tags and images.

Definition at line 1027 of file index.php.

tx_version_cm1::displayWorkspaceOverview_commandLinks	(	$	table,
		&$	rec_on,
		&$	rec_off,
		$	vType
	)

Links to publishing etc of a version

Parameters:

string	Table name
array	Online record
array	Offline record (version)
string	Swap type, "branch", "page" or "element"

Returns:: string HTML content, mainly link tags and images.

Definition at line 1690 of file index.php.

References $GLOBALS.

tx_version_cm1::displayWorkspaceOverview_commandLinksSub	(	$	table,
		$	rec,
		$	origId
	)

Links to publishing etc of a version

Parameters:

string	Table name
array	Record
integer	The uid of the online version of $uid. If zero it means we are drawing a row for the online version itself while a value means we are drawing display for an offline version.

Returns:: string HTML content, mainly link tags and images.

Definition at line 1760 of file index.php.

tx_version_cm1::displayWorkspaceOverview_list ( $ pArray )

Rendering the content for the publish / review overview: (Made for internal recursive calling)

Parameters:

array Storage of the elements to display (see displayWorkspaceOverview() / displayWorkspaceOverview_setInPageArray())

Returns:: array Table rows, see displayWorkspaceOverview()

Definition at line 842 of file index.php.

tx_version_cm1::displayWorkspaceOverview_setInPageArray	(	&$	pArray,
		$	table,
		$	row
	)

Building up of the $pArray (Internal)

Parameters:

array	Array that is built up with the page tree structure
string	Table name
array	Table row

Returns:: void $pArray is passed by reference and modified internally

Definition at line 1014 of file index.php.

tx_version_cm1::displayWorkspaceOverview_stageCmd	(	$	table,
		&$	rec_off
	)

Links to stage change of a version

Parameters:

string	Table name
array	Offline record (version)

Returns:: string HTML content, mainly link tags and images.

Definition at line 1602 of file index.php.

tx_version_cm1::formatCount ( $ count )

Format publishing count for version (lifecycle state)

Parameters:

integer t3ver_count value (number of times it has been online)

Returns:: string String translation of count.

Definition at line 1155 of file index.php.

tx_version_cm1::formatVerId ( $ verId )

Formatting the version number for HTML output

Parameters:

integer Version number

Returns:: string Version number for output

Definition at line 1118 of file index.php.

tx_version_cm1::formatWorkspace ( $ wsid )

Formatting workspace ID into a visual label

Parameters:

integer Workspace ID

Returns:: string Workspace title

Definition at line 1128 of file index.php.

tx_version_cm1::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 335 of file index.php.

References $BACK_PATH, $BE_USER, $GLOBALS, $TCA, t3lib_BEfunc\BEgetRootLine(), t3lib_div\getIndpEnv(), t3lib_BEfunc\getListViewLink(), t3lib_iconWorks\getSpriteIcon(), and t3lib_BEfunc\viewOnClick().

Referenced by main().

tx_version_cm1::includeLL ( )

Includes the [extDir]/locallang.php and returns the $LOCAL_LANG array found in that file.

Returns:: array Local lang array

Definition at line 123 of file class.tx_version_cm1.php.

Referenced by main().

tx_version_cm1::lookForOwnVersions	(	$	table,
		$	uid
	)

Look for number of versions of a record

Parameters:

string	Table name
integer	Record uid

Returns:: integer Number of versions for record, false if none.

Definition at line 608 of file index.php.

References $TCA, and t3lib_BEfunc\selectVersionsOfRecord().

Referenced by pageSubContent().

tx_version_cm1::main	(	&$	backRef,
		$	menuItems,
		$	table,
		$	uid
	)

Main function, adding the item to input menuItems array

Parameters:

object	References to parent clickmenu objects.
array	Array of existing menu items accumulated. New element added to this.
string	Table name of the element
integer	Record UID of the element

Returns:: array Modified menuItems array

Definition at line 65 of file class.tx_version_cm1.php.

References $BE_USER, $GLOBALS, $TCA, $value, t3lib_extMgm\extRelPath(), and includeLL().

tx_version_cm1::main ( )

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

Returns:: void

Definition at line 189 of file index.php.

References $BACK_PATH, $BE_USER, $CLIENT, $GLOBALS, $TCA, $TYPO3_CONF_VARS, t3lib_div\_GP(), getButtons(), t3lib_BEfunc\getFuncMenu(), t3lib_div\getIndpEnv(), t3lib_BEfunc\getRecord(), t3lib_BEfunc\isModuleSetInTBE_MODULES(), t3lib_div\makeInstance(), t3lib_BEfunc\readPageAccess(), versioningMgm(), workspaceMenu(), and workspaceMgm().

tx_version_cm1::markupNewOriginals ( )

JavaScript code to mark up new records that are online (in sub element lists)

Returns:: string HTML javascript section

Definition at line 1463 of file index.php.

tx_version_cm1::menuConfig ( )

Initialize menu configuration

Returns:: void

Reimplemented from t3lib_SCbase.

Definition at line 142 of file index.php.

References $GLOBALS, t3lib_div\_GP(), t3lib_BEfunc\deleteClause(), and t3lib_BEfunc\getModuleData().

tx_version_cm1::pageSubContent	(	$	pid,
		$	c = `0`
	)

Recursively look for children for page version with $pid

Parameters:

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

Returns:: string Table with content if any

Definition at line 554 of file index.php.

References $content, $GLOBALS, $pid, $TCA, t3lib_BEfunc\deleteClause(), t3lib_BEfunc\getRecordTitle(), lookForOwnVersions(), and t3lib_div\removeArrayEntryByValue().

Referenced by versioningMgm().

tx_version_cm1::printContent ( )

Outputs accumulated module content to browser.

Returns:: void

Definition at line 326 of file index.php.

tx_version_cm1::publishAction ( )

Will publish workspace if buttons are pressed

Returns:: void

Definition at line 1816 of file index.php.

Referenced by workspaceMgm().

tx_version_cm1::showStageChangeLog	(	$	table,
		$	id,
		$	stageCommands
	)

Looks up stage changes for version and displays a formatted view on mouseover.

Parameters:

string	Table name
integer	Record ID
string	HTML string to wrap the mouseover around (should be stage change links)

Returns:: string HTML code.

Definition at line 1212 of file index.php.

tx_version_cm1::subElements	(	$	uid,
		$	treeLevel,
		$	origId = `0`
	)

Creates display of sub elements of a page when the swap mode is either "Page" or "Branch" (0 / ALL)

Parameters:

integer	Page uid (for either online or offline version, but it MUST have swapmode/treeLevel set to >0 (not -1 indicating element versioning)
integer	The treeLevel value, >0 indicates "branch" while 0 means page+content. (-1 would have meant element versioning, but that should never happen for a call to this function!)
integer	For offline versions; This is t3ver_oid, the original ID of the online page.

Returns:: string HTML content.

Definition at line 1261 of file index.php.

References $GLOBALS, $TCA, t3lib_BEfunc\getRecord(), t3lib_div\makeInstance(), subElements_getNonPageRecords(), and subElements_renderItem().

tx_version_cm1::subElements_getNonPageRecords	(	$	tN,
		$	uid,
		&$	recList
	)

Select records from a table and add them to recList

Parameters:

string	Table name (from TCA)
integer	PID to select records from
array	Array where records are accumulated, passed by reference

Returns:: void

Definition at line 1364 of file index.php.

References $GLOBALS, $TCA, and t3lib_BEfunc\deleteClause().

Referenced by subElements().

tx_version_cm1::subElements_renderItem	(	&$	tCell,
		$	tN,
		$	uid,
		$	rec,
		$	origId,
		$	iconMode,
		$	HTMLdata
	)

Render a single item in a subelement list into a table row:

Parameters:

array	Table rows, passed by reference
string	Table name
integer	Page uid for which the subelements are selected/shown
array	Row of element in list
integer	The uid of the online version of $uid. If zero it means we are drawing a row for the online version itself while a value means we are drawing display for an offline version.
integer	Mode of icon display: 0=not the last, 1= is the last in list (make joinbottom icon then), 2=do not shown icons are all (for pages from the page tree already rendered)
string	Prefix HTML data (icons for tree rendering)

Returns:: void (Content accumulated in $tCell!)

Definition at line 1394 of file index.php.

References $TCA.

Referenced by subElements().

tx_version_cm1::versioningMgm ( )

Management of versions for record

Returns:: void

Definition at line 389 of file index.php.

References $content, $GLOBALS, $row, $TCA, t3lib_div\_POST(), adminLinks(), t3lib_BEfunc\editOnClick(), t3lib_TCEforms\getHiddenTokenField(), t3lib_BEfunc\getProcessedValue(), t3lib_BEfunc\getRecord(), t3lib_BEfunc\getRecordTitle(), t3lib_iconWorks\getSpriteIcon(), t3lib_iconWorks\getSpriteIconForRecord(), t3lib_div\inList(), t3lib_div\loadTCA(), t3lib_div\makeInstance(), pageSubContent(), and t3lib_BEfunc\selectVersionsOfRecord().

Referenced by main().

tx_version_cm1::versionsInOtherWS	(	$	table,
		$	uid
	)

Looking for versions of a record in other workspaces than the current

Parameters:

string	Table name
integer	Record uid

Returns:: string List of other workspace IDs

Definition at line 1182 of file index.php.

tx_version_cm1::workspaceMenu ( )

Definition at line 746 of file index.php.

Referenced by main().

tx_version_cm1::workspaceMgm ( )

Management of workspace for page ID Called when $this->id is set.

Returns:: void

Definition at line 697 of file index.php.

References $GLOBALS, displayWorkspaceOverview(), and publishAction().

Referenced by main().

Member Data Documentation

tx_version_cm1::$be_user_Array = array()

Definition at line 121 of file index.php.

tx_version_cm1::$content

Generally used for accumulating the output content of backend modules

Reimplemented from t3lib_SCbase.

Definition at line 111 of file index.php.

Referenced by pageSubContent(), and versioningMgm().

tx_version_cm1::$doc

Reimplemented from t3lib_SCbase.

Definition at line 110 of file index.php.

tx_version_cm1::$formatCount_cache = array()

Definition at line 117 of file index.php.

tx_version_cm1::$formatWorkspace_cache = array()

Definition at line 116 of file index.php.

tx_version_cm1::$MCONF = array()

Loaded with the global array $MCONF which holds some module configuration from the conf.php file of backend modules.

See also:: init()

Reimplemented from t3lib_SCbase.

Definition at line 101 of file index.php.

tx_version_cm1::$MOD_MENU = array()

The module menu items array. Each key represents a key for which values can range between the items in the array of that key.

See also:: init()

Reimplemented from t3lib_SCbase.

Definition at line 102 of file index.php.

tx_version_cm1::$MOD_SETTINGS = array()

Current settings for the keys of the MOD_MENU array

See also:: $MOD_MENU

Reimplemented from t3lib_SCbase.

Definition at line 103 of file index.php.

tx_version_cm1::$pageModule = ''

Definition at line 119 of file index.php.

Referenced by adminLinks().

tx_version_cm1::$publishAccess = FALSE

Definition at line 120 of file index.php.

tx_version_cm1::$recIndex = array()

Definition at line 123 of file index.php.

tx_version_cm1::$showDraftWorkspace = FALSE [protected]

Definition at line 124 of file index.php.

tx_version_cm1::$showWorkspaceCol = 0

Definition at line 115 of file index.php.

tx_version_cm1::$stageIndex = array()

Definition at line 122 of file index.php.

tx_version_cm1::$targets = array()

Definition at line 118 of file index.php.

The documentation for this class was generated from the following files:

typo3/sysext/version/class.tx_version_cm1.php
typo3/sysext/version/cm1/index.php

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

Member Data Documentation