api/v3/examples/GroupContact/Delete.php

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