From 9b10d354777f7eea21820aec522c4865fb1663fe Mon Sep 17 00:00:00 2001 From: Daniel Kesselberg Date: Fri, 3 Jul 2020 10:46:51 +0200 Subject: [PATCH 1/2] Fix wrong phpdoc for execute method Signed-off-by: Daniel Kesselberg --- lib/private/BackgroundJob/Job.php | 3 ++- lib/private/BackgroundJob/TimedJob.php | 3 ++- lib/public/BackgroundJob/IJob.php | 2 +- 3 files changed, 5 insertions(+), 3 deletions(-) diff --git a/lib/private/BackgroundJob/Job.php b/lib/private/BackgroundJob/Job.php index f0b780d0c7..30326b6a4f 100644 --- a/lib/private/BackgroundJob/Job.php +++ b/lib/private/BackgroundJob/Job.php @@ -28,6 +28,7 @@ namespace OC\BackgroundJob; use OCP\BackgroundJob\IJob; +use OCP\BackgroundJob\IJobList; use OCP\ILogger; abstract class Job implements IJob { @@ -47,7 +48,7 @@ abstract class Job implements IJob { protected $argument; /** - * @param JobList $jobList + * @param IJobList $jobList * @param ILogger|null $logger */ public function execute($jobList, ILogger $logger = null) { diff --git a/lib/private/BackgroundJob/TimedJob.php b/lib/private/BackgroundJob/TimedJob.php index e5dfeb96c9..d33cdd90b3 100644 --- a/lib/private/BackgroundJob/TimedJob.php +++ b/lib/private/BackgroundJob/TimedJob.php @@ -25,6 +25,7 @@ namespace OC\BackgroundJob; +use OCP\BackgroundJob\IJobList; use OCP\ILogger; /** @@ -49,7 +50,7 @@ abstract class TimedJob extends Job { /** * run the job if * - * @param JobList $jobList + * @param IJobList $jobList * @param ILogger|null $logger */ public function execute($jobList, ILogger $logger = null) { diff --git a/lib/public/BackgroundJob/IJob.php b/lib/public/BackgroundJob/IJob.php index 985b5e973b..e9c8ddedee 100644 --- a/lib/public/BackgroundJob/IJob.php +++ b/lib/public/BackgroundJob/IJob.php @@ -38,7 +38,7 @@ interface IJob { /** * Run the background job with the registered argument * - * @param \OCP\BackgroundJob\IJobList $jobList The job list that manages the state of this job + * @param IJobList $jobList The job list that manages the state of this job * @param ILogger|null $logger * @since 7.0.0 */ From b1cdd0dd9b020d56a9e4bac97486aefc0d2e4d32 Mon Sep 17 00:00:00 2001 From: Morris Jobke Date: Mon, 6 Jul 2020 10:13:23 +0200 Subject: [PATCH 2/2] Use formal type hints instead of informal PHPDoc Signed-off-by: Morris Jobke --- lib/private/BackgroundJob/Job.php | 22 ++++++---------------- lib/public/BackgroundJob/IJob.php | 8 +++----- 2 files changed, 9 insertions(+), 21 deletions(-) diff --git a/lib/private/BackgroundJob/Job.php b/lib/private/BackgroundJob/Job.php index 30326b6a4f..a464ea2ba1 100644 --- a/lib/private/BackgroundJob/Job.php +++ b/lib/private/BackgroundJob/Job.php @@ -32,26 +32,16 @@ use OCP\BackgroundJob\IJobList; use OCP\ILogger; abstract class Job implements IJob { - /** - * @var int $id - */ + /** @var int */ protected $id; - /** - * @var int $lastRun - */ + /** @var int */ protected $lastRun; - /** - * @var mixed $argument - */ + /** @var mixed */ protected $argument; - /** - * @param IJobList $jobList - * @param ILogger|null $logger - */ - public function execute($jobList, ILogger $logger = null) { + public function execute(IJobList $jobList, ILogger $logger = null) { $jobList->setLastRun($this); if ($logger === null) { $logger = \OC::$server->getLogger(); @@ -77,11 +67,11 @@ abstract class Job implements IJob { abstract protected function run($argument); - public function setId($id) { + public function setId(int $id) { $this->id = $id; } - public function setLastRun($lastRun) { + public function setLastRun(int $lastRun) { $this->lastRun = $lastRun; } diff --git a/lib/public/BackgroundJob/IJob.php b/lib/public/BackgroundJob/IJob.php index e9c8ddedee..a61f70a3cf 100644 --- a/lib/public/BackgroundJob/IJob.php +++ b/lib/public/BackgroundJob/IJob.php @@ -42,19 +42,17 @@ interface IJob { * @param ILogger|null $logger * @since 7.0.0 */ - public function execute($jobList, ILogger $logger = null); + public function execute(IJobList $jobList, ILogger $logger = null); /** - * @param int $id * @since 7.0.0 */ - public function setId($id); + public function setId(int $id); /** - * @param int $lastRun * @since 7.0.0 */ - public function setLastRun($lastRun); + public function setLastRun(int $lastRun); /** * @param mixed $argument