"TYPO3 4.0.1: SC_mod_user_ws_workspaceForms Class Reference", "datetime" => "Sat Dec 2 19:25:34 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_workspaceForms Class Reference

Inheritance diagram for SC_mod_user_ws_workspaceForms:

[legend]Collaboration diagram for SC_mod_user_ws_workspaceForms:

[legend]List of all members.


Public Member Functions
	init ()
	main ()
	printContent ()
	initTCEForms ()
	getModuleParameters ()
	getTitle ()
	buildForm ()
	buildEditForm ()
	buildNewForm ()
	createButtons ()
	getOwnerUser ($uid)
	processData ()
	fixVariousTCAFields ()
	fixTCAUserField ($fieldName)
	checkWorkspaceAccess ()
Public Attributes
	$MCONF = array()
	$MOD_MENU = array()
	$MOD_SETTINGS = array()
	$doc
	$content
	$isEditAction = false
	$workspaceId
	$tceforms

Detailed Description

Definition at line 93 of file workspaceforms.php.

Member Function Documentation

SC_mod_user_ws_workspaceForms::buildEditForm ( )

Creates a form for editing workspace. Parts were adopted from alt_doc.php.

Returns:
string Generated form

Definition at line 330 of file workspaceforms.php.
References $content, createButtons(), fixTCAUserField(), fixVariousTCAFields(), and t3lib_div::makeInstance().
Referenced by buildForm().

SC_mod_user_ws_workspaceForms::buildForm ( )

Creates form for workspace. This function is a wrapper around buildEditForm() and buildNewForm().

Returns:
string Generated form

Definition at line 321 of file workspaceforms.php.
References buildEditForm(), and buildNewForm().
Referenced by main().

SC_mod_user_ws_workspaceForms::buildNewForm ( )

Creates a form for new workspace. Parts are adopted from alt_doc.php.

Returns:
string Generated form

Definition at line 394 of file workspaceforms.php.
References $content, createButtons(), fixTCAUserField(), fixVariousTCAFields(), getOwnerUser(), and t3lib_div::makeInstance().
Referenced by buildForm().

SC_mod_user_ws_workspaceForms::checkWorkspaceAccess ( )

Checks if use has editing access to the workspace.

Returns:
boolean Returns true if user can edit workspace

Definition at line 588 of file workspaceforms.php.
References t3lib_BEfunc::deleteClause().
Referenced by main().

SC_mod_user_ws_workspaceForms::createButtons ( )

Creates standard buttons for form. Adopted from alt_doc.php.

Returns:
string Generated buttons code

Definition at line 453 of file workspaceforms.php.
References $content, and t3lib_iconWorks::skinImg().
Referenced by buildEditForm(), and buildNewForm().

SC_mod_user_ws_workspaceForms::fixTCAUserField ( $ fieldName )

"Fixes" $TCA to enable blinding for users/groups for non-admin users only.

Parameters:

string $fieldName Name of the field to change

Returns:
void

Definition at line 561 of file workspaceforms.php.
References t3lib_div::loadTCA().
Referenced by buildEditForm(), and buildNewForm().

SC_mod_user_ws_workspaceForms::fixVariousTCAFields ( )

Fixes various $TCA fields for better visual representation of workspace editor.

Returns:
void

Definition at line 549 of file workspaceforms.php.
Referenced by buildEditForm(), and buildNewForm().

SC_mod_user_ws_workspaceForms::getModuleParameters ( )

Retrieves module parameters from the t3lib_div::_GP. The following arguments are retrieved:

action

workspace id (if action == 'edit')

Returns:
void

Definition at line 284 of file workspaceforms.php.
References t3lib_div::_GP().
Referenced by main().

SC_mod_user_ws_workspaceForms::getOwnerUser ( $ uid )

Returns owner user (i.e. current BE user) in the format suitable for TCE forms. This function uses t3lib_loadDBGroup to create value. Code is adopted from t3lib_transferdata::renderRecord_groupProc().

Parameters:

string $uid UID of the record (as NEW...)

Returns:
string User record formatted for TCEForms

Definition at line 479 of file workspaceforms.php.
References t3lib_div::loadTCA(), and t3lib_div::makeInstance().
Referenced by buildNewForm().

SC_mod_user_ws_workspaceForms::getTitle ( )

Retrieves a title of the module according to action.

Returns:
string A title for the module

Definition at line 302 of file workspaceforms.php.
Referenced by main().

SC_mod_user_ws_workspaceForms::init ( )

Initializes the module. See t3lib_SCbase::init() for more information.

Returns:
void

Reimplemented from t3lib_SCbase.
Definition at line 123 of file workspaceforms.php.
References t3lib_SCbase::init(), and t3lib_div::makeInstance().

SC_mod_user_ws_workspaceForms::initTCEForms ( )

Initializes t3lib_TCEform class for use in this module.

Returns:
void

Definition at line 257 of file workspaceforms.php.
References t3lib_div::inList(), and t3lib_div::makeInstance().
Referenced by main().

SC_mod_user_ws_workspaceForms::main ( )

Creates module content.

Returns:
void

Definition at line 158 of file workspaceforms.php.
References t3lib_div::_GP(), buildForm(), checkWorkspaceAccess(), getModuleParameters(), getTitle(), initTCEForms(), t3lib_div::locationHeaderUrl(), processData(), and t3lib_iconWorks::skinImg().

SC_mod_user_ws_workspaceForms::printContent ( )

Outputs module content to the browser.

Returns:
void

Definition at line 233 of file workspaceforms.php.

SC_mod_user_ws_workspaceForms::processData ( )

Processes submitted data. This function uses t3lib_TCEmain::process_datamap() to create/update records in the sys_workspace table. It will print error messages just like any other Typo3 module with similar functionality. Function also changes workspace ID and module mode to 'edit' if new record was just created.

Returns:
void

Definition at line 505 of file workspaceforms.php.
References t3lib_div::_GP(), t3lib_div::getIndpEnv(), and t3lib_div::makeInstance().
Referenced by main().

Member Data Documentation

SC_mod_user_ws_workspaceForms::$content

Generally used for accumulating the output content of backend modules
Reimplemented from t3lib_SCbase.
Definition at line 100 of file workspaceforms.php.
Referenced by buildEditForm(), buildNewForm(), and createButtons().

SC_mod_user_ws_workspaceForms::$doc

Generally used to hold an instance of the 'template' class from typo3/template.php
Reimplemented from t3lib_SCbase.
Definition at line 99 of file workspaceforms.php.

SC_mod_user_ws_workspaceForms::$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 96 of file workspaceforms.php.

SC_mod_user_ws_workspaceForms::$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 97 of file workspaceforms.php.

SC_mod_user_ws_workspaceForms::$MOD_SETTINGS = array()

Current settings for the keys of the MOD_MENU array
See also:
$MOD_MENU

Reimplemented from t3lib_SCbase.
Definition at line 98 of file workspaceforms.php.

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

typo3_src-4.0.1/typo3/mod/user/ws/workspaceforms.php

SC_mod_user_ws_workspaceForms Class Reference

Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

Member Data Documentation