QueuedJob.php 1.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859
  1. <?php
  2. declare(strict_types=1);
  3. /**
  4. * @copyright Copyright (c) 2018, Roeland Jago Douma <roeland@famdouma.nl>
  5. *
  6. * @author Roeland Jago Douma <roeland@famdouma.nl>
  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. namespace OCP\BackgroundJob;
  25. use OCP\ILogger;
  26. /**
  27. * Simple base class for a one time background job
  28. *
  29. * @since 15.0.0
  30. */
  31. abstract class QueuedJob extends Job {
  32. /**
  33. * Run the job, then remove it from the joblist
  34. *
  35. * @param IJobList $jobList
  36. * @param ILogger|null $logger
  37. *
  38. * @since 15.0.0
  39. * @deprecated since 25.0.0 Use start() instead. This method will be removed
  40. * with the ILogger interface
  41. */
  42. final public function execute($jobList, ?ILogger $logger = null) {
  43. $this->start($jobList);
  44. }
  45. /**
  46. * Run the job, then remove it from the joblist
  47. *
  48. * @since 25.0.0
  49. */
  50. final public function start(IJobList $jobList): void {
  51. $jobList->remove($this, $this->argument);
  52. parent::start($jobList);
  53. }
  54. }