CRM/Dedupe/DAO/DedupeException.php

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