CRM/Case/DAO/CaseContact.php

   1 <?php
   2
   3 /**
   4  * @package CRM
   5  * @copyright CiviCRM LLC https://civicrm.org/licensing
   6  *
   7  * Generated from xml/schema/CRM/Case/CaseContact.xml
   8  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
   9  * (GenCodeChecksum:b315f42d7c886c123c9e87c9713c4911)
  10  */
  11
  12 /**
  13  * Database access object for the CaseContact entity.
  14  */
  15 class CRM_Case_DAO_CaseContact extends CRM_Core_DAO {
  16   const EXT = 'civicrm';
  17   const TABLE_ADDED = '2.1';
  18
  19   /**
  20    * Static instance to hold the table name.
  21    *
  22    * @var string
  23    */
  24   public static $_tableName = 'civicrm_case_contact';
  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 = TRUE;
  32
  33   /**
  34    * Unique case-contact association id
  35    *
  36    * @var int
  37    */
  38   public $id;
  39
  40   /**
  41    * Case ID of case-contact association.
  42    *
  43    * @var int
  44    */
  45   public $case_id;
  46
  47   /**
  48    * Contact ID of contact record given case belongs to.
  49    *
  50    * @var int
  51    */
  52   public $contact_id;
  53
  54   /**
  55    * Class constructor.
  56    */
  57   public function __construct() {
  58     $this->__table = 'civicrm_case_contact';
  59     parent::__construct();
  60   }
  61
  62   /**
  63    * Returns localized title of this entity.
  64    */
  65   public static function getEntityTitle() {
  66     return ts('Case Contacts');
  67   }
  68
  69   /**
  70    * Returns foreign keys and entity references.
  71    *
  72    * @return array
  73    *   [CRM_Core_Reference_Interface]
  74    */
  75   public static function getReferenceColumns() {
  76     if (!isset(Civi::$statics[__CLASS__]['links'])) {
  77       Civi::$statics[__CLASS__]['links'] = static::createReferenceColumns(__CLASS__);
  78       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'case_id', 'civicrm_case', 'id');
  79       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'contact_id', 'civicrm_contact', 'id');
  80       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']);
  81     }
  82     return Civi::$statics[__CLASS__]['links'];
  83   }
  84
  85   /**
  86    * Returns all the column names of this table
  87    *
  88    * @return array
  89    */
  90   public static function &fields() {
  91     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
  92       Civi::$statics[__CLASS__]['fields'] = [
  93         'id' => [
  94           'name' => 'id',
  95           'type' => CRM_Utils_Type::T_INT,
  96           'title' => ts('Case Contact ID'),
  97           'description' => ts('Unique case-contact association id'),
  98           'required' => TRUE,
  99           'where' => 'civicrm_case_contact.id',
 100           'table_name' => 'civicrm_case_contact',
 101           'entity' => 'CaseContact',
 102           'bao' => 'CRM_Case_BAO_CaseContact',
 103           'localizable' => 0,
 104           'add' => '2.1',
 105         ],
 106         'case_id' => [
 107           'name' => 'case_id',
 108           'type' => CRM_Utils_Type::T_INT,
 109           'title' => ts('Case'),
 110           'description' => ts('Case ID of case-contact association.'),
 111           'required' => TRUE,
 112           'where' => 'civicrm_case_contact.case_id',
 113           'table_name' => 'civicrm_case_contact',
 114           'entity' => 'CaseContact',
 115           'bao' => 'CRM_Case_BAO_CaseContact',
 116           'localizable' => 0,
 117           'FKClassName' => 'CRM_Case_DAO_Case',
 118           'add' => '2.1',
 119         ],
 120         'contact_id' => [
 121           'name' => 'contact_id',
 122           'type' => CRM_Utils_Type::T_INT,
 123           'title' => ts('Contact ID'),
 124           'description' => ts('Contact ID of contact record given case belongs to.'),
 125           'required' => TRUE,
 126           'where' => 'civicrm_case_contact.contact_id',
 127           'table_name' => 'civicrm_case_contact',
 128           'entity' => 'CaseContact',
 129           'bao' => 'CRM_Case_BAO_CaseContact',
 130           'localizable' => 0,
 131           'FKClassName' => 'CRM_Contact_DAO_Contact',
 132           'html' => [
 133             'type' => 'EntityRef',
 134           ],
 135           'add' => '2.1',
 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__, 'case_contact', $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__, 'case_contact', $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_case_contact_id' => [
 208         'name' => 'UI_case_contact_id',
 209         'field' => [
 210           0 => 'case_id',
 211           1 => 'contact_id',
 212         ],
 213         'localizable' => FALSE,
 214         'unique' => TRUE,
 215         'sig' => 'civicrm_case_contact::1::case_id::contact_id',
 216       ],
 217     ];
 218     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
 219   }
 220
 221 }