wslib_gui Klassenreferenz

Aufstellung aller Elemente

Öffentliche Methoden
	getWorkspaceOverview (&$doc, $wsid=null, $filter=0, $pageId=-1)
	initVars ()
	displayWorkspaceOverview_setInPageArray (&$pArray, $rlArr, $table, $row)
	markupNewOriginals ()
	displayWorkspaceOverview_list ($pArray, $tableRows=array(), $c=0, $warnAboutVersions=FALSE)
	cropWorkspaceOverview_list (&$pArray, $pointer=0, $resPerPage=50, $stat=array())
	displayWorkspaceOverview_pageTreeIconTitle ($pageUid, $title, $indentCount)
	formatVerId ($verId)
	formatWorkspace ($wsid)
	createDiffView ($table, $diff_1_record, $diff_2_record)
	versionsInOtherWS ($table, $uid)
	showStageChangeLog ($table, $id, $stageCommands)
	displayWorkspaceOverview_commandLinks ($table, &$rec_on, &$rec_off, $vType)
	formatCount ($count)
	subElements ($uid, $treeLevel, $origId=0)
	subElements_getNonPageRecords ($tN, $uid, &$recList)
	subElements_renderItem (&$tCell, $tN, $uid, $rec, $origId, $iconMode, $HTMLdata)
	displayWorkspaceOverview_commandLinksSub ($table, $rec, $origId)
	displayWorkspaceOverview_stageCmd ($table, &$rec_off)
Öffentliche Attribute
	$pageTreeIndent = 8
	$pageTreeIndent_titleLgd = 30
	$diff = false
	$expandSubElements = false
	$alwaysDisplayHeader = false
	$showWorkspaceCol = 0
	$doc
	$formatWorkspace_cache = array()
	$targets = array()
	$be_user_Array = array()
	$pageModule = ''
	$formatCount_cache = array()
	$stageIndex = array()
	$addHlSubelementsScript = false

---

Dokumentation der Elementfunktionen

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

Create visual difference view of two records. Using t3lib_diff library

Parameter:

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

Rückgabe:

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

wslib_gui::cropWorkspaceOverview_list	(	&$	pArray,
		$	pointer = 0,
		$	resPerPage = 50,
		$	stat = array()
	)

Filtering out items in pArray according to pointer and result-per-page setting

Parameter:

array

Hierarchical storage of the elements to display (see displayWorkspaceOverview() / displayWorkspaceOverview_setInPageArray())

Rückgabe:

array Returns statistics about the pointer state.

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

Links to publishing etc of a version

Parameter:

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

Rückgabe:

string HTML content, mainly link tags and images.

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

Links to publishing etc of a version

Parameter:

	string	Table name
	array	Record array
	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.

Rückgabe:

string HTML content, mainly link tags and images.

wslib_gui::displayWorkspaceOverview_list	(	$	pArray,
		$	tableRows = array(),
		$	c = 0,
		$	warnAboutVersions = FALSE
	)

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

Parameter:

	array	Hierarchical storage of the elements to display (see displayWorkspaceOverview() / displayWorkspaceOverview_setInPageArray())
	array	Existing array of table rows to add to
	array	Depth counter
	boolean	If set, a warning is shown if versions are found (internal flag)

Rückgabe:

array Table rows, see displayWorkspaceOverview()

wslib_gui::displayWorkspaceOverview_pageTreeIconTitle	(	$	pageUid,
		$	title,
		$	indentCount
	)

Create indentation, icon and title for the page tree identification for the list.

Parameter:

	integer	Page UID (record will be looked up again)
	string	Page title
	integer	Depth counter from displayWorkspaceOverview_list() used to indent the icon and title

Rückgabe:

string HTML content

wslib_gui::displayWorkspaceOverview_setInPageArray	(	&$	pArray,
		$	rlArr,
		$	table,
		$	row
	)

Building up of the $pArray variable which is a hierarchical storage of table-rows arranged according to the level in the rootline the element was found (Internal) Made for recursive calling

Parameter:

	array	Array that is built up with the page tree structure
	array	Root line for element (table / row); The element is stored in pArray according to this root line.
	string	Table name
	array	Table row

Rückgabe:

void $pArray is passed by reference and modified internally

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

Links to stage change of a version

Parameter:

	string	Table name
	array	Offline record (version)

Rückgabe:

string HTML content, mainly link tags and images.

wslib_gui::formatCount

(

$

count

)

Format publishing count for version (lifecycle state)

Parameter:

integer

t3ver_count value (number of times it has been online)

Rückgabe:

string String translation of count.

wslib_gui::formatVerId

(

$

verId

)

Formatting the version number for HTML output

Parameter:

integer

Version number

Rückgabe:

string Version number for output

wslib_gui::formatWorkspace

(

$

wsid

)

Formatting workspace ID into a visual label

Parameter:

integer

Workspace ID

Rückgabe:

string Workspace title

wslib_gui::getWorkspaceOverview	(	&$	doc,
		$	wsid = null,
		$	filter = 0,
		$	pageId = -1
	)

Creates HTML to display workspace overview. Can be used to display overview for all possible records or only for single page.

The following code is required in BE module when this function is used: $this->doc->getContextMenuCode(); or click-menu will not be generated properly!

Parameter:

	object	$doc Document (to use for formatting)
	int	$wsid Workspace ID, If null, the value is obtained from current BE user
	int	$filter If 0, than no filtering, if 10 than select for publishing, otherwise stage value
	int	$pageId If greater than zero, than it is UID of page in LIVE workspaces to select records for

Rückgabe:

string Generated HTML

wslib_gui::initVars

(

)

Initializes several class variables

Rückgabe:

void

wslib_gui::markupNewOriginals

(

)

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

Rückgabe:

string HTML javascript section

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

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

Parameter:

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

Rückgabe:

string HTML code.

wslib_gui::subElements	(	$	uid,
		$	treeLevel,
		$	origId = 0
	)

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

Parameter:

	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.

Rückgabe:

string HTML content.

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

Select records from a table and add them to recList

Parameter:

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

Rückgabe:

void

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

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

Parameter:

	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)

Rückgabe:

void (Content accumulated in $tCell!)

wslib_gui::versionsInOtherWS	(	$	table,
		$	uid
	)

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

Parameter:

	string	Table name
	integer	Record uid

Rückgabe:

string List of other workspace IDs

---

Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei:

• /srv/www/vhosts/typo3.local/typo3_src-4.2.10/typo3/mod/user/ws/class.wslib_gui.php