3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
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 * File for the CiviCRM APIv3 group functions
31 * @package CiviCRM_APIv3
32 * @subpackage API_ContributionRecur
33 * @copyright CiviCRM LLC (c) 2004-2014
37 * Create or update a contribution_recur
39 * @param array $params Associative array of property
40 * name/value pairs to insert in new 'contribution_recur'
41 * @example ContributionRecurCreate.php Std Create example
43 * @return array api result array
44 * {@getfields contribution_recur_create}
47 function civicrm_api3_contribution_recur_create($params) {
48 return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
52 * Adjust Metadata for Create action
54 * The metadata is used for setting defaults, documentation & validation
55 * @param array $params array or 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';
65 * Returns array of contribution_recurs matching a set of one or more group properties
67 * @param array $params Array of one or more valid
68 * property_name=>value pairs. If $params is set
69 * as null, all contribution_recurs will be returned
71 * @return array API result Array of matching contribution_recurs
72 * {@getfields contribution_recur_get}
75 function civicrm_api3_contribution_recur_get($params) {
76 return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
80 * Cancel a recurring contribution of existing contribution_recur.id
82 * @param array $params (reference) array containing id of the recurring contribution
84 * @return boolean 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 contribution_recur
95 * This method is used to delete any existing contribution_recur. id of the group
96 * to be deleted is required field in $params array
98 * @param array $params array containing id of the group
101 * @return array API result array
103 * {@getfields contribution_recur_delete}
106 function civicrm_api3_contribution_recur_delete($params) {
107 return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__
), $params);