Add a new backgroundjob class to access the type of background jobs easily

1 files changed, 52 insertions, 0 deletions

diff --git a/lib/backgroundjob.php b/lib/backgroundjob.php
new file mode 100644
index 00000000000..992a2484ea5
--- /dev/null
+++ b/lib/backgroundjob.php
@@ -0,0 +1,52 @@
+<?php
+/**
+* ownCloud
+*
+* @author Jakob Sack
+* @copyright 2012 Jakob Sack owncloud@jakobsack.de
+*
+* This library is free software; you can redistribute it and/or
+* modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
+* License as published by the Free Software Foundation; either
+* version 3 of the License, or any later version.
+*
+* This library 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 along with this library.  If not, see <http://www.gnu.org/licenses/>.
+*
+*/
+
+/**
+ * This class does the dirty work.
+ */
+class OC_BackgroundJob{
+	/**
+	 * @brief get the 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.
+	 */
+	public static function getType() {
+		return OC_Appconfig::getValue( 'core', 'backgroundjobs_mode', 'ajax' );
+	}
+	
+	/**
+	 * @brief sets the background jobs type
+	 * @param $type type of background jobs
+	 * @return boolean
+	 *
+	 * This method sets the type of the background jobs. Possible types are
+	 * "none", "ajax", "webcron", "cron"
+	 */
+	public static function setType( $type ) {
+		if( !in_array( $type, array('none', 'ajax', 'webcron', 'cron'))){
+			return false;
+		}
+		return OC_Appconfig::setValue( 'core', 'backgroundjobs_mode', $type );
+	}
+}