| GNU Affero General Public License or the licensing of CiviCRM, |
| see the CiviCRM license FAQ at http://civicrm.org/licensing |
+--------------------------------------------------------------------+
-*/
+ */
/**
*
class CRM_Contribute_BAO_ContributionRecur extends CRM_Contribute_DAO_ContributionRecur {
/**
- * Create recurring contribution
+ * Create recurring contribution.
*
* @param array $params
* (reference ) an assoc array of name/value pairs.
}
/**
- * Takes an associative array and creates a contribution object
+ * Takes an associative array and creates a contribution object.
*
* the function extract all the params it needs to initialize the create a
* contribution object. the params array could contain additional unused name/value
* @param array $params
* (reference ) an assoc array of name/value pairs.
*
- * @return CRM_Contribute_BAO_Contribution object
- * @static
+ * @return CRM_Contribute_BAO_Contribution
* @todo move hook calls / extended logic to create - requires changing calls to call create not add
*/
public static function add(&$params) {
}
/**
- * Check if there is a recurring contribution with the same trxn_id or invoice_id
+ * Check if there is a recurring contribution with the same trxn_id or invoice_id.
*
* @param array $params
* (reference ) an assoc array of name/value pairs.
* @param array $duplicates
* (reference ) store ids of duplicate contribs.
*
- * @return boolean
+ * @return bool
* true if duplicate, false otherwise
- * static
*/
public static function checkDuplicate($params, &$duplicates) {
- $id = CRM_Utils_Array::value('id', $params);
- $trxn_id = CRM_Utils_Array::value('trxn_id', $params);
+ $id = CRM_Utils_Array::value('id', $params);
+ $trxn_id = CRM_Utils_Array::value('trxn_id', $params);
$invoice_id = CRM_Utils_Array::value('invoice_id', $params);
$clause = array();
$params[3] = array($id, 'Integer');
}
- $query = "SELECT id FROM civicrm_contribution_recur WHERE $clause";
- $dao = CRM_Core_DAO::executeQuery($query, $params);
+ $query = "SELECT id FROM civicrm_contribution_recur WHERE $clause";
+ $dao = CRM_Core_DAO::executeQuery($query, $params);
$result = FALSE;
while ($dao->fetch()) {
$duplicates[] = $dao->id;
*
* @return array
* an array of recurring ids count
- * static
*/
public static function getCount(&$ids) {
$recurID = implode(',', $ids);
* @param int $recurId
*
* @return bool
- * @static
*/
public static function deleteRecurContribution($recurId) {
$result = FALSE;
return $result;
}
- $recur = new CRM_Contribute_DAO_ContributionRecur();
+ $recur = new CRM_Contribute_DAO_ContributionRecur();
$recur->id = $recurId;
- $result = $recur->delete();
+ $result = $recur->delete();
return $result;
}
* @param array $activityParams
*
* @return bool
- * @static
*/
public static function cancelRecurContribution($recurId, $objects, $activityParams = array()) {
if (!$recurId) {
}
$contributionStatus = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name');
- $canceledId = array_search('Cancelled', $contributionStatus);
- $recur = new CRM_Contribute_DAO_ContributionRecur();
- $recur->id = $recurId;
+ $canceledId = array_search('Cancelled', $contributionStatus);
+ $recur = new CRM_Contribute_DAO_ContributionRecur();
+ $recur->id = $recurId;
$recur->whereAdd("contribution_status_id != $canceledId");
if ($recur->find(TRUE)) {
if ($dao->auto_renew && $dao->membership_id) {
// its auto-renewal membership mode
$membershipTypes = CRM_Member_PseudoConstant::membershipType();
- $membershipType = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_Membership', $dao->membership_id, 'membership_type_id');
- $membershipType = CRM_Utils_Array::value($membershipType, $membershipTypes);
+ $membershipType = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_Membership', $dao->membership_id, 'membership_type_id');
+ $membershipType = CRM_Utils_Array::value($membershipType, $membershipTypes);
$details .= '
<br/>' . ts('Automatic renewal of %1 membership cancelled.', array(1 => $membershipType));
}
else {
$details .= '
<br/>' . ts('The recurring contribution of %1, every %2 %3 has been cancelled.', array(
- 1 => $dao->amount,
+ 1 => $dao->amount,
2 => $dao->frequency_interval,
3 => $dao->frequency_unit,
));
}
/**
- * Get list of recurring contribution of contact Ids
+ * Get list of recurring contribution of contact Ids.
*
* @param int $contactId
* Contact ID.
* @return array
* list of recurring contribution fields
*
- * @static
*/
public static function getRecurContributions($contactId) {
$params = array();
}
}
}
+
}