Source for file INFA_MODULECLASS.phpclass

Documentation is available at INFA_MODULECLASS.phpclass

  1. <?php
  2. /**
  3.   * openCSP class file INFA_MODULECLASS.phpclass
  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-25.06.2008
  12.   * @version $Id: INFA_MODULECLASS.phpclass,v 1.1 2008/06/27 13:59:25 pitlinz Exp $
  13.   */
  14.  
  15.     // ---------------------------------------------------------
  16.     // requirements
  17.     // ---------------------------------------------------------
  18.  
  19.     pcf_require_class('OCSP_OBJ',__OCSP_PHPINCPATH__ . "common/OCSP_OBJ.phpclass");
  20.  
  21. /**
  22.   * openCSP class INFA_MODULECLASS
  23.   *
  24.   * @project Open CSP-Management
  25.   * @package modules
  26.   *
  27.   * @author Peter Krebs <pitlinz@users.sourceforge.net>
  28.   * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  29.   *
  30.   * @since pk-25.06.2008
  31.   * @version $Id: INFA_MODULECLASS.phpclass,v 1.1 2008/06/27 13:59:25 pitlinz Exp $
  32.   */
  33. interface INFA_MODULECLASS
  34. {
  35.     // ---------------------------------------------------------------------------
  36.     // constants
  37.     // ---------------------------------------------------------------------------
  38.     
  39.  
  40.     // ---------------------------------------------------------------------------
  41.     // class (static)
  42.     // ---------------------------------------------------------------------------
  43.     
  44.     /*** class vars ------------------------------------------------------ */
  45.     
  46.     /*** class methods --------------------------------------------------- */
  47.     
  48.     // ---------------------------------------------------------------------------
  49.     // object vars
  50.     // ---------------------------------------------------------------------------
  51.     
  52.     /*** compostion --------------------------------------------------- */
  53.     
  54.     /*** attributes  -------------------------------------------------- */
  55.     
  56.     // ---------------------------------------------------------------------------
  57.     // factory / construct
  58.     // ---------------------------------------------------------------------------
  59.     
  60.     // ---------------------------------------------------------------------------
  61.     // getter / setter
  62.     // ---------------------------------------------------------------------------    
  63.  
  64.     /**
  65.      * returns the module prefix
  66.      * @return string 
  67.      */
  68.     public function getModulePrefix();
  69.     
  70.     /**
  71.      * returns the module object
  72.      *
  73.      * @param boolean $debug 
  74.      * 
  75.      * @return OCSP_MODULE 
  76.      */
  77.     public function getModuleObj($debug=False);
  78. }
  79.  
  80. ?>

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