6 * Class ContactTestTrait
9 * This trait defines a number of helper functions for managing
10 * test contacts. Generally, it depends on having access to the
11 * API test functions ($this->callAPISuccess()) and to the
12 * standard PHPUnit assertions ($this->assertEquals). It should
13 * not impose any other requirements for the downstream consumer class.
15 trait ContactTestTrait
{
18 * Emulate a logged in user since certain functions use that.
19 * value to store a record in the DB (like activity)
23 * Contact ID of the created user.
25 public function createLoggedInUser() {
27 'first_name' => 'Logged In',
28 'last_name' => 'User ' . rand(),
29 'contact_type' => 'Individual',
30 'domain_id' => \CRM_Core_Config
::domainID(),
32 $contactID = $this->individualCreate($params);
33 $this->callAPISuccess('UFMatch', 'create', array(
34 'contact_id' => $contactID,
35 'uf_name' => 'superman',
39 $session = \CRM_Core_Session
::singleton();
40 $session->set('userID', $contactID);
45 * Generic function to create Organisation, to be used in test cases
47 * @param array $params
48 * parameters for civicrm_contact_add api function call
50 * sequence number if creating multiple organizations
53 * id of Organisation created
55 public function organizationCreate($params = array(), $seq = 0) {
59 $params = array_merge($this->sampleContact('Organization', $seq), $params);
60 return $this->_contactCreate($params);
64 * Generic function to create Individual, to be used in test cases
66 * @param array $params
67 * parameters for civicrm_contact_add api function call
69 * sequence number if creating multiple individuals
73 * id of Individual created
75 * @throws \CRM_Core_Exception
77 public function individualCreate($params = array(), $seq = 0, $random = FALSE) {
78 $params = array_merge($this->sampleContact('Individual', $seq, $random), $params);
79 return $this->_contactCreate($params);
83 * Generic function to create Household, to be used in test cases
85 * @param array $params
86 * parameters for civicrm_contact_add api function call
88 * sequence number if creating multiple households
91 * id of Household created
94 public function householdCreate($params = array(), $seq = 0) {
95 $params = array_merge($this->sampleContact('Household', $seq), $params);
96 return $this->_contactCreate($params);
100 * Helper function for getting sample contact properties.
102 * @param string $contact_type
103 * enum contact type: Individual, Organization
105 * sequence number for the values of this type
106 * @param bool $random
109 * properties of sample contact (ie. $params for API call)
111 public function sampleContact($contact_type, $seq = 0, $random = FALSE) {
113 'Individual' => array(
114 // The number of values in each list need to be coprime numbers to not have duplicates
115 'first_name' => array('Anthony', 'Joe', 'Terrence', 'Lucie', 'Albert', 'Bill', 'Kim'),
116 'middle_name' => array('J.', 'M.', 'P', 'L.', 'K.', 'A.', 'B.', 'C.', 'D', 'E.', 'Z.'),
117 'last_name' => array('Anderson', 'Miller', 'Smith', 'Collins', 'Peterson'),
119 'Organization' => array(
120 'organization_name' => array(
121 'Unit Test Organization',
128 'Household' => array(
129 'household_name' => array('Unit Test household'),
132 $params = array('contact_type' => $contact_type);
133 foreach ($samples[$contact_type] as $key => $values) {
134 $params[$key] = $values[$seq %
count($values)];
136 $params[$key] .= substr(sha1(rand()), 0, 5);
139 if ($contact_type == 'Individual') {
140 $params['email'] = strtolower(
141 $params['first_name'] . '_' . $params['last_name'] . '@civicrm.org'
143 $params['prefix_id'] = 3;
144 $params['suffix_id'] = 3;
150 * Private helper function for calling civicrm_contact_add.
152 * @param array $params
153 * For civicrm_contact_add api function call.
155 * @throws CRM_Core_Exception
158 * id of Household created
160 private function _contactCreate($params) {
161 $result = $this->callAPISuccess('contact', 'create', $params);
162 if (!empty($result['is_error']) ||
empty($result['id'])) {
163 throw new \
CRM_Core_Exception('Could not create test contact, with message: ' . \CRM_Utils_Array
::value('error_message', $result) . "\nBacktrace:" . \CRM_Utils_Array
::value('trace', $result));
165 return $result['id'];
169 * Delete contact, ensuring it is not the domain contact
171 * @param int $contactID
172 * Contact ID to delete
174 public function contactDelete($contactID) {
175 $domain = new \
CRM_Core_BAO_Domain();
176 $domain->contact_id
= $contactID;
177 if (!$domain->find(TRUE)) {
178 $this->callAPISuccess('contact', 'delete', array(
180 'skip_undelete' => 1,
188 * @param array $params
190 * groupId of created group
192 public function groupCreate($params = array()) {
193 $params = array_merge(array(
194 'name' => 'Test Group 1',
196 'title' => 'New Test Group Created',
197 'description' => 'New Test Group Created',
199 'visibility' => 'Public Pages',
200 'group_type' => array(
206 $result = $this->callAPISuccess('Group', 'create', $params);
207 return $result['id'];
215 public function groupDelete($gid) {
220 $this->callAPISuccess('Group', 'delete', $params);
224 * Function to add a Group.
226 * @params array to add group
228 * @param int $groupID
229 * @param int $totalCount
230 * @param bool $random
232 * groupId of created group
234 public function groupContactCreate($groupID, $totalCount = 10, $random = FALSE) {
235 $params = array('group_id' => $groupID);
236 for ($i = 1; $i <= $totalCount; $i++
) {
237 $contactID = $this->individualCreate(array(), 0, $random);
239 $params +
= array('contact_id' => $contactID);
242 $params +
= array("contact_id.$i" => $contactID);
245 $result = $this->callAPISuccess('GroupContact', 'create', $params);