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

Public Member Functions

 __construct ()
 
 init ()
 
 menuConfig ()
 
 main ()
 
 mainAction (ServerRequestInterface $request, ResponseInterface $response)
 
 render ()
 
 checkDate ($string)
 
 addMessage ($message, $severity=FlashMessage::OK)
 
- 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

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

Protected Attributes

 $submittedData = []
 
 $messages = []
 
 $cshKey
 
 $scheduler
 
 $backendTemplatePath = ''
 
 $view
 
 $moduleName = 'system_txschedulerM1'
 
 $moduleUri
 
 $moduleTemplate
 
- 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

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

Definition at line 37 of file SchedulerModuleController.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Scheduler\Controller\SchedulerModuleController::__construct ( )
Returns

Definition at line 96 of file SchedulerModuleController.php.

References TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\$moduleName, TYPO3\CMS\Backend\Module\BaseScriptClass\$pageRenderer, TYPO3\CMS\Core\Utility\ExtensionManagementUtility\extPath(), TYPO3\CMS\Backend\Module\BaseScriptClass\getLanguageService(), and TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

Member Function Documentation

◆ addMessage()

TYPO3\CMS\Scheduler\Controller\SchedulerModuleController::addMessage (   $message,
  $severity = FlashMessage::OK 
)

This method is used to add a message to the internal queue

Parameters
string$messageThe message itself
int$severityMessage level (according to FlashMessage class constants)
Returns
void

Definition at line 1492 of file SchedulerModuleController.php.

Referenced by TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\checkSchedulerUser(), TYPO3\CMS\Recycler\Task\CleanerFieldProvider\checkTcaIsNotEmpty(), TYPO3\CMS\Recycler\Task\CleanerFieldProvider\checkTcaIsValid(), TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\deleteTask(), TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\executeTasks(), TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\getModuleContent(), TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\makeStatusLabel(), TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\stopTask(), TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\toggleDisableAction(), TYPO3\CMS\Recycler\Task\CleanerFieldProvider\validateAdditionalFieldPeriod(), and TYPO3\CMS\Linkvalidator\Task\ValidatorTaskAdditionalFieldProvider\validateAdditionalFields().

◆ 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$stringString to check
Returns
int Unix timestamp
Exceptions

Definition at line 1454 of file SchedulerModuleController.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\logDeprecatedFunction(), and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

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

Definition at line 337 of file SchedulerModuleController.php.

References $GLOBALS, TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\addMessage(), TYPO3\CMS\Backend\Utility\BackendUtility\BEenableFields(), TYPO3\CMS\Backend\Utility\BackendUtility\deleteClause(), TYPO3\CMS\Core\Messaging\AbstractMessage\ERROR, TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\getDatabaseConnection(), TYPO3\CMS\Backend\Module\BaseScriptClass\getLanguageService(), TYPO3\CMS\Saltedpasswords\Salt\SaltFactory\getSaltingInstance(), TYPO3\CMS\Core\Utility\StringUtility\getUniqueId(), TYPO3\CMS\Saltedpasswords\Utility\SaltedPasswordsUtility\isUsageEnabled(), TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance(), TYPO3\CMS\Core\Messaging\AbstractMessage\OK, TYPO3\CMS\Fluid\ViewHelpers\Be\InfoboxViewHelper\STATE_ERROR, TYPO3\CMS\Fluid\ViewHelpers\Be\InfoboxViewHelper\STATE_INFO, TYPO3\CMS\Fluid\ViewHelpers\Be\InfoboxViewHelper\STATE_OK, TYPO3\CMS\Fluid\ViewHelpers\Be\InfoboxViewHelper\STATE_WARNING, 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 519 of file SchedulerModuleController.php.

References TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\addMessage(), TYPO3\CMS\Core\Messaging\AbstractMessage\ERROR, TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\getBackendUser(), TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\getDatabaseConnection(), and TYPO3\CMS\Backend\Module\BaseScriptClass\getLanguageService().

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

◆ executeTasks()

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

Execute all selected tasks

Returns
void

Definition at line 899 of file SchedulerModuleController.php.

References $GLOBALS, $uid, TYPO3\CMS\Core\Utility\GeneralUtility\_POST(), TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\addMessage(), TYPO3\CMS\Core\Messaging\AbstractMessage\ERROR, TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\getDatabaseConnection(), TYPO3\CMS\Backend\Module\BaseScriptClass\getLanguageService(), TYPO3\CMS\Backend\Module\BaseScriptClass\getPageRenderer(), TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\getRegisteredClasses(), TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\getRegisteredTaskGroups(), TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\makeStatusLabel(), TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\renderTaskProgressBar(), TYPO3\CMS\Core\Imaging\Icon\SIZE_SMALL, and TYPO3\CMS\Scheduler\Task\AbstractTask\TYPE_SINGLE.

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

◆ getBackendUser()

TYPO3\CMS\Scheduler\Controller\SchedulerModuleController::getBackendUser ( )
protected

Returns the global BackendUserAuthentication object.

Returns

Definition at line 1658 of file SchedulerModuleController.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\deleteTask(), TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\main(), and TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\makeStatusLabel().

◆ getButtons()

TYPO3\CMS\Scheduler\Controller\SchedulerModuleController::getButtons ( )
protected

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

Definition at line 1578 of file SchedulerModuleController.php.

References TYPO3\CMS\Backend\Template\Components\ButtonBar\BUTTON_POSITION_LEFT, TYPO3\CMS\Backend\Template\Components\ButtonBar\BUTTON_POSITION_RIGHT, TYPO3\CMS\Backend\Module\BaseScriptClass\getLanguageService(), TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\getRegisteredClasses(), TYPO3\CMS\Core\Utility\GeneralUtility\quoteJSvalue(), and TYPO3\CMS\Core\Imaging\Icon\SIZE_SMALL.

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

◆ getDatabaseConnection()

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

Returns the database connection

Returns
DatabaseConnection

Definition at line 1668 of file SchedulerModuleController.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\checkSchedulerUser(), TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\deleteTask(), TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\executeTasks(), and TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\getRegisteredTaskGroups().

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

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

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

◆ getModuleMenu()

TYPO3\CMS\Scheduler\Controller\SchedulerModuleController::getModuleMenu ( )
protected

Generates the action menu

Definition at line 173 of file SchedulerModuleController.php.

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

◆ getRegisteredClasses()

TYPO3\CMS\Scheduler\Controller\SchedulerModuleController::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 1510 of file SchedulerModuleController.php.

References $GLOBALS, and TYPO3\CMS\Backend\Module\BaseScriptClass\getLanguageService().

Referenced by TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\executeTasks(), TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\getButtons(), TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\infoScreenAction(), and TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\toggleDisableAction().

◆ getRegisteredTaskGroups()

TYPO3\CMS\Scheduler\Controller\SchedulerModuleController::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 1533 of file SchedulerModuleController.php.

References TYPO3\CMS\Backend\Utility\BackendUtility\BEenableFields(), TYPO3\CMS\Backend\Utility\BackendUtility\deleteClause(), and TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\getDatabaseConnection().

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

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

References TYPO3\CMS\Backend\Module\BaseScriptClass\$content, and TYPO3\CMS\Backend\Module\BaseScriptClass\getLanguageService().

◆ infoScreenAction()

TYPO3\CMS\Scheduler\Controller\SchedulerModuleController::infoScreenAction ( )
protected

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

Returns
string html

Definition at line 485 of file SchedulerModuleController.php.

References TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\getRegisteredClasses().

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

◆ init()

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

Initializes the backend module

Returns
void

Definition at line 119 of file SchedulerModuleController.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

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

◆ main()

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

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

Returns
void

Definition at line 149 of file SchedulerModuleController.php.

References TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\getBackendUser(), TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\getButtons(), TYPO3\CMS\Backend\Module\BaseScriptClass\getLanguageService(), TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\getModuleContent(), and TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\getModuleMenu().

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

◆ mainAction()

TYPO3\CMS\Scheduler\Controller\SchedulerModuleController::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 307 of file SchedulerModuleController.php.

References $GLOBALS, TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\init(), and TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\main().

◆ makeStatusLabel()

TYPO3\CMS\Scheduler\Controller\SchedulerModuleController::makeStatusLabel ( array  $labels)
protected

Generates bootstrap labels containing the label statuses

Parameters
array$labels
Returns
string

Definition at line 1239 of file SchedulerModuleController.php.

References $GLOBALS, TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\addMessage(), TYPO3\CMS\Core\Messaging\AbstractMessage\ERROR, TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\getBackendUser(), TYPO3\CMS\Backend\Module\BaseScriptClass\getLanguageService(), TYPO3\CMS\Core\Utility\GeneralUtility\getUserObj(), TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance(), TYPO3\CMS\Scheduler\CronCommand\NormalizeCommand\normalize(), TYPO3\CMS\Scheduler\Task\AbstractTask\TYPE_RECURRING, and TYPO3\CMS\Scheduler\Task\AbstractTask\TYPE_SINGLE.

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

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

References TYPO3\CMS\Backend\Module\BaseScriptClass\getLanguageService().

◆ render()

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

This method actually prints out the module's HTML content

Returns
void
Deprecated:
since TYPO3 CMS 7, will be removed in TYPO3 CMS 8

Definition at line 324 of file SchedulerModuleController.php.

References TYPO3\CMS\Backend\Module\BaseScriptClass\$content, and TYPO3\CMS\Core\Utility\GeneralUtility\logDeprecatedFunction().

◆ renderTaskProgressBar()

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

Renders the task progress bar.

Parameters
float$progressTask progress
Returns
string Progress bar markup

Definition at line 506 of file SchedulerModuleController.php.

References TYPO3\CMS\Backend\Module\BaseScriptClass\getLanguageService().

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

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

References TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\addMessage(), TYPO3\CMS\Core\Messaging\AbstractMessage\ERROR, TYPO3\CMS\Backend\Module\BaseScriptClass\getLanguageService(), and TYPO3\CMS\Core\Messaging\AbstractMessage\WARNING.

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

◆ toggleDisableAction()

TYPO3\CMS\Scheduler\Controller\SchedulerModuleController::toggleDisableAction ( )
protected

Toggles the disabled state of the submitted task

Returns
void

Definition at line 585 of file SchedulerModuleController.php.

References $GLOBALS, TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\addMessage(), TYPO3\CMS\Core\Messaging\AbstractMessage\ERROR, TYPO3\CMS\Backend\Module\BaseScriptClass\getLanguageService(), TYPO3\CMS\Backend\Module\BaseScriptClass\getPageRenderer(), TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\getRegisteredClasses(), TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\getRegisteredTaskGroups(), TYPO3\CMS\Core\Utility\GeneralUtility\getUserObj(), TYPO3\CMS\Core\Utility\ArrayUtility\mergeRecursiveWithOverrule(), TYPO3\CMS\Scheduler\Task\AbstractTask\TYPE_RECURRING, and TYPO3\CMS\Scheduler\Task\AbstractTask\TYPE_SINGLE.

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

Member Data Documentation

◆ $backendTemplatePath

TYPO3\CMS\Scheduler\Controller\SchedulerModuleController::$backendTemplatePath = ''
protected

Definition at line 67 of file SchedulerModuleController.php.

◆ $cshKey

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

Definition at line 57 of file SchedulerModuleController.php.

◆ $messages

TYPO3\CMS\Scheduler\Controller\SchedulerModuleController::$messages = []
protected

Definition at line 52 of file SchedulerModuleController.php.

◆ $moduleName

TYPO3\CMS\Scheduler\Controller\SchedulerModuleController::$moduleName = 'system_txschedulerM1'
protected

Definition at line 79 of file SchedulerModuleController.php.

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

◆ $moduleTemplate

TYPO3\CMS\Scheduler\Controller\SchedulerModuleController::$moduleTemplate
protected

Definition at line 91 of file SchedulerModuleController.php.

◆ $moduleUri

TYPO3\CMS\Scheduler\Controller\SchedulerModuleController::$moduleUri
protected

Definition at line 84 of file SchedulerModuleController.php.

◆ $scheduler

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

Definition at line 62 of file SchedulerModuleController.php.

◆ $submittedData

TYPO3\CMS\Scheduler\Controller\SchedulerModuleController::$submittedData = []
protected

Definition at line 44 of file SchedulerModuleController.php.

◆ $view

TYPO3\CMS\Scheduler\Controller\SchedulerModuleController::$view
protected

Definition at line 72 of file SchedulerModuleController.php.