[CLEANUP] Add phpDoc to properties in ext:backend
[Packages/TYPO3.CMS.git] / typo3 / sysext / backend / Classes / Sprite / SpriteIconGeneratorInterface.php
1 <?php
2 namespace TYPO3\CMS\Backend\Sprite;
3
4 /**
5 * This file is part of the TYPO3 CMS project.
6 *
7 * It is free software; you can redistribute it and/or modify it under
8 * the terms of the GNU General Public License, either version 2
9 * of the License, or any later version.
10 *
11 * For the full copyright and license information, please read the
12 * LICENSE.txt file that was distributed with this source code.
13 *
14 * The TYPO3 project - inspiring people to share!
15 */
16
17 /**
18 * Interface all handlers in SpriteManager have to implement.
19 *
20 * @author Steffen Ritter <info@steffen-ritter.net>
21 */
22 interface SpriteIconGeneratorInterface {
23 /**
24 * the implementation of this function has to do the main task
25 * this function will be called if the extension list changed or
26 * registered icons in TBE_STYLES[spritemanager] changed
27 *
28 * @return void
29 */
30 public function generate();
31
32 /**
33 * The sprite manager will call this function after the call to "generate"
34 * it should return an array of all sprite-icon-names generated through the run
35 *
36 * @return array All generated/detected sprite-icon-names
37 */
38 public function getAvailableIconNames();
39
40 }