infra updated incorrectly set public functions to private on payment classes
[civicrm-core.git] / api / v3 / examples / Batch / Get.php
1 <?php
2 /**
3 * @file
4 * Test Generated API Example.
5 * See bottom of this file for more detail.
6 */
7
8 /**
9 * Test Generated example of using batch get API.
10 *
11 *
12 * @return array
13 * API result array
14 */
15 function batch_get_example() {
16 $params = array(
17 'id' => 1,
18 );
19
20 try{
21 $result = civicrm_api3('batch', 'get', $params);
22 }
23 catch (CiviCRM_API3_Exception $e) {
24 // Handle error here.
25 $errorMessage = $e->getMessage();
26 $errorCode = $e->getErrorCode();
27 $errorData = $e->getExtraParams();
28 return array(
29 'error' => $errorMessage,
30 'error_code' => $errorCode,
31 'error_data' => $errorData,
32 );
33 }
34
35 return $result;
36 }
37
38 /**
39 * Function returns array of result expected from previous function.
40 *
41 * @return array
42 * API result array
43 */
44 function batch_get_expectedresult() {
45
46 $expectedResult = array(
47 'is_error' => 0,
48 'version' => 3,
49 'count' => 1,
50 'id' => 1,
51 'values' => array(
52 '1' => array(
53 'id' => '1',
54 'name' => 'Batch_433397',
55 'title' => 'Batch_433397',
56 'modified_date' => '2012-11-14 16:02:35',
57 'status_id' => '1',
58 ),
59 ),
60 );
61
62 return $expectedResult;
63 }
64
65 /**
66 * This example has been generated from the API test suite.
67 * The test that created it is called
68 * testGet
69 * and can be found in
70 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/BatchTest.php
71 *
72 * You can see the outcome of the API tests at
73 * https://test.civicrm.org/job/CiviCRM-master-git/
74 *
75 * To Learn about the API read
76 * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
77 *
78 * Browse the api on your own site with the api explorer
79 * http://MYSITE.ORG/path/to/civicrm/api/explorer
80 *
81 * Read more about testing here
82 * http://wiki.civicrm.org/confluence/display/CRM/Testing
83 *
84 * API Standards documentation:
85 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
86 */