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