4 * Class CRM_Core_BAO_CustomFieldTest
8 class CRM_Core_BAO_CustomFieldTest
extends CiviUnitTestCase
{
10 use CRMTraits_Custom_CustomDataTrait
;
12 protected $customFieldID;
15 * Clean up after test.
19 public function tearDown() {
20 $this->quickCleanup([], TRUE);
25 * Test creating a custom field.
27 public function testCreateCustomField() {
28 $customGroup = $this->createCustomField();
29 $customFieldID = $this->assertDBNotNull('CRM_Core_DAO_CustomField', $customGroup['id'], 'id', 'custom_group_id',
30 'Database check for created CustomField.'
33 'id' => $customFieldID,
34 'label' => 'editTestFld',
36 'data_type' => 'String',
37 'html_type' => 'Text',
38 'custom_group_id' => $customGroup['id'],
41 CRM_Core_BAO_CustomField
::create($fields);
42 $this->assertDBNotNull('CRM_Core_DAO_CustomField', 1, 'id', 'is_active', 'Database check for edited CustomField.');
43 $this->assertDBNotNull('CRM_Core_DAO_CustomField', $fields['label'], 'id', 'label', 'Database check for edited CustomField.');
45 $dbFieldName = $this->assertDBNotNull('CRM_Core_DAO_CustomField', $customFieldID, 'name', 'id', 'Database check for edited CustomField.');
46 $dbColumnName = $this->assertDBNotNull('CRM_Core_DAO_CustomField', $customFieldID, 'column_name', 'id', 'Database check for edited CustomField.');
47 $this->assertEquals(strtolower("{$dbFieldName}_{$customFieldID}"), $dbColumnName,
48 "Column name ends in ID");
50 $this->customGroupDelete($customGroup['id']);
54 * Test custom field create accepts passed column name.
56 public function testCreateCustomFieldColumnName() {
57 $customGroup = $this->customGroupCreate(['extends' => 'Individual']);
59 'label' => 'testFld 2',
60 'column_name' => 'special_colname',
61 'data_type' => 'String',
62 'html_type' => 'Text',
63 'custom_group_id' => $customGroup['id'],
65 CRM_Core_BAO_CustomField
::create($fields);
66 $customFieldID = $this->assertDBNotNull('CRM_Core_DAO_CustomField', $customGroup['id'], 'id', 'custom_group_id',
67 'Database check for created CustomField.'
69 $dbColumnName = $this->assertDBNotNull('CRM_Core_DAO_CustomField', $customFieldID, 'column_name', 'id', 'Database check for edited CustomField.');
70 $this->assertEquals($fields['column_name'], $dbColumnName,
71 "Column name set as specified");
73 $this->customGroupDelete($customGroup['id']);
77 * Test that name is used for the column.
79 public function testCreateCustomFieldName() {
80 $customGroup = $this->customGroupCreate(['extends' => 'Individual']);
82 'label' => 'testFld 2',
83 'name' => 'special_fldlname',
84 'data_type' => 'String',
85 'html_type' => 'Text',
86 'custom_group_id' => $customGroup['id'],
88 CRM_Core_BAO_CustomField
::create($fields);
89 $customFieldID = $this->assertDBNotNull('CRM_Core_DAO_CustomField', $customGroup['id'], 'id', 'custom_group_id',
90 'Database check for created CustomField.'
92 $dbFieldName = $this->assertDBNotNull('CRM_Core_DAO_CustomField', $customFieldID, 'name', 'id', 'Database check for edited CustomField.');
93 $this->assertEquals($fields['name'], $dbFieldName,
94 "Column name set as specified");
96 $this->customGroupDelete($customGroup['id']);
100 * Test get fields function.
102 public function testGetFields() {
103 $customGroup = $this->customGroupCreate(['extends' => 'Individual']);
105 'label' => 'testFld1',
106 'data_type' => 'String',
107 'html_type' => 'Text',
109 'custom_group_id' => $customGroup['id'],
111 CRM_Core_BAO_CustomField
::create($fields);
112 $this->assertDBNotNull('CRM_Core_DAO_CustomField', $customGroup['id'], 'id', 'custom_group_id',
113 'Database check for created CustomField.'
116 'label' => 'testFld2',
117 'data_type' => 'String',
118 'html_type' => 'Text',
120 'custom_group_id' => $customGroup['id'],
122 CRM_Core_BAO_CustomField
::create($fields);
123 $this->assertDBNotNull('CRM_Core_DAO_CustomField', $customGroup['id'], 'id', 'custom_group_id',
124 'Database check for created CustomField.'
127 $this->customGroupDelete($customGroup['id']);
133 public function testGetDisplayedValues() {
134 $customGroup = $this->customGroupCreate(['extends' => 'Individual']);
137 'data_type' => 'Country',
138 'html_type' => 'Select Country',
140 'United States' => 1228,
145 'data_type' => 'StateProvince',
146 'html_type' => 'Multi-Select State/Province',
150 'Alabama, Alaska' => [1000, 1001],
154 'data_type' => 'String',
155 'html_type' => 'Radio',
164 'data_type' => 'String',
165 'html_type' => 'CheckBox',
173 'Label1' => ['key1'],
175 'Label2, Label3' => ['key2', 'key3'],
176 'Label3, Label4' => CRM_Utils_Array
::implodePadded(['key3', 'key4']),
177 'Label1, Label4' => ['key1' => 1, 'key4' => 1],
181 'data_type' => 'Date',
182 'html_type' => 'Select Date',
183 'date_format' => 'd M yy',
186 '1 Jun 1999 1:30PM' => '1999-06-01 13:30',
191 foreach ($fieldsToCreate as $num => $field) {
192 $params = $field +
['label' => 'test field ' . $num, 'custom_group_id' => $customGroup['id']];
193 unset($params['tests']);
194 $createdField = $this->callAPISuccess('customField', 'create', $params);
195 foreach ($field['tests'] as $expected => $input) {
196 $this->assertEquals($expected, CRM_Core_BAO_CustomField
::displayValue($input, $createdField['id']));
200 $this->customGroupDelete($customGroup['id']);
204 * Test CRM_Core_BAO_CustomField::displayValue.
206 * @throws \CRM_Core_Exception
209 public function testGetDisplayedValuesContactRef() {
210 $customGroup = $this->customGroupCreate(['extends' => 'Individual']);
212 'data_type' => 'ContactReference',
213 'html_type' => 'Autocomplete-Select',
214 'label' => 'test ref',
215 'custom_group_id' => $customGroup['id'],
217 $createdField = $this->callAPISuccess('customField', 'create', $params);
218 $contact1 = $this->individualCreate();
219 $contact2 = $this->individualCreate(['custom_' . $createdField['id'] => $contact1['id']]);
221 $this->assertEquals($contact1['display_name'], CRM_Core_BAO_CustomField
::displayValue($contact2['id'], $createdField['id']));
222 $this->assertEquals("Bob", CRM_Core_BAO_CustomField
::displayValue("Bob", $createdField['id']));
224 $this->contactDelete($contact2['id']);
225 $this->contactDelete($contact1['id']);
226 $this->customGroupDelete($customGroup['id']);
229 public function testDeleteCustomField() {
230 $customGroup = $this->customGroupCreate(['extends' => 'Individual']);
232 'custom_group_id' => $customGroup['id'],
233 'label' => 'Throwaway Field',
234 'dataType' => 'Memo',
235 'htmlType' => 'TextArea',
238 $customField = $this->customFieldCreate($fields);
239 $fieldObject = new CRM_Core_BAO_CustomField();
240 $fieldObject->id
= $customField['id'];
241 $fieldObject->find(TRUE);
242 CRM_Core_BAO_CustomField
::deleteField($fieldObject);
243 $this->assertDBNull('CRM_Core_DAO_CustomField', $customGroup['id'], 'id',
244 'custom_group_id', 'Database check for deleted Custom Field.'
246 $this->customGroupDelete($customGroup['id']);
250 * Move a custom field from $groupA to $groupB.
252 * Make sure that data records are correctly matched and created.
254 * @throws \CRM_Core_Exception
256 public function testMoveField() {
257 $countriesByName = array_flip(CRM_Core_PseudoConstant
::country(FALSE, FALSE));
258 $this->assertTrue($countriesByName['Andorra'] > 0);
260 'A' => $this->customGroupCreate([
261 'title' => 'Test_Group A',
262 'name' => 'test_group_a',
263 'extends' => ['Individual'],
269 'B' => $this->customGroupCreate([
270 'title' => 'Test_Group B',
271 'name' => 'test_group_b',
272 'extends' => ['Individual'],
279 $groupA = $groups['A']['values'][$groups['A']['id']];
280 $groupB = $groups['B']['values'][$groups['B']['id']];
281 $countryA = $this->customFieldCreate([
282 'custom_group_id' => $groups['A']['id'],
283 'label' => 'Country A',
284 'dataType' => 'Country',
285 'htmlType' => 'Select Country',
286 'default_value' => NULL,
288 $countryB = $this->customFieldCreate([
289 'custom_group_id' => $groups['A']['id'],
290 'label' => 'Country B',
291 'dataType' => 'Country',
292 'htmlType' => 'Select Country',
293 'default_value' => NULL,
295 $countryC = $this->customFieldCreate([
296 'custom_group_id' => $groups['B']['id'],
297 'label' => 'Country C',
298 'dataType' => 'Country',
299 'htmlType' => 'Select Country',
300 'default_value' => NULL,
304 'countryA' => $countryA['values'][$countryA['id']],
305 'countryB' => $countryB['values'][$countryB['id']],
306 'countryC' => $countryC['values'][$countryC['id']],
309 'alice' => $this->individualCreate([
310 'first_name' => 'Alice',
311 'last_name' => 'Albertson',
312 'custom_' . $fields['countryA']['id'] => $countriesByName['Andorra'],
313 'custom_' . $fields['countryB']['id'] => $countriesByName['Barbados'],
315 'bob' => $this->individualCreate([
316 'first_name' => 'Bob',
317 'last_name' => 'Roberts',
318 'custom_' . $fields['countryA']['id'] => $countriesByName['Austria'],
319 'custom_' . $fields['countryB']['id'] => $countriesByName['Bermuda'],
320 'custom_' . $fields['countryC']['id'] => $countriesByName['Chad'],
322 'carol' => $this->individualCreate([
323 'first_name' => 'Carol',
324 'last_name' => 'Carolson',
325 'custom_' . $fields['countryC']['id'] => $countriesByName['Cambodia'],
330 CRM_Core_BAO_CustomField
::moveField($fields['countryB']['id'], $groupB['id']);
332 // Group[A] no longer has fields[countryB]
333 $errorScope = CRM_Core_TemporaryErrorScope
::useException();
335 $this->assertDBQuery(1, "SELECT {$fields['countryB']['column_name']} FROM " . $groupA['table_name']);
336 $this->fail('Expected exception when querying column on wrong table');
338 catch (PEAR_Exception
$e) {
342 // Alice: Group[B] has fields[countryB], but fields[countryC] did not exist before
343 $this->assertDBQuery(1,
344 "SELECT count(*) FROM {$groupB['table_name']}
346 AND {$fields['countryB']['column_name']} = %3
347 AND {$fields['countryC']['column_name']} is null",
349 1 => [$contacts['alice'], 'Integer'],
350 3 => [$countriesByName['Barbados'], 'Integer'],
354 // Bob: Group[B] has merged fields[countryB] and fields[countryC] on the same record
355 $this->assertDBQuery(1,
356 "SELECT count(*) FROM {$groupB['table_name']}
358 AND {$fields['countryB']['column_name']} = %3
359 AND {$fields['countryC']['column_name']} = %4",
361 1 => [$contacts['bob'], 'Integer'],
362 3 => [$countriesByName['Bermuda'], 'Integer'],
363 4 => [$countriesByName['Chad'], 'Integer'],
367 // Carol: Group[B] still has fields[countryC] but did not get fields[countryB]
368 $this->assertDBQuery(1,
369 "SELECT count(*) FROM {$groupB['table_name']}
371 AND {$fields['countryB']['column_name']} is null
372 AND {$fields['countryC']['column_name']} = %4",
374 1 => [$contacts['carol'], 'Integer'],
375 4 => [$countriesByName['Cambodia'], 'Integer'],
379 $this->customGroupDelete($groups['A']['id']);
380 $this->customGroupDelete($groupB['id']);
384 * Test get custom field id function.
386 * @throws \CiviCRM_API3_Exception
388 public function testGetCustomFieldID() {
389 $this->createCustomField();
390 $fieldID = CRM_Core_BAO_CustomField
::getCustomFieldID('testFld');
391 $this->assertEquals($this->customFieldID
, $fieldID);
393 $fieldID = CRM_Core_BAO_CustomField
::getCustomFieldID('testFld', 'new custom group');
394 $this->assertEquals($this->customFieldID
, $fieldID);
396 $fieldID = CRM_Core_BAO_CustomField
::getCustomFieldID('testFld', 'new custom group', TRUE);
397 $this->assertEquals('custom_' . $this->customFieldID
, $fieldID);
399 // create field with same name in a different group
400 $this->createCustomField('other custom group');
401 $otherFieldID = CRM_Core_BAO_CustomField
::getCustomFieldID('testFld', 'other custom group');
402 // make sure it does not return the field ID of the first field
403 $this->assertNotEquals($fieldID, $otherFieldID);
407 * Create a custom field
409 * @param string $groupTitle
413 protected function createCustomField($groupTitle = 'new custom group') {
414 $customGroup = $this->customGroupCreate([
415 'extends' => 'Individual',
416 'title' => $groupTitle,
419 'label' => 'testFld',
420 'data_type' => 'String',
421 'html_type' => 'Text',
422 'custom_group_id' => $customGroup['id'],
424 $field = CRM_Core_BAO_CustomField
::create($fields);
425 $this->customFieldID
= $field->id
;
430 * Test the getFieldsForImport function.
434 public function testGetFieldsForImport() {
435 $this->entity
= 'Contact';
436 $this->createCustomGroupWithFieldsOfAllTypes();
437 $customGroupID = $this->ids
['CustomGroup']['Custom Group'];
439 $this->getCustomFieldName('country') => [
440 'name' => $this->getCustomFieldName('country'),
442 'title' => 'Country',
443 'headerPattern' => '//',
445 'custom_field_id' => $this->getCustomFieldID('country'),
446 'options_per_line' => NULL,
447 'text_length' => NULL,
448 'data_type' => 'Country',
449 'html_type' => 'Select Country',
450 'is_search_range' => '0',
451 'id' => $this->getCustomFieldID('country'),
452 'label' => 'Country',
453 'groupTitle' => 'Custom Group',
454 'default_value' => NULL,
455 'custom_group_id' => $customGroupID,
456 'extends' => 'Contact',
457 'extends_entity_column_value' => NULL,
458 'extends_entity_column_id' => NULL,
460 'is_multiple' => '0',
461 'option_group_id' => NULL,
462 'date_format' => NULL,
463 'time_format' => NULL,
465 'table_name' => 'civicrm_value_custom_group_' . $customGroupID,
466 'column_name' => $this->getCustomFieldColumnName('country'),
467 'where' => 'civicrm_value_custom_group_' . $customGroupID . '.' . $this->getCustomFieldColumnName('country'),
468 'extends_table' => 'civicrm_contact',
469 'search_table' => 'contact_a',
470 'pseudoconstant' => [
471 'table' => 'civicrm_country',
473 'labelColumn' => 'name',
474 'nameColumn' => 'iso_code',
477 $this->getCustomFieldName('multi_country') => [
478 'name' => $this->getCustomFieldName('multi_country'),
480 'title' => 'Country-multi',
481 'headerPattern' => '//',
483 'custom_field_id' => $this->getCustomFieldID('multi_country'),
484 'options_per_line' => NULL,
485 'text_length' => NULL,
486 'data_type' => 'Country',
487 'html_type' => 'Multi-Select Country',
488 'is_search_range' => '0',
489 'id' => $this->getCustomFieldID('multi_country'),
490 'label' => 'Country-multi',
491 'groupTitle' => 'Custom Group',
492 'default_value' => NULL,
493 'custom_group_id' => $customGroupID,
494 'extends' => 'Contact',
495 'extends_entity_column_value' => NULL,
496 'extends_entity_column_id' => NULL,
498 'is_multiple' => '0',
499 'option_group_id' => NULL,
500 'date_format' => NULL,
501 'time_format' => NULL,
503 'table_name' => 'civicrm_value_custom_group_' . $customGroupID,
504 'column_name' => $this->getCustomFieldColumnName('multi_country'),
505 'where' => 'civicrm_value_custom_group_' . $customGroupID . '.' . $this->getCustomFieldColumnName('multi_country'),
506 'extends_table' => 'civicrm_contact',
507 'search_table' => 'contact_a',
508 'pseudoconstant' => [
509 'table' => 'civicrm_country',
511 'labelColumn' => 'name',
512 'nameColumn' => 'iso_code',
515 $this->getCustomFieldName('file') => [
516 'name' => $this->getCustomFieldName('file'),
518 'title' => 'My file',
519 'headerPattern' => '//',
521 'custom_field_id' => $this->getCustomFieldID('file'),
522 'options_per_line' => NULL,
523 'text_length' => NULL,
524 'data_type' => 'File',
525 'html_type' => 'File',
526 'is_search_range' => '0',
527 'id' => $this->getCustomFieldID('file'),
528 'label' => 'My file',
529 'groupTitle' => 'Custom Group',
530 'default_value' => NULL,
531 'custom_group_id' => $customGroupID,
532 'extends' => 'Contact',
533 'extends_entity_column_value' => NULL,
534 'extends_entity_column_id' => NULL,
536 'is_multiple' => '0',
537 'option_group_id' => NULL,
538 'date_format' => NULL,
539 'time_format' => NULL,
541 'table_name' => 'civicrm_value_custom_group_' . $customGroupID,
542 'column_name' => 'my_file_' . $this->getCustomFieldID('file'),
543 'where' => 'civicrm_value_custom_group_' . $customGroupID . '.my_file_' . $this->getCustomFieldID('file'),
544 'extends_table' => 'civicrm_contact',
545 'search_table' => 'contact_a',
547 $this->getCustomFieldName('text') => [
548 'name' => $this->getCustomFieldName('text'),
550 'title' => 'Enter text here',
551 'headerPattern' => '//',
553 'custom_field_id' => $this->getCustomFieldID('text'),
554 'options_per_line' => NULL,
555 'text_length' => 300,
556 'data_type' => 'String',
557 'html_type' => 'Text',
558 'is_search_range' => '0',
559 'id' => $this->getCustomFieldID('text'),
560 'label' => 'Enter text here',
561 'groupTitle' => 'Custom Group',
562 'default_value' => 'xyz',
563 'custom_group_id' => '1',
564 'extends' => 'Contact',
565 'extends_entity_column_value' => NULL,
566 'extends_entity_column_id' => NULL,
568 'is_multiple' => '0',
569 'option_group_id' => NULL,
570 'date_format' => NULL,
571 'time_format' => NULL,
573 'table_name' => 'civicrm_value_custom_group_' . $customGroupID,
574 'column_name' => 'enter_text_here_' . $this->getCustomFieldID('text'),
575 'where' => 'civicrm_value_custom_group_' . $customGroupID . '.enter_text_here_' . $this->getCustomFieldID('text'),
576 'extends_table' => 'civicrm_contact',
577 'search_table' => 'contact_a',
580 $this->getCustomFieldName('select_string') => [
581 'name' => $this->getCustomFieldName('select_string'),
583 'title' => 'Pick Color',
584 'headerPattern' => '//',
586 'custom_field_id' => $this->getCustomFieldID('select_string'),
587 'options_per_line' => NULL,
588 'text_length' => NULL,
589 'data_type' => 'String',
590 'html_type' => 'Select',
591 'is_search_range' => '0',
592 'id' => $this->getCustomFieldID('select_string'),
593 'label' => 'Pick Color',
594 'groupTitle' => 'Custom Group',
595 'default_value' => NULL,
596 'custom_group_id' => $customGroupID,
597 'extends' => 'Contact',
598 'extends_entity_column_value' => NULL,
599 'extends_entity_column_id' => NULL,
601 'is_multiple' => '0',
602 'option_group_id' => $this->callAPISuccessGetValue('CustomField', ['id' => $this->getCustomFieldID('select_string'), 'return' => 'option_group_id']),
603 'date_format' => NULL,
604 'time_format' => NULL,
606 'table_name' => 'civicrm_value_custom_group_' . $customGroupID,
607 'column_name' => 'pick_color_' . $this->getCustomFieldID('select_string'),
608 'where' => 'civicrm_value_custom_group_' . $customGroupID . '.pick_color_' . $this->getCustomFieldID('select_string'),
609 'extends_table' => 'civicrm_contact',
610 'search_table' => 'contact_a',
611 'pseudoconstant' => [
612 'optionGroupName' => $this->callAPISuccessGetValue('CustomField', ['id' => $this->getCustomFieldID('select_string'), 'return' => 'option_group_id.name']),
613 'optionEditPath' => 'civicrm/admin/options/' . $this->callAPISuccessGetValue('CustomField', ['id' => $this->getCustomFieldID('select_string'), 'return' => 'option_group_id.name']),
616 $this->getCustomFieldName('select_date') => [
617 'name' => $this->getCustomFieldName('select_date'),
619 'title' => 'Test Date',
620 'headerPattern' => '//',
622 'custom_field_id' => $this->getCustomFieldID('select_date'),
623 'options_per_line' => NULL,
624 'text_length' => NULL,
625 'data_type' => 'Date',
626 'html_type' => 'Select Date',
627 'is_search_range' => '1',
628 'date_format' => 'mm/dd/yy',
629 'time_format' => '1',
630 'id' => $this->getCustomFieldID('select_date'),
631 'label' => 'Test Date',
632 'groupTitle' => 'Custom Group',
633 'default_value' => '20090711',
634 'custom_group_id' => $customGroupID,
635 'extends' => 'Contact',
636 'extends_entity_column_value' => NULL,
637 'extends_entity_column_id' => NULL,
639 'is_multiple' => '0',
640 'option_group_id' => NULL,
641 'is_required' => '0',
642 'table_name' => 'civicrm_value_custom_group_' . $customGroupID,
643 'column_name' => 'test_date_' . $this->getCustomFieldID('select_date'),
644 'where' => 'civicrm_value_custom_group_' . $customGroupID . '.test_date_' . $this->getCustomFieldID('select_date'),
645 'extends_table' => 'civicrm_contact',
646 'search_table' => 'contact_a',
648 $this->getCustomFieldName('link') => [
649 'name' => $this->getCustomFieldName('link'),
651 'title' => 'test_link',
652 'headerPattern' => '//',
654 'custom_field_id' => $this->getCustomFieldID('link'),
655 'options_per_line' => NULL,
656 'text_length' => NULL,
657 'data_type' => 'Link',
658 'html_type' => 'Link',
659 'is_search_range' => '0',
660 'id' => $this->getCustomFieldID('link'),
661 'label' => 'test_link',
662 'groupTitle' => 'Custom Group',
663 'default_value' => 'http://civicrm.org',
664 'custom_group_id' => $customGroupID,
665 'extends' => 'Contact',
666 'extends_entity_column_value' => NULL,
667 'extends_entity_column_id' => NULL,
669 'is_multiple' => '0',
670 'option_group_id' => NULL,
671 'date_format' => NULL,
672 'time_format' => NULL,
674 'table_name' => 'civicrm_value_custom_group_' . $customGroupID,
675 'column_name' => 'test_link_' . $this->getCustomFieldID('link'),
676 'where' => 'civicrm_value_custom_group_' . $customGroupID . '.test_link_' . $this->getCustomFieldID('link'),
677 'extends_table' => 'civicrm_contact',
678 'search_table' => 'contact_a',
680 $this->getCustomFieldName('int') => [
681 'name' => $this->getCustomFieldName('int'),
682 'type' => CRM_Utils_Type
::T_INT
,
683 'title' => 'Enter integer here',
684 'headerPattern' => '//',
686 'custom_field_id' => $this->getCustomFieldID('int'),
687 'options_per_line' => NULL,
688 'text_length' => NULL,
689 'data_type' => 'Int',
690 'html_type' => 'Text',
691 'is_search_range' => '1',
692 'id' => $this->getCustomFieldID('int'),
693 'label' => 'Enter integer here',
694 'groupTitle' => 'Custom Group',
695 'default_value' => '4',
696 'custom_group_id' => $customGroupID,
697 'extends' => 'Contact',
698 'extends_entity_column_value' => NULL,
699 'extends_entity_column_id' => NULL,
701 'is_multiple' => '0',
702 'option_group_id' => NULL,
703 'date_format' => NULL,
704 'time_format' => NULL,
706 'table_name' => 'civicrm_value_custom_group_' . $customGroupID,
707 'column_name' => $this->getCustomFieldColumnName('int'),
708 'where' => 'civicrm_value_custom_group_' . $customGroupID . '.' . $this->getCustomFieldColumnName('int'),
709 'extends_table' => 'civicrm_contact',
710 'search_table' => 'contact_a',
712 $this->getCustomFieldName('contact_reference') => [
713 'name' => $this->getCustomFieldName('contact_reference'),
714 'type' => CRM_Utils_Type
::T_INT
,
715 'title' => 'Contact reference field',
716 'headerPattern' => '//',
718 'custom_field_id' => $this->getCustomFieldID('contact_reference'),
719 'options_per_line' => NULL,
720 'text_length' => NULL,
721 'data_type' => 'ContactReference',
722 'html_type' => 'Autocomplete-Select',
723 'is_search_range' => '0',
724 'id' => $this->getCustomFieldID('contact_reference'),
725 'label' => 'Contact reference field',
726 'groupTitle' => 'Custom Group',
727 'default_value' => NULL,
728 'custom_group_id' => $customGroupID,
729 'extends' => 'Contact',
730 'extends_entity_column_value' => NULL,
731 'extends_entity_column_id' => NULL,
733 'is_multiple' => '0',
734 'option_group_id' => NULL,
735 'date_format' => NULL,
736 'time_format' => NULL,
738 'table_name' => 'civicrm_value_custom_group_' . $customGroupID,
739 'column_name' => $this->getCustomFieldColumnName('contact_reference'),
740 'where' => 'civicrm_value_custom_group_' . $customGroupID . '.' . $this->getCustomFieldColumnName('contact_reference'),
741 'extends_table' => 'civicrm_contact',
742 'search_table' => 'contact_a',
744 $this->getCustomFieldName('state') => [
745 'name' => $this->getCustomFieldName('state'),
746 'id' => $this->getCustomFieldID('state'),
748 'headerPattern' => '//',
750 'custom_field_id' => $this->getCustomFieldID('state'),
751 'groupTitle' => 'Custom Group',
752 'default_value' => NULL,
753 'custom_group_id' => $customGroupID,
754 'extends' => 'Contact',
755 'extends_entity_column_value' => NULL,
756 'extends_entity_column_id' => NULL,
758 'is_multiple' => '0',
759 'option_group_id' => NULL,
760 'date_format' => NULL,
761 'time_format' => NULL,
763 'table_name' => 'civicrm_value_custom_group_' . $customGroupID,
764 'column_name' => $this->getCustomFieldColumnName('state'),
765 'where' => 'civicrm_value_custom_group_' . $customGroupID . '.' . $this->getCustomFieldColumnName('state'),
766 'extends_table' => 'civicrm_contact',
767 'search_table' => 'contact_a',
768 'pseudoconstant' => [
769 'table' => 'civicrm_state_province',
771 'labelColumn' => 'name',
774 'data_type' => 'StateProvince',
776 'html_type' => 'Select State/Province',
777 'text_length' => NULL,
778 'options_per_line' => NULL,
779 'is_search_range' => '0',
781 $this->getCustomFieldName('multi_state') => [
782 'id' => $this->getCustomFieldID('multi_state'),
783 'label' => 'State-multi',
784 'headerPattern' => '//',
785 'title' => 'State-multi',
786 'custom_field_id' => $this->getCustomFieldID('multi_state'),
787 'groupTitle' => 'Custom Group',
788 'default_value' => NULL,
789 'custom_group_id' => $customGroupID,
790 'extends' => 'Contact',
791 'extends_entity_column_value' => NULL,
792 'extends_entity_column_id' => NULL,
794 'is_multiple' => '0',
795 'option_group_id' => NULL,
796 'date_format' => NULL,
797 'time_format' => NULL,
799 'table_name' => 'civicrm_value_custom_group_' . $customGroupID,
800 'column_name' => $this->getCustomFieldColumnName('multi_state'),
801 'where' => 'civicrm_value_custom_group_' . $customGroupID . '.' . $this->getCustomFieldColumnName('multi_state'),
802 'extends_table' => 'civicrm_contact',
803 'search_table' => 'contact_a',
804 'pseudoconstant' => [
805 'table' => 'civicrm_state_province',
807 'labelColumn' => 'name',
810 'data_type' => 'StateProvince',
811 'name' => $this->getCustomFieldName('multi_state'),
813 'html_type' => 'Multi-Select State/Province',
814 'text_length' => NULL,
815 'options_per_line' => NULL,
816 'is_search_range' => '0',
818 $this->getCustomFieldName('boolean') => [
819 'id' => $this->getCustomFieldID('boolean'),
821 'headerPattern' => '//',
823 'custom_field_id' => $this->getCustomFieldID('boolean'),
824 'groupTitle' => 'Custom Group',
825 'default_value' => NULL,
826 'custom_group_id' => $customGroupID,
827 'extends' => 'Contact',
828 'extends_entity_column_value' => NULL,
829 'extends_entity_column_id' => NULL,
831 'is_multiple' => '0',
832 'option_group_id' => NULL,
833 'date_format' => NULL,
834 'time_format' => NULL,
836 'table_name' => 'civicrm_value_custom_group_' . $customGroupID,
837 'column_name' => $this->getCustomFieldColumnName('boolean'),
838 'where' => 'civicrm_value_custom_group_' . $customGroupID . '.' . $this->getCustomFieldColumnName('boolean'),
839 'extends_table' => 'civicrm_contact',
840 'search_table' => 'contact_a',
842 'data_type' => 'Boolean',
843 'name' => $this->getCustomFieldName('boolean'),
845 'html_type' => 'Radio',
846 'text_length' => NULL,
847 'options_per_line' => NULL,
848 'is_search_range' => '0',
849 'pseudoconstant' => [
850 'callback' => 'CRM_Core_SelectValues::boolean',
854 $this->assertEquals($expected, CRM_Core_BAO_CustomField
::getFieldsForImport());
858 * Test the bulk create function works.
860 public function testBulkCreate() {
861 $customGroup = $this->customGroupCreate([
862 'extends' => 'Individual',
863 'title' => 'my bulk group',
865 CRM_Core_BAO_CustomField
::bulkSave([
868 'data_type' => 'String',
869 'html_type' => 'Text',
870 'column_name' => 'my_text',
873 'label' => 'test_link',
874 'data_type' => 'Link',
875 'html_type' => 'Link',
876 'is_search_range' => '0',
880 'custom_group_id' => $customGroup['id'],
882 'is_searchable' => 1,
884 $dao = CRM_Core_DAO
::executeQuery(('SHOW CREATE TABLE ' . $customGroup['values'][$customGroup['id']]['table_name']));
886 $this->assertContains('`test_link_2` varchar(255) COLLATE utf8_unicode_ci DEFAULT NULL', $dao->Create_Table
);
887 $this->assertContains('KEY `INDEX_my_text` (`my_text`)', $dao->Create_Table
);
891 * Check that outputting the display value for a file field with No description doesn't generate error
893 public function testFileDisplayValueNoDescription() {
894 $customGroup = $this->customGroupCreate([
895 'extends' => 'Individual',
896 'title' => 'Test Contact File Custom Group',
898 $fileField = $this->customFieldCreate([
899 'custom_group_id' => $customGroup['id'],
900 'data_type' => 'File',
901 'html_type' => 'File',
902 'default_value' => '',
904 $filePath = Civi
::paths()->getPath('[civicrm.files]/custom/test_file.txt');
905 $file = $this->callAPISuccess('File', 'create', [
908 $individual = $this->individualCreate(['custom_' . $fileField['id'] => $file['id']]);
909 $expectedDisplayValue = CRM_Core_BAO_File
::paperIconAttachment('*', $file['id'])[$file['id']];
910 $this->assertEquals($expectedDisplayValue, CRM_Core_BAO_CustomField
::displayValue($file['id'], $fileField['id']));
914 * Test for hook_civicrm_alterCustomFieldDisplayValue().
916 public function testAlterCustomFieldDisplayValueHook() {
917 CRM_Utils_Hook_UnitTests
::singleton()->setHook('civicrm_alterCustomFieldDisplayValue', [$this, 'alterCustomFieldDisplayValue']);
918 $customGroupId = $this->customGroupCreate([
919 'extends' => 'Individual',
920 'title' => 'Test Contactcustom Group',
922 $fieldId = $this->customFieldCreate([
923 'custom_group_id' => $customGroupId,
924 'name' => 'alter_cf_field',
925 'label' => 'Alter CF Field',
927 $contactId = $this->individualCreate(['custom_' . $fieldId => 'Test']);
929 $this->assertEquals('Test', $this->callAPISuccessGetValue('Contact',
930 ['id' => $contactId, 'return' => "custom_{$fieldId}"]
935 'custom_' . $fieldId => $this->callAPISuccess('Contact', 'getfield', [
936 'name' => 'custom_' . $fieldId,
941 // CRM_Core_BAO_UFGroup::getValues() invokes CRM_Core_BAO_CustomField::displayValue() function.
942 CRM_Core_BAO_UFGroup
::getValues($contactId, $fields, $values);
943 $this->assertEquals('New value', $values['Alter CF Field']);
947 * @param string $displayValue
948 * @param mixed $value
949 * @param int $entityId
950 * @param array $fieldInfo
953 public function alterCustomFieldDisplayValue(&$displayValue, $value, $entityId, $fieldInfo) {
954 if ($fieldInfo['name'] == 'alter_cf_field') {
955 $displayValue = 'New value';