infra updated incorrectly set public functions to private on payment classes
[civicrm-core.git] / api / v3 / examples / ContributionSoft / Get.php
CommitLineData
4f53d6f2 1<?php
fb32de45 2/**
50fb255d 3 * @file
4 * Test Generated API Example.
5 * See bottom of this file for more detail.
4f53d6f2 6 */
4f53d6f2 7
50fb255d 8/**
9 * Test Generated example of using contribution_soft get API.
10 *
11 *
12 * @return array
13 * API result array
14 */
15function contribution_soft_get_example() {
16 $params = array(
17 'id' => 1,
18 );
4f53d6f2 19
50fb255d 20 try{
21 $result = civicrm_api3('contribution_soft', '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;
4f53d6f2 36}
37
fb32de45 38/**
50fb255d 39 * Function returns array of result expected from previous function.
40 *
41 * @return array
42 * API result array
4f53d6f2 43 */
50fb255d 44function contribution_soft_get_expectedresult() {
4f53d6f2 45
edb0d67a 46 $expectedResult = array(
50fb255d 47 'is_error' => 0,
48 'version' => 3,
49 'count' => 1,
50 'id' => 1,
51 'values' => array(
edb0d67a 52 '1' => array(
50fb255d 53 'id' => '1',
54 'contribution_id' => '1',
55 'contact_id' => '4',
56 'amount' => '10.00',
57 'currency' => 'USD',
58 'pcp_display_in_roll' => 0,
59 'soft_credit_type_id' => '4',
60 ),
4f53d6f2 61 ),
50fb255d 62 );
4f53d6f2 63
fb32de45 64 return $expectedResult;
4f53d6f2 65}
66
50fb255d 67/**
68* This example has been generated from the API test suite.
69* The test that created it is called
70* testGetContributionSoft
71* and can be found in
69d79249 72* https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ContributionSoftTest.php
4f53d6f2 73*
74* You can see the outcome of the API tests at
69d79249 75* https://test.civicrm.org/job/CiviCRM-master-git/
4f53d6f2 76*
77* To Learn about the API read
69d79249 78* http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
4f53d6f2 79*
69d79249
E
80* Browse the api on your own site with the api explorer
81* http://MYSITE.ORG/path/to/civicrm/api/explorer
4f53d6f2 82*
83* Read more about testing here
84* http://wiki.civicrm.org/confluence/display/CRM/Testing
85*
86* API Standards documentation:
87* http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
b259a4ab 88*/