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:57c93b00e00d0a48d5071d5a991289ab)
  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    * @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('Case Contacts') : ts('Case Contact');
  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(), 'case_id', 'civicrm_case', 'id');
  82       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'contact_id', '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('Case Contact ID'),
 100           'description' => ts('Unique case-contact association id'),
 101           'required' => TRUE,
 102           'where' => 'civicrm_case_contact.id',
 103           'table_name' => 'civicrm_case_contact',
 104           'entity' => 'CaseContact',
 105           'bao' => 'CRM_Case_BAO_CaseContact',
 106           'localizable' => 0,
 107           'add' => '2.1',
 108         ],
 109         'case_id' => [
 110           'name' => 'case_id',
 111           'type' => CRM_Utils_Type::T_INT,
 112           'title' => ts('Case'),
 113           'description' => ts('Case ID of case-contact association.'),
 114           'required' => TRUE,
 115           'where' => 'civicrm_case_contact.case_id',
 116           'table_name' => 'civicrm_case_contact',
 117           'entity' => 'CaseContact',
 118           'bao' => 'CRM_Case_BAO_CaseContact',
 119           'localizable' => 0,
 120           'FKClassName' => 'CRM_Case_DAO_Case',
 121           'add' => '2.1',
 122         ],
 123         'contact_id' => [
 124           'name' => 'contact_id',
 125           'type' => CRM_Utils_Type::T_INT,
 126           'title' => ts('Contact ID'),
 127           'description' => ts('Contact ID of contact record given case belongs to.'),
 128           'required' => TRUE,
 129           'where' => 'civicrm_case_contact.contact_id',
 130           'table_name' => 'civicrm_case_contact',
 131           'entity' => 'CaseContact',
 132           'bao' => 'CRM_Case_BAO_CaseContact',
 133           'localizable' => 0,
 134           'FKClassName' => 'CRM_Contact_DAO_Contact',
 135           'html' => [
 136             'type' => 'EntityRef',
 137           ],
 138           'add' => '2.1',
 139         ],
 140       ];
 141       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 142     }
 143     return Civi::$statics[__CLASS__]['fields'];
 144   }
 145
 146   /**
 147    * Return a mapping from field-name to the corresponding key (as used in fields()).
 148    *
 149    * @return array
 150    *   Array(string $name => string $uniqueName).
 151    */
 152   public static function &fieldKeys() {
 153     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 154       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 155     }
 156     return Civi::$statics[__CLASS__]['fieldKeys'];
 157   }
 158
 159   /**
 160    * Returns the names of this table
 161    *
 162    * @return string
 163    */
 164   public static function getTableName() {
 165     return self::$_tableName;
 166   }
 167
 168   /**
 169    * Returns if this table needs to be logged
 170    *
 171    * @return bool
 172    */
 173   public function getLog() {
 174     return self::$_log;
 175   }
 176
 177   /**
 178    * Returns the list of fields that can be imported
 179    *
 180    * @param bool $prefix
 181    *
 182    * @return array
 183    */
 184   public static function &import($prefix = FALSE) {
 185     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'case_contact', $prefix, []);
 186     return $r;
 187   }
 188
 189   /**
 190    * Returns the list of fields that can be exported
 191    *
 192    * @param bool $prefix
 193    *
 194    * @return array
 195    */
 196   public static function &export($prefix = FALSE) {
 197     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'case_contact', $prefix, []);
 198     return $r;
 199   }
 200
 201   /**
 202    * Returns the list of indices
 203    *
 204    * @param bool $localize
 205    *
 206    * @return array
 207    */
 208   public static function indices($localize = TRUE) {
 209     $indices = [
 210       'UI_case_contact_id' => [
 211         'name' => 'UI_case_contact_id',
 212         'field' => [
 213           0 => 'case_id',
 214           1 => 'contact_id',
 215         ],
 216         'localizable' => FALSE,
 217         'unique' => TRUE,
 218         'sig' => 'civicrm_case_contact::1::case_id::contact_id',
 219       ],
 220     ];
 221     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
 222   }
 223
 224 }