Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
a30c801b | 4 | | Copyright CiviCRM LLC. All rights reserved. | |
6a488035 | 5 | | | |
a30c801b TO |
6 | | This work is published under the GNU AGPLv3 license with some | |
7 | | permitted exceptions and without any warranty. For full license | | |
8 | | and copyright information, see https://civicrm.org/licensing | | |
6a488035 TO |
9 | +--------------------------------------------------------------------+ |
10 | */ | |
11 | ||
12 | /** | |
c28e1768 | 13 | * This api exposes CiviCRM recurring contributions. |
6a488035 TO |
14 | * |
15 | * @package CiviCRM_APIv3 | |
6a488035 TO |
16 | */ |
17 | ||
6a488035 | 18 | /** |
244bbdd8 | 19 | * Create or update a ContributionRecur. |
6a488035 | 20 | * |
cf470720 | 21 | * @param array $params |
2e66abf8 | 22 | * Array per getfields metadata. |
6a488035 | 23 | * |
a6c01b45 | 24 | * @return array |
72b3a70c | 25 | * api result array |
6a488035 TO |
26 | */ |
27 | function civicrm_api3_contribution_recur_create($params) { | |
98fd592b | 28 | return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'ContributionRecur'); |
6a488035 | 29 | } |
11e09c59 TO |
30 | |
31 | /** | |
0aa0303c EM |
32 | * Adjust Metadata for Create action. |
33 | * | |
34 | * The metadata is used for setting defaults, documentation & validation. | |
1c88e578 | 35 | * |
cf470720 | 36 | * @param array $params |
b081365f | 37 | * Array of parameters determined by getfields. |
6a488035 TO |
38 | */ |
39 | function _civicrm_api3_contribution_recur_create_spec(&$params) { | |
40 | $params['contact_id']['api.required'] = 1; | |
41 | $params['create_date']['api.default'] = 'now'; | |
35ed6e9c | 42 | $params['frequency_interval']['api.required'] = 1; |
bca6d769 | 43 | $params['amount']['api.required'] = 1; |
28658972 | 44 | $params['start_date']['api.default'] = 'now'; |
b1b2796c | 45 | $params['modified_date']['api.default'] = 'now'; |
6a488035 TO |
46 | } |
47 | ||
48 | /** | |
d1b0d05e | 49 | * Returns array of contribution_recurs matching a set of one or more group properties. |
6a488035 | 50 | * |
cf470720 | 51 | * @param array $params |
b081365f | 52 | * Array of properties. If empty, all records will be returned. |
6a488035 | 53 | * |
a6c01b45 | 54 | * @return array |
72b3a70c | 55 | * API result Array of matching contribution_recurs |
6a488035 TO |
56 | */ |
57 | function civicrm_api3_contribution_recur_get($params) { | |
58 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
59 | } | |
60 | ||
4f1c81da | 61 | /** |
244bbdd8 | 62 | * Cancel a recurring contribution of existing ContributionRecur given its id. |
4f1c81da | 63 | * |
cf470720 | 64 | * @param array $params |
d1b0d05e | 65 | * Array containing id of the recurring contribution. |
4f1c81da | 66 | * |
5c766a0b | 67 | * @return bool |
72b3a70c | 68 | * returns true is successfully cancelled |
4f1c81da | 69 | */ |
4f1c81da | 70 | function civicrm_api3_contribution_recur_cancel($params) { |
9cfc631e | 71 | return CRM_Contribute_BAO_ContributionRecur::cancelRecurContribution($params) ? civicrm_api3_create_success() : civicrm_api3_create_error(ts('Error while cancelling recurring contribution')); |
72 | } | |
73 | ||
74 | /** | |
75 | * Adjust Metadata for Cancel action. | |
76 | * | |
77 | * The metadata is used for setting defaults, documentation & validation. | |
78 | * | |
79 | * @param array $params | |
80 | * Array of parameters determined by getfields. | |
81 | */ | |
82 | function _civicrm_api3_contribution_recur_cancel_spec(&$params) { | |
83 | $params['id'] = [ | |
84 | 'title' => ts('Contribution Recur ID'), | |
85 | 'api.required' => TRUE, | |
86 | 'type' => CRM_Utils_Type::T_INT, | |
87 | ]; | |
4f1c81da | 88 | } |
89 | ||
6a488035 | 90 | /** |
244bbdd8 | 91 | * Delete an existing ContributionRecur. |
6a488035 | 92 | * |
244bbdd8 | 93 | * This method is used to delete an existing ContributionRecur given its id. |
6a488035 | 94 | * |
cf470720 | 95 | * @param array $params |
c28e1768 | 96 | * [id] |
6a488035 | 97 | * |
a6c01b45 | 98 | * @return array |
72b3a70c | 99 | * API result array |
6a488035 TO |
100 | */ |
101 | function civicrm_api3_contribution_recur_delete($params) { | |
102 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
103 | } |