3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2017 |
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 * This api exposes CiviCRM recurring contributions.
31 * @package CiviCRM_APIv3
35 * Create or update a ContributionRecur.
37 * @param array $params
38 * Array per getfields metadata.
43 function civicrm_api3_contribution_recur_create($params) {
44 _civicrm_api3_custom_format_params($params, $values, 'ContributionRecur');
45 $params = array_merge($params, $values);
46 return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
50 * Adjust Metadata for Create action.
52 * The metadata is used for setting defaults, documentation & validation.
54 * @param array $params
55 * Array of parameters determined by getfields.
57 function _civicrm_api3_contribution_recur_create_spec(&$params) {
58 $params['contact_id']['api.required'] = 1;
59 $params['create_date']['api.default'] = 'now';
60 $params['frequency_interval']['api.required'] = 1;
61 $params['start_date']['api.default'] = 'now';
62 $params['modified_date']['api.default'] = 'now';
66 * Returns array of contribution_recurs matching a set of one or more group properties.
68 * @param array $params
69 * Array of properties. If empty, all records will be returned.
72 * API result Array of matching contribution_recurs
74 function civicrm_api3_contribution_recur_get($params) {
75 return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
79 * Cancel a recurring contribution of existing ContributionRecur given its id.
81 * @param array $params
82 * Array containing id of the recurring contribution.
85 * returns true is successfully cancelled
87 function civicrm_api3_contribution_recur_cancel($params) {
88 civicrm_api3_verify_one_mandatory($params, NULL, array('id'));
89 return CRM_Contribute_BAO_ContributionRecur
::cancelRecurContribution($params['id'], CRM_Core_DAO
::$_nullObject) ?
civicrm_api3_create_success() : civicrm_api3_create_error(ts('Error while cancelling recurring contribution'));
93 * Delete an existing ContributionRecur.
95 * This method is used to delete an existing ContributionRecur given its id.
97 * @param array $params
103 function civicrm_api3_contribution_recur_delete($params) {
104 return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__
), $params);