CRM/Dedupe/DAO/Exception.php

   1 <?php
   2
   3 /**
   4  * @package CRM
   5  * @copyright CiviCRM LLC https://civicrm.org/licensing
   6  *
   7  * Generated from xml/schema/CRM/Dedupe/Exception.xml
   8  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
   9  * (GenCodeChecksum:ba60ce547a19bb867543b38a84f4654d)
  10  */
  11
  12 /**
  13  * Database access object for the Exception entity.
  14  */
  15 class CRM_Dedupe_DAO_Exception extends CRM_Core_DAO {
  16
  17   /**
  18    * Static instance to hold the table name.
  19    *
  20    * @var string
  21    */
  22   public static $_tableName = 'civicrm_dedupe_exception';
  23
  24   /**
  25    * Should CiviCRM log any modifications to this table in the civicrm_log table.
  26    *
  27    * @var bool
  28    */
  29   public static $_log = FALSE;
  30
  31   /**
  32    * Unique dedupe exception id
  33    *
  34    * @var int
  35    */
  36   public $id;
  37
  38   /**
  39    * FK to Contact ID
  40    *
  41    * @var int
  42    */
  43   public $contact_id1;
  44
  45   /**
  46    * FK to Contact ID
  47    *
  48    * @var int
  49    */
  50   public $contact_id2;
  51
  52   /**
  53    * Class constructor.
  54    */
  55   public function __construct() {
  56     $this->__table = 'civicrm_dedupe_exception';
  57     parent::__construct();
  58   }
  59
  60   /**
  61    * Returns localized title of this entity.
  62    */
  63   public static function getEntityTitle() {
  64     return ts('Exceptions');
  65   }
  66
  67   /**
  68    * Returns foreign keys and entity references.
  69    *
  70    * @return array
  71    *   [CRM_Core_Reference_Interface]
  72    */
  73   public static function getReferenceColumns() {
  74     if (!isset(Civi::$statics[__CLASS__]['links'])) {
  75       Civi::$statics[__CLASS__]['links'] = static::createReferenceColumns(__CLASS__);
  76       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'contact_id1', 'civicrm_contact', 'id');
  77       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'contact_id2', 'civicrm_contact', 'id');
  78       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']);
  79     }
  80     return Civi::$statics[__CLASS__]['links'];
  81   }
  82
  83   /**
  84    * Returns all the column names of this table
  85    *
  86    * @return array
  87    */
  88   public static function &fields() {
  89     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
  90       Civi::$statics[__CLASS__]['fields'] = [
  91         'id' => [
  92           'name' => 'id',
  93           'type' => CRM_Utils_Type::T_INT,
  94           'title' => ts('Dedupe Exception ID'),
  95           'description' => ts('Unique dedupe exception id'),
  96           'required' => TRUE,
  97           'where' => 'civicrm_dedupe_exception.id',
  98           'table_name' => 'civicrm_dedupe_exception',
  99           'entity' => 'Exception',
 100           'bao' => 'CRM_Dedupe_BAO_Exception',
 101           'localizable' => 0,
 102         ],
 103         'contact_id1' => [
 104           'name' => 'contact_id1',
 105           'type' => CRM_Utils_Type::T_INT,
 106           'title' => ts('First Dupe Contact ID'),
 107           'description' => ts('FK to Contact ID'),
 108           'required' => TRUE,
 109           'where' => 'civicrm_dedupe_exception.contact_id1',
 110           'table_name' => 'civicrm_dedupe_exception',
 111           'entity' => 'Exception',
 112           'bao' => 'CRM_Dedupe_BAO_Exception',
 113           'localizable' => 0,
 114           'FKClassName' => 'CRM_Contact_DAO_Contact',
 115         ],
 116         'contact_id2' => [
 117           'name' => 'contact_id2',
 118           'type' => CRM_Utils_Type::T_INT,
 119           'title' => ts('Second Dupe Contact ID'),
 120           'description' => ts('FK to Contact ID'),
 121           'required' => TRUE,
 122           'where' => 'civicrm_dedupe_exception.contact_id2',
 123           'table_name' => 'civicrm_dedupe_exception',
 124           'entity' => 'Exception',
 125           'bao' => 'CRM_Dedupe_BAO_Exception',
 126           'localizable' => 0,
 127           'FKClassName' => 'CRM_Contact_DAO_Contact',
 128         ],
 129       ];
 130       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 131     }
 132     return Civi::$statics[__CLASS__]['fields'];
 133   }
 134
 135   /**
 136    * Return a mapping from field-name to the corresponding key (as used in fields()).
 137    *
 138    * @return array
 139    *   Array(string $name => string $uniqueName).
 140    */
 141   public static function &fieldKeys() {
 142     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 143       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 144     }
 145     return Civi::$statics[__CLASS__]['fieldKeys'];
 146   }
 147
 148   /**
 149    * Returns the names of this table
 150    *
 151    * @return string
 152    */
 153   public static function getTableName() {
 154     return self::$_tableName;
 155   }
 156
 157   /**
 158    * Returns if this table needs to be logged
 159    *
 160    * @return bool
 161    */
 162   public function getLog() {
 163     return self::$_log;
 164   }
 165
 166   /**
 167    * Returns the list of fields that can be imported
 168    *
 169    * @param bool $prefix
 170    *
 171    * @return array
 172    */
 173   public static function &import($prefix = FALSE) {
 174     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'dedupe_exception', $prefix, []);
 175     return $r;
 176   }
 177
 178   /**
 179    * Returns the list of fields that can be exported
 180    *
 181    * @param bool $prefix
 182    *
 183    * @return array
 184    */
 185   public static function &export($prefix = FALSE) {
 186     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'dedupe_exception', $prefix, []);
 187     return $r;
 188   }
 189
 190   /**
 191    * Returns the list of indices
 192    *
 193    * @param bool $localize
 194    *
 195    * @return array
 196    */
 197   public static function indices($localize = TRUE) {
 198     $indices = [
 199       'UI_contact_id1_contact_id2' => [
 200         'name' => 'UI_contact_id1_contact_id2',
 201         'field' => [
 202           0 => 'contact_id1',
 203           1 => 'contact_id2',
 204         ],
 205         'localizable' => FALSE,
 206         'unique' => TRUE,
 207         'sig' => 'civicrm_dedupe_exception::1::contact_id1::contact_id2',
 208       ],
 209     ];
 210     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
 211   }
 212
 213 }