phpcs fixes
authorEileen McNaughton <eileen@fuzion.co.nz>
Mon, 22 Jun 2015 23:00:17 +0000 (11:00 +1200)
committerEileen McNaughton <eileen@fuzion.co.nz>
Mon, 22 Jun 2015 23:00:17 +0000 (11:00 +1200)
CRM/Contribute/BAO/Query.php

index d25b65b14d099f27f8b0af6c055ca0c80e28e2e2..c6b816082af5d9706669368a24fd5dd40d7cda4f 100644 (file)
@@ -43,7 +43,7 @@ class CRM_Contribute_BAO_Query {
   static $_contribOrSoftCredit = "only_contribs";
 
   /**
-   * Function get the import/export fields for contribution
+   * Function get the import/export fields for contribution.
    *
    * @return array
    *   self::$_contributionFields  associative array of contribution fields
@@ -64,7 +64,7 @@ class CRM_Contribute_BAO_Query {
   /**
    * If contributions are involved, add the specific contribute fields.
    *
-   * @param $query
+   * @param CRM_Contact_BAO_Query $query
    */
   public static function select(&$query) {
     // if contribute mode add contribution id
@@ -219,7 +219,9 @@ class CRM_Contribute_BAO_Query {
   }
 
   /**
-   * @param $query
+   * Get where clause.
+   *
+   * @param CRM_Contact_BAO_Query $query
    */
   public static function where(&$query) {
     $grouping = NULL;
@@ -252,8 +254,10 @@ class CRM_Contribute_BAO_Query {
   }
 
   /**
-   * @param $values
-   * @param $query
+   * Get where clause for a single value.
+   *
+   * @param array $values
+   * @param CRM_Contact_BAO_Query $query
    */
   public static function whereClauseSingle(&$values, &$query) {
     list($name, $op, $value, $grouping, $wildcard) = $values;
@@ -551,9 +555,11 @@ class CRM_Contribute_BAO_Query {
   }
 
   /**
+   * Get from clause.
+   *
    * @param string $name
-   * @param $mode
-   * @param $side
+   * @param string $mode
+   * @param string $side
    *
    * @return NULL|string
    */
@@ -694,7 +700,9 @@ class CRM_Contribute_BAO_Query {
   }
 
   /**
-   * @param $query
+   * Initialise the soft credit clause.
+   *
+   * @param CRM_Contact_BAO_Query $query
    */
   public static function initializeAnySoftCreditClause(&$query) {
     if (self::isSoftCreditOptionEnabled($query->_params)) {
@@ -707,6 +715,8 @@ class CRM_Contribute_BAO_Query {
   }
 
   /**
+   * Check if soft credits are enables.
+   *
    * @param array $queryParams
    *
    * @return bool
@@ -746,6 +756,8 @@ class CRM_Contribute_BAO_Query {
   }
 
   /**
+   * Get return properties for soft credits.
+   *
    * @param bool $isExportMode
    *
    * @return array
@@ -969,14 +981,20 @@ class CRM_Contribute_BAO_Query {
   }
 
   /**
-   * @param $row
+   * Function that may not be needed.
+   *
+   * @param array $row
    * @param int $id
    */
   public static function searchAction(&$row, $id) {
   }
 
   /**
-   * @param $tables
+   * Get table names.
+   *
+   * @todo better function comment needed - what IS the point of this?
+   *
+   * @param array $tables
    */
   public static function tableNames(&$tables) {
     // Add contribution table
@@ -1020,6 +1038,8 @@ class CRM_Contribute_BAO_Query {
   }
 
   /**
+   * Get fields for recurring contributions.
+   *
    * @return array
    */
   public static function getRecurringFields() {