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 2321c23b7ba33dc06f547a74a2aae7d54fb29227..068e9c973cfbf2bb2940df539f807ee389c90c19 100644 (file)
--- a/CRM/Report/BAO/Hook.php
+++ b/CRM/Report/BAO/Hook.php
@@ -1,9 +1,9 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.4                                                |
+ | CiviCRM version 4.5                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2013                                |
+ | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -28,14 +28,14 @@
 /**
  *
  * @package CRM
- * @copyright CiviCRM LLC (c) 2004-2013
+ * @copyright CiviCRM LLC (c) 2004-2014
  * $Id$
  *
  */
 
 /**
  * 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);