X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=CRM%2FContribute%2FBAO%2FContributionRecur.php;h=ee81af0b638291f1e2a1deaa213a141f0cbd3e74;hb=eee2530fb5cb0ffa6c790079b2ef38c30e61229a;hp=fed004ad8e7555eaaa7f2a66b7008b7f7e9960b8;hpb=1024e1784fb68b8529a77143f5191a60d70837cf;p=civicrm-core.git diff --git a/CRM/Contribute/BAO/ContributionRecur.php b/CRM/Contribute/BAO/ContributionRecur.php index fed004ad8e..ee81af0b63 100644 --- a/CRM/Contribute/BAO/ContributionRecur.php +++ b/CRM/Contribute/BAO/ContributionRecur.php @@ -23,7 +23,7 @@ | GNU Affero General Public License or the licensing of CiviCRM, | | see the CiviCRM license FAQ at http://civicrm.org/licensing | +--------------------------------------------------------------------+ -*/ + */ /** * @@ -35,28 +35,29 @@ class CRM_Contribute_BAO_ContributionRecur extends CRM_Contribute_DAO_ContributionRecur { /** - * Create recurring contribution - * - * @param array $params (reference ) an assoc array of name/value pairs + * Create recurring contribution. * - * @return object activity contact object + * @param array $params + * (reference ) an assoc array of name/value pairs. * + * @return object + * activity contact object */ public static function create(&$params) { return self::add($params); } /** - * 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 * pairs * - * @param array $params (reference ) an assoc array of name/value pairs + * @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) { @@ -103,17 +104,19 @@ class CRM_Contribute_BAO_ContributionRecur extends CRM_Contribute_DAO_Contributi } /** - * 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 + * @param array $params + * (reference ) an assoc array of name/value pairs. + * @param array $duplicates + * (reference ) store ids of duplicate contribs. * - * @return boolean true if duplicate, false otherwise - * static + * @return bool + * true if duplicate, false otherwise */ 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(); @@ -139,8 +142,8 @@ class CRM_Contribute_BAO_ContributionRecur extends CRM_Contribute_DAO_Contributi $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; @@ -175,10 +178,11 @@ SELECT r.payment_processor_id /** * Get the number of installment done/completed for each recurring contribution * - * @param array $ids (reference ) an array of recurring contribution ids + * @param array $ids + * (reference ) an array of recurring contribution ids. * - * @return array $totalCount an array of recurring ids count - * static + * @return array + * an array of recurring ids count */ public static function getCount(&$ids) { $recurID = implode(',', $ids); @@ -204,7 +208,6 @@ SELECT r.payment_processor_id * @param int $recurId * * @return bool - * @static */ public static function deleteRecurContribution($recurId) { $result = FALSE; @@ -212,9 +215,9 @@ SELECT r.payment_processor_id 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; } @@ -222,14 +225,15 @@ SELECT r.payment_processor_id /** * Cancel Recurring contribution. * - * @param integer $recurId recur contribution id. - * @param array $objects an array of objects that is to be cancelled like + * @param int $recurId + * Recur contribution id. + * @param array $objects + * An array of objects that is to be cancelled like. * contribution, membership, event. At least contribution object is a must. * * @param array $activityParams * * @return bool - * @static */ public static function cancelRecurContribution($recurId, $objects, $activityParams = array()) { if (!$recurId) { @@ -237,9 +241,9 @@ SELECT r.payment_processor_id } $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)) { @@ -257,17 +261,17 @@ SELECT r.payment_processor_id 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 .= '
' . ts('Automatic renewal of %1 membership cancelled.', array(1 => $membershipType)); } else { $details .= '
' . 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 + 3 => $dao->frequency_unit, )); } $activityParams = array( @@ -317,13 +321,14 @@ SELECT r.payment_processor_id } /** - * Get list of recurring contribution of contact Ids + * Get list of recurring contribution of contact Ids. * - * @param int $contactId Contact ID + * @param int $contactId + * Contact ID. * - * @return array list of recurring contribution fields + * @return array + * list of recurring contribution fields * - * @static */ public static function getRecurContributions($contactId) { $params = array(); @@ -451,4 +456,5 @@ INNER JOIN civicrm_contribution con ON ( con.id = mp.contribution_id ) } } } + }