Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
fb32de45 | 2 | /** |
3 | * Test Generated example of using membership get API | |
4 | * * | |
6a488035 TO |
5 | */ |
6 | function membership_get_example(){ | |
53ca8fd7 | 7 | $params = array( |
37eda84b | 8 | 'membership_type_id' => 19, |
6a488035 TO |
9 | ); |
10 | ||
fb32de45 | 11 | try{ |
12 | $result = civicrm_api3('membership', '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 membership_get_expectedresult(){ | |
29 | ||
53ca8fd7 | 30 | $expectedResult = array( |
6a488035 TO |
31 | 'is_error' => 0, |
32 | 'version' => 3, | |
33 | 'count' => 1, | |
34 | 'id' => 1, | |
53ca8fd7 | 35 | 'values' => array( |
36 | '1' => array( | |
6a488035 | 37 | 'id' => '1', |
37eda84b | 38 | 'contact_id' => '14', |
39 | 'membership_type_id' => '19', | |
6a488035 | 40 | 'join_date' => '2009-01-21', |
9f1b81e0 | 41 | 'start_date' => '2013-07-29 00:00:00', |
42 | 'end_date' => '2013-08-04 00:00:00', | |
6a488035 | 43 | 'source' => 'Payment', |
37eda84b | 44 | 'status_id' => '17', |
6a488035 TO |
45 | 'is_override' => '1', |
46 | 'is_test' => 0, | |
47 | 'is_pay_later' => 0, | |
48 | 'membership_name' => 'General', | |
49 | 'relationship_name' => 'Child of', | |
50 | 'custom_1' => 'custom string', | |
51 | 'custom_1_1' => 'custom string', | |
52 | ), | |
53 | ), | |
54 | ); | |
55 | ||
fb32de45 | 56 | return $expectedResult; |
6a488035 TO |
57 | } |
58 | ||
59 | ||
60 | /* | |
61 | * This example has been generated from the API test suite. The test that created it is called | |
62 | * | |
63 | * testGetWithParamsMemberShipIdAndCustom and can be found in | |
64 | * http://svn.civicrm.org/civicrm/trunk/tests/phpunit/CiviTest/api/v3/MembershipTest.php | |
65 | * | |
66 | * You can see the outcome of the API tests at | |
67 | * http://tests.dev.civicrm.org/trunk/results-api_v3 | |
68 | * | |
69 | * To Learn about the API read | |
70 | * http://book.civicrm.org/developer/current/techniques/api/ | |
71 | * | |
72 | * and review the wiki at | |
73 | * http://wiki.civicrm.org/confluence/display/CRMDOC/CiviCRM+Public+APIs | |
74 | * | |
75 | * Read more about testing here | |
76 | * http://wiki.civicrm.org/confluence/display/CRM/Testing | |
77 | * | |
78 | * API Standards documentation: | |
79 | * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards | |
80 | */ |