api/v3/examples/GroupContact/Create.php

   1 <?php
   2 /**
   3  * Test Generated example of using group_contact create API
   4  * *
   5  */
   6 function group_contact_create_example(){
   7 $params = array(
   8   'contact_id' => 1,
   9   'contact_id.2' => 2,
  10   'group_id' => 1,
  11 );
  12
  13 try{
  14   $result = civicrm_api3('group_contact', 'create', $params);
  15 }
  16 catch (CiviCRM_API3_Exception $e) {
  17   // handle error here
  18   $errorMessage = $e->getMessage();
  19   $errorCode = $e->getErrorCode();
  20   $errorData = $e->getExtraParams();
  21   return array('error' => $errorMessage, 'error_code' => $errorCode, 'error_data' => $errorData);
  22 }
  23
  24 return $result;
  25 }
  26
  27 /**
  28  * Function returns array of result expected from previous function
  29  */
  30 function group_contact_create_expectedresult(){
  31
  32   $expectedResult = array(
  33   'is_error' => 0,
  34   'version' => 3,
  35   'count' => 1,
  36   'values' => 1,
  37   'total_count' => 2,
  38   'added' => 1,
  39   'not_added' => 1,
  40 );
  41
  42   return $expectedResult;
  43 }
  44
  45
  46 /*
  47 * This example has been generated from the API test suite. The test that created it is called
  48 *
  49 * testCreate and can be found in
  50 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/GroupContactTest.php
  51 *
  52 * You can see the outcome of the API tests at
  53 * https://test.civicrm.org/job/CiviCRM-master-git/
  54 *
  55 * To Learn about the API read
  56 * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
  57 *
  58 * Browse the api on your own site with the api explorer
  59 * http://MYSITE.ORG/path/to/civicrm/api/explorer
  60 *
  61 * Read more about testing here
  62 * http://wiki.civicrm.org/confluence/display/CRM/Testing
  63 *
  64 * API Standards documentation:
  65 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
  66 */