Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
6a488035 TO |
2 | /* |
3 | +--------------------------------------------------------------------+ | |
39de6fd5 | 4 | | CiviCRM version 4.6 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
06b69b18 | 6 | | Copyright CiviCRM LLC (c) 2004-2014 | |
6a488035 TO |
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 | */ |
6a488035 TO |
27 | |
28 | /** | |
29 | * | |
30 | * @package CRM | |
06b69b18 | 31 | * @copyright CiviCRM LLC (c) 2004-2014 |
6a488035 TO |
32 | * $Id$ |
33 | * | |
34 | */ | |
35 | class CRM_Report_Form_Mailing_Clicks extends CRM_Report_Form { | |
36 | ||
37 | protected $_summary = NULL; | |
38 | ||
39 | protected $_emailField = FALSE; | |
40 | ||
41 | protected $_phoneField = FALSE; | |
42 | ||
9d72cede EM |
43 | protected $_customGroupExtends = array( |
44 | 'Contact', | |
45 | 'Individual', | |
46 | 'Household', | |
21dfd5f5 | 47 | 'Organization', |
9d72cede | 48 | ); |
6a488035 TO |
49 | |
50 | protected $_charts = array( | |
51 | '' => 'Tabular', | |
52 | 'barChart' => 'Bar Chart', | |
53 | 'pieChart' => 'Pie Chart', | |
54 | ); | |
2f4c2f5d | 55 | |
74cf4551 | 56 | /** |
74cf4551 EM |
57 | */ |
58 | /** | |
74cf4551 | 59 | */ |
00be9182 | 60 | public function __construct() { |
6a488035 TO |
61 | $this->_columns = array(); |
62 | ||
63 | $this->_columns['civicrm_contact'] = array( | |
64 | 'dao' => 'CRM_Contact_DAO_Contact', | |
65 | 'fields' => array( | |
66 | 'id' => array( | |
67 | 'title' => ts('Contact ID'), | |
68 | 'required' => TRUE, | |
69 | ), | |
9d72cede | 70 | 'sort_name' => array( |
6a488035 TO |
71 | 'title' => ts('Contact Name'), |
72 | 'required' => TRUE, | |
73 | ), | |
74 | ), | |
75 | 'filters' => array( | |
76 | 'sort_name' => array( | |
77 | 'title' => ts('Contact Name'), | |
78 | ), | |
79 | 'source' => array( | |
80 | 'title' => ts('Contact Source'), | |
81 | 'type' => CRM_Utils_Type::T_STRING, | |
82 | ), | |
83 | 'id' => array( | |
84 | 'title' => ts('Contact ID'), | |
85 | 'no_display' => TRUE, | |
86 | ), | |
87 | ), | |
9d72cede EM |
88 | 'order_bys' => array( |
89 | 'sort_name' => array( | |
90 | 'title' => ts('Contact Name'), | |
91 | 'default' => TRUE, | |
21dfd5f5 | 92 | 'default_order' => 'ASC', |
9d72cede | 93 | ), |
6a488035 TO |
94 | ), |
95 | 'grouping' => 'contact-fields', | |
96 | ); | |
97 | ||
98 | $this->_columns['civicrm_mailing'] = array( | |
99 | 'dao' => 'CRM_Mailing_DAO_Mailing', | |
100 | 'fields' => array( | |
101 | 'mailing_name' => array( | |
102 | 'name' => 'name', | |
103 | 'title' => ts('Mailing'), | |
104 | 'default' => TRUE, | |
105 | ), | |
106 | 'mailing_name_alias' => array( | |
107 | 'name' => 'name', | |
108 | 'required' => TRUE, | |
109 | 'no_display' => TRUE, | |
110 | ), | |
111 | ), | |
112 | 'filters' => array( | |
113 | 'mailing_id' => array( | |
114 | 'name' => 'id', | |
115 | 'title' => ts('Mailing'), | |
116 | 'operatorType' => CRM_Report_Form::OP_MULTISELECT, | |
117 | 'type' => CRM_Utils_Type::T_INT, | |
118 | 'options' => CRM_Mailing_BAO_Mailing::getMailingsList(), | |
119 | 'operator' => 'like', | |
120 | ), | |
121 | ), | |
9d72cede EM |
122 | 'order_bys' => array( |
123 | 'mailing_name' => array( | |
6a488035 TO |
124 | 'name' => 'name', |
125 | 'title' => ts('Mailing'), | |
126 | ), | |
127 | ), | |
128 | 'grouping' => 'mailing-fields', | |
129 | ); | |
130 | ||
131 | $this->_columns['civicrm_email'] = array( | |
132 | 'dao' => 'CRM_Core_DAO_Email', | |
133 | 'fields' => array( | |
134 | 'email' => array( | |
135 | 'title' => ts('Email'), | |
136 | 'no_repeat' => TRUE, | |
137 | 'required' => TRUE, | |
138 | ), | |
139 | ), | |
140 | 'grouping' => 'contact-fields', | |
141 | ); | |
142 | ||
143 | $this->_columns['civicrm_phone'] = array( | |
144 | 'dao' => 'CRM_Core_DAO_Phone', | |
145 | 'fields' => array('phone' => NULL), | |
146 | 'grouping' => 'contact-fields', | |
147 | ); | |
148 | ||
149 | $this->_columns['civicrm_mailing_trackable_url'] = array( | |
150 | 'dao' => 'CRM_Mailing_DAO_TrackableURL', | |
151 | 'fields' => array( | |
152 | 'url' => array( | |
153 | 'title' => ts('Click through URL'), | |
154 | ), | |
155 | ), | |
9d72cede EM |
156 | 'order_bys' => array( |
157 | 'url' => array('title' => ts('Click through URL')), | |
6a488035 TO |
158 | ), |
159 | 'grouping' => 'mailing-fields', | |
160 | ); | |
161 | ||
16e2e80c | 162 | $this->_groupFilter = TRUE; |
6a488035 TO |
163 | $this->_tagFilter = TRUE; |
164 | parent::__construct(); | |
165 | } | |
166 | ||
00be9182 | 167 | public function preProcess() { |
6a488035 TO |
168 | $this->assign('chartSupported', TRUE); |
169 | parent::preProcess(); | |
170 | } | |
171 | ||
00be9182 | 172 | public function select() { |
6a488035 TO |
173 | $select = array(); |
174 | $this->_columnHeaders = array(); | |
175 | foreach ($this->_columns as $tableName => $table) { | |
176 | if (array_key_exists('fields', $table)) { | |
177 | foreach ($table['fields'] as $fieldName => $field) { | |
9d72cede EM |
178 | if (!empty($field['required']) || |
179 | !empty($this->_params['fields'][$fieldName]) | |
180 | ) { | |
6a488035 TO |
181 | if ($tableName == 'civicrm_email') { |
182 | $this->_emailField = TRUE; | |
183 | } | |
184 | elseif ($tableName == 'civicrm_phone') { | |
185 | $this->_phoneField = TRUE; | |
186 | } | |
187 | ||
188 | $select[] = "{$field['dbAlias']} as {$tableName}_{$fieldName}"; | |
189 | $this->_columnHeaders["{$tableName}_{$fieldName}"]['type'] = CRM_Utils_Array::value('type', $field); | |
190 | $this->_columnHeaders["{$tableName}_{$fieldName}"]['no_display'] = CRM_Utils_Array::value('no_display', $field); | |
191 | $this->_columnHeaders["{$tableName}_{$fieldName}"]['title'] = CRM_Utils_Array::value('title', $field); | |
192 | } | |
193 | } | |
194 | } | |
195 | } | |
196 | ||
a7488080 | 197 | if (!empty($this->_params['charts'])) { |
6a488035 TO |
198 | $select[] = "COUNT(civicrm_mailing_event_trackable_url_open.id) as civicrm_mailing_click_count"; |
199 | $this->_columnHeaders["civicrm_mailing_click_count"]['title'] = ts('Click Count'); | |
200 | } | |
201 | ||
202 | $this->_select = "SELECT " . implode(', ', $select) . " "; | |
203 | } | |
204 | ||
74cf4551 EM |
205 | /** |
206 | * @param $fields | |
207 | * @param $files | |
208 | * @param $self | |
209 | * | |
210 | * @return array | |
211 | */ | |
00be9182 | 212 | public static function formRule($fields, $files, $self) { |
6a488035 TO |
213 | $errors = $grouping = array(); |
214 | return $errors; | |
215 | } | |
216 | ||
00be9182 | 217 | public function from() { |
6a488035 TO |
218 | $this->_from = " |
219 | FROM civicrm_contact {$this->_aliases['civicrm_contact']} {$this->_aclFrom}"; | |
220 | ||
221 | $this->_from .= " | |
2f4c2f5d | 222 | INNER JOIN civicrm_mailing_event_queue |
223 | ON civicrm_mailing_event_queue.contact_id = {$this->_aliases['civicrm_contact']}.id | |
224 | INNER JOIN civicrm_email {$this->_aliases['civicrm_email']} | |
225 | ON civicrm_mailing_event_queue.email_id = {$this->_aliases['civicrm_email']}.id | |
226 | INNER JOIN civicrm_mailing_event_trackable_url_open | |
227 | ON civicrm_mailing_event_trackable_url_open.event_queue_id = civicrm_mailing_event_queue.id | |
228 | INNER JOIN civicrm_mailing_trackable_url {$this->_aliases['civicrm_mailing_trackable_url']} | |
229 | ON civicrm_mailing_event_trackable_url_open.trackable_url_id = {$this->_aliases['civicrm_mailing_trackable_url']}.id | |
230 | INNER JOIN civicrm_mailing_job | |
231 | ON civicrm_mailing_event_queue.job_id = civicrm_mailing_job.id | |
232 | INNER JOIN civicrm_mailing {$this->_aliases['civicrm_mailing']} | |
233 | ON civicrm_mailing_job.mailing_id = {$this->_aliases['civicrm_mailing']}.id | |
234 | AND civicrm_mailing_job.is_test = 0 | |
235 | "; | |
6a488035 TO |
236 | if ($this->_phoneField) { |
237 | $this->_from .= " | |
2f4c2f5d | 238 | LEFT JOIN civicrm_phone {$this->_aliases['civicrm_phone']} |
239 | ON {$this->_aliases['civicrm_contact']}.id = {$this->_aliases['civicrm_phone']}.contact_id AND | |
6a488035 TO |
240 | {$this->_aliases['civicrm_phone']}.is_primary = 1 "; |
241 | } | |
242 | } | |
243 | ||
00be9182 | 244 | public function where() { |
6a488035 TO |
245 | parent::where(); |
246 | $this->_where .= " AND {$this->_aliases['civicrm_mailing']}.sms_provider_id IS NULL"; | |
247 | } | |
248 | ||
00be9182 | 249 | public function groupBy() { |
6a488035 TO |
250 | |
251 | $this->_groupBy = ''; | |
a7488080 | 252 | if (!empty($this->_params['charts'])) { |
6a488035 TO |
253 | $this->_groupBy = " GROUP BY {$this->_aliases['civicrm_mailing']}.id"; |
254 | } | |
255 | else { | |
256 | $this->_groupBy = " GROUP BY civicrm_mailing_event_trackable_url_open.id"; | |
257 | } | |
258 | } | |
259 | ||
00be9182 | 260 | public function postProcess() { |
6a488035 TO |
261 | |
262 | $this->beginPostProcess(); | |
263 | ||
264 | // get the acl clauses built before we assemble the query | |
265 | $this->buildACLClause($this->_aliases['civicrm_contact']); | |
266 | ||
267 | $sql = $this->buildQuery(TRUE); | |
268 | ||
269 | $rows = $graphRows = array(); | |
270 | $this->buildRows($sql, $rows); | |
271 | ||
272 | $this->formatDisplay($rows); | |
273 | $this->doTemplateAssignment($rows); | |
274 | $this->endPostProcess($rows); | |
275 | } | |
276 | ||
74cf4551 EM |
277 | /** |
278 | * @param $rows | |
279 | */ | |
00be9182 | 280 | public function buildChart(&$rows) { |
6a488035 TO |
281 | if (empty($rows)) { |
282 | return; | |
283 | } | |
284 | ||
9d72cede EM |
285 | $chartInfo = array( |
286 | 'legend' => ts('Mail Clickthrough Report'), | |
6a488035 TO |
287 | 'xname' => ts('Mailing'), |
288 | 'yname' => ts('Clicks'), | |
289 | 'xLabelAngle' => 20, | |
290 | 'tip' => ts('Clicks: %1', array(1 => '#val#')), | |
291 | ); | |
292 | foreach ($rows as $row) { | |
293 | $chartInfo['values'][$row['civicrm_mailing_mailing_name_alias']] = $row['civicrm_mailing_click_count']; | |
294 | } | |
295 | ||
296 | // build the chart. | |
297 | CRM_Utils_OpenFlashChart::buildChart($chartInfo, $this->_params['charts']); | |
298 | $this->assign('chartType', $this->_params['charts']); | |
299 | } | |
300 | ||
74cf4551 | 301 | /** |
ced9bfed EM |
302 | * Alter display of rows. |
303 | * | |
304 | * Iterate through the rows retrieved via SQL and make changes for display purposes, | |
305 | * such as rendering contacts as links. | |
306 | * | |
307 | * @param array $rows | |
308 | * Rows generated by SQL, with an array for each row. | |
74cf4551 | 309 | */ |
00be9182 | 310 | public function alterDisplay(&$rows) { |
6a488035 TO |
311 | $entryFound = FALSE; |
312 | foreach ($rows as $rowNum => $row) { | |
313 | // make count columns point to detail report | |
314 | // convert display name to links | |
315 | if (array_key_exists('civicrm_contact_sort_name', $row) && | |
316 | array_key_exists('civicrm_contact_id', $row) | |
317 | ) { | |
318 | $url = CRM_Utils_System::url('civicrm/contact/view', | |
319 | 'reset=1&cid=' . $row['civicrm_contact_id'], | |
320 | $this->_absoluteUrl | |
321 | ); | |
322 | $rows[$rowNum]['civicrm_contact_sort_name_link'] = $url; | |
323 | $rows[$rowNum]['civicrm_contact_sort_name_hover'] = ts("View Contact details for this contact."); | |
324 | $entryFound = TRUE; | |
325 | } | |
326 | ||
327 | // skip looking further in rows, if first row itself doesn't | |
328 | // have the column we need | |
329 | if (!$entryFound) { | |
330 | break; | |
331 | } | |
332 | } | |
333 | } | |
96025800 | 334 | |
6a488035 | 335 | } |