api/v3/examples/UFJoin/Get.php

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