Commit | Line | Data |
---|---|---|
21150aae CW |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
39de6fd5 | 4 | | CiviCRM version 4.6 | |
21150aae | 5 | +--------------------------------------------------------------------+ |
731a0992 | 6 | | Copyright CiviCRM LLC (c) 2004-2014 | |
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 | +--------------------------------------------------------------------+ | |
26 | */ | |
27 | ||
28 | /** | |
29 | * File for the CiviCRM APIv3 PaymentProcessor functions | |
30 | * | |
31 | * @package CiviCRM_APIv3 | |
32 | * @subpackage API_PaymentProcessor | |
33 | * | |
731a0992 | 34 | * @copyright CiviCRM LLC (c) 2004-2014 |
21150aae CW |
35 | */ |
36 | ||
37 | /** | |
38 | * Add/Update a PaymentProcessor | |
39 | * | |
40 | * Allowed @params array keys are: | |
41 | * {@getfields payment_processor_create} | |
42 | * | |
c490a46a | 43 | * @param array $params |
77b97be7 | 44 | * |
a6c01b45 | 45 | * @return array |
16b10e64 | 46 | * Array of newly created PaymentProcessor property values. |
21150aae CW |
47 | */ |
48 | function civicrm_api3_payment_processor_create($params) { | |
49 | return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
50 | } | |
51 | ||
52 | /** | |
53 | * Adjust Metadata for Create action | |
54 | * | |
55 | * The metadata is used for setting defaults, documentation & validation | |
cf470720 TO |
56 | * @param array $params |
57 | * Array or parameters determined by getfields. | |
21150aae CW |
58 | */ |
59 | function _civicrm_api3_payment_processor_create_spec(&$params) { | |
60 | $params['payment_processor_type_id']['api.required'] = 1; | |
61 | $params['is_default']['api.default'] = 0; | |
62 | $params['is_test']['api.default'] = 0; | |
63 | } | |
64 | ||
65 | /** | |
66 | * Deletes an existing PaymentProcessor | |
67 | * | |
cf470720 | 68 | * @param array $params |
21150aae CW |
69 | * {@getfields payment_processor_delete} |
70 | * | |
a6c01b45 | 71 | * @return array |
72b3a70c | 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 | /** | |
79 | * Retrieve one or more PaymentProcessor | |
80 | * | |
cf470720 | 81 | * @param mixed[] (reference) input parameters |
21150aae | 82 | * {@getfields payment_processor_get} |
cf470720 TO |
83 | * @param array $params |
84 | * An associative array of name/value pairs. | |
21150aae | 85 | * |
a6c01b45 | 86 | * @return array |
72b3a70c | 87 | * details of found PaymentProcessor |
21150aae CW |
88 | */ |
89 | function civicrm_api3_payment_processor_get($params) { | |
90 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
91 | } |