|
1
|
|
|
<?php |
|
2
|
|
|
declare(strict_types=1); |
|
3
|
|
|
/** |
|
4
|
|
|
* @copyright Copyright (c) 2018, Roeland Jago Douma <[email protected]> |
|
5
|
|
|
* |
|
6
|
|
|
* @author Roeland Jago Douma <[email protected]> |
|
7
|
|
|
* |
|
8
|
|
|
* @license GNU AGPL version 3 or any later version |
|
9
|
|
|
* |
|
10
|
|
|
* This program is free software: you can redistribute it and/or modify |
|
11
|
|
|
* it under the terms of the GNU Affero General Public License as |
|
12
|
|
|
* published by the Free Software Foundation, either version 3 of the |
|
13
|
|
|
* License, or (at your option) any later version. |
|
14
|
|
|
* |
|
15
|
|
|
* This program is distributed in the hope that it will be useful, |
|
16
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of |
|
17
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
|
18
|
|
|
* GNU Affero General Public License for more details. |
|
19
|
|
|
* |
|
20
|
|
|
* You should have received a copy of the GNU Affero General Public License |
|
21
|
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>. |
|
22
|
|
|
* |
|
23
|
|
|
*/ |
|
24
|
|
|
|
|
25
|
|
|
namespace OCP\BackgroundJob; |
|
26
|
|
|
|
|
27
|
|
|
use OC\BackgroundJob\JobList; |
|
28
|
|
|
use OCP\ILogger; |
|
29
|
|
|
|
|
30
|
|
|
/** |
|
31
|
|
|
* Simple base class to extend to run periodic background jobs. |
|
32
|
|
|
* Call setInterval with your desired interval in seconds from the constructor. |
|
33
|
|
|
* |
|
34
|
|
|
* @since 15.0.0 |
|
35
|
|
|
*/ |
|
36
|
|
View Code Duplication |
abstract class TimedJob extends Job { |
|
|
|
|
|
|
37
|
|
|
/** @var int */ |
|
38
|
|
|
protected $interval = 0; |
|
39
|
|
|
|
|
40
|
|
|
/** |
|
41
|
|
|
* set the interval for the job |
|
42
|
|
|
* |
|
43
|
|
|
* @since 15.0.0 |
|
44
|
|
|
*/ |
|
45
|
|
|
public function setInterval(int $interval) { |
|
46
|
|
|
$this->interval = $interval; |
|
47
|
|
|
} |
|
48
|
|
|
|
|
49
|
|
|
/** |
|
50
|
|
|
* run the job if the last run is is more than the interval ago |
|
51
|
|
|
* |
|
52
|
|
|
* @param JobList $jobList |
|
53
|
|
|
* @param ILogger|null $logger |
|
54
|
|
|
* |
|
55
|
|
|
* @since 15.0.0 |
|
56
|
|
|
*/ |
|
57
|
|
|
final public function execute($jobList, ILogger $logger = null) { |
|
58
|
|
|
if (($this->time->getTime() - $this->lastRun) > $this->interval) { |
|
59
|
|
|
parent::execute($jobList, $logger); |
|
60
|
|
|
} |
|
61
|
|
|
} |
|
62
|
|
|
} |
|
63
|
|
|
|
nextcloud /
server
Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.
You can also find more detailed suggestions in the “Code” section of your repository.