<?php
/*
+--------------------------------------------------------------------+
- | CiviCRM version 4.5 |
+ | CiviCRM version 4.6 |
+--------------------------------------------------------------------+
| Copyright CiviCRM LLC (c) 2004-2014 |
+--------------------------------------------------------------------+
*/
/**
- * Create or update a contribution_recur
+ * Create or update a contribution_recur.
*
- * @param array $params Associative array of property
- * name/value pairs to insert in new 'contribution_recur'
- * @example ContributionRecurCreate.php Std Create example
+ * @param array $params
+ * Array per getfields metadata.
*
- * @return array api result array
- * {@getfields contribution_recur_create}
- * @access public
+ * @return array
+ * api result array
*/
function civicrm_api3_contribution_recur_create($params) {
return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
}
/**
- * Adjust Metadata for Create action
+ * Adjust Metadata for Create action.
*
- * The metadata is used for setting defaults, documentation & validation
- * @param array $params array or parameters determined by getfields
+ * The metadata is used for setting defaults, documentation & validation.
+ *
+ * @param array $params
+ * Array or parameters determined by getfields.
*/
function _civicrm_api3_contribution_recur_create_spec(&$params) {
$params['contact_id']['api.required'] = 1;
}
/**
- * Returns array of contribution_recurs matching a set of one or more group properties
+ * Returns array of contribution_recurs matching a set of one or more group properties.
*
- * @param array $params (referance) Array of one or more valid
+ * @param array $params
+ * Array of one or more valid.
* property_name=>value pairs. If $params is set
* as null, all contribution_recurs will be returned
*
- * @return array (referance) Array of matching contribution_recurs
- * {@getfields contribution_recur_get}
- * @access public
+ * @return array
+ * API result Array of matching contribution_recurs
*/
function civicrm_api3_contribution_recur_get($params) {
return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
}
/**
- * Cancel a recurring contribution of existing contribution_recur.id
+ * Cancel a recurring contribution of existing contribution_recur.id.
*
- * @param array $params (reference) array containing id of the recurring contribution
+ * @param array $params
+ * Array containing id of the recurring contribution.
*
- * @return boolean returns true is successfully cancelled
+ * @return bool
+ * returns true is successfully cancelled
*/
-
function civicrm_api3_contribution_recur_cancel($params) {
civicrm_api3_verify_one_mandatory($params, NULL, array('id'));
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'));
}
/**
- * delete an existing contribution_recur
+ * Delete an existing contribution_recur.
*
* This method is used to delete any existing contribution_recur. id of the group
* to be deleted is required field in $params array
*
- * @param array $params (reference) array containing id of the group
+ * @param array $params
+ * Array containing id of the group.
* to be deleted
*
- * @return array (referance) returns flag true if successfull, error
- * message otherwise
- * {@getfields contribution_recur_delete}
- * @access public
+ * @return array
+ * API result array
*/
function civicrm_api3_contribution_recur_delete($params) {
return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);