crm.fsf.org/20131203/files/sites/all/modules-old/civicrm/api/v3/examples/UFMatch/Get.php

   1 <?php
   2 /**
   3  * Test Generated example demonstrating the UFMatch.get API.
   4  *
   5  * @return array
   6  *   API result array
   7  */
   8 function uf_match_get_example() {
   9   $params = array(
  10     'contact_id' => 69,
  11   );
  12
  13   try{
  14     $result = civicrm_api3('UFMatch', '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 uf_match_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         'domain_id' => '1',
  48         'uf_id' => '42',
  49         'contact_id' => '69',
  50       ),
  51     ),
  52   );
  53
  54   return $expectedResult;
  55 }
  56
  57 /*
  58 * This example has been generated from the API test suite.
  59 * The test that created it is called "testGetUFID"
  60 * and can be found at:
  61 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/UFMatchTest.php
  62 *
  63 * You can see the outcome of the API tests at
  64 * https://test.civicrm.org/job/CiviCRM-master-git/
  65 *
  66 * To Learn about the API read
  67 * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
  68 *
  69 * Browse the api on your own site with the api explorer
  70 * http://MYSITE.ORG/path/to/civicrm/api
  71 *
  72 * Read more about testing here
  73 * http://wiki.civicrm.org/confluence/display/CRM/Testing
  74 *
  75 * API Standards documentation:
  76 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
  77 */