[Sommaire] [Imprimer]

   1  <?php
   2  /**************************************************************************\
   3  * eGroupWare - Workflow Agent's SO-layer (storage-object)                  *
   4  * http://www.egroupware.org                                                *
   5  * (c) 2005 by Regis leroy <regis.leroy@glconseil.com>                      *
   6  * --------------------------------------------                             *
   7  *  This program is free software; you can redistribute it and/or modify it *
   8  *  under the terms of the GNU General Public License as published by the   *
   9  *  Free Software Foundation; either version 2 of the License, or (at your  *
  10  *  option) any later version.                                              *
  11  \**************************************************************************/
  12  
  13  /* $Id: class.so_agent.inc.php 19830 2005-11-14 19:37:58Z regis_glc $ */
  14  
  15  /**
  16   * Abstract Class to store/read all agents data
  17   *
  18   * Creation and deletion of agents records are done by the workflow engine, not
  19   * by this class and her childs.
  20   *
  21   * @package workflow
  22   * @author regis.leroy@glconseil.com
  23   * @license GPL
  24   */
  25  
  26  class so_agent
  27  {
  28      //public functions
  29      var $public_functions = array(
  30          'read'    => true,
  31          'save'    => true,
  32      );
  33  
  34      var $wf_table = 'egw_wf_agent_';
  35      var $agent_table = '';
  36      
  37      // link to the global db-object
  38      var $db;
  39      
  40       // Constructor of the so_agent class
  41       //do not forget to call it (parent::so_agent();) in child classes
  42  	function so_agent()
  43      {
  44          $this->db =& $GLOBALS['egw']->db;
  45      }
  46      
  47      /**
  48       * @abstract read all agent datas from the database
  49       * @param $agent_id int id of the entry to read
  50       * @return array/boolean array with column => value pairs or false if entry not found
  51       */
  52  	function read($agent_id)
  53      {
  54          return false;
  55      }
  56  
  57      /**
  58       * @abstract save all agent datas to the database
  59       * @param $agent_id int id of the entry to save
  60       * @param $datas is an array containing columns => value pairs which will be saved for this agent
  61       * @return true if everything was ok, false else
  62       */
  63  	function save($agent_id, &$datas)
  64      {
  65          return false;
  66      }
  67  }