api/v3/examples/UFGroup/Get.php

   1 <?php
   2 /**
   3  * Test Generated example of using uf_group get API
   4  * *
   5  */
   6 function uf_group_get_example(){
   7 $params = array(
   8   'id' => 2,
   9 );
  10
  11 try{
  12   $result = civicrm_api3('uf_group', 'get', $params);
  13 }
  14 catch (CiviCRM_API3_Exception $e) {
  15   // handle error here
  16   $errorMessage = $e->getMessage();
  17   $errorCode = $e->getErrorCode();
  18   $errorData = $e->getExtraParams();
  19   return array('error' => $errorMessage, 'error_code' => $errorCode, 'error_data' => $errorData);
  20 }
  21
  22 return $result;
  23 }
  24
  25 /**
  26  * Function returns array of result expected from previous function
  27  */
  28 function uf_group_get_expectedresult(){
  29
  30   $expectedResult = array(
  31   'is_error' => 0,
  32   'version' => 3,
  33   'count' => 1,
  34   'id' => 2,
  35   'values' => array(
  36       '2' => array(
  37           'id' => '2',
  38           'is_active' => 0,
  39           'group_type' => 'Individual,Contact',
  40           'title' => 'Test Group',
  41           'help_pre' => 'help pre',
  42           'help_post' => 'help post',
  43           'limit_listings_group_id' => '1',
  44           'post_URL' => 'http://example.org/post',
  45           'add_to_group_id' => '1',
  46           'add_captcha' => '1',
  47           'is_map' => '1',
  48           'is_edit_link' => '1',
  49           'is_uf_link' => '1',
  50           'is_update_dupe' => '1',
  51           'cancel_URL' => 'http://example.org/cancel',
  52           'is_cms_user' => '1',
  53           'notify' => 'admin@example.org',
  54           'is_reserved' => '1',
  55           'name' => 'Test_Group_2',
  56           'created_id' => '1',
  57           'created_date' => '2013-07-28 08:49:19',
  58           'is_proximity_search' => 0,
  59         ),
  60     ),
  61 );
  62
  63   return $expectedResult;
  64 }
  65
  66
  67 /*
  68 * This example has been generated from the API test suite. The test that created it is called
  69 *
  70 * testUFGroupGet and can be found in
  71 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/UFGroupTest.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/explorer
  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 */