Source for file IEmbedmentOutputHandler.php

Documentation is available at IEmbedmentOutputHandler.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 IEmbedmentOutputHandler
  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.  * Interface IEmbedmentOutputHandler, used for processing embedments
  36.  */
  37. interface IEmbedmentOutputHandler extends IPlugin
  38. {
  39.  
  40.     /** Aggregations: */
  41.  
  42.     /** Compositions: */
  43.  
  44.     /**
  45.      * Data provided by use of this method may be left out if the OutputHandler wishes
  46.      * to print something else the HTML, therefor don't add important information
  47.      * here.
  48.      *
  49.      * @param string line A line you wish to add to the header.
  50.  
  51.      * @return 
  52.      * @access public
  53.      */
  54.     public function ExtentHeader$line );
  55.  
  56.     /**
  57.      * Set the body if the page, read parameter documentation.
  58.      *
  59.      * @param string body Body of the page, or description of a channel.
  60.  
  61.      * @param array List Parse a list, use this feature if you wish to parse a list. This will also
  62.      *  enable to OutputHandler to print a feed. This parameter is optional, if set the
  63.      *  first parameter will define the description of the channel, and every body and
  64.      *  title in this array will define an entry.
  65.      *  Array layout:
  66.      *  [body,body,...]
  67.      *  or
  68.      *  [[title,body],[title,body],...]
  69.  
  70.      * @return 
  71.      * @access public
  72.      */
  73.     public function SetBody$body,  $List null );
  74.      // end of member function SetBody
  75.  
  76.  
  77.     
  78.     /**
  79.     *Gets content ready to be printed
  80.     *
  81.     *This does not include header, only the body content.
  82.     *
  83.     *@return string Content ready for print
  84.     */
  85.     public function GetContent();
  86.  
  87.     /**
  88.     *Gets the header extension
  89.     *
  90.     *@return string Lines to be added to the header
  91.     */
  92.     public function GetHeader();
  93.  
  94.             //Decleared in parents
  95.     /*  *
  96.      *
  97.      * @param CMS3_System Owner The CMS3_System that owns this plugin, gives the plugin ability to get data from
  98. CMS3_System
  99.  
  100.      * @return 
  101.      * @access public
  102.      */
  103.     //public function Register( $Owner );
  104.  
  105.     /*  *
  106.      * Gets the pluginID of the plugin.
  107.      *
  108.      * @return string
  109.      * @access public
  110.      */
  111.     //public function GetPluginID( );
  112.  
  113. // end of IEmbedmentOutputHandler
  114. ?>

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