5 * @copyright CiviCRM LLC https://civicrm.org/licensing
7 * Generated from xml/schema/CRM/Case/CaseContact.xml
8 * DO NOT EDIT. Generated by CRM_Core_CodeGen
9 * (GenCodeChecksum:57c93b00e00d0a48d5071d5a991289ab)
13 * Database access object for the CaseContact entity.
15 class CRM_Case_DAO_CaseContact
extends CRM_Core_DAO
{
16 const EXT
= 'civicrm';
17 const TABLE_ADDED
= '2.1';
20 * Static instance to hold the table name.
24 public static $_tableName = 'civicrm_case_contact';
27 * Should CiviCRM log any modifications to this table in the civicrm_log table.
31 public static $_log = TRUE;
34 * Unique case-contact association id
41 * Case ID of case-contact association.
48 * Contact ID of contact record given case belongs to.
57 public function __construct() {
58 $this->__table
= 'civicrm_case_contact';
59 parent
::__construct();
63 * Returns localized title of this entity.
66 * Whether to return the plural version of the title.
68 public static function getEntityTitle($plural = FALSE) {
69 return $plural ?
ts('Case Contacts') : ts('Case Contact');
73 * Returns foreign keys and entity references.
76 * [CRM_Core_Reference_Interface]
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']);
85 return Civi
::$statics[__CLASS__
]['links'];
89 * Returns all the column names of this table
93 public static function &fields() {
94 if (!isset(Civi
::$statics[__CLASS__
]['fields'])) {
95 Civi
::$statics[__CLASS__
]['fields'] = [
98 'type' => CRM_Utils_Type
::T_INT
,
99 'title' => ts('Case Contact ID'),
100 'description' => ts('Unique case-contact association id'),
102 'where' => 'civicrm_case_contact.id',
103 'table_name' => 'civicrm_case_contact',
104 'entity' => 'CaseContact',
105 'bao' => 'CRM_Case_BAO_CaseContact',
111 'type' => CRM_Utils_Type
::T_INT
,
112 'title' => ts('Case'),
113 'description' => ts('Case ID of case-contact association.'),
115 'where' => 'civicrm_case_contact.case_id',
116 'table_name' => 'civicrm_case_contact',
117 'entity' => 'CaseContact',
118 'bao' => 'CRM_Case_BAO_CaseContact',
120 'FKClassName' => 'CRM_Case_DAO_Case',
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.'),
129 'where' => 'civicrm_case_contact.contact_id',
130 'table_name' => 'civicrm_case_contact',
131 'entity' => 'CaseContact',
132 'bao' => 'CRM_Case_BAO_CaseContact',
134 'FKClassName' => 'CRM_Contact_DAO_Contact',
136 'type' => 'EntityRef',
141 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'fields_callback', Civi
::$statics[__CLASS__
]['fields']);
143 return Civi
::$statics[__CLASS__
]['fields'];
147 * Return a mapping from field-name to the corresponding key (as used in fields()).
150 * Array(string $name => string $uniqueName).
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()));
156 return Civi
::$statics[__CLASS__
]['fieldKeys'];
160 * Returns the names of this table
164 public static function getTableName() {
165 return self
::$_tableName;
169 * Returns if this table needs to be logged
173 public function getLog() {
178 * Returns the list of fields that can be imported
180 * @param bool $prefix
184 public static function &import($prefix = FALSE) {
185 $r = CRM_Core_DAO_AllCoreTables
::getImports(__CLASS__
, 'case_contact', $prefix, []);
190 * Returns the list of fields that can be exported
192 * @param bool $prefix
196 public static function &export($prefix = FALSE) {
197 $r = CRM_Core_DAO_AllCoreTables
::getExports(__CLASS__
, 'case_contact', $prefix, []);
202 * Returns the list of indices
204 * @param bool $localize
208 public static function indices($localize = TRUE) {
210 'UI_case_contact_id' => [
211 'name' => 'UI_case_contact_id',
216 'localizable' => FALSE,
218 'sig' => 'civicrm_case_contact::1::case_id::contact_id',
221 return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables
::multilingualize(__CLASS__
, $indices) : $indices;