3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
29 * new version of civicrm apis. See blog post at
30 * http://civicrm.org/node/131
32 * @package CiviCRM_APIv3
33 * @subpackage API_Contact
34 * @copyright CiviCRM LLC (c) 2004-2014
35 * $Id: PaymentProcessorType.php 30415 2010-10-29 12:02:47Z shot $
39 * Create payment_processor type.
41 * @param array $params
42 * Associative array of property name/value pairs to insert in new payment_processor type.
46 function civicrm_api3_payment_processor_type_create($params) {
47 if (isset($params['id']) && !CRM_Utils_Rule
::integer($params['id'])) {
48 return civicrm_api3_create_error('Invalid value for payment_processor type ID');
51 $paymentProcessorType = CRM_Financial_BAO_PaymentProcessorType
::create($params);
55 _civicrm_api3_object_to_array($paymentProcessorType, $relType[$paymentProcessorType->id
]);
57 return civicrm_api3_create_success($relType, $params, 'payment_processor_type', 'create', $paymentProcessorType);
61 * Adjust Metadata for Create action.
63 * The metadata is used for setting defaults, documentation & validation.
65 * @param array $params
66 * Array or parameters determined by getfields.
68 function _civicrm_api3_payment_processor_type_create_spec(&$params) {
69 $params['billing_mode']['api.required'] = 1;
70 $params['class_name']['api.required'] = 1;
71 $params['is_active']['api.default'] = 1;
72 $params['is_recur']['api.default'] = FALSE;
73 // FIXME bool support // $params['is_recur']['api.required'] = 1;
74 $params['name']['api.required'] = 1;
75 $params['title']['api.required'] = 1;
79 * get all payment_processor types
80 * @param array $params
83 function civicrm_api3_payment_processor_type_get($params) {
84 return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
88 * Delete a payment_processor type delete.
90 * @param array $params
95 function civicrm_api3_payment_processor_type_delete($params) {
96 if ($params['id'] != NULL && !CRM_Utils_Rule
::integer($params['id'])) {
97 return civicrm_api3_create_error('Invalid value for payment processor type ID');
100 $payProcTypeBAO = new CRM_Financial_BAO_PaymentProcessorType();
101 $result = $payProcTypeBAO->del($params['id']);
103 return civicrm_api3_create_error('Could not delete payment processor type');
105 return civicrm_api3_create_success($result, $params, 'payment_processor_type', 'delete', $payProcTypeBAO);