Source for file CMS3_Help_IProvidesHelp.php

Documentation is available at CMS3_Help_IProvidesHelp.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 CMS3_Help_IProvidesHelp
  22. *
  23. @package    Help
  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. *A plugin that implements this interfaces exposes data that will be available for the Help plugin.
  36. */
  37. interface CMS3_Help_IProvidesHelp extends IPlugin
  38. {
  39.     /**
  40.     *Gets a list of the help available for this plugin
  41.     *
  42.     *This method returns a list of toplevel subjects, only one or two toplevel subjects, each toplevel subject is an array with 3 fields number zero a title, number one the body text of the help page (in HTML) and number 2 is an array of subsubjects. Each subsubject consists of the same as the toplevel subjects.
  43.     *
  44.     *Return array List of help subjects and subsubjects
  45.     */
  46.     public function GetHelp();
  47. }
  48.  
  49.  
  50.  
  51. ?>

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