TYPO3\CMS\Taskcenter\Controller\TaskModuleController Class Reference

Inheritance diagram for TYPO3\CMS\Taskcenter\Controller\TaskModuleController:

Public Member Functions
	__construct ()
	menuConfig ()
	main ()
	printContent ()
	description ($title, $description='')
	renderListMenu ($items, $mainMenu=FALSE)
	urlInIframe ($url, $max=0)
Public Member Functions inherited from TYPO3\CMS\Backend\Module\BaseScriptClass
	init ()
	menuConfig ()
	mergeExternalItems ($modName, $menuKey, $menuArr)
	handleExternalFunctionValue ($MM_key='function', $MS_value=NULL)
	getExternalItemConfig ($modName, $menuKey, $value='')
	checkExtObj ()
	checkSubExtObj ()
	extObjHeader ()
	extObjContent ()

Protected Member Functions
	renderModuleContent ()
	renderInformationContent ()
	indexAction ()
	getButtons ()
	checkAccess ($extKey, $taskClass)
	getUniqueKey ($string)
	openInNewWindow ()
Protected Member Functions inherited from TYPO3\CMS\Backend\Module\BaseScriptClass
	getLanguageService ()
	getBackendUser ()

Protected Attributes
	$pageinfo

Additional Inherited Members
Public Attributes inherited from TYPO3\CMS\Backend\Module\BaseScriptClass
	$MCONF = array()
	$id
	$CMD
	$perms_clause
	$MOD_MENU
	$MOD_SETTINGS = array()
	$modTSconfig
	$modMenu_type = ''
	$modMenu_dontValidateList = ''
	$modMenu_setDefaultList = ''
	$extClassConf
	$include_once = array()
	$content = ''
	$doc
	$extObj

Detailed Description

This class provides a taskcenter for BE users

Author

Georg Ringer typo3.nosp@m.@rin.nosp@m.gerge.nosp@m..org

Definition at line 25 of file TaskModuleController.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Taskcenter\Controller\TaskModuleController::__construct

(

)

Initializes the Module

Returns

void

Definition at line 34 of file TaskModuleController.php.

References $GLOBALS, and TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

Member Function Documentation

checkAccess()

TYPO3\CMS\Taskcenter\Controller\TaskModuleController::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 334 of file TaskModuleController.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Taskcenter\Controller\TaskModuleController\indexAction(), and TYPO3\CMS\Taskcenter\Controller\TaskModuleController\renderModuleContent().

description()

TYPO3\CMS\Taskcenter\Controller\TaskModuleController::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 157 of file TaskModuleController.php.

References TYPO3\CMS\Backend\Module\BaseScriptClass\$content.

Referenced by TYPO3\CMS\Taskcenter\Controller\TaskModuleController\renderInformationContent().

getButtons()

TYPO3\CMS\Taskcenter\Controller\TaskModuleController::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 311 of file TaskModuleController.php.

References $GLOBALS, TYPO3\CMS\Backend\Utility\BackendUtility\cshItem(), and TYPO3\CMS\Taskcenter\Controller\TaskModuleController\openInNewWindow().

Referenced by TYPO3\CMS\Taskcenter\Controller\TaskModuleController\main().

getUniqueKey()

TYPO3\CMS\Taskcenter\Controller\TaskModuleController::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 377 of file TaskModuleController.php.

Referenced by TYPO3\CMS\Taskcenter\Controller\TaskModuleController\indexAction(), and TYPO3\CMS\Taskcenter\Controller\TaskModuleController\renderListMenu().

indexAction()

TYPO3\CMS\Taskcenter\Controller\TaskModuleController::indexAction ( )

protected

Shows an overview list of available reports.

Returns

string List of available reports

Definition at line 261 of file TaskModuleController.php.

References TYPO3\CMS\Backend\Module\BaseScriptClass\$content, $GLOBALS, TYPO3\CMS\Taskcenter\Controller\TaskModuleController\checkAccess(), TYPO3\CMS\Core\Utility\ExtensionManagementUtility\extRelPath(), TYPO3\CMS\Backend\Utility\BackendUtility\getModuleUrl(), TYPO3\CMS\Taskcenter\Controller\TaskModuleController\getUniqueKey(), TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance(), and TYPO3\CMS\Taskcenter\Controller\TaskModuleController\renderListMenu().

Referenced by TYPO3\CMS\Taskcenter\Controller\TaskModuleController\renderModuleContent().

main()

TYPO3\CMS\Taskcenter\Controller\TaskModuleController::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 64 of file TaskModuleController.php.

References TYPO3\CMS\Backend\Module\BaseScriptClass\$content, $GLOBALS, TYPO3\CMS\Taskcenter\Controller\TaskModuleController\getButtons(), TYPO3\CMS\Backend\Utility\BackendUtility\getFuncMenu(), TYPO3\CMS\Taskcenter\Controller\TaskModuleController\renderInformationContent(), and TYPO3\CMS\Taskcenter\Controller\TaskModuleController\renderModuleContent().

menuConfig()

TYPO3\CMS\Taskcenter\Controller\TaskModuleController::menuConfig

(

)

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

Returns

void

Definition at line 51 of file TaskModuleController.php.

References $GLOBALS.

openInNewWindow()

TYPO3\CMS\Taskcenter\Controller\TaskModuleController::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 388 of file TaskModuleController.php.

References TYPO3\CMS\Backend\Module\BaseScriptClass\$content, $GLOBALS, TYPO3\CMS\Core\Utility\GeneralUtility\getIndpEnv(), and TYPO3\CMS\Backend\Utility\IconUtility\skinImg().

Referenced by TYPO3\CMS\Taskcenter\Controller\TaskModuleController\getButtons().

printContent()

TYPO3\CMS\Taskcenter\Controller\TaskModuleController::printContent

(

)

Prints out the module's HTML

Returns

void

Definition at line 90 of file TaskModuleController.php.

References TYPO3\CMS\Backend\Module\BaseScriptClass\$content.

renderInformationContent()

TYPO3\CMS\Taskcenter\Controller\TaskModuleController::renderInformationContent ( )

protected

Generates the information content

Returns

void

Definition at line 141 of file TaskModuleController.php.

References TYPO3\CMS\Backend\Module\BaseScriptClass\$content, $GLOBALS, and TYPO3\CMS\Taskcenter\Controller\TaskModuleController\description().

Referenced by TYPO3\CMS\Taskcenter\Controller\TaskModuleController\main().

renderListMenu()

TYPO3\CMS\Taskcenter\Controller\TaskModuleController::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 Fefinition list

Definition at line 180 of file TaskModuleController.php.

References TYPO3\CMS\Backend\Module\BaseScriptClass\$content, $GLOBALS, TYPO3\CMS\Backend\Module\BaseScriptClass\$id, TYPO3\CMS\Taskcenter\Controller\TaskModuleController\getUniqueKey(), and TYPO3\CMS\Backend\Utility\IconUtility\skinImg().

Referenced by TYPO3\CMS\Taskcenter\Controller\TaskModuleController\indexAction().

renderModuleContent()

TYPO3\CMS\Taskcenter\Controller\TaskModuleController::renderModuleContent ( )

protected

Generates the module content by calling the selected task

Returns

void

Definition at line 99 of file TaskModuleController.php.

References TYPO3\CMS\Backend\Module\BaseScriptClass\$content, $GLOBALS, TYPO3\CMS\Taskcenter\Controller\TaskModuleController\checkAccess(), TYPO3\CMS\Taskcenter\Controller\TaskModuleController\indexAction(), and TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

Referenced by TYPO3\CMS\Taskcenter\Controller\TaskModuleController\main().

urlInIframe()

TYPO3\CMS\Taskcenter\Controller\TaskModuleController::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
integer	$max

Returns

string Code that inserts the iframe (HTML)

Definition at line 358 of file TaskModuleController.php.

Member Data Documentation

$pageinfo

TYPO3\CMS\Taskcenter\Controller\TaskModuleController::$pageinfo

protected

Definition at line 27 of file TaskModuleController.php.