[TASK] Clean up the phpDoc of t3lib/spritemanager/
[Packages/TYPO3.CMS.git] / t3lib / spritemanager / class.t3lib_spritemanager_spritebuildinghandler.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 2010-2011 Steffen Ritter <info@steffen-ritter.net>
6 * All rights reserved
7 *
8 * This script is part of the TYPO3 project. The TYPO3 project is
9 * free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
13 *
14 * The GNU General Public License can be found at
15 * http://www.gnu.org/copyleft/gpl.html.
16 * A copy is found in the textfile GPL.txt and important notices to the license
17 * from the author is found in LICENSE.txt distributed with these scripts.
18 *
19 *
20 * This script is distributed in the hope that it will be useful,
21 * but WITHOUT ANY WARRANTY; without even the implied warranty of
22 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 * GNU General Public License for more details.
24 *
25 * This copyright notice MUST APPEAR in all copies of the script!
26 ***************************************************************/
27
28 /**
29 *
30 * @author Steffen Ritter <info@steffen-ritter.net>
31 * @package TYPO3
32 * @subpackage t3lib
33 */
34 class t3lib_spritemanager_SpriteBuildingHandler extends t3lib_spritemanager_AbstractHandler {
35
36 /**
37 * @var t3lib_spritemanager_SpriteGenerator
38 */
39 protected $generatorInstance = NULL;
40
41 /**
42 * Interface function. This will be called from the sprite manager to
43 * refresh all caches.
44 *
45 * @return void
46 */
47 public function generate() {
48 $this->generatorInstance = t3lib_div::makeInstance('t3lib_spritemanager_SpriteGenerator', 'GeneratorHandler');
49 $this->generatorInstance
50 ->setOmmitSpriteNameInIconName(TRUE)
51 ->setIncludeTimestampInCSS(TRUE)
52 ->setSpriteFolder(t3lib_SpriteManager::$tempPath)
53 ->setCSSFolder(t3lib_SpriteManager::$tempPath);
54
55 $iconsToProcess = array_merge(
56 (array) $GLOBALS['TBE_STYLES']['spritemanager']['singleIcons'],
57 $this->collectTcaSpriteIcons()
58 );
59
60 foreach ($iconsToProcess as $iconName => $iconFile) {
61 $iconsToProcess[$iconName] = t3lib_div::resolveBackPath('typo3/' . $iconFile);
62 }
63
64 $generatorResponse = $this->generatorInstance->generateSpriteFromArray($iconsToProcess);
65
66 $this->iconNames = array_merge($this->iconNames, $generatorResponse['iconNames']);
67
68 parent::generate();
69 }
70 }
71
72 ?>