aboutsummaryrefslogtreecommitdiff
path: root/lib/cronjobs/purge_cache.php
diff options
context:
space:
mode:
Diffstat (limited to 'lib/cronjobs/purge_cache.php')
-rw-r--r--lib/cronjobs/purge_cache.php92
1 files changed, 92 insertions, 0 deletions
diff --git a/lib/cronjobs/purge_cache.php b/lib/cronjobs/purge_cache.php
new file mode 100644
index 0000000..2e253e1
--- /dev/null
+++ b/lib/cronjobs/purge_cache.php
@@ -0,0 +1,92 @@
+<?php
+/**
+ * purge_cache.php - Purges the file cache.
+ *
+ * @author André Noack <noack@data-quest.de>, Suchi & Berg GmbH <info@data-quest.de>
+ * @author Jan-Hendrik Willms <tleilax+studip@gmail.com>
+ * @access public
+ * @since 2.4
+ */
+
+// +---------------------------------------------------------------------------+
+// This file is part of Stud.IP
+// purge_cache.php
+//
+// Copyright (C) 2013 Jan-Hendrik Willms <tleilax+studip@gmail.com>
+// +---------------------------------------------------------------------------+
+// This program is free software; you can redistribute it and/or
+// modify it under the terms of the GNU General Public License
+// as published by the Free Software Foundation; either version 2
+// of the License, or any later version.
+// +---------------------------------------------------------------------------+
+// 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 General Public License for more details.
+// You should have received a copy of the GNU General Public License
+// along with this program; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+// +---------------------------------------------------------------------------+
+
+require_once 'lib/classes/CronJob.php';
+
+class PurgeCacheJob extends CronJob
+{
+ /**
+ * Returns the name of the cronjob.
+ */
+ public static function getName()
+ {
+ return _('Dateicache leeren');
+ }
+
+ /**
+ * Returns the description of the cronjob.
+ */
+ public static function getDescription()
+ {
+ return _('Leert den dateibasierten Cache');
+ }
+
+ /**
+ * Return the paremeters for this cronjob.
+ *
+ * @return Array Parameters.
+ */
+ public static function getParameters()
+ {
+ return [
+ 'verbose' => [
+ 'type' => 'boolean',
+ 'default' => false,
+ 'status' => 'optional',
+ 'description' => _('Sollen Ausgaben erzeugt werden (sind später im Log des Cronjobs sichtbar)'),
+ ],
+ ];
+ }
+
+ /**
+ * Setup method. Loads the neccessary classes.
+ */
+ public function setUp()
+ {
+ require_once 'lib/classes/cache/FileCache.php';
+ }
+
+ /**
+ * Execute the cronjob.
+ *
+ * @param mixed $last_result What the last execution of this cronjob
+ * returned.
+ * @param Array $parameters Parameters for this cronjob instance which
+ * were defined during scheduling.
+ * Only valid parameter at the moment is
+ * "verbose" which toggles verbose output while
+ * purging the cache.
+ */
+ public function execute($last_result, $parameters = [])
+ {
+ $cache = new \Studip\Cache\FileCache();
+ $cache->purge(empty($parameters['verbose']));
+ }
+}