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:cf45b00165fe5bdad9b216e46091e3e6)
  10  */
  11
  12 /**
  13  * Database access object for the CaseContact entity.
  14  */
  15 class CRM_Case_DAO_CaseContact extends CRM_Core_DAO {
  16
  17   /**
  18    * Static instance to hold the table name.
  19    *
  20    * @var string
  21    */
  22   public static $_tableName = 'civicrm_case_contact';
  23
  24   /**
  25    * Should CiviCRM log any modifications to this table in the civicrm_log table.
  26    *
  27    * @var bool
  28    */
  29   public static $_log = TRUE;
  30
  31   /**
  32    * Unique case-contact association id
  33    *
  34    * @var int
  35    */
  36   public $id;
  37
  38   /**
  39    * Case ID of case-contact association.
  40    *
  41    * @var int
  42    */
  43   public $case_id;
  44
  45   /**
  46    * Contact ID of contact record given case belongs to.
  47    *
  48    * @var int
  49    */
  50   public $contact_id;
  51
  52   /**
  53    * Class constructor.
  54    */
  55   public function __construct() {
  56     $this->__table = 'civicrm_case_contact';
  57     parent::__construct();
  58   }
  59
  60   /**
  61    * Returns localized title of this entity.
  62    */
  63   public static function getEntityTitle() {
  64     return ts('Case Contacts');
  65   }
  66
  67   /**
  68    * Returns foreign keys and entity references.
  69    *
  70    * @return array
  71    *   [CRM_Core_Reference_Interface]
  72    */
  73   public static function getReferenceColumns() {
  74     if (!isset(Civi::$statics[__CLASS__]['links'])) {
  75       Civi::$statics[__CLASS__]['links'] = static::createReferenceColumns(__CLASS__);
  76       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'case_id', 'civicrm_case', 'id');
  77       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'contact_id', 'civicrm_contact', 'id');
  78       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']);
  79     }
  80     return Civi::$statics[__CLASS__]['links'];
  81   }
  82
  83   /**
  84    * Returns all the column names of this table
  85    *
  86    * @return array
  87    */
  88   public static function &fields() {
  89     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
  90       Civi::$statics[__CLASS__]['fields'] = [
  91         'id' => [
  92           'name' => 'id',
  93           'type' => CRM_Utils_Type::T_INT,
  94           'title' => ts('Case Contact ID'),
  95           'description' => ts('Unique case-contact association id'),
  96           'required' => TRUE,
  97           'where' => 'civicrm_case_contact.id',
  98           'table_name' => 'civicrm_case_contact',
  99           'entity' => 'CaseContact',
 100           'bao' => 'CRM_Case_BAO_CaseContact',
 101           'localizable' => 0,
 102         ],
 103         'case_id' => [
 104           'name' => 'case_id',
 105           'type' => CRM_Utils_Type::T_INT,
 106           'title' => ts('Case'),
 107           'description' => ts('Case ID of case-contact association.'),
 108           'required' => TRUE,
 109           'where' => 'civicrm_case_contact.case_id',
 110           'table_name' => 'civicrm_case_contact',
 111           'entity' => 'CaseContact',
 112           'bao' => 'CRM_Case_BAO_CaseContact',
 113           'localizable' => 0,
 114           'FKClassName' => 'CRM_Case_DAO_Case',
 115         ],
 116         'contact_id' => [
 117           'name' => 'contact_id',
 118           'type' => CRM_Utils_Type::T_INT,
 119           'title' => ts('Contact ID'),
 120           'description' => ts('Contact ID of contact record given case belongs to.'),
 121           'required' => TRUE,
 122           'where' => 'civicrm_case_contact.contact_id',
 123           'table_name' => 'civicrm_case_contact',
 124           'entity' => 'CaseContact',
 125           'bao' => 'CRM_Case_BAO_CaseContact',
 126           'localizable' => 0,
 127           'FKClassName' => 'CRM_Contact_DAO_Contact',
 128           'html' => [
 129             'type' => 'EntityRef',
 130           ],
 131         ],
 132       ];
 133       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 134     }
 135     return Civi::$statics[__CLASS__]['fields'];
 136   }
 137
 138   /**
 139    * Return a mapping from field-name to the corresponding key (as used in fields()).
 140    *
 141    * @return array
 142    *   Array(string $name => string $uniqueName).
 143    */
 144   public static function &fieldKeys() {
 145     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 146       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 147     }
 148     return Civi::$statics[__CLASS__]['fieldKeys'];
 149   }
 150
 151   /**
 152    * Returns the names of this table
 153    *
 154    * @return string
 155    */
 156   public static function getTableName() {
 157     return self::$_tableName;
 158   }
 159
 160   /**
 161    * Returns if this table needs to be logged
 162    *
 163    * @return bool
 164    */
 165   public function getLog() {
 166     return self::$_log;
 167   }
 168
 169   /**
 170    * Returns the list of fields that can be imported
 171    *
 172    * @param bool $prefix
 173    *
 174    * @return array
 175    */
 176   public static function &import($prefix = FALSE) {
 177     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'case_contact', $prefix, []);
 178     return $r;
 179   }
 180
 181   /**
 182    * Returns the list of fields that can be exported
 183    *
 184    * @param bool $prefix
 185    *
 186    * @return array
 187    */
 188   public static function &export($prefix = FALSE) {
 189     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'case_contact', $prefix, []);
 190     return $r;
 191   }
 192
 193   /**
 194    * Returns the list of indices
 195    *
 196    * @param bool $localize
 197    *
 198    * @return array
 199    */
 200   public static function indices($localize = TRUE) {
 201     $indices = [
 202       'UI_case_contact_id' => [
 203         'name' => 'UI_case_contact_id',
 204         'field' => [
 205           0 => 'case_id',
 206           1 => 'contact_id',
 207         ],
 208         'localizable' => FALSE,
 209         'unique' => TRUE,
 210         'sig' => 'civicrm_case_contact::1::case_id::contact_id',
 211       ],
 212     ];
 213     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
 214   }
 215
 216 }