summaryrefslogtreecommitdiffstats
path: root/lib/private/BackgroundJob/Job.php
diff options
context:
space:
mode:
Diffstat (limited to 'lib/private/BackgroundJob/Job.php')
-rw-r--r--lib/private/BackgroundJob/Job.php88
1 files changed, 88 insertions, 0 deletions
diff --git a/lib/private/BackgroundJob/Job.php b/lib/private/BackgroundJob/Job.php
new file mode 100644
index 00000000000..e7268894848
--- /dev/null
+++ b/lib/private/BackgroundJob/Job.php
@@ -0,0 +1,88 @@
+<?php
+/**
+ * @author Morris Jobke <hey@morrisjobke.de>
+ * @author Robin Appelman <icewind@owncloud.com>
+ * @author Thomas Müller <thomas.mueller@tmit.eu>
+ *
+ * @copyright Copyright (c) 2016, ownCloud, Inc.
+ * @license AGPL-3.0
+ *
+ * This code is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License, version 3,
+ * as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License, version 3,
+ * along with this program. If not, see <http://www.gnu.org/licenses/>
+ *
+ */
+
+namespace OC\BackgroundJob;
+
+use OCP\BackgroundJob\IJob;
+use OCP\ILogger;
+
+abstract class Job implements IJob {
+ /**
+ * @var int $id
+ */
+ protected $id;
+
+ /**
+ * @var int $lastRun
+ */
+ protected $lastRun;
+
+ /**
+ * @var mixed $argument
+ */
+ protected $argument;
+
+ /**
+ * @param JobList $jobList
+ * @param ILogger $logger
+ */
+ public function execute($jobList, ILogger $logger = null) {
+ $jobList->setLastRun($this);
+ try {
+ $this->run($this->argument);
+ } catch (\Exception $e) {
+ if ($logger) {
+ $logger->logException($e, [
+ 'app' => 'core',
+ 'message' => 'Error while running background job (class: ' . get_class($this) . ', arguments: ' . print_r($this->argument, true) . ')'
+ ]);
+ }
+ }
+ }
+
+ abstract protected function run($argument);
+
+ public function setId($id) {
+ $this->id = $id;
+ }
+
+ public function setLastRun($lastRun) {
+ $this->lastRun = $lastRun;
+ }
+
+ public function setArgument($argument) {
+ $this->argument = $argument;
+ }
+
+ public function getId() {
+ return $this->id;
+ }
+
+ public function getLastRun() {
+ return $this->lastRun;
+ }
+
+ public function getArgument() {
+ return $this->argument;
+ }
+}