diff options
author | Morris Jobke <hey@morrisjobke.de> | 2018-01-26 00:14:00 +0100 |
---|---|---|
committer | Morris Jobke <hey@morrisjobke.de> | 2018-01-26 10:43:01 +0100 |
commit | 9ef6148bfabea0581a0fb4b696d17c1d7379754a (patch) | |
tree | 3a1b98c74b8186d76cfa8fee102bf628d7ce9f78 /lib/public/BackgroundJob.php | |
parent | b9bbb894f8b01e000bb5e3a8a82db7bebad3ea00 (diff) | |
download | nextcloud-server-9ef6148bfabea0581a0fb4b696d17c1d7379754a.tar.gz nextcloud-server-9ef6148bfabea0581a0fb4b696d17c1d7379754a.zip |
Deprecated OCP interface to fetch background job type
* was not used by apps and also is not needed
* migrated the documentation to IJobList
Signed-off-by: Morris Jobke <hey@morrisjobke.de>
Diffstat (limited to 'lib/public/BackgroundJob.php')
-rw-r--r-- | lib/public/BackgroundJob.php | 45 |
1 files changed, 5 insertions, 40 deletions
diff --git a/lib/public/BackgroundJob.php b/lib/public/BackgroundJob.php index d343ae2531c..9e37ff30145 100644 --- a/lib/public/BackgroundJob.php +++ b/lib/public/BackgroundJob.php @@ -25,67 +25,32 @@ * */ -/** - * Public interface of ownCloud for background jobs. - */ - -// use OCP namespace for all classes that are considered public. -// This means that they should be used by apps instead of the internal ownCloud classes namespace OCP; - /** - * This class provides functions to register backgroundjobs in ownCloud - * - * To create a new backgroundjob create a new class that inherits from either \OC\BackgroundJob\Job, - * \OC\BackgroundJob\QueuedJob or \OC\BackgroundJob\TimedJob and register it using - * \OCP\BackgroundJob->registerJob($job, $argument), $argument will be passed to the run() function - * of the job when the job is executed. - * - * A regular Job will be executed every time cron.php is run, a QueuedJob will only run once and a TimedJob - * will only run at a specific interval which is to be specified in the constructor of the job by calling - * $this->setInterval($interval) with $interval in seconds. * @since 4.5.0 + * @deprecated 14.0.0 */ class BackgroundJob { /** - * get the execution type of background jobs - * - * @return string - * - * This method returns the type how background jobs are executed. If the user - * did not select something, the type is ajax. * @since 5.0.0 + * @deprecated 14.0.0 */ public static function getExecutionType() { - return \OC::$server->getConfig()->getAppValue('core', 'backgroundjobs_mode', 'ajax'); + return ''; } /** - * sets the background jobs execution type - * - * @param string $type execution type - * @return false|null - * - * This method sets the execution type of the background jobs. Possible types - * are "none", "ajax", "webcron", "cron" * @since 5.0.0 + * @deprecated 14.0.0 */ public static function setExecutionType($type) { - if( !in_array( $type, array('none', 'ajax', 'webcron', 'cron'))) { - return false; - } - \OC::$server->getConfig()->setAppValue('core', 'backgroundjobs_mode', $type); } /** - * @param string $job - * @param mixed $argument - * @deprecated 8.1.0 Use \OC::$server->getJobList()->add() instead * @since 6.0.0 + * @deprecated 8.1.0 Use \OC::$server->getJobList()->add() instead */ public static function registerJob($job, $argument = null) { - $jobList = \OC::$server->getJobList(); - $jobList->add($job, $argument); } } |