Source for file INFA_CLI_PROFILE.phpclass

Documentation is available at INFA_CLI_PROFILE.phpclass

  1. <?php
  2. /**
  3.   * openCSP class file INFA_CLI_PROFILE.phpclass
  4.   *
  5.   * @project Open CSP-Management
  6.   * @package default
  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-02.01.2009
  12.   * @version $Id:$
  13.   */
  14.  
  15.     // ---------------------------------------------------------
  16.     // requirements
  17.     // ---------------------------------------------------------
  18.  
  19. /**
  20.   * openCSP class INFA_CLI_PROFILE
  21.   *
  22.   * @project Open CSP-Management
  23.   * @package default
  24.   *
  25.   * @author Peter Krebs <pitlinz@users.sourceforge.net>
  26.   * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  27.   *
  28.   * @since pk-02.01.2009
  29.   * @version $Id$
  30.   */
  31. interface INFA_CLI_PROFILE
  32. {
  33.     // ---------------------------------------------------------------------------
  34.     // constants
  35.     // ---------------------------------------------------------------------------
  36.     
  37.     // ---------------------------------------------------------------------------
  38.     // class (static)
  39.     // ---------------------------------------------------------------------------
  40.     
  41.     /*** class vars ------------------------------------------------------ */
  42.     
  43.     /*** class methods --------------------------------------------------- */
  44.     
  45.     // ---------------------------------------------------------------------------
  46.     // object vars
  47.     // ---------------------------------------------------------------------------
  48.     
  49.     /*** compostion --------------------------------------------------- */
  50.     
  51.     /*** attributes  -------------------------------------------------- */
  52.     
  53.     // ---------------------------------------------------------------------------
  54.     // factory / construct
  55.     // ---------------------------------------------------------------------------
  56.     
  57.     // ---------------------------------------------------------------------------
  58.     // getter / setter
  59.     // ---------------------------------------------------------------------------    
  60.  
  61.     /**
  62.      * returns the id
  63.      *
  64.      * @return int 
  65.      ***/
  66.     function getId();    
  67.     
  68.     /**
  69.       * returns the entry table name
  70.       *
  71.       * @return string 
  72.       */
  73.     function getEntryTbl();    
  74.     
  75.     /* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ */
  76.     /*  ENTRY object Methods                                                 */
  77.     /* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ */
  78.     
  79.     /**
  80.       * @param int $aKey 
  81.       * @param int $idx 
  82.       * @param boolean $debug 
  83.       *
  84.       * @return CLI_PROFILE_ENTRY 
  85.       */
  86.     function getEntryObj($key=NULL,$idx=0,$debug=False);
  87.     
  88.     
  89. }
  90.  
  91. ?>

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