CRM/Core/DAO/Log.php

   1 <?php
   2 /*
   3 +--------------------------------------------------------------------+
   4 | CiviCRM version 4.7                                                |
   5 +--------------------------------------------------------------------+
   6 | Copyright CiviCRM LLC (c) 2004-2017                                |
   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-2017
  30  *
  31  * Generated from xml/schema/CRM/Core/Log.xml
  32  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
  33  * (GenCodeChecksum:a0c51596a4ccc5f07a5dcec00bbb7231)
  34  */
  35 require_once 'CRM/Core/DAO.php';
  36 require_once 'CRM/Utils/Type.php';
  37 /**
  38  * CRM_Core_DAO_Log constructor.
  39  */
  40 class CRM_Core_DAO_Log extends CRM_Core_DAO {
  41   /**
  42    * Static instance to hold the table name.
  43    *
  44    * @var string
  45    */
  46   static $_tableName = 'civicrm_log';
  47   /**
  48    * Should CiviCRM log any modifications to this table in the civicrm_log table.
  49    *
  50    * @var boolean
  51    */
  52   static $_log = false;
  53   /**
  54    * Log ID
  55    *
  56    * @var int unsigned
  57    */
  58   public $id;
  59   /**
  60    * Name of table where item being referenced is stored.
  61    *
  62    * @var string
  63    */
  64   public $entity_table;
  65   /**
  66    * Foreign key to the referenced item.
  67    *
  68    * @var int unsigned
  69    */
  70   public $entity_id;
  71   /**
  72    * Updates does to this object if any.
  73    *
  74    * @var text
  75    */
  76   public $data;
  77   /**
  78    * FK to Contact ID of person under whose credentials this data modification was made.
  79    *
  80    * @var int unsigned
  81    */
  82   public $modified_id;
  83   /**
  84    * When was the referenced entity created or modified or deleted.
  85    *
  86    * @var datetime
  87    */
  88   public $modified_date;
  89   /**
  90    * Class constructor.
  91    */
  92   function __construct() {
  93     $this->__table = 'civicrm_log';
  94     parent::__construct();
  95   }
  96   /**
  97    * Returns foreign keys and entity references.
  98    *
  99    * @return array
 100    *   [CRM_Core_Reference_Interface]
 101    */
 102   static function getReferenceColumns() {
 103     if (!isset(Civi::$statics[__CLASS__]['links'])) {
 104       Civi::$statics[__CLASS__]['links'] = static ::createReferenceColumns(__CLASS__);
 105       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName() , 'modified_id', 'civicrm_contact', 'id');
 106       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Dynamic(self::getTableName() , 'entity_id', NULL, 'id', 'entity_table');
 107       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']);
 108     }
 109     return Civi::$statics[__CLASS__]['links'];
 110   }
 111   /**
 112    * Returns all the column names of this table
 113    *
 114    * @return array
 115    */
 116   static function &fields() {
 117     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
 118       Civi::$statics[__CLASS__]['fields'] = array(
 119         'id' => array(
 120           'name' => 'id',
 121           'type' => CRM_Utils_Type::T_INT,
 122           'title' => ts('Log ID') ,
 123           'description' => 'Log ID',
 124           'required' => true,
 125           'table_name' => 'civicrm_log',
 126           'entity' => 'Log',
 127           'bao' => 'CRM_Core_BAO_Log',
 128         ) ,
 129         'entity_table' => array(
 130           'name' => 'entity_table',
 131           'type' => CRM_Utils_Type::T_STRING,
 132           'title' => ts('Entity Table') ,
 133           'description' => 'Name of table where item being referenced is stored.',
 134           'required' => true,
 135           'maxlength' => 64,
 136           'size' => CRM_Utils_Type::BIG,
 137           'table_name' => 'civicrm_log',
 138           'entity' => 'Log',
 139           'bao' => 'CRM_Core_BAO_Log',
 140         ) ,
 141         'entity_id' => array(
 142           'name' => 'entity_id',
 143           'type' => CRM_Utils_Type::T_INT,
 144           'title' => ts('Entity ID ') ,
 145           'description' => 'Foreign key to the referenced item.',
 146           'required' => true,
 147           'table_name' => 'civicrm_log',
 148           'entity' => 'Log',
 149           'bao' => 'CRM_Core_BAO_Log',
 150         ) ,
 151         'data' => array(
 152           'name' => 'data',
 153           'type' => CRM_Utils_Type::T_TEXT,
 154           'title' => ts('Data') ,
 155           'description' => 'Updates does to this object if any.',
 156           'table_name' => 'civicrm_log',
 157           'entity' => 'Log',
 158           'bao' => 'CRM_Core_BAO_Log',
 159         ) ,
 160         'modified_id' => array(
 161           'name' => 'modified_id',
 162           'type' => CRM_Utils_Type::T_INT,
 163           'title' => ts('Modified By') ,
 164           'description' => 'FK to Contact ID of person under whose credentials this data modification was made.',
 165           'table_name' => 'civicrm_log',
 166           'entity' => 'Log',
 167           'bao' => 'CRM_Core_BAO_Log',
 168           'FKClassName' => 'CRM_Contact_DAO_Contact',
 169         ) ,
 170         'modified_date' => array(
 171           'name' => 'modified_date',
 172           'type' => CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME,
 173           'title' => ts('Modified Date') ,
 174           'description' => 'When was the referenced entity created or modified or deleted.',
 175           'table_name' => 'civicrm_log',
 176           'entity' => 'Log',
 177           'bao' => 'CRM_Core_BAO_Log',
 178         ) ,
 179       );
 180       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 181     }
 182     return Civi::$statics[__CLASS__]['fields'];
 183   }
 184   /**
 185    * Return a mapping from field-name to the corresponding key (as used in fields()).
 186    *
 187    * @return array
 188    *   Array(string $name => string $uniqueName).
 189    */
 190   static function &fieldKeys() {
 191     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 192       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 193     }
 194     return Civi::$statics[__CLASS__]['fieldKeys'];
 195   }
 196   /**
 197    * Returns the names of this table
 198    *
 199    * @return string
 200    */
 201   static function getTableName() {
 202     return self::$_tableName;
 203   }
 204   /**
 205    * Returns if this table needs to be logged
 206    *
 207    * @return boolean
 208    */
 209   function getLog() {
 210     return self::$_log;
 211   }
 212   /**
 213    * Returns the list of fields that can be imported
 214    *
 215    * @param bool $prefix
 216    *
 217    * @return array
 218    */
 219   static function &import($prefix = false) {
 220     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'log', $prefix, array());
 221     return $r;
 222   }
 223   /**
 224    * Returns the list of fields that can be exported
 225    *
 226    * @param bool $prefix
 227    *
 228    * @return array
 229    */
 230   static function &export($prefix = false) {
 231     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'log', $prefix, array());
 232     return $r;
 233   }
 234 }