api/v3/examples/UFJoin/Get.php

   1 <?php
   2 /**
   3  * Test Generated example demonstrating the UFJoin.get API.
   4  *
   5  * @return array
   6  *   API result array
   7  */
   8 function uf_join_get_example() {
   9   $params = [
  10     'entity_table' => 'civicrm_contribution_page',
  11     'entity_id' => 1,
  12     'sequential' => 1,
  13   ];
  14
  15   try{
  16     $result = civicrm_api3('UFJoin', 'get', $params);
  17   }
  18   catch (CiviCRM_API3_Exception $e) {
  19     // Handle error here.
  20     $errorMessage = $e->getMessage();
  21     $errorCode = $e->getErrorCode();
  22     $errorData = $e->getExtraParams();
  23     return [
  24       'is_error' => 1,
  25       'error_message' => $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 uf_join_get_expectedresult() {
  41
  42   $expectedResult = [
  43     'is_error' => 0,
  44     'version' => 3,
  45     'count' => 1,
  46     'id' => 1,
  47     'values' => [
  48       '0' => [
  49         'id' => '1',
  50         'is_active' => '1',
  51         'module' => 'CiviContribute',
  52         'entity_table' => 'civicrm_contribution_page',
  53         'entity_id' => '1',
  54         'weight' => '1',
  55         'uf_group_id' => '11',
  56       ],
  57     ],
  58   ];
  59
  60   return $expectedResult;
  61 }
  62
  63 /*
  64 * This example has been generated from the API test suite.
  65 * The test that created it is called "testGetUFJoinId"
  66 * and can be found at:
  67 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/UFJoinTest.php
  68 *
  69 * You can see the outcome of the API tests at
  70 * https://test.civicrm.org/job/CiviCRM-master-git/
  71 *
  72 * To Learn about the API read
  73 * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
  74 *
  75 * Browse the api on your own site with the api explorer
  76 * http://MYSITE.ORG/path/to/civicrm/api
  77 *
  78 * Read more about testing here
  79 * http://wiki.civicrm.org/confluence/display/CRM/Testing
  80 *
  81 * API Standards documentation:
  82 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
  83 */