Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
6a488035 TO |
2 | /* |
3 | +--------------------------------------------------------------------+ | |
fee14197 | 4 | | CiviCRM version 5 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
6b83d5bd | 6 | | Copyright CiviCRM LLC (c) 2004-2019 | |
6a488035 TO |
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 | +--------------------------------------------------------------------+ | |
26 | */ | |
27 | ||
28 | /** | |
c28e1768 | 29 | * This api exposes CiviCRM payment processor types. |
6a488035 TO |
30 | * |
31 | * @package CiviCRM_APIv3 | |
6a488035 | 32 | */ |
6a488035 TO |
33 | |
34 | /** | |
22242c87 | 35 | * Create payment_processor type. |
6a488035 | 36 | * |
cf470720 TO |
37 | * @param array $params |
38 | * Associative array of property name/value pairs to insert in new payment_processor type. | |
6a488035 | 39 | * |
72b3a70c | 40 | * @return array |
6a488035 TO |
41 | */ |
42 | function civicrm_api3_payment_processor_type_create($params) { | |
da2dec3a | 43 | return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'PaymentProcessorType'); |
6a488035 TO |
44 | } |
45 | ||
46 | /** | |
0aa0303c EM |
47 | * Adjust Metadata for Create action. |
48 | * | |
49 | * The metadata is used for setting defaults, documentation & validation. | |
6a488035 | 50 | * |
cf470720 | 51 | * @param array $params |
b081365f | 52 | * Array of parameters determined by getfields. |
6a488035 TO |
53 | */ |
54 | function _civicrm_api3_payment_processor_type_create_spec(&$params) { | |
55 | $params['billing_mode']['api.required'] = 1; | |
56 | $params['class_name']['api.required'] = 1; | |
57 | $params['is_active']['api.default'] = 1; | |
58 | $params['is_recur']['api.default'] = FALSE; | |
6a488035 TO |
59 | $params['name']['api.required'] = 1; |
60 | $params['title']['api.required'] = 1; | |
a1936a29 | 61 | $params['payment_instrument_id']['api.default'] = 'Credit Card'; |
6a488035 TO |
62 | } |
63 | ||
64 | /** | |
d1b0d05e EM |
65 | * Get all payment_processor types. |
66 | * | |
d0997921 | 67 | * @param array $params |
d1b0d05e | 68 | * |
645ee340 | 69 | * @return array |
6a488035 TO |
70 | */ |
71 | function civicrm_api3_payment_processor_type_get($params) { | |
72 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
73 | } | |
74 | ||
75 | /** | |
22242c87 | 76 | * Delete a payment_processor type delete. |
6a488035 | 77 | * |
c23f45d3 | 78 | * @param array $params |
6a488035 | 79 | * |
a6c01b45 | 80 | * @return array |
72b3a70c | 81 | * API Result Array |
6a488035 TO |
82 | */ |
83 | function civicrm_api3_payment_processor_type_delete($params) { | |
6a488035 TO |
84 | if ($params['id'] != NULL && !CRM_Utils_Rule::integer($params['id'])) { |
85 | return civicrm_api3_create_error('Invalid value for payment processor type ID'); | |
86 | } | |
87 | ||
88 | $payProcTypeBAO = new CRM_Financial_BAO_PaymentProcessorType(); | |
89 | $result = $payProcTypeBAO->del($params['id']); | |
90 | if (!$result) { | |
91 | return civicrm_api3_create_error('Could not delete payment processor type'); | |
92 | } | |
244bbdd8 | 93 | return civicrm_api3_create_success($result, $params, 'PaymentProcessorType', 'delete', $payProcTypeBAO); |
6a488035 | 94 | } |