TYPO3 CMS  TYPO3_7-6
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
TYPO3\CMS\Taskcenter\Controller\TaskModuleController Class Reference
Inheritance diagram for TYPO3\CMS\Taskcenter\Controller\TaskModuleController:
TYPO3\CMS\Backend\Module\BaseScriptClass

Public Member Functions

 __construct ()
 
 menuConfig ()
 
 mainAction (ServerRequestInterface $request, ResponseInterface $response)
 
 main ()
 
 printContent ()
 
 description ($title, $description='')
 
 renderListMenu ($items, $mainMenu=false)
 
 urlInIframe ($url)
 
 getModuleTemplate ()
 
- 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 ()
 

Protected Member Functions

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

Protected Attributes

 $pageinfo
 
 $moduleTemplate
 
 $moduleName = 'user_task'
 
- Protected Attributes inherited from TYPO3\CMS\Backend\Module\BaseScriptClass
 $pageRenderer = null
 

Additional Inherited Members

- Public Attributes inherited from TYPO3\CMS\Backend\Module\BaseScriptClass
 $MCONF = []
 
 $id
 
 $CMD
 
 $perms_clause
 
 $MOD_MENU
 
 $MOD_SETTINGS = []
 
 $modTSconfig
 
 $modMenu_type = ''
 
 $modMenu_dontValidateList = ''
 
 $modMenu_setDefaultList = ''
 
 $extClassConf
 
 $content = ''
 
 $doc
 
 $extObj
 

Detailed Description

This class provides a taskcenter for BE users

Definition at line 33 of file TaskModuleController.php.

Constructor & Destructor Documentation

◆ __construct()

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

Initializes the Module

Definition at line 57 of file TaskModuleController.php.

References TYPO3\CMS\Taskcenter\Controller\TaskModuleController\$moduleName, TYPO3\CMS\Core\Utility\ExtensionManagementUtility\extRelPath(), TYPO3\CMS\Taskcenter\Controller\TaskModuleController\getLanguageService(), 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$extKeyExtension key
string$taskClassName of the task
Returns
bool Access to the task allowed or not

Definition at line 461 of file TaskModuleController.php.

References $GLOBALS, and TYPO3\CMS\Taskcenter\Controller\TaskModuleController\getBackendUser().

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

◆ description()

TYPO3\CMS\Taskcenter\Controller\TaskModuleController::description (   $title,
  $description = '' 
)

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

Parameters
string$titleTitle
string$descriptionDescription
Returns
string formatted title and description

Definition at line 262 of file TaskModuleController.php.

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

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

◆ generateMenu()

TYPO3\CMS\Taskcenter\Controller\TaskModuleController::generateMenu ( )
protected

Generates the menu based on $this->MOD_MENU

Exceptions

Definition at line 94 of file TaskModuleController.php.

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

◆ getBackendUser()

TYPO3\CMS\Taskcenter\Controller\TaskModuleController::getBackendUser ( )
protected

Returns the current BE user.

Returns

Definition at line 524 of file TaskModuleController.php.

References $GLOBALS.

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

◆ getButtons()

TYPO3\CMS\Taskcenter\Controller\TaskModuleController::getButtons ( )
protected

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

Returns
void

Definition at line 429 of file TaskModuleController.php.

References TYPO3\CMS\Backend\Template\Components\ButtonBar\BUTTON_POSITION_RIGHT, TYPO3\CMS\Core\Utility\GeneralUtility\getIndpEnv(), TYPO3\CMS\Taskcenter\Controller\TaskModuleController\getLanguageService(), TYPO3\CMS\Core\Utility\GeneralUtility\quoteJSvalue(), and TYPO3\CMS\Core\Imaging\Icon\SIZE_SMALL.

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

◆ getLanguageService()

TYPO3\CMS\Taskcenter\Controller\TaskModuleController::getLanguageService ( )
protected

Returns LanguageService

Returns

Definition at line 534 of file TaskModuleController.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Taskcenter\Controller\TaskModuleController\__construct(), TYPO3\CMS\Taskcenter\Controller\TaskModuleController\getButtons(), TYPO3\CMS\Taskcenter\Controller\TaskModuleController\main(), TYPO3\CMS\Taskcenter\Controller\TaskModuleController\menuConfig(), TYPO3\CMS\Taskcenter\Controller\TaskModuleController\openInNewWindow(), TYPO3\CMS\Taskcenter\Controller\TaskModuleController\printContent(), TYPO3\CMS\Taskcenter\Controller\TaskModuleController\renderInformationContent(), and TYPO3\CMS\Taskcenter\Controller\TaskModuleController\renderListMenu().

◆ getModuleTemplate()

TYPO3\CMS\Taskcenter\Controller\TaskModuleController::getModuleTemplate ( )
Returns
ModuleTemplate

Definition at line 542 of file TaskModuleController.php.

References TYPO3\CMS\Taskcenter\Controller\TaskModuleController\$moduleTemplate.

◆ getUniqueKey()

TYPO3\CMS\Taskcenter\Controller\TaskModuleController::getUniqueKey (   $string)
protected

Create a unique key from a string which can be used in JS for sorting Therefore '_' are replaced

Parameters
string$stringstring which is used to generate the identifier
Returns
string Modified string

Definition at line 497 of file TaskModuleController.php.

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

◆ 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 146 of file TaskModuleController.php.

References TYPO3\CMS\Taskcenter\Controller\TaskModuleController\generateMenu(), TYPO3\CMS\Taskcenter\Controller\TaskModuleController\getButtons(), TYPO3\CMS\Taskcenter\Controller\TaskModuleController\getLanguageService(), and TYPO3\CMS\Taskcenter\Controller\TaskModuleController\renderInformationContent().

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

◆ mainAction()

TYPO3\CMS\Taskcenter\Controller\TaskModuleController::mainAction ( ServerRequestInterface  $request,
ResponseInterface  $response 
)

Injects the request object for the current request or subrequest Simply calls main() and writes the content to the response

Parameters
ServerRequestInterface$requestthe current request
ResponseInterface$response
Returns
ResponseInterface the response with the content

Definition at line 129 of file TaskModuleController.php.

References $GLOBALS, and TYPO3\CMS\Taskcenter\Controller\TaskModuleController\main().

◆ 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 73 of file TaskModuleController.php.

References TYPO3\CMS\Taskcenter\Controller\TaskModuleController\getLanguageService(), TYPO3\CMS\Backend\Utility\BackendUtility\getModTSconfig(), TYPO3\CMS\Backend\Module\BaseScriptClass\mergeExternalItems(), and TYPO3\CMS\Backend\Utility\BackendUtility\unsetMenuItems().

◆ 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 509 of file TaskModuleController.php.

References TYPO3\CMS\Backend\Module\BaseScriptClass\$content, TYPO3\CMS\Core\Utility\GeneralUtility\getIndpEnv(), TYPO3\CMS\Taskcenter\Controller\TaskModuleController\getLanguageService(), TYPO3\CMS\Core\Utility\GeneralUtility\quoteJSvalue(), and TYPO3\CMS\Core\Imaging\Icon\SIZE_SMALL.

◆ printContent()

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

Prints out the module's HTML

Returns
void

Definition at line 171 of file TaskModuleController.php.

References TYPO3\CMS\Backend\Module\BaseScriptClass\$content, TYPO3\CMS\Taskcenter\Controller\TaskModuleController\checkAccess(), TYPO3\CMS\Core\Messaging\AbstractMessage\ERROR, TYPO3\CMS\Taskcenter\Controller\TaskModuleController\getLanguageService(), TYPO3\CMS\Core\Messaging\AbstractMessage\INFO, and TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

◆ renderInformationContent()

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

Generates the information content

Returns
void

Definition at line 245 of file TaskModuleController.php.

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

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$itemsList of items to be displayed in the definition list.
bool$mainMenuSet it to TRUE to render the main menu
Returns
string Fefinition list

Definition at line 286 of file TaskModuleController.php.

References TYPO3\CMS\Backend\Module\BaseScriptClass\$content, $GLOBALS, TYPO3\CMS\Backend\Module\BaseScriptClass\$id, TYPO3\CMS\Taskcenter\Controller\TaskModuleController\checkAccess(), TYPO3\CMS\Core\Utility\ExtensionManagementUtility\extRelPath(), TYPO3\CMS\Core\Utility\PathUtility\getAbsoluteWebPath(), TYPO3\CMS\Taskcenter\Controller\TaskModuleController\getBackendUser(), TYPO3\CMS\Core\Utility\GeneralUtility\getFileAbsFileName(), TYPO3\CMS\Taskcenter\Controller\TaskModuleController\getLanguageService(), TYPO3\CMS\Backend\Module\BaseScriptClass\getPageRenderer(), TYPO3\CMS\Taskcenter\Controller\TaskModuleController\getUniqueKey(), TYPO3\CMS\Core\Messaging\AbstractMessage\INFO, and TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

◆ urlInIframe()

TYPO3\CMS\Taskcenter\Controller\TaskModuleController::urlInIframe (   $url)

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

Parameters
string$urlUrl to display
Returns
string Code that inserts the iframe (HTML)

Definition at line 485 of file TaskModuleController.php.

Member Data Documentation

◆ $moduleName

TYPO3\CMS\Taskcenter\Controller\TaskModuleController::$moduleName = 'user_task'
protected

Definition at line 52 of file TaskModuleController.php.

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

◆ $moduleTemplate

TYPO3\CMS\Taskcenter\Controller\TaskModuleController::$moduleTemplate
protected

Definition at line 45 of file TaskModuleController.php.

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

◆ $pageinfo

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

Definition at line 38 of file TaskModuleController.php.