api/v3/examples/UFJoin/Create.php

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