[TASK] Re-work/simplify copyright header in PHP files - Part 9
[Packages/TYPO3.CMS.git] / typo3 / sysext / scheduler / Classes / Task / FileIndexingTask.php
1 <?php
2 namespace TYPO3\CMS\Scheduler\Task;
3
4 /**
5 * This file is part of the TYPO3 CMS project.
6 *
7 * It is free software; you can redistribute it and/or modify it under
8 * the terms of the GNU General Public License, either version 2
9 * of the License, or any later version.
10 *
11 * For the full copyright and license information, please read the
12 * LICENSE.txt file that was distributed with this source code.
13 *
14 * The TYPO3 project - inspiring people to share!
15 */
16 /**
17 * This class provides Scheduler plugin implementation
18 *
19 * @author Lorenz Ulrich <lorenz.ulrich@visol.ch>
20 * @deprecated since TYPO3 CMS 6.2 LTS - will be removed 2 versions later
21 */
22 class FileIndexingTask extends \TYPO3\CMS\Scheduler\Task\AbstractTask {
23
24 /**
25 * @var string
26 */
27 protected $indexingConfiguration;
28
29 /**
30 * @var string
31 */
32 protected $paths;
33
34 /**
35 * Get the value of the protected property indexingConfiguration
36 *
37 * @return string UID of indexing configuration used for the job
38 */
39 public function getIndexingConfiguration() {
40 return $this->indexingConfiguration;
41 }
42
43 /**
44 * Set the value of the private property indexingConfiguration
45 *
46 * @param string $indexingConfiguration UID of indexing configuration used for the job
47 * @return void
48 */
49 public function setIndexingConfiguration($indexingConfiguration) {
50 $this->indexingConfiguration = $indexingConfiguration;
51 }
52
53 /**
54 * Get the value of the protected property paths
55 *
56 * @return string path information for scheduler job (JSON encoded array)
57 */
58 public function getPaths() {
59 return $this->paths;
60 }
61
62 /**
63 * Set the value of the private property paths
64 *
65 * @param array $paths path information for scheduler job (JSON encoded array)
66 * @return void
67 */
68 public function setPaths($paths) {
69 $this->paths = $paths;
70 }
71
72 /**
73 * Hardcode disabled state
74 *
75 * @return boolean TRUE if task is disabled, FALSE otherwise
76 */
77 public function isDisabled() {
78 return TRUE;
79 }
80
81 /**
82 * Function execute from the Scheduler
83 *
84 * @return boolean TRUE on successful execution, FALSE on error
85 */
86 public function execute() {
87 return FALSE;
88 }
89
90 }