Source for file IPlugin.php

Documentation is available at IPlugin.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 IPlugin
  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.  * class IPlugin, this minimum requirement for a plugin
  31.  */
  32. interface IPlugin
  33. {
  34.  
  35.     /** Aggregations: */
  36.  
  37.     /** Compositions: */
  38.  
  39.     /**
  40.      *
  41.      * @param CMS3_MainClass Owner The CMS3_MainClass that owns this plugin, gives the plugin ability to get data from
  42. CMS3_MainClass
  43.  
  44.      * @return 
  45.      * @access public
  46.      */
  47.     public function Register&$Owner );
  48.  
  49.     /**
  50.      * Gets the pluginID of the plugin.
  51.      *
  52.      * @return string 
  53.      * @access public
  54.      */
  55.     public function GetPluginID);
  56.  
  57.  
  58. // end of IPlugin
  59. ?>

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