TYPO3CMS  8
 All Classes Namespaces Files Functions Variables Pages
SchedulerModuleController Class Reference
Inheritance diagram for SchedulerModuleController:
BaseScriptClass

Public Member Functions

 __construct ()
 
 init ()
 
 menuConfig ()
 
 main ()
 
 mainAction (ServerRequestInterface $request, ResponseInterface $response)
 
 addMessage ($message, $severity=FlashMessage::OK)
 
- Public Member Functions inherited from BaseScriptClass
 init ()
 
 menuConfig ()
 
 mergeExternalItems ($modName, $menuKey, $menuArr)
 
 handleExternalFunctionValue ($MM_key= 'function', $MS_value=null)
 
 getExternalItemConfig ($modName, $menuKey, $value= '')
 
 checkExtObj ()
 
 checkSubExtObj ()
 
 extObjHeader ()
 
 getExtObjContent ()
 

Protected Member Functions

 getModuleMenu ()
 
 getModuleContent ()
 
 checkSchedulerUser ()
 
 infoScreenAction ()
 
 renderTaskProgressBar ($progress)
 
 deleteTask ()
 
 stopTask ()
 
 toggleDisableAction ()
 
 executeTasks ()
 
 makeStatusLabel (array $labels)
 
 getRegisteredClasses ()
 
 getRegisteredTaskGroups ()
 
 getTemplateMarkers ()
 
 getButtons ()
 
 getServerTime ()
 
 getBackendUser ()
 
- Protected Member Functions inherited from BaseScriptClass
 getLanguageService ()
 
 getBackendUser ()
 
 getDatabaseConnection ()
 
 getPageRenderer ()
 

Protected Attributes

 $submittedData = []
 
 $messages = []
 
 $cshKey
 
 $scheduler
 
 $backendTemplatePath = ''
 
 $view
 
 $moduleName = 'system_txschedulerM1'
 
 $moduleUri
 
 $moduleTemplate
 
- Protected Attributes inherited from BaseScriptClass
 $pageRenderer = null
 

Additional Inherited Members

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

Detailed Description

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

Definition at line 39 of file SchedulerModuleController.php.

Constructor & Destructor Documentation

Member Function Documentation

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
int -1 if user doesn't exist, 0 if user exists but is not enabled, 1 if user exists and is enabled

Definition at line 328 of file SchedulerModuleController.php.

References GeneralUtility\makeInstance().

getBackendUser ( )
protected

Returns the global BackendUserAuthentication object.

Returns

Definition at line 1625 of file SchedulerModuleController.php.

References $GLOBALS.

Referenced by SchedulerModuleController\deleteTask(), and SchedulerModuleController\main().

getButtons ( )
protected
getModuleMenu ( )
protected

Generates the action menu

Definition at line 176 of file SchedulerModuleController.php.

Referenced by SchedulerModuleController\main().

getRegisteredClasses ( )
protected

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 1479 of file SchedulerModuleController.php.

References $GLOBALS, and BaseScriptClass\getLanguageService().

Referenced by SchedulerModuleController\executeTasks(), SchedulerModuleController\getButtons(), and SchedulerModuleController\infoScreenAction().

getRegisteredTaskGroups ( )
protected

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

Returns
array List of registered groups

Definition at line 1502 of file SchedulerModuleController.php.

References GeneralUtility\makeInstance().

getServerTime ( )
protected
Returns
string

Definition at line 1614 of file SchedulerModuleController.php.

References $GLOBALS.

getTemplateMarkers ( )
protected

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

Returns
array The filled marker array

Definition at line 1525 of file SchedulerModuleController.php.

References BaseScriptClass\$content, and BaseScriptClass\getLanguageService().

infoScreenAction ( )
protected

This method gathers information about all available task classes and displays it

Returns
string html

Definition at line 489 of file SchedulerModuleController.php.

References SchedulerModuleController\getRegisteredClasses().

Referenced by SchedulerModuleController\getModuleContent().

init ( )

Initializes the backend module

Returns
void

Definition at line 122 of file SchedulerModuleController.php.

References GeneralUtility\makeInstance().

Referenced by SchedulerModuleController\mainAction().

mainAction ( ServerRequestInterface  $request,
ResponseInterface  $response 
)

Injects the request object for the current request or subrequest Simply calls main() and init() and outputs the content

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

Definition at line 310 of file SchedulerModuleController.php.

References $GLOBALS, SchedulerModuleController\init(), and SchedulerModuleController\main().

makeStatusLabel ( array  $labels)
protected

Generates bootstrap labels containing the label statuses

Parameters
array$labels
Returns
string

Definition at line 1246 of file SchedulerModuleController.php.

menuConfig ( )

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

Returns
void

Definition at line 135 of file SchedulerModuleController.php.

References BaseScriptClass\getLanguageService().

renderTaskProgressBar (   $progress)
protected

Renders the task progress bar.

Parameters
float$progressTask progress
Returns
string Progress bar markup

Definition at line 510 of file SchedulerModuleController.php.

References BaseScriptClass\getLanguageService().

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 570 of file SchedulerModuleController.php.

References SchedulerModuleController\addMessage(), AbstractMessage\ERROR, BaseScriptClass\getLanguageService(), and AbstractMessage\WARNING.

Referenced by SchedulerModuleController\getModuleContent().

toggleDisableAction ( )
protected

Toggles the disabled state of the submitted task

Returns
void

Definition at line 598 of file SchedulerModuleController.php.

References AbstractTask\TYPE_SINGLE.

Referenced by SchedulerModuleController\getModuleContent().

Member Data Documentation

$backendTemplatePath = ''
protected

Definition at line 69 of file SchedulerModuleController.php.

$cshKey
protected

Definition at line 59 of file SchedulerModuleController.php.

$messages = []
protected

Definition at line 54 of file SchedulerModuleController.php.

$moduleName = 'system_txschedulerM1'
protected

Definition at line 81 of file SchedulerModuleController.php.

Referenced by SchedulerModuleController\__construct().

$moduleTemplate
protected

Definition at line 93 of file SchedulerModuleController.php.

$moduleUri
protected

Definition at line 86 of file SchedulerModuleController.php.

$scheduler
protected

Definition at line 64 of file SchedulerModuleController.php.

$submittedData = []
protected

Definition at line 46 of file SchedulerModuleController.php.

$view
protected

Definition at line 74 of file SchedulerModuleController.php.