3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2014
37 * Report hooks that allow extending a particular report.
38 * Example: Adding new tables to log reports
40 class CRM_Report_BAO_Hook
{
43 * @var array of CRM_Report_BAO_HookInterface objects
45 protected $_queryObjects = NULL;
48 * Singleton function used to manage this object
54 public static function singleton() {
55 static $singleton = NULL;
57 $singleton = new CRM_Report_BAO_Hook();
63 * Get or build the list of search objects (via hook)
65 * @return array of CRM_Report_BAO_Hook_Interface objects
67 public function getSearchQueryObjects() {
68 if ($this->_queryObjects
=== NULL) {
69 $this->_queryObjects
= array();
70 CRM_Utils_Hook
::queryObjects($this->_queryObjects
, 'Report');
72 return $this->_queryObjects
;
79 public function alterLogTables(&$reportObj, &$logTables) {
80 foreach (self
::getSearchQueryObjects() as $obj) {
81 $obj->alterLogTables($reportObj, $logTables);
91 public function logDiffClause(&$reportObj, $table) {
92 $contactIdClause = $join = '';
93 foreach (self
::getSearchQueryObjects() as $obj) {
94 list($cidClause, $joinClause) = $obj->logDiffClause($reportObj, $table);
98 $contactIdClause .= $cidClause;
100 return array($contactIdClause, $join);