"TYPO3 4.0.1: tx_version_cm1 Class Reference", "datetime" => "Sat Dec 2 19:27:27 2006", "date" => "2 Dec 2006", "doxygenversion" => "1.4.6", "projectname" => "TYPO3 4.0.1", "projectnumber" => "4.0.1" ); get_header($doxygen_vars); ?>

tx_version_cm1 Class Reference

Inheritance diagram for tx_version_cm1:

Inheritance graph
[legend]
Collaboration diagram for tx_version_cm1:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 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 ()

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()

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 560 of file index.php.

References $pageModule, t3lib_extMgm::extRelPath(), t3lib_extMgm::isLoaded(), and t3lib_BEfunc::isModuleSetInTBE_MODULES().

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 1357 of file index.php.

References $content, t3lib_BEfunc::getItemLabel(), t3lib_BEfunc::getProcessedValue(), t3lib_div::inList(), t3lib_div::loadTCA(), t3lib_div::makeInstance(), t3lib_BEfunc::thumbCode(), and t3lib_div::trimExplode().

Referenced by displayWorkspaceOverview_list(), and subElements_renderItem().

tx_version_cm1::displayWorkspaceOverview (   ) 
 

Rendering the overview of versions in the current workspace

Returns:
string HTML (table)
See also:
typo3/mod/user/ws/index.php for sister function!

Definition at line 692 of file index.php.

References t3lib_div::_GP(), t3lib_BEfunc::blindUserNames(), displayWorkspaceOverview_list(), displayWorkspaceOverview_setInPageArray(), t3lib_BEfunc::getListGroupNames(), t3lib_BEfunc::getUserNames(), and t3lib_div::makeInstance().

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 940 of file index.php.

Referenced by workspaceMgm().

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 1561 of file index.php.

References t3lib_extMgm::extRelPath().

Referenced by displayWorkspaceOverview_list().

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 1631 of file index.php.

References t3lib_extMgm::extRelPath().

Referenced by subElements_renderItem().

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 762 of file index.php.

References createDiffView(), displayWorkspaceOverview_commandLinks(), displayWorkspaceOverview_stageCmd(), formatCount(), formatVerId(), formatWorkspace(), t3lib_iconWorks::getIconImage(), t3lib_BEfunc::getRecord(), t3lib_BEfunc::getRecordTitle(), subElements(), and versionsInOtherWS().

Referenced by displayWorkspaceOverview().

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 927 of file index.php.

Referenced by displayWorkspaceOverview().

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 1474 of file index.php.

Referenced by displayWorkspaceOverview_list().

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 1027 of file index.php.

Referenced by displayWorkspaceOverview_list().

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 990 of file index.php.

Referenced by displayWorkspaceOverview_list().

tx_version_cm1::formatWorkspace (  $  wsid  ) 
 

Formatting workspace ID into a visual label

Parameters:
integer Workspace ID
Returns:
string Workspace title

Definition at line 1000 of file index.php.

References t3lib_BEfunc::deleteClause().

Referenced by displayWorkspaceOverview_list().

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 111 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 543 of file index.php.

References t3lib_BEfunc::selectVersionsOfRecord().

Referenced by pageSubContent().

tx_version_cm1::main (   ) 
 

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

Returns:
void

Definition at line 175 of file index.php.

References t3lib_div::_GP(), t3lib_BEfunc::getRecord(), t3lib_BEfunc::isModuleSetInTBE_MODULES(), t3lib_div::makeInstance(), t3lib_BEfunc::readPageAccess(), versioningMgm(), and workspaceMgm().

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 t3lib_extMgm::extRelPath(), and includeLL().

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 1335 of file index.php.

tx_version_cm1::menuConfig (   ) 
 

Initialize menu configuration

Returns:
void

Reimplemented from t3lib_SCbase.

Definition at line 138 of file index.php.

References 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 489 of file index.php.

References $content, t3lib_BEfunc::deleteClause(), lookForOwnVersions(), and t3lib_div::removeArrayEntryByValue().

Referenced by versioningMgm().

tx_version_cm1::printContent (   ) 
 

Outputs accumulated module content to browser.

Returns:
void

Definition at line 300 of file index.php.

tx_version_cm1::publishAction (   ) 
 

Will publish workspace if buttons are pressed

Returns:
void

Definition at line 1687 of file index.php.

References t3lib_div::_POST(), and t3lib_div::makeInstance().

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 1084 of file index.php.

References t3lib_SCbase::$id.

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 1133 of file index.php.

References t3lib_BEfunc::getRecord(), t3lib_div::makeInstance(), subElements_getNonPageRecords(), and subElements_renderItem().

Referenced by displayWorkspaceOverview_list().

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 1236 of file index.php.

References 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 1266 of file index.php.

References createDiffView(), displayWorkspaceOverview_commandLinksSub(), t3lib_iconWorks::getIconImage(), and t3lib_BEfunc::getRecordTitle().

Referenced by subElements().

tx_version_cm1::versioningMgm (   ) 
 

Management of versions for record

Returns:
void

Definition at line 326 of file index.php.

References $content, t3lib_div::_POST(), adminLinks(), t3lib_iconWorks::getIconImage(), t3lib_BEfunc::getProcessedValue(), t3lib_BEfunc::getRecord(), t3lib_BEfunc::getRecordTitle(), 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 1054 of file index.php.

References t3lib_BEfunc::deleteClause().

Referenced by displayWorkspaceOverview_list().

tx_version_cm1::workspaceMgm (   ) 
 

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

Returns:
void

Definition at line 632 of file index.php.

References t3lib_div::_POST(), displayWorkspaceOverview(), displayWorkspaceOverview_allStageCmd(), t3lib_BEfunc::getFuncCheck(), t3lib_BEfunc::getFuncMenu(), t3lib_div::getIndpEnv(), and publishAction().

Referenced by main().

Member Data Documentation

tx_version_cm1::$content
 

Generally used for accumulating the output content of backend modules

Reimplemented from t3lib_SCbase.

Definition at line 109 of file index.php.

Referenced by createDiffView(), pageSubContent(), and versioningMgm().

tx_version_cm1::$doc
 

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

Reimplemented from t3lib_SCbase.

Definition at line 108 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 105 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 106 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 107 of file index.php.

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