api/v3/examples/GroupContact/Create.php

   1 <?php
   2 /**
   3  * Test Generated example of using group_contact create API.
   4  *
   5  *
   6  * @return array
   7  *   API result array
   8  */
   9 function group_contact_create_example() {
  10   $params = array(
  11     'contact_id' => 8,
  12     'contact_id.2' => 9,
  13     'group_id' => 11,
  14   );
  15
  16   try{
  17     $result = civicrm_api3('group_contact', 'create', $params);
  18   }
  19   catch (CiviCRM_API3_Exception $e) {
  20     // Handle error here.
  21     $errorMessage = $e->getMessage();
  22     $errorCode = $e->getErrorCode();
  23     $errorData = $e->getExtraParams();
  24     return array(
  25       'error' => $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 = array(
  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
  58 * testCreate
  59 * and can be found in
  60 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/GroupContactTest.php
  61 *
  62 * You can see the outcome of the API tests at
  63 * https://test.civicrm.org/job/CiviCRM-master-git/
  64 *
  65 * To Learn about the API read
  66 * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
  67 *
  68 * Browse the api on your own site with the api explorer
  69 * http://MYSITE.ORG/path/to/civicrm/api
  70 *
  71 * Read more about testing here
  72 * http://wiki.civicrm.org/confluence/display/CRM/Testing
  73 *
  74 * API Standards documentation:
  75 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
  76 */