api/v3/examples/UFJoin/Create.php

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