Merge pull request #10157 from eileenmcnaughton/iida3
[civicrm-core.git] / api / v3 / ContributionRecur.php
index 0133aba9739c06b60850296a6f9bbc8c02c3c331..2dbdc64e35f795bf252019e73cc269725a9eb28d 100644 (file)
@@ -1,9 +1,9 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.6                                                |
+ | CiviCRM version 4.7                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2014                                |
+ | Copyright CiviCRM LLC (c) 2004-2017                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -32,7 +32,7 @@
  */
 
 /**
- * Create or update a contribution_recur.
+ * Create or update a ContributionRecur.
  *
  * @param array $params
  *   Array per getfields metadata.
@@ -41,6 +41,8 @@
  *   api result array
  */
 function civicrm_api3_contribution_recur_create($params) {
+  _civicrm_api3_custom_format_params($params, $values, 'ContributionRecur');
+  $params = array_merge($params, $values);
   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 }
 
@@ -57,6 +59,7 @@ function _civicrm_api3_contribution_recur_create_spec(&$params) {
   $params['create_date']['api.default'] = 'now';
   $params['frequency_interval']['api.required'] = 1;
   $params['start_date']['api.default'] = 'now';
+  $params['modified_date']['api.default'] = 'now';
 }
 
 /**
@@ -73,7 +76,7 @@ function civicrm_api3_contribution_recur_get($params) {
 }
 
 /**
- * Cancel a recurring contribution of existing contribution_recur.id.
+ * Cancel a recurring contribution of existing ContributionRecur given its id.
  *
  * @param array $params
  *   Array containing id of the recurring contribution.
@@ -87,10 +90,9 @@ function civicrm_api3_contribution_recur_cancel($params) {
 }
 
 /**
- * Delete an existing contribution_recur.
+ * Delete an existing ContributionRecur.
  *
- * This method is used to delete any existing contribution_recur. id of the group
- * to be deleted is required field in $params array
+ * This method is used to delete an existing ContributionRecur given its id.
  *
  * @param array $params
  *   [id]