From fd371700a26684f01da2f76fa29fc8f9b9140aec Mon Sep 17 00:00:00 2001 From: Roeland Jago Douma Date: Sat, 7 May 2016 12:15:59 +0200 Subject: Move \OCP\BackgroundJob to PSR-4 --- lib/public/BackgroundJob/IJob.php | 86 ++++++++++++++++++++++++++ lib/public/BackgroundJob/IJobList.php | 110 ++++++++++++++++++++++++++++++++++ lib/public/backgroundjob/ijob.php | 86 -------------------------- lib/public/backgroundjob/ijoblist.php | 110 ---------------------------------- 4 files changed, 196 insertions(+), 196 deletions(-) create mode 100644 lib/public/BackgroundJob/IJob.php create mode 100644 lib/public/BackgroundJob/IJobList.php delete mode 100644 lib/public/backgroundjob/ijob.php delete mode 100644 lib/public/backgroundjob/ijoblist.php diff --git a/lib/public/BackgroundJob/IJob.php b/lib/public/BackgroundJob/IJob.php new file mode 100644 index 00000000000..71cdee65636 --- /dev/null +++ b/lib/public/BackgroundJob/IJob.php @@ -0,0 +1,86 @@ + + * @author Morris Jobke + * @author Robin Appelman + * + * @copyright Copyright (c) 2016, ownCloud, Inc. + * @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 + * + */ + +namespace OCP\BackgroundJob; +use OCP\ILogger; + +/** + * Interface IJob + * + * @package OCP\BackgroundJob + * @since 7.0.0 + */ +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 ILogger $logger + * @since 7.0.0 + */ + public function execute($jobList, ILogger $logger = null); + + /** + * @param int $id + * @since 7.0.0 + */ + public function setId($id); + + /** + * @param int $lastRun + * @since 7.0.0 + */ + public function setLastRun($lastRun); + + /** + * @param mixed $argument + * @since 7.0.0 + */ + public function setArgument($argument); + + /** + * Get the id of the background job + * This id is determined by the job list when a job is added to the list + * + * @return int + * @since 7.0.0 + */ + public function getId(); + + /** + * Get the last time this job was run as unix timestamp + * + * @return int + * @since 7.0.0 + */ + public function getLastRun(); + + /** + * Get the argument associated with the background job + * This is the argument that will be passed to the background job + * + * @return mixed + * @since 7.0.0 + */ + public function getArgument(); +} diff --git a/lib/public/BackgroundJob/IJobList.php b/lib/public/BackgroundJob/IJobList.php new file mode 100644 index 00000000000..5a76ce1ba26 --- /dev/null +++ b/lib/public/BackgroundJob/IJobList.php @@ -0,0 +1,110 @@ + + * @author Morris Jobke + * @author Robin Appelman + * @author Robin McCorkell + * + * @copyright Copyright (c) 2016, ownCloud, Inc. + * @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 + * + */ + +namespace OCP\BackgroundJob; + +/** + * Interface IJobList + * + * @package OCP\BackgroundJob + * @since 7.0.0 + */ +interface IJobList { + /** + * Add a job to the list + * + * @param \OCP\BackgroundJob\IJob|string $job + * @param mixed $argument The argument to be passed to $job->run() when the job is exectured + * @since 7.0.0 + */ + public function add($job, $argument = null); + + /** + * Remove a job from the list + * + * @param \OCP\BackgroundJob\IJob|string $job + * @param mixed $argument + * @since 7.0.0 + */ + public function remove($job, $argument = null); + + /** + * check if a job is in the list + * + * @param \OCP\BackgroundJob\IJob|string $job + * @param mixed $argument + * @return bool + * @since 7.0.0 + */ + public function has($job, $argument); + + /** + * get all jobs in the list + * + * @return \OCP\BackgroundJob\IJob[] + * @since 7.0.0 + * @deprecated 9.0.0 - This method is dangerous since it can cause load and + * memory problems when creating too many instances. + */ + public function getAll(); + + /** + * get the next job in the list + * + * @return \OCP\BackgroundJob\IJob|null + * @since 7.0.0 + */ + public function getNext(); + + /** + * @param int $id + * @return \OCP\BackgroundJob\IJob|null + * @since 7.0.0 + */ + public function getById($id); + + /** + * set the job that was last ran to the current time + * + * @param \OCP\BackgroundJob\IJob $job + * @since 7.0.0 + */ + public function setLastJob($job); + + /** + * get the id of the last ran job + * + * @return int + * @since 7.0.0 + */ + public function getLastJob(); + + /** + * set the lastRun of $job to now + * + * @param \OCP\BackgroundJob\IJob $job + * @since 7.0.0 + */ + public function setLastRun($job); +} diff --git a/lib/public/backgroundjob/ijob.php b/lib/public/backgroundjob/ijob.php deleted file mode 100644 index 71cdee65636..00000000000 --- a/lib/public/backgroundjob/ijob.php +++ /dev/null @@ -1,86 +0,0 @@ - - * @author Morris Jobke - * @author Robin Appelman - * - * @copyright Copyright (c) 2016, ownCloud, Inc. - * @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 - * - */ - -namespace OCP\BackgroundJob; -use OCP\ILogger; - -/** - * Interface IJob - * - * @package OCP\BackgroundJob - * @since 7.0.0 - */ -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 ILogger $logger - * @since 7.0.0 - */ - public function execute($jobList, ILogger $logger = null); - - /** - * @param int $id - * @since 7.0.0 - */ - public function setId($id); - - /** - * @param int $lastRun - * @since 7.0.0 - */ - public function setLastRun($lastRun); - - /** - * @param mixed $argument - * @since 7.0.0 - */ - public function setArgument($argument); - - /** - * Get the id of the background job - * This id is determined by the job list when a job is added to the list - * - * @return int - * @since 7.0.0 - */ - public function getId(); - - /** - * Get the last time this job was run as unix timestamp - * - * @return int - * @since 7.0.0 - */ - public function getLastRun(); - - /** - * Get the argument associated with the background job - * This is the argument that will be passed to the background job - * - * @return mixed - * @since 7.0.0 - */ - public function getArgument(); -} diff --git a/lib/public/backgroundjob/ijoblist.php b/lib/public/backgroundjob/ijoblist.php deleted file mode 100644 index 5a76ce1ba26..00000000000 --- a/lib/public/backgroundjob/ijoblist.php +++ /dev/null @@ -1,110 +0,0 @@ - - * @author Morris Jobke - * @author Robin Appelman - * @author Robin McCorkell - * - * @copyright Copyright (c) 2016, ownCloud, Inc. - * @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 - * - */ - -namespace OCP\BackgroundJob; - -/** - * Interface IJobList - * - * @package OCP\BackgroundJob - * @since 7.0.0 - */ -interface IJobList { - /** - * Add a job to the list - * - * @param \OCP\BackgroundJob\IJob|string $job - * @param mixed $argument The argument to be passed to $job->run() when the job is exectured - * @since 7.0.0 - */ - public function add($job, $argument = null); - - /** - * Remove a job from the list - * - * @param \OCP\BackgroundJob\IJob|string $job - * @param mixed $argument - * @since 7.0.0 - */ - public function remove($job, $argument = null); - - /** - * check if a job is in the list - * - * @param \OCP\BackgroundJob\IJob|string $job - * @param mixed $argument - * @return bool - * @since 7.0.0 - */ - public function has($job, $argument); - - /** - * get all jobs in the list - * - * @return \OCP\BackgroundJob\IJob[] - * @since 7.0.0 - * @deprecated 9.0.0 - This method is dangerous since it can cause load and - * memory problems when creating too many instances. - */ - public function getAll(); - - /** - * get the next job in the list - * - * @return \OCP\BackgroundJob\IJob|null - * @since 7.0.0 - */ - public function getNext(); - - /** - * @param int $id - * @return \OCP\BackgroundJob\IJob|null - * @since 7.0.0 - */ - public function getById($id); - - /** - * set the job that was last ran to the current time - * - * @param \OCP\BackgroundJob\IJob $job - * @since 7.0.0 - */ - public function setLastJob($job); - - /** - * get the id of the last ran job - * - * @return int - * @since 7.0.0 - */ - public function getLastJob(); - - /** - * set the lastRun of $job to now - * - * @param \OCP\BackgroundJob\IJob $job - * @since 7.0.0 - */ - public function setLastRun($job); -} -- cgit v1.2.3