Source for file IOutputHandler.php

Documentation is available at IOutputHandler.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 IOutputHandler
  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 IEmbedmentOutputHandler
  31. */
  32. require_once("share/System/IEmbedmentOutputHandler.php");
  33.  
  34. /**
  35.  * class IOutputHandler, implement this if your plugin is and OutputHandler
  36.  */
  37. {
  38.  
  39.     /**
  40.     *Sets the complete unique identifier.
  41.     *
  42.     *@param string Idenfitifer Complete unique identifier.
  43.     *@access public
  44.     */
  45.     public function SetIdentifier($Identifier "");
  46.  
  47.     /** Aggregations: */
  48.  
  49.     /** Compositions: */
  50.  
  51.     /**
  52.      * Print an error code, if you use this method no other methods will be available.
  53.      *
  54.      * @param string msg The message you wish to print
  55.  
  56.      * @param int code The error code you wish to print eg. 404.
  57.  
  58.      * @return 
  59.      * @access public
  60.      */
  61.     public function PrintError$msg,  $code );
  62.     // end of member function PrintError
  63.  
  64.     
  65.     /**
  66.      * Set the title of the page
  67.      *
  68.      * @param string title Title of the page, channel etc.
  69.  
  70.      * @return 
  71.      * @access public
  72.      */
  73.     public function SetTitle$title );
  74.      // end of member function SetTitle
  75.  
  76.     
  77.     /**
  78.      * Diable the OutputHandler, do this if you wish to print binary data.
  79.      *
  80.      * @return 
  81.      * @access public
  82.      */
  83.     public function Disable);
  84.     // end of member function Disable
  85.  
  86.     
  87.     /**
  88.      * Gets to original identifier specified as <Namespace>/<PluginID>.<ext>
  89.      * Do this if you wish to extraxt the extention and parse manually.
  90.      *
  91.      * @return string 
  92.      * @access public
  93.      */
  94.     public function GetIdentifier);
  95.      // end of member function GetIdentifier
  96.  
  97.     
  98.     /**
  99.      * Print the content, should also be called from GetPage().
  100.      *
  101.      * @return 
  102.      * @access public
  103.      */
  104.     public function Parse);
  105.      // end of member function Parse
  106.  
  107.  
  108. // end of IOutputHandler
  109. ?>

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