5be22f39 |
1 | <?php |
2 | /** |
3 | * Test Generated example demonstrating the EntityBatch.create API. |
4 | * |
5 | * @return array |
6 | * API result array |
7 | */ |
8 | function entity_batch_create_example() { |
9 | $params = array( |
10 | 'entity_id' => 1, |
11 | 'batch_id' => 1, |
12 | 'entity_table' => 'civicrm_financial_trxn', |
13 | ); |
14 | |
15 | try{ |
16 | $result = civicrm_api3('EntityBatch', 'create', $params); |
17 | } |
18 | catch (CiviCRM_API3_Exception $e) { |
19 | // Handle error here. |
20 | $errorMessage = $e->getMessage(); |
21 | $errorCode = $e->getErrorCode(); |
22 | $errorData = $e->getExtraParams(); |
23 | return array( |
24 | 'is_error' => 1, |
25 | 'error_message' => $errorMessage, |
26 | 'error_code' => $errorCode, |
27 | 'error_data' => $errorData, |
28 | ); |
29 | } |
30 | |
31 | return $result; |
32 | } |
33 | |
34 | /** |
35 | * Function returns array of result expected from previous function. |
36 | * |
37 | * @return array |
38 | * API result array |
39 | */ |
40 | function entity_batch_create_expectedresult() { |
41 | |
42 | $expectedResult = array( |
43 | 'is_error' => 0, |
44 | 'version' => 3, |
45 | 'count' => 1, |
46 | 'id' => 1, |
47 | 'values' => array( |
48 | '1' => array( |
49 | 'id' => '1', |
50 | 'entity_table' => 'civicrm_financial_trxn', |
51 | 'entity_id' => '1', |
52 | 'batch_id' => '1', |
53 | ), |
54 | ), |
55 | ); |
56 | |
57 | return $expectedResult; |
58 | } |
59 | |
60 | /* |
61 | * This example has been generated from the API test suite. |
62 | * The test that created it is called "testCreateEntityBatch" |
63 | * and can be found at: |
64 | * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/EntityBatchTest.php |
65 | * |
66 | * You can see the outcome of the API tests at |
67 | * https://test.civicrm.org/job/CiviCRM-master-git/ |
68 | * |
69 | * To Learn about the API read |
70 | * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API |
71 | * |
72 | * Browse the api on your own site with the api explorer |
73 | * http://MYSITE.ORG/path/to/civicrm/api |
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 | */ |