api/v3/examples/GroupContact/Get.php

   1 <?php
   2 /**
   3  * Test Generated example of using group_contact get API.
   4  *
   5  * @return array
   6  *   API result array
   7  */
   8 function group_contact_get_example() {
   9   $params = array(
  10     'contact_id' => 3,
  11   );
  12
  13   try{
  14     $result = civicrm_api3('group_contact', 'get', $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(
  22       'error' => $errorMessage,
  23       'error_code' => $errorCode,
  24       'error_data' => $errorData,
  25     );
  26   }
  27
  28   return $result;
  29 }
  30
  31 /**
  32  * Function returns array of result expected from previous function.
  33  *
  34  * @return array
  35  *   API result array
  36  */
  37 function group_contact_get_expectedresult() {
  38
  39   $expectedResult = array(
  40     'is_error' => 0,
  41     'version' => 3,
  42     'count' => 1,
  43     'id' => 1,
  44     'values' => array(
  45       '1' => array(
  46         'id' => '1',
  47         'group_id' => '1',
  48         'title' => 'New Test Group Created',
  49         'visibility' => 'Public Pages',
  50         'is_hidden' => 0,
  51         'in_date' => '2013-07-28 08:50:19',
  52         'in_method' => 'API',
  53       ),
  54     ),
  55   );
  56
  57   return $expectedResult;
  58 }
  59
  60 /**
  61 * This example has been generated from the API test suite.
  62 * The test that created it is called
  63 * testGet
  64 * and can be found in
  65 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/GroupContactTest.php
  66 *
  67 * You can see the outcome of the API tests at
  68 * https://test.civicrm.org/job/CiviCRM-master-git/
  69 *
  70 * To Learn about the API read
  71 * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
  72 *
  73 * Browse the api on your own site with the api explorer
  74 * http://MYSITE.ORG/path/to/civicrm/api
  75 *
  76 * Read more about testing here
  77 * http://wiki.civicrm.org/confluence/display/CRM/Testing
  78 *
  79 * API Standards documentation:
  80 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
  81 */