Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
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 recurring contributions. |
6a488035 TO |
30 | * |
31 | * @package CiviCRM_APIv3 | |
6a488035 TO |
32 | */ |
33 | ||
6a488035 | 34 | /** |
244bbdd8 | 35 | * Create or update a ContributionRecur. |
6a488035 | 36 | * |
cf470720 | 37 | * @param array $params |
2e66abf8 | 38 | * Array per getfields metadata. |
6a488035 | 39 | * |
a6c01b45 | 40 | * @return array |
72b3a70c | 41 | * api result array |
6a488035 TO |
42 | */ |
43 | function civicrm_api3_contribution_recur_create($params) { | |
98fd592b | 44 | return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'ContributionRecur'); |
6a488035 | 45 | } |
11e09c59 TO |
46 | |
47 | /** | |
0aa0303c EM |
48 | * Adjust Metadata for Create action. |
49 | * | |
50 | * The metadata is used for setting defaults, documentation & validation. | |
1c88e578 | 51 | * |
cf470720 | 52 | * @param array $params |
b081365f | 53 | * Array of parameters determined by getfields. |
6a488035 TO |
54 | */ |
55 | function _civicrm_api3_contribution_recur_create_spec(&$params) { | |
56 | $params['contact_id']['api.required'] = 1; | |
57 | $params['create_date']['api.default'] = 'now'; | |
35ed6e9c | 58 | $params['frequency_interval']['api.required'] = 1; |
bca6d769 | 59 | $params['amount']['api.required'] = 1; |
28658972 | 60 | $params['start_date']['api.default'] = 'now'; |
b1b2796c | 61 | $params['modified_date']['api.default'] = 'now'; |
6a488035 TO |
62 | } |
63 | ||
64 | /** | |
d1b0d05e | 65 | * Returns array of contribution_recurs matching a set of one or more group properties. |
6a488035 | 66 | * |
cf470720 | 67 | * @param array $params |
b081365f | 68 | * Array of properties. If empty, all records will be returned. |
6a488035 | 69 | * |
a6c01b45 | 70 | * @return array |
72b3a70c | 71 | * API result Array of matching contribution_recurs |
6a488035 TO |
72 | */ |
73 | function civicrm_api3_contribution_recur_get($params) { | |
74 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
75 | } | |
76 | ||
4f1c81da | 77 | /** |
244bbdd8 | 78 | * Cancel a recurring contribution of existing ContributionRecur given its id. |
4f1c81da | 79 | * |
cf470720 | 80 | * @param array $params |
d1b0d05e | 81 | * Array containing id of the recurring contribution. |
4f1c81da | 82 | * |
5c766a0b | 83 | * @return bool |
72b3a70c | 84 | * returns true is successfully cancelled |
4f1c81da | 85 | */ |
4f1c81da | 86 | function civicrm_api3_contribution_recur_cancel($params) { |
9cfc631e | 87 | return CRM_Contribute_BAO_ContributionRecur::cancelRecurContribution($params) ? civicrm_api3_create_success() : civicrm_api3_create_error(ts('Error while cancelling recurring contribution')); |
88 | } | |
89 | ||
90 | /** | |
91 | * Adjust Metadata for Cancel action. | |
92 | * | |
93 | * The metadata is used for setting defaults, documentation & validation. | |
94 | * | |
95 | * @param array $params | |
96 | * Array of parameters determined by getfields. | |
97 | */ | |
98 | function _civicrm_api3_contribution_recur_cancel_spec(&$params) { | |
99 | $params['id'] = [ | |
100 | 'title' => ts('Contribution Recur ID'), | |
101 | 'api.required' => TRUE, | |
102 | 'type' => CRM_Utils_Type::T_INT, | |
103 | ]; | |
4f1c81da | 104 | } |
105 | ||
6a488035 | 106 | /** |
244bbdd8 | 107 | * Delete an existing ContributionRecur. |
6a488035 | 108 | * |
244bbdd8 | 109 | * This method is used to delete an existing ContributionRecur given its id. |
6a488035 | 110 | * |
cf470720 | 111 | * @param array $params |
c28e1768 | 112 | * [id] |
6a488035 | 113 | * |
a6c01b45 | 114 | * @return array |
72b3a70c | 115 | * API result array |
6a488035 TO |
116 | */ |
117 | function civicrm_api3_contribution_recur_delete($params) { | |
118 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
119 | } |