crm.fsf.org/20131203/files/sites/all/modules-old/civicrm/CRM/Core/DAO/Log.php

   1 <?php
   2 /*
   3 +--------------------------------------------------------------------+
   4 | CiviCRM version 4.6                                                |
   5 +--------------------------------------------------------------------+
   6 | Copyright CiviCRM LLC (c) 2004-2015                                |
   7 +--------------------------------------------------------------------+
   8 | This file is a part of CiviCRM.                                    |
   9 |                                                                    |
  10 | CiviCRM is free software; you can copy, modify, and distribute it  |
  11 | under the terms of the GNU Affero General Public License           |
  12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13 |                                                                    |
  14 | CiviCRM is distributed in the hope that it will be useful, but     |
  15 | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17 | See the GNU Affero General Public License for more details.        |
  18 |                                                                    |
  19 | You should have received a copy of the GNU Affero General Public   |
  20 | License and the CiviCRM Licensing Exception along                  |
  21 | with this program; if not, contact CiviCRM LLC                     |
  22 | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23 | GNU Affero General Public License or the licensing of CiviCRM,     |
  24 | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25 +--------------------------------------------------------------------+
  26 */
  27 /**
  28  * @package CRM
  29  * @copyright CiviCRM LLC (c) 2004-2015
  30  *
  31  * Generated from xml/schema/CRM/Core/Log.xml
  32  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
  33  */
  34 require_once 'CRM/Core/DAO.php';
  35 require_once 'CRM/Utils/Type.php';
  36 class CRM_Core_DAO_Log extends CRM_Core_DAO {
  37   /**
  38    * static instance to hold the table name
  39    *
  40    * @var string
  41    */
  42   static $_tableName = 'civicrm_log';
  43   /**
  44    * static instance to hold the field values
  45    *
  46    * @var array
  47    */
  48   static $_fields = null;
  49   /**
  50    * static instance to hold the keys used in $_fields for each field.
  51    *
  52    * @var array
  53    */
  54   static $_fieldKeys = null;
  55   /**
  56    * static instance to hold the FK relationships
  57    *
  58    * @var string
  59    */
  60   static $_links = null;
  61   /**
  62    * static instance to hold the values that can
  63    * be imported
  64    *
  65    * @var array
  66    */
  67   static $_import = null;
  68   /**
  69    * static instance to hold the values that can
  70    * be exported
  71    *
  72    * @var array
  73    */
  74   static $_export = null;
  75   /**
  76    * static value to see if we should log any modifications to
  77    * this table in the civicrm_log table
  78    *
  79    * @var boolean
  80    */
  81   static $_log = false;
  82   /**
  83    * Log ID
  84    *
  85    * @var int unsigned
  86    */
  87   public $id;
  88   /**
  89    * Name of table where item being referenced is stored.
  90    *
  91    * @var string
  92    */
  93   public $entity_table;
  94   /**
  95    * Foreign key to the referenced item.
  96    *
  97    * @var int unsigned
  98    */
  99   public $entity_id;
 100   /**
 101    * Updates does to this object if any.
 102    *
 103    * @var text
 104    */
 105   public $data;
 106   /**
 107    * FK to Contact ID of person under whose credentials this data modification was made.
 108    *
 109    * @var int unsigned
 110    */
 111   public $modified_id;
 112   /**
 113    * When was the referenced entity created or modified or deleted.
 114    *
 115    * @var datetime
 116    */
 117   public $modified_date;
 118   /**
 119    * class constructor
 120    *
 121    * @return civicrm_log
 122    */
 123   function __construct() {
 124     $this->__table = 'civicrm_log';
 125     parent::__construct();
 126   }
 127   /**
 128    * Returns foreign keys and entity references
 129    *
 130    * @return array
 131    *   [CRM_Core_Reference_Interface]
 132    */
 133   static function getReferenceColumns() {
 134     if (!self::$_links) {
 135       self::$_links = static ::createReferenceColumns(__CLASS__);
 136       self::$_links[] = new CRM_Core_Reference_Basic(self::getTableName() , 'modified_id', 'civicrm_contact', 'id');
 137       self::$_links[] = new CRM_Core_Reference_Dynamic(self::getTableName() , 'entity_id', NULL, 'id', 'entity_table');
 138     }
 139     return self::$_links;
 140   }
 141   /**
 142    * Returns all the column names of this table
 143    *
 144    * @return array
 145    */
 146   static function &fields() {
 147     if (!(self::$_fields)) {
 148       self::$_fields = array(
 149         'id' => array(
 150           'name' => 'id',
 151           'type' => CRM_Utils_Type::T_INT,
 152           'description' => 'Log ID',
 153           'required' => true,
 154         ) ,
 155         'entity_table' => array(
 156           'name' => 'entity_table',
 157           'type' => CRM_Utils_Type::T_STRING,
 158           'title' => ts('Entity Table') ,
 159           'description' => 'Name of table where item being referenced is stored.',
 160           'required' => true,
 161           'maxlength' => 64,
 162           'size' => CRM_Utils_Type::BIG,
 163         ) ,
 164         'entity_id' => array(
 165           'name' => 'entity_id',
 166           'type' => CRM_Utils_Type::T_INT,
 167           'description' => 'Foreign key to the referenced item.',
 168           'required' => true,
 169         ) ,
 170         'data' => array(
 171           'name' => 'data',
 172           'type' => CRM_Utils_Type::T_TEXT,
 173           'title' => ts('Data') ,
 174           'description' => 'Updates does to this object if any.',
 175         ) ,
 176         'modified_id' => array(
 177           'name' => 'modified_id',
 178           'type' => CRM_Utils_Type::T_INT,
 179           'description' => 'FK to Contact ID of person under whose credentials this data modification was made.',
 180           'FKClassName' => 'CRM_Contact_DAO_Contact',
 181         ) ,
 182         'modified_date' => array(
 183           'name' => 'modified_date',
 184           'type' => CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME,
 185           'title' => ts('Modified Date') ,
 186           'description' => 'When was the referenced entity created or modified or deleted.',
 187         ) ,
 188       );
 189     }
 190     return self::$_fields;
 191   }
 192   /**
 193    * Returns an array containing, for each field, the arary key used for that
 194    * field in self::$_fields.
 195    *
 196    * @return array
 197    */
 198   static function &fieldKeys() {
 199     if (!(self::$_fieldKeys)) {
 200       self::$_fieldKeys = array(
 201         'id' => 'id',
 202         'entity_table' => 'entity_table',
 203         'entity_id' => 'entity_id',
 204         'data' => 'data',
 205         'modified_id' => 'modified_id',
 206         'modified_date' => 'modified_date',
 207       );
 208     }
 209     return self::$_fieldKeys;
 210   }
 211   /**
 212    * Returns the names of this table
 213    *
 214    * @return string
 215    */
 216   static function getTableName() {
 217     return self::$_tableName;
 218   }
 219   /**
 220    * Returns if this table needs to be logged
 221    *
 222    * @return boolean
 223    */
 224   function getLog() {
 225     return self::$_log;
 226   }
 227   /**
 228    * Returns the list of fields that can be imported
 229    *
 230    * @param bool $prefix
 231    *
 232    * @return array
 233    */
 234   static function &import($prefix = false) {
 235     if (!(self::$_import)) {
 236       self::$_import = array();
 237       $fields = self::fields();
 238       foreach($fields as $name => $field) {
 239         if (CRM_Utils_Array::value('import', $field)) {
 240           if ($prefix) {
 241             self::$_import['log'] = & $fields[$name];
 242           } else {
 243             self::$_import[$name] = & $fields[$name];
 244           }
 245         }
 246       }
 247     }
 248     return self::$_import;
 249   }
 250   /**
 251    * Returns the list of fields that can be exported
 252    *
 253    * @param bool $prefix
 254    *
 255    * @return array
 256    */
 257   static function &export($prefix = false) {
 258     if (!(self::$_export)) {
 259       self::$_export = array();
 260       $fields = self::fields();
 261       foreach($fields as $name => $field) {
 262         if (CRM_Utils_Array::value('export', $field)) {
 263           if ($prefix) {
 264             self::$_export['log'] = & $fields[$name];
 265           } else {
 266             self::$_export[$name] = & $fields[$name];
 267           }
 268         }
 269       }
 270     }
 271     return self::$_export;
 272   }
 273 }