TYPO3 CMS  TYPO3_6-2
TYPO3\CMS\Scheduler\Task\FileIndexingTask Class Reference
Inheritance diagram for TYPO3\CMS\Scheduler\Task\FileIndexingTask:
TYPO3\CMS\Scheduler\Task\AbstractTask tx_scheduler_FileIndexing

Public Member Functions

 getIndexingConfiguration ()
 
 setIndexingConfiguration ($indexingConfiguration)
 
 getPaths ()
 
 setPaths ($paths)
 
 isDisabled ()
 
 execute ()
 
- Public Member Functions inherited from TYPO3\CMS\Scheduler\Task\AbstractTask
 __construct ()
 
 execute ()
 
 getAdditionalInformation ()
 
 setTaskUid ($id)
 
 getTaskUid ()
 
 getTaskTitle ()
 
 getTaskDescription ()
 
 getTaskClassName ()
 
 isDisabled ()
 
 setDisabled ($flag)
 
 setExecutionTime ($timestamp)
 
 getTaskGroup ()
 
 setTaskGroup ($taskGroup)
 
 getExecutionTime ()
 
 setDescription ($description)
 
 getDescription ()
 
 setScheduler ()
 
 unsetScheduler ()
 
 setExecution (\TYPO3\CMS\Scheduler\Execution $execution)
 
 getExecution ()
 
 getNextDueExecution ()
 
 areMultipleExecutionsAllowed ()
 
 isExecutionRunning ()
 
 markExecution ()
 
 unmarkExecution ($executionID, \Exception $failure=NULL)
 
 unmarkAllExecutions ()
 
 save ()
 
 stop ()
 
 remove ()
 

Protected Attributes

 $indexingConfiguration
 
 $paths
 
- Protected Attributes inherited from TYPO3\CMS\Scheduler\Task\AbstractTask
 $scheduler
 
 $taskUid
 
 $disabled = FALSE
 
 $execution
 
 $executionTime = 0
 
 $description = ''
 
 $taskGroup
 

Detailed Description

This file is part of the TYPO3 CMS project.

It is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License, either version 2 of the License, or any later version.

For the full copyright and license information, please read the LICENSE.txt file that was distributed with this source code.

The TYPO3 project - inspiring people to share! This class provides Scheduler plugin implementation

Author
Lorenz Ulrich loren.nosp@m.z.ul.nosp@m.rich@.nosp@m.viso.nosp@m.l.ch
Deprecated:
since TYPO3 CMS 6.2 LTS - will be removed 2 versions later

Definition at line 22 of file FileIndexingTask.php.

Member Function Documentation

◆ execute()

TYPO3\CMS\Scheduler\Task\FileIndexingTask::execute ( )

Function execute from the Scheduler

Returns
boolean TRUE on successful execution, FALSE on error

Definition at line 86 of file FileIndexingTask.php.

◆ getIndexingConfiguration()

TYPO3\CMS\Scheduler\Task\FileIndexingTask::getIndexingConfiguration ( )

Get the value of the protected property indexingConfiguration

Returns
string UID of indexing configuration used for the job

Definition at line 39 of file FileIndexingTask.php.

References TYPO3\CMS\Scheduler\Task\FileIndexingTask\$indexingConfiguration.

◆ getPaths()

TYPO3\CMS\Scheduler\Task\FileIndexingTask::getPaths ( )

Get the value of the protected property paths

Returns
string path information for scheduler job (JSON encoded array)

Definition at line 58 of file FileIndexingTask.php.

References TYPO3\CMS\Scheduler\Task\FileIndexingTask\$paths.

◆ isDisabled()

TYPO3\CMS\Scheduler\Task\FileIndexingTask::isDisabled ( )

Hardcode disabled state

Returns
boolean TRUE if task is disabled, FALSE otherwise

Definition at line 77 of file FileIndexingTask.php.

◆ setIndexingConfiguration()

TYPO3\CMS\Scheduler\Task\FileIndexingTask::setIndexingConfiguration (   $indexingConfiguration)

Set the value of the private property indexingConfiguration

Parameters
string$indexingConfigurationUID of indexing configuration used for the job
Returns
void

Definition at line 49 of file FileIndexingTask.php.

References TYPO3\CMS\Scheduler\Task\FileIndexingTask\$indexingConfiguration.

◆ setPaths()

TYPO3\CMS\Scheduler\Task\FileIndexingTask::setPaths (   $paths)

Set the value of the private property paths

Parameters
array$pathspath information for scheduler job (JSON encoded array)
Returns
void

Definition at line 68 of file FileIndexingTask.php.

References TYPO3\CMS\Scheduler\Task\FileIndexingTask\$paths.

Member Data Documentation

◆ $indexingConfiguration

TYPO3\CMS\Scheduler\Task\FileIndexingTask::$indexingConfiguration
protected

◆ $paths

TYPO3\CMS\Scheduler\Task\FileIndexingTask::$paths
protected