SC_mod_user_task_index Class Reference

Inheritance diagram for SC_mod_user_task_index:

Collaboration diagram for SC_mod_user_task_index:

List of all members.

Public Member Functions
	__construct ()
	menuConfig ()
	main ()
	printContent ()
	description ($title, $description='')
	renderListMenu ($items, $mainMenu=FALSE)
	urlInIframe ($url, $max=0)
Protected Member Functions
	renderModuleContent ()
	renderInformationContent ()
	indexAction ()
	getButtons ()
	checkAccess ($extKey, $taskClass)
	getUniqueKey ($string)
	openInNewWindow ()
Protected Attributes
	$pageinfo

---

Detailed Description

Definition at line 45 of file index.php.

---

Constructor & Destructor Documentation

SC_mod_user_task_index::__construct

(

)

Initializes the Module

Returns:

void

Definition at line 54 of file index.php.

References $GLOBALS, t3lib_extMgm\extPath(), t3lib_SCbase\init(), t3lib_div\makeInstance(), and t3lib_extMgm\siteRelPath().

---

Member Function Documentation

SC_mod_user_task_index::checkAccess	(	$	extKey,
		$	taskClass
	)		[protected]

Check the access to a task. Considered are:

• Admins are always allowed
• Tasks can be restriced to admins only
• Tasks can be blinded for Users with TsConfig taskcenter.<extensionkey>.<taskName> = 0

Parameters:

string	$extKey,:	Extension key
string	$taskClass,:	Name of the task

Returns:

boolean Access to the task allowed or not

Definition at line 445 of file index.php.

References $GLOBALS.

Referenced by indexAction(), and renderModuleContent().

SC_mod_user_task_index::description	(	$	title,
		$	description = ''
	)

Render the headline of a task including a title and an optional description.

Parameters:

string	$title,:	Title
string	$description,:	Description

Returns:

string formatted title and description

Definition at line 238 of file index.php.

References t3lib_SCbase\$content.

Referenced by renderInformationContent().

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

References $GLOBALS, t3lib_BEfunc\cshItem(), and openInNewWindow().

Referenced by main().

SC_mod_user_task_index::getUniqueKey

(

$

string

)

[protected]

Create a unique key from a string which can be used in Prototype's Sortable Therefore '_' are replaced

Parameters:

string

$string,:

string which is used to generate the identifier

Returns:

string modified string

Definition at line 497 of file index.php.

Referenced by indexAction(), and renderListMenu().

SC_mod_user_task_index::indexAction

(

)

[protected]

Shows an overview list of available reports.

Returns:

string list of available reports

Definition at line 359 of file index.php.

References t3lib_SCbase\$content, $GLOBALS, checkAccess(), t3lib_extMgm\extRelPath(), getUniqueKey(), t3lib_message_AbstractMessage\INFO, t3lib_div\makeInstance(), and renderListMenu().

Referenced by renderModuleContent().

SC_mod_user_task_index::main

(

)

Creates the module's content. In this case it rather acts as a kind of # dispatcher redirecting requests to specific tasks.

Returns:

void

Definition at line 90 of file index.php.

References $GLOBALS, getButtons(), t3lib_BEfunc\getFuncMenu(), renderInformationContent(), and renderModuleContent().

SC_mod_user_task_index::menuConfig

(

)

Adds items to the ->MOD_MENU array. Used for the function menu selector.

Returns:

void

Reimplemented from t3lib_SCbase.

Definition at line 75 of file index.php.

References $GLOBALS.

SC_mod_user_task_index::openInNewWindow

(

)

[protected]

This method prepares the link for opening the devlog in a new window

Returns:

string Hyperlink with icon and appropriate JavaScript

Definition at line 509 of file index.php.

References t3lib_SCbase\$content, $GLOBALS, t3lib_div\getIndpEnv(), and t3lib_iconWorks\skinImg().

Referenced by getButtons().

SC_mod_user_task_index::printContent

(

)

Prints out the module's HTML

Returns:

void

Definition at line 140 of file index.php.

SC_mod_user_task_index::renderInformationContent

(

)

[protected]

Generates the information content

Returns:

void

Definition at line 213 of file index.php.

References t3lib_SCbase\$content, $GLOBALS, and description().

Referenced by main().

SC_mod_user_task_index::renderListMenu	(	$	items,
		$	mainMenu = FALSE
	)

Render a list of items as a nicely formated definition list including a link, icon, title and description. The keys of a single item are:

• title: Title of the item
• link: Link to the task
• icon: Path to the icon or Icon as HTML if it begins with <img
• description: Description of the task, using htmlspecialchars()
• descriptionHtml: Description allowing HTML tags which will override the description

Parameters:

array	$items,:	List of items to be displayed in the definition list.
boolean	$mainMenu,:	Set it to TRUE to render the main menu

Returns:

string definition list

Definition at line 262 of file index.php.

References t3lib_SCbase\$content, $GLOBALS, t3lib_SCbase\$id, $items, t3lib_extMgm\extRelPath(), getUniqueKey(), and t3lib_iconWorks\skinImg().

Referenced by indexAction().

SC_mod_user_task_index::renderModuleContent

(

)

[protected]

Generates the module content by calling the selected task

Returns:

void

Definition at line 149 of file index.php.

References t3lib_SCbase\$content, $GLOBALS, checkAccess(), t3lib_message_AbstractMessage\ERROR, indexAction(), t3lib_message_AbstractMessage\INFO, and t3lib_div\makeInstance().

Referenced by main().

SC_mod_user_task_index::urlInIframe	(	$	url,
		$	max = 0
	)

Returns HTML code to dislay an url in an iframe at the right side of the taskcenter

Parameters:

string	$url,:	url to display
int	$max,:

Returns:

string code that inserts the iframe (HTML)

Definition at line 472 of file index.php.

---

Member Data Documentation

SC_mod_user_task_index::$pageinfo [protected]

Definition at line 47 of file index.php.

---

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

• typo3/sysext/taskcenter/task/index.php