CRM/Report/BAO/Hook.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.5                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26 */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2014
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * Report hooks that allow extending a particular report.
  38  * Example: Adding new tables to log reports
  39  */
  40 class CRM_Report_BAO_Hook {
  41
  42   /**
  43    * @var array of CRM_Report_BAO_HookInterface objects
  44    */
  45   protected $_queryObjects = NULL;
  46
  47   /**
  48    * singleton function used to manage this object
  49    *
  50    * @return object
  51    * @static
  52    *
  53    */
  54   public static function singleton() {
  55     static $singleton = NULL;
  56     if (!$singleton) {
  57       $singleton = new CRM_Report_BAO_Hook();
  58     }
  59     return $singleton;
  60   }
  61
  62  /**
  63   * Get or build the list of search objects (via hook)
  64   *
  65   * @return array of CRM_Report_BAO_Hook_Interface objects
  66   */
  67   public function getSearchQueryObjects() {
  68     if ($this->_queryObjects === NULL) {
  69       $this->_queryObjects = array();
  70       CRM_Utils_Hook::queryObjects($this->_queryObjects, 'Report');
  71     }
  72     return $this->_queryObjects;
  73   }
  74
  75   /**
  76    * @param $reportObj
  77    * @param $logTables
  78    */
  79   public function alterLogTables(&$reportObj, &$logTables) {
  80     foreach (self::getSearchQueryObjects() as $obj) {
  81       $obj->alterLogTables($reportObj, $logTables);
  82     }
  83   }
  84
  85   /**
  86    * @param $reportObj
  87    * @param $table
  88    *
  89    * @return array
  90    */
  91   public function logDiffClause(&$reportObj, $table) {
  92     $contactIdClause = $join = '';
  93     foreach (self::getSearchQueryObjects() as $obj) {
  94       list($cidClause, $joinClause) = $obj->logDiffClause($reportObj, $table);
  95       if ($joinClause)
  96         $join .= $joinClause;
  97       if ($cidClause)
  98         $contactIdClause .= $cidClause;
  99     }
 100     return array($contactIdClause, $join);
 101   }
 102 }