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