Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
fb32de45 | 2 | /** |
3 | * Test Generated example of using uf_group get API | |
4 | * * | |
6a488035 TO |
5 | */ |
6 | function uf_group_get_example(){ | |
ee600d6f | 7 | $params = array( |
f27f2724 | 8 | 'id' => 2, |
6a488035 TO |
9 | ); |
10 | ||
fb32de45 | 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 | } | |
6a488035 | 21 | |
fb32de45 | 22 | return $result; |
6a488035 TO |
23 | } |
24 | ||
fb32de45 | 25 | /** |
6a488035 TO |
26 | * Function returns array of result expected from previous function |
27 | */ | |
28 | function uf_group_get_expectedresult(){ | |
29 | ||
ee600d6f | 30 | $expectedResult = array( |
6a488035 TO |
31 | 'is_error' => 0, |
32 | 'version' => 3, | |
33 | 'count' => 1, | |
f27f2724 | 34 | 'id' => 2, |
ee600d6f | 35 | 'values' => array( |
f27f2724 | 36 | '2' => array( |
37 | 'id' => '2', | |
6a488035 TO |
38 | 'is_active' => 0, |
39 | 'group_type' => 'Individual,Contact', | |
40 | 'title' => 'Test Group', | |
41 | 'help_pre' => 'help pre', | |
42 | 'help_post' => 'help post', | |
f27f2724 | 43 | 'limit_listings_group_id' => '1', |
6a488035 | 44 | 'post_URL' => 'http://example.org/post', |
f27f2724 | 45 | 'add_to_group_id' => '1', |
6a488035 TO |
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', | |
f27f2724 | 55 | 'name' => 'Test_Group_2', |
56 | 'created_id' => '1', | |
9f1b81e0 | 57 | 'created_date' => '2013-07-28 08:49:19', |
6a488035 TO |
58 | 'is_proximity_search' => 0, |
59 | ), | |
60 | ), | |
61 | ); | |
62 | ||
fb32de45 | 63 | return $expectedResult; |
6a488035 TO |
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 | |
69d79249 | 71 | * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/UFGroupTest.php |
6a488035 TO |
72 | * |
73 | * You can see the outcome of the API tests at | |
69d79249 | 74 | * https://test.civicrm.org/job/CiviCRM-master-git/ |
6a488035 TO |
75 | * |
76 | * To Learn about the API read | |
69d79249 | 77 | * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API |
6a488035 | 78 | * |
69d79249 E |
79 | * Browse the api on your own site with the api explorer |
80 | * http://MYSITE.ORG/path/to/civicrm/api/explorer | |
6a488035 TO |
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 | |
b259a4ab | 87 | */ |