2 use Civi\Api4\ContactType
;
5 * Class CRM_Contact_BAO_ContactType_ContactTypeTest
8 class CRM_Contact_BAO_ContactType_ContactTypeTest
extends CiviUnitTestCase
{
10 public function setUp() {
13 'label' => 'sub1_individual',
14 'name' => 'sub1_individual',
15 'parent_id:name' => 'Individual',
19 $this->ids
['ContactType'][] = ContactType
::create()->setValues($params)->execute()->first()['id'];
22 'label' => 'sub2_individual',
23 'name' => 'sub2_individual',
24 'parent_id:name' => 'Individual',
28 $this->ids
['ContactType'][] = ContactType
::create()->setValues($params)->execute()->first()['id'];
31 'label' => 'sub_organization',
32 'name' => 'sub_organization',
33 'parent_id:name' => 'Organization',
37 $this->ids
['ContactType'][] = ContactType
::create()->setValues($params)->execute()->first()['id'];
40 'label' => 'sub_household',
41 'name' => 'sub_household',
42 'parent_id:name' => 'Household',
45 $this->ids
['ContactType'][] = ContactType
::create()->setValues($params)->execute()->first()['id'];
49 * Cleanup contact types.
51 * @throws \API_Exception
52 * @throws \Civi\API\Exception\UnauthorizedException
54 public function tearDown() {
56 ContactType
::delete()->addWhere('id', 'IN', $this->ids
['ContactType'])->execute();
60 * Test contactTypes() and subTypes() methods return correct contact types.
62 public function testGetMethods() {
63 $result = CRM_Contact_BAO_ContactType
::contactTypes(TRUE);
64 $this->assertEquals(array_keys($this->getExpectedContactTypes()), $result);
66 // check for type:Individual
67 $result = CRM_Contact_BAO_ContactType
::subTypes('Individual');
68 $this->assertEquals(array_keys($this->getExpectedContactSubTypes('Individual')), $result);
70 // check for type:Organization
71 $result = CRM_Contact_BAO_ContactType
::subTypes('Organization');
72 $this->assertEquals(array_keys($this->getExpectedContactSubTypes('Organization')), $result);
74 // check for type:Household
75 $result = CRM_Contact_BAO_ContactType
::subTypes('Household');
76 $this->assertEquals(array_keys($this->getExpectedContactSubTypes('Household')), $result);
78 // check for all contact types
79 $result = CRM_Contact_BAO_ContactType
::subTypes();
80 $this->assertEquals(array_keys($this->getExpectedAllSubtypes()), $result);
84 * Test subTypes() methods with invalid data
86 public function testGetMethodsInvalid() {
89 $result = CRM_Contact_BAO_ContactType
::subTypes($params);
90 $this->assertEquals(empty($result), TRUE);
92 $params = ['invalid'];
93 $result = CRM_Contact_BAO_ContactType
::subTypes($params);
94 $this->assertEquals(empty($result), TRUE);
98 * Test function for getting contact types.
100 * @throws \API_Exception
102 public function testContactTypeInfo() {
103 $blahType = ['is_active' => 0, 'name' => 'blah', 'label' => 'blah blah', 'parent_id:name' => 'Individual'];
104 $createdType = ContactType
::create()->setValues($blahType)->execute()->first();
105 $activeTypes = CRM_Contact_BAO_ContactType
::contactTypeInfo();
106 $expected = $this->getExpectedContactTypes();
107 $this->assertEquals($expected, $activeTypes);
108 $allTypes = CRM_Contact_BAO_ContactType
::contactTypeInfo(TRUE);
109 $expected['blah'] = [
112 'label' => 'blah blah',
113 'id' => $createdType['id'],
116 'parent' => 'Individual',
117 'parent_label' => 'Individual',
119 $this->assertEquals($expected, $allTypes);
123 * Get all expected types.
127 public function getExpectedContactTypes() {
132 'name' => 'Individual',
133 'label' => 'Individual',
135 'is_reserved' => '1',
140 'name' => 'Household',
141 'label' => 'Household',
143 'is_reserved' => '1',
148 'name' => 'Organization',
149 'label' => 'Organization',
151 'is_reserved' => '1',
157 'label' => 'Student',
160 'is_reserved' => '0',
161 'parent' => 'Individual',
162 'parent_label' => 'Individual',
171 'is_reserved' => '0',
172 'parent' => 'Individual',
173 'parent_label' => 'Individual',
182 'is_reserved' => '0',
183 'parent' => 'Individual',
184 'parent_label' => 'Individual',
193 'is_reserved' => '0',
194 'parent' => 'Organization',
195 'parent_label' => 'Organization',
201 'label' => 'Sponsor',
204 'is_reserved' => '0',
205 'parent' => 'Organization',
206 'parent_label' => 'Organization',
210 'id' => $this->ids
['ContactType'][0],
211 'name' => 'sub1_individual',
212 'label' => 'sub1_individual',
215 'is_reserved' => '0',
216 'parent' => 'Individual',
217 'parent_label' => 'Individual',
221 'id' => $this->ids
['ContactType'][1],
222 'name' => 'sub2_individual',
223 'label' => 'sub2_individual',
226 'is_reserved' => '0',
227 'parent' => 'Individual',
228 'parent_label' => 'Individual',
230 'sub_organization' =>
232 'id' => $this->ids
['ContactType'][2],
233 'name' => 'sub_organization',
234 'label' => 'sub_organization',
237 'is_reserved' => '0',
238 'parent' => 'Organization',
239 'parent_label' => 'Organization',
243 'id' => $this->ids
['ContactType'][3],
244 'name' => 'sub_household',
245 'label' => 'sub_household',
248 'is_reserved' => '0',
249 'parent' => 'Household',
250 'parent_label' => 'Household',
256 * Get subtypes for all main types.
260 public function getExpectedAllSubtypes() {
262 $this->getExpectedContactSubTypes('Individual'),
263 $this->getExpectedContactSubTypes('Household'),
264 $this->getExpectedContactSubTypes('Organization')
269 * Get the expected subtypes of the given contact type.
271 * @param string $parentType
275 public function getExpectedContactSubTypes($parentType) {
276 $expected = $this->getExpectedContactTypes();
277 foreach ($expected as $index => $values) {
278 if (($values['parent_label'] ??
'') !== $parentType) {
279 unset($expected[$index]);
286 * Test add() methods with valid data
289 public function testAdd() {
292 'label' => 'indiviSubType',
293 'name' => 'indiviSubType',
297 $result = CRM_Contact_BAO_ContactType
::add($params);
298 $this->assertEquals($result->label
, $params['label']);
299 $this->assertEquals($result->name
, $params['name']);
300 $this->assertEquals($result->parent_id
, $params['parent_id']);
301 $this->assertEquals($result->is_active
, $params['is_active']);
302 CRM_Contact_BAO_ContactType
::del($result->id
);
305 'label' => 'householdSubType',
306 'name' => 'householdSubType',
310 $result = CRM_Contact_BAO_ContactType
::add($params);
311 $this->assertEquals($result->label
, $params['label']);
312 $this->assertEquals($result->name
, $params['name']);
313 $this->assertEquals($result->parent_id
, $params['parent_id']);
314 $this->assertEquals($result->is_active
, $params['is_active']);
315 CRM_Contact_BAO_ContactType
::del($result->id
);
319 * Test add() with invalid data
321 public function testAddInvalid1() {
323 // parent id does not exist in db
325 'label' => 'subType',
331 $result = CRM_Contact_BAO_ContactType
::add($params);
332 $this->assertEquals($result, NULL);
335 public function testAddInvalid2() {
337 // params does not have name and label keys
342 $result = CRM_Contact_BAO_ContactType
::add($params);
343 $this->assertEquals($result, NULL);
346 public function testAddInvalid3() {
348 // params does not have parent_id
350 'label' => 'subType',
354 $result = CRM_Contact_BAO_ContactType
::add($params);
355 $this->assertEquals($result, NULL);
359 * Test del() with valid data.
361 public function testDel() {
364 'label' => 'indiviSubType',
365 'name' => 'indiviSubType',
369 $subtype = CRM_Contact_BAO_ContactType
::add($params);
370 $result = CRM_Contact_BAO_ContactType
::subTypes();
371 $this->assertEquals(TRUE, in_array($subtype->name
, $result, TRUE));
372 $this->callAPISuccess('ContactType', 'delete', ['id' => $subtype->id
]);
374 $result = CRM_Contact_BAO_ContactType
::subTypes();
375 $this->assertEquals(FALSE, in_array($subtype->name
, $result, TRUE));
379 * Test del() with invalid data
381 public function testDelInvalid() {
382 $del = CRM_Contact_BAO_ContactType
::del(NULL);
383 $this->assertEquals($del, FALSE);