Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
6a488035 TO |
2 | /* |
3 | +--------------------------------------------------------------------+ | |
39de6fd5 | 4 | | CiviCRM version 4.6 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
731a0992 | 6 | | Copyright CiviCRM LLC (c) 2004-2014 | |
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 | /** | |
29 | * new version of civicrm apis. See blog post at | |
30 | * http://civicrm.org/node/131 | |
31 | * | |
32 | * @package CiviCRM_APIv3 | |
33 | * @subpackage API_Contact | |
731a0992 | 34 | * @copyright CiviCRM LLC (c) 2004-2014 |
6a488035 TO |
35 | * $Id: PaymentProcessorType.php 30415 2010-10-29 12:02:47Z shot $ |
36 | * | |
37 | */ | |
38 | ||
39 | /** | |
40 | * Include common API util functions | |
41 | */ | |
6a488035 TO |
42 | |
43 | /** | |
c490a46a | 44 | * create payment_processor type |
6a488035 | 45 | * |
cf470720 TO |
46 | * @param array $params |
47 | * Associative array of property name/value pairs to insert in new payment_processor type. | |
6a488035 | 48 | * |
72b3a70c | 49 | * @return array |
6a488035 TO |
50 | */ |
51 | function civicrm_api3_payment_processor_type_create($params) { | |
6a488035 TO |
52 | if (isset($params['id']) && !CRM_Utils_Rule::integer($params['id'])) { |
53 | return civicrm_api3_create_error('Invalid value for payment_processor type ID'); | |
54 | } | |
55 | ||
54f1aa2a | 56 | $paymentProcessorType = CRM_Financial_BAO_PaymentProcessorType::create($params); |
6a488035 TO |
57 | |
58 | $relType = array(); | |
59 | ||
54f1aa2a | 60 | _civicrm_api3_object_to_array($paymentProcessorType, $relType[$paymentProcessorType->id]); |
6a488035 | 61 | |
54f1aa2a | 62 | return civicrm_api3_create_success($relType, $params, 'payment_processor_type', 'create', $paymentProcessorType); |
6a488035 TO |
63 | } |
64 | ||
65 | /** | |
66 | * Adjust Metadata for Create action | |
67 | * | |
68 | * The metadata is used for setting defaults, documentation & validation | |
cf470720 TO |
69 | * @param array $params |
70 | * Array or parameters determined by getfields. | |
6a488035 TO |
71 | */ |
72 | function _civicrm_api3_payment_processor_type_create_spec(&$params) { | |
73 | $params['billing_mode']['api.required'] = 1; | |
74 | $params['class_name']['api.required'] = 1; | |
75 | $params['is_active']['api.default'] = 1; | |
76 | $params['is_recur']['api.default'] = FALSE; | |
77 | // FIXME bool support // $params['is_recur']['api.required'] = 1; | |
78 | $params['name']['api.required'] = 1; | |
79 | $params['title']['api.required'] = 1; | |
80 | } | |
81 | ||
82 | /** | |
c23f45d3 | 83 | * get all payment_processor types |
d0997921 | 84 | * @param array $params |
645ee340 | 85 | * @return array |
6a488035 TO |
86 | */ |
87 | function civicrm_api3_payment_processor_type_get($params) { | |
88 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
89 | } | |
90 | ||
91 | /** | |
92 | * Delete a payment_processor type delete | |
93 | * | |
c23f45d3 | 94 | * @param array $params |
6a488035 | 95 | * |
a6c01b45 | 96 | * @return array |
72b3a70c | 97 | * API Result Array |
6a488035 TO |
98 | */ |
99 | function civicrm_api3_payment_processor_type_delete($params) { | |
6a488035 TO |
100 | if ($params['id'] != NULL && !CRM_Utils_Rule::integer($params['id'])) { |
101 | return civicrm_api3_create_error('Invalid value for payment processor type ID'); | |
102 | } | |
103 | ||
104 | $payProcTypeBAO = new CRM_Financial_BAO_PaymentProcessorType(); | |
105 | $result = $payProcTypeBAO->del($params['id']); | |
106 | if (!$result) { | |
107 | return civicrm_api3_create_error('Could not delete payment processor type'); | |
108 | } | |
109 | return civicrm_api3_create_success($result, $params, 'payment_processor_type', 'delete', $payProcTypeBAO); | |
110 | } |