Source for file IConfigure.php

Documentation is available at IConfigure.php

  1. <?php     
  2. //          (F)
  3. // CMS3 - A Three Content Management System.
  4. // Copyright (C) 2007  Jop... (Jonas F. Jensen).
  5. // 
  6. // This program is free software; you can redistribute it and/or
  7. // modify it under the terms of the GNU General Public License
  8. // as published by the Free Software Foundation; either version 2
  9. // of the License, or (at your option) any later version.
  10. // 
  11. // This program is distributed in the hope that it will be useful,
  12. // but WITHOUT ANY WARRANTY; without even the implied warranty of
  13. // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14. // GNU General Public License for more details.
  15. //
  16. // You should have received a copy of the GNU General Public License
  17. // along with this program; if not, write to the Free Software
  18. // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  19.  
  20. /**
  21. *This file defines IConfigure
  22. *
  23. @package    System
  24. @author    Jonas F. Jensen <jopsen@gmail.com>
  25. @copyright    2007 Jonas F. Jensen.
  26. @license    http://www.gnu.org/licenses/gpl.txt
  27. */
  28.  
  29. /**
  30. *The interface defined in this file depends on IPlugin
  31. */
  32. require_once("share/System/IPlugin.php");
  33.  
  34. /**
  35.  * class IConfigure, implement this is your plugin should expose a configuration page.
  36.  */
  37. interface IConfigure extends IPlugin
  38. {
  39.  
  40.     /** Aggregations: */
  41.  
  42.     /** Compositions: */
  43.  
  44.     /**
  45.      * Gets a dojo based ajax guide for configuration of the plugin.
  46.      *
  47.      * @param IEmbedmentOutputHandler OutputHandler
  48.     * @param string Identifier String at the end of the URL
  49.      * @return IEmbedmentOutputHandler 
  50.      * @access public
  51.      */
  52.     public function &Configure($Identifier null&$OutputHandler);
  53.  
  54.     /**
  55.     * Gets an absolute address of an icon for this plugin
  56.     */
  57.     public function GetControlCenterIcon();
  58.  
  59.     /**
  60.     * Gets menu entry string
  61.     */
  62.     public function GetControlCenterMenuEntry();
  63. // end of IConfigure
  64. ?>

Documentation generated on Mon, 30 Apr 2007 01:59:13 +0200 by phpDocumentor 1.3.1