4 +--------------------------------------------------------------------+
5 | CiviCRM version 4.5 |
6 +--------------------------------------------------------------------+
7 | Copyright CiviCRM LLC (c) 2004-2014 |
8 +--------------------------------------------------------------------+
9 | This file is a part of CiviCRM. |
11 | CiviCRM is free software; you can copy, modify, and distribute it |
12 | under the terms of the GNU Affero General Public License |
13 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
15 | CiviCRM is distributed in the hope that it will be useful, but |
16 | WITHOUT ANY WARRANTY; without even the implied warranty of |
17 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
18 | See the GNU Affero General Public License for more details. |
20 | You should have received a copy of the GNU Affero General Public |
21 | License and the CiviCRM Licensing Exception along |
22 | with this program; if not, contact CiviCRM LLC |
23 | at info[AT]civicrm[DOT]org. If you have questions about the |
24 | GNU Affero General Public License or the licensing of CiviCRM, |
25 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
26 +--------------------------------------------------------------------+
30 * new version of civicrm apis. See blog post at
31 * http://civicrm.org/node/131
33 * @package CiviCRM_APIv3
34 * @subpackage API_Contact
35 * @copyright CiviCRM LLC (c) 2004-2014
36 * $Id: PaymentProcessorType.php 30415 2010-10-29 12:02:47Z shot $
41 * Include common API util functions
45 * Function to create payment_processor type
47 * @param array $params Associative array of property name/value pairs to insert in new payment_processor type.
49 * @return Newly created PaymentProcessor_type object
50 * {@getfields PaymentProcessorType_create}
52 * {@schema Core/PaymentProcessorType.xml}
54 function civicrm_api3_payment_processor_type_create($params) {
56 if (isset($params['id']) && !CRM_Utils_Rule
::integer($params['id'])) {
57 return civicrm_api3_create_error('Invalid value for payment_processor type ID');
60 $payProcType = new CRM_Financial_BAO_PaymentProcessorType();
61 $payProcType = CRM_Financial_BAO_PaymentProcessorType
::create($params);
65 _civicrm_api3_object_to_array($payProcType, $relType[$payProcType->id
]);
67 return civicrm_api3_create_success($relType, $params, 'payment_processor_type', 'create', $payProcType);
71 * Adjust Metadata for Create action
73 * The metadata is used for setting defaults, documentation & validation
74 * @param array $params array or parameters determined by getfields
76 function _civicrm_api3_payment_processor_type_create_spec(&$params) {
77 $params['billing_mode']['api.required'] = 1;
78 $params['class_name']['api.required'] = 1;
79 $params['is_active']['api.default'] = 1;
80 $params['is_recur']['api.default'] = FALSE;
81 // FIXME bool support // $params['is_recur']['api.required'] = 1;
82 $params['name']['api.required'] = 1;
83 $params['title']['api.required'] = 1;
87 * Function to get all payment_processor type
88 * retruns An array of PaymentProcessor_type
90 * {@getfields PaymentProcessorType_get}
91 * @example PaymentProcessorTypeGet.php
93 function civicrm_api3_payment_processor_type_get($params) {
94 return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
98 * Delete a payment_processor type delete
100 * @param id of payment_processor type $id
102 * @return array API Result Array
103 * {@getfields PaymentProcessorType_delete}
107 function civicrm_api3_payment_processor_type_delete($params) {
108 if ($params['id'] != NULL && !CRM_Utils_Rule
::integer($params['id'])) {
109 return civicrm_api3_create_error('Invalid value for payment processor type ID');
112 $payProcTypeBAO = new CRM_Financial_BAO_PaymentProcessorType();
113 $result = $payProcTypeBAO->del($params['id']);
115 return civicrm_api3_create_error('Could not delete payment processor type');
117 return civicrm_api3_create_success($result, $params, 'payment_processor_type', 'delete', $payProcTypeBAO);