Civi/Test/ContactTestTrait.php

   1 <?php
   2
   3 namespace Civi\Test;
   4
   5 /**
   6  * Class ContactTestTrait
   7  *
   8  * @package Civi\Test
   9  *
  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.
  15  */
  16 trait ContactTestTrait {
  17
  18   /**
  19    * Emulate a logged in user since certain functions use that.
  20    * value to store a record in the DB (like activity)
  21    *
  22    * @see https://issues.civicrm.org/jira/browse/CRM-8180
  23    *
  24    * @return int
  25    *   Contact ID of the created user.
  26    */
  27   public function createLoggedInUser(): int {
  28     $params = [
  29       'first_name' => 'Logged In',
  30       'last_name' => 'User ' . rand(),
  31       'contact_type' => 'Individual',
  32       'domain_id' => \CRM_Core_Config::domainID(),
  33     ];
  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',
  39       'uf_id' => 6,
  40     ]);
  41
  42     $session = \CRM_Core_Session::singleton();
  43     $session->set('userID', $contactID);
  44     return $contactID;
  45   }
  46
  47   /**
  48    * Generic function to create Organisation, to be used in test cases
  49    *
  50    * @param array $params
  51    *   parameters for civicrm_contact_add api function call
  52    * @param int $seq
  53    *   sequence number if creating multiple organizations
  54    *
  55    * @return int
  56    *   id of Organisation created
  57    */
  58   public function organizationCreate($params = [], $seq = 0): int {
  59     if (!$params) {
  60       $params = [];
  61     }
  62     $params = array_merge($this->sampleContact('Organization', $seq), $params);
  63     return $this->_contactCreate($params);
  64   }
  65
  66   /**
  67    * Generic function to create Individual, to be used in test cases
  68    *
  69    * @param array $params
  70    *   parameters for civicrm_contact_add api function call
  71    * @param int $seq
  72    *   sequence number if creating multiple individuals
  73    * @param bool $random
  74    *
  75    * @return int
  76    *   id of Individual created
  77    */
  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];
  82   }
  83
  84   /**
  85    * Generic function to create Household, to be used in test cases
  86    *
  87    * @param array $params
  88    *   parameters for civicrm_contact_add api function call
  89    * @param int $seq
  90    *   sequence number if creating multiple households
  91    *
  92    * @return int
  93    *   id of Household created
  94    *
  95    * @throws \CRM_Core_Exception
  96    */
  97   public function householdCreate($params = [], $seq = 0) {
  98     $params = array_merge($this->sampleContact('Household', $seq), $params);
  99     return $this->_contactCreate($params);
 100   }
 101
 102   /**
 103    * Helper function for getting sample contact properties.
 104    *
 105    * @param string $contact_type
 106    *   enum contact type: Individual, Organization
 107    * @param int $seq
 108    *   sequence number for the values of this type
 109    * @param bool $random
 110    *
 111    * @return array
 112    *   properties of sample contact (ie. $params for API call)
 113    */
 114   public function sampleContact($contact_type, $seq = 0, $random = FALSE) {
 115     $samples = [
 116       'Individual' => [
 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'],
 121       ],
 122       'Organization' => [
 123         'organization_name' => [
 124           'Unit Test Organization',
 125           'Acme',
 126           'Roberts and Sons',
 127           'Cryo Space Labs',
 128           'Sharper Pens',
 129         ],
 130       ],
 131       'Household' => [
 132         'household_name' => ['Unit Test household'],
 133       ],
 134     ];
 135     $params = ['contact_type' => $contact_type];
 136     foreach ($samples[$contact_type] as $key => $values) {
 137       $params[$key] = $values[$seq % count($values)];
 138       if ($random) {
 139         $params[$key] .= substr(sha1(rand()), 0, 5);
 140       }
 141     }
 142     if ($contact_type == 'Individual') {
 143       $params['email'] = strtolower(
 144         $params['first_name'] . '_' . $params['last_name'] . '@civicrm.org'
 145       );
 146       $params['prefix_id'] = 3;
 147       $params['suffix_id'] = 3;
 148     }
 149     return $params;
 150   }
 151
 152   /**
 153    * Private helper function for calling civicrm_contact_add.
 154    *
 155    * @param array $params
 156    *   For civicrm_contact_add api function call.
 157    *
 158    * @return int
 159    *   id of contact created
 160    */
 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'];
 167   }
 168
 169   /**
 170    * Delete contact, ensuring it is not the domain contact
 171    *
 172    * @param int $contactID
 173    *   Contact ID to delete
 174    */
 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', [
 180         'id' => $contactID,
 181         'skip_undelete' => 1,
 182       ]);
 183     }
 184   }
 185
 186   /**
 187    * Add a Group.
 188    *
 189    * @param array $params
 190    *
 191    * @return int
 192    *   groupId of created group
 193    */
 194   public function groupCreate($params = []) {
 195     $params = array_merge([
 196       'name' => 'Test Group 1',
 197       'domain_id' => 1,
 198       'title' => 'New Test Group Created',
 199       'description' => 'New Test Group Created',
 200       'is_active' => 1,
 201       'visibility' => 'Public Pages',
 202       'group_type' => [
 203         '1' => 1,
 204         '2' => 1,
 205       ],
 206     ], $params);
 207
 208     $result = $this->callAPISuccess('Group', 'create', $params);
 209     return $result['id'];
 210   }
 211
 212   /**
 213    * Delete a Group.
 214    *
 215    * @param int $gid
 216    */
 217   public function groupDelete($gid) {
 218     $params = [
 219       'id' => $gid,
 220     ];
 221
 222     $this->callAPISuccess('Group', 'delete', $params);
 223   }
 224
 225   /**
 226    * Function to add a Group.
 227    *
 228    * @params array to add group
 229    *
 230    * @param int $groupID
 231    * @param int $totalCount
 232    * @param bool $random
 233    *
 234    * @return int
 235    *   groupId of created group
 236    */
 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);
 241       if ($i == 1) {
 242         $params += ['contact_id' => $contactID];
 243       }
 244       else {
 245         $params += ["contact_id.$i" => $contactID];
 246       }
 247     }
 248     $result = $this->callAPISuccess('GroupContact', 'create', $params);
 249
 250     return $result;
 251   }
 252
 253 }