api/v3/ContributionRecur.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2019                                |
   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  * This api exposes CiviCRM recurring contributions.
  30  *
  31  * @package CiviCRM_APIv3
  32  */
  33
  34 /**
  35  * Create or update a ContributionRecur.
  36  *
  37  * @param array $params
  38  *   Array per getfields metadata.
  39  *
  40  * @return array
  41  *   api result array
  42  */
  43 function civicrm_api3_contribution_recur_create($params) {
  44   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'ContributionRecur');
  45 }
  46
  47 /**
  48  * Adjust Metadata for Create action.
  49  *
  50  * The metadata is used for setting defaults, documentation & validation.
  51  *
  52  * @param array $params
  53  *   Array of parameters determined by getfields.
  54  */
  55 function _civicrm_api3_contribution_recur_create_spec(&$params) {
  56   $params['contact_id']['api.required'] = 1;
  57   $params['create_date']['api.default'] = 'now';
  58   $params['frequency_interval']['api.required'] = 1;
  59   $params['amount']['api.required'] = 1;
  60   $params['start_date']['api.default'] = 'now';
  61   $params['modified_date']['api.default'] = 'now';
  62 }
  63
  64 /**
  65  * Returns array of contribution_recurs matching a set of one or more group properties.
  66  *
  67  * @param array $params
  68  *   Array of properties. If empty, all records will be returned.
  69  *
  70  * @return array
  71  *   API result Array of matching contribution_recurs
  72  */
  73 function civicrm_api3_contribution_recur_get($params) {
  74   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  75 }
  76
  77 /**
  78  * Cancel a recurring contribution of existing ContributionRecur given its id.
  79  *
  80  * @param array $params
  81  *   Array containing id of the recurring contribution.
  82  *
  83  * @return bool
  84  *   returns true is successfully cancelled
  85  */
  86 function civicrm_api3_contribution_recur_cancel($params) {
  87   civicrm_api3_verify_one_mandatory($params, NULL, array('id'));
  88   return CRM_Contribute_BAO_ContributionRecur::cancelRecurContribution($params['id']) ? civicrm_api3_create_success() : civicrm_api3_create_error(ts('Error while cancelling recurring contribution'));
  89 }
  90
  91 /**
  92  * Delete an existing ContributionRecur.
  93  *
  94  * This method is used to delete an existing ContributionRecur given its id.
  95  *
  96  * @param array $params
  97  *   [id]
  98  *
  99  * @return array
 100  *   API result array
 101  */
 102 function civicrm_api3_contribution_recur_delete($params) {
 103   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 104 }