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 $subtypes = array_keys($this->getExpectedAllSubtypes());
81 $this->assertEquals(sort($subtypes), sort($result));
85 * Test subTypes() methods with invalid data
87 public function testGetMethodsInvalid() {
90 $result = CRM_Contact_BAO_ContactType
::subTypes($params);
91 $this->assertEquals(empty($result), TRUE);
93 $params = ['invalid'];
94 $result = CRM_Contact_BAO_ContactType
::subTypes($params);
95 $this->assertEquals(empty($result), TRUE);
99 * Test function for getting contact types.
101 * @throws \API_Exception
103 public function testContactTypeInfo() {
104 $blahType = ['is_active' => 0, 'name' => 'blah', 'label' => 'blah blah', 'parent_id:name' => 'Individual'];
105 $createdType = ContactType
::create()->setValues($blahType)->execute()->first();
106 $activeTypes = CRM_Contact_BAO_ContactType
::contactTypeInfo();
107 $expected = $this->getExpectedContactTypes();
108 $this->assertEquals($expected, $activeTypes);
109 $allTypes = CRM_Contact_BAO_ContactType
::contactTypeInfo(TRUE);
110 $expected['blah'] = [
113 'label' => 'blah blah',
114 'id' => $createdType['id'],
117 'parent' => 'Individual',
118 'parent_label' => 'Individual',
120 $this->assertEquals($expected, $allTypes);
124 * Get all expected types.
128 public function getExpectedContactTypes() {
133 'name' => 'Individual',
134 'label' => 'Individual',
136 'is_reserved' => '1',
141 'name' => 'Household',
142 'label' => 'Household',
144 'is_reserved' => '1',
149 'name' => 'Organization',
150 'label' => 'Organization',
152 'is_reserved' => '1',
158 'label' => 'Student',
161 'is_reserved' => '0',
162 'parent' => 'Individual',
163 'parent_label' => 'Individual',
172 'is_reserved' => '0',
173 'parent' => 'Individual',
174 'parent_label' => 'Individual',
183 'is_reserved' => '0',
184 'parent' => 'Individual',
185 'parent_label' => 'Individual',
194 'is_reserved' => '0',
195 'parent' => 'Organization',
196 'parent_label' => 'Organization',
202 'label' => 'Sponsor',
205 'is_reserved' => '0',
206 'parent' => 'Organization',
207 'parent_label' => 'Organization',
211 'id' => $this->ids
['ContactType'][0],
212 'name' => 'sub1_individual',
213 'label' => 'sub1_individual',
216 'is_reserved' => '0',
217 'parent' => 'Individual',
218 'parent_label' => 'Individual',
222 'id' => $this->ids
['ContactType'][1],
223 'name' => 'sub2_individual',
224 'label' => 'sub2_individual',
227 'is_reserved' => '0',
228 'parent' => 'Individual',
229 'parent_label' => 'Individual',
231 'sub_organization' =>
233 'id' => $this->ids
['ContactType'][2],
234 'name' => 'sub_organization',
235 'label' => 'sub_organization',
238 'is_reserved' => '0',
239 'parent' => 'Organization',
240 'parent_label' => 'Organization',
244 'id' => $this->ids
['ContactType'][3],
245 'name' => 'sub_household',
246 'label' => 'sub_household',
249 'is_reserved' => '0',
250 'parent' => 'Household',
251 'parent_label' => 'Household',
257 * Get subtypes for all main types.
261 public function getExpectedAllSubtypes() {
263 $this->getExpectedContactSubTypes('Individual'),
264 $this->getExpectedContactSubTypes('Household'),
265 $this->getExpectedContactSubTypes('Organization')
270 * Get the expected subtypes of the given contact type.
272 * @param string $parentType
276 public function getExpectedContactSubTypes($parentType) {
277 $expected = $this->getExpectedContactTypes();
278 foreach ($expected as $index => $values) {
279 if (($values['parent_label'] ??
'') !== $parentType) {
280 unset($expected[$index]);
287 * Test add() methods with valid data
290 public function testAdd() {
293 'label' => 'indiviSubType',
294 'name' => 'indiviSubType',
298 $result = CRM_Contact_BAO_ContactType
::add($params);
299 $this->assertEquals($result->label
, $params['label']);
300 $this->assertEquals($result->name
, $params['name']);
301 $this->assertEquals($result->parent_id
, $params['parent_id']);
302 $this->assertEquals($result->is_active
, $params['is_active']);
303 CRM_Contact_BAO_ContactType
::del($result->id
);
306 'label' => 'householdSubType',
307 'name' => 'householdSubType',
311 $result = CRM_Contact_BAO_ContactType
::add($params);
312 $this->assertEquals($result->label
, $params['label']);
313 $this->assertEquals($result->name
, $params['name']);
314 $this->assertEquals($result->parent_id
, $params['parent_id']);
315 $this->assertEquals($result->is_active
, $params['is_active']);
316 CRM_Contact_BAO_ContactType
::del($result->id
);
320 * Test add() with invalid data
322 public function testAddInvalid1() {
324 // parent id does not exist in db
326 'label' => 'subType',
332 $result = CRM_Contact_BAO_ContactType
::add($params);
333 $this->assertEquals($result, NULL);
336 public function testAddInvalid2() {
338 // params does not have name and label keys
343 $result = CRM_Contact_BAO_ContactType
::add($params);
344 $this->assertEquals($result, NULL);
347 public function testAddInvalid3() {
349 // params does not have parent_id
351 'label' => 'subType',
355 $result = CRM_Contact_BAO_ContactType
::add($params);
356 $this->assertEquals($result, NULL);
360 * Test del() with valid data.
362 public function testDel() {
365 'label' => 'indiviSubType',
366 'name' => 'indiviSubType',
370 $subtype = CRM_Contact_BAO_ContactType
::add($params);
371 $result = CRM_Contact_BAO_ContactType
::subTypes();
372 $this->assertEquals(TRUE, in_array($subtype->name
, $result, TRUE));
373 $this->callAPISuccess('ContactType', 'delete', ['id' => $subtype->id
]);
375 $result = CRM_Contact_BAO_ContactType
::subTypes();
376 $this->assertEquals(FALSE, in_array($subtype->name
, $result, TRUE));
380 * Test del() with invalid data
382 public function testDelInvalid() {
383 $del = CRM_Contact_BAO_ContactType
::del(NULL);
384 $this->assertEquals($del, FALSE);