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

SC_mod_user_ws_index Class Reference

Inheritance diagram for SC_mod_user_ws_index:

Inheritance graph
[legend]
Collaboration diagram for SC_mod_user_ws_index:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 menuConfig ()
 init ()
 main ()
 printContent ()
 moduleContent_publish ()
 displayVersionDetails ($details)
 displayWorkspaceOverview ()
 displayWorkspaceOverview_list ($pArray, $tableRows=array(), $c=0, $warnAboutVersions=FALSE)
 displayWorkspaceOverview_pageTreeIconTitle ($pageUid, $title, $indentCount)
 displayWorkspaceOverview_stageCmd ($table, &$rec_off)
 displayWorkspaceOverview_commandLinks ($table, &$rec_on, &$rec_off, $vType)
 displayWorkspaceOverview_commandLinksSub ($table, $rec, $origId)
 displayWorkspaceOverview_setInPageArray (&$pArray, $rlArr, $table, $row)
 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)
 moduleContent_workspaceList ()
 workspaceList_displayUserWorkspaceList ()
 workspaceList_getUserWorkspaceList ()
 workspaceList_formatWorkspaceData (&$wksp)
 workspaceList_getWebMountPoints (&$wksp)
 workspaceList_getFileMountPoints (&$wksp)
 workspaceList_displayUserWorkspaceListHeader ()
 workspaceList_getUserList (&$wksp)
 workspaceList_getUserListForSysWorkspace (&$wksp)
 workspaceList_getUserListWithAccess (&$list, $access)
 workspaceList_displayIcons ($currentWorkspace, &$wksp)
 workspaceList_hasEditAccess (&$wksp)
 workspaceList_createFakeWorkspaceRecord ($uid)
 formatVerId ($verId)
 formatWorkspace ($wsid)
 formatCount ($count)
 versionsInOtherWS ($table, $uid)
 showStageChangeLog ($table, $id, $stageCommands)
 publishAction ()

Public Attributes

 $pageTreeIndent = 8
 $pageTreeIndent_titleLgd = 30
 $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()
 $be_user_Array_full = array()
 $stageIndex = array()

Detailed Description

Definition at line 120 of file index.php.

Member Function Documentation

SC_mod_user_ws_index::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 1217 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().

SC_mod_user_ws_index::displayVersionDetails (  $  details  ) 
 

Display details for a single version from workspace

Parameters:
string Version identification, made of table and uid
Returns:
string HTML string

Definition at line 454 of file index.php.

Referenced by moduleContent_publish().

SC_mod_user_ws_index::displayWorkspaceOverview (   ) 
 

Rendering the overview of versions in the current workspace

Returns:
string HTML (table)

Definition at line 463 of file index.php.

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

Referenced by moduleContent_publish().

SC_mod_user_ws_index::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 836 of file index.php.

References t3lib_extMgm::extRelPath().

Referenced by displayWorkspaceOverview_list().

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

Links to publishing etc of a version

Parameters:
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.
Returns:
string HTML content, mainly link tags and images.

Definition at line 912 of file index.php.

References t3lib_extMgm::extRelPath().

Referenced by subElements_renderItem().

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

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

Parameters:
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)
Returns:
array Table rows, see displayWorkspaceOverview()

Definition at line 538 of file index.php.

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

Referenced by displayWorkspaceOverview().

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

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

Parameters:
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
Returns:
string HTML content

Definition at line 731 of file index.php.

References t3lib_div::fixed_lgd_cs(), t3lib_iconWorks::getIconImage(), and t3lib_BEfunc::getRecord().

Referenced by displayWorkspaceOverview_list().

SC_mod_user_ws_index::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

Parameters:
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
Returns:
void $pArray is passed by reference and modified internally

Definition at line 962 of file index.php.

Referenced by displayWorkspaceOverview().

SC_mod_user_ws_index::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 746 of file index.php.

Referenced by displayWorkspaceOverview_list().

SC_mod_user_ws_index::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 1936 of file index.php.

Referenced by displayWorkspaceOverview_list().

SC_mod_user_ws_index::formatVerId (  $  verId  ) 
 

Formatting the version number for HTML output

Parameters:
integer Version number
Returns:
string Version number for output

Definition at line 1899 of file index.php.

Referenced by displayWorkspaceOverview_list().

SC_mod_user_ws_index::formatWorkspace (  $  wsid  ) 
 

Formatting workspace ID into a visual label

Parameters:
integer Workspace ID
Returns:
string Workspace title

Definition at line 1909 of file index.php.

References t3lib_BEfunc::deleteClause().

Referenced by displayWorkspaceOverview_list().

SC_mod_user_ws_index::init (   ) 
 

Standard init function of a module.

Returns:
void

Reimplemented from t3lib_SCbase.

Definition at line 204 of file index.php.

References t3lib_BEfunc::isModuleSetInTBE_MODULES(), t3lib_div::makeInstance(), and t3lib_iconWorks::skinImg().

SC_mod_user_ws_index::main (   ) 
 

Main function for Workspace Manager module.

Returns:
void

Definition at line 282 of file index.php.

References $content, t3lib_div::_GET(), moduleContent_publish(), moduleContent_workspaceList(), and publishAction().

SC_mod_user_ws_index::markupNewOriginals (   ) 
 

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

Returns:
string HTML javascript section

Definition at line 1195 of file index.php.

SC_mod_user_ws_index::menuConfig (   ) 
 

Initialize menu configuration

Returns:
void

Reimplemented from t3lib_SCbase.

Definition at line 157 of file index.php.

References t3lib_div::_GP(), t3lib_BEfunc::deleteClause(), and t3lib_BEfunc::getModuleData().

SC_mod_user_ws_index::moduleContent_publish (   ) 
 

Rendering the content for the publish and review panel in the workspace manager

Returns:
string HTML content

Definition at line 353 of file index.php.

References $content, t3lib_div::_GP(), displayVersionDetails(), displayWorkspaceOverview(), t3lib_BEfunc::getFuncCheck(), t3lib_BEfunc::getFuncMenu(), and t3lib_iconWorks::getIconImage().

Referenced by main().

SC_mod_user_ws_index::moduleContent_workspaceList (   ) 
 

Rendering of the workspace list

Returns:
string HTML

Definition at line 1349 of file index.php.

References workspaceList_displayUserWorkspaceList().

Referenced by main().

SC_mod_user_ws_index::printContent (   ) 
 

Print module content. Called as last thing in the global scope.

Returns:
void

Definition at line 323 of file index.php.

SC_mod_user_ws_index::publishAction (   ) 
 

Will publish workspace if buttons are pressed

Returns:
void

Definition at line 2055 of file index.php.

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

Referenced by main().

SC_mod_user_ws_index::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 1994 of file index.php.

References t3lib_BEfunc::datetime().

SC_mod_user_ws_index::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 993 of file index.php.

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

Referenced by displayWorkspaceOverview_list().

SC_mod_user_ws_index::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 1096 of file index.php.

References t3lib_BEfunc::deleteClause().

Referenced by subElements().

SC_mod_user_ws_index::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 1126 of file index.php.

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

Referenced by subElements().

SC_mod_user_ws_index::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 1964 of file index.php.

References t3lib_BEfunc::deleteClause().

Referenced by displayWorkspaceOverview_list().

SC_mod_user_ws_index::workspaceList_createFakeWorkspaceRecord (  $  uid  ) 
 

Creates a fake workspace record for system workspaces. Record contains all fields found in sys_workspaces.

Parameters:
integer System workspace ID. Currently 0 and -1 are accepted.
Returns:
array Generated record (see sys_workspaces for structure)

Definition at line 1834 of file index.php.

Referenced by workspaceList_getUserWorkspaceList().

SC_mod_user_ws_index::workspaceList_displayIcons (  $  currentWorkspace,
&$  wksp
) 
 

Creates a list of icons for workspace.

Parameters:
boolean true if current workspace
array Workspace record
Returns:
string Generated content

Definition at line 1774 of file index.php.

References t3lib_iconWorks::skinImg().

Referenced by workspaceList_displayUserWorkspaceList().

SC_mod_user_ws_index::workspaceList_displayUserWorkspaceList (   ) 
 

Generates HTML to display a list of workspaces.

Returns:
string Generated HTML code

Definition at line 1364 of file index.php.

References $content, t3lib_iconWorks::skinImg(), workspaceList_displayIcons(), workspaceList_displayUserWorkspaceListHeader(), workspaceList_formatWorkspaceData(), and workspaceList_getUserWorkspaceList().

Referenced by moduleContent_workspaceList().

SC_mod_user_ws_index::workspaceList_displayUserWorkspaceListHeader (   ) 
 

Creates a header for the workspace list table. This function only makes workspaceList_displayUserWorkspaceList() smaller.

Returns:
string Generated content

Definition at line 1627 of file index.php.

Referenced by workspaceList_displayUserWorkspaceList().

SC_mod_user_ws_index::workspaceList_formatWorkspaceData (  &$  wksp  ) 
 

Create inner information panel for workspace list. This panel is initially hidden and becomes visible when user click on the expand icon on the very left of workspace list against the workspace he wants to explore.

Parameters:
array Workspace information
Returns:
string Formatted workspace information

Definition at line 1483 of file index.php.

References $content, t3lib_BEfunc::datetime(), workspaceList_getFileMountPoints(), workspaceList_getUserList(), and workspaceList_getWebMountPoints().

Referenced by workspaceList_displayUserWorkspaceList().

SC_mod_user_ws_index::workspaceList_getFileMountPoints (  &$  wksp  ) 
 

Retrieves and formats file mount points lists.

Parameters:
array &$wksp Workspace record
Returns:
string Generated HTML

Definition at line 1574 of file index.php.

Referenced by workspaceList_formatWorkspaceData().

SC_mod_user_ws_index::workspaceList_getUserList (  &$  wksp  ) 
 

Generates a list of <option> tags with user names.

Parameters:
array Workspace record
Returns:
string Generated content

Definition at line 1647 of file index.php.

Referenced by workspaceList_formatWorkspaceData().

SC_mod_user_ws_index::workspaceList_getUserListForSysWorkspace (  &$  wksp  ) 
 

Generates a list of user names that has access to the system workspace.

Parameters:
array &$wksp Workspace record
Returns:
string Generated content

Definition at line 1674 of file index.php.

References t3lib_iconWorks::getIconImage().

SC_mod_user_ws_index::workspaceList_getUserListWithAccess (  &$  list,
$  access
) 
 

Generates a list of user names that has access to the workspace.

Parameters:
array A list of user IDs separated by comma
string Access string
Returns:
string Generated content

Definition at line 1701 of file index.php.

References t3lib_BEfunc::getGroupNames(), and t3lib_iconWorks::getIconImage().

SC_mod_user_ws_index::workspaceList_getUserWorkspaceList (   ) 
 

Retrieves a list of workspaces where user has access.

Returns:
array A list of workspaces available to the current BE user

Definition at line 1441 of file index.php.

References t3lib_BEfunc::deleteClause(), t3lib_BEfunc::getUserNames(), and workspaceList_createFakeWorkspaceRecord().

Referenced by workspaceList_displayUserWorkspaceList().

SC_mod_user_ws_index::workspaceList_getWebMountPoints (  &$  wksp  ) 
 

Retrieves and formats database mount points lists.

Parameters:
array &$wksp Workspace record
Returns:
string Generated HTML

Definition at line 1525 of file index.php.

References t3lib_iconWorks::getIconImage(), and t3lib_iconWorks::skinImg().

Referenced by workspaceList_formatWorkspaceData().

SC_mod_user_ws_index::workspaceList_hasEditAccess (  &$  wksp  ) 
 

Checks if user has edit access to workspace. Access is granted if workspace is custom and user is admin or the the owner of the workspace. This function assumes that $wksp were passed through $GLOBALS['BE_USER']->checkWorkspace() function to obtain _ACCESS attribute of the workspace.

Parameters:
array Workspace record
Returns:
boolean true if user can modify workspace parameters

Definition at line 1822 of file index.php.

Member Data Documentation

SC_mod_user_ws_index::$content
 

Generally used for accumulating the output content of backend modules

Reimplemented from t3lib_SCbase.

Definition at line 131 of file index.php.

Referenced by createDiffView(), main(), moduleContent_publish(), workspaceList_displayUserWorkspaceList(), and workspaceList_formatWorkspaceData().

SC_mod_user_ws_index::$doc
 

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

Reimplemented from t3lib_SCbase.

Definition at line 130 of file index.php.

SC_mod_user_ws_index::$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 127 of file index.php.

SC_mod_user_ws_index::$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 128 of file index.php.

SC_mod_user_ws_index::$MOD_SETTINGS = array()
 

Current settings for the keys of the MOD_MENU array

See also:
$MOD_MENU

Reimplemented from t3lib_SCbase.

Definition at line 129 of file index.php.

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