TYPO3\CMS\Scheduler\Example\TestTask Class Reference

Inheritance diagram for TYPO3\CMS\Scheduler\Example\TestTask:

Public Member Functions
bool	execute ()
string	getAdditionalInformation ()
‪Public Member Functions inherited from ‪TYPO3\CMS\Scheduler\Task\AbstractTask
	__construct ()
	setTaskUid ($id)
int	getTaskUid ()
string	getTaskTitle ()
string	getTaskDescription ()
string	getTaskClassName ()
bool	isDisabled ()
	setDisabled ($flag)
	setRunOnNextCronJob ($flag)
bool	getRunOnNextCronJob ()
	setExecutionTime ($timestamp)
int	getTaskGroup ()
	setTaskGroup ($taskGroup)
int	getExecutionTime ()
	setDescription ($description)
string	getDescription ()
	setScheduler ()
	unsetScheduler ()
	registerSingleExecution ($timestamp)
	registerRecurringExecution ($start, $interval, $end=0, $multiple=false, $cron_cmd='')
	setExecution (Execution $execution)
Execution	getExecution ()
int	getNextDueExecution ()
bool	areMultipleExecutionsAllowed ()
bool	isExecutionRunning ()
int	markExecution ()
	unmarkExecution ($executionID, \Throwable $failure=null)
bool	unmarkAllExecutions ()
bool	save ()
	stop ()
	remove ()
int	getType ()

Public Attributes
string	$email
‪Public Attributes inherited from ‪TYPO3\CMS\Scheduler\Task\AbstractTask
const	TYPE_SINGLE = 1
const	TYPE_RECURRING = 2

Additional Inherited Members
‪Protected Member Functions inherited from ‪TYPO3\CMS\Scheduler\Task\AbstractTask
	logException (\Exception $e)
LanguageService null	getLanguageService ()
‪Protected Attributes inherited from ‪TYPO3\CMS\Scheduler\Task\AbstractTask
TYPO3 CMS Scheduler Scheduler	$scheduler
int	$taskUid
bool	$disabled = false
bool	$runOnNextCronJob = false
Execution	$execution
int	$executionTime = 0
string	$description = ''
int	$taskGroup = 0

Detailed Description

Provides testing procedures

This class is an example is not considered part of the Public TYPO3 API.

Definition at line 31 of file TestTask.php.

Member Function Documentation

execute()

bool TYPO3\CMS\Scheduler\Example\TestTask::execute

(

)

Function executed from the Scheduler. Sends an email

Returns

‪bool

Reimplemented from TYPO3\CMS\Scheduler\Task\AbstractTask.

Definition at line 45 of file TestTask.php.

References TYPO3\CMS\Scheduler\Example\TestTask\$email, $GLOBALS, and TYPO3\CMS\Core\Core\Environment\isCli().

getAdditionalInformation()

string TYPO3\CMS\Scheduler\Example\TestTask::getAdditionalInformation

(

)

This method returns the destination mail address as additional information

Returns

‪string Information to display

Reimplemented from TYPO3\CMS\Scheduler\Task\AbstractTask.

Definition at line 103 of file TestTask.php.

References TYPO3\CMS\Scheduler\Example\TestTask\$email, TYPO3\CMS\Scheduler\Task\AbstractTask\getLanguageService(), and TYPO3\CMS\Core\Localization\LanguageService\sL().

Member Data Documentation

$email

string TYPO3\CMS\Scheduler\Example\TestTask::$email

An email address to be used during the process

$email

Definition at line 37 of file TestTask.php.

Referenced by TYPO3\CMS\Scheduler\Example\TestTask\execute(), and TYPO3\CMS\Scheduler\Example\TestTask\getAdditionalInformation().