Solutions Open Source

Référence de la classe SC_mod_user_ws_index

Graphe d'héritage de SC_mod_user_ws_index:

Inheritance graph
[légende]
Graphe de collaboration de SC_mod_user_ws_index:

Collaboration graph
[légende]

Liste de tous les membres

Fonctions membres publiques

 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)

Attributs publics

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

Documentation des fonctions membres

SC_mod_user_ws_index::menuConfig (  ) 

Initialize menu configuration

Renvoie:
void

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

SC_mod_user_ws_index::init (  ) 

Standard init function of a module.

Renvoie:
void

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

SC_mod_user_ws_index::main (  ) 

Main function for Workspace Manager module.

Renvoie:
void

SC_mod_user_ws_index::printContent (  ) 

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

Renvoie:
void

SC_mod_user_ws_index::moduleContent_publish (  ) 

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

Renvoie:
string HTML content

SC_mod_user_ws_index::displayVersionDetails ( $  details  ) 

Display details for a single version from workspace

Paramètres:
string Version identification, made of table and uid
Renvoie:
string HTML string

SC_mod_user_ws_index::displayWorkspaceOverview (  ) 

Rendering the overview of versions in the current workspace

Renvoie:
string HTML (table)

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)

Paramètres:
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)
Renvoie:
array Table rows, see displayWorkspaceOverview()

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

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

Paramètres:
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
Renvoie:
string HTML content

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

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

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

Links to publishing etc of a version

Paramètres:
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.
Renvoie:
string HTML content, mainly link tags and images.

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

Paramètres:
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
Renvoie:
void $pArray is passed by reference and modified internally

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)

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.

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

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:

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

SC_mod_user_ws_index::markupNewOriginals (  ) 

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

Renvoie:
string HTML javascript section

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

SC_mod_user_ws_index::moduleContent_workspaceList (  ) 

Rendering of the workspace list

Renvoie:
string HTML

SC_mod_user_ws_index::workspaceList_displayUserWorkspaceList (  ) 

Generates HTML to display a list of workspaces.

Renvoie:
string Generated HTML code

SC_mod_user_ws_index::workspaceList_getUserWorkspaceList (  ) 

Retrieves a list of workspaces where user has access.

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

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.

Paramètres:
array Workspace information
Renvoie:
string Formatted workspace information

SC_mod_user_ws_index::workspaceList_getWebMountPoints ( &$  wksp  ) 

Retrieves and formats database mount points lists.

Paramètres:
array &$wksp Workspace record
Renvoie:
string Generated HTML

SC_mod_user_ws_index::workspaceList_getFileMountPoints ( &$  wksp  ) 

Retrieves and formats file mount points lists.

Paramètres:
array &$wksp Workspace record
Renvoie:
string Generated HTML

SC_mod_user_ws_index::workspaceList_displayUserWorkspaceListHeader (  ) 

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

Renvoie:
string Generated content

SC_mod_user_ws_index::workspaceList_getUserList ( &$  wksp  ) 

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

Paramètres:
array Workspace record
Renvoie:
string Generated content

SC_mod_user_ws_index::workspaceList_getUserListForSysWorkspace ( &$  wksp  ) 

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

Paramètres:
array &$wksp Workspace record
Renvoie:
string Generated content

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

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

Paramètres:
array A list of user IDs separated by comma
string Access string
Renvoie:
string Generated content

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

Creates a list of icons for workspace.

Paramètres:
boolean true if current workspace
array Workspace record
Renvoie:
string Generated content

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.

Paramètres:
array Workspace record
Renvoie:
boolean true if user can modify workspace parameters

SC_mod_user_ws_index::workspaceList_createFakeWorkspaceRecord ( $  uid  ) 

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

Paramètres:
integer System workspace ID. Currently 0 and -1 are accepted.
Renvoie:
array Generated record (see sys_workspaces for structure)

SC_mod_user_ws_index::formatVerId ( $  verId  ) 

Formatting the version number for HTML output

Paramètres:
integer Version number
Renvoie:
string Version number for output

SC_mod_user_ws_index::formatWorkspace ( $  wsid  ) 

Formatting workspace ID into a visual label

Paramètres:
integer Workspace ID
Renvoie:
string Workspace title

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

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

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

Documentation des données membres

SC_mod_user_ws_index::$pageTreeIndent = 8

SC_mod_user_ws_index::$pageTreeIndent_titleLgd = 30

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.

Voir également:
init()

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

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.

Voir également:
init()

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

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

SC_mod_user_ws_index::$doc

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

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

SC_mod_user_ws_index::$content

Generally used for accumulating the output content of backend modules

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

SC_mod_user_ws_index::$showWorkspaceCol = 0

SC_mod_user_ws_index::$formatWorkspace_cache = array()

SC_mod_user_ws_index::$formatCount_cache = array()

SC_mod_user_ws_index::$targets = array()

SC_mod_user_ws_index::$pageModule = ''

SC_mod_user_ws_index::$publishAccess = FALSE

SC_mod_user_ws_index::$be_user_Array = array()

SC_mod_user_ws_index::$be_user_Array_full = array()

SC_mod_user_ws_index::$stageIndex = array()

La documentation de cette classe a été générée à partir du fichier suivant :
Généré le Fri Aug 31 11:41:41 2007 pour OBLADY - Typo3 API v4.1.2 par  doxygen 1.5.3