6 * Class ContactTestTrait
10 * This trait defines a number of helper functions for managing
11 * test contacts. Generally, it depends on having access to the
12 * API test functions ($this->callAPISuccess()) and to the
13 * standard PHPUnit assertions ($this->assertEquals). It should
14 * not impose any other requirements for the downstream consumer class.
16 trait ContactTestTrait
{
19 * Emulate a logged in user since certain functions use that.
20 * value to store a record in the DB (like activity)
22 * @see https://issues.civicrm.org/jira/browse/CRM-8180
25 * Contact ID of the created user.
27 public function createLoggedInUser(): int {
29 'first_name' => 'Logged In',
30 'last_name' => 'User ' . rand(),
31 'contact_type' => 'Individual',
32 'domain_id' => \CRM_Core_Config
::domainID(),
34 $contactID = $this->individualCreate($params);
35 $this->callAPISuccess('UFMatch', 'get', ['uf_id' => 6, 'api.UFMatch.delete' => []]);
36 $this->callAPISuccess('UFMatch', 'create', [
37 'contact_id' => $contactID,
38 'uf_name' => 'superman',
42 $session = \CRM_Core_Session
::singleton();
43 $session->set('userID', $contactID);
48 * Generic function to create Organisation, to be used in test cases
50 * @param array $params
51 * parameters for civicrm_contact_add api function call
53 * sequence number if creating multiple organizations
56 * id of Organisation created
58 public function organizationCreate($params = [], $seq = 0): int {
62 $params = array_merge($this->sampleContact('Organization', $seq), $params);
63 return $this->_contactCreate($params);
67 * Generic function to create Individual, to be used in test cases
69 * @param array $params
70 * parameters for civicrm_contact_add api function call
72 * sequence number if creating multiple individuals
76 * id of Individual created
78 public function individualCreate(array $params = [], $seq = 0, $random = FALSE): int {
79 $params = array_merge($this->sampleContact('Individual', $seq, $random), $params);
80 $this->ids
['Contact']['individual_' . $seq] = $this->_contactCreate($params);
81 return $this->ids
['Contact']['individual_' . $seq];
85 * Generic function to create Household, to be used in test cases
87 * @param array $params
88 * parameters for civicrm_contact_add api function call
90 * sequence number if creating multiple households
93 * id of Household created
95 * @throws \CRM_Core_Exception
97 public function householdCreate($params = [], $seq = 0) {
98 $params = array_merge($this->sampleContact('Household', $seq), $params);
99 return $this->_contactCreate($params);
103 * Helper function for getting sample contact properties.
105 * @param string $contact_type
106 * enum contact type: Individual, Organization
108 * sequence number for the values of this type
109 * @param bool $random
112 * properties of sample contact (ie. $params for API call)
114 public function sampleContact($contact_type, $seq = 0, $random = FALSE) {
117 // The number of values in each list need to be coprime numbers to not have duplicates
118 'first_name' => ['Anthony', 'Joe', 'Terrence', 'Lucie', 'Albert', 'Bill', 'Kim'],
119 'middle_name' => ['J.', 'M.', 'P', 'L.', 'K.', 'A.', 'B.', 'C.', 'D', 'E.', 'Z.'],
120 'last_name' => ['Anderson', 'Miller', 'Smith', 'Collins', 'Peterson'],
123 'organization_name' => [
124 'Unit Test Organization',
132 'household_name' => ['Unit Test household'],
135 $params = ['contact_type' => $contact_type];
136 foreach ($samples[$contact_type] as $key => $values) {
137 $params[$key] = $values[$seq %
count($values)];
139 $params[$key] .= substr(sha1(rand()), 0, 5);
142 if ($contact_type == 'Individual') {
143 $params['email'] = strtolower(
144 $params['first_name'] . '_' . $params['last_name'] . '@civicrm.org'
146 $params['prefix_id'] = 3;
147 $params['suffix_id'] = 3;
153 * Private helper function for calling civicrm_contact_add.
155 * @param array $params
156 * For civicrm_contact_add api function call.
159 * id of contact created
161 private function _contactCreate(array $params): int {
162 $version = $this->_apiversion
;
163 $this->_apiversion
= 3;
164 $result = $this->callAPISuccess('contact', 'create', $params);
165 $this->_apiversion
= $version;
166 return (int) $result['id'];
170 * Delete contact, ensuring it is not the domain contact
172 * @param int $contactID
173 * Contact ID to delete
175 public function contactDelete($contactID) {
176 $domain = new \
CRM_Core_BAO_Domain();
177 $domain->contact_id
= $contactID;
178 if (!$domain->find(TRUE)) {
179 $this->callAPISuccess('contact', 'delete', [
181 'skip_undelete' => 1,
189 * @param array $params
192 * groupId of created group
194 public function groupCreate($params = []) {
195 $params = array_merge([
196 'name' => 'Test Group 1',
198 'title' => 'New Test Group Created',
199 'description' => 'New Test Group Created',
201 'visibility' => 'Public Pages',
208 $result = $this->callAPISuccess('Group', 'create', $params);
209 return $result['id'];
217 public function groupDelete($gid) {
222 $this->callAPISuccess('Group', 'delete', $params);
226 * Function to add a Group.
228 * @params array to add group
230 * @param int $groupID
231 * @param int $totalCount
232 * @param bool $random
235 * groupId of created group
237 public function groupContactCreate($groupID, $totalCount = 10, $random = FALSE) {
238 $params = ['group_id' => $groupID];
239 for ($i = 1; $i <= $totalCount; $i++
) {
240 $contactID = $this->individualCreate([], 0, $random);
242 $params +
= ['contact_id' => $contactID];
245 $params +
= ["contact_id.$i" => $contactID];
248 $result = $this->callAPISuccess('GroupContact', 'create', $params);