api/v3/examples/Relationship/Get.ex.php

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