Commit | Line | Data |
---|---|---|
21150aae CW |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
81621fee | 4 | | CiviCRM version 4.7 | |
21150aae | 5 | +--------------------------------------------------------------------+ |
1f4ea726 | 6 | | Copyright CiviCRM LLC (c) 2004-2017 | |
21150aae CW |
7 | +--------------------------------------------------------------------+ |
8 | | This file is a part of CiviCRM. | | |
9 | | | | |
10 | | CiviCRM is free software; you can copy, modify, and distribute it | | |
11 | | under the terms of the GNU Affero General Public License | | |
12 | | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. | | |
13 | | | | |
14 | | CiviCRM is distributed in the hope that it will be useful, but | | |
15 | | WITHOUT ANY WARRANTY; without even the implied warranty of | | |
16 | | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. | | |
17 | | See the GNU Affero General Public License for more details. | | |
18 | | | | |
19 | | You should have received a copy of the GNU Affero General Public | | |
20 | | License and the CiviCRM Licensing Exception along | | |
21 | | with this program; if not, contact CiviCRM LLC | | |
22 | | at info[AT]civicrm[DOT]org. If you have questions about the | | |
23 | | GNU Affero General Public License or the licensing of CiviCRM, | | |
24 | | see the CiviCRM license FAQ at http://civicrm.org/licensing | | |
25 | +--------------------------------------------------------------------+ | |
d25dd0ee | 26 | */ |
21150aae CW |
27 | |
28 | /** | |
c28e1768 | 29 | * This api exposes CiviCRM PaymentProcessor. |
21150aae CW |
30 | * |
31 | * @package CiviCRM_APIv3 | |
21150aae CW |
32 | */ |
33 | ||
34 | /** | |
d1b0d05e | 35 | * Add/Update a PaymentProcessor. |
21150aae | 36 | * |
c490a46a | 37 | * @param array $params |
77b97be7 | 38 | * |
a6c01b45 | 39 | * @return array |
00f8641b | 40 | * API result array |
21150aae CW |
41 | */ |
42 | function civicrm_api3_payment_processor_create($params) { | |
a1936a29 EM |
43 | if (empty($params['id']) && empty($params['payment_instrument_id'])) { |
44 | $params['payment_instrument_id'] = civicrm_api3('PaymentProcessorType', 'getvalue', array( | |
45 | 'id' => $params['payment_processor_type_id'], | |
46 | 'return' => 'payment_instrument_id', | |
47 | )); | |
48 | } | |
21150aae CW |
49 | return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); |
50 | } | |
51 | ||
52 | /** | |
0aa0303c EM |
53 | * Adjust Metadata for Create action. |
54 | * | |
55 | * The metadata is used for setting defaults, documentation & validation. | |
21150aae | 56 | * |
cf470720 | 57 | * @param array $params |
b081365f | 58 | * Array of parameters determined by getfields. |
21150aae CW |
59 | */ |
60 | function _civicrm_api3_payment_processor_create_spec(&$params) { | |
61 | $params['payment_processor_type_id']['api.required'] = 1; | |
62 | $params['is_default']['api.default'] = 0; | |
63 | $params['is_test']['api.default'] = 0; | |
64 | } | |
65 | ||
66 | /** | |
d1b0d05e | 67 | * Deletes an existing PaymentProcessor. |
21150aae | 68 | * |
cf470720 | 69 | * @param array $params |
21150aae | 70 | * |
a6c01b45 | 71 | * @return array |
00f8641b | 72 | * API result array |
21150aae CW |
73 | */ |
74 | function civicrm_api3_payment_processor_delete($params) { | |
75 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
76 | } | |
77 | ||
78 | /** | |
d1b0d05e | 79 | * Retrieve one or more PaymentProcessor. |
21150aae | 80 | * |
cf470720 | 81 | * @param array $params |
d1b0d05e | 82 | * Array of name/value pairs. |
21150aae | 83 | * |
a6c01b45 | 84 | * @return array |
00f8641b | 85 | * API result array |
21150aae CW |
86 | */ |
87 | function civicrm_api3_payment_processor_get($params) { | |
88 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
89 | } | |
6b4c9564 CW |
90 | |
91 | ||
92 | /** | |
93 | * Set default getlist parameters. | |
94 | * | |
95 | * @see _civicrm_api3_generic_getlist_defaults | |
96 | * | |
97 | * @param array $request | |
98 | * | |
99 | * @return array | |
100 | */ | |
101 | function _civicrm_api3_payment_processor_getlist_defaults(&$request) { | |
102 | return array( | |
103 | 'description_field' => array( | |
104 | 'payment_processor_type_id', | |
105 | 'description', | |
106 | ), | |
107 | 'params' => array( | |
108 | 'is_test' => 0, | |
109 | 'is_active' => 1, | |
110 | ), | |
111 | ); | |
112 | } |