FileStorageIndexingTask extends AbstractTask
This task tries to find changes in storage and writes them back to DB
This class is a specific scheduler task implementation is not considered part of the Public TYPO3 API.
Table of Contents
Constants
- TYPE_RECURRING = 2
- TYPE_SINGLE = 1
Properties
- $storageUid : int
- Storage Uid
- $description : string
- Description for the task
- $disabled : bool
- Disable flag, TRUE if task is disabled, FALSE otherwise
- $execution : Execution
- The execution object related to the task
- $executionTime : int
- This variable contains the time of next execution of the task
- $runOnNextCronJob : bool
- Run on next cron job flag, TRUE if task should run on next cronjob, FALSE otherwise
- $scheduler : Scheduler|null
- Reference to a scheduler object
- $taskGroup : int|null
- Task group for this task
- $taskUid : int
- The unique id of the task used to identify it in the database.
Methods
- __construct() : mixed
- Constructor
- areMultipleExecutionsAllowed() : bool
- Returns TRUE if several runs of the task are allowed concurrently
- execute() : bool
- Function execute from the Scheduler
- getAdditionalInformation() : string
- This method is designed to return some additional information about the task, that may help to set it apart from other tasks from the same class This additional information is used - for example - in the Scheduler's BE module This method should be implemented in most task classes
- getDescription() : string
- This method returns the description of the task
- getExecution() : Execution|object|null
- Returns the execution object
- getExecutionTime() : int
- This method returns the timestamp corresponding to the next execution time of the task
- getNextDueExecution() : int
- Returns the timestamp for next due execution of the task
- getRunOnNextCronJob() : bool
- This method returns the run on next cron job status of the task
- getTaskClassName() : string
- This method returns the class name of the scheduler task
- getTaskDescription() : string
- This method returns the description of the scheduler task
- getTaskGroup() : int|null
- This method returns the task group (uid) of the task
- getTaskTitle() : string
- This method returns the title of the scheduler task
- getTaskUid() : int
- This method returns the unique id of the task
- getType() : int
- Guess task type from the existing information If an interval or a cron command is defined, it's a recurring task
- isDisabled() : bool
- This method returns the disabled status of the task
- registerRecurringExecution() : mixed
- Registers a recurring execution of the task
- registerSingleExecution() : mixed
- Registers a single execution of the task
- save() : bool
- Saves the details of the task to the database.
- setDescription() : void
- This method is used to set the description of the task
- setDisabled() : mixed
- This method is used to set the disabled status of the task
- setExecution() : mixed
- Sets the internal execution object
- setExecutionTime() : mixed
- This method is used to set the timestamp corresponding to the next execution time of the task
- setRunOnNextCronJob() : mixed
- This method set the flag for next cron job execution
- setScheduler() : mixed
- Sets the internal reference to the singleton instance of the Scheduler and the logger instance in case it was unserialized
- setTaskGroup() : mixed
- This method is used to set the task group (uid) of the task
- setTaskUid() : void
- This method is used to set the unique id of the task
- stop() : mixed
- Stops the task, by replacing the execution object by an empty one NOTE: the task still needs to be saved after that
- unsetScheduler() : mixed
- Unsets the internal reference to the singleton instance of the Scheduler and the logger instance.
- getIndexer() : Indexer
- Gets the indexer
- getLanguageService() : LanguageService|null
- logException() : mixed
Constants
TYPE_RECURRING
public
mixed
TYPE_RECURRING
= 2
TYPE_SINGLE
public
mixed
TYPE_SINGLE
= 1
Properties
$storageUid
Storage Uid
public
int
$storageUid
= -1
$description
Description for the task
protected
string
$description
= ''
$disabled
Disable flag, TRUE if task is disabled, FALSE otherwise
protected
bool
$disabled
= false
$execution
The execution object related to the task
protected
Execution
$execution
$executionTime
This variable contains the time of next execution of the task
protected
int
$executionTime
= 0
$runOnNextCronJob
Run on next cron job flag, TRUE if task should run on next cronjob, FALSE otherwise
protected
bool
$runOnNextCronJob
= false
$scheduler
Reference to a scheduler object
protected
Scheduler|null
$scheduler
$taskGroup
Task group for this task
protected
int|null
$taskGroup
= 0
$taskUid
The unique id of the task used to identify it in the database.
protected
int
$taskUid
= 0
Methods
__construct()
Constructor
public
__construct() : mixed
areMultipleExecutionsAllowed()
Returns TRUE if several runs of the task are allowed concurrently
public
areMultipleExecutionsAllowed() : bool
since TYPO3 v12.3, not part of TYPO3 Public API anymore.
Return values
bool —TRUE if concurrent executions are allowed, FALSE otherwise
execute()
Function execute from the Scheduler
public
execute() : bool
Return values
bool —TRUE on successful execution, FALSE on error
getAdditionalInformation()
This method is designed to return some additional information about the task, that may help to set it apart from other tasks from the same class This additional information is used - for example - in the Scheduler's BE module This method should be implemented in most task classes
public
getAdditionalInformation() : string
Return values
string —Information to display
getDescription()
This method returns the description of the task
public
getDescription() : string
Return values
string —Description
getExecution()
Returns the execution object
public
getExecution() : Execution|object|null
since TYPO3 v12.3, not part of TYPO3 Public API anymore.
Return values
Execution|object|null —The internal execution object - when an invalid task is being unserialized, the Execution object might not be available
getExecutionTime()
This method returns the timestamp corresponding to the next execution time of the task
public
getExecutionTime() : int
Return values
int —Timestamp of next execution
getNextDueExecution()
Returns the timestamp for next due execution of the task
public
getNextDueExecution() : int
since TYPO3 v12.3, not part of TYPO3 Public API anymore.
Return values
int —Date and time of the next execution as a timestamp
getRunOnNextCronJob()
This method returns the run on next cron job status of the task
public
getRunOnNextCronJob() : bool
Return values
bool —TRUE if task should run on next cron job, FALSE otherwise
getTaskClassName()
This method returns the class name of the scheduler task
public
getTaskClassName() : string
Return values
stringgetTaskDescription()
This method returns the description of the scheduler task
public
getTaskDescription() : string
Return values
stringgetTaskGroup()
This method returns the task group (uid) of the task
public
getTaskGroup() : int|null
Return values
int|null —Uid of task group or null if it came back from the DB without the task group set.
getTaskTitle()
This method returns the title of the scheduler task
public
getTaskTitle() : string
Return values
stringgetTaskUid()
This method returns the unique id of the task
public
getTaskUid() : int
Return values
int —The id of the task
getType()
Guess task type from the existing information If an interval or a cron command is defined, it's a recurring task
public
getType() : int
Return values
intisDisabled()
This method returns the disabled status of the task
public
isDisabled() : bool
Return values
bool —TRUE if task is disabled, FALSE otherwise
registerRecurringExecution()
Registers a recurring execution of the task
public
registerRecurringExecution(int $start, int $interval[, int $end = 0 ][, bool $multiple = false ][, string $cron_cmd = '' ]) : mixed
Parameters
- $start : int
-
The first date/time where this execution should occur (timestamp)
- $interval : int
-
Execution interval in seconds
- $end : int = 0
-
The last date/time where this execution should occur (timestamp)
- $multiple : bool = false
-
Set to FALSE if multiple executions of this task are not permitted in parallel
- $cron_cmd : string = ''
-
Used like in crontab (minute hour day month weekday)
since TYPO3 v12.3, not part of TYPO3 Public API anymore.
registerSingleExecution()
Registers a single execution of the task
public
registerSingleExecution(int $timestamp) : mixed
Parameters
- $timestamp : int
-
Timestamp of the next execution
since TYPO3 v12.3, not part of TYPO3 Public API anymore.
save()
Saves the details of the task to the database.
public
save() : bool
since TYPO3 v12.3, not part of TYPO3 Public API anymore.
Return values
boolsetDescription()
This method is used to set the description of the task
public
setDescription(string $description) : void
Parameters
- $description : string
-
Description
setDisabled()
This method is used to set the disabled status of the task
public
setDisabled(bool $flag) : mixed
Parameters
- $flag : bool
-
TRUE if task should be disabled, FALSE otherwise
setExecution()
Sets the internal execution object
public
setExecution(Execution $execution) : mixed
Parameters
- $execution : Execution
-
The execution to add
since TYPO3 v12.3, not part of TYPO3 Public API anymore.
setExecutionTime()
This method is used to set the timestamp corresponding to the next execution time of the task
public
setExecutionTime(int $timestamp) : mixed
Parameters
- $timestamp : int
-
Timestamp of next execution
setRunOnNextCronJob()
This method set the flag for next cron job execution
public
setRunOnNextCronJob(bool $flag) : mixed
Parameters
- $flag : bool
-
TRUE if task should run with the next cron job, FALSE otherwise
setScheduler()
Sets the internal reference to the singleton instance of the Scheduler and the logger instance in case it was unserialized
public
setScheduler() : mixed
since TYPO3 v12.3, not part of TYPO3 Public API anymore.
setTaskGroup()
This method is used to set the task group (uid) of the task
public
setTaskGroup(int $taskGroup) : mixed
Parameters
- $taskGroup : int
-
Uid of task group
setTaskUid()
This method is used to set the unique id of the task
public
setTaskUid(int $id) : void
Parameters
- $id : int
-
Primary key (from the database record) of the scheduled task
stop()
Stops the task, by replacing the execution object by an empty one NOTE: the task still needs to be saved after that
public
stop() : mixed
since TYPO3 v12.3, not part of TYPO3 Public API anymore.
unsetScheduler()
Unsets the internal reference to the singleton instance of the Scheduler and the logger instance.
public
unsetScheduler() : mixed
This is done before a task is serialized, so that the scheduler instance and the logger instance are not saved to the database
since TYPO3 v12.3, not part of TYPO3 Public API anymore.
getIndexer()
Gets the indexer
protected
getIndexer(ResourceStorage $storage) : Indexer
Parameters
- $storage : ResourceStorage
Return values
IndexergetLanguageService()
protected
getLanguageService() : LanguageService|null
Return values
LanguageService|nulllogException()
protected
logException(Exception $e) : mixed
Parameters
- $e : Exception