Commit | Line | Data |
---|---|---|
c3e3dd65 DS |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
7e9e8871 | 4 | | CiviCRM version 4.7 | |
c3e3dd65 | 5 | +--------------------------------------------------------------------+ |
fa938177 | 6 | | Copyright CiviCRM LLC (c) 2004-2016 | |
c3e3dd65 DS |
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 | +--------------------------------------------------------------------+ | |
d25dd0ee | 26 | */ |
c3e3dd65 DS |
27 | |
28 | /** | |
29 | * | |
30 | * @package CRM | |
fa938177 | 31 | * @copyright CiviCRM LLC (c) 2004-2016 |
c3e3dd65 DS |
32 | * $Id$ |
33 | * | |
34 | */ | |
35 | ||
36 | /** | |
37 | * Report hooks that allow extending a particular report. | |
74cf4551 | 38 | * Example: Adding new tables to log reports |
c3e3dd65 DS |
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 | /** | |
fe482240 | 48 | * Singleton function used to manage this object. |
c3e3dd65 DS |
49 | * |
50 | * @return object | |
c3e3dd65 DS |
51 | */ |
52 | public static function singleton() { | |
53 | static $singleton = NULL; | |
54 | if (!$singleton) { | |
55 | $singleton = new CRM_Report_BAO_Hook(); | |
56 | } | |
57 | return $singleton; | |
58 | } | |
59 | ||
353ffa53 TO |
60 | /** |
61 | * Get or build the list of search objects (via hook) | |
62 | * | |
63 | * @return array | |
16b10e64 | 64 | * Array of CRM_Report_BAO_Hook_Interface objects |
353ffa53 | 65 | */ |
c3e3dd65 DS |
66 | public function getSearchQueryObjects() { |
67 | if ($this->_queryObjects === NULL) { | |
68 | $this->_queryObjects = array(); | |
69 | CRM_Utils_Hook::queryObjects($this->_queryObjects, 'Report'); | |
70 | } | |
c3e3dd65 DS |
71 | return $this->_queryObjects; |
72 | } | |
73 | ||
74cf4551 EM |
74 | /** |
75 | * @param $reportObj | |
76 | * @param $logTables | |
77 | */ | |
6b4b11c4 | 78 | public function alterLogTables(&$reportObj, &$logTables) { |
c3e3dd65 | 79 | foreach (self::getSearchQueryObjects() as $obj) { |
6b4b11c4 | 80 | $obj->alterLogTables($reportObj, $logTables); |
c3e3dd65 DS |
81 | } |
82 | } | |
6b4b11c4 | 83 | |
74cf4551 EM |
84 | /** |
85 | * @param $reportObj | |
86 | * @param $table | |
87 | * | |
88 | * @return array | |
89 | */ | |
6b4b11c4 DS |
90 | public function logDiffClause(&$reportObj, $table) { |
91 | $contactIdClause = $join = ''; | |
92 | foreach (self::getSearchQueryObjects() as $obj) { | |
93 | list($cidClause, $joinClause) = $obj->logDiffClause($reportObj, $table); | |
79d7553f | 94 | if ($joinClause) { |
6b4b11c4 | 95 | $join .= $joinClause; |
79d7553f | 96 | } |
97 | if ($cidClause) { | |
6b4b11c4 | 98 | $contactIdClause .= $cidClause; |
79d7553f | 99 | } |
6b4b11c4 DS |
100 | } |
101 | return array($contactIdClause, $join); | |
102 | } | |
96025800 | 103 | |
232624b1 | 104 | } |