includes/class_logging.php

   1 <?php
   2 /*=====================================================================*\
   3 || ###################################################################
   4 || # Bugdar [#]version[#]
   5 || # Copyright ©2002-[#]year[#] Iris Studios, Inc.
   6 || #
   7 || # This program is free software; you can redistribute it and/or modify
   8 || # it under the terms of the GNU General Public License as published by
   9 || # the Free Software Foundation; version [#]gpl[#] of the License.
  10 || #
  11 || # This program is distributed in the hope that it will be useful, but
  12 || # WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  13 || # or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
  14 || # more details.
  15 || #
  16 || # You should have received a copy of the GNU General Public License along
  17 || # with this program; if not, write to the Free Software Foundation, Inc.,
  18 || # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
  19 || ###################################################################
  20 \*=====================================================================*/
  21
  22 /*
  23 A USEFUL QUERY:
  24
  25 DELETE FROM history WHERE field IN ('lastposttime', 'lastpostby', 'hiddenlastposttime', 'hiddenlastpostby')
  26
  27 */
  28
  29 /**
  30 * Bug Change Logging
  31 *
  32 * This class is used to record changes in a bug's fields, comments, and
  33 * attachments.
  34 *
  35 * @author               Iris Studios, Inc.
  36 * @copyright    Copyright ©2002 - [#]year[#], Iris Studios, Inc.
  37 * @version              $Revision$
  38 * @package              Bugdar
  39 *
  40 */
  41 class Logging
  42 {
  43         /**
  44         * Bug ID
  45         * @var  integer
  46         * @access       private
  47         */
  48         var $bugid = 0;
  49
  50         /**
  51         * The original data to compare against
  52         * @var  array
  53         * @access       private
  54         */
  55         var $original = array();
  56
  57         /**
  58         * Modified data
  59         * @var  array
  60         * @access       private
  61         */
  62         var $modified = array();
  63
  64         // ###################################################################
  65         /**
  66         * Sets the bug ID for the current logging instance
  67         *
  68         * @access       public
  69         *
  70         * @param        integer New bug ID
  71         */
  72         function set_bugid($newbugid)
  73         {
  74                 $this->bugid = $newbugid;
  75         }
  76
  77         // ###################################################################
  78         /**
  79         * Assigns data into the $this->original or $this->modified array based
  80         * on the passed arrays of information and the fields to add (and what
  81         * name to add them under), and any prefix
  82         *
  83         * @access       public
  84         *
  85         * @param        bool    TRUE for original, FALSE for modified
  86         * @param        array   Data array
  87         * @param        array   List of fields in the data array to add; in format of array('field name' => 'display name', 'display name 2', 'display name 3')
  88         * @param        bool    If TRUE, then the list of fields is used to exclude, not include
  89         * @param        string  Field prefix
  90         */
  91         function add_data($orig, $data, $fields, $exclude = false,  $prefix = '')
  92         {
  93                 $array = ($orig ? 'original' : 'modified');
  94                 $prefix .= '.';
  95
  96                 if ($exclude == false)
  97                 {
  98                         foreach ($fields AS $fname => $fdisplay)
  99                         {
 100                                 if (is_numeric($fname))
 101                                 {
 102                                         $fname = $fdisplay;
 103                                 }
 104
 105                                 $this->{$array}["$prefix$fdisplay"] = array('name' => $fname, 'value' => $data["$fname"]);
 106                         }
 107                 }
 108                 else
 109                 {
 110                         foreach ($data AS $fname => $value)
 111                         {
 112                                 if (!in_array($fname, $fields))
 113                                 {
 114                                         $this->{$array}["$prefix$fname"] = array('name' => $fname, 'value' => $value);
 115                                 }
 116                         }
 117                 }
 118         }
 119 }
 120
 121 /*=====================================================================*\
 122 || ###################################################################
 123 || # $HeadURL$
 124 || # $Id$
 125 || ###################################################################
 126 \*=====================================================================*/
 127 ?>