From 35e6241a9d6860e367e50847d83ae8997c3b9770 Mon Sep 17 00:00:00 2001 From: Eileen McNaughton Date: Tue, 23 Jun 2015 11:00:17 +1200 Subject: [PATCH] phpcs fixes --- CRM/Contribute/BAO/Query.php | 40 +++++++++++++++++++++++++++--------- 1 file changed, 30 insertions(+), 10 deletions(-) diff --git a/CRM/Contribute/BAO/Query.php b/CRM/Contribute/BAO/Query.php index d25b65b14d..c6b816082a 100644 --- a/CRM/Contribute/BAO/Query.php +++ b/CRM/Contribute/BAO/Query.php @@ -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() { -- 2.25.1