3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2015 |
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-2015
35 class CRM_Report_Form_ActivitySummary
extends CRM_Report_Form
{
37 protected $_emailField = FALSE;
38 protected $_phoneField = FALSE;
44 public function __construct() {
45 $this->_columns
= array(
46 'civicrm_contact' => array(
47 'dao' => 'CRM_Contact_DAO_Contact',
54 'title' => ts('Contact Name'),
61 'title' => ts('Contact Name'),
67 'title' => ts('Contact'),
73 'title' => ts('Contact Name'),
76 'grouping' => 'contact-fields',
78 'civicrm_email' => array(
79 'dao' => 'CRM_Core_DAO_Email',
88 'title' => ts('Email'),
91 'grouping' => 'contact-fields',
93 'civicrm_phone' => array(
94 'dao' => 'CRM_Core_DAO_Email',
100 'grouping' => 'contact-fields',
102 'civicrm_activity' => array(
103 'dao' => 'CRM_Activity_DAO_Activity',
105 'activity_type_id' => array(
106 'title' => ts('Activity Type'),
108 'type' => CRM_Utils_Type
::T_STRING
,
110 'status_id' => array(
111 'title' => ts('Activity Status'),
113 'type' => CRM_Utils_Type
::T_STRING
,
116 'title' => 'Duration',
117 'statistics' => array(
118 'sum' => ts('Duration'),
122 'title' => 'Total Activities',
124 'statistics' => array(
125 'count' => ts('Count'),
130 'activity_date_time' => array(
131 'operatorType' => CRM_Report_Form
::OP_DATE
,
133 'activity_type_id' => array(
134 'title' => ts('Activity Type'),
135 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
136 'options' => CRM_Core_PseudoConstant
::activityType(TRUE, TRUE, FALSE, 'label', TRUE),
138 'status_id' => array(
139 'title' => ts('Activity Status'),
140 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
141 'options' => CRM_Core_PseudoConstant
::activityStatus(),
143 'priority_id' => array(
144 'title' => ts('Priority'),
145 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
146 'options' => CRM_Core_PseudoConstant
::get('CRM_Activity_DAO_Activity', 'priority_id'),
149 'group_bys' => array(
150 'activity_date_time' => array(
151 'title' => ts('Activity Date'),
154 'activity_type_id' => array(
155 'title' => ts('Activity Type'),
158 'status_id' => array(
159 'title' => ts('Activity Status'),
163 'order_bys' => array(
164 'activity_date_time' => array(
165 'title' => ts('Activity Date'),
167 'activity_type_id' => array(
168 'title' => ts('Activity Type'),
171 'grouping' => 'activity-fields',
172 'alias' => 'activity',
175 $this->_groupFilter
= TRUE;
177 parent
::__construct();
180 public function select() {
182 $this->_columnHeaders
= array();
183 foreach ($this->_columns
as $tableName => $table) {
184 if (array_key_exists('group_bys', $table)) {
185 foreach ($table['group_bys'] as $fieldName => $field) {
186 if (!empty($this->_params
['group_bys'][$fieldName])) {
187 //include column in report when selected in group by but not in column section.
188 if (empty($this->_params
['fields'][$fieldName])) {
189 $this->_params
['fields'][$fieldName] = TRUE;
191 if (isset($this->_params
['group_bys_freq']) && !empty($this->_params
['group_bys_freq'][$fieldName])) {
192 switch ($this->_params
['group_bys_freq'][$fieldName]) {
194 $select[] = "DATE_SUB({$field['dbAlias']}, INTERVAL WEEKDAY({$field['dbAlias']}) DAY) AS {$tableName}_{$fieldName}_start";
196 $select[] = "YEARWEEK({$field['dbAlias']}) AS {$tableName}_{$fieldName}_subtotal";
197 $select[] = "WEEKOFYEAR({$field['dbAlias']}) AS {$tableName}_{$fieldName}_interval";
198 $field['title'] = 'Week';
202 $select[] = "MAKEDATE(YEAR({$field['dbAlias']}), 1) AS {$tableName}_{$fieldName}_start";
203 $select[] = "YEAR({$field['dbAlias']}) AS {$tableName}_{$fieldName}_subtotal";
204 $select[] = "YEAR({$field['dbAlias']}) AS {$tableName}_{$fieldName}_interval";
205 $field['title'] = 'Year';
209 $select[] = "DATE_SUB({$field['dbAlias']}, INTERVAL (DAYOFMONTH({$field['dbAlias']})-1) DAY) as {$tableName}_{$fieldName}_start";
210 $select[] = "MONTH({$field['dbAlias']}) AS {$tableName}_{$fieldName}_subtotal";
211 $select[] = "MONTHNAME({$field['dbAlias']}) AS {$tableName}_{$fieldName}_interval";
212 $field['title'] = 'Month';
216 $select[] = "STR_TO_DATE(CONCAT( 3 * QUARTER( {$field['dbAlias']} ) -2 , '/', '1', '/', YEAR( {$field['dbAlias']} ) ), '%m/%d/%Y') AS {$tableName}_{$fieldName}_start";
217 $select[] = "QUARTER({$field['dbAlias']}) AS {$tableName}_{$fieldName}_subtotal";
218 $select[] = "QUARTER({$field['dbAlias']}) AS {$tableName}_{$fieldName}_interval";
219 $field['title'] = 'Quarter';
222 $this->_interval
= $field['title'];
223 $this->_columnHeaders
["{$tableName}_{$fieldName}_start"]['title'] = $field['title'] . ' Beginning';
224 $this->_columnHeaders
["{$tableName}_{$fieldName}_start"]['type'] = $field['type'];
225 $this->_columnHeaders
["{$tableName}_{$fieldName}_start"]['group_by'] = $this->_params
['group_bys_freq'][$fieldName];
227 // just to make sure these values are transferred to rows.
228 // since we need that for calculation purpose,
229 // e.g making subtotals look nicer or graphs
230 $this->_columnHeaders
["{$tableName}_{$fieldName}_interval"] = array('no_display' => TRUE);
231 $this->_columnHeaders
["{$tableName}_{$fieldName}_subtotal"] = array('no_display' => TRUE);
236 if (array_key_exists('fields', $table)) {
237 foreach ($table['fields'] as $fieldName => $field) {
238 if (!empty($field['required']) ||
!empty($this->_params
['fields'][$fieldName])) {
239 if ($tableName == 'civicrm_email') {
240 $this->_emailField
= TRUE;
242 if ($tableName == 'civicrm_phone') {
243 $this->_phoneField
= TRUE;
245 if (!empty($field['statistics'])) {
246 foreach ($field['statistics'] as $stat => $label) {
247 switch (strtolower($stat)) {
249 $select[] = "COUNT(DISTINCT({$field['dbAlias']})) as {$tableName}_{$fieldName}_{$stat}";
250 $this->_columnHeaders
["{$tableName}_{$fieldName}_{$stat}"]['type'] = CRM_Utils_Type
::T_INT
;
251 $this->_columnHeaders
["{$tableName}_{$fieldName}_{$stat}"]['title'] = $label;
252 $this->_statFields
[] = "{$tableName}_{$fieldName}_{$stat}";
256 $select[] = "SUM({$field['dbAlias']}) as {$tableName}_{$fieldName}_{$stat}";
257 $this->_columnHeaders
["{$tableName}_{$fieldName}_{$stat}"]['type'] = CRM_Utils_Type
::T_INT
;
258 $this->_columnHeaders
["{$tableName}_{$fieldName}_{$stat}"]['title'] = $label;
259 $this->_statFields
[] = "{$tableName}_{$fieldName}_{$stat}";
264 elseif ($fieldName == 'activity_type_id') {
265 if (empty($this->_params
['group_bys']['activity_type_id'])) {
266 $select[] = "GROUP_CONCAT(DISTINCT {$field['dbAlias']} ORDER BY {$field['dbAlias']} ) as {$tableName}_{$fieldName}";
269 $select[] = "{$field['dbAlias']} as {$tableName}_{$fieldName}";
271 $this->_columnHeaders
["{$tableName}_{$fieldName}"]['type'] = CRM_Utils_Array
::value('type', $field);
272 $this->_columnHeaders
["{$tableName}_{$fieldName}"]['title'] = CRM_Utils_Array
::value('title', $field);
273 $this->_columnHeaders
["{$tableName}_{$fieldName}"]['no_display'] = CRM_Utils_Array
::value('no_display', $field);
276 $select[] = "{$field['dbAlias']} as {$tableName}_{$fieldName}";
277 $this->_columnHeaders
["{$tableName}_{$fieldName}"]['type'] = CRM_Utils_Array
::value('type', $field);
278 $this->_columnHeaders
["{$tableName}_{$fieldName}"]['title'] = CRM_Utils_Array
::value('title', $field);
279 $this->_columnHeaders
["{$tableName}_{$fieldName}"]['no_display'] = CRM_Utils_Array
::value('no_display', $field);
286 $this->_select
= "SELECT " . implode(', ', $select) . " ";
289 public function from() {
290 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
291 $assigneeID = CRM_Utils_Array
::key('Activity Assignees', $activityContacts);
292 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
293 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
296 FROM civicrm_activity {$this->_aliases['civicrm_activity']}
298 LEFT JOIN civicrm_activity_contact target_activity
299 ON {$this->_aliases['civicrm_activity']}.id = target_activity.activity_id AND
300 target_activity.record_type_id = {$targetID}
301 LEFT JOIN civicrm_activity_contact assignment_activity
302 ON {$this->_aliases['civicrm_activity']}.id = assignment_activity.activity_id AND
303 assignment_activity.record_type_id = {$assigneeID}
304 LEFT JOIN civicrm_activity_contact source_activity
305 ON {$this->_aliases['civicrm_activity']}.id = source_activity.activity_id AND
306 source_activity.record_type_id = {$sourceID}
307 LEFT JOIN civicrm_contact contact_civireport
308 ON target_activity.contact_id = contact_civireport.id
309 LEFT JOIN civicrm_contact civicrm_contact_assignee
310 ON assignment_activity.contact_id = civicrm_contact_assignee.id
311 LEFT JOIN civicrm_contact civicrm_contact_source
312 ON source_activity.contact_id = civicrm_contact_source.id
314 LEFT JOIN civicrm_option_value
315 ON ( {$this->_aliases['civicrm_activity']}.activity_type_id = civicrm_option_value.value )
316 LEFT JOIN civicrm_option_group
317 ON civicrm_option_group.id = civicrm_option_value.option_group_id
318 LEFT JOIN civicrm_case_activity
319 ON civicrm_case_activity.activity_id = {$this->_aliases['civicrm_activity']}.id
320 LEFT JOIN civicrm_case
321 ON civicrm_case_activity.case_id = civicrm_case.id
322 LEFT JOIN civicrm_case_contact
323 ON civicrm_case_contact.case_id = civicrm_case.id ";
325 if ($this->_emailField
) {
327 LEFT JOIN civicrm_email {$this->_aliases['civicrm_email']}
328 ON {$this->_aliases['civicrm_contact']}.id = {$this->_aliases['civicrm_email']}.contact_id AND
329 {$this->_aliases['civicrm_email']}.is_primary = 1 ";
332 if ($this->_phoneField
) {
334 LEFT JOIN civicrm_phone {$this->_aliases['civicrm_phone']}
335 ON {$this->_aliases['civicrm_contact']}.id = {$this->_aliases['civicrm_phone']}.contact_id AND
336 {$this->_aliases['civicrm_phone']}.is_primary = 1 ";
340 public function where() {
341 $this->_where
= " WHERE civicrm_option_group.name = 'activity_type' AND
342 {$this->_aliases['civicrm_activity']}.is_test = 0 AND
343 {$this->_aliases['civicrm_activity']}.is_deleted = 0 AND
344 {$this->_aliases['civicrm_activity']}.is_current_revision = 1";
347 foreach ($this->_columns
as $tableName => $table) {
348 if (array_key_exists('filters', $table)) {
350 foreach ($table['filters'] as $fieldName => $field) {
352 if (CRM_Utils_Array
::value('type', $field) & CRM_Utils_Type
::T_DATE
) {
353 $relative = CRM_Utils_Array
::value("{$fieldName}_relative", $this->_params
);
354 $from = CRM_Utils_Array
::value("{$fieldName}_from", $this->_params
);
355 $to = CRM_Utils_Array
::value("{$fieldName}_to", $this->_params
);
357 $clause = $this->dateClause($field['name'], $relative, $from, $to, $field['type']);
360 $op = CRM_Utils_Array
::value("{$fieldName}_op", $this->_params
);
362 $clause = $this->whereClause($field,
364 CRM_Utils_Array
::value("{$fieldName}_value", $this->_params
),
365 CRM_Utils_Array
::value("{$fieldName}_min", $this->_params
),
366 CRM_Utils_Array
::value("{$fieldName}_max", $this->_params
)
371 if (!empty($clause)) {
372 $clauses[] = $clause;
378 if (empty($clauses)) {
379 $this->_where
.= " ";
382 $this->_where
.= " AND " . implode(' AND ', $clauses);
385 if ($this->_aclWhere
) {
386 $this->_where
.= " AND {$this->_aclWhere} ";
390 public function groupBy() {
391 $this->_groupBy
= array();
392 if (is_array($this->_params
['group_bys']) &&
393 !empty($this->_params
['group_bys'])
395 foreach ($this->_columns
as $tableName => $table) {
396 if (array_key_exists('group_bys', $table)) {
397 foreach ($table['group_bys'] as $fieldName => $field) {
398 if (!empty($this->_params
['group_bys'][$fieldName])) {
399 if (!empty($field['chart'])) {
400 $this->assign('chartSupported', TRUE);
402 if (!empty($table['group_bys'][$fieldName]['frequency']) &&
403 !empty($this->_params
['group_bys_freq'][$fieldName])
406 $append = "YEAR({$field['dbAlias']}),";
407 if (in_array(strtolower($this->_params
['group_bys_freq'][$fieldName]),
412 $this->_groupBy
[] = "$append {$this->_params['group_bys_freq'][$fieldName]}({$field['dbAlias']})";
416 $this->_groupBy
[] = $field['dbAlias'];
423 $this->_groupBy
= "GROUP BY " . implode(', ', $this->_groupBy
);
426 $this->_groupBy
= "GROUP BY {$this->_aliases['civicrm_contact']}.id ";
437 public static function formRule($fields, $files, $self) {
439 $contactFields = array('sort_name', 'email', 'phone');
440 if (!empty($fields['group_bys'])) {
441 if (!empty($fields['group_bys']['activity_date_time'])) {
442 if (!empty($fields['group_bys']['sort_name'])) {
443 $errors['fields'] = ts("Please do not select GroupBy 'Activity Date' with GroupBy 'Contact'");
446 foreach ($fields['fields'] as $fieldName => $val) {
447 if (in_array($fieldName, $contactFields)) {
448 $errors['fields'] = ts("Please do not select any Contact Fields with GroupBy 'Activity Date'");
458 public function postProcess() {
459 // get the acl clauses built before we assemble the query
460 $this->buildACLClause($this->_aliases
['civicrm_contact']);
461 parent
::postProcess();
469 public function statistics(&$rows) {
470 $statistics = parent
::statistics($rows);
471 $totalType = $totalActivity = $totalDuration = 0;
474 COUNT(DISTINCT {$this->_aliases['civicrm_activity']}.activity_type_id ) as civicrm_activity_activity_type_id_count,
475 COUNT({$this->_aliases['civicrm_activity']}.activity_type_id ) as civicrm_activity_activity_type_count,
476 SUM({$this->_aliases['civicrm_activity']}.duration ) as civicrm_activity_activity_duration
477 {$this->_from} {$this->_where}";
479 $actDAO = CRM_Core_DAO
::executeQuery($actSQL);
481 while ($actDAO->fetch()) {
482 $totalType +
= $actDAO->civicrm_activity_activity_type_id_count
;
483 $totalActivity +
= $actDAO->civicrm_activity_activity_type_count
;
484 $totalDuration +
= $actDAO->civicrm_activity_activity_duration
;
487 $statistics['counts']['type'] = array(
488 'title' => ts('Total Types'),
489 'value' => $totalType,
491 $statistics['counts']['activities'] = array(
492 'title' => ts('Total Number of Activities'),
493 'value' => $totalActivity,
495 $statistics['counts']['duration'] = array(
496 'title' => ts('Total Duration (in Minutes)'),
497 'value' => $totalDuration,
502 public function modifyColumnHeaders() {
503 //CRM-16719 modify name of column
504 if (!empty($this->_columnHeaders
['civicrm_activity_status_id'])) {
505 $this->_columnHeaders
['civicrm_activity_status_id']['title'] = "Status";
510 * Alter display of rows.
512 * Iterate through the rows retrieved via SQL and make changes for display purposes,
513 * such as rendering contacts as links.
516 * Rows generated by SQL, with an array for each row.
518 public function alterDisplay(&$rows) {
520 $activityType = CRM_Core_PseudoConstant
::activityType(TRUE, TRUE, FALSE, 'label', TRUE);
521 $activityStatus = CRM_Core_PseudoConstant
::activityStatus();
523 $onHover = ts('View Contact Summary for this Contact');
524 foreach ($rows as $rowNum => $row) {
525 // make count columns point to activity detail report
526 if (!empty($row['civicrm_activity_id_count'])) {
528 $urlParams = array('activity_type_id', 'gid', 'status_id', 'contact_id');
529 foreach ($urlParams as $field) {
530 if (!empty($row['civicrm_activity_' . $field])) {
531 $url[] = "{$field}_op=in&{$field}_value={$row['civicrm_activity_'.$field]}";
533 elseif (!empty($this->_params
[$field . '_value'])) {
534 $val = implode(",", $this->_params
[$field . '_value']);
535 $url[] = "{$field}_op=in&{$field}_value={$val}";
538 $date_suffixes = array('relative', 'from', 'to');
539 while (list(, $suffix) = each($date_suffixes)) {
540 if (!empty($this->_params
['activity_date_time_' . $suffix])) {
543 CRM_Utils_Array
::value("activity_date_time_relative", $this->_params
),
544 CRM_Utils_Array
::value("activity_date_time_from", $this->_params
),
545 CRM_Utils_Array
::value("activity_date_time_to", $this->_params
)
547 $url[] = "activity_date_time_from={$from}&activity_date_time_to={$to}";
551 $url = implode('&', $url);
552 $url = CRM_Report_Utils_Report
::getNextUrl('activity', "reset=1&force=1&{$url}",
555 $this->_drilldownReport
);
556 $rows[$rowNum]['civicrm_activity_id_count_link'] = $url;
557 $rows[$rowNum]['civicrm_activity_id_count_hover'] = ts('List all activity(s) for this row.');
561 if (array_key_exists('civicrm_contact_sort_name', $row) && $this->_outputMode
!= 'csv') {
562 if ($value = $row['civicrm_contact_id']) {
565 $priviousContact = $value;
568 if ($priviousContact == $value) {
570 $priviousContact = $value;
574 $priviousContact = $value;
578 if ($flagContact == 1) {
579 $rows[$rowNum]['civicrm_contact_sort_name'] = "";
581 if (array_key_exists('civicrm_email_email', $row)) {
582 $rows[$rowNum]['civicrm_email_email'] = "";
584 if (array_key_exists('civicrm_phone_phone', $row)) {
585 $rows[$rowNum]['civicrm_phone_phone'] = "";
589 $url = CRM_Utils_System
::url('civicrm/contact/view',
590 'reset=1&cid=' . $value,
594 $rows[$rowNum]['civicrm_contact_sort_name'] = "<a href='$url'>" . $row['civicrm_contact_sort_name'] .
601 if (array_key_exists('civicrm_activity_activity_type_id', $row)) {
602 if ($value = $row['civicrm_activity_activity_type_id']) {
604 $value = explode(',', $value);
605 foreach ($value as $key => $id) {
606 $value[$key] = $activityType[$id];
609 $rows[$rowNum]['civicrm_activity_activity_type_id'] = implode(' , ', $value);
614 if (array_key_exists('civicrm_activity_status_id', $row)) {
615 if ($value = $row['civicrm_activity_status_id']) {
616 $rows[$rowNum]['civicrm_activity_status_id'] = $activityStatus[$value];