Merge pull request #5210 from eileenmcnaughton/CRM-15996

[civicrm-core.git] / CRM / Contribute / BAO / ContributionRecur.php

diff --git a/CRM/Contribute/BAO/ContributionRecur.php b/CRM/Contribute/BAO/ContributionRecur.php
index 35abe09e936b7d87a5050164fcf093e393949e6d..ee81af0b638291f1e2a1deaa213a141f0cbd3e74 100644 (file)
--- 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,7 +35,7 @@
 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.
@@ -48,7 +48,7 @@ class CRM_Contribute_BAO_ContributionRecur extends CRM_Contribute_DAO_Contributi
   }
 
   /**
-   * 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
@@ -58,7 +58,6 @@ class CRM_Contribute_BAO_ContributionRecur extends CRM_Contribute_DAO_Contributi
    *   (reference ) an assoc array of name/value pairs.
    *
    * @return CRM_Contribute_BAO_Contribution
-   * @static
    * @todo move hook calls / extended logic to create - requires changing calls to call create not add
    */
   public static function add(&$params) {
@@ -105,16 +104,15 @@ 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.
    *
-   * @return boolean
+   * @return bool
    *   true if duplicate, false otherwise
-   * @static
    */
   public static function checkDuplicate($params, &$duplicates) {
     $id = CRM_Utils_Array::value('id', $params);
@@ -185,7 +183,6 @@ SELECT r.payment_processor_id
    *
    * @return array
    *   an array of recurring ids count
-   * @static
    */
   public static function getCount(&$ids) {
     $recurID = implode(',', $ids);
@@ -211,7 +208,6 @@ SELECT r.payment_processor_id
    * @param int $recurId
    *
    * @return bool
-   * @static
    */
   public static function deleteRecurContribution($recurId) {
     $result = FALSE;
@@ -238,7 +234,6 @@ SELECT r.payment_processor_id
    * @param array $activityParams
    *
    * @return bool
-   * @static
    */
   public static function cancelRecurContribution($recurId, $objects, $activityParams = array()) {
     if (!$recurId) {
@@ -326,7 +321,7 @@ 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.
@@ -334,7 +329,6 @@ SELECT r.payment_processor_id
    * @return array
    *   list of recurring contribution fields
    *
-   * @static
    */
   public static function getRecurContributions($contactId) {
     $params = array();
@@ -462,4 +456,5 @@ INNER JOIN civicrm_contribution       con ON ( con.id = mp.contribution_id )
       }
     }
   }
+
 }