aboutsummaryrefslogtreecommitdiffstats
path: root/lib/public/BackgroundJob/IJobList.php
diff options
context:
space:
mode:
Diffstat (limited to 'lib/public/BackgroundJob/IJobList.php')
-rw-r--r--lib/public/BackgroundJob/IJobList.php8
1 files changed, 4 insertions, 4 deletions
diff --git a/lib/public/BackgroundJob/IJobList.php b/lib/public/BackgroundJob/IJobList.php
index 396a28fc120..f200988695d 100644
--- a/lib/public/BackgroundJob/IJobList.php
+++ b/lib/public/BackgroundJob/IJobList.php
@@ -108,11 +108,11 @@ interface IJobList {
public function getJobsIterator($job, ?int $limit, int $offset): iterable;
/**
- * get the next job in the list
+ * Get the next job in the list
*
* @param bool $onlyTimeSensitive Whether we get only time sensitive jobs or not
- * @param array|null $jobClasses List of job classes to restrict which next job we get
- * @return IJob|null
+ * @param class-string<IJob>[]|null $jobClasses List of job classes to restrict which next job we get
+ * @return ?IJob the next job to run. Beware that this object may be a singleton and may be modified by the next call to buildJob.
* @since 7.0.0 - In 24.0.0 parameter $onlyTimeSensitive got added; In 30.0.0 parameter $jobClasses got added
*/
public function getNext(bool $onlyTimeSensitive = false, ?array $jobClasses = null): ?IJob;
@@ -176,7 +176,7 @@ interface IJobList {
* Returns a count of jobs per Job class
*
* @return list<array{class:class-string, count:int}>
- * @since 29.0.0
+ * @since 30.0.0
*/
public function countByClass(): array;
}