SC_mod_user_ws_index Klassenreferenz
Aufstellung aller Elemente
Dokumentation der Elementfunktionen
| t3lib_SCbase::checkExtObj |
( |
|
) |
[inherited] |
Creates an instance of the class found in $this->extClassConf['name'] in $this->extObj if any (this should hold three keys, "name", "path" and "title" if a "Function menu module" tries to connect...) This value in extClassConf might be set by an extension (in a ext_tables/ext_localconf file) which thus "connects" to a module. The array $this->extClassConf is set in handleExternalFunctionValue() based on the value of MOD_SETTINGS[function] (Should be) called from global scope right after inclusion of files from the ->include_once array. If an instance is created it is initiated with $this passed as value and $this->extClassConf as second argument. Further the $this->MOD_SETTING is cleaned up again after calling the init function.
- Rückgabe:
- void
- Siehe auch:
- handleExternalFunctionValue(), t3lib_extMgm::insertModuleFunction(), $extObj
| t3lib_SCbase::checkSubExtObj |
( |
|
) |
[inherited] |
Calls the checkExtObj function in sub module if present.
- Rückgabe:
- void
| SC_mod_user_ws_index::displayVersionDetails |
( |
$ |
details |
) |
|
Display details for a single version from workspace
- Parameter:
-
| string | Version identification, made of table and uid |
- Rückgabe:
- string HTML string
| SC_mod_user_ws_index::displayWorkspaceOverview |
( |
|
) |
|
Rendering the overview of versions in the current workspace
- Rückgabe:
- string HTML (table)
| SC_mod_user_ws_index::execute |
( |
|
) |
|
Executes action for selected elements, if any is sent:
| t3lib_SCbase::extObjContent |
( |
|
) |
[inherited] |
Calls the 'main' function inside the "Function menu module" if present
- Rückgabe:
- void
| t3lib_SCbase::extObjHeader |
( |
|
) |
[inherited] |
Calls the 'header' function inside the "Function menu module" if present. A header function might be needed to add JavaScript or other stuff in the head. This can't be done in the main function because the head is already written. example call in the header function: $this->pObj->doc->JScode = $this->pObj->doc->wrapScriptTags(' ...
- Rückgabe:
- void
| SC_mod_user_ws_index::getButtons |
( |
|
) |
[protected] |
Create the panel of buttons for submitting the form or otherwise perform operations.
- Rückgabe:
- array all available buttons as an assoc. array
| t3lib_SCbase::getExternalItemConfig |
( |
$ |
modName, |
|
|
$ |
menuKey, |
|
|
$ |
value = '' | |
|
) |
| | [inherited] |
Returns configuration values from the global variable $TBE_MODULES_EXT for the module given. For example if the module is named "web_info" and the "function" key ($menuKey) of MOD_SETTINGS is "stat" ($value) then you will have the values of $TBE_MODULES_EXT['webinfo']['MOD_MENU']['function']['stat'] returned.
- Parameter:
-
| string | Module name |
| string | Menu key, eg. "function" for the function menu. See $this->MOD_MENU |
| string | Optionally the value-key to fetch from the array that would otherwise have been returned if this value was not set. Look source... |
- Rückgabe:
- mixed The value from the TBE_MODULES_EXT array.
- Siehe auch:
- handleExternalFunctionValue()
| t3lib_SCbase::handleExternalFunctionValue |
( |
$ |
MM_key = 'function', |
|
|
$ |
MS_value = NULL | |
|
) |
| | [inherited] |
Loads $this->extClassConf with the configuration for the CURRENT function of the menu. If for this array the key 'path' is set then that is expected to be an absolute path to a file which should be included - so it is set in the internal array $this->include_once
- Parameter:
-
| string | The key to MOD_MENU for which to fetch configuration. 'function' is default since it is first and foremost used to get information per "extension object" (I think that is what its called) |
| string | The value-key to fetch from the config array. If NULL (default) MOD_SETTINGS[$MM_key] will be used. This is usefull if you want to force another function than the one defined in MOD_SETTINGS[function]. Call this in init() function of your Script Class: handleExternalFunctionValue('function', $forcedSubModKey) |
- Rückgabe:
- void
- Siehe auch:
- getExternalItemConfig(), $include_once, init()
Erneute Implementation in SC_mod_tools_em_index.
| SC_mod_user_ws_index::init |
( |
|
) |
|
Standard init function of a module.
- Rückgabe:
- void
Erneute Implementation von t3lib_SCbase.
| SC_mod_user_ws_index::main |
( |
|
) |
|
Main function for Workspace Manager module.
- Rückgabe:
- void
| SC_mod_user_ws_index::menuConfig |
( |
|
) |
|
Initialize menu configuration
- Rückgabe:
- void
Erneute Implementation von t3lib_SCbase.
| t3lib_SCbase::mergeExternalItems |
( |
$ |
modName, |
|
|
$ |
menuKey, |
|
|
$ |
menuArr | |
|
) |
| | [inherited] |
Merges menu items from global array $TBE_MODULES_EXT
- Parameter:
-
| string | Module name for which to find value |
| string | Menu key, eg. 'function' for the function menu. |
| array | The part of a MOD_MENU array to work on. |
- Rückgabe:
- array Modified array part. private
- Siehe auch:
- t3lib_extMgm::insertModuleFunction(), menuConfig()
| SC_mod_user_ws_index::moduleContent_publish |
( |
|
) |
|
Rendering the content for the publish and review panel in the workspace manager
- Rückgabe:
- string HTML content
| SC_mod_user_ws_index::moduleContent_workspaceList |
( |
|
) |
|
Rendering of the workspace list
- Rückgabe:
- string HTML
| SC_mod_user_ws_index::printContent |
( |
|
) |
|
Print module content. Called as last thing in the global scope.
- Rückgabe:
- void
| SC_mod_user_ws_index::workspaceList_createFakeWorkspaceRecord |
( |
$ |
uid |
) |
|
Creates a fake workspace record for system workspaces. Record contains all fields found in sys_workspaces.
- Parameter:
-
| integer | System workspace ID. Currently 0 and -1 are accepted. |
- Rückgabe:
- array Generated record (see
sys_workspaces for structure)
| SC_mod_user_ws_index::workspaceList_displayIcons |
( |
$ |
currentWorkspace, |
|
|
&$ |
wksp | |
|
) |
| | |
Creates a list of icons for workspace.
- Parameter:
-
| boolean | true if current workspace |
| array | Workspace record |
- Rückgabe:
- string Generated content
| SC_mod_user_ws_index::workspaceList_displayUserWorkspaceList |
( |
|
) |
|
Generates HTML to display a list of workspaces.
- Rückgabe:
- string Generated HTML code
| SC_mod_user_ws_index::workspaceList_displayUserWorkspaceListHeader |
( |
|
) |
|
| 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.
- Parameter:
-
| array | Workspace information |
- Rückgabe:
- string Formatted workspace information
| SC_mod_user_ws_index::workspaceList_getFileMountPoints |
( |
&$ |
wksp |
) |
|
Retrieves and formats file mount points lists.
- Parameter:
-
| array | &$wksp Workspace record |
- Rückgabe:
- string Generated HTML
| SC_mod_user_ws_index::workspaceList_getUserList |
( |
&$ |
wksp |
) |
|
Generates a list of <option> tags with user names.
- Parameter:
-
- Rückgabe:
- string Generated content
| SC_mod_user_ws_index::workspaceList_getUserListForSysWorkspace |
( |
&$ |
wksp |
) |
|
Generates a list of user names that has access to the system workspace.
- Parameter:
-
| array | &$wksp Workspace record |
- Rückgabe:
- string Generated content
| SC_mod_user_ws_index::workspaceList_getUserListWithAccess |
( |
&$ |
list, |
|
|
$ |
access | |
|
) |
| | |
Generates a list of user names that has access to the workspace.
- Parameter:
-
| array | A list of user IDs separated by comma |
| string | Access string |
- Rückgabe:
- string Generated content
| SC_mod_user_ws_index::workspaceList_getUserWorkspaceList |
( |
|
) |
|
Retrieves a list of workspaces where user has access.
- Rückgabe:
- array A list of workspaces available to the current BE user
| SC_mod_user_ws_index::workspaceList_getWebMountPoints |
( |
&$ |
wksp |
) |
|
Retrieves and formats database mount points lists.
- Parameter:
-
| array | &$wksp Workspace record |
- Rückgabe:
- string Generated HTML
| 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.
- Parameter:
-
- Rückgabe:
- boolean
true if user can modify workspace parameters
Dokumentation der Datenelemente
t3lib_SCbase::$CMD [inherited] |
| SC_mod_user_ws_index::$content |
Generally used for accumulating the output content of backend modules
Erneute Implementation von t3lib_SCbase.
t3lib_SCbase::$extClassConf [inherited] |
t3lib_SCbase::$extObj [inherited] |
May contain an instance of a 'Function menu module' which connects to this backend module.
- Siehe auch:
- checkExtObj()
t3lib_SCbase::$id [inherited] |
The integer value of the GET/POST var, 'id'. Used for submodules to the 'Web' module (page id)
- Siehe auch:
- init()
t3lib_SCbase::$include_once = array() [inherited] |
Contains absolute paths to class files to include from the global scope. This is done in the module index.php files after calling the init() function
- Siehe auch:
- handleExternalFunctionValue()
| 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.
- Siehe auch:
- init()
Erneute Implementation von 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.
- Siehe auch:
- init()
Erneute Implementation von t3lib_SCbase.
| SC_mod_user_ws_index::$MOD_SETTINGS = array() |
Current settings for the keys of the MOD_MENU array
- Siehe auch:
- $MOD_MENU
Erneute Implementation von t3lib_SCbase.
t3lib_SCbase::$modMenu_dontValidateList = '' [inherited] |
dontValidateList can be used to list variables that should not be checked if their value is found in the MOD_MENU array. Used for dynamically generated menus. Can be set from extension classes of this class before the init() function is called.
- Siehe auch:
- menuConfig(), t3lib_BEfunc::getModuleData()
t3lib_SCbase::$modMenu_setDefaultList = '' [inherited] |
List of default values from $MOD_MENU to set in the output array (only if the values from MOD_MENU are not arrays) Can be set from extension classes of this class before the init() function is called.
- Siehe auch:
- menuConfig(), t3lib_BEfunc::getModuleData()
t3lib_SCbase::$modMenu_type = '' [inherited] |
If type is 'ses' then the data is stored as session-lasting data. This means that it'll be wiped out the next time the user logs in. Can be set from extension classes of this class before the init() function is called.
- Siehe auch:
- menuConfig(), t3lib_BEfunc::getModuleData()
t3lib_SCbase::$modTSconfig [inherited] |
Module TSconfig based on PAGE TSconfig / USER TSconfig
- Siehe auch:
- menuConfig()
t3lib_SCbase::$perms_clause [inherited] |
A WHERE clause for selection records from the pages table based on read-permissions of the current backend user.
- Siehe auch:
- init()
Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei:
- /srv/www/vhosts/typo3.local/typo3_src-4.2.10/typo3/mod/user/ws/index.php
1.6.1