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 ()
 execute ()
 init ()
 main ()
 printContent ()
 moduleContent_publish ()
 displayVersionDetails ($details)
 displayWorkspaceOverview ()
 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)

Public Attributes

 $MCONF = array()
 $MOD_MENU = array()
 $MOD_SETTINGS = array()
 $doc
 $content
 $publishAccess = FALSE
 $be_user_Array = array()
 $be_user_Array_full = array()

Protected Member Functions

 getButtons ()

Detailed Description

Definition at line 100 of file index.php.


Member Function Documentation

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

References $GLOBALS, and t3lib_div::makeInstance().

Referenced by moduleContent_publish().

SC_mod_user_ws_index::execute (  ) 

Executes action for selected elements, if any is sent:

Definition at line 178 of file index.php.

References $GLOBALS, t3lib_div::_POST(), t3lib_BEfunc::getLiveVersionOfRecord(), t3lib_div::makeInstance(), and t3lib_div::testInt().

SC_mod_user_ws_index::getButtons (  )  [protected]

Create the panel of buttons for submitting the form or otherwise perform operations.

Returns:
array all available buttons as an assoc. array

Definition at line 367 of file index.php.

References $BACK_PATH, $GLOBALS, and t3lib_iconWorks::skinImg().

Referenced by main().

SC_mod_user_ws_index::init (  ) 

Standard init function of a module.

Returns:
void

Reimplemented from t3lib_SCbase.

Definition at line 246 of file index.php.

References $BACK_PATH, $GLOBALS, t3lib_div::makeInstance(), and t3lib_iconWorks::skinImg().

SC_mod_user_ws_index::main (  ) 

Main function for Workspace Manager module.

Returns:
void

Definition at line 301 of file index.php.

References $BACK_PATH, $content, $GLOBALS, t3lib_div::_GET(), t3lib_BEfunc::blindUserNames(), getButtons(), t3lib_BEfunc::getListGroupNames(), t3lib_BEfunc::getUserNames(), moduleContent_publish(), and moduleContent_workspaceList().

SC_mod_user_ws_index::menuConfig (  ) 

Initialize menu configuration

Returns:
void

Reimplemented from t3lib_SCbase.

Definition at line 133 of file index.php.

References $GLOBALS, 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 406 of file index.php.

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

Referenced by main().

SC_mod_user_ws_index::moduleContent_workspaceList (  ) 

Rendering of the workspace list

Returns:
string HTML

Definition at line 568 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 358 of file index.php.

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

References $BACK_PATH, $content, t3lib_iconWorks::skinImg(), and workspaceList_hasEditAccess().

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

References $BACK_PATH, $content, $GLOBALS, nbsp, 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 833 of file index.php.

References nbsp.

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

References $content, $GLOBALS, t3lib_BEfunc::datetime(), nbsp, 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 780 of file index.php.

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

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

References $content, workspaceList_getUserListForSysWorkspace(), and workspaceList_getUserListWithAccess().

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

References $GLOBALS, and t3lib_iconWorks::getIconImage().

Referenced by workspaceList_getUserList().

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

References $content, $GLOBALS, t3lib_SCbase::$id, t3lib_BEfunc::getGroupNames(), t3lib_iconWorks::getIconImage(), and nbsp.

Referenced by workspaceList_getUserList().

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

References $GLOBALS, t3lib_BEfunc::deleteClause(), 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 731 of file index.php.

References $GLOBALS, 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 1028 of file index.php.

Referenced by workspaceList_displayIcons().


Member Data Documentation

SC_mod_user_ws_index::$be_user_Array = array()

Definition at line 118 of file index.php.

SC_mod_user_ws_index::$be_user_Array_full = array()

Definition at line 119 of file index.php.

SC_mod_user_ws_index::$content

Generally used for accumulating the output content of backend modules

Reimplemented from t3lib_SCbase.

Definition at line 113 of file index.php.

Referenced by main(), moduleContent_publish(), workspaceList_displayIcons(), workspaceList_displayUserWorkspaceList(), workspaceList_formatWorkspaceData(), workspaceList_getUserList(), and workspaceList_getUserListWithAccess().

SC_mod_user_ws_index::$doc

Reimplemented from t3lib_SCbase.

Definition at line 112 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 103 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 104 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 105 of file index.php.

SC_mod_user_ws_index::$publishAccess = FALSE

Definition at line 117 of file index.php.


The documentation for this class was generated from the following file:
Generated on Sat Nov 29 04:23:33 2008 for TYPO3 API by  doxygen 1.4.7