api/v3/examples/MappingField/Get.php

   1 <?php
   2 /**
   3  * Test Generated example demonstrating the MappingField.get API.
   4  *
   5  * @return array
   6  *   API result array
   7  */
   8 function mapping_field_get_example() {
   9   $params = array(
  10     'mapping_id' => 2,
  11     'name' => 'last_name',
  12     'contact_type' => 'Individual',
  13     'column_number' => 2,
  14     'grouping' => 1,
  15   );
  16
  17   try{
  18     $result = civicrm_api3('MappingField', 'get', $params);
  19   }
  20   catch (CiviCRM_API3_Exception $e) {
  21     // Handle error here.
  22     $errorMessage = $e->getMessage();
  23     $errorCode = $e->getErrorCode();
  24     $errorData = $e->getExtraParams();
  25     return array(
  26       'is_error' => 1,
  27       'error_message' => $errorMessage,
  28       'error_code' => $errorCode,
  29       'error_data' => $errorData,
  30     );
  31   }
  32
  33   return $result;
  34 }
  35
  36 /**
  37  * Function returns array of result expected from previous function.
  38  *
  39  * @return array
  40  *   API result array
  41  */
  42 function mapping_field_get_expectedresult() {
  43
  44   $expectedResult = array(
  45     'is_error' => 0,
  46     'version' => 3,
  47     'count' => 1,
  48     'id' => 2,
  49     'values' => array(
  50       '2' => array(
  51         'id' => '2',
  52         'mapping_id' => '2',
  53         'name' => 'last_name',
  54         'contact_type' => 'Individual',
  55         'column_number' => '2',
  56         'grouping' => '1',
  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 "testGetMappingField"
  67 * and can be found at:
  68 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/MappingFieldTest.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 */