TYPO3\CMS\Scheduler\Controller\SchedulerModuleController Class Reference

Inheritance diagram for TYPO3\CMS\Scheduler\Controller\SchedulerModuleController:

Public Member Functions
	__construct ()
	init ()
	menuConfig ()
	main ()
	render ()
	checkDate ($string)
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 ()

Public Attributes
	$backPath
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

Protected Member Functions
	getModuleContent ()
	checkSchedulerUser ()
	displayServerTime ()
	renderTaskProgressBar ($progress)
	deleteTask ()
	stopTask ()
	executeTasks ()
	getTemplateMarkers ()
	getFunctionMenu ()
	getDocHeaderButtons ()
	getShortcutButton ()
	getBackendUserAuthentication ()
	getDatabaseConnection ()
Protected Member Functions inherited from TYPO3\CMS\Backend\Module\BaseScriptClass
	getLanguageService ()
	getBackendUser ()

Static Protected Member Functions
static	getRegisteredClasses ()
static	getRegisteredTaskGroups ()

Protected Attributes
	$submittedData = array()
	$messages = array()
	$cshKey
	$scheduler
	$pageRenderer

Detailed Description

Module 'TYPO3 Scheduler administration module' for the 'scheduler' extension.

Author

François Suter franc.nosp@m.ois@.nosp@m.typo3.nosp@m..org

Christian Jul Jensen julle.nosp@m.@typ.nosp@m.o3.or.nosp@m.g

Ingo Renner ingo@.nosp@m.typo.nosp@m.3.org

Definition at line 36 of file SchedulerModuleController.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Scheduler\Controller\SchedulerModuleController::__construct

(

)

Constructor

Returns

Definition at line 80 of file SchedulerModuleController.php.

References $GLOBALS.

Member Function Documentation

checkDate()

TYPO3\CMS\Scheduler\Controller\SchedulerModuleController::checkDate

(

$string

)

This method checks whether the given string can be considered a valid date or not Allowed values are anything that matches natural language (see PHP function strtotime()) or TYPO3's date syntax: HH:ii yyyy-mm-dd If the string is a valid date, the corresponding timestamp is returned. Otherwise an exception is thrown

Parameters

string

$string

String to check

Returns

integer Unix timestamp

Exceptions

Definition at line 1405 of file SchedulerModuleController.php.

checkSchedulerUser()

TYPO3\CMS\Scheduler\Controller\SchedulerModuleController::checkSchedulerUser ( )

protected

This method checks the status of the '_cli_scheduler' user It will differentiate between a non-existing user and an existing, but disabled user (as per enable fields)

Returns

integer -1 if user doesn't exist

Definition at line 257 of file SchedulerModuleController.php.

References TYPO3\CMS\Backend\Module\BaseScriptClass\$content, $GLOBALS, $registry, TYPO3\CMS\Backend\Utility\BackendUtility\BEenableFields(), TYPO3\CMS\Backend\Utility\BackendUtility\deleteClause(), TYPO3\CMS\Core\Messaging\AbstractMessage\ERROR, TYPO3\CMS\Saltedpasswords\Salt\SaltFactory\getSaltingInstance(), TYPO3\CMS\Backend\Utility\IconUtility\getSpriteIcon(), TYPO3\CMS\Core\Messaging\AbstractMessage\INFO, TYPO3\CMS\Saltedpasswords\Utility\SaltedPasswordsUtility\isUsageEnabled(), TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance(), TYPO3\CMS\Core\Messaging\AbstractMessage\OK, and TYPO3\CMS\Core\Messaging\AbstractMessage\WARNING.

deleteTask()

TYPO3\CMS\Scheduler\Controller\SchedulerModuleController::deleteTask ( )

protected

Delete a task from the execution queue

Returns

void

Definition at line 492 of file SchedulerModuleController.php.

References $GLOBALS, $result, and TYPO3\CMS\Core\Messaging\AbstractMessage\ERROR.

Referenced by TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\getModuleContent().

displayServerTime()

TYPO3\CMS\Scheduler\Controller\SchedulerModuleController::displayServerTime ( )

protected

Display the current server's time along with a help text about server time usage in the Scheduler

Returns

string HTML to display

Definition at line 464 of file SchedulerModuleController.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\stopTask().

executeTasks()

TYPO3\CMS\Scheduler\Controller\SchedulerModuleController::executeTasks ( )

protected

Execute all selected tasks

Returns

void

Definition at line 855 of file SchedulerModuleController.php.

References TYPO3\CMS\Backend\Module\BaseScriptClass\$content, $GLOBALS, $result, $uid, TYPO3\CMS\Core\Utility\GeneralUtility\_POST(), TYPO3\CMS\Core\Messaging\AbstractMessage\ERROR, TYPO3\CMS\Core\Utility\ExtensionManagementUtility\extRelPath(), TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\getDatabaseConnection(), TYPO3\CMS\Backend\Module\BaseScriptClass\getLanguageService(), TYPO3\CMS\Backend\Utility\IconUtility\getSpriteIcon(), TYPO3\CMS\Core\Messaging\AbstractMessage\INFO, and TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

Referenced by TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\getModuleContent().

getBackendUserAuthentication()

TYPO3\CMS\Scheduler\Controller\SchedulerModuleController::getBackendUserAuthentication ( )

protected

Returns the global BackendUserAuthentication object.

Returns

Definition at line 1591 of file SchedulerModuleController.php.

getDatabaseConnection()

TYPO3\CMS\Scheduler\Controller\SchedulerModuleController::getDatabaseConnection ( )

protected

Returns the database connection

Returns

DatabaseConnection

Definition at line 1600 of file SchedulerModuleController.php.

Referenced by TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\executeTasks().

getDocHeaderButtons()

TYPO3\CMS\Scheduler\Controller\SchedulerModuleController::getDocHeaderButtons ( )

protected

Gets the buttons that shall be rendered in the docHeader.

Returns

array Available buttons for the docHeader

Definition at line 1542 of file SchedulerModuleController.php.

Referenced by TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\main().

getFunctionMenu()

TYPO3\CMS\Scheduler\Controller\SchedulerModuleController::getFunctionMenu ( )

protected

Gets the function menu selector for this backend module.

Returns

string The HTML representation of the function menu selector

Definition at line 1532 of file SchedulerModuleController.php.

getModuleContent()

TYPO3\CMS\Scheduler\Controller\SchedulerModuleController::getModuleContent ( )

protected

Generate the module's content

Returns

string HTML of the module's main content

Definition at line 154 of file SchedulerModuleController.php.

References TYPO3\CMS\Backend\Module\BaseScriptClass\$content, $GLOBALS, $result, TYPO3\CMS\Core\Utility\GeneralUtility\_GP(), TYPO3\CMS\Core\Utility\GeneralUtility\_GPmerged(), TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\deleteTask(), TYPO3\CMS\Core\Messaging\AbstractMessage\ERROR, TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\executeTasks(), and TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\stopTask().

Referenced by TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\main().

getRegisteredClasses()

static TYPO3\CMS\Scheduler\Controller\SchedulerModuleController::getRegisteredClasses ( )

staticprotected

This method fetches a list of all classes that have been registered with the Scheduler For each item the following information is provided, as an associative array:

['extension'] => Key of the extension which provides the class ['filename'] => Path to the file containing the class ['title'] => String (possibly localized) containing a human-readable name for the class ['provider'] => Name of class that implements the interface for additional fields, if necessary

The name of the class itself is used as the key of the list array

Returns

array List of registered classes

Definition at line 1463 of file SchedulerModuleController.php.

getRegisteredTaskGroups()

static TYPO3\CMS\Scheduler\Controller\SchedulerModuleController::getRegisteredTaskGroups ( )

staticprotected

This method fetches list of all group that have been registered with the Scheduler

Returns

array List of registered groups

Definition at line 1485 of file SchedulerModuleController.php.

getShortcutButton()

TYPO3\CMS\Scheduler\Controller\SchedulerModuleController::getShortcutButton ( )

protected

Gets the button to set a new shortcut in the backend (if current user is allowed to).

Returns

string HTML representation of the shortcut button

Definition at line 1578 of file SchedulerModuleController.php.

getTemplateMarkers()

TYPO3\CMS\Scheduler\Controller\SchedulerModuleController::getTemplateMarkers ( )

protected

Gets the filled markers that are used in the HTML template.

Returns

array The filled marker array

Definition at line 1517 of file SchedulerModuleController.php.

Referenced by TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\main().

init()

TYPO3\CMS\Scheduler\Controller\SchedulerModuleController::init

(

)

Initializes the backend module

Returns

void

Definition at line 93 of file SchedulerModuleController.php.

References TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\$backPath, TYPO3\CMS\Core\Utility\ExtensionManagementUtility\extPath(), TYPO3\CMS\Core\Utility\ExtensionManagementUtility\extRelPath(), and TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

main()

TYPO3\CMS\Scheduler\Controller\SchedulerModuleController::main

(

)

Main function of the module. Write the content to $this->content

Returns

void

Definition at line 128 of file SchedulerModuleController.php.

References TYPO3\CMS\Backend\Module\BaseScriptClass\$content, $GLOBALS, TYPO3\CMS\Core\Utility\ExtensionManagementUtility\extRelPath(), TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\getDocHeaderButtons(), TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\getModuleContent(), and TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\getTemplateMarkers().

menuConfig()

TYPO3\CMS\Scheduler\Controller\SchedulerModuleController::menuConfig

(

)

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

Returns

void

Definition at line 112 of file SchedulerModuleController.php.

References $GLOBALS.

render()

TYPO3\CMS\Scheduler\Controller\SchedulerModuleController::render

(

)

This method actually prints out the module's HTML content

Returns

void

Definition at line 246 of file SchedulerModuleController.php.

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

renderTaskProgressBar()

TYPO3\CMS\Scheduler\Controller\SchedulerModuleController::renderTaskProgressBar (   $progress )

protected

Renders the task progress bar.

Parameters

float

$progress

Task progress

Returns

string Progress bar markup

Definition at line 481 of file SchedulerModuleController.php.

References $GLOBALS.

stopTask()

TYPO3\CMS\Scheduler\Controller\SchedulerModuleController::stopTask ( )

protected

Clears the registered running executions from the task Note that this doesn't actually stop the running script. It just unmarks all executions. TODO: find a way to really kill the running task

Returns

void

Definition at line 529 of file SchedulerModuleController.php.

References TYPO3\CMS\Backend\Module\BaseScriptClass\$content, $GLOBALS, $result, TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\displayServerTime(), TYPO3\CMS\Core\Messaging\AbstractMessage\ERROR, TYPO3\CMS\Core\Utility\ExtensionManagementUtility\extRelPath(), TYPO3\CMS\Backend\Utility\IconUtility\getSpriteIcon(), TYPO3\CMS\Core\Utility\GeneralUtility\getUserObj(), TYPO3\CMS\Core\Utility\ArrayUtility\mergeRecursiveWithOverrule(), TYPO3\CMS\Core\Messaging\AbstractMessage\WARNING, and TYPO3\CMS\Backend\Utility\BackendUtility\wrapInHelp().

Referenced by TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\getModuleContent().

Member Data Documentation

$backPath

string TYPO3\CMS\Scheduler\Controller\SchedulerModuleController::$backPath

Back path to typo3 main dir

Definition at line 43 of file SchedulerModuleController.php.

Referenced by TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\init().

$cshKey

TYPO3\CMS\Scheduler\Controller\SchedulerModuleController::$cshKey

protected

Definition at line 63 of file SchedulerModuleController.php.

$messages

array TYPO3\CMS\Scheduler\Controller\SchedulerModuleController::$messages = array()

protected

Array containing all messages issued by the application logic Contains the error's severity and the message itself

Definition at line 58 of file SchedulerModuleController.php.

$pageRenderer

TYPO3\CMS\Scheduler\Controller\SchedulerModuleController::$pageRenderer

protected

Definition at line 73 of file SchedulerModuleController.php.

$scheduler

TYPO3\CMS\Scheduler\Controller\SchedulerModuleController::$scheduler

protected

Definition at line 68 of file SchedulerModuleController.php.

$submittedData

array TYPO3\CMS\Scheduler\Controller\SchedulerModuleController::$submittedData = array()

protected

Array containing submitted data when editing or adding a task

Definition at line 50 of file SchedulerModuleController.php.