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