api/v3/examples/MappingField/Create.php

   1 <?php
   2 /**
   3  * Test Generated example demonstrating the MappingField.create API.
   4  *
   5  * @return array
   6  *   API result array
   7  */
   8 function mapping_field_create_example() {
   9   $params = [
  10     'mapping_id' => 1,
  11     'name' => 'last_name',
  12     'contact_type' => 'Individual',
  13     'column_number' => 2,
  14     'grouping' => 1,
  15   ];
  16
  17   try{
  18     $result = civicrm_api3('MappingField', 'create', $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 [
  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_create_expectedresult() {
  43
  44   $expectedResult = [
  45     'is_error' => 0,
  46     'version' => 3,
  47     'count' => 1,
  48     'id' => 1,
  49     'values' => [
  50       '1' => [
  51         'id' => '1',
  52         'mapping_id' => '1',
  53         'name' => 'last_name',
  54         'contact_type' => 'Individual',
  55         'column_number' => '2',
  56         'location_type_id' => '',
  57         'phone_type_id' => '',
  58         'im_provider_id' => '',
  59         'website_type_id' => '',
  60         'relationship_type_id' => '',
  61         'relationship_direction' => '',
  62         'grouping' => '1',
  63         'operator' => '',
  64         'value' => '',
  65       ],
  66     ],
  67   ];
  68
  69   return $expectedResult;
  70 }
  71
  72 /*
  73 * This example has been generated from the API test suite.
  74 * The test that created it is called "testCreateMappingField"
  75 * and can be found at:
  76 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/MappingFieldTest.php
  77 *
  78 * You can see the outcome of the API tests at
  79 * https://test.civicrm.org/job/CiviCRM-Core-Matrix/
  80 *
  81 * To Learn about the API read
  82 * https://docs.civicrm.org/dev/en/latest/api/
  83 *
  84 * Browse the API on your own site with the API Explorer. It is in the main
  85 * CiviCRM menu, under: Support > Development > API Explorer.
  86 *
  87 * Read more about testing here
  88 * https://docs.civicrm.org/dev/en/latest/testing/
  89 *
  90 * API Standards documentation:
  91 * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/
  92 */