Solutions Open Source

Référence de la classe tx_version_cm1

Graphe d'héritage de tx_version_cm1:

[légende]

Graphe de collaboration de tx_version_cm1:

[légende]

Liste de tous les membres

Fonctions membres publiques
	main (&$backRef, $menuItems, $table, $uid)
	includeLL ()
	menuConfig ()
	main ()
	printContent ()
	versioningMgm ()
	pageSubContent ($pid, $c=0)
	lookForOwnVersions ($table, $uid)
	adminLinks ($table, $row)
	workspaceMgm ()
	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 ()
Attributs publics
	$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()

---

Documentation des fonctions membres

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

Main function, adding the item to input menuItems array

Paramètres:

	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

Renvoie:

array Modified menuItems array

tx_version_cm1::includeLL

(

)

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

Renvoie:

array Local lang array

tx_version_cm1::menuConfig

(

)

Initialize menu configuration

Renvoie:

void

Réimplémentée à partir de t3lib_SCbase.

tx_version_cm1::main

(

)

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

Renvoie:

void

tx_version_cm1::printContent

(

)

Outputs accumulated module content to browser.

Renvoie:

void

tx_version_cm1::versioningMgm

(

)

Management of versions for record

Renvoie:

void

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

Recursively look for children for page version with $pid

Paramètres:

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

Renvoie:

string Table with content if any

tx_version_cm1::lookForOwnVersions	(	$	table,
		$	uid
	)

Look for number of versions of a record

Paramètres:

	string	Table name
	integer	Record uid

Renvoie:

integer Number of versions for record, false if none.

tx_version_cm1::adminLinks	(	$	table,
		$	row
	)

Administrative links for a table / record

Paramètres:

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

Renvoie:

string HTML link tags.

tx_version_cm1::workspaceMgm

(

)

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

Renvoie:

void

tx_version_cm1::displayWorkspaceOverview

(

)

Rendering the overview of versions in the current workspace

Renvoie:

string HTML (table)

Voir également:

typo3/mod/user/ws/index.php for sister function!

tx_version_cm1::displayWorkspaceOverview_list

(

$

pArray

)

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

Paramètres:

array

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

Renvoie:

array Table rows, see displayWorkspaceOverview()

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

Building up of the $pArray (Internal)

Paramètres:

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

Renvoie:

void $pArray is passed by reference and modified internally

tx_version_cm1::displayWorkspaceOverview_allStageCmd

(

)

Links to stage change of a version

Paramètres:

	string	Table name
	array	Offline record (version)

Renvoie:

string HTML content, mainly link tags and images.

tx_version_cm1::formatVerId

(

$

verId

)

Formatting the version number for HTML output

Paramètres:

integer

Version number

Renvoie:

string Version number for output

tx_version_cm1::formatWorkspace

(

$

wsid

)

Formatting workspace ID into a visual label

Paramètres:

integer

Workspace ID

Renvoie:

string Workspace title

tx_version_cm1::formatCount

(

$

count

)

Format publishing count for version (lifecycle state)

Paramètres:

integer

t3ver_count value (number of times it has been online)

Renvoie:

string String translation of count.

tx_version_cm1::versionsInOtherWS	(	$	table,
		$	uid
	)

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

Paramètres:

	string	Table name
	integer	Record uid

Renvoie:

string List of other workspace IDs

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

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

Paramètres:

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

Renvoie:

string HTML code.

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)

Paramètres:

	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.

Renvoie:

string HTML content.

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

Select records from a table and add them to recList

Paramètres:

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

Renvoie:

void

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

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

Paramètres:

	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)

Renvoie:

void (Content accumulated in $tCell!)

tx_version_cm1::markupNewOriginals

(

)

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

Renvoie:

string HTML javascript section

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

Create visual difference view of two records. Using t3lib_diff library

Paramètres:

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

Renvoie:

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

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

Links to stage change of a version

Paramètres:

	string	Table name
	array	Offline record (version)

Renvoie:

string HTML content, mainly link tags and images.

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

Links to publishing etc of a version

Paramètres:

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

Renvoie:

string HTML content, mainly link tags and images.

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

Links to publishing etc of a version

Paramètres:

	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.

Renvoie:

string HTML content, mainly link tags and images.

tx_version_cm1::publishAction

(

)

Will publish workspace if buttons are pressed

Renvoie:

void

---

Documentation des données membres

tx_version_cm1::$MCONF = array()

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

Voir également:

init()

Réimplémentée à partir de t3lib_SCbase.

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.

Voir également:

init()

Réimplémentée à partir de t3lib_SCbase.

tx_version_cm1::$MOD_SETTINGS = array()

Current settings for the keys of the MOD_MENU array

Voir également:

$MOD_MENU

Réimplémentée à partir de t3lib_SCbase.

tx_version_cm1::$doc

Generally used to hold an instance of the 'template' class from typo3/template.php

Réimplémentée à partir de t3lib_SCbase.

tx_version_cm1::$content

Generally used for accumulating the output content of backend modules

Réimplémentée à partir de t3lib_SCbase.

tx_version_cm1::$showWorkspaceCol = 0

tx_version_cm1::$formatWorkspace_cache = array()

tx_version_cm1::$formatCount_cache = array()

tx_version_cm1::$targets = array()

tx_version_cm1::$pageModule = ''

tx_version_cm1::$publishAccess = FALSE

tx_version_cm1::$be_user_Array = array()

tx_version_cm1::$stageIndex = array()

tx_version_cm1::$recIndex = array()

---

La documentation de cette classe a été générée à partir des fichiers suivants :

• Z:/doxygen/typo3_src-4.1.2/typo3/sysext/version/class.tx_version_cm1.php
• Z:/doxygen/typo3_src-4.1.2/typo3/sysext/version/cm1/index.php

---