Merge pull request #3912 from eileenmcnaughton/CRM-15168

[civicrm-core.git] / CRM / Report / BAO / Hook.php

diff --git a/CRM/Report/BAO/Hook.php b/CRM/Report/BAO/Hook.php
index b8d69b8eb27e9af7c06475549ee6a2bac310e759..068e9c973cfbf2bb2940df539f807ee389c90c19 100644 (file)
--- a/CRM/Report/BAO/Hook.php
+++ b/CRM/Report/BAO/Hook.php
@@ -35,7 +35,7 @@
 
 /**
  * Report hooks that allow extending a particular report.
- * Example: Adding new tables to log reports 
+ * Example: Adding new tables to log reports
  */
 class CRM_Report_BAO_Hook {
 
@@ -72,19 +72,29 @@ class CRM_Report_BAO_Hook {
     return $this->_queryObjects;
   }
 
+  /**
+   * @param $reportObj
+   * @param $logTables
+   */
   public function alterLogTables(&$reportObj, &$logTables) {
     foreach (self::getSearchQueryObjects() as $obj) {
       $obj->alterLogTables($reportObj, $logTables);
     }
   }
 
+  /**
+   * @param $reportObj
+   * @param $table
+   *
+   * @return array
+   */
   public function logDiffClause(&$reportObj, $table) {
     $contactIdClause = $join = '';
     foreach (self::getSearchQueryObjects() as $obj) {
       list($cidClause, $joinClause) = $obj->logDiffClause($reportObj, $table);
-      if ($joinClause) 
+      if ($joinClause)
         $join .= $joinClause;
-      if ($cidClause) 
+      if ($cidClause)
         $contactIdClause .= $cidClause;
     }
     return array($contactIdClause, $join);