diff options
Diffstat (limited to 'lib/public/BackgroundJob/IJob.php')
| -rw-r--r-- | lib/public/BackgroundJob/IJob.php | 50 |
1 files changed, 25 insertions, 25 deletions
diff --git a/lib/public/BackgroundJob/IJob.php b/lib/public/BackgroundJob/IJob.php index 3c2da42bf88..28a7df1c377 100644 --- a/lib/public/BackgroundJob/IJob.php +++ b/lib/public/BackgroundJob/IJob.php @@ -1,35 +1,19 @@ <?php + /** - * @copyright Copyright (c) 2016, ownCloud, Inc. - * - * @author Christoph Wurst <christoph@winzerhof-wurst.at> - * @author Daniel Kesselberg <mail@danielkesselberg.de> - * @author Joas Schilling <coding@schilljs.com> - * @author Lukas Reschke <lukas@statuscode.ch> - * @author Morris Jobke <hey@morrisjobke.de> - * @author Robin Appelman <robin@icewind.nl> - * - * @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/> - * + * SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors + * SPDX-FileCopyrightText: 2016 ownCloud, Inc. + * SPDX-License-Identifier: AGPL-3.0-only */ namespace OCP\BackgroundJob; use OCP\ILogger; /** - * Interface IJob + * This interface represents a background job run with cron + * + * To implement a background job, you must extend either \OCP\BackgroundJob\Job, + * \OCP\BackgroundJob\TimedJob or \OCP\BackgroundJob\QueuedJob * * @since 7.0.0 */ @@ -49,8 +33,24 @@ interface IJob { * @param IJobList $jobList The job list that manages the state of this job * @param ILogger|null $logger * @since 7.0.0 + * @deprecated 25.0.0 Use start() instead. This method will be removed + * with the ILogger interface + */ + public function execute(IJobList $jobList, ?ILogger $logger = null); + + /** + * Start the background job with the registered argument + * + * This methods will take care of running the background job, of initializing + * the state and cleaning up the job list after running the job. + * + * For common background job scenario, you will want to use TimedJob or QueuedJob + * instead of overwritting this method. + * + * @param IJobList $jobList The job list that manages the state of this job + * @since 25.0.0 */ - public function execute(IJobList $jobList, ILogger $logger = null); + public function start(IJobList $jobList): void; /** * @since 7.0.0 |