Commit | Line | Data |
---|---|---|
e501603b | 1 | <?php |
c3fc2621 | 2 | |
e501603b TO |
3 | /** |
4 | * @package CRM | |
ca5cec67 | 5 | * @copyright CiviCRM LLC https://civicrm.org/licensing |
e501603b TO |
6 | * |
7 | * Generated from xml/schema/CRM/Case/CaseContact.xml | |
8 | * DO NOT EDIT. Generated by CRM_Core_CodeGen | |
28979d65 | 9 | * (GenCodeChecksum:92ba2cdb76569cdd69d488e73c495374) |
e501603b | 10 | */ |
c3fc2621 | 11 | |
f41f0342 | 12 | /** |
c3fc2621 | 13 | * Database access object for the CaseContact entity. |
f41f0342 | 14 | */ |
e501603b | 15 | class CRM_Case_DAO_CaseContact extends CRM_Core_DAO { |
929a1c14 CW |
16 | const EXT = 'civicrm'; |
17 | const TABLE_ADDED = '2.1'; | |
d31fb4e3 | 18 | const COMPONENT = 'CiviCase'; |
c3fc2621 | 19 | |
e501603b | 20 | /** |
f41f0342 | 21 | * Static instance to hold the table name. |
e501603b TO |
22 | * |
23 | * @var string | |
24 | */ | |
fa45b5b9 | 25 | public static $_tableName = 'civicrm_case_contact'; |
c3fc2621 | 26 | |
e501603b | 27 | /** |
f41f0342 | 28 | * Should CiviCRM log any modifications to this table in the civicrm_log table. |
e501603b | 29 | * |
c3fc2621 | 30 | * @var bool |
e501603b | 31 | */ |
fa45b5b9 | 32 | public static $_log = TRUE; |
c3fc2621 | 33 | |
e501603b TO |
34 | /** |
35 | * Unique case-contact association id | |
36 | * | |
28979d65 CW |
37 | * @var int|string|null |
38 | * (SQL type: int unsigned) | |
39 | * Note that values will be retrieved from the database as a string. | |
e501603b TO |
40 | */ |
41 | public $id; | |
c3fc2621 | 42 | |
e501603b TO |
43 | /** |
44 | * Case ID of case-contact association. | |
45 | * | |
28979d65 CW |
46 | * @var int|string |
47 | * (SQL type: int unsigned) | |
48 | * Note that values will be retrieved from the database as a string. | |
e501603b TO |
49 | */ |
50 | public $case_id; | |
c3fc2621 | 51 | |
e501603b TO |
52 | /** |
53 | * Contact ID of contact record given case belongs to. | |
54 | * | |
28979d65 CW |
55 | * @var int|string |
56 | * (SQL type: int unsigned) | |
57 | * Note that values will be retrieved from the database as a string. | |
e501603b TO |
58 | */ |
59 | public $contact_id; | |
c3fc2621 | 60 | |
e501603b | 61 | /** |
f41f0342 | 62 | * Class constructor. |
e501603b | 63 | */ |
c3fc2621 | 64 | public function __construct() { |
e501603b TO |
65 | $this->__table = 'civicrm_case_contact'; |
66 | parent::__construct(); | |
67 | } | |
c3fc2621 | 68 | |
449c4e6b CW |
69 | /** |
70 | * Returns localized title of this entity. | |
7b66c3b5 AH |
71 | * |
72 | * @param bool $plural | |
73 | * Whether to return the plural version of the title. | |
449c4e6b | 74 | */ |
7b66c3b5 AH |
75 | public static function getEntityTitle($plural = FALSE) { |
76 | return $plural ? ts('Case Contacts') : ts('Case Contact'); | |
449c4e6b CW |
77 | } |
78 | ||
e501603b | 79 | /** |
f41f0342 | 80 | * Returns foreign keys and entity references. |
e501603b TO |
81 | * |
82 | * @return array | |
83 | * [CRM_Core_Reference_Interface] | |
84 | */ | |
c3fc2621 | 85 | public static function getReferenceColumns() { |
346aaaba | 86 | if (!isset(Civi::$statics[__CLASS__]['links'])) { |
fa45b5b9 | 87 | Civi::$statics[__CLASS__]['links'] = static::createReferenceColumns(__CLASS__); |
c3fc2621 CW |
88 | Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'case_id', 'civicrm_case', 'id'); |
89 | Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'contact_id', 'civicrm_contact', 'id'); | |
346aaaba | 90 | CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']); |
e501603b | 91 | } |
346aaaba | 92 | return Civi::$statics[__CLASS__]['links']; |
e501603b | 93 | } |
c3fc2621 | 94 | |
e501603b TO |
95 | /** |
96 | * Returns all the column names of this table | |
97 | * | |
98 | * @return array | |
99 | */ | |
c3fc2621 | 100 | public static function &fields() { |
346aaaba | 101 | if (!isset(Civi::$statics[__CLASS__]['fields'])) { |
c3fc2621 CW |
102 | Civi::$statics[__CLASS__]['fields'] = [ |
103 | 'id' => [ | |
e501603b TO |
104 | 'name' => 'id', |
105 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 106 | 'title' => ts('Case Contact ID'), |
215b423e | 107 | 'description' => ts('Unique case-contact association id'), |
c3fc2621 | 108 | 'required' => TRUE, |
a36434b9 | 109 | 'where' => 'civicrm_case_contact.id', |
522a26c9 | 110 | 'table_name' => 'civicrm_case_contact', |
111 | 'entity' => 'CaseContact', | |
112 | 'bao' => 'CRM_Case_BAO_CaseContact', | |
6a7e5e5d | 113 | 'localizable' => 0, |
2cbbebe8 A |
114 | 'html' => [ |
115 | 'type' => 'Number', | |
116 | ], | |
1fe423d6 | 117 | 'readonly' => TRUE, |
a9d0587b | 118 | 'add' => '2.1', |
c3fc2621 CW |
119 | ], |
120 | 'case_id' => [ | |
e501603b TO |
121 | 'name' => 'case_id', |
122 | 'type' => CRM_Utils_Type::T_INT, | |
2cbbebe8 | 123 | 'title' => ts('Case ID'), |
215b423e | 124 | 'description' => ts('Case ID of case-contact association.'), |
c3fc2621 | 125 | 'required' => TRUE, |
a36434b9 | 126 | 'where' => 'civicrm_case_contact.case_id', |
522a26c9 | 127 | 'table_name' => 'civicrm_case_contact', |
128 | 'entity' => 'CaseContact', | |
129 | 'bao' => 'CRM_Case_BAO_CaseContact', | |
6a7e5e5d | 130 | 'localizable' => 0, |
e501603b | 131 | 'FKClassName' => 'CRM_Case_DAO_Case', |
2cbbebe8 A |
132 | 'html' => [ |
133 | 'label' => ts("Case"), | |
134 | ], | |
a9d0587b | 135 | 'add' => '2.1', |
c3fc2621 CW |
136 | ], |
137 | 'contact_id' => [ | |
e501603b TO |
138 | 'name' => 'contact_id', |
139 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 140 | 'title' => ts('Contact ID'), |
215b423e | 141 | 'description' => ts('Contact ID of contact record given case belongs to.'), |
c3fc2621 | 142 | 'required' => TRUE, |
a36434b9 | 143 | 'where' => 'civicrm_case_contact.contact_id', |
522a26c9 | 144 | 'table_name' => 'civicrm_case_contact', |
145 | 'entity' => 'CaseContact', | |
146 | 'bao' => 'CRM_Case_BAO_CaseContact', | |
6a7e5e5d | 147 | 'localizable' => 0, |
e501603b | 148 | 'FKClassName' => 'CRM_Contact_DAO_Contact', |
c3fc2621 | 149 | 'html' => [ |
e501603b | 150 | 'type' => 'EntityRef', |
2cbbebe8 | 151 | 'label' => ts("Contact"), |
c3fc2621 | 152 | ], |
a9d0587b | 153 | 'add' => '2.1', |
c3fc2621 CW |
154 | ], |
155 | ]; | |
346aaaba | 156 | CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']); |
e501603b | 157 | } |
346aaaba | 158 | return Civi::$statics[__CLASS__]['fields']; |
e501603b | 159 | } |
c3fc2621 | 160 | |
e501603b | 161 | /** |
bd8e0b14 | 162 | * Return a mapping from field-name to the corresponding key (as used in fields()). |
e501603b TO |
163 | * |
164 | * @return array | |
bd8e0b14 | 165 | * Array(string $name => string $uniqueName). |
e501603b | 166 | */ |
c3fc2621 | 167 | public static function &fieldKeys() { |
bd8e0b14 TO |
168 | if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) { |
169 | Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields())); | |
e501603b | 170 | } |
bd8e0b14 | 171 | return Civi::$statics[__CLASS__]['fieldKeys']; |
e501603b | 172 | } |
c3fc2621 | 173 | |
e501603b TO |
174 | /** |
175 | * Returns the names of this table | |
176 | * | |
177 | * @return string | |
178 | */ | |
c3fc2621 | 179 | public static function getTableName() { |
e501603b TO |
180 | return self::$_tableName; |
181 | } | |
c3fc2621 | 182 | |
e501603b TO |
183 | /** |
184 | * Returns if this table needs to be logged | |
185 | * | |
c3fc2621 | 186 | * @return bool |
e501603b | 187 | */ |
c3fc2621 | 188 | public function getLog() { |
e501603b TO |
189 | return self::$_log; |
190 | } | |
c3fc2621 | 191 | |
e501603b TO |
192 | /** |
193 | * Returns the list of fields that can be imported | |
194 | * | |
195 | * @param bool $prefix | |
196 | * | |
197 | * @return array | |
198 | */ | |
c3fc2621 CW |
199 | public static function &import($prefix = FALSE) { |
200 | $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'case_contact', $prefix, []); | |
60808919 | 201 | return $r; |
e501603b | 202 | } |
c3fc2621 | 203 | |
e501603b TO |
204 | /** |
205 | * Returns the list of fields that can be exported | |
206 | * | |
207 | * @param bool $prefix | |
208 | * | |
209 | * @return array | |
210 | */ | |
c3fc2621 CW |
211 | public static function &export($prefix = FALSE) { |
212 | $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'case_contact', $prefix, []); | |
60808919 | 213 | return $r; |
e501603b | 214 | } |
c3fc2621 | 215 | |
e7a6b91a AS |
216 | /** |
217 | * Returns the list of indices | |
c3fc2621 CW |
218 | * |
219 | * @param bool $localize | |
220 | * | |
221 | * @return array | |
e7a6b91a AS |
222 | */ |
223 | public static function indices($localize = TRUE) { | |
c3fc2621 CW |
224 | $indices = [ |
225 | 'UI_case_contact_id' => [ | |
e7a6b91a | 226 | 'name' => 'UI_case_contact_id', |
c3fc2621 | 227 | 'field' => [ |
e7a6b91a AS |
228 | 0 => 'case_id', |
229 | 1 => 'contact_id', | |
c3fc2621 CW |
230 | ], |
231 | 'localizable' => FALSE, | |
232 | 'unique' => TRUE, | |
738b63ef | 233 | 'sig' => 'civicrm_case_contact::1::case_id::contact_id', |
c3fc2621 CW |
234 | ], |
235 | ]; | |
e7a6b91a AS |
236 | return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices; |
237 | } | |
c3fc2621 | 238 | |
e501603b | 239 | } |