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 = array(
  10     'module' => 'CiviContribute',
  11     'entity_table' => 'civicrm_contribution_page',
  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 array(
  28       'error' => $errorMessage,
  29       'error_code' => $errorCode,
  30       'error_data' => $errorData,
  31     );
  32   }
  33
  34   return $result;
  35 }
  36
  37 /**
  38  * Function returns array of result expected from previous function.
  39  *
  40  * @return array
  41  *   API result array
  42  */
  43 function uf_join_create_expectedresult() {
  44
  45   $expectedResult = array(
  46     'is_error' => 0,
  47     'version' => 3,
  48     'count' => 1,
  49     'id' => 0,
  50     'values' => array(
  51       '0' => array(
  52         'id' => '1',
  53         'is_active' => '1',
  54         'module' => 'CiviContribute',
  55         'entity_table' => 'civicrm_contribution_page',
  56         'entity_id' => '1',
  57         'weight' => '1',
  58         'uf_group_id' => '11',
  59         'module_data' => '',
  60       ),
  61     ),
  62   );
  63
  64   return $expectedResult;
  65 }
  66
  67 /*
  68 * This example has been generated from the API test suite.
  69 * The test that created it is called "testCreateUFJoin"
  70 * and can be found at:
  71 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/UFJoinTest.php
  72 *
  73 * You can see the outcome of the API tests at
  74 * https://test.civicrm.org/job/CiviCRM-master-git/
  75 *
  76 * To Learn about the API read
  77 * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
  78 *
  79 * Browse the api on your own site with the api explorer
  80 * http://MYSITE.ORG/path/to/civicrm/api
  81 *
  82 * Read more about testing here
  83 * http://wiki.civicrm.org/confluence/display/CRM/Testing
  84 *
  85 * API Standards documentation:
  86 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
  87 */