interface.t3lib_spritemanager_spriteicongenerator.php

Go to the documentation of this file.

<?php
/***************************************************************
 *  Copyright notice
 *
 *  (c) 2010-2011 Steffen Ritter <info@steffen-ritter.net>
 *  All rights reserved
 *
 *  This script is part of the TYPO3 project. The TYPO3 project 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
 *  (at your option) any later version.
 *
 *  The GNU General Public License can be found at
 *  http://www.gnu.org/copyleft/gpl.html.
 *  A copy is found in the textfile GPL.txt and important notices to the license
 *  from the author is found in LICENSE.txt distributed with these scripts.
 *
 *
 *  This script 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.
 *
 *  This copyright notice MUST APPEAR in all copies of the script!
 ***************************************************************/


/**
 * Interface all handlers in t3lib_spritemanager have to implement.
 *
 * @author  Steffen Ritter <info@steffen-ritter.net>
 * @package TYPO3
 * @subpackage t3lib
 */
interface t3lib_spritemanager_SpriteIconGenerator {

    /**
     * the implementation of this function has to do the main task
     * this function will be called if the extension list changed or
     * registered icons in TBE_STYLES[spritemanager] changed
     *
     * @return void
     */
    public function generate();

    /**
     * The sprite manager will call this function after the call to "generate"
     * it should return an array of all sprite-icon-names generated through the run
     *
     * @retun array all generated/detected sprite-icon-names
     */
    public function getAvailableIconNames();
}

?>