api/v3/examples/GroupContact/Create.ex.php

   1 <?php
   2 /**
   3  * Test Generated example demonstrating the GroupContact.create API.
   4  *
   5  * @return array
   6  *   API result array
   7  */
   8 function group_contact_create_example() {
   9   $params = [
  10     'contact_id' => 8,
  11     'contact_id.2' => 9,
  12     'group_id' => 11,
  13   ];
  14
  15   try{
  16     $result = civicrm_api3('GroupContact', 'create', $params);
  17   }
  18   catch (CiviCRM_API3_Exception $e) {
  19     // Handle error here.
  20     $errorMessage = $e->getMessage();
  21     $errorCode = $e->getErrorCode();
  22     $errorData = $e->getExtraParams();
  23     return [
  24       'is_error' => 1,
  25       'error_message' => $errorMessage,
  26       'error_code' => $errorCode,
  27       'error_data' => $errorData,
  28     ];
  29   }
  30
  31   return $result;
  32 }
  33
  34 /**
  35  * Function returns array of result expected from previous function.
  36  *
  37  * @return array
  38  *   API result array
  39  */
  40 function group_contact_create_expectedresult() {
  41
  42   $expectedResult = [
  43     'is_error' => 0,
  44     'version' => 3,
  45     'count' => 1,
  46     'values' => 1,
  47     'total_count' => 2,
  48     'added' => 1,
  49     'not_added' => 1,
  50   ];
  51
  52   return $expectedResult;
  53 }
  54
  55 /*
  56 * This example has been generated from the API test suite.
  57 * The test that created it is called "testCreate"
  58 * and can be found at:
  59 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/GroupContactTest.php
  60 *
  61 * You can see the outcome of the API tests at
  62 * https://test.civicrm.org/job/CiviCRM-Core-Matrix/
  63 *
  64 * To Learn about the API read
  65 * https://docs.civicrm.org/dev/en/latest/api/
  66 *
  67 * Browse the API on your own site with the API Explorer. It is in the main
  68 * CiviCRM menu, under: Support > Development > API Explorer.
  69 *
  70 * Read more about testing here
  71 * https://docs.civicrm.org/dev/en/latest/testing/
  72 *
  73 * API Standards documentation:
  74 * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/
  75 */