Commit | Line | Data |
---|---|---|
4f53d6f2 | 1 | <?php |
fb32de45 | 2 | /** |
3 | * Test Generated example of using contribution_soft create API | |
4 | * * | |
4f53d6f2 | 5 | */ |
6 | function contribution_soft_create_example(){ | |
edb0d67a | 7 | $params = array( |
4f53d6f2 | 8 | 'contribution_id' => 1, |
9 | 'contact_id' => 2, | |
10 | 'amount' => '10', | |
11 | 'currency' => 'USD', | |
4f53d6f2 | 12 | ); |
13 | ||
fb32de45 | 14 | try{ |
15 | $result = civicrm_api3('contribution_soft', 'create', $params); | |
16 | } | |
17 | catch (CiviCRM_API3_Exception $e) { | |
18 | // handle error here | |
19 | $errorMessage = $e->getMessage(); | |
20 | $errorCode = $e->getErrorCode(); | |
21 | $errorData = $e->getExtraParams(); | |
22 | return array('error' => $errorMessage, 'error_code' => $errorCode, 'error_data' => $errorData); | |
23 | } | |
4f53d6f2 | 24 | |
fb32de45 | 25 | return $result; |
4f53d6f2 | 26 | } |
27 | ||
fb32de45 | 28 | /** |
4f53d6f2 | 29 | * Function returns array of result expected from previous function |
30 | */ | |
31 | function contribution_soft_create_expectedresult(){ | |
32 | ||
edb0d67a | 33 | $expectedResult = array( |
4f53d6f2 | 34 | 'is_error' => 0, |
35 | 'version' => 3, | |
36 | 'count' => 1, | |
37 | 'id' => 1, | |
edb0d67a | 38 | 'values' => array( |
39 | '1' => array( | |
4f53d6f2 | 40 | 'id' => '1', |
41 | 'contribution_id' => '1', | |
42 | 'contact_id' => '2', | |
43 | 'amount' => '10', | |
44 | 'currency' => 'USD', | |
45 | 'pcp_id' => '', | |
46 | 'pcp_display_in_roll' => '', | |
47 | 'pcp_roll_nickname' => '', | |
48 | 'pcp_personal_note' => '', | |
49 | ), | |
50 | ), | |
51 | ); | |
52 | ||
fb32de45 | 53 | return $expectedResult; |
4f53d6f2 | 54 | } |
55 | ||
56 | ||
57 | /* | |
58 | * This example has been generated from the API test suite. The test that created it is called | |
59 | * | |
60 | * testCreateContributionSoft and can be found in | |
69d79249 | 61 | * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ContributionSoftTest.php |
4f53d6f2 | 62 | * |
63 | * You can see the outcome of the API tests at | |
69d79249 | 64 | * https://test.civicrm.org/job/CiviCRM-master-git/ |
4f53d6f2 | 65 | * |
66 | * To Learn about the API read | |
69d79249 | 67 | * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API |
4f53d6f2 | 68 | * |
69d79249 E |
69 | * Browse the api on your own site with the api explorer |
70 | * http://MYSITE.ORG/path/to/civicrm/api/explorer | |
4f53d6f2 | 71 | * |
72 | * Read more about testing here | |
73 | * http://wiki.civicrm.org/confluence/display/CRM/Testing | |
74 | * | |
75 | * API Standards documentation: | |
76 | * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards | |
b259a4ab | 77 | */ |