Source for file INFA_MODULE.phpclass

Documentation is available at INFA_MODULE.phpclass

  1. <?php
  2. /**
  3.   * openCSP interface file
  4.   *
  5.   * @project Open CSP-Management
  6.   * @package modules
  7.   *
  8.   * @author Peter Krebs <pitlinz@users.sourceforge.net>
  9.   * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  10.   *
  11.   * @since pk-24.03.2008
  12.   * @version $Id: INFA_MODULE.phpclass,v 1.1 2008/06/13 15:30:17 pitlinz Exp $
  13.   ***/
  14.  
  15. // ---------------------------------------------------------
  16. // requirements
  17. // ---------------------------------------------------------
  18.  
  19. if (!class_exists('OCSP_OBJ'))
  20. {
  21.     require_once __OCSP_PHPINCPATH__ . "common" . _OCSP_DIRSEP_ . "OCSP_OBJ.phpclass";
  22. }
  23.  
  24. /**
  25.   * openCSP interface
  26.   *
  27.   * @project Open CSP-Management
  28.   * @package modules
  29.   *
  30.   * @author Peter Krebs <pitlinz@users.sourceforge.net>
  31.   * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  32.   *
  33.   * @since pk-24.03.2008
  34.   * @version $Id: INFA_MODULE.phpclass,v 1.1 2008/06/13 15:30:17 pitlinz Exp $
  35.   ***/
  36. interface INFA_MODULE
  37. {
  38.     /*** class constants  --------------------------------------------- */
  39.  
  40.     /*** class variables  --------------------------------------------- */
  41.     
  42.     /*** compostion --------------------------------------------------- */
  43.     
  44.     /*** attributes  -------------------------------------------------- */
  45.  
  46.     /*** static function  --------------------------------------------- */
  47.     
  48.     /**
  49.      * factory a module object out of the environment ($_GET,$_POST ....)
  50.      * 
  51.      * @param boolean $debug 
  52.      * 
  53.      * @return INFA_MODULE object
  54.      */
  55.     public static function factoryFromEnv($debug=false);
  56.         
  57.     /**
  58.      * returns the instance
  59.      *
  60.      * @param boolean $debug 
  61.      * 
  62.      * @return INFA_MODULE object
  63.      */
  64.     public static function getInstance($debug=false);
  65.     
  66.     /*** getter / setter  --------------------------------------------- */
  67.  
  68.     /**
  69.      * returns the module configuration object
  70.      *
  71.      * @return OCSP_MOD_CONF 
  72.      */
  73.     public function getMyModConf();
  74.     
  75.     /**
  76.      * sets the module configuration object
  77.      *
  78.      * @param OCSP_MOD_CONF $aConfObj 
  79.      */
  80.     public function setMyModConf($aConfObj);
  81.     
  82.     /*** path methods  ------------------------------------------------ */
  83.  
  84.     /**
  85.      * returns the module path
  86.      * 
  87.      * @return string 
  88.      */
  89.     public function getModulePath();    
  90.     
  91.     /**
  92.      * requires a module file
  93.      *
  94.      * @param string $file 
  95.      * @param boolean $debug 
  96.      */
  97.     public function requireFile($file,$debug=false);
  98.     
  99.     /*** front controller  -------------------------------------------- */
  100.     
  101.     /**
  102.      * adds the content of the current module to $aPageObj
  103.      * if $aPageObj is null a new page object is created
  104.      *
  105.      * @param OCSP_HTMLPAGE $aPageObj 
  106.      * @param boolean $debug 
  107.      * 
  108.      * @return OCSP_HTMLPAGE) 
  109.      */
  110.     public function fc_getContent($aPageObj=NULL,$debug=false);
  111.  
  112.     
  113. }
  114.  
  115. ?>

Documentation generated on Thu, 08 Jan 2009 17:44:27 +0100 by phpDocumentor 1.4.0a2