[FEATURE] Grouping for scheduler-jobs
[Packages/TYPO3.CMS.git] / typo3 / sysext / scheduler / Classes / Task / CachingFrameworkGarbageCollectionTask.php
1 <?php
2 namespace TYPO3\CMS\Scheduler\Task;
3
4 /***************************************************************
5 * Copyright notice
6 *
7 * (c) 2009-2013 Christian Kuhn <lolli@schwarzbu.ch>
8 * All rights reserved
9 *
10 * This script is part of the TYPO3 project. The TYPO3 project is
11 * free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
15 *
16 * The GNU General Public License can be found at
17 * http://www.gnu.org/copyleft/gpl.html.
18 *
19 * This script is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 * GNU General Public License for more details.
23 *
24 * This copyright notice MUST APPEAR in all copies of the script!
25 ***************************************************************/
26 /**
27 * Garbage collection of caching framework cache backends.
28 *
29 * This task finds all configured caching framework caches and
30 * calls the garbage collection of a cache if the cache backend
31 * is configured to be cleaned.
32 *
33 * @author Christian Kuhn <lolli@schwarzbu.ch>
34 */
35 class CachingFrameworkGarbageCollectionTask extends \TYPO3\CMS\Scheduler\Task\AbstractTask {
36
37 /**
38 * Backend types that should be cleaned up,
39 * set by additional field provider.
40 *
41 * @var array Selected backends to do garbage collection for
42 */
43 public $selectedBackends = array();
44
45 /**
46 * Execute garbage collection, called by scheduler.
47 *
48 * @return boolean
49 */
50 public function execute() {
51 // Global sub-array with all configured caches
52 $cacheConfigurations = $GLOBALS['TYPO3_CONF_VARS']['SYS']['caching']['cacheConfigurations'];
53 if (is_array($cacheConfigurations)) {
54 // Iterate through configured caches and call garbage collection if
55 // backend is within selected backends in additonal field of task
56 foreach ($cacheConfigurations as $cacheName => $cacheConfiguration) {
57 // The cache backend used for this cache
58 $usedCacheBackend = $cacheConfiguration['backend'];
59 if (in_array($usedCacheBackend, $this->selectedBackends)) {
60 $GLOBALS['typo3CacheManager']->getCache($cacheName)->collectGarbage();
61 }
62 }
63 }
64 return TRUE;
65 }
66
67 }