Merge pull request #4955 from atif-shaikh/master-cleanup

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

diff --git a/CRM/Contribute/BAO/ContributionSoft.php b/CRM/Contribute/BAO/ContributionSoft.php
index a08dbaf5bcf692c152bc8957729d80bbd71966a0..2e8d49da0ea26e230f7ada0eb91d73af615d265a 100644 (file)
--- a/CRM/Contribute/BAO/ContributionSoft.php
+++ b/CRM/Contribute/BAO/ContributionSoft.php
@@ -47,8 +47,8 @@ class CRM_Contribute_BAO_ContributionSoft extends CRM_Contribute_DAO_Contributio
    * @param array $params
    *   (reference ) an assoc array of name/value pairs.
    *
-   * @return object soft contribution of object that is added
-   *
+   * @return object
+   *   soft contribution of object that is added
    */
   public static function add(&$params) {
     $contributionSoft = new CRM_Contribute_DAO_ContributionSoft();
@@ -70,8 +70,7 @@ class CRM_Contribute_BAO_ContributionSoft extends CRM_Contribute_DAO_Contributio
    * @param array $defaults
    *   (reference ) an assoc array to hold the flattened values.
    *
-   * @return CRM_Contribute_BAO_ContributionSoft object
-   * @static
+   * @return CRM_Contribute_BAO_ContributionSoft
    */
   public static function retrieve(&$params, &$defaults) {
     $contributionSoft = new CRM_Contribute_DAO_ContributionSoft();
@@ -88,7 +87,6 @@ class CRM_Contribute_BAO_ContributionSoft extends CRM_Contribute_DAO_Contributio
    *
    * @param array $params
    *
-   * @static
    */
   public static function del($params) {
     //delete from contribution soft table
@@ -114,8 +112,9 @@ class CRM_Contribute_BAO_ContributionSoft extends CRM_Contribute_DAO_Contributio
     GROUP BY currency';
 
     $params = array(
-    1 => array($contact_id, 'Integer'),
-      2 => array($isTest, 'Integer'));
+      1 => array($contact_id, 'Integer'),
+      2 => array($isTest, 'Integer')
+    );
 
     $cs = CRM_Core_DAO::executeQuery($query, $params);
 
@@ -148,8 +147,8 @@ class CRM_Contribute_BAO_ContributionSoft extends CRM_Contribute_DAO_Contributio
    * @param bool $all
    *   Include PCP data.
    *
-   * @return array of soft contribution ids, amounts, and associated contact ids
-   * @static
+   * @return array
+   *   Array of soft contribution ids, amounts, and associated contact ids
    */
   public static function getSoftContribution($contributionID, $all = FALSE) {
     $pcpFields = array(
@@ -191,7 +190,7 @@ class CRM_Contribute_BAO_ContributionSoft extends CRM_Contribute_DAO_Contributio
           'amount' => $dao->amount,
           'contact_name' => $dao->display_name,
           'soft_credit_type' => $dao->soft_credit_type_id,
-          'soft_credit_type_label' => CRM_Core_OptionGroup::getLabel('soft_credit_type', $dao->soft_credit_type_id)
+          'soft_credit_type_label' => CRM_Core_OptionGroup::getLabel('soft_credit_type', $dao->soft_credit_type_id),
         );
         $count++;
       }
@@ -243,7 +242,6 @@ class CRM_Contribute_BAO_ContributionSoft extends CRM_Contribute_DAO_Contributio
    *   Additional filter criteria, later used in where clause.
    *
    * @return array
-   * @static
    */
   public static function getSoftContributionList($contact_id, $filter = NULL, $isTest = 0) {
     $query = '
@@ -281,7 +279,7 @@ class CRM_Contribute_BAO_ContributionSoft extends CRM_Contribute_DAO_Contributio
 
     $params = array(
       1 => array($contact_id, 'Integer'),
-      2 => array($isTest, 'Integer')
+      2 => array($isTest, 'Integer'),
     );
     $cs = CRM_Core_DAO::executeQuery($query, $params);
     $contributionStatus = CRM_Contribute_PseudoConstant::contributionStatus();
@@ -309,15 +307,11 @@ class CRM_Contribute_BAO_ContributionSoft extends CRM_Contribute_DAO_Contributio
     return $result;
   }
 
-  /*
-   *  Function to assign honor profile fields to template/form, if $honorId (as soft-credit's contact_id)
-   *  is passed  then  whole honoreeprofile fields with title/value assoc array assigned or only honoreeName
-   *  is assigned
-   *
-   *  @static
-   */
-
   /**
+   * Function to assign honor profile fields to template/form, if $honorId (as soft-credit's contact_id)
+   * is passed  then  whole honoreeprofile fields with title/value assoc array assigned or only honoreeName
+   * is assigned
+   *
    * @param CRM_Core_Form $form
    * @param array $params
    * @param int $honoreeprofileId