| 1 | <?php |
| 2 | /* |
| 3 | +--------------------------------------------------------------------+ |
| 4 | | CiviCRM version 4.6 | |
| 5 | +--------------------------------------------------------------------+ |
| 6 | | Copyright CiviCRM LLC (c) 2004-2014 | |
| 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 group functions |
| 30 | * |
| 31 | * @package CiviCRM_APIv3 |
| 32 | * @subpackage API_ContributionRecur |
| 33 | * @copyright CiviCRM LLC (c) 2004-2014 |
| 34 | */ |
| 35 | |
| 36 | /** |
| 37 | * Create or update a contribution_recur |
| 38 | * |
| 39 | * @param array $params |
| 40 | * Associative array of property. |
| 41 | * name/value pairs to insert in new 'contribution_recur' |
| 42 | * @example ContributionRecurCreate.php Std Create example |
| 43 | * |
| 44 | * @return array |
| 45 | * api result array |
| 46 | * {@getfields contribution_recur_create} |
| 47 | */ |
| 48 | function civicrm_api3_contribution_recur_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 |
| 56 | * @param array $params |
| 57 | * Array or parameters determined by getfields. |
| 58 | */ |
| 59 | function _civicrm_api3_contribution_recur_create_spec(&$params) { |
| 60 | $params['contact_id']['api.required'] = 1; |
| 61 | $params['create_date']['api.default'] = 'now'; |
| 62 | $params['frequency_interval']['api.required'] = 1; |
| 63 | $params['start_date']['api.default'] = 'now'; |
| 64 | } |
| 65 | |
| 66 | /** |
| 67 | * Returns array of contribution_recurs matching a set of one or more group properties |
| 68 | * |
| 69 | * @param array $params |
| 70 | * Array of one or more valid. |
| 71 | * property_name=>value pairs. If $params is set |
| 72 | * as null, all contribution_recurs will be returned |
| 73 | * |
| 74 | * @return array |
| 75 | * API result Array of matching contribution_recurs |
| 76 | * {@getfields contribution_recur_get} |
| 77 | */ |
| 78 | function civicrm_api3_contribution_recur_get($params) { |
| 79 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); |
| 80 | } |
| 81 | |
| 82 | /** |
| 83 | * Cancel a recurring contribution of existing contribution_recur.id |
| 84 | * |
| 85 | * @param array $params |
| 86 | * (reference) array containing id of the recurring contribution. |
| 87 | * |
| 88 | * @return boolean |
| 89 | * returns true is successfully cancelled |
| 90 | */ |
| 91 | |
| 92 | function civicrm_api3_contribution_recur_cancel($params) { |
| 93 | civicrm_api3_verify_one_mandatory($params, NULL, array('id')); |
| 94 | 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')); |
| 95 | } |
| 96 | |
| 97 | /** |
| 98 | * delete an existing contribution_recur |
| 99 | * |
| 100 | * This method is used to delete any existing contribution_recur. id of the group |
| 101 | * to be deleted is required field in $params array |
| 102 | * |
| 103 | * @param array $params |
| 104 | * Array containing id of the group. |
| 105 | * to be deleted |
| 106 | * |
| 107 | * @return array |
| 108 | * API result array |
| 109 | * message otherwise |
| 110 | * {@getfields contribution_recur_delete} |
| 111 | */ |
| 112 | function civicrm_api3_contribution_recur_delete($params) { |
| 113 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); |
| 114 | } |