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:95d83f44443d6ddfed8758214c46ff1b)
  10  */
  11
  12 /**
  13  * Database access object for the Exception entity.
  14  */
  15 class CRM_Dedupe_DAO_Exception 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('Exceptions') : ts('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' => 'Exception',
 105           'bao' => 'CRM_Dedupe_BAO_Exception',
 106           'localizable' => 0,
 107           'add' => '3.3',
 108         ],
 109         'contact_id1' => [
 110           'name' => 'contact_id1',
 111           'type' => CRM_Utils_Type::T_INT,
 112           'title' => ts('First Dupe Contact ID'),
 113           'description' => ts('FK to Contact ID'),
 114           'required' => TRUE,
 115           'where' => 'civicrm_dedupe_exception.contact_id1',
 116           'table_name' => 'civicrm_dedupe_exception',
 117           'entity' => 'Exception',
 118           'bao' => 'CRM_Dedupe_BAO_Exception',
 119           'localizable' => 0,
 120           'FKClassName' => 'CRM_Contact_DAO_Contact',
 121           'add' => '3.3',
 122         ],
 123         'contact_id2' => [
 124           'name' => 'contact_id2',
 125           'type' => CRM_Utils_Type::T_INT,
 126           'title' => ts('Second Dupe Contact ID'),
 127           'description' => ts('FK to Contact ID'),
 128           'required' => TRUE,
 129           'where' => 'civicrm_dedupe_exception.contact_id2',
 130           'table_name' => 'civicrm_dedupe_exception',
 131           'entity' => 'Exception',
 132           'bao' => 'CRM_Dedupe_BAO_Exception',
 133           'localizable' => 0,
 134           'FKClassName' => 'CRM_Contact_DAO_Contact',
 135           'add' => '3.3',
 136         ],
 137       ];
 138       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 139     }
 140     return Civi::$statics[__CLASS__]['fields'];
 141   }
 142
 143   /**
 144    * Return a mapping from field-name to the corresponding key (as used in fields()).
 145    *
 146    * @return array
 147    *   Array(string $name => string $uniqueName).
 148    */
 149   public static function &fieldKeys() {
 150     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 151       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 152     }
 153     return Civi::$statics[__CLASS__]['fieldKeys'];
 154   }
 155
 156   /**
 157    * Returns the names of this table
 158    *
 159    * @return string
 160    */
 161   public static function getTableName() {
 162     return self::$_tableName;
 163   }
 164
 165   /**
 166    * Returns if this table needs to be logged
 167    *
 168    * @return bool
 169    */
 170   public function getLog() {
 171     return self::$_log;
 172   }
 173
 174   /**
 175    * Returns the list of fields that can be imported
 176    *
 177    * @param bool $prefix
 178    *
 179    * @return array
 180    */
 181   public static function &import($prefix = FALSE) {
 182     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'dedupe_exception', $prefix, []);
 183     return $r;
 184   }
 185
 186   /**
 187    * Returns the list of fields that can be exported
 188    *
 189    * @param bool $prefix
 190    *
 191    * @return array
 192    */
 193   public static function &export($prefix = FALSE) {
 194     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'dedupe_exception', $prefix, []);
 195     return $r;
 196   }
 197
 198   /**
 199    * Returns the list of indices
 200    *
 201    * @param bool $localize
 202    *
 203    * @return array
 204    */
 205   public static function indices($localize = TRUE) {
 206     $indices = [
 207       'UI_contact_id1_contact_id2' => [
 208         'name' => 'UI_contact_id1_contact_id2',
 209         'field' => [
 210           0 => 'contact_id1',
 211           1 => 'contact_id2',
 212         ],
 213         'localizable' => FALSE,
 214         'unique' => TRUE,
 215         'sig' => 'civicrm_dedupe_exception::1::contact_id1::contact_id2',
 216       ],
 217     ];
 218     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
 219   }
 220
 221 }