1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
|
<?php
namespace Civi\Test\Api4\Action;
use Civi\Api4\CustomField;
use Civi\Api4\CustomGroup;
use Civi\Api4\CustomValue;
use Civi\Api4\Contact;
/**
* @group headless
*/
class CustomValueTest extends BaseCustomValueTest {
protected $contactID;
/**
* Test CustomValue::GetFields/Get/Create/Update/Replace/Delete
*/
public function testCRUD() {
$optionValues = ['r' => 'Red', 'g' => 'Green', 'b' => 'Blue'];
$group = uniqid('groupc');
$colorField = uniqid('colorc');
$customGroup = CustomGroup::create()
->setCheckPermissions(FALSE)
->addValue('name', $group)
->addValue('extends', 'Contact')
->addValue('is_multiple', TRUE)
->execute()
->first();
CustomField::create()
->setCheckPermissions(FALSE)
->addValue('label', $colorField)
->addValue('options', $optionValues)
->addValue('custom_group_id', $customGroup['id'])
->addValue('html_type', 'Select')
->addValue('data_type', 'String')
->execute();
$this->contactID = Contact::create()
->setCheckPermissions(FALSE)
->addValue('first_name', 'Johann')
->addValue('last_name', 'Tester')
->addValue('contact_type', 'Individual')
->execute()
->first()['id'];
// Retrieve and check the fields of CustomValue = Custom_$group
$fields = CustomValue::getFields($group)->execute();
$expectedResult = [
[
'custom_field_id' => 1,
'custom_group' => $group,
'name' => $colorField,
'title' => ts($colorField),
'entity' => "Custom_$group",
'data_type' => 'String',
'fk_entity' => NULL,
],
[
'name' => 'id',
'title' => ts('Custom Value ID'),
'entity' => "Custom_$group",
'data_type' => 'Integer',
'fk_entity' => NULL,
],
[
'name' => 'entity_id',
'title' => ts('Entity ID'),
'entity' => "Custom_$group",
'data_type' => 'Integer',
'fk_entity' => 'Contact',
],
];
foreach ($expectedResult as $key => $field) {
foreach ($field as $attr => $value) {
$this->assertEquals($expectedResult[$key][$attr], $fields[$key][$attr]);
}
}
// CASE 1: Test CustomValue::create
// Create two records for a single contact and using CustomValue::get ensure that two records are created
CustomValue::create($group)
->addValue($colorField, 'Green')
->addValue("entity_id", $this->contactID)
->execute();
CustomValue::create($group)
->addValue($colorField, 'Red')
->addValue("entity_id", $this->contactID)
->execute();
// fetch custom values using API4 CustomValue::get
$result = CustomValue::get($group)->execute();
// check if two custom values are created
$this->assertEquals(2, count($result));
$expectedResult = [
[
'id' => 1,
$colorField => 'Green',
'entity_id' => $this->contactID,
],
[
'id' => 2,
$colorField => 'Red',
'entity_id' => $this->contactID,
],
];
// match the data
foreach ($expectedResult as $key => $field) {
foreach ($field as $attr => $value) {
$this->assertEquals($expectedResult[$key][$attr], $result[$key][$attr]);
}
}
// CASE 2: Test CustomValue::update
// Update a records whose id is 1 and change the custom field (name = Color) value to 'White' from 'Green'
CustomValue::update($group)
->addWhere("id", "=", 1)
->addValue($colorField, 'White')
->execute();
// ensure that the value is changed for id = 1
$color = CustomValue::get($group)
->addWhere("id", "=", 1)
->execute()
->first()[$colorField];
$this->assertEquals('White', $color);
// CASE 3: Test CustomValue::replace
// create a second contact which will be used to replace the custom values, created earlier
$secondContactID = Contact::create()
->setCheckPermissions(FALSE)
->addValue('first_name', 'Adam')
->addValue('last_name', 'Tester')
->addValue('contact_type', 'Individual')
->execute()
->first()['id'];
// Replace all the records which was created earlier with entity_id = first contact
// with custom record [$colorField => 'Rainbow', 'entity_id' => $secondContactID]
CustomValue::replace($group)
->setRecords([[$colorField => 'Rainbow', 'entity_id' => $secondContactID]])
->addWhere('entity_id', '=', $this->contactID)
->execute();
// Check the two records created earlier is replaced by new contact
$result = CustomValue::get($group)->execute();
$this->assertEquals(1, count($result));
$expectedResult = [
[
'id' => 3,
$colorField => 'Rainbow',
'entity_id' => $secondContactID,
],
];
foreach ($expectedResult as $key => $field) {
foreach ($field as $attr => $value) {
$this->assertEquals($expectedResult[$key][$attr], $result[$key][$attr]);
}
}
// CASE 4: Test CustomValue::delete
// There is only record left whose id = 3, delete that record on basis of criteria id = 3
CustomValue::delete($group)->addWhere("id", "=", 3)->execute();
$result = CustomValue::get($group)->execute();
// check that there are no custom values present
$this->assertEquals(0, count($result));
}
}
|
