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/Core/UFField.xml | |
8 | * DO NOT EDIT. Generated by CRM_Core_CodeGen | |
2562d09a | 9 | * (GenCodeChecksum:47f3fbbbd8d816a9cfb9f7fb4e7d5dc4) |
e501603b | 10 | */ |
c3fc2621 | 11 | |
f41f0342 | 12 | /** |
c3fc2621 | 13 | * Database access object for the UFField entity. |
f41f0342 | 14 | */ |
e501603b | 15 | class CRM_Core_DAO_UFField extends CRM_Core_DAO { |
929a1c14 CW |
16 | const EXT = 'civicrm'; |
17 | const TABLE_ADDED = '1.1'; | |
c3fc2621 | 18 | |
e501603b | 19 | /** |
f41f0342 | 20 | * Static instance to hold the table name. |
e501603b TO |
21 | * |
22 | * @var string | |
23 | */ | |
fa45b5b9 | 24 | public static $_tableName = 'civicrm_uf_field'; |
c3fc2621 | 25 | |
e501603b | 26 | /** |
f41f0342 | 27 | * Should CiviCRM log any modifications to this table in the civicrm_log table. |
e501603b | 28 | * |
c3fc2621 | 29 | * @var bool |
e501603b | 30 | */ |
fa45b5b9 | 31 | public static $_log = TRUE; |
c3fc2621 | 32 | |
e501603b TO |
33 | /** |
34 | * Unique table ID | |
35 | * | |
e6ca0a57 | 36 | * @var int |
e501603b TO |
37 | */ |
38 | public $id; | |
c3fc2621 | 39 | |
e501603b TO |
40 | /** |
41 | * Which form does this field belong to. | |
42 | * | |
e6ca0a57 | 43 | * @var int |
e501603b TO |
44 | */ |
45 | public $uf_group_id; | |
c3fc2621 | 46 | |
e501603b TO |
47 | /** |
48 | * Name for CiviCRM field which is being exposed for sharing. | |
49 | * | |
50 | * @var string | |
51 | */ | |
52 | public $field_name; | |
c3fc2621 | 53 | |
e501603b TO |
54 | /** |
55 | * Is this field currently shareable? If false, hide the field for all sharing contexts. | |
56 | * | |
e6ca0a57 | 57 | * @var bool |
e501603b TO |
58 | */ |
59 | public $is_active; | |
c3fc2621 | 60 | |
e501603b TO |
61 | /** |
62 | * the field is view only and not editable in user forms. | |
63 | * | |
e6ca0a57 | 64 | * @var bool |
e501603b TO |
65 | */ |
66 | public $is_view; | |
c3fc2621 | 67 | |
e501603b TO |
68 | /** |
69 | * Is this field required when included in a user or registration form? | |
70 | * | |
e6ca0a57 | 71 | * @var bool |
e501603b TO |
72 | */ |
73 | public $is_required; | |
c3fc2621 | 74 | |
e501603b TO |
75 | /** |
76 | * Controls field display order when user framework fields are displayed in registration and account editing forms. | |
77 | * | |
78 | * @var int | |
79 | */ | |
80 | public $weight; | |
c3fc2621 | 81 | |
e501603b TO |
82 | /** |
83 | * Description and/or help text to display after this field. | |
84 | * | |
85 | * @var text | |
86 | */ | |
87 | public $help_post; | |
c3fc2621 | 88 | |
e501603b TO |
89 | /** |
90 | * Description and/or help text to display before this field. | |
91 | * | |
92 | * @var text | |
93 | */ | |
94 | public $help_pre; | |
c3fc2621 | 95 | |
e501603b TO |
96 | /** |
97 | * In what context(s) is this field visible. | |
98 | * | |
99 | * @var string | |
100 | */ | |
101 | public $visibility; | |
c3fc2621 | 102 | |
e501603b TO |
103 | /** |
104 | * Is this field included as a column in the selector table? | |
105 | * | |
e6ca0a57 | 106 | * @var bool |
e501603b TO |
107 | */ |
108 | public $in_selector; | |
c3fc2621 | 109 | |
e501603b TO |
110 | /** |
111 | * Is this field included search form of profile? | |
112 | * | |
e6ca0a57 | 113 | * @var bool |
e501603b TO |
114 | */ |
115 | public $is_searchable; | |
c3fc2621 | 116 | |
e501603b TO |
117 | /** |
118 | * Location type of this mapping, if required | |
119 | * | |
e6ca0a57 | 120 | * @var int |
e501603b TO |
121 | */ |
122 | public $location_type_id; | |
c3fc2621 | 123 | |
e501603b | 124 | /** |
2cbbebe8 | 125 | * Phone Type ID, if required |
e501603b | 126 | * |
e6ca0a57 | 127 | * @var int |
e501603b TO |
128 | */ |
129 | public $phone_type_id; | |
c3fc2621 | 130 | |
e501603b | 131 | /** |
2cbbebe8 | 132 | * Website Type ID, if required |
e501603b | 133 | * |
e6ca0a57 | 134 | * @var int |
e501603b TO |
135 | */ |
136 | public $website_type_id; | |
c3fc2621 | 137 | |
e501603b TO |
138 | /** |
139 | * To save label for fields. | |
140 | * | |
141 | * @var string | |
142 | */ | |
143 | public $label; | |
c3fc2621 | 144 | |
e501603b TO |
145 | /** |
146 | * This field saves field type (ie individual,household.. field etc). | |
147 | * | |
148 | * @var string | |
149 | */ | |
150 | public $field_type; | |
c3fc2621 | 151 | |
e501603b TO |
152 | /** |
153 | * Is this field reserved for use by some other CiviCRM functionality? | |
154 | * | |
e6ca0a57 | 155 | * @var bool |
e501603b TO |
156 | */ |
157 | public $is_reserved; | |
c3fc2621 | 158 | |
e501603b TO |
159 | /** |
160 | * Include in multi-record listing? | |
161 | * | |
e6ca0a57 | 162 | * @var bool |
e501603b TO |
163 | */ |
164 | public $is_multi_summary; | |
c3fc2621 | 165 | |
e501603b | 166 | /** |
f41f0342 | 167 | * Class constructor. |
e501603b | 168 | */ |
c3fc2621 | 169 | public function __construct() { |
e501603b TO |
170 | $this->__table = 'civicrm_uf_field'; |
171 | parent::__construct(); | |
172 | } | |
c3fc2621 | 173 | |
449c4e6b CW |
174 | /** |
175 | * Returns localized title of this entity. | |
7b66c3b5 AH |
176 | * |
177 | * @param bool $plural | |
178 | * Whether to return the plural version of the title. | |
449c4e6b | 179 | */ |
7b66c3b5 AH |
180 | public static function getEntityTitle($plural = FALSE) { |
181 | return $plural ? ts('UFFields') : ts('UFField'); | |
449c4e6b CW |
182 | } |
183 | ||
e501603b | 184 | /** |
f41f0342 | 185 | * Returns foreign keys and entity references. |
e501603b TO |
186 | * |
187 | * @return array | |
188 | * [CRM_Core_Reference_Interface] | |
189 | */ | |
c3fc2621 | 190 | public static function getReferenceColumns() { |
346aaaba | 191 | if (!isset(Civi::$statics[__CLASS__]['links'])) { |
fa45b5b9 | 192 | Civi::$statics[__CLASS__]['links'] = static::createReferenceColumns(__CLASS__); |
c3fc2621 CW |
193 | Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'uf_group_id', 'civicrm_uf_group', 'id'); |
194 | Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'location_type_id', 'civicrm_location_type', 'id'); | |
346aaaba | 195 | CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']); |
e501603b | 196 | } |
346aaaba | 197 | return Civi::$statics[__CLASS__]['links']; |
e501603b | 198 | } |
c3fc2621 | 199 | |
e501603b TO |
200 | /** |
201 | * Returns all the column names of this table | |
202 | * | |
203 | * @return array | |
204 | */ | |
c3fc2621 | 205 | public static function &fields() { |
346aaaba | 206 | if (!isset(Civi::$statics[__CLASS__]['fields'])) { |
c3fc2621 CW |
207 | Civi::$statics[__CLASS__]['fields'] = [ |
208 | 'id' => [ | |
e501603b TO |
209 | 'name' => 'id', |
210 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 211 | 'title' => ts('Profile Field ID'), |
215b423e | 212 | 'description' => ts('Unique table ID'), |
c3fc2621 | 213 | 'required' => TRUE, |
a36434b9 | 214 | 'where' => 'civicrm_uf_field.id', |
522a26c9 | 215 | 'table_name' => 'civicrm_uf_field', |
216 | 'entity' => 'UFField', | |
217 | 'bao' => 'CRM_Core_BAO_UFField', | |
6a7e5e5d | 218 | 'localizable' => 0, |
2cbbebe8 A |
219 | 'html' => [ |
220 | 'type' => 'Number', | |
221 | ], | |
1fe423d6 | 222 | 'readonly' => TRUE, |
a9d0587b | 223 | 'add' => '1.1', |
c3fc2621 CW |
224 | ], |
225 | 'uf_group_id' => [ | |
e501603b TO |
226 | 'name' => 'uf_group_id', |
227 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 228 | 'title' => ts('Profile ID'), |
215b423e | 229 | 'description' => ts('Which form does this field belong to.'), |
c3fc2621 | 230 | 'required' => TRUE, |
a36434b9 | 231 | 'where' => 'civicrm_uf_field.uf_group_id', |
522a26c9 | 232 | 'table_name' => 'civicrm_uf_field', |
233 | 'entity' => 'UFField', | |
234 | 'bao' => 'CRM_Core_BAO_UFField', | |
6a7e5e5d | 235 | 'localizable' => 0, |
e501603b | 236 | 'FKClassName' => 'CRM_Core_DAO_UFGroup', |
c3fc2621 | 237 | 'html' => [ |
e501603b | 238 | 'type' => 'Select', |
2cbbebe8 | 239 | 'label' => ts("Profile"), |
c3fc2621 CW |
240 | ], |
241 | 'pseudoconstant' => [ | |
e501603b TO |
242 | 'table' => 'civicrm_uf_group', |
243 | 'keyColumn' => 'id', | |
244 | 'labelColumn' => 'title', | |
e6ca0a57 | 245 | ], |
a9d0587b | 246 | 'add' => '1.1', |
c3fc2621 CW |
247 | ], |
248 | 'field_name' => [ | |
e501603b TO |
249 | 'name' => 'field_name', |
250 | 'type' => CRM_Utils_Type::T_STRING, | |
c3fc2621 | 251 | 'title' => ts('Profile Field Name'), |
215b423e | 252 | 'description' => ts('Name for CiviCRM field which is being exposed for sharing.'), |
c3fc2621 | 253 | 'required' => TRUE, |
e501603b TO |
254 | 'maxlength' => 64, |
255 | 'size' => CRM_Utils_Type::BIG, | |
a36434b9 | 256 | 'where' => 'civicrm_uf_field.field_name', |
522a26c9 | 257 | 'table_name' => 'civicrm_uf_field', |
258 | 'entity' => 'UFField', | |
259 | 'bao' => 'CRM_Core_BAO_UFField', | |
6a7e5e5d | 260 | 'localizable' => 0, |
ffb9cdec CW |
261 | 'pseudoconstant' => [ |
262 | 'callback' => 'CRM_Core_BAO_UFField::getAvailableFieldTitles', | |
e6ca0a57 | 263 | ], |
a9d0587b | 264 | 'add' => '1.1', |
c3fc2621 CW |
265 | ], |
266 | 'is_active' => [ | |
e501603b TO |
267 | 'name' => 'is_active', |
268 | 'type' => CRM_Utils_Type::T_BOOLEAN, | |
c3fc2621 | 269 | 'title' => ts('Profile Field Is Active'), |
215b423e | 270 | 'description' => ts('Is this field currently shareable? If false, hide the field for all sharing contexts.'), |
a36434b9 | 271 | 'where' => 'civicrm_uf_field.is_active', |
e501603b | 272 | 'default' => '1', |
522a26c9 | 273 | 'table_name' => 'civicrm_uf_field', |
274 | 'entity' => 'UFField', | |
275 | 'bao' => 'CRM_Core_BAO_UFField', | |
6a7e5e5d | 276 | 'localizable' => 0, |
a9d0587b | 277 | 'add' => '1.1', |
c3fc2621 CW |
278 | ], |
279 | 'is_view' => [ | |
e501603b TO |
280 | 'name' => 'is_view', |
281 | 'type' => CRM_Utils_Type::T_BOOLEAN, | |
c3fc2621 | 282 | 'title' => ts('Profile Is View Only'), |
215b423e | 283 | 'description' => ts('the field is view only and not editable in user forms.'), |
a36434b9 | 284 | 'where' => 'civicrm_uf_field.is_view', |
45a83e42 | 285 | 'default' => '0', |
522a26c9 | 286 | 'table_name' => 'civicrm_uf_field', |
287 | 'entity' => 'UFField', | |
288 | 'bao' => 'CRM_Core_BAO_UFField', | |
6a7e5e5d | 289 | 'localizable' => 0, |
a9d0587b | 290 | 'add' => '1.1', |
c3fc2621 CW |
291 | ], |
292 | 'is_required' => [ | |
e501603b TO |
293 | 'name' => 'is_required', |
294 | 'type' => CRM_Utils_Type::T_BOOLEAN, | |
c3fc2621 | 295 | 'title' => ts('Profile Field Is Required'), |
215b423e | 296 | 'description' => ts('Is this field required when included in a user or registration form?'), |
a36434b9 | 297 | 'where' => 'civicrm_uf_field.is_required', |
45a83e42 | 298 | 'default' => '0', |
522a26c9 | 299 | 'table_name' => 'civicrm_uf_field', |
300 | 'entity' => 'UFField', | |
301 | 'bao' => 'CRM_Core_BAO_UFField', | |
6a7e5e5d | 302 | 'localizable' => 0, |
a9d0587b | 303 | 'add' => '1.1', |
c3fc2621 CW |
304 | ], |
305 | 'weight' => [ | |
e501603b TO |
306 | 'name' => 'weight', |
307 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 308 | 'title' => ts('Order'), |
215b423e | 309 | 'description' => ts('Controls field display order when user framework fields are displayed in registration and account editing forms.'), |
c3fc2621 | 310 | 'required' => TRUE, |
a36434b9 | 311 | 'where' => 'civicrm_uf_field.weight', |
e501603b | 312 | 'default' => '1', |
522a26c9 | 313 | 'table_name' => 'civicrm_uf_field', |
314 | 'entity' => 'UFField', | |
315 | 'bao' => 'CRM_Core_BAO_UFField', | |
6a7e5e5d | 316 | 'localizable' => 0, |
a9d0587b | 317 | 'add' => '1.1', |
c3fc2621 CW |
318 | ], |
319 | 'help_post' => [ | |
e501603b TO |
320 | 'name' => 'help_post', |
321 | 'type' => CRM_Utils_Type::T_TEXT, | |
c3fc2621 | 322 | 'title' => ts('Profile Field Post Help'), |
215b423e | 323 | 'description' => ts('Description and/or help text to display after this field.'), |
a36434b9 | 324 | 'where' => 'civicrm_uf_field.help_post', |
522a26c9 | 325 | 'table_name' => 'civicrm_uf_field', |
326 | 'entity' => 'UFField', | |
327 | 'bao' => 'CRM_Core_BAO_UFField', | |
6a7e5e5d | 328 | 'localizable' => 1, |
a9d0587b | 329 | 'add' => '1.1', |
c3fc2621 CW |
330 | ], |
331 | 'help_pre' => [ | |
e501603b TO |
332 | 'name' => 'help_pre', |
333 | 'type' => CRM_Utils_Type::T_TEXT, | |
c3fc2621 | 334 | 'title' => ts('Profile Field Pre Help'), |
215b423e | 335 | 'description' => ts('Description and/or help text to display before this field.'), |
a36434b9 | 336 | 'where' => 'civicrm_uf_field.help_pre', |
522a26c9 | 337 | 'table_name' => 'civicrm_uf_field', |
338 | 'entity' => 'UFField', | |
339 | 'bao' => 'CRM_Core_BAO_UFField', | |
6a7e5e5d | 340 | 'localizable' => 1, |
a9d0587b | 341 | 'add' => '3.2', |
c3fc2621 CW |
342 | ], |
343 | 'visibility' => [ | |
e501603b TO |
344 | 'name' => 'visibility', |
345 | 'type' => CRM_Utils_Type::T_STRING, | |
c3fc2621 | 346 | 'title' => ts('Profile Field Visibility'), |
215b423e | 347 | 'description' => ts('In what context(s) is this field visible.'), |
e501603b TO |
348 | 'maxlength' => 32, |
349 | 'size' => CRM_Utils_Type::MEDIUM, | |
a36434b9 | 350 | 'where' => 'civicrm_uf_field.visibility', |
e501603b | 351 | 'default' => 'User and User Admin Only', |
522a26c9 | 352 | 'table_name' => 'civicrm_uf_field', |
353 | 'entity' => 'UFField', | |
354 | 'bao' => 'CRM_Core_BAO_UFField', | |
6a7e5e5d | 355 | 'localizable' => 0, |
c3fc2621 | 356 | 'html' => [ |
e501603b | 357 | 'type' => 'Select', |
c3fc2621 CW |
358 | ], |
359 | 'pseudoconstant' => [ | |
e501603b | 360 | 'callback' => 'CRM_Core_SelectValues::ufVisibility', |
e6ca0a57 | 361 | ], |
a9d0587b | 362 | 'add' => '1.1', |
c3fc2621 CW |
363 | ], |
364 | 'in_selector' => [ | |
e501603b TO |
365 | 'name' => 'in_selector', |
366 | 'type' => CRM_Utils_Type::T_BOOLEAN, | |
c3fc2621 | 367 | 'title' => ts('Profile Field Is a Filter'), |
215b423e | 368 | 'description' => ts('Is this field included as a column in the selector table?'), |
a36434b9 | 369 | 'where' => 'civicrm_uf_field.in_selector', |
45a83e42 | 370 | 'default' => '0', |
522a26c9 | 371 | 'table_name' => 'civicrm_uf_field', |
372 | 'entity' => 'UFField', | |
373 | 'bao' => 'CRM_Core_BAO_UFField', | |
6a7e5e5d | 374 | 'localizable' => 0, |
a9d0587b | 375 | 'add' => '1.2', |
c3fc2621 CW |
376 | ], |
377 | 'is_searchable' => [ | |
e501603b TO |
378 | 'name' => 'is_searchable', |
379 | 'type' => CRM_Utils_Type::T_BOOLEAN, | |
c3fc2621 | 380 | 'title' => ts('Profile Field Is Searchable'), |
215b423e | 381 | 'description' => ts('Is this field included search form of profile?'), |
a36434b9 | 382 | 'where' => 'civicrm_uf_field.is_searchable', |
45a83e42 | 383 | 'default' => '0', |
522a26c9 | 384 | 'table_name' => 'civicrm_uf_field', |
385 | 'entity' => 'UFField', | |
386 | 'bao' => 'CRM_Core_BAO_UFField', | |
6a7e5e5d | 387 | 'localizable' => 0, |
a9d0587b | 388 | 'add' => '1.4', |
c3fc2621 CW |
389 | ], |
390 | 'location_type_id' => [ | |
e501603b TO |
391 | 'name' => 'location_type_id', |
392 | 'type' => CRM_Utils_Type::T_INT, | |
c23563e3 | 393 | 'title' => ts('Location Type ID'), |
215b423e | 394 | 'description' => ts('Location type of this mapping, if required'), |
a36434b9 | 395 | 'where' => 'civicrm_uf_field.location_type_id', |
522a26c9 | 396 | 'table_name' => 'civicrm_uf_field', |
397 | 'entity' => 'UFField', | |
398 | 'bao' => 'CRM_Core_BAO_UFField', | |
6a7e5e5d | 399 | 'localizable' => 0, |
e501603b | 400 | 'FKClassName' => 'CRM_Core_DAO_LocationType', |
2cbbebe8 | 401 | 'html' => [ |
c23563e3 | 402 | 'label' => ts("Location Type"), |
2cbbebe8 | 403 | ], |
a9d0587b | 404 | 'add' => '1.3', |
c3fc2621 CW |
405 | ], |
406 | 'phone_type_id' => [ | |
e501603b TO |
407 | 'name' => 'phone_type_id', |
408 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 409 | 'title' => ts('Profile Field Phone Type'), |
2cbbebe8 | 410 | 'description' => ts('Phone Type ID, if required'), |
a36434b9 | 411 | 'where' => 'civicrm_uf_field.phone_type_id', |
522a26c9 | 412 | 'table_name' => 'civicrm_uf_field', |
413 | 'entity' => 'UFField', | |
414 | 'bao' => 'CRM_Core_BAO_UFField', | |
6a7e5e5d | 415 | 'localizable' => 0, |
b9bf5852 PN |
416 | 'pseudoconstant' => [ |
417 | 'optionGroupName' => 'phone_type', | |
418 | 'optionEditPath' => 'civicrm/admin/options/phone_type', | |
e6ca0a57 | 419 | ], |
a9d0587b | 420 | 'add' => '2.2', |
c3fc2621 CW |
421 | ], |
422 | 'website_type_id' => [ | |
e501603b TO |
423 | 'name' => 'website_type_id', |
424 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 425 | 'title' => ts('Profile Field Website Type'), |
2cbbebe8 | 426 | 'description' => ts('Website Type ID, if required'), |
a36434b9 | 427 | 'where' => 'civicrm_uf_field.website_type_id', |
522a26c9 | 428 | 'table_name' => 'civicrm_uf_field', |
429 | 'entity' => 'UFField', | |
430 | 'bao' => 'CRM_Core_BAO_UFField', | |
6a7e5e5d | 431 | 'localizable' => 0, |
b9bf5852 PN |
432 | 'pseudoconstant' => [ |
433 | 'optionGroupName' => 'website_type', | |
434 | 'optionEditPath' => 'civicrm/admin/options/website_type', | |
e6ca0a57 | 435 | ], |
a9d0587b | 436 | 'add' => '4.5', |
c3fc2621 CW |
437 | ], |
438 | 'label' => [ | |
e501603b TO |
439 | 'name' => 'label', |
440 | 'type' => CRM_Utils_Type::T_STRING, | |
c3fc2621 | 441 | 'title' => ts('Profile Field Label'), |
215b423e | 442 | 'description' => ts('To save label for fields.'), |
c3fc2621 | 443 | 'required' => TRUE, |
e501603b TO |
444 | 'maxlength' => 255, |
445 | 'size' => CRM_Utils_Type::HUGE, | |
a36434b9 | 446 | 'where' => 'civicrm_uf_field.label', |
522a26c9 | 447 | 'table_name' => 'civicrm_uf_field', |
448 | 'entity' => 'UFField', | |
449 | 'bao' => 'CRM_Core_BAO_UFField', | |
6a7e5e5d | 450 | 'localizable' => 1, |
a9d0587b | 451 | 'add' => '1.4', |
c3fc2621 CW |
452 | ], |
453 | 'field_type' => [ | |
e501603b TO |
454 | 'name' => 'field_type', |
455 | 'type' => CRM_Utils_Type::T_STRING, | |
c3fc2621 | 456 | 'title' => ts('Profile Field Type'), |
215b423e | 457 | 'description' => ts('This field saves field type (ie individual,household.. field etc).'), |
e501603b TO |
458 | 'maxlength' => 255, |
459 | 'size' => CRM_Utils_Type::HUGE, | |
a36434b9 | 460 | 'where' => 'civicrm_uf_field.field_type', |
522a26c9 | 461 | 'table_name' => 'civicrm_uf_field', |
462 | 'entity' => 'UFField', | |
463 | 'bao' => 'CRM_Core_BAO_UFField', | |
6a7e5e5d | 464 | 'localizable' => 0, |
a9d0587b | 465 | 'add' => '1.4', |
c3fc2621 CW |
466 | ], |
467 | 'is_reserved' => [ | |
e501603b TO |
468 | 'name' => 'is_reserved', |
469 | 'type' => CRM_Utils_Type::T_BOOLEAN, | |
c3fc2621 | 470 | 'title' => ts('Profile Field Is Reserved'), |
215b423e | 471 | 'description' => ts('Is this field reserved for use by some other CiviCRM functionality?'), |
a36434b9 | 472 | 'where' => 'civicrm_uf_field.is_reserved', |
522a26c9 | 473 | 'table_name' => 'civicrm_uf_field', |
474 | 'entity' => 'UFField', | |
475 | 'bao' => 'CRM_Core_BAO_UFField', | |
6a7e5e5d | 476 | 'localizable' => 0, |
a9d0587b | 477 | 'add' => '3.0', |
c3fc2621 CW |
478 | ], |
479 | 'is_multi_summary' => [ | |
e501603b TO |
480 | 'name' => 'is_multi_summary', |
481 | 'type' => CRM_Utils_Type::T_BOOLEAN, | |
c3fc2621 | 482 | 'title' => ts('Profile Field Supports Multiple'), |
215b423e | 483 | 'description' => ts('Include in multi-record listing?'), |
a36434b9 | 484 | 'where' => 'civicrm_uf_field.is_multi_summary', |
45a83e42 | 485 | 'default' => '0', |
522a26c9 | 486 | 'table_name' => 'civicrm_uf_field', |
487 | 'entity' => 'UFField', | |
488 | 'bao' => 'CRM_Core_BAO_UFField', | |
6a7e5e5d | 489 | 'localizable' => 0, |
a9d0587b | 490 | 'add' => '4.3', |
c3fc2621 CW |
491 | ], |
492 | ]; | |
346aaaba | 493 | CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']); |
e501603b | 494 | } |
346aaaba | 495 | return Civi::$statics[__CLASS__]['fields']; |
e501603b | 496 | } |
c3fc2621 | 497 | |
e501603b | 498 | /** |
bd8e0b14 | 499 | * Return a mapping from field-name to the corresponding key (as used in fields()). |
e501603b TO |
500 | * |
501 | * @return array | |
bd8e0b14 | 502 | * Array(string $name => string $uniqueName). |
e501603b | 503 | */ |
c3fc2621 | 504 | public static function &fieldKeys() { |
bd8e0b14 TO |
505 | if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) { |
506 | Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields())); | |
e501603b | 507 | } |
bd8e0b14 | 508 | return Civi::$statics[__CLASS__]['fieldKeys']; |
e501603b | 509 | } |
c3fc2621 | 510 | |
e501603b TO |
511 | /** |
512 | * Returns the names of this table | |
513 | * | |
514 | * @return string | |
515 | */ | |
c3fc2621 | 516 | public static function getTableName() { |
e501603b TO |
517 | return CRM_Core_DAO::getLocaleTableName(self::$_tableName); |
518 | } | |
c3fc2621 | 519 | |
e501603b TO |
520 | /** |
521 | * Returns if this table needs to be logged | |
522 | * | |
c3fc2621 | 523 | * @return bool |
e501603b | 524 | */ |
c3fc2621 | 525 | public function getLog() { |
e501603b TO |
526 | return self::$_log; |
527 | } | |
c3fc2621 | 528 | |
e501603b TO |
529 | /** |
530 | * Returns the list of fields that can be imported | |
531 | * | |
532 | * @param bool $prefix | |
533 | * | |
534 | * @return array | |
535 | */ | |
c3fc2621 CW |
536 | public static function &import($prefix = FALSE) { |
537 | $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'uf_field', $prefix, []); | |
60808919 | 538 | return $r; |
e501603b | 539 | } |
c3fc2621 | 540 | |
e501603b TO |
541 | /** |
542 | * Returns the list of fields that can be exported | |
543 | * | |
544 | * @param bool $prefix | |
545 | * | |
546 | * @return array | |
547 | */ | |
c3fc2621 CW |
548 | public static function &export($prefix = FALSE) { |
549 | $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'uf_field', $prefix, []); | |
60808919 | 550 | return $r; |
e501603b | 551 | } |
c3fc2621 | 552 | |
e7a6b91a AS |
553 | /** |
554 | * Returns the list of indices | |
c3fc2621 CW |
555 | * |
556 | * @param bool $localize | |
557 | * | |
558 | * @return array | |
e7a6b91a AS |
559 | */ |
560 | public static function indices($localize = TRUE) { | |
c3fc2621 CW |
561 | $indices = [ |
562 | 'IX_website_type_id' => [ | |
e7a6b91a | 563 | 'name' => 'IX_website_type_id', |
c3fc2621 | 564 | 'field' => [ |
e7a6b91a | 565 | 0 => 'website_type_id', |
c3fc2621 CW |
566 | ], |
567 | 'localizable' => FALSE, | |
e7a6b91a | 568 | 'sig' => 'civicrm_uf_field::0::website_type_id', |
c3fc2621 CW |
569 | ], |
570 | ]; | |
e7a6b91a AS |
571 | return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices; |
572 | } | |
c3fc2621 | 573 | |
e501603b | 574 | } |