projects / civicrm-core.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Merge pull request #2597 from pratik-joshi/atif_work_on_fix_for_js_break
[civicrm-core.git] / CRM / Report / Form.php
CommitLineData
6a488035 1<?php
6a488035
TO		 2/*
3 +--------------------------------------------------------------------+
232624b1 4 | CiviCRM version 4.4 |
6a488035
TO		 5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2013 |
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-2013
32 * $Id$
33 *
34 */
35class CRM_Report_Form extends CRM_Core_Form {
36 CONST ROW_COUNT_LIMIT = 50;
37
38 /**
39 * Operator types - used for displaying filter elements
40 */
41 CONST
42 OP_INT = 1,
43 OP_STRING = 2,
44 OP_DATE = 4,
45 OP_DATETIME = 5,
46 OP_FLOAT = 8,
47 OP_SELECT = 64,
48 OP_MULTISELECT = 65,
49 OP_MULTISELECT_SEPARATOR = 66,
50 OP_MONTH = 128;
51
52 /**
53 * The id of the report instance
54 *
55 * @var integer
56 */
57 protected $_id;
58
59 /**
60 * The id of the report template
61 *
62 * @var integer;
63 */
64 protected $_templateID;
65
66 /**
67 * The report title
68 *
69 * @var string
70 */
71 protected $_title;
72 protected $_noFields = FALSE;
73
74 /**
75 * The set of all columns in the report. An associative array
76 * with column name as the key and attribues as the value
77 *
78 * @var array
79 */
80 protected $_columns = array();
81
82 /**
83 * The set of filters in the report
84 *
85 * @var array
86 */
87 protected $_filters = array();
88
89 /**
90 * The set of optional columns in the report
91 *
92 * @var array
93 */
94 protected $_options = array();
95
96 protected $_defaults = array();
97
98 /*
99 * By default most reports hide contact id.
100 * Setting this to true makes it available
101 */
102 protected $_exposeContactID = TRUE;
103
104 /**
105 * Set of statistic fields
106 *
107 * @var array
108 */
109 protected $_statFields = array();
110
111 /**
112 * Set of statistics data
113 *
114 * @var array
115 */
116 protected $_statistics = array();
117
118 /**
119 * List of fields not to be repeated during display
120 *
121 * @var array
122 */
123 protected $_noRepeats = array();
124
125 /**
126 * List of fields not to be displayed
127 *
128 * @var array
129 */
130 protected $_noDisplay = array();
131
132 /**
133 * Object type that a custom group extends
134 *
135 * @var null
136 */
137 protected $_customGroupExtends = NULL;
aa1aa08e 138 protected $_customGroupExtendsJoin = array();
6a488035
TO		 139 protected $_customGroupFilters = TRUE;
140 protected $_customGroupGroupBy = FALSE;
7a8b61ab 141 protected $_customGroupJoin = 'LEFT JOIN';
6a488035
TO		 142
143 /**
144 * build tags filter
145 *
146 */
147 protected $_tagFilter = FALSE;
148
149 /**
150 * build groups filter
151 *
152 */
153 protected $_groupFilter = FALSE;
154
155 /**
156 * Navigation fields
157 *
158 * @var array
159 */
160 public $_navigation = array();
161
162 public $_drilldownReport = array();
163
164 /**
165 * An attribute for checkbox/radio form field layout
166 *
167 * @var array
168 */
169 protected $_fourColumnAttribute = array(
170 '</td><td width="25%">', '</td><td width="25%">',
171 '</td><td width="25%">', '</tr><tr><td>',
172 );
173
174 protected $_force = 1;
175
176 protected $_params = NULL;
177 protected $_formValues = NULL;
178 protected $_instanceValues = NULL;
179
180 protected $_instanceForm = FALSE;
181 protected $_criteriaForm = FALSE;
182
183 protected $_instanceButtonName = NULL;
184 protected $_createNewButtonName = NULL;
185 protected $_printButtonName = NULL;
186 protected $_pdfButtonName = NULL;
187 protected $_csvButtonName = NULL;
188 protected $_groupButtonName = NULL;
189 protected $_chartButtonName = NULL;
190 protected $_csvSupported = TRUE;
191 protected $_add2groupSupported = TRUE;
192 protected $_groups = NULL;
9b0380d9 193 protected $_grandFlag = FALSE;
6a488035
TO		 194 protected $_rowsFound = NULL;
195 protected $_selectAliases = array();
196 protected $_rollup = NULL;
6f900755
E		 197
198 /**
199 * SQL Limit clause
200 * @var string
201 */
6a488035 202 protected $_limit = NULL;
6f900755
E		 203
204 /**
205 * This can be set to specify a limit to the number of rows
206 * Since it is currently envisaged as part of the api usage it is only being applied
207 * when $_output mode is not 'html' or 'group' so as not to have to interpret / mess with that part
208 * of the code (see limit() fn
209 * @var integer
210 */
211 protected $_limitValue = NULL;
212
213 /**
214 * This can be set to specify row offset
215 * See notes on _limitValue
216 * @var integer
217 */
218 protected $_offsetValue = NULL;
6a488035
TO		 219 protected $_sections = NULL;
220 protected $_autoIncludeIndexedFieldsAsOrderBys = 0;
221 protected $_absoluteUrl = FALSE;
222
ae555e90
DS		 223 /**
224 * Flag to indicate if result-set is to be stored in a class variable which could be retrieved using getResultSet() method.
225 *
226 * @var boolean
227 */
228 protected $_storeResultSet = FALSE;
229
230 /**
231 * When _storeResultSet Flag is set use this var to store result set in form of array
232 *
233 * @var boolean
234 */
235 protected $_resultSet = array();
236
6a488035
TO		 237 /**
238 * To what frequency group-by a date column
239 *
240 * @var array
241 */
242 protected $_groupByDateFreq = array(
243 'MONTH' => 'Month',
244 'YEARWEEK' => 'Week',
245 'QUARTER' => 'Quarter',
246 'YEAR' => 'Year',
247 );
248
249 /**
250 * Variables to hold the acl inner join and where clause
251 */
252 protected $_aclFrom = NULL;
253 protected $_aclWhere = NULL;
254
255 /**
256 * Array of DAO tables having columns included in SELECT or ORDER BY clause
257 *
258 * @var array
259 */
260 protected $_selectedTables;
261
c58f66e0
E		 262 /**
263 * outputmode e.g 'print', 'csv', 'pdf'
c58f66e0
E		 264 * @var string
265 */
f63fae91 266 protected $_outputMode;
c58f66e0 267
6a488035
TO		 268 public $_having = NULL;
269 public $_select = NULL;
1f220d30 270 public $_selectClauses = array();
6a488035
TO		 271 public $_columnHeaders = array();
272 public $_orderBy = NULL;
f2947aea
DS		 273 public $_orderByFields = array();
274 public $_orderByArray = array();
6a488035 275 public $_groupBy = NULL;
adfe2750 276 public $_whereClauses = array();
277 public $_havingClauses = array();
1c4d8c3e 278
c58f66e0
E		 279 /**
280 * Is this being called without a form controller (ie. the report is being render outside the normal form
281 * - e.g the api is retrieving the rows
282 * @var boolean
283 */
284 public $noController = FALSE;
285
7a961f19 286 /**
287 * Variable to hold the currency alias
288 */
289 protected $_currencyColumn = NULL;
6a488035
TO		 290
291 /**
292 *
293 */
294 function __construct() {
295 parent::__construct();
296
297 // build tag filter
298 if ($this->_tagFilter) {
299 $this->buildTagFilter();
300 }
301 if ($this->_exposeContactID) {
302 if (array_key_exists('civicrm_contact', $this->_columns)) {
303 $this->_columns['civicrm_contact']['fields']['exposed_id'] = array(
304 'name' => 'id',
305 'title' => 'Contact ID',
306 'no_repeat' => TRUE,
307 );
308 }
309 }
310
311 if ($this->_groupFilter) {
312 $this->buildGroupFilter();
313 }
314
315 // Get all custom groups
cd43c5e3 316 $allGroups = CRM_Core_PseudoConstant::get('CRM_Core_DAO_CustomField', 'custom_group_id');
6a488035 317
4f8ec8be
DS		 318 // Get the custom groupIds for which the user has VIEW permission
319 // If the user has 'access all custom data' permission, we'll leave $permCustomGroupIds empty
320 // and addCustomDataToColumns() will allow access to all custom groups.
321 $permCustomGroupIds = array();
322 if (!CRM_Core_Permission::check('access all custom data')) {
323 $permCustomGroupIds = CRM_ACL_API::group(CRM_Core_Permission::VIEW, NULL, 'civicrm_custom_group', $allGroups, NULL);
324 // do not allow custom data for reports if user doesn't have
325 // permission to access custom data.
326 if (!empty($this->_customGroupExtends) && empty($permCustomGroupIds)) {
327 $this->_customGroupExtends = array();
328 }
6a488035
TO		 329 }
330
331 // merge custom data columns to _columns list, if any
332 $this->addCustomDataToColumns(TRUE, $permCustomGroupIds);
333
334 // add / modify display columns, filters ..etc
335 CRM_Utils_Hook::alterReportVar('columns', $this->_columns, $this);
7a961f19 336
337 //assign currencyColumn variable to tpl
338 $this->assign('currencyColumn', $this->_currencyColumn);
6a488035
TO		 339 }
340
341 function preProcessCommon() {
8f1445ea
DL		 342 $this->_force =
343 CRM_Utils_Request::retrieve(
344 'force',
345 'Boolean',
346 CRM_Core_DAO::$_nullObject
347 );
6a488035
TO		 348
349 $this->_section = CRM_Utils_Request::retrieve('section', 'Integer', CRM_Core_DAO::$_nullObject);
350
351 $this->assign('section', $this->_section);
352 CRM_Core_Region::instance('page-header')->add(array(
353 'markup' => sprintf('<!-- Report class: [%s] -->', htmlentities(get_class($this))),
354 ));
c58f66e0
E		 355 if(!$this->noController) {
356 $this->setID($this->get('instanceId'));
6a488035 357
6a488035 358 if (!$this->_id) {
c58f66e0
E		 359 $this->setID(CRM_Report_Utils_Report::getInstanceID());
360 if (!$this->_id) {
361 $this->setID( CRM_Report_Utils_Report::getInstanceIDForPath());
362 }
6a488035 363 }
6a488035 364
c58f66e0
E		 365 // set qfkey so that pager picks it up and use it in the "Next > Last >>" links.
366 // FIXME: Note setting it in $_GET doesn't work, since pager generates link based on QUERY_STRING
367 $_SERVER['QUERY_STRING'] .= "&qfKey={$this->controller->_key}";
368 }
6a488035
TO		 369
370 if ($this->_id) {
371 $this->assign('instanceId', $this->_id);
372 $params = array('id' => $this->_id);
373 $this->_instanceValues = array();
0b25329b 374 CRM_Core_DAO::commonRetrieve('CRM_Report_DAO_ReportInstance',
6a488035
TO		 375 $params,
376 $this->_instanceValues
377 );
378 if (empty($this->_instanceValues)) {
379 CRM_Core_Error::fatal("Report could not be loaded.");
380 }
7cab1323 381 $this->_title = $this->_instanceValues['title'];
6a488035
TO		 382 if (!empty($this->_instanceValues['permission']) &&
383 (!(CRM_Core_Permission::check($this->_instanceValues['permission']) ||
384 CRM_Core_Permission::check('administer Reports')
385 ))
386 ) {
387 CRM_Utils_System::permissionDenied();
388 CRM_Utils_System::civiExit();
389 }
390
391 $formValues = CRM_Utils_Array::value('form_values', $this->_instanceValues);
392 if ($formValues) {
393 $this->_formValues = unserialize($formValues);
394 }
395 else {
396 $this->_formValues = NULL;
397 }
398
399 // lets always do a force if reset is found in the url.
a7488080 400 if (!empty($_REQUEST['reset'])) {
6a488035
TO		 401 $this->_force = 1;
402 }
403
404 // set the mode
405 $this->assign('mode', 'instance');
406 }
c58f66e0 407 elseif (!$this->noController) {
6a488035
TO		 408 list($optionValueID, $optionValue) = CRM_Report_Utils_Report::getValueIDFromUrl();
409 $instanceCount = CRM_Report_Utils_Report::getInstanceCount($optionValue);
410 if (($instanceCount > 0) && $optionValueID) {
411 $this->assign('instanceUrl',
412 CRM_Utils_System::url('civicrm/report/list',
413 "reset=1&ovid=$optionValueID"
414 )
415 );
416 }
417 if ($optionValueID) {
418 $this->_description = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionValue', $optionValueID, 'description');
419 }
420
421 // set the mode
422 $this->assign('mode', 'template');
423 }
424
425 // lets display the Report Settings section
426 $this->_instanceForm = $this->_force || $this->_id || (!empty($_POST));
427
428 // Do not display Report Settings section if administer Reports permission is absent OR
429 // if report instance is reserved and administer reserved reports absent
430 if (!CRM_Core_Permission::check('administer Reports') ||
431 ($this->_instanceValues['is_reserved'] && !CRM_Core_Permission::check('administer reserved reports'))) {
432 $this->_instanceForm = FALSE;
433 }
434
435 $this->assign('criteriaForm', FALSE);
436 // Display Report Criteria section if user has access Report Criteria OR administer Reports AND report instance is not reserved
437 if (CRM_Core_Permission::check('administer Reports') || CRM_Core_Permission::check('access Report Criteria')) {
438 if (!$this->_instanceValues['is_reserved'] || CRM_Core_Permission::check('administer reserved reports')) {
439 $this->assign('criteriaForm', TRUE);
440 $this->_criteriaForm = TRUE;
441 }
442 }
443
444 $this->_instanceButtonName = $this->getButtonName('submit', 'save');
445 $this->_createNewButtonName = $this->getButtonName('submit', 'next');
446 $this->_printButtonName = $this->getButtonName('submit', 'print');
447 $this->_pdfButtonName = $this->getButtonName('submit', 'pdf');
448 $this->_csvButtonName = $this->getButtonName('submit', 'csv');
449 $this->_groupButtonName = $this->getButtonName('submit', 'group');
450 $this->_chartButtonName = $this->getButtonName('submit', 'chart');
451 }
452
29fc2b79 453 function addBreadCrumb() {
8f1445ea
DL		 454 $breadCrumbs =
455 array(
456 array(
457 'title' => ts('Report Templates'),
458 'url' => CRM_Utils_System::url('civicrm/admin/report/template/list', 'reset=1'),
459 )
460 );
6a488035
TO		 461
462 CRM_Utils_System::appendBreadCrumb($breadCrumbs);
463 }
464
465 function preProcess() {
8f1445ea 466 $this->preProcessCommon();
6a488035 467
6a488035 468 if (!$this->_id) {
29fc2b79 469 $this->addBreadCrumb();
6a488035
TO		 470 }
471
472 foreach ($this->_columns as $tableName => $table) {
473 // set alias
474 if (!isset($table['alias'])) {
475 $this->_columns[$tableName]['alias'] = substr($tableName, 8) . '_civireport';
476 }
477 else {
478 $this->_columns[$tableName]['alias'] = $table['alias'] . '_civireport';
479 }
480
481 $this->_aliases[$tableName] = $this->_columns[$tableName]['alias'];
482
c75e90fa 483 $daoOrBaoName = NULL;
6a488035
TO		 484 // higher preference to bao object
485 if (array_key_exists('bao', $table)) {
c75e90fa
DS		 486 $daoOrBaoName = $table['bao'];
487 $expFields = $daoOrBaoName::exportableFields( );
6a488035 488 }
8edb9849 489 elseif (array_key_exists('dao', $table)){
c75e90fa
DS		 490 $daoOrBaoName = $table['dao'];
491 $expFields = $daoOrBaoName::export( );
6a488035 492 }
8edb9849 493 else{
494 $expFields = array();
495 }
6a488035
TO		 496
497 $doNotCopy = array('required');
498
499 $fieldGroups = array('fields', 'filters', 'group_bys', 'order_bys');
500 foreach ($fieldGroups as $fieldGrp) {
a7488080 501 if (!empty($table[$fieldGrp]) && is_array($table[$fieldGrp])) {
6a488035
TO		 502 foreach ($table[$fieldGrp] as $fieldName => $field) {
503 // $name is the field name used to reference the BAO/DAO export fields array
504 $name = isset($field['name']) ? $field['name'] : $fieldName;
505
506 // Sometimes the field name key in the BAO/DAO export fields array is
507 // different from the actual database field name.
508 // Unset $field['name'] so that actual database field name can be obtained
509 // from the BAO/DAO export fields array.
510 unset($field['name']);
511
512 if (array_key_exists($name, $expFields)) {
513 foreach ($doNotCopy as $dnc) {
514 // unset the values we don't want to be copied.
515 unset($expFields[$name][$dnc]);
516 }
517 if (empty($field)) {
518 $this->_columns[$tableName][$fieldGrp][$fieldName] = $expFields[$name];
519 }
520 else {
521 foreach ($expFields[$name] as $property => $val) {
522 if (!array_key_exists($property, $field)) {
523 $this->_columns[$tableName][$fieldGrp][$fieldName][$property] = $val;
524 }
525 }
526 }
527 }
528
529 // fill other vars
a7488080 530 if (!empty($field['no_repeat'])) {
6a488035
TO		 531 $this->_noRepeats[] = "{$tableName}_{$fieldName}";
532 }
a7488080 533 if (!empty($field['no_display'])) {
6a488035
TO		 534 $this->_noDisplay[] = "{$tableName}_{$fieldName}";
535 }
536
537 // set alias = table-name, unless already set
538 $alias = isset($field['alias']) ? $field['alias'] : (isset($this->_columns[$tableName]['alias']) ?
539 $this->_columns[$tableName]['alias'] : $tableName
540 );
541 $this->_columns[$tableName][$fieldGrp][$fieldName]['alias'] = $alias;
542
543 // set name = fieldName, unless already set
544 if (!isset($this->_columns[$tableName][$fieldGrp][$fieldName]['name'])) {
545 $this->_columns[$tableName][$fieldGrp][$fieldName]['name'] = $name;
546 }
547
548 // set dbAlias = alias.name, unless already set
549 if (!isset($this->_columns[$tableName][$fieldGrp][$fieldName]['dbAlias'])) {
550 $this->_columns[$tableName][$fieldGrp][$fieldName]['dbAlias'] = $alias . '.' . $this->_columns[$tableName][$fieldGrp][$fieldName]['name'];
551 }
552
c75e90fa 553 // a few auto fills for filters
c93f6d83 554 if ($fieldGrp == 'filters') {
c75e90fa
DS		 555 // fill operator types
556 if (!array_key_exists('operatorType', $this->_columns[$tableName][$fieldGrp][$fieldName])) {
557 switch (CRM_Utils_Array::value('type', $this->_columns[$tableName][$fieldGrp][$fieldName])) {
558 case CRM_Utils_Type::T_MONEY:
559 case CRM_Utils_Type::T_FLOAT:
560 $this->_columns[$tableName][$fieldGrp][$fieldName]['operatorType'] = CRM_Report_Form::OP_FLOAT;
561 break;
562 case CRM_Utils_Type::T_INT:
563 $this->_columns[$tableName][$fieldGrp][$fieldName]['operatorType'] = CRM_Report_Form::OP_INT;
564 break;
565 case CRM_Utils_Type::T_DATE:
c93f6d83 566 $this->_columns[$tableName][$fieldGrp][$fieldName]['operatorType'] = CRM_Report_Form::OP_DATE;
c75e90fa
DS		 567 break;
568 case CRM_Utils_Type::T_BOOLEAN:
569 $this->_columns[$tableName][$fieldGrp][$fieldName]['operatorType'] = CRM_Report_Form::OP_SELECT;
570 if (!array_key_exists('options', $this->_columns[$tableName][$fieldGrp][$fieldName])) {
c93f6d83 571 $this->_columns[$tableName][$fieldGrp][$fieldName]['options'] =
c75e90fa
DS		 572 array('' => ts('Any'), '0' => ts('No'), '1' => ts('Yes'));
573 }
574 break;
575 default:
c93f6d83 576 if ($daoOrBaoName &&
4b5ff63c 577 array_key_exists('pseudoconstant', $this->_columns[$tableName][$fieldGrp][$fieldName])) {
c75e90fa
DS		 578 // with multiple options operator-type is generally multi-select
579 $this->_columns[$tableName][$fieldGrp][$fieldName]['operatorType'] = CRM_Report_Form::OP_MULTISELECT;
580 if (!array_key_exists('options', $this->_columns[$tableName][$fieldGrp][$fieldName])) {
581 // fill options
582 $this->_columns[$tableName][$fieldGrp][$fieldName]['options'] = CRM_Core_PseudoConstant::get($daoOrBaoName, $fieldName);
583 }
584 }
585 break;
586 }
6a488035
TO		 587 }
588 }
589 }
590 }
591 }
592
593 // copy filters to a separate handy variable
594 if (array_key_exists('filters', $table)) {
595 $this->_filters[$tableName] = $this->_columns[$tableName]['filters'];
596 }
597
598 if (array_key_exists('group_bys', $table)) {
599 $groupBys[$tableName] = $this->_columns[$tableName]['group_bys'];
600 }
601
602 if (array_key_exists('fields', $table)) {
603 $reportFields[$tableName] = $this->_columns[$tableName]['fields'];
604 }
605 }
606
607 if ($this->_force) {
608 $this->setDefaultValues(FALSE);
609 }
610
8f1445ea
DL		 611 CRM_Report_Utils_Get::processFilter($this->_filters, $this->_defaults);
612 CRM_Report_Utils_Get::processGroupBy($groupBys, $this->_defaults);
613 CRM_Report_Utils_Get::processFields($reportFields, $this->_defaults);
6a488035
TO		 614 CRM_Report_Utils_Get::processChart($this->_defaults);
615
616 if ($this->_force) {
617 $this->_formValues = $this->_defaults;
618 $this->postProcess();
619 }
620 }
621
622 function setDefaultValues($freeze = TRUE) {
623 $freezeGroup = array();
624
625 // FIXME: generalizing form field naming conventions would reduce
626 // lots of lines below.
627 foreach ($this->_columns as $tableName => $table) {
628 if (array_key_exists('fields', $table)) {
629 foreach ($table['fields'] as $fieldName => $field) {
a7488080 630 if (empty($field['no_display'])) {
6a488035
TO		 631 if (isset($field['required'])) {
632 // set default
633 $this->_defaults['fields'][$fieldName] = 1;
634
635 if ($freeze) {
636 // find element object, so that we could use quickform's freeze method
637 // for required elements
8f1445ea 638 $obj = $this->getElementFromGroup("fields", $fieldName);
6a488035
TO		 639 if ($obj) {
640 $freezeGroup[] = $obj;
641 }
642 }
643 }
644 elseif (isset($field['default'])) {
645 $this->_defaults['fields'][$fieldName] = $field['default'];
646 }
647 }
648 }
649 }
650
651 if (array_key_exists('group_bys', $table)) {
652 foreach ($table['group_bys'] as $fieldName => $field) {
653 if (isset($field['default'])) {
a7488080 654 if (!empty($field['frequency'])) {
6a488035
TO		 655 $this->_defaults['group_bys_freq'][$fieldName] = 'MONTH';
656 }
657 $this->_defaults['group_bys'][$fieldName] = $field['default'];
658 }
659 }
660 }
661 if (array_key_exists('filters', $table)) {
662 foreach ($table['filters'] as $fieldName => $field) {
663 if (isset($field['default'])) {
664 if (CRM_Utils_Array::value('type', $field) & CRM_Utils_Type::T_DATE) {
b0e34e7c 665 if(is_array($field['default'])){
666 $this->_defaults["{$fieldName}_from"] = CRM_Utils_Array::value('from', $field['default']);
667 $this->_defaults["{$fieldName}_to"] = CRM_Utils_Array::value('to', $field['default']);
668 $this->_defaults["{$fieldName}_relative"] = 0;
669 }
670 else{
671 $this->_defaults["{$fieldName}_relative"] = $field['default'];
672 }
6a488035
TO		 673 }
674 else {
675 $this->_defaults["{$fieldName}_value"] = $field['default'];
676 }
677 }
678 //assign default value as "in" for multiselect
679 //operator, To freeze the select element
160d32e1 680 if (CRM_Utils_Array::value('operatorType', $field) == CRM_Report_Form::OP_MULTISELECT) {
6a488035
TO		 681 $this->_defaults["{$fieldName}_op"] = 'in';
682 }
160d32e1 683 elseif (CRM_Utils_Array::value('operatorType', $field) == CRM_Report_Form::OP_MULTISELECT_SEPARATOR) {
6a488035
TO		 684 $this->_defaults["{$fieldName}_op"] = 'mhas';
685 }
686 elseif ($op = CRM_Utils_Array::value('default_op', $field)) {
687 $this->_defaults["{$fieldName}_op"] = $op;
688 }
689 }
690 }
691
8f1445ea
DL		 692 if (
693 array_key_exists('order_bys', $table) &&
6a488035
TO		 694 is_array($table['order_bys'])
695 ) {
6a488035 696 if (!array_key_exists('order_bys', $this->_defaults)) {
6a488035
TO		 697 $this->_defaults['order_bys'] = array();
698 }
699 foreach ($table['order_bys'] as $fieldName => $field) {
8cc574cf
CW		 700 if (!empty($field['default']) || !empty($field['default_order']) ||
701 CRM_Utils_Array::value('default_is_section', $field) || !empty($field['default_weight'])) {
6a488035
TO		 702 $order_by = array(
703 'column' => $fieldName,
704 'order' => CRM_Utils_Array::value('default_order', $field, 'ASC'),
705 'section' => CRM_Utils_Array::value('default_is_section', $field, 0),
706 );
707
a7488080 708 if (!empty($field['default_weight'])) {
6a488035
TO		 709 $this->_defaults['order_bys'][(int) $field['default_weight']] = $order_by;
710 }
711 else {
712 array_unshift($this->_defaults['order_bys'], $order_by);
713 }
714 }
715 }
716 }
717
718 foreach ($this->_options as $fieldName => $field) {
719 if (isset($field['default'])) {
720 $this->_defaults['options'][$fieldName] = $field['default'];
721 }
722 }
723 }
724
725 if (!empty($this->_submitValues)) {
726 $this->preProcessOrderBy($this->_submitValues);
727 }
728 else {
729 $this->preProcessOrderBy($this->_defaults);
730 }
731
732 // lets finish freezing task here itself
733 if (!empty($freezeGroup)) {
734 foreach ($freezeGroup as $elem) {
735 $elem->freeze();
736 }
737 }
738
739 if ($this->_formValues) {
740 $this->_defaults = array_merge($this->_defaults, $this->_formValues);
741 }
742
743 if ($this->_instanceValues) {
744 $this->_defaults = array_merge($this->_defaults, $this->_instanceValues);
745 }
746
747 CRM_Report_Form_Instance::setDefaultValues($this, $this->_defaults);
748
749 return $this->_defaults;
750 }
751
752 function getElementFromGroup($group, $grpFieldName) {
753 $eleObj = $this->getElement($group);
754 foreach ($eleObj->_elements as $index => $obj) {
755 if ($grpFieldName == $obj->_attributes['name']) {
756 return $obj;
757 }
758 }
759 return FALSE;
760 }
761
c58f66e0
E		 762 /**
763 * Setter for $_params
764 * @param array $params
765 */
766 function setParams($params) {
767 $this->_params = $params;
768 }
769
770 /**
771 * Setter for $_id
772 * @param integer $id
773 */
774 function setID($instanceid) {
775 $this->_id = $instanceid;
776 }
777
778 /**
779 * Setter for $_force
780 * @param boolean $force
781 */
782 function setForce($isForce) {
783 $this->_force = $isForce;
784 }
6f900755
E		 785
786 /**
787 * Setter for $_limitValue
788 * @param number $_limitValue
789 */
790 function setLimitValue($_limitValue) {
791 $this->_limitValue = $_limitValue;
792 }
793
794 /**
795 * Setter for $_offsetValue
796 * @param number $_offsetValue
797 */
798 function setOffsetValue($_offsetValue) {
799 $this->_offsetValue = $_offsetValue;
800 }
801
c58f66e0
E		 802 /**
803 * Getter for $_defaultValues
804 * @return array $_defaultValues
805 */
806 function getDefaultValues() {
807 return $this->_defaults;
808 }
809
6a488035
TO		 810 function addColumns() {
811 $options = array();
812 $colGroups = NULL;
813 foreach ($this->_columns as $tableName => $table) {
814 if (array_key_exists('fields', $table)) {
815 foreach ($table['fields'] as $fieldName => $field) {
8bdc861c 816 $groupTitle = '';
a7488080 817 if (empty($field['no_display'])) {
8bdc861c
DS		 818 foreach ( array('table', 'field') as $var) {
819 if (!empty(${$var}['grouping'])) {
820 if (!is_array(${$var}['grouping'])) {
821 $tableName = ${$var}['grouping'];
822 } else {
b80138e0
DS		 823 $tableName = array_keys(${$var}['grouping']);
824 $tableName = $tableName[0];
825 $groupTitle = array_values(${$var}['grouping']);
826 $groupTitle = $groupTitle[0];
8bdc861c
DS		 827 }
828 }
6a488035 829 }
8bdc861c
DS		 830
831 if (!$groupTitle && isset($table['group_title'])) {
832 $groupTitle = $table['group_title'];
6a488035 833 }
6a488035 834
8bdc861c 835 $colGroups[$tableName]['fields'][$fieldName] = CRM_Utils_Array::value('title', $field);
8cc574cf 836 if ($groupTitle && empty($colGroups[$tableName]['group_title'])) {
8bdc861c 837 $colGroups[$tableName]['group_title'] = $groupTitle;
6a488035
TO		 838 }
839
840 $options[$fieldName] = CRM_Utils_Array::value('title', $field);
841 }
842 }
843 }
844 }
845
846 $this->addCheckBox("fields", ts('Select Columns'), $options, NULL,
847 NULL, NULL, NULL, $this->_fourColumnAttribute, TRUE
848 );
849 $this->assign('colGroups', $colGroups);
850 }
851
852 function addFilters() {
853 $options = $filters = array();
854 $count = 1;
855 foreach ($this->_filters as $table => $attributes) {
856 foreach ($attributes as $fieldName => $field) {
857 // get ready with option value pair
1b36206c 858 // @ todo being able to specific options for a field (e.g a date field) in the field spec as an array rather than an override
859 // would be useful
860 $operations = $this->getOperationPair(
8f1445ea 861 CRM_Utils_Array::value('operatorType', $field),
1b36206c 862 $fieldName);
6a488035
TO		 863
864 $filters[$table][$fieldName] = $field;
865
866 switch (CRM_Utils_Array::value('operatorType', $field)) {
867 case CRM_Report_Form::OP_MONTH:
868 if (!array_key_exists('options', $field) || !is_array($field['options']) || empty($field['options'])) {
869 // If there's no option list for this filter, define one.
870 $field['options'] = array(
871 1 => ts('January'),
872 2 => ts('February'),
873 3 => ts('March'),
874 4 => ts('April'),
875 5 => ts('May'),
876 6 => ts('June'),
877 7 => ts('July'),
878 8 => ts('August'),
879 9 => ts('September'),
880 10 => ts('October'),
881 11 => ts('November'),
882 12 => ts('December'),
883 );
884 // Add this option list to this column _columns. This is
885 // required so that filter statistics show properly.
886 $this->_columns[$table]['filters'][$fieldName]['options'] = $field['options'];
887 }
160d32e1
E		 888 case CRM_Report_Form::OP_MULTISELECT:
889 case CRM_Report_Form::OP_MULTISELECT_SEPARATOR:
6a488035
TO		 890 // assume a multi-select field
891 if (!empty($field['options'])) {
892 $element = $this->addElement('select', "{$fieldName}_op", ts('Operator:'), $operations);
893 if (count($operations) <= 1) {
894 $element->freeze();
895 }
896 $select = $this->addElement('select', "{$fieldName}_value", NULL,
897 $field['options'], array(
898 'size' => 4,
899 'style' => 'min-width:250px',
900 )
901 );
902 $select->setMultiple(TRUE);
903 }
904 break;
905
160d32e1 906 case CRM_Report_Form::OP_SELECT:
6a488035
TO		 907 // assume a select field
908 $this->addElement('select', "{$fieldName}_op", ts('Operator:'), $operations);
5a9a44d9
DS		 909 if (!empty($field['options']))
910 $this->addElement('select', "{$fieldName}_value", NULL, $field['options']);
6a488035
TO		 911 break;
912
160d32e1 913 case CRM_Report_Form::OP_DATE:
6a488035 914 // build datetime fields
bc3f7f04 915 CRM_Core_Form_Date::buildDateRange($this, $fieldName, $count, '_from','_to', 'From:', FALSE, $operations);
6a488035
TO		 916 $count++;
917 break;
918
160d32e1 919 case CRM_Report_Form::OP_DATETIME:
6a488035 920 // build datetime fields
bc3f7f04 921 CRM_Core_Form_Date::buildDateRange($this, $fieldName, $count, '_from', '_to', 'From:', FALSE, $operations, 'searchDate', true);
6a488035
TO		 922 $count++;
923 break;
924
160d32e1
E		 925 case CRM_Report_Form::OP_INT:
926 case CRM_Report_Form::OP_FLOAT:
6a488035
TO		 927 // and a min value input box
928 $this->add('text', "{$fieldName}_min", ts('Min'));
929 // and a max value input box
930 $this->add('text', "{$fieldName}_max", ts('Max'));
931 default:
932 // default type is string
933 $this->addElement('select', "{$fieldName}_op", ts('Operator:'), $operations,
934 array('onchange' => "return showHideMaxMinVal( '$fieldName', this.value );")
935 );
936 // we need text box for value input
937 $this->add('text', "{$fieldName}_value", NULL);
938 break;
939 }
940 }
941 }
942 $this->assign('filters', $filters);
943 }
944
945 function addOptions() {
946 if (!empty($this->_options)) {
947 // FIXME: For now lets build all elements as checkboxes.
948 // Once we clear with the format we can build elements based on type
949
950 $options = array();
951 foreach ($this->_options as $fieldName => $field) {
952 if ($field['type'] == 'select') {
953 $this->addElement('select', "{$fieldName}", $field['title'], $field['options']);
954 }
52634dad 955 else if ($field['type'] == 'checkbox') {
6a488035 956 $options[$field['title']] = $fieldName;
52634dad
DS		 957 $this->addCheckBox($fieldName, NULL,
958 $options, NULL,
959 NULL, NULL, NULL, $this->_fourColumnAttribute
960 );
6a488035
TO		 961 }
962 }
6a488035 963 }
52634dad 964 $this->assign('otherOptions', $this->_options);
6a488035
TO		 965 }
966
967 function addChartOptions() {
968 if (!empty($this->_charts)) {
969 $this->addElement('select', "charts", ts('Chart'), $this->_charts, array('onchange' => 'disablePrintPDFButtons(this.value);'));
970 $this->assign('charts', $this->_charts);
971 $this->addElement('submit', $this->_chartButtonName, ts('View'));
972 }
973 }
974
975 function addGroupBys() {
976 $options = $freqElements = array();
977
978 foreach ($this->_columns as $tableName => $table) {
979 if (array_key_exists('group_bys', $table)) {
980 foreach ($table['group_bys'] as $fieldName => $field) {
981 if (!empty($field)) {
982 $options[$field['title']] = $fieldName;
a7488080 983 if (!empty($field['frequency'])) {
6a488035
TO		 984 $freqElements[$field['title']] = $fieldName;
985 }
986 }
987 }
988 }
989 }
990 $this->addCheckBox("group_bys", ts('Group by columns'), $options, NULL,
991 NULL, NULL, NULL, $this->_fourColumnAttribute
992 );
993 $this->assign('groupByElements', $options);
994
995 foreach ($freqElements as $name) {
996 $this->addElement('select', "group_bys_freq[$name]",
997 ts('Frequency'), $this->_groupByDateFreq
998 );
999 }
1000 }
1001
1002 function addOrderBys() {
1003 $options = array();
1004 foreach ($this->_columns as $tableName => $table) {
1005
1006 // Report developer may define any column to order by; include these as order-by options
1007 if (array_key_exists('order_bys', $table)) {
1008 foreach ($table['order_bys'] as $fieldName => $field) {
1009 if (!empty($field)) {
1010 $options[$fieldName] = $field['title'];
1011 }
1012 }
1013 }
1014
1015 /* Add searchable custom fields as order-by options, if so requested
1016 * (These are already indexed, so allowing to order on them is cheap.)
1017 */
1018
1019
1020 if ($this->_autoIncludeIndexedFieldsAsOrderBys && array_key_exists('extends', $table) && !empty($table['extends'])) {
1021 foreach ($table['fields'] as $fieldName => $field) {
a7488080 1022 if (empty($field['no_display'])) {
6a488035
TO		 1023 $options[$fieldName] = $field['title'];
1024 }
1025 }
1026 }
1027 }
1028
1029 asort($options);
1030
1031 $this->assign('orderByOptions', $options);
1032
1033 if (!empty($options)) {
1034 $options = array(
1035 '-' => ' - none - ') + $options;
1036 for ($i = 1; $i <= 5; $i++) {
1037 $this->addElement('select', "order_bys[{$i}][column]", ts('Order by Column'), $options);
1038 $this->addElement('select', "order_bys[{$i}][order]", ts('Order by Order'), array('ASC' => 'Ascending', 'DESC' => 'Descending'));
1039 $this->addElement('checkbox', "order_bys[{$i}][section]", ts('Order by Section'), FALSE, array('id' => "order_by_section_$i"));
5895cba0 1040 $this->addElement('checkbox', "order_bys[{$i}][pageBreak]", ts('Page Break'), FALSE, array('id' => "order_by_pagebreak_$i"));
6a488035
TO		 1041 }
1042 }
1043 }
1044
1045 function buildInstanceAndButtons() {
1046 CRM_Report_Form_Instance::buildForm($this);
1047
1048 $label = $this->_id ? ts('Update Report') : ts('Create Report');
1049
1050 $this->addElement('submit', $this->_instanceButtonName, $label);
1051 $this->addElement('submit', $this->_printButtonName, ts('Print Report'));
1052 $this->addElement('submit', $this->_pdfButtonName, ts('PDF'));
1053
1054 if ($this->_id) {
1055 $this->addElement('submit', $this->_createNewButtonName, ts('Save a Copy') . '...');
1056 }
1057 if ($this->_instanceForm) {
1058 $this->assign('instanceForm', TRUE);
1059 }
1060
1061 $label = $this->_id ? ts('Print Report') : ts('Print Preview');
1062 $this->addElement('submit', $this->_printButtonName, $label);
1063
1064 $label = $this->_id ? ts('PDF') : ts('Preview PDF');
1065 $this->addElement('submit', $this->_pdfButtonName, $label);
1066
1067 $label = $this->_id ? ts('Export to CSV') : ts('Preview CSV');
1068
1069 if ($this->_csvSupported) {
1070 $this->addElement('submit', $this->_csvButtonName, $label);
1071 }
1072
1073 if (CRM_Core_Permission::check('administer Reports') && $this->_add2groupSupported) {
1074 $this->addElement('select', 'groups', ts('Group'),
1075 array('' => ts('- select group -')) + CRM_Core_PseudoConstant::staticGroup()
1076 );
1077 $this->assign('group', TRUE);
1078 }
1079
58175fe6 1080 $label = ts('Add These Contacts to Group');
6a488035
TO		 1081 $this->addElement('submit', $this->_groupButtonName, $label, array('onclick' => 'return checkGroup();'));
1082
1083 $this->addChartOptions();
1084 $this->addButtons(array(
1085 array(
1086 'type' => 'submit',
1087 'name' => ts('Preview Report'),
1088 'isDefault' => TRUE,
1089 ),
1090 )
1091 );
1092 }
1093
1094 function buildQuickForm() {
1095 $this->addColumns();
1096
1097 $this->addFilters();
1098
1099 $this->addOptions();
1100
1101 $this->addGroupBys();
1102
1103 $this->addOrderBys();
1104
1105 $this->buildInstanceAndButtons();
1106
1107 //add form rule for report
1108 if (is_callable(array(
1109 $this, 'formRule'))) {
1110 $this->addFormRule(array(get_class($this), 'formRule'), $this);
1111 }
1112 }
1113
1114 // a formrule function to ensure that fields selected in group_by
1115 // (if any) should only be the ones present in display/select fields criteria;
1116 // note: works if and only if any custom field selected in group_by.
1117 function customDataFormRule($fields, $ignoreFields = array( )) {
1118 $errors = array();
1119 if (!empty($this->_customGroupExtends) && $this->_customGroupGroupBy && !empty($fields['group_bys'])) {
1120 foreach ($this->_columns as $tableName => $table) {
1121 if ((substr($tableName, 0, 13) == 'civicrm_value' || substr($tableName, 0, 12) == 'custom_value') && !empty($this->_columns[$tableName]['fields'])) {
1122 foreach ($this->_columns[$tableName]['fields'] as $fieldName => $field) {
1123 if (array_key_exists($fieldName, $fields['group_bys']) &&
1124 !array_key_exists($fieldName, $fields['fields'])
1125 ) {
1126 $errors['fields'] = "Please make sure fields selected in 'Group by Columns' section are also selected in 'Display Columns' section.";
1127 }
1128 elseif (array_key_exists($fieldName, $fields['group_bys'])) {
1129 foreach ($fields['fields'] as $fld => $val) {
1130 if (!array_key_exists($fld, $fields['group_bys']) && !in_array($fld, $ignoreFields)) {
1131 $errors['fields'] = "Please ensure that fields selected in 'Display Columns' are also selected in 'Group by Columns' section.";
1132 }
1133 }
1134 }
1135 }
1136 }
1137 }
1138 }
1139 return $errors;
1140 }
1141
1142 // Note: $fieldName param allows inheriting class to build operationPairs
1143 // specific to a field.
1b36206c 1144 function getOperationPair($type = "string", $fieldName = NULL) {
6a488035
TO		 1145 // FIXME: At some point we should move these key-val pairs
1146 // to option_group and option_value table.
6a488035 1147 switch ($type) {
160d32e1
E		 1148 case CRM_Report_Form::OP_INT:
1149 case CRM_Report_Form::OP_FLOAT:
bc3f7f04 1150 return array(
1151 'lte' => ts('Is less than or equal to'),
6a488035
TO		 1152 'gte' => ts('Is greater than or equal to'),
1153 'bw' => ts('Is between'),
1154 'eq' => ts('Is equal to'),
1155 'lt' => ts('Is less than'),
1156 'gt' => ts('Is greater than'),
1157 'neq' => ts('Is not equal to'),
1158 'nbw' => ts('Is not between'),
1159 'nll' => ts('Is empty (Null)'),
1160 'nnll' => ts('Is not empty (Null)'),
1161 );
1162 break;
1163
160d32e1 1164 case CRM_Report_Form::OP_SELECT:
bc3f7f04 1165 return array(
1166 'eq' => ts('Is equal to'),
1167 );
6a488035 1168
160d32e1
E		 1169 case CRM_Report_Form::OP_MONTH:
1170 case CRM_Report_Form::OP_MULTISELECT:
bc3f7f04 1171 return array(
1172 'in' => ts('Is one of'),
6a488035
TO		 1173 'notin' => ts('Is not one of'),
1174 );
1175 break;
1176
160d32e1 1177 case CRM_Report_Form::OP_DATE:
bc3f7f04 1178 return array(
1179 'nll' => ts('Is empty (Null)'),
6a488035
TO		 1180 'nnll' => ts('Is not empty (Null)'),
1181 );
1182 break;
1183
160d32e1 1184 case CRM_Report_Form::OP_MULTISELECT_SEPARATOR:
6a488035
TO		 1185 // use this operator for the values, concatenated with separator. For e.g if
1186 // multiple options for a column is stored as ^A{val1}^A{val2}^A
bc3f7f04 1187 return array(
1188 'mhas' => ts('Is one of'),
1189 );
6a488035
TO		 1190
1191 default:
1192 // type is string
bc3f7f04 1193 return array(
1194 'has' => ts('Contains'),
6a488035
TO		 1195 'sw' => ts('Starts with'),
1196 'ew' => ts('Ends with'),
1197 'nhas' => ts('Does not contain'),
1198 'eq' => ts('Is equal to'),
1199 'neq' => ts('Is not equal to'),
1200 'nll' => ts('Is empty (Null)'),
1201 'nnll' => ts('Is not empty (Null)'),
1202 );
1203 }
1204 }
1205
1206 function buildTagFilter() {
1207 $contactTags = CRM_Core_BAO_Tag::getTags();
1208 if (!empty($contactTags)) {
1209 $this->_columns['civicrm_tag'] = array(
1210 'dao' => 'CRM_Core_DAO_Tag',
1211 'filters' =>
1212 array(
1213 'tagid' =>
1214 array(
1215 'name' => 'tag_id',
1216 'title' => ts('Tag'),
1217 'tag' => TRUE,
1218 'operatorType' => CRM_Report_Form::OP_MULTISELECT,
1219 'options' => $contactTags,
1220 ),
1221 ),
1222 );
1223 }
1224 }
1225
1226 /*
1227 * Adds group filters to _columns (called from _Constuct
1228 */
1229 function buildGroupFilter() {
1230 $this->_columns['civicrm_group']['filters'] = array(
1231 'gid' =>
1232 array(
1233 'name' => 'group_id',
1234 'title' => ts('Group'),
1235 'operatorType' => CRM_Report_Form::OP_MULTISELECT,
1236 'group' => TRUE,
1237 'options' => CRM_Core_PseudoConstant::group(),
1238 ),
1239 );
1240 if (empty($this->_columns['civicrm_group']['dao'])) {
1241 $this->_columns['civicrm_group']['dao'] = 'CRM_Contact_DAO_GroupContact';
1242 }
1243 if (empty($this->_columns['civicrm_group']['alias'])) {
1244 $this->_columns['civicrm_group']['alias'] = 'cgroup';
1245 }
1246 }
1247
29fc2b79 1248 function getSQLOperator($operator = "like") {
6a488035
TO		 1249 switch ($operator) {
1250 case 'eq':
1251 return '=';
1252
1253 case 'lt':
1254 return '<';
1255
1256 case 'lte':
1257 return '<=';
1258
1259 case 'gt':
1260 return '>';
1261
1262 case 'gte':
1263 return '>=';
1264
1265 case 'ne':
1266 case 'neq':
1267 return '!=';
1268
1269 case 'nhas':
1270 return 'NOT LIKE';
1271
1272 case 'in':
1273 return 'IN';
1274
1275 case 'notin':
1276 return 'NOT IN';
1277
1278 case 'nll':
1279 return 'IS NULL';
1280
1281 case 'nnll':
1282 return 'IS NOT NULL';
1283
1284 default:
1285 // type is string
1286 return 'LIKE';
1287 }
1288 }
1289
1290 function whereClause(&$field, $op,
1291 $value, $min, $max
1292 ) {
1293
1294 $type = CRM_Utils_Type::typeToString(CRM_Utils_Array::value('type', $field));
1295 $clause = NULL;
1296
1297 switch ($op) {
1298 case 'bw':
1299 case 'nbw':
1300 if (($min !== NULL && strlen($min) > 0) ||
1301 ($max !== NULL && strlen($max) > 0)
1302 ) {
1303 $min = CRM_Utils_Type::escape($min, $type);
1304 $max = CRM_Utils_Type::escape($max, $type);
1305 $clauses = array();
1306 if ($min) {
1307 if ($op == 'bw') {
1308 $clauses[] = "( {$field['dbAlias']} >= $min )";
1309 }
1310 else {
1311 $clauses[] = "( {$field['dbAlias']} < $min )";
1312 }
1313 }
1314 if ($max) {
1315 if ($op == 'bw') {
1316 $clauses[] = "( {$field['dbAlias']} <= $max )";
1317 }
1318 else {
1319 $clauses[] = "( {$field['dbAlias']} > $max )";
1320 }
1321 }
1322
1323 if (!empty($clauses)) {
1324 if ($op == 'bw') {
1325 $clause = implode(' AND ', $clauses);
1326 }
1327 else {
1328 $clause = implode(' OR ', $clauses);
1329 }
1330 }
1331 }
1332 break;
1333
1334 case 'has':
1335 case 'nhas':
1336 if ($value !== NULL && strlen($value) > 0) {
1337 $value = CRM_Utils_Type::escape($value, $type);
1338 if (strpos($value, '%') === FALSE) {
1339 $value = "'%{$value}%'";
1340 }
1341 else {
1342 $value = "'{$value}'";
1343 }
29fc2b79 1344 $sqlOP = $this->getSQLOperator($op);
6a488035
TO		 1345 $clause = "( {$field['dbAlias']} $sqlOP $value )";
1346 }
1347 break;
1348
1349 case 'in':
1350 case 'notin':
1351 if ($value !== NULL && is_array($value) && count($value) > 0) {
29fc2b79 1352 $sqlOP = $this->getSQLOperator($op);
6a488035
TO		 1353 if (CRM_Utils_Array::value('type', $field) == CRM_Utils_Type::T_STRING) {
1354 //cycle through selections and esacape values
1355 foreach ($value as $key => $selection) {
1356 $value[$key] = CRM_Utils_Type::escape($selection, $type);
1357 }
1358 $clause = "( {$field['dbAlias']} $sqlOP ( '" . implode("' , '", $value) . "') )";
1359 }
1360 else {
1361 // for numerical values
1362 $clause = "{$field['dbAlias']} $sqlOP (" . implode(', ', $value) . ")";
1363 }
1364 if ($op == 'notin') {
1365 $clause = "( " . $clause . " OR {$field['dbAlias']} IS NULL )";
1366 }
1367 else {
1368 $clause = "( " . $clause . " )";
1369 }
1370 }
1371 break;
1372
1373 case 'mhas':
1374 // mhas == multiple has
1375 if ($value !== NULL && count($value) > 0) {
29fc2b79 1376 $sqlOP = $this->getSQLOperator($op);
6a488035
TO		 1377 $clause = "{$field['dbAlias']} REGEXP '[[:<:]]" . implode('|', $value) . "[[:>:]]'";
1378 }
1379 break;
1380
1381 case 'sw':
1382 case 'ew':
1383 if ($value !== NULL && strlen($value) > 0) {
1384 $value = CRM_Utils_Type::escape($value, $type);
1385 if (strpos($value, '%') === FALSE) {
1386 if ($op == 'sw') {
1387 $value = "'{$value}%'";
1388 }
1389 else {
1390 $value = "'%{$value}'";
1391 }
1392 }
1393 else {
1394 $value = "'{$value}'";
1395 }
29fc2b79 1396 $sqlOP = $this->getSQLOperator($op);
6a488035
TO		 1397 $clause = "( {$field['dbAlias']} $sqlOP $value )";
1398 }
1399 break;
1400
1401 case 'nll':
1402 case 'nnll':
29fc2b79 1403 $sqlOP = $this->getSQLOperator($op);
6a488035
TO		 1404 $clause = "( {$field['dbAlias']} $sqlOP )";
1405 break;
1406
1407 default:
1408 if ($value !== NULL && strlen($value) > 0) {
1409 if (isset($field['clause'])) {
1410 // FIXME: we not doing escape here. Better solution is to use two
1411 // different types - data-type and filter-type
0e6e8724 1412 $clause = $field['clause'];
6a488035
TO		 1413 }
1414 else {
1415 $value = CRM_Utils_Type::escape($value, $type);
29fc2b79 1416 $sqlOP = $this->getSQLOperator($op);
6a488035
TO		 1417 if ($field['type'] == CRM_Utils_Type::T_STRING) {
1418 $value = "'{$value}'";
1419 }
1420 $clause = "( {$field['dbAlias']} $sqlOP $value )";
1421 }
1422 }
1423 break;
1424 }
1425
a7488080 1426 if (!empty($field['group']) && $clause) {
6a488035
TO		 1427 $clause = $this->whereGroupClause($field, $value, $op);
1428 }
a7488080 1429 elseif (!empty($field['tag']) && $clause) {
6a488035
TO		 1430 // not using left join in query because if any contact
1431 // belongs to more than one tag, results duplicate
1432 // entries.
1433 $clause = $this->whereTagClause($field, $value, $op);
1434 }
1435
1436 return $clause;
1437 }
1438
1439 function dateClause($fieldName,
1440 $relative, $from, $to, $type = NULL, $fromTime = NULL, $toTime = NULL
1441 ) {
1442 $clauses = array();
160d32e1 1443 if (in_array($relative, array_keys($this->getOperationPair(CRM_Report_Form::OP_DATE)))) {
29fc2b79 1444 $sqlOP = $this->getSQLOperator($relative);
6a488035
TO		 1445 return "( {$fieldName} {$sqlOP} )";
1446 }
1447
29fc2b79 1448 list($from, $to) = $this->getFromTo($relative, $from, $to, $fromTime, $toTime);
6a488035
TO		 1449
1450 if ($from) {
1451 $from = ($type == CRM_Utils_Type::T_DATE) ? substr($from, 0, 8) : $from;
1452 $clauses[] = "( {$fieldName} >= $from )";
1453 }
1454
1455 if ($to) {
1456 $to = ($type == CRM_Utils_Type::T_DATE) ? substr($to, 0, 8) : $to;
1457 $clauses[] = "( {$fieldName} <= {$to} )";
1458 }
1459
1460 if (!empty($clauses)) {
1461 return implode(' AND ', $clauses);
1462 }
1463
1464 return NULL;
1465 }
29fc2b79 1466 /**
1467 * @todo - could not find any instances where this is called
1468 * @param unknown_type $relative
1469 * @param String $from
1470 * @param String_type $to
1471 * @return string|NULL
1472 */
1473 function dateDisplay($relative, $from, $to) {
1474 list($from, $to) = $this->getFromTo($relative, $from, $to);
6a488035
TO		 1475
1476 if ($from) {
1477 $clauses[] = CRM_Utils_Date::customFormat($from, NULL, array('m', 'M'));
1478 }
1479 else {
1480 $clauses[] = 'Past';
1481 }
1482
1483 if ($to) {
1484 $clauses[] = CRM_Utils_Date::customFormat($to, NULL, array('m', 'M'));
1485 }
1486 else {
1487 $clauses[] = 'Today';
1488 }
1489
1490 if (!empty($clauses)) {
1491 return implode(' - ', $clauses);
1492 }
1493
1494 return NULL;
1495 }
1496
29fc2b79 1497 function getFromTo($relative, $from, $to, $fromtime = NULL, $totime = NULL) {
6a488035
TO		 1498 if (empty($totime)) {
1499 $totime = '235959';
1500 }
1501 //FIX ME not working for relative
1502 if ($relative) {
1503 list($term, $unit) = CRM_Utils_System::explode('.', $relative, 2);
1504 $dateRange = CRM_Utils_Date::relativeToAbsolute($term, $unit);
1505 $from = substr($dateRange['from'], 0, 8);
1506 //Take only Date Part, Sometime Time part is also present in 'to'
1507 $to = substr($dateRange['to'], 0, 8);
1508 }
1509 $from = CRM_Utils_Date::processDate($from, $fromtime);
1510 $to = CRM_Utils_Date::processDate($to, $totime);
1511 return array($from, $to);
1512 }
1513
1514 function alterDisplay(&$rows) {
1515 // custom code to alter rows
1516 }
1517
1518 function alterCustomDataDisplay(&$rows) {
1519 // custom code to alter rows having custom values
1520 if (empty($this->_customGroupExtends)) {
1521 return;
1522 }
1523
1524 $customFieldIds = array();
1525 foreach ($this->_params['fields'] as $fieldAlias => $value) {
1526 if ($fieldId = CRM_Core_BAO_CustomField::getKeyID($fieldAlias)) {
1527 $customFieldIds[$fieldAlias] = $fieldId;
1528 }
1529 }
1530 if (empty($customFieldIds)) {
1531 return;
1532 }
1533
1534 $customFields = $fieldValueMap = array();
1535 $customFieldCols = array('column_name', 'data_type', 'html_type', 'option_group_id', 'id');
1536
1537 // skip for type date and ContactReference since date format is already handled
1538 $query = "
1539SELECT cg.table_name, cf." . implode(", cf.", $customFieldCols) . ", ov.value, ov.label
1540FROM civicrm_custom_field cf
1541INNER JOIN civicrm_custom_group cg ON cg.id = cf.custom_group_id
1542LEFT JOIN civicrm_option_value ov ON cf.option_group_id = ov.option_group_id
1543WHERE cg.extends IN ('" . implode("','", $this->_customGroupExtends) . "') AND
1544 cg.is_active = 1 AND
1545 cf.is_active = 1 AND
1546 cf.is_searchable = 1 AND
1547 cf.data_type NOT IN ('ContactReference', 'Date') AND
1548 cf.id IN (" . implode(",", $customFieldIds) . ")";
1549
1550 $dao = CRM_Core_DAO::executeQuery($query);
1551 while ($dao->fetch()) {
1552 foreach ($customFieldCols as $key) {
1553 $customFields[$dao->table_name . '_custom_' . $dao->id][$key] = $dao->$key;
1554 }
1555 if ($dao->option_group_id) {
1556 $fieldValueMap[$dao->option_group_id][$dao->value] = $dao->label;
1557 }
1558 }
1559 $dao->free();
1560
1561 $entryFound = FALSE;
1562 foreach ($rows as $rowNum => $row) {
1563 foreach ($row as $tableCol => $val) {
1564 if (array_key_exists($tableCol, $customFields)) {
1565 $rows[$rowNum][$tableCol] = $this->formatCustomValues($val, $customFields[$tableCol], $fieldValueMap);
1566 $entryFound = TRUE;
1567 }
1568 }
1569
1570 // skip looking further in rows, if first row itself doesn't
1571 // have the column we need
1572 if (!$entryFound) {
1573 break;
1574 }
1575 }
1576 }
1577
1578 function formatCustomValues($value, $customField, $fieldValueMap) {
1579 if (CRM_Utils_System::isNull($value)) {
1580 return;
1581 }
1582
1583 $htmlType = $customField['html_type'];
1584
1585 switch ($customField['data_type']) {
1586 case 'Boolean':
1587 if ($value == '1') {
1588 $retValue = ts('Yes');
1589 }
1590 else {
1591 $retValue = ts('No');
1592 }
1593 break;
1594
1595 case 'Link':
1596 $retValue = CRM_Utils_System::formatWikiURL($value);
1597 break;
1598
1599 case 'File':
1600 $retValue = $value;
1601 break;
1602
1603 case 'Memo':
1604 $retValue = $value;
1605 break;
1606
1607 case 'Float':
1608 if ($htmlType == 'Text') {
1609 $retValue = (float)$value;
1610 break;
1611 }
1612 case 'Money':
1613 if ($htmlType == 'Text') {
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623 $retValue = CRM_Utils_Money::format($value, NULL, '%a');
1624 break;
1625 }
1626 case 'String':
1627 case 'Int':
1628 if (in_array($htmlType, array(
1629 'Text', 'TextArea'))) {
1630 $retValue = $value;
1631 break;
1632 }
1633 case 'StateProvince':
1634 case 'Country':
1635
1636 switch ($htmlType) {
1637 case 'Multi-Select Country':
1638 $value = explode(CRM_Core_DAO::VALUE_SEPARATOR, $value);
1639 $customData = array();
1640 foreach ($value as $val) {
1641 if ($val) {
1642 $customData[] = CRM_Core_PseudoConstant::country($val, FALSE);
1643 }
1644 }
1645 $retValue = implode(', ', $customData);
1646 break;
1647
1648 case 'Select Country':
1649 $retValue = CRM_Core_PseudoConstant::country($value, FALSE);
1650 break;
1651
1652 case 'Select State/Province':
1653 $retValue = CRM_Core_PseudoConstant::stateProvince($value, FALSE);
1654 break;
1655
1656 case 'Multi-Select State/Province':
1657 $value = explode(CRM_Core_DAO::VALUE_SEPARATOR, $value);
1658 $customData = array();
1659 foreach ($value as $val) {
1660 if ($val) {
1661 $customData[] = CRM_Core_PseudoConstant::stateProvince($val, FALSE);
1662 }
1663 }
1664 $retValue = implode(', ', $customData);
1665 break;
1666
1667 case 'Select':
1668 case 'Radio':
1669 case 'Autocomplete-Select':
1670 $retValue = $fieldValueMap[$customField['option_group_id']][$value];
1671 break;
1672
1673 case 'CheckBox':
1674 case 'AdvMulti-Select':
1675 case 'Multi-Select':
1676 $value = explode(CRM_Core_DAO::VALUE_SEPARATOR, $value);
1677 $customData = array();
1678 foreach ($value as $val) {
1679 if ($val) {
1680 $customData[] = $fieldValueMap[$customField['option_group_id']][$val];
1681 }
1682 }
1683 $retValue = implode(', ', $customData);
1684 break;
1685
1686 default:
1687 $retValue = $value;
1688 }
1689 break;
1690
1691 default:
1692 $retValue = $value;
1693 }
1694
1695 return $retValue;
1696 }
1697
1698 function removeDuplicates(&$rows) {
1699 if (empty($this->_noRepeats)) {
1700 return;
1701 }
1702 $checkList = array();
1703
1704 foreach ($rows as $key => $list) {
1705 foreach ($list as $colName => $colVal) {
8f1445ea 1706 if (array_key_exists($colName, $checkList) &&
6a488035
TO		 1707 $checkList[$colName] == $colVal) {
1708 $rows[$key][$colName] = "";
1709 }
1710 if (in_array($colName, $this->_noRepeats)) {
1711 $checkList[$colName] = $colVal;
1712 }
1713 }
1714 }
1715 }
1716
1717 function fixSubTotalDisplay(&$row, $fields, $subtotal = TRUE) {
1718 foreach ($row as $colName => $colVal) {
1719 if (in_array($colName, $fields)) {
1720 $row[$colName] = $row[$colName];
1721 }
1722 elseif (isset($this->_columnHeaders[$colName])) {
1723 if ($subtotal) {
1724 $row[$colName] = "Subtotal";
1725 $subtotal = FALSE;
1726 }
1727 else {
1728 unset($row[$colName]);
1729 }
1730 }
1731 }
1732 }
1733
1734 function grandTotal(&$rows) {
1735 if (!$this->_rollup || ($this->_rollup == '') ||
1736 ($this->_limit && count($rows) >= self::ROW_COUNT_LIMIT)
1737 ) {
1738 return FALSE;
1739 }
1740 $lastRow = array_pop($rows);
1741
6a488035
TO		 1742 foreach ($this->_columnHeaders as $fld => $val) {
1743 if (!in_array($fld, $this->_statFields)) {
1744 if (!$this->_grandFlag) {
1745 $lastRow[$fld] = "Grand Total";
1746 $this->_grandFlag = TRUE;
1747 }
1748 else {
1749 $lastRow[$fld] = "";
1750 }
1751 }
1752 }
1753
1754 $this->assign('grandStat', $lastRow);
1755 return TRUE;
1756 }
1757
1758 function formatDisplay(&$rows, $pager = TRUE) {
1759 // set pager based on if any limit was applied in the query.
1760 if ($pager) {
1761 $this->setPager();
1762 }
1763
1764 // allow building charts if any
1765 if (!empty($this->_params['charts']) && !empty($rows)) {
1766 $this->buildChart($rows);
1767 $this->assign('chartEnabled', TRUE);
1768 $this->_chartId = "{$this->_params['charts']}_" . ($this->_id ? $this->_id : substr(get_class($this), 16)) . '_' . session_id();
1769 $this->assign('chartId', $this->_chartId);
1770 }
1771
1772 // unset columns not to be displayed.
1773 foreach ($this->_columnHeaders as $key => $value) {
a7488080 1774 if (!empty($value['no_display'])) {
6a488035
TO		 1775 unset($this->_columnHeaders[$key]);
1776 }
1777 }
1778
1779 // unset columns not to be displayed.
1780 if (!empty($rows)) {
1781 foreach ($this->_noDisplay as $noDisplayField) {
1782 foreach ($rows as $rowNum => $row) {
1783 unset($this->_columnHeaders[$noDisplayField]);
1784 }
1785 }
1786 }
1787
1788 // build array of section totals
1789 $this->sectionTotals();
1790
1791 // process grand-total row
1792 $this->grandTotal($rows);
1793
1794 // use this method for formatting rows for display purpose.
1795 $this->alterDisplay($rows);
1796 CRM_Utils_Hook::alterReportVar('rows', $rows, $this);
1797
1798 // use this method for formatting custom rows for display purpose.
1799 $this->alterCustomDataDisplay($rows);
1800 }
1801
1802 function buildChart(&$rows) {
1803 // override this method for building charts.
1804 }
1805
1806 // select() method below has been added recently (v3.3), and many of the report templates might
1807 // still be having their own select() method. We should fix them as and when encountered and move
1808 // towards generalizing the select() method below.
1809 function select() {
1f220d30 1810 $select = $this->_selectAliases = array();
6a488035
TO		 1811
1812 foreach ($this->_columns as $tableName => $table) {
1813 if (array_key_exists('fields', $table)) {
1814 foreach ($table['fields'] as $fieldName => $field) {
1815 if ($tableName == 'civicrm_address') {
1816 $this->_addressField = TRUE;
1817 }
1818 if ($tableName == 'civicrm_email') {
1819 $this->_emailField = TRUE;
1820 }
1821 if ($tableName == 'civicrm_phone') {
1822 $this->_phoneField = TRUE;
1823 }
1824
8cc574cf 1825 if (!empty($field['required']) || !empty($this->_params['fields'][$fieldName])) {
6a488035
TO		 1826
1827 // 1. In many cases we want select clause to be built in slightly different way
1828 // for a particular field of a particular type.
1829 // 2. This method when used should receive params by reference and modify $this->_columnHeaders
1830 // as needed.
1831 $selectClause = $this->selectClause($tableName, 'fields', $fieldName, $field);
1832 if ($selectClause) {
1833 $select[] = $selectClause;
1834 continue;
1835 }
1836
1837 // include statistics columns only if set
a7488080 1838 if (!empty($field['statistics'])) {
6a488035
TO		 1839 foreach ($field['statistics'] as $stat => $label) {
1840 $alias = "{$tableName}_{$fieldName}_{$stat}";
1841 switch (strtolower($stat)) {
1842 case 'max':
1843 case 'sum':
1844 $select[] = "$stat({$field['dbAlias']}) as $alias";
1845 $this->_columnHeaders["{$tableName}_{$fieldName}_{$stat}"]['title'] = $label;
1846 $this->_columnHeaders["{$tableName}_{$fieldName}_{$stat}"]['type'] = $field['type'];
9e6d7767 1847 $this->_statFields[$label] = $alias;
6a488035
TO		 1848 $this->_selectAliases[] = $alias;
1849 break;
1850
1851 case 'count':
1852 $select[] = "COUNT({$field['dbAlias']}) as $alias";
1853 $this->_columnHeaders["{$tableName}_{$fieldName}_{$stat}"]['title'] = $label;
1854 $this->_columnHeaders["{$tableName}_{$fieldName}_{$stat}"]['type'] = CRM_Utils_Type::T_INT;
9e6d7767 1855 $this->_statFields[$label] = $alias;
6a488035
TO		 1856 $this->_selectAliases[] = $alias;
1857 break;
1858
1bfaf6a6
DS		 1859 case 'count_distinct':
1860 $select[] = "COUNT(DISTINCT {$field['dbAlias']}) as $alias";
1861 $this->_columnHeaders["{$tableName}_{$fieldName}_{$stat}"]['title'] = $label;
1862 $this->_columnHeaders["{$tableName}_{$fieldName}_{$stat}"]['type'] = CRM_Utils_Type::T_INT;
1863 $this->_statFields[$label] = $alias;
1864 $this->_selectAliases[] = $alias;
1865 break;
1866
6a488035
TO		 1867 case 'avg':
1868 $select[] = "ROUND(AVG({$field['dbAlias']}),2) as $alias";
1869 $this->_columnHeaders["{$tableName}_{$fieldName}_{$stat}"]['title'] = $label;
1870 $this->_columnHeaders["{$tableName}_{$fieldName}_{$stat}"]['type'] = $field['type'];
9e6d7767 1871 $this->_statFields[$label] = $alias;
6a488035
TO		 1872 $this->_selectAliases[] = $alias;
1873 break;
1874 }
1875 }
1876 }
1877 else {
1878 $alias = "{$tableName}_{$fieldName}";
1879 $select[] = "{$field['dbAlias']} as $alias";
1880 $this->_columnHeaders["{$tableName}_{$fieldName}"]['title'] = CRM_Utils_Array::value('title', $field);
1881 $this->_columnHeaders["{$tableName}_{$fieldName}"]['type'] = CRM_Utils_Array::value('type', $field);
1882 $this->_selectAliases[] = $alias;
1883 }
1884 }
1885 }
1886 }
1887
1888 // select for group bys
1889 if (array_key_exists('group_bys', $table)) {
1890 foreach ($table['group_bys'] as $fieldName => $field) {
1891
1892 if ($tableName == 'civicrm_address') {
1893 $this->_addressField = TRUE;
1894 }
1895 if ($tableName == 'civicrm_email') {
1896 $this->_emailField = TRUE;
1897 }
1898 if ($tableName == 'civicrm_phone') {
1899 $this->_phoneField = TRUE;
1900 }
1901 // 1. In many cases we want select clause to be built in slightly different way
1902 // for a particular field of a particular type.
1903 // 2. This method when used should receive params by reference and modify $this->_columnHeaders
1904 // as needed.
1905 $selectClause = $this->selectClause($tableName, 'group_bys', $fieldName, $field);
1906 if ($selectClause) {
1907 $select[] = $selectClause;
1908 continue;
1909 }
1910
8cc574cf 1911 if (!empty($this->_params['group_bys']) && !empty($this->_params['group_bys'][$fieldName]) && !empty($this->_params['group_bys_freq'])) {
6a488035
TO		 1912 switch (CRM_Utils_Array::value($fieldName, $this->_params['group_bys_freq'])) {
1913 case 'YEARWEEK':
1914 $select[] = "DATE_SUB({$field['dbAlias']}, INTERVAL WEEKDAY({$field['dbAlias']}) DAY) AS {$tableName}_{$fieldName}_start";
1915 $select[] = "YEARWEEK({$field['dbAlias']}) AS {$tableName}_{$fieldName}_subtotal";
1916 $select[] = "WEEKOFYEAR({$field['dbAlias']}) AS {$tableName}_{$fieldName}_interval";
1917 $field['title'] = 'Week';
1918 break;
1919
1920 case 'YEAR':
1921 $select[] = "MAKEDATE(YEAR({$field['dbAlias']}), 1) AS {$tableName}_{$fieldName}_start";
1922 $select[] = "YEAR({$field['dbAlias']}) AS {$tableName}_{$fieldName}_subtotal";
1923 $select[] = "YEAR({$field['dbAlias']}) AS {$tableName}_{$fieldName}_interval";
1924 $field['title'] = 'Year';
1925 break;
1926
1927 case 'MONTH':
1928 $select[] = "DATE_SUB({$field['dbAlias']}, INTERVAL (DAYOFMONTH({$field['dbAlias']})-1) DAY) as {$tableName}_{$fieldName}_start";
1929 $select[] = "MONTH({$field['dbAlias']}) AS {$tableName}_{$fieldName}_subtotal";
1930 $select[] = "MONTHNAME({$field['dbAlias']}) AS {$tableName}_{$fieldName}_interval";
1931 $field['title'] = 'Month';
1932 break;
1933
1934 case 'QUARTER':
1935 $select[] = "STR_TO_DATE(CONCAT( 3 * QUARTER( {$field['dbAlias']} ) -2 , '/', '1', '/', YEAR( {$field['dbAlias']} ) ), '%m/%d/%Y') AS {$tableName}_{$fieldName}_start";
1936 $select[] = "QUARTER({$field['dbAlias']}) AS {$tableName}_{$fieldName}_subtotal";
1937 $select[] = "QUARTER({$field['dbAlias']}) AS {$tableName}_{$fieldName}_interval";
1938 $field['title'] = 'Quarter';
1939 break;
1940 }
1941 // for graphs and charts -
a7488080 1942 if (!empty($this->_params['group_bys_freq'][$fieldName])) {
6a488035
TO		 1943 $this->_interval = $field['title'];
1944 $this->_columnHeaders["{$tableName}_{$fieldName}_start"]['title'] = $field['title'] . ' Beginning';
1945 $this->_columnHeaders["{$tableName}_{$fieldName}_start"]['type'] = $field['type'];
1946 $this->_columnHeaders["{$tableName}_{$fieldName}_start"]['group_by'] = $this->_params['group_bys_freq'][$fieldName];
1947
1948 // just to make sure these values are transfered to rows.
1949 // since we 'll need them for calculation purpose,
1950 // e.g making subtotals look nicer or graphs
1951 $this->_columnHeaders["{$tableName}_{$fieldName}_interval"] = array('no_display' => TRUE);
1952 $this->_columnHeaders["{$tableName}_{$fieldName}_subtotal"] = array('no_display' => TRUE);
1953 }
1954 }
1955 }
1956 }
1957 }
1958
1f220d30 1959 $this->_selectClauses = $select;
6a488035
TO		 1960 $this->_select = "SELECT " . implode(', ', $select) . " ";
1961 }
1962
1963 function selectClause(&$tableName, $tableKey, &$fieldName, &$field) {
1964 return FALSE;
1965 }
1966
1967 function where() {
adfe2750 1968 $this->storeWhereHavingClauseArray();
1969
1970 if (empty($this->_whereClauses)) {
1971 $this->_where = "WHERE ( 1 ) ";
1972 $this->_having = "";
1973 }
1974 else {
1975 $this->_where = "WHERE " . implode(' AND ', $this->_whereClauses);
1976 }
1977
1978 if ($this->_aclWhere) {
1979 $this->_where .= " AND {$this->_aclWhere} ";
1980 }
1981
1982 if (!empty($this->_havingClauses)) {
1983 // use this clause to construct group by clause.
1984 $this->_having = "HAVING " . implode(' AND ', $this->_havingClauses);
1985 }
1986 }
1987
1988 /**
1989 * Store Where clauses into an array - breaking out this step makes
1990 * over-riding more flexible as the clauses can be used in constructing a
1991 * temp table that may not be part of the final where clause or added
1992 * in other functions
1993 */
1994 function storeWhereHavingClauseArray(){
6a488035
TO		 1995 foreach ($this->_columns as $tableName => $table) {
1996 if (array_key_exists('filters', $table)) {
1997 foreach ($table['filters'] as $fieldName => $field) {
d12de91c 1998 // respect pseudofield to filter spec so fields can be marked as
1999 // not to be handled here
2000 if(!empty($field['pseudofield'])){
2001 continue;
2002 }
6a488035
TO		 2003 $clause = NULL;
2004 if (CRM_Utils_Array::value('type', $field) & CRM_Utils_Type::T_DATE) {
2005 if (CRM_Utils_Array::value('operatorType', $field) == CRM_Report_Form::OP_MONTH) {
2006 $op = CRM_Utils_Array::value("{$fieldName}_op", $this->_params);
2007 $value = CRM_Utils_Array::value("{$fieldName}_value", $this->_params);
2008 if (is_array($value) && !empty($value)) {
2009 $clause = "(month({$field['dbAlias']}) $op (" . implode(', ', $value) . '))';
2010 }
2011 }
2012 else {
2013 $relative = CRM_Utils_Array::value("{$fieldName}_relative", $this->_params);
2014 $from = CRM_Utils_Array::value("{$fieldName}_from", $this->_params);
2015 $to = CRM_Utils_Array::value("{$fieldName}_to", $this->_params);
2016 $fromTime = CRM_Utils_Array::value("{$fieldName}_from_time", $this->_params);
2017 $toTime = CRM_Utils_Array::value("{$fieldName}_to_time", $this->_params);
2018 $clause = $this->dateClause($field['dbAlias'], $relative, $from, $to, $field['type'], $fromTime, $toTime);
2019 }
2020 }
2021 else {
2022 $op = CRM_Utils_Array::value("{$fieldName}_op", $this->_params);
2023 if ($op) {
2024 $clause = $this->whereClause($field,
adfe2750 2025 $op,
2026 CRM_Utils_Array::value("{$fieldName}_value", $this->_params),
2027 CRM_Utils_Array::value("{$fieldName}_min", $this->_params),
2028 CRM_Utils_Array::value("{$fieldName}_max", $this->_params)
6a488035
TO		 2029 );
2030 }
2031 }
2032
2033 if (!empty($clause)) {
a7488080 2034 if (!empty($field['having'])) {
adfe2750 2035 $this->_havingClauses[] = $clause;
6a488035
TO		 2036 }
2037 else {
adfe2750 2038 $this->_whereClauses[] = $clause;
6a488035
TO		 2039 }
2040 }
2041 }
2042 }
2043 }
2044
6a488035 2045 }
6a488035
TO		 2046 function processReportMode() {
2047 $buttonName = $this->controller->getButtonName();
2048
884605ca
DL		 2049 $output = CRM_Utils_Request::retrieve(
2050 'output',
2051 'String',
2052 CRM_Core_DAO::$_nullObject
6a488035
TO		 2053 );
2054
2055 $this->_sendmail =
884605ca
DL		 2056 CRM_Utils_Request::retrieve(
2057 'sendmail',
2058 'Boolean',
2059 CRM_Core_DAO::$_nullObject
2060 );
6a488035
TO		 2061
2062 $this->_absoluteUrl = FALSE;
2063 $printOnly = FALSE;
2064 $this->assign('printOnly', FALSE);
2065
2066 if ($this->_printButtonName == $buttonName || $output == 'print' || ($this->_sendmail && !$output)) {
2067 $this->assign('printOnly', TRUE);
2068 $printOnly = TRUE;
2069 $this->assign('outputMode', 'print');
2070 $this->_outputMode = 'print';
2071 if ($this->_sendmail) {
2072 $this->_absoluteUrl = TRUE;
2073 }
2074 }
2075 elseif ($this->_pdfButtonName == $buttonName || $output == 'pdf') {
2076 $this->assign('printOnly', TRUE);
2077 $printOnly = TRUE;
2078 $this->assign('outputMode', 'pdf');
2079 $this->_outputMode = 'pdf';
2080 $this->_absoluteUrl = TRUE;
2081 }
2082 elseif ($this->_csvButtonName == $buttonName || $output == 'csv') {
2083 $this->assign('printOnly', TRUE);
2084 $printOnly = TRUE;
2085 $this->assign('outputMode', 'csv');
2086 $this->_outputMode = 'csv';
2087 $this->_absoluteUrl = TRUE;
2088 }
2089 elseif ($this->_groupButtonName == $buttonName || $output == 'group') {
2090 $this->assign('outputMode', 'group');
2091 $this->_outputMode = 'group';
2092 }
2093 elseif ($output == 'create_report' && $this->_criteriaForm) {
2094 $this->assign('outputMode', 'create_report');
2095 $this->_outputMode = 'create_report';
2096 }
2097 else {
2098 $this->assign('outputMode', 'html');
2099 $this->_outputMode = 'html';
2100 }
2101
2102 // Get today's date to include in printed reports
2103 if ($printOnly) {
2104 $reportDate = CRM_Utils_Date::customFormat(date('Y-m-d H:i'));
2105 $this->assign('reportDate', $reportDate);
2106 }
2107 }
2108
2109 function beginPostProcess() {
c58f66e0 2110 $this->setParams($this->controller->exportValues($this->_name));
6a488035
TO		 2111
2112 if (empty($this->_params) &&
2113 $this->_force
2114 ) {
c58f66e0 2115 $this->setParams($this->_formValues);
6a488035
TO		 2116 }
2117
2118 // hack to fix params when submitted from dashboard, CRM-8532
2119 // fields array is missing because form building etc is skipped
2120 // in dashboard mode for report
c58f66e0 2121 //@todo - this could be done in the dashboard no we have a setter
a7488080 2122 if (empty($this->_params['fields']) && !$this->_noFields) {
c58f66e0 2123 $this->setParams($this->_formValues);
6a488035
TO		 2124 }
2125
2126 $this->_formValues = $this->_params;
2127 if (CRM_Core_Permission::check('administer Reports') &&
2128 isset($this->_id) &&
2129 ($this->_instanceButtonName == $this->controller->getButtonName() . '_save' ||
2130 $this->_chartButtonName == $this->controller->getButtonName()
2131 )
2132 ) {
2133 $this->assign('updateReportButton', TRUE);
2134 }
2135 $this->processReportMode();
c58f66e0
E		 2136 $this->beginPostProcessCommon();
2137 }
2138
2139 /**
2140 * beginPostProcess function run in both report mode and non-report mode (api)
2141 */
2142 function beginPostProcessCommon() {
2143
6a488035
TO		 2144 }
2145
2146 function buildQuery($applyLimit = TRUE) {
2147 $this->select();
2148 $this->from();
2149 $this->customDataFrom();
2150 $this->where();
2151 $this->groupBy();
2152 $this->orderBy();
2153
2154 // order_by columns not selected for display need to be included in SELECT
2155 $unselectedSectionColumns = $this->unselectedSectionColumns();
2156 foreach ($unselectedSectionColumns as $alias => $section) {
2157 $this->_select .= ", {$section['dbAlias']} as {$alias}";
2158 }
2159
8cc574cf 2160 if ($applyLimit && empty($this->_params['charts'])) {
6a488035
TO		 2161 $this->limit();
2162 }
2163 CRM_Utils_Hook::alterReportVar('sql', $this, $this);
2164
2165 $sql = "{$this->_select} {$this->_from} {$this->_where} {$this->_groupBy} {$this->_having} {$this->_orderBy} {$this->_limit}";
2166 return $sql;
2167 }
2168
2169 function groupBy() {
2170 $groupBys = array();
a7488080 2171 if (!empty($this->_params['group_bys']) &&
6a488035
TO		 2172 is_array($this->_params['group_bys']) &&
2173 !empty($this->_params['group_bys'])
2174 ) {
2175 foreach ($this->_columns as $tableName => $table) {
2176 if (array_key_exists('group_bys', $table)) {
2177 foreach ($table['group_bys'] as $fieldName => $field) {
a7488080 2178 if (!empty($this->_params['group_bys'][$fieldName])) {
6a488035
TO		 2179 $groupBys[] = $field['dbAlias'];
2180 }
2181 }
2182 }
2183 }
2184 }
2185
2186 if (!empty($groupBys)) {
2187 $this->_groupBy = "GROUP BY " . implode(', ', $groupBys);
2188 }
2189 }
2190
2191 function orderBy() {
2192 $this->_orderBy = "";
2193 $this->_sections = array();
2194 $this->storeOrderByArray();
2195 if(!empty($this->_orderByArray) && !$this->_rollup == 'WITH ROLLUP'){
2196 $this->_orderBy = "ORDER BY " . implode(', ', $this->_orderByArray);
2197 }
2198 $this->assign('sections', $this->_sections);
2199 }
f2947aea 2200
6a488035
TO		 2201 /*
2202 * In some cases other functions want to know which fields are selected for ordering by
2203 * Separating this into a separate function allows it to be called separately from constructing
2204 * the order by clause
2205 */
2206 function storeOrderByArray() {
2207 $orderBys = array();
2208
a7488080 2209 if (!empty($this->_params['order_bys']) &&
6a488035
TO		 2210 is_array($this->_params['order_bys']) &&
2211 !empty($this->_params['order_bys'])
2212 ) {
2213
2214 // Proces order_bys in user-specified order
2215 foreach ($this->_params['order_bys'] as $orderBy) {
2216 $orderByField = array();
2217 foreach ($this->_columns as $tableName => $table) {
2218 if (array_key_exists('order_bys', $table)) {
2219 // For DAO columns defined in $this->_columns
2220 $fields = $table['order_bys'];
2221 }
2222 elseif (array_key_exists('extends', $table)) {
2223 // For custom fields referenced in $this->_customGroupExtends
1efec7ff 2224 $fields = CRM_Utils_Array::value('fields', $table, array());
6a488035
TO		 2225 }
2226 if (!empty($fields) && is_array($fields)) {
2227 foreach ($fields as $fieldName => $field) {
2228 if ($fieldName == $orderBy['column']) {
f2947aea 2229 $orderByField = array_merge($field, $orderBy);
6a488035
TO		 2230 $orderByField['tplField'] = "{$tableName}_{$fieldName}";
2231 break 2;
2232 }
2233 }
2234 }
2235 }
2236
2237 if (!empty($orderByField)) {
f2947aea 2238 $this->_orderByFields[] = $orderByField;
6a488035
TO		 2239 $orderBys[] = "{$orderByField['dbAlias']} {$orderBy['order']}";
2240
2241 // Record any section headers for assignment to the template
a7488080 2242 if (!empty($orderBy['section'])) {
b5801e1d 2243 $orderByField['pageBreak'] = CRM_Utils_Array::value('pageBreak', $orderBy);
6a488035
TO		 2244 $this->_sections[$orderByField['tplField']] = $orderByField;
2245 }
2246 }
2247 }
2248 }
2249
2250 $this->_orderByArray = $orderBys;
2251
2252 $this->assign('sections', $this->_sections);
2253 }
2254
2255 function unselectedSectionColumns() {
2256 $selectColumns = array();
2257 foreach ($this->_columns as $tableName => $table) {
2258 if (array_key_exists('fields', $table)) {
2259 foreach ($table['fields'] as $fieldName => $field) {
8cc574cf 2260 if (!empty($field['required']) || !empty($this->_params['fields'][$fieldName])) {
6a488035
TO		 2261
2262 $selectColumns["{$tableName}_{$fieldName}"] = 1;
2263 }
2264 }
2265 }
2266 }
f2947aea 2267
6a488035
TO		 2268 if (is_array($this->_sections)) {
2269 return array_diff_key($this->_sections, $selectColumns);
2270 }
2271 else {
2272 return array();
2273 }
2274 }
2275
2276 function buildRows($sql, &$rows) {
2277 $dao = CRM_Core_DAO::executeQuery($sql);
2278 if (!is_array($rows)) {
2279 $rows = array();
2280 }
2281
2282 // use this method to modify $this->_columnHeaders
2283 $this->modifyColumnHeaders();
2284
2285 $unselectedSectionColumns = $this->unselectedSectionColumns();
2286
2287 while ($dao->fetch()) {
2288 $row = array();
2289 foreach ($this->_columnHeaders as $key => $value) {
2290 if (property_exists($dao, $key)) {
2291 $row[$key] = $dao->$key;
2292 }
2293 }
2294
2295 // section headers not selected for display need to be added to row
2296 foreach ($unselectedSectionColumns as $key => $values) {
2297 if (property_exists($dao, $key)) {
2298 $row[$key] = $dao->$key;
2299 }
2300 }
2301
2302 $rows[] = $row;
2303 }
2304 }
2305
2306 /**
2307 * When "order by" fields are marked as sections, this assigns to the template
2308 * an array of total counts for each section. This data is used by the Smarty
2309 * plugin {sectionTotal}
2310 */
2311 function sectionTotals() {
2312
2313 // Reports using order_bys with sections must populate $this->_selectAliases in select() method.
2314 if (empty($this->_selectAliases)) {
2315 return;
2316 }
2317
2318 if (!empty($this->_sections)) {
2319 // build the query with no LIMIT clause
2320 $select = str_ireplace('SELECT SQL_CALC_FOUND_ROWS ', 'SELECT ', $this->_select);
2321 $sql = "{$select} {$this->_from} {$this->_where} {$this->_groupBy} {$this->_having} {$this->_orderBy}";
2322
2323 // pull section aliases out of $this->_sections
2324 $sectionAliases = array_keys($this->_sections);
2325
2326 $ifnulls = array();
2327 foreach (array_merge($sectionAliases, $this->_selectAliases) as $alias) {
2328 $ifnulls[] = "ifnull($alias, '') as $alias";
2329 }
2330
2331 /* Group (un-limited) report by all aliases and get counts. This might
2332 * be done more efficiently when the contents of $sql are known, ie. by
2333 * overriding this method in the report class.
2334 */
2335
2336
2337 $query = "select " . implode(", ", $ifnulls) . ", count(*) as ct from ($sql) as subquery group by " . implode(", ", $sectionAliases);
2338
2339 // initialize array of total counts
2340 $totals = array();
2341 $dao = CRM_Core_DAO::executeQuery($query);
2342 while ($dao->fetch()) {
2343
2344 // let $this->_alterDisplay translate any integer ids to human-readable values.
2345 $rows[0] = $dao->toArray();
2346 $this->alterDisplay($rows);
2347 $row = $rows[0];
2348
2349 // add totals for all permutations of section values
2350 $values = array();
2351 $i = 1;
2352 $aliasCount = count($sectionAliases);
2353 foreach ($sectionAliases as $alias) {
2354 $values[] = $row[$alias];
2355 $key = implode(CRM_Core_DAO::VALUE_SEPARATOR, $values);
2356 if ($i == $aliasCount) {
2357 // the last alias is the lowest-level section header; use count as-is
2358 $totals[$key] = $dao->ct;
2359 }
2360 else {
2361 // other aliases are higher level; roll count into their total
2362 $totals[$key] += $dao->ct;
2363 }
2364 }
2365 }
2366 $this->assign('sectionTotals', $totals);
2367 }
2368 }
2369
2370 function modifyColumnHeaders() {
2371 // use this method to modify $this->_columnHeaders
2372 }
2373
2374 function doTemplateAssignment(&$rows) {
2375 $this->assign_by_ref('columnHeaders', $this->_columnHeaders);
2376 $this->assign_by_ref('rows', $rows);
2377 $this->assign('statistics', $this->statistics($rows));
2378 }
2379
2380 // override this method to build your own statistics
2381 function statistics(&$rows) {
2382 $statistics = array();
2383
2384 $count = count($rows);
2385
2386 if ($this->_rollup && ($this->_rollup != '') && $this->_grandFlag) {
2387 $count++;
2388 }
2389
2390 $this->countStat($statistics, $count);
2391
2392 $this->groupByStat($statistics);
2393
2394 $this->filterStat($statistics);
2395
2396 return $statistics;
2397 }
2398
2399 function countStat(&$statistics, $count) {
2400 $statistics['counts']['rowCount'] = array('title' => ts('Row(s) Listed'),
2401 'value' => $count,
2402 );
2403
2404 if ($this->_rowsFound && ($this->_rowsFound > $count)) {
2405 $statistics['counts']['rowsFound'] = array('title' => ts('Total Row(s)'),
2406 'value' => $this->_rowsFound,
2407 );
2408 }
2409 }
2410
2411 function groupByStat(&$statistics) {
a7488080 2412 if (!empty($this->_params['group_bys']) &&
6a488035
TO		 2413 is_array($this->_params['group_bys']) &&
2414 !empty($this->_params['group_bys'])
2415 ) {
2416 foreach ($this->_columns as $tableName => $table) {
2417 if (array_key_exists('group_bys', $table)) {
2418 foreach ($table['group_bys'] as $fieldName => $field) {
a7488080 2419 if (!empty($this->_params['group_bys'][$fieldName])) {
6a488035
TO		 2420 $combinations[] = $field['title'];
2421 }
2422 }
2423 }
2424 }
2425 $statistics['groups'][] = array('title' => ts('Grouping(s)'),
2426 'value' => implode(' & ', $combinations),
2427 );
2428 }
2429 }
2430
2431 function filterStat(&$statistics) {
2432 foreach ($this->_columns as $tableName => $table) {
2433 if (array_key_exists('filters', $table)) {
2434 foreach ($table['filters'] as $fieldName => $field) {
2435 if (CRM_Utils_Array::value('type', $field) & CRM_Utils_Type::T_DATE && CRM_Utils_Array::value('operatorType', $field) != CRM_Report_Form::OP_MONTH) {
8f1445ea
DL		 2436 list($from, $to) =
2437 $this->getFromTo(
2438 CRM_Utils_Array::value("{$fieldName}_relative", $this->_params),
2439 CRM_Utils_Array::value("{$fieldName}_from", $this->_params),
2440 CRM_Utils_Array::value("{$fieldName}_to", $this->_params),
2441 CRM_Utils_Array::value("{$fieldName}_from_time", $this->_params),
2442 CRM_Utils_Array::value("{$fieldName}_to_time", $this->_params)
2443 );
0d8afee2 2444 $from_time_format = !empty($this->_params["{$fieldName}_from_time"]) ? 'h' : 'd';
6a488035
TO		 2445 $from = CRM_Utils_Date::customFormat($from, null, array($from_time_format));
2446
0d8afee2 2447 $to_time_format = !empty($this->_params["{$fieldName}_to_time"]) ? 'h' : 'd';
6a488035
TO		 2448 $to = CRM_Utils_Date::customFormat($to, null, array($to_time_format));
2449
2450 if ($from || $to) {
2451 $statistics['filters'][] = array(
2452 'title' => $field['title'],
10a5be27 2453 'value' => ts("Between %1 and %2", array(1 => $from, 2 => $to)),
6a488035
TO		 2454 );
2455 }
2456 elseif (in_array($rel = CRM_Utils_Array::value("{$fieldName}_relative", $this->_params),
160d32e1 2457 array_keys($this->getOperationPair(CRM_Report_Form::OP_DATE))
6a488035 2458 )) {
160d32e1 2459 $pair = $this->getOperationPair(CRM_Report_Form::OP_DATE);
6a488035
TO		 2460 $statistics['filters'][] = array(
2461 'title' => $field['title'],
2462 'value' => $pair[$rel],
2463 );
2464 }
2465 }
2466 else {
2467 $op = CRM_Utils_Array::value("{$fieldName}_op", $this->_params);
2468 $value = NULL;
2469 if ($op) {
1b36206c 2470 $pair = $this->getOperationPair(
8f1445ea
DL		 2471 CRM_Utils_Array::value('operatorType', $field),
2472 $fieldName
6a488035
TO		 2473 );
2474 $min = CRM_Utils_Array::value("{$fieldName}_min", $this->_params);
2475 $max = CRM_Utils_Array::value("{$fieldName}_max", $this->_params);
2476 $val = CRM_Utils_Array::value("{$fieldName}_value", $this->_params);
2477 if (in_array($op, array(
2478 'bw', 'nbw')) && ($min || $max)) {
2479 $value = "{$pair[$op]} " . $min . ' and ' . $max;
2480 }
2481 elseif ($op == 'nll' || $op == 'nnll') {
2482 $value = $pair[$op];
2483 }
2484 elseif (is_array($val) && (!empty($val))) {
f974e915 2485 $options = CRM_Utils_Array::value('options', $field, array());
6a488035
TO		 2486 foreach ($val as $key => $valIds) {
2487 if (isset($options[$valIds])) {
2488 $val[$key] = $options[$valIds];
2489 }
2490 }
f974e915 2491 $pair[$op] = (count($val) == 1) ? (($op == 'notin') ? ts('Is Not') : ts('Is')) : CRM_Utils_Array::value($op, $pair);
6a488035
TO		 2492 $val = implode(', ', $val);
2493 $value = "{$pair[$op]} " . $val;
2494 }
2495 elseif (!is_array($val) && (!empty($val) || $val == '0') && isset($field['options']) &&
2496 is_array($field['options']) && !empty($field['options'])
2497 ) {
2498 $value = CRM_Utils_Array::value($op, $pair) . " " . CRM_Utils_Array::value($val, $field['options'], $val);
2499 }
2500 elseif ($val) {
2501 $value = CRM_Utils_Array::value($op, $pair) . " " . $val;
2502 }
2503 }
2504 if ($value) {
2505 $statistics['filters'][] = array('title' => CRM_Utils_Array::value('title', $field),
2506 'value' => $value,
2507 );
2508 }
2509 }
2510 }
2511 }
2512 }
2513 }
2514
2515 function endPostProcess(&$rows = NULL) {
ae555e90
DS		 2516 if ( $this->_storeResultSet ) {
2517 $this->_resultSet = $rows;
2518 }
2519
6a488035
TO		 2520 if ($this->_outputMode == 'print' ||
2521 $this->_outputMode == 'pdf' ||
2522 $this->_sendmail
2523 ) {
2524
2525 $content = $this->compileContent();
2526 $url = CRM_Utils_System::url("civicrm/report/instance/{$this->_id}",
2527 "reset=1", TRUE
2528 );
2529
2530 if ($this->_sendmail) {
2531 $config = CRM_Core_Config::singleton();
2532 $attachments = array();
2533
2534 if ($this->_outputMode == 'csv') {
2535 $content = $this->_formValues['report_header'] . '<p>' . ts('Report URL') . ": {$url}</p>" . '<p>' . ts('The report is attached as a CSV file.') . '</p>' . $this->_formValues['report_footer'];
2536
2537 $csvFullFilename = $config->templateCompileDir . CRM_Utils_File::makeFileName('CiviReport.csv');
2538 $csvContent = CRM_Report_Utils_Report::makeCsv($this, $rows);
2539 file_put_contents($csvFullFilename, $csvContent);
2540 $attachments[] = array(
2541 'fullPath' => $csvFullFilename,
2542 'mime_type' => 'text/csv',
2543 'cleanName' => 'CiviReport.csv',
2544 );
2545 }
2546 if ($this->_outputMode == 'pdf') {
2547 // generate PDF content
2548 $pdfFullFilename = $config->templateCompileDir . CRM_Utils_File::makeFileName('CiviReport.pdf');
2549 file_put_contents($pdfFullFilename,
2550 CRM_Utils_PDF_Utils::html2pdf($content, "CiviReport.pdf",
2551 TRUE, array('orientation' => 'landscape')
2552 )
2553 );
2554 // generate Email Content
2555 $content = $this->_formValues['report_header'] . '<p>' . ts('Report URL') . ": {$url}</p>" . '<p>' . ts('The report is attached as a PDF file.') . '</p>' . $this->_formValues['report_footer'];
2556
2557 $attachments[] = array(
2558 'fullPath' => $pdfFullFilename,
2559 'mime_type' => 'application/pdf',
2560 'cleanName' => 'CiviReport.pdf',
2561 );
2562 }
2563
2564 if (CRM_Report_Utils_Report::mailReport($content, $this->_id,
2565 $this->_outputMode, $attachments
2566 )) {
2567 CRM_Core_Session::setStatus(ts("Report mail has been sent."), ts('Sent'), 'success');
2568 }
2569 else {
2570 CRM_Core_Session::setStatus(ts("Report mail could not be sent."), ts('Mail Error'), 'error');
2571 }
2572
1c4d8c3e 2573 CRM_Utils_System::redirect(CRM_Utils_System::url(CRM_Utils_System::currentPath(), 'reset=1'));
6a488035
TO		 2574 }
2575 elseif ($this->_outputMode == 'print') {
2576 echo $content;
2577 }
2578 else {
2579 if ($chartType = CRM_Utils_Array::value('charts', $this->_params)) {
2580 $config = CRM_Core_Config::singleton();
2581 //get chart image name
2582 $chartImg = $this->_chartId . '.png';
2583 //get image url path
2584 $uploadUrl = str_replace('/persist/contribute/', '/persist/', $config->imageUploadURL) . 'openFlashChart/';
2585 $uploadUrl .= $chartImg;
2586 //get image doc path to overwrite
2587 $uploadImg = str_replace('/persist/contribute/', '/persist/', $config->imageUploadDir) . 'openFlashChart/' . $chartImg;
2588 //Load the image
2589 $chart = imagecreatefrompng($uploadUrl);
2590 //convert it into formattd png
2591 header('Content-type: image/png');
2592 //overwrite with same image
2593 imagepng($chart, $uploadImg);
2594 //delete the object
2595 imagedestroy($chart);
2596 }
2597 CRM_Utils_PDF_Utils::html2pdf($content, "CiviReport.pdf", FALSE, array('orientation' => 'landscape'));
2598 }
2599 CRM_Utils_System::civiExit();
2600 }
2601 elseif ($this->_outputMode == 'csv') {
2602 CRM_Report_Utils_Report::export2csv($this, $rows);
2603 }
2604 elseif ($this->_outputMode == 'group') {
2605 $group = $this->_params['groups'];
2606 $this->add2group($group);
2607 }
2608 elseif ($this->_instanceButtonName == $this->controller->getButtonName()) {
2609 CRM_Report_Form_Instance::postProcess($this);
2610 }
2611 elseif ($this->_createNewButtonName == $this->controller->getButtonName() ||
2612 $this->_outputMode == 'create_report' ) {
2613 $this->_createNew = TRUE;
2614 CRM_Report_Form_Instance::postProcess($this);
2615 }
2616 }
8f1445ea 2617
ae555e90
DS		 2618 function storeResultSet() {
2619 $this->_storeResultSet = TRUE;
2620 }
2621
2622 function getResultSet() {
2623 return $this->_resultSet;
2624 }
2625
6a488035
TO		 2626 /*
2627 * Get Template file name - use default form template if a specific one has not been set up for this report
2628 *
2629 */
2630 function getTemplateFileName(){
2631 $defaultTpl = parent::getTemplateFileName();
2632 $template = CRM_Core_Smarty::singleton();
2633 if (!$template->template_exists($defaultTpl)) {
2634 $defaultTpl = 'CRM/Report/Form.tpl';
2635 }
2636 return $defaultTpl;
2637 }
2638
2639 /*
2640 * Compile the report content
2641 *
2642 * Although this function is super-short it is useful to keep separate so it can be over-ridden by report classes.
2643 */
2644 function compileContent(){
8aac22c8 2645 $templateFile = $this->getHookedTemplateFileName();
6a488035
TO		 2646 return $this->_formValues['report_header'] . CRM_Core_Form::$_template->fetch($templateFile) . $this->_formValues['report_footer'];
2647 }
2648
2649
2650 function postProcess() {
2651 // get ready with post process params
2652 $this->beginPostProcess();
2653
2654 // build query
2655 $sql = $this->buildQuery();
2656
2657 // build array of result based on column headers. This method also allows
2658 // modifying column headers before using it to build result set i.e $rows.
2659 $rows = array();
2660 $this->buildRows($sql, $rows);
2661
2662 // format result set.
2663 $this->formatDisplay($rows);
2664
2665 // assign variables to templates
2666 $this->doTemplateAssignment($rows);
2667
2668 // do print / pdf / instance stuff if needed
2669 $this->endPostProcess($rows);
2670 }
2671
2672 function limit($rowCount = self::ROW_COUNT_LIMIT) {
2673 // lets do the pager if in html mode
2674 $this->_limit = NULL;
2675 if ($this->_outputMode == 'html' || $this->_outputMode == 'group') {
2676 $this->_select = str_ireplace('SELECT ', 'SELECT SQL_CALC_FOUND_ROWS ', $this->_select);
2677
2678 $pageId = CRM_Utils_Request::retrieve('crmPID', 'Integer', CRM_Core_DAO::$_nullObject);
2679
2680 if (!$pageId && !empty($_POST)) {
2681 if (isset($_POST['PagerBottomButton']) && isset($_POST['crmPID_B'])) {
2682 $pageId = max((int)@$_POST['crmPID_B'], 1);
2683 }
2684 elseif (isset($_POST['PagerTopButton']) && isset($_POST['crmPID'])) {
2685 $pageId = max((int)@$_POST['crmPID'], 1);
2686 }
2687 unset($_POST['crmPID_B'], $_POST['crmPID']);
2688 }
2689
2690 $pageId = $pageId ? $pageId : 1;
2691 $this->set(CRM_Utils_Pager::PAGE_ID, $pageId);
2692 $offset = ($pageId - 1) * $rowCount;
2693
bf00d1b6
DL		 2694 $offset = CRM_Utils_Type::escape($offset, 'Int');
2695 $rowCount = CRM_Utils_Type::escape($rowCount, 'Int');
2696
dd3a4117 2697 $this->_limit = " LIMIT $offset, $rowCount";
6a488035
TO		 2698 return array($offset, $rowCount);
2699 }
6f900755
E		 2700 if($this->_limitValue) {
2701 if($this->_offsetValue) {
2702 $this->_limit = " LIMIT {$this->_offsetValue}, {$this->_limitValue} ";
2703 }
2704 else {
2705 $this->_limit = " LIMIT " . $this->_limitValue;
2706 }
2707 }
6a488035
TO		 2708 }
2709
2710 function setPager($rowCount = self::ROW_COUNT_LIMIT) {
2711 if ($this->_limit && ($this->_limit != '')) {
2712 $sql = "SELECT FOUND_ROWS();";
2713 $this->_rowsFound = CRM_Core_DAO::singleValueQuery($sql);
2714 $params = array(
2715 'total' => $this->_rowsFound,
2716 'rowCount' => $rowCount,
2717 'status' => ts('Records') . ' %%StatusMessage%%',
2718 'buttonBottom' => 'PagerBottomButton',
2719 'buttonTop' => 'PagerTopButton',
2720 'pageID' => $this->get(CRM_Utils_Pager::PAGE_ID),
2721 );
2722
2723 $pager = new CRM_Utils_Pager($params);
2724 $this->assign_by_ref('pager', $pager);
ecc20f0e 2725 $this->ajaxResponse['totalRows'] = $this->_rowsFound;
6a488035
TO		 2726 }
2727 }
2728
2729 function whereGroupClause($field, $value, $op) {
2730
2731 $smartGroupQuery = "";
2732
2733 $group = new CRM_Contact_DAO_Group();
2734 $group->is_active = 1;
2735 $group->find();
2736 $smartGroups = array();
2737 while ($group->fetch()) {
2738 if (in_array($group->id, $this->_params['gid_value']) && $group->saved_search_id) {
2739 $smartGroups[] = $group->id;
2740 }
2741 }
2742
2743 CRM_Contact_BAO_GroupContactCache::check($smartGroups);
2744
2745 $smartGroupQuery = '';
2746 if (!empty($smartGroups)) {
2747 $smartGroups = implode(',', $smartGroups);
2748 $smartGroupQuery = " UNION DISTINCT
2749 SELECT DISTINCT smartgroup_contact.contact_id
2750 FROM civicrm_group_contact_cache smartgroup_contact
2751 WHERE smartgroup_contact.group_id IN ({$smartGroups}) ";
2752 }
2753
29fc2b79 2754 $sqlOp = $this->getSQLOperator($op);
6a488035
TO		 2755 if (!is_array($value)) {
2756 $value = array($value);
2757 }
2758 $clause = "{$field['dbAlias']} IN (" . implode(', ', $value) . ")";
2759
2760 return " {$this->_aliases['civicrm_contact']}.id {$sqlOp} (
2761 SELECT DISTINCT {$this->_aliases['civicrm_group']}.contact_id
2762 FROM civicrm_group_contact {$this->_aliases['civicrm_group']}
2763 WHERE {$clause} AND {$this->_aliases['civicrm_group']}.status = 'Added'
2764 {$smartGroupQuery} ) ";
2765 }
2766
2767 function whereTagClause($field, $value, $op) {
2768 // not using left join in query because if any contact
2769 // belongs to more than one tag, results duplicate
2770 // entries.
29fc2b79 2771 $sqlOp = $this->getSQLOperator($op);
6a488035
TO		 2772 if (!is_array($value)) {
2773 $value = array($value);
2774 }
2775 $clause = "{$field['dbAlias']} IN (" . implode(', ', $value) . ")";
2776
2777 return " {$this->_aliases['civicrm_contact']}.id {$sqlOp} (
2778 SELECT DISTINCT {$this->_aliases['civicrm_tag']}.entity_id
2779 FROM civicrm_entity_tag {$this->_aliases['civicrm_tag']}
2780 WHERE entity_table = 'civicrm_contact' AND {$clause} ) ";
2781 }
2782
2783 function buildACLClause($tableAlias = 'contact_a') {
2784 list($this->_aclFrom, $this->_aclWhere) = CRM_Contact_BAO_Contact_Permission::cacheClause($tableAlias);
2785 }
2786
2787 function addCustomDataToColumns($addFields = TRUE, $permCustomGroupIds = array()) {
2788 if (empty($this->_customGroupExtends)) {
2789 return;
2790 }
2791 if (!is_array($this->_customGroupExtends)) {
2792 $this->_customGroupExtends = array($this->_customGroupExtends);
2793 }
2794 $customGroupWhere = '';
2795 if (!empty($permCustomGroupIds)) {
2796 $customGroupWhere = "cg.id IN (".implode(',' , $permCustomGroupIds).") AND";
2797 }
2798 $sql = "
2799SELECT cg.table_name, cg.title, cg.extends, cf.id as cf_id, cf.label,
2800 cf.column_name, cf.data_type, cf.html_type, cf.option_group_id, cf.time_format
2801FROM civicrm_custom_group cg
2802INNER JOIN civicrm_custom_field cf ON cg.id = cf.custom_group_id
2803WHERE cg.extends IN ('" . implode("','", $this->_customGroupExtends) . "') AND
2804 {$customGroupWhere}
2805 cg.is_active = 1 AND
2806 cf.is_active = 1 AND
2807 cf.is_searchable = 1
2808ORDER BY cg.weight, cf.weight";
2809 $customDAO = CRM_Core_DAO::executeQuery($sql);
2810
2811 $curTable = NULL;
2812 while ($customDAO->fetch()) {
2813 if ($customDAO->table_name != $curTable) {
2814 $curTable = $customDAO->table_name;
2815 $curFields = $curFilters = array();
2816
2817 // dummy dao object
2818 $this->_columns[$curTable]['dao'] = 'CRM_Contact_DAO_Contact';
2819 $this->_columns[$curTable]['extends'] = $customDAO->extends;
2820 $this->_columns[$curTable]['grouping'] = $customDAO->table_name;
2821 $this->_columns[$curTable]['group_title'] = $customDAO->title;
2822
2823 foreach (array(
2824 'fields', 'filters', 'group_bys') as $colKey) {
2825 if (!array_key_exists($colKey, $this->_columns[$curTable])) {
2826 $this->_columns[$curTable][$colKey] = array();
2827 }
2828 }
2829 }
2830 $fieldName = 'custom_' . $customDAO->cf_id;
2831
2832 if ($addFields) {
2833 // this makes aliasing work in favor
2834 $curFields[$fieldName] = array(
2835 'name' => $customDAO->column_name,
2836 'title' => $customDAO->label,
2837 'dataType' => $customDAO->data_type,
2838 'htmlType' => $customDAO->html_type,
2839 );
2840 }
2841 if ($this->_customGroupFilters) {
2842 // this makes aliasing work in favor
2843 $curFilters[$fieldName] = array(
2844 'name' => $customDAO->column_name,
2845 'title' => $customDAO->label,
2846 'dataType' => $customDAO->data_type,
2847 'htmlType' => $customDAO->html_type,
2848 );
2849 }
2850
2851 switch ($customDAO->data_type) {
2852 case 'Date':
2853 // filters
2854 $curFilters[$fieldName]['operatorType'] = CRM_Report_Form::OP_DATE;
2855 $curFilters[$fieldName]['type'] = CRM_Utils_Type::T_DATE;
2856 // CRM-6946, show time part for datetime date fields
2857 if ($customDAO->time_format) {
2858 $curFields[$fieldName]['type'] = CRM_Utils_Type::T_TIMESTAMP;
2859 }
2860 break;
2861
2862 case 'Boolean':
2863 $curFilters[$fieldName]['operatorType'] = CRM_Report_Form::OP_SELECT;
2864 $curFilters[$fieldName]['options'] = array('' => ts('- select -'),
2865 1 => ts('Yes'),
2866 0 => ts('No'),
2867 );
2868 $curFilters[$fieldName]['type'] = CRM_Utils_Type::T_INT;
2869 break;
2870
2871 case 'Int':
2872 $curFilters[$fieldName]['operatorType'] = CRM_Report_Form::OP_INT;
2873 $curFilters[$fieldName]['type'] = CRM_Utils_Type::T_INT;
2874 break;
2875
2876 case 'Money':
2877 $curFilters[$fieldName]['operatorType'] = CRM_Report_Form::OP_FLOAT;
2878 $curFilters[$fieldName]['type'] = CRM_Utils_Type::T_MONEY;
2879 break;
2880
2881 case 'Float':
2882 $curFilters[$fieldName]['operatorType'] = CRM_Report_Form::OP_FLOAT;
2883 $curFilters[$fieldName]['type'] = CRM_Utils_Type::T_FLOAT;
2884 break;
2885
2886 case 'String':
2887 $curFilters[$fieldName]['type'] = CRM_Utils_Type::T_STRING;
2888
2889 if (!empty($customDAO->option_group_id)) {
2890 if (in_array($customDAO->html_type, array(
2891 'Multi-Select', 'AdvMulti-Select', 'CheckBox'))) {
2892 $curFilters[$fieldName]['operatorType'] = CRM_Report_Form::OP_MULTISELECT_SEPARATOR;
2893 }
2894 else {
2895 $curFilters[$fieldName]['operatorType'] = CRM_Report_Form::OP_MULTISELECT;
2896 }
2897 if ($this->_customGroupFilters) {
2898 $curFilters[$fieldName]['options'] = array();
2899 $ogDAO = CRM_Core_DAO::executeQuery("SELECT ov.value, ov.label FROM civicrm_option_value ov WHERE ov.option_group_id = %1 ORDER BY ov.weight", array(1 => array($customDAO->option_group_id, 'Integer')));
2900 while ($ogDAO->fetch()) {
2901 $curFilters[$fieldName]['options'][$ogDAO->value] = $ogDAO->label;
2902 }
2903 }
2904 }
2905 break;
2906
2907 case 'StateProvince':
2908 if (in_array($customDAO->html_type, array(
2909 'Multi-Select State/Province'))) {
2910 $curFilters[$fieldName]['operatorType'] = CRM_Report_Form::OP_MULTISELECT_SEPARATOR;
2911 }
2912 else {
2913 $curFilters[$fieldName]['operatorType'] = CRM_Report_Form::OP_MULTISELECT;
2914 }
2915 $curFilters[$fieldName]['options'] = CRM_Core_PseudoConstant::stateProvince();
2916 break;
2917
2918 case 'Country':
2919 if (in_array($customDAO->html_type, array(
2920 'Multi-Select Country'))) {
2921 $curFilters[$fieldName]['operatorType'] = CRM_Report_Form::OP_MULTISELECT_SEPARATOR;
2922 }
2923 else {
2924 $curFilters[$fieldName]['operatorType'] = CRM_Report_Form::OP_MULTISELECT;
2925 }
2926 $curFilters[$fieldName]['options'] = CRM_Core_PseudoConstant::country();
2927 break;
2928
2929 case 'ContactReference':
2930 $curFilters[$fieldName]['type'] = CRM_Utils_Type::T_STRING;
2931 $curFilters[$fieldName]['name'] = 'display_name';
2932 $curFilters[$fieldName]['alias'] = "contact_{$fieldName}_civireport";
2933
2934 $curFields[$fieldName]['type'] = CRM_Utils_Type::T_STRING;
2935 $curFields[$fieldName]['name'] = 'display_name';
2936 $curFields[$fieldName]['alias'] = "contact_{$fieldName}_civireport";
2937 break;
2938
2939 default:
2940 $curFields[$fieldName]['type'] = CRM_Utils_Type::T_STRING;
2941 $curFilters[$fieldName]['type'] = CRM_Utils_Type::T_STRING;
2942 }
2943
2944 if (!array_key_exists('type', $curFields[$fieldName])) {
fc161185 2945 $curFields[$fieldName]['type'] = CRM_Utils_Array::value('type', $curFilters[$fieldName], array());
6a488035
TO		 2946 }
2947
2948 if ($addFields) {
2949 $this->_columns[$curTable]['fields'] = array_merge($this->_columns[$curTable]['fields'], $curFields);
2950 }
2951 if ($this->_customGroupFilters) {
2952 $this->_columns[$curTable]['filters'] = array_merge($this->_columns[$curTable]['filters'], $curFilters);
2953 }
2954 if ($this->_customGroupGroupBy) {
2955 $this->_columns[$curTable]['group_bys'] = array_merge($this->_columns[$curTable]['group_bys'], $curFields);
2956 }
2957 }
2958 }
2959
2960 function customDataFrom() {
2961 if (empty($this->_customGroupExtends)) {
2962 return;
2963 }
2964 $mapper = CRM_Core_BAO_CustomQuery::$extendsMap;
2965
2966 foreach ($this->_columns as $table => $prop) {
2967 if (substr($table, 0, 13) == 'civicrm_value' || substr($table, 0, 12) == 'custom_value') {
2968 $extendsTable = $mapper[$prop['extends']];
2969
2970 // check field is in params
2971 if (!$this->isFieldSelected($prop)) {
2972 continue;
2973 }
4c9d78ea 2974 $baseJoin = CRM_Utils_Array::value($prop['extends'], $this->_customGroupExtendsJoin, "{$this->_aliases[$extendsTable]}.id");
6a488035 2975
7a8b61ab 2976 $customJoin = is_array($this->_customGroupJoin) ? $this->_customGroupJoin[$table] : $this->_customGroupJoin;
6a488035 2977 $this->_from .= "
aa1aa08e 2978{$customJoin} {$table} {$this->_aliases[$table]} ON {$this->_aliases[$table]}.entity_id = {$baseJoin}";
6a488035
TO		 2979 // handle for ContactReference
2980 if (array_key_exists('fields', $prop)) {
2981 foreach ($prop['fields'] as $fieldName => $field) {
2982 if (CRM_Utils_Array::value('dataType', $field) == 'ContactReference') {
2983 $columnName = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_CustomField', CRM_Core_BAO_CustomField::getKeyID($fieldName), 'column_name');
2984 $this->_from .= "
2985LEFT JOIN civicrm_contact {$field['alias']} ON {$field['alias']}.id = {$this->_aliases[$table]}.{$columnName} ";
2986 }
2987 }
2988 }
2989 }
2990 }
2991 }
2992
2993 function isFieldSelected($prop) {
2994 if (empty($prop)) {
2995 return FALSE;
2996 }
2997
2998 if (!empty($this->_params['fields'])) {
2999 foreach (array_keys($prop['fields']) as $fieldAlias) {
3000 $customFieldId = CRM_Core_BAO_CustomField::getKeyID($fieldAlias);
3001 if ($customFieldId) {
3002 if (array_key_exists($fieldAlias, $this->_params['fields'])) {
3003 return TRUE;
3004 }
3005
3006 //might be survey response field.
8cc574cf 3007 if (!empty($this->_params['fields']['survey_response']) && !empty($prop['fields'][$fieldAlias]['isSurveyResponseField'])) {
6a488035
TO		 3008 return TRUE;
3009 }
3010 }
3011 }
3012 }
3013
3014 if (!empty($this->_params['group_bys']) && $this->_customGroupGroupBy) {
3015 foreach (array_keys($prop['group_bys']) as $fieldAlias) {
3016 if (array_key_exists($fieldAlias, $this->_params['group_bys']) && CRM_Core_BAO_CustomField::getKeyID($fieldAlias)) {
3017 return TRUE;
3018 }
3019 }
3020 }
3021
3022 if (!empty($this->_params['order_bys'])) {
3023 foreach (array_keys($prop['fields']) as $fieldAlias) {
3024 foreach ($this->_params['order_bys'] as $orderBy) {
3025 if ($fieldAlias == $orderBy['column'] && CRM_Core_BAO_CustomField::getKeyID($fieldAlias)) {
3026 return TRUE;
3027 }
3028 }
3029 }
3030 }
3031
3032 if (!empty($prop['filters']) && $this->_customGroupFilters) {
3033 foreach ($prop['filters'] as $fieldAlias => $val) {
3034 foreach (array(
3035 'value', 'min', 'max', 'relative', 'from', 'to') as $attach) {
3036 if (isset($this->_params[$fieldAlias . '_' . $attach]) &&
dfe4b2f5 3037 (!empty($this->_params[$fieldAlias . '_' . $attach])
3038 || ($attach != 'relative' && $this->_params[$fieldAlias . '_' . $attach] == '0')
3039 )
3040 ){
6a488035
TO		 3041 return TRUE;
3042 }
3043 }
a7488080 3044 if (!empty($this->_params[$fieldAlias . '_op']) &&
6a488035
TO		 3045 in_array($this->_params[$fieldAlias . '_op'], array('nll', 'nnll'))
3046 ) {
3047 return TRUE;
3048 }
3049 }
3050 }
3051
3052 return FALSE;
3053 }
3054
3055 /**
3056 * Check for empty order_by configurations and remove them; also set
3057 * template to hide them.
3058 */
3059 function preProcessOrderBy(&$formValues) {
3060 // Object to show/hide form elements
ae555e90 3061 $_showHide = new CRM_Core_ShowHideBlocks('', '');
6a488035
TO		 3062
3063 $_showHide->addShow('optionField_1');
3064
3065 // Cycle through order_by options; skip any empty ones, and hide them as well
3066 $n = 1;
3067
3068 if (!empty($formValues['order_bys'])) {
3069 foreach ($formValues['order_bys'] as $order_by) {
3070 if ($order_by['column'] && $order_by['column'] != '-') {
3071 $_showHide->addShow('optionField_' . $n);
3072 $orderBys[$n] = $order_by;
3073 $n++;
3074 }
3075 }
3076 }
3077 for ($i = $n; $i <= 5; $i++) {
3078 if ($i > 1) {
3079 $_showHide->addHide('optionField_' . $i);
3080 }
3081 }
3082
3083 // overwrite order_by options with modified values
3084 if (!empty($orderBys)) {
3085 $formValues['order_bys'] = $orderBys;
3086 }
3087 else {
3088 $formValues['order_bys'] = array(1 => array('column' => '-'));
3089 }
3090
3091 // assign show/hide data to template
3092 $_showHide->addToTemplate();
3093 }
3094
3095 /**
3096 * Does table name have columns in SELECT clause?
3097 *
3098 * @param string $tableName Name of table (index of $this->_columns array)
3099 *
3100 * @return bool
3101 */
3102 function isTableSelected($tableName) {
3103 return in_array($tableName, $this->selectedTables());
3104 }
3105
3106 /**
3107 * Fetch array of DAO tables having columns included in SELECT or ORDER BY clause
3108 * (building the array if it's unset)
3109 *
3110 * @return Array $this->_selectedTables
3111 */
3112 function selectedTables() {
3113 if (!$this->_selectedTables) {
3114 $orderByColumns = array();
7a8b61ab 3115 if (array_key_exists('order_bys', $this->_params) && is_array($this->_params['order_bys'])) {
6a488035
TO		 3116 foreach ($this->_params['order_bys'] as $orderBy) {
3117 $orderByColumns[] = $orderBy['column'];
3118 }
3119 }
3120
3121 foreach ($this->_columns as $tableName => $table) {
3122 if (array_key_exists('fields', $table)) {
3123 foreach ($table['fields'] as $fieldName => $field) {
8cc574cf 3124 if (!empty($field['required']) || !empty($this->_params['fields'][$fieldName])) {
6a488035
TO		 3125 $this->_selectedTables[] = $tableName;
3126 break;
3127 }
3128 }
3129 }
3130 if (array_key_exists('order_bys', $table)) {
3131 foreach ($table['order_bys'] as $orderByName => $orderBy) {
3132 if (in_array($orderByName, $orderByColumns)) {
3133 $this->_selectedTables[] = $tableName;
3134 break;
3135 }
3136 }
3137 }
3138 if (array_key_exists('filters', $table)) {
3139 foreach ($table['filters'] as $filterName => $filter) {
a7488080 3140 if (!empty($this->_params["{$filterName}_value"]) ||
6a488035
TO		 3141 CRM_Utils_Array::value("{$filterName}_op", $this->_params) == 'nll' ||
3142 CRM_Utils_Array::value("{$filterName}_op", $this->_params) == 'nnll'
3143 ) {
3144 $this->_selectedTables[] = $tableName;
3145 break;
3146 }
3147 }
3148 }
3149 }
3150 }
3151 return $this->_selectedTables;
3152 }
3153
850e4640
E		 3154 /**
3155 * @deprecated - use getAddressColumns which is a more accurate description
3156 * and also accepts an array of options rather than a long list
3157 *
6a488035
TO		 3158 * function for adding address fields to construct function in reports
3159 * @param bool $groupBy Add GroupBy? Not appropriate for detail report
3160 * @param bool $orderBy Add GroupBy? Not appropriate for detail report
3161 * @return array address fields for construct clause
3162 */
3163 function addAddressFields($groupBy = TRUE, $orderBy = FALSE, $filters = TRUE, $defaults = array(
3164 'country_id' => TRUE)) {
3165 $addressFields = array(
3166 'civicrm_address' =>
3167 array(
3168 'dao' => 'CRM_Core_DAO_Address',
3169 'fields' =>
3170 array(
3171 'name' =>
3172 array('title' => ts('Address Name'),
3173 'default' => CRM_Utils_Array::value('name', $defaults, FALSE),
3174 ),
3175 'street_address' =>
3176 array('title' => ts('Street Address'),
3177 'default' => CRM_Utils_Array::value('street_address', $defaults, FALSE),
3178 ),
3179 'supplemental_address_1' =>
3180 array('title' => ts('Supplementary Address Field 1'),
3181 'default' => CRM_Utils_Array::value('supplemental_address_1', $defaults, FALSE),
3182 ),
3183 'supplemental_address_2' =>
3184 array('title' => ts('Supplementary Address Field 2'),
3185 'default' => CRM_Utils_Array::value('supplemental_address_2', $defaults, FALSE),
3186 ),
3187 'street_number' =>
3188 array(
3189 'name' => 'street_number',
3190 'title' => ts('Street Number'),
3191 'type' => 1,
3192 'default' => CRM_Utils_Array::value('street_number', $defaults, FALSE),
3193 ),
3194 'street_name' =>
3195 array(
3196 'name' => 'street_name',
3197 'title' => ts('Street Name'),
3198 'type' => 1,
3199 'default' => CRM_Utils_Array::value('street_name', $defaults, FALSE),
3200 ),
3201 'street_unit' =>
3202 array(
3203 'name' => 'street_unit',
3204 'title' => ts('Street Unit'),
3205 'type' => 1,
3206 'default' => CRM_Utils_Array::value('street_unit', $defaults, FALSE),
3207 ),
3208 'city' =>
3209 array('title' => ts('City'),
3210 'default' => CRM_Utils_Array::value('city', $defaults, FALSE),
3211 ),
3212 'postal_code' =>
3213 array('title' => ts('Postal Code'),
3214 'default' => CRM_Utils_Array::value('postal_code', $defaults, FALSE),
4cbdd2b1
JL		 3215 ),
3216 'postal_code_suffix' =>
3217 array('title' => ts('Postal Code Suffix'),
3218 'default' => CRM_Utils_Array::value('postal_code_suffix', $defaults, FALSE),
6a488035
TO		 3219 ),
3220 'county_id' =>
3221 array('title' => ts('County'),
3222 'default' => CRM_Utils_Array::value('county_id', $defaults, FALSE),
3223 ),
3224 'state_province_id' =>
3225 array('title' => ts('State/Province'),
3226 'default' => CRM_Utils_Array::value('state_province_id', $defaults, FALSE),
3227 ),
3228 'country_id' =>
3229 array('title' => ts('Country'),
3230 'default' => CRM_Utils_Array::value('country_id', $defaults, FALSE),
3231 ),
3232 ),
3233 'grouping' => 'location-fields',
3234 ),
3235 );
3236
3237 if ($filters) {
3238 $addressFields['civicrm_address']['filters'] = array(
3239 'street_number' => array('title' => ts('Street Number'),
3240 'type' => 1,
3241 'name' => 'street_number',
3242 ),
3243 'street_name' => array('title' => ts('Street Name'),
3244 'name' => 'street_name',
3245 'operator' => 'like',
3246 ),
3247 'postal_code' => array('title' => ts('Postal Code'),
3248 'type' => 1,
3249 'name' => 'postal_code',
3250 ),
3251 'city' => array('title' => ts('City'),
3252 'operator' => 'like',
3253 'name' => 'city',
3254 ),
3255 'county_id' => array(
3256 'name' => 'county_id',
3257 'title' => ts('County'),
3258 'type' => CRM_Utils_Type::T_INT,
3259 'operatorType' =>
3260 CRM_Report_Form::OP_MULTISELECT,
3261 'options' =>
3262 CRM_Core_PseudoConstant::county(),
3263 ),
3264 'state_province_id' => array(
3265 'name' => 'state_province_id',
3266 'title' => ts('State/Province'),
3267 'type' => CRM_Utils_Type::T_INT,
3268 'operatorType' =>
3269 CRM_Report_Form::OP_MULTISELECT,
3270 'options' =>
3271 CRM_Core_PseudoConstant::stateProvince(),
3272 ),
3273 'country_id' => array(
3274 'name' => 'country_id',
3275 'title' => ts('Country'),
3276 'type' => CRM_Utils_Type::T_INT,
3277 'operatorType' =>
3278 CRM_Report_Form::OP_MULTISELECT,
3279 'options' =>
3280 CRM_Core_PseudoConstant::country(),
3281 ),
3282 );
3283 }
3284
3285 if ($orderBy) {
3286 $addressFields['civicrm_address']['order_bys'] = array('street_name' => array('title' => ts('Street Name')),
3287 'street_number' => array('title' => 'Odd / Even Street Number'),
3288 'street_address' => NULL,
3289 'city' => NULL,
3290 'postal_code' => NULL,
3291 );
3292 }
3293
3294 if ($groupBy) {
3295 $addressFields['civicrm_address']['group_bys'] = array(
3296 'street_address' => NULL,
3297 'city' => NULL,
3298 'postal_code' => NULL,
3299 'state_province_id' =>
3300 array('title' => ts('State/Province'),
3301 ),
3302 'country_id' =>
3303 array('title' => ts('Country'),
3304 ),
3305 'county_id' =>
3306 array('title' => ts('County'),
3307 ),
3308 );
3309 }
3310 return $addressFields;
3311 }
3312
3313 /*
3314 * Do AlterDisplay processing on Address Fields
3315 */
3316 function alterDisplayAddressFields(&$row, &$rows, &$rowNum, $baseUrl, $urltxt) {
3317 $criteriaQueryParams = CRM_Report_Utils_Report::getPreviewCriteriaQueryParams($this->_defaults, $this->_params);
3318 $entryFound = FALSE;
3319 // handle country
3320 if (array_key_exists('civicrm_address_country_id', $row)) {
3321 if ($value = $row['civicrm_address_country_id']) {
3322 $rows[$rowNum]['civicrm_address_country_id'] = CRM_Core_PseudoConstant::country($value, FALSE);
3323 $url = CRM_Report_Utils_Report::getNextUrl($baseUrl,
3324 "reset=1&force=1&{$criteriaQueryParams}&" .
3325 "country_id_op=in&country_id_value={$value}",
3326 $this->_absoluteUrl, $this->_id
3327 );
3328 $rows[$rowNum]['civicrm_address_country_id_link'] = $url;
3329 $rows[$rowNum]['civicrm_address_country_id_hover'] = ts("%1 for this country.",
3330 array(1 => $urltxt)
3331 );
3332 }
3333
3334 $entryFound = TRUE;
3335 }
3336 if (array_key_exists('civicrm_address_county_id', $row)) {
3337 if ($value = $row['civicrm_address_county_id']) {
3338 $rows[$rowNum]['civicrm_address_county_id'] = CRM_Core_PseudoConstant::county($value, FALSE);
3339 $url = CRM_Report_Utils_Report::getNextUrl($baseUrl,
3340 "reset=1&force=1&{$criteriaQueryParams}&" .
3341 "county_id_op=in&county_id_value={$value}",
3342 $this->_absoluteUrl, $this->_id
3343 );
3344 $rows[$rowNum]['civicrm_address_county_id_link'] = $url;
3345 $rows[$rowNum]['civicrm_address_county_id_hover'] = ts("%1 for this county.",
3346 array(1 => $urltxt)
3347 );
3348 }
3349 $entryFound = TRUE;
3350 }
3351 // handle state province
3352 if (array_key_exists('civicrm_address_state_province_id', $row)) {
3353 if ($value = $row['civicrm_address_state_province_id']) {
3354 $rows[$rowNum]['civicrm_address_state_province_id'] = CRM_Core_PseudoConstant::stateProvince($value, FALSE);
3355
3356 $url = CRM_Report_Utils_Report::getNextUrl($baseUrl,
3357 "reset=1&force=1&{$criteriaQueryParams}&state_province_id_op=in&state_province_id_value={$value}",
3358 $this->_absoluteUrl, $this->_id
3359 );
3360 $rows[$rowNum]['civicrm_address_state_province_id_link'] = $url;
3361 $rows[$rowNum]['civicrm_address_state_province_id_hover'] = ts("%1 for this state.",
3362 array(1 => $urltxt)
3363 );
3364 }
3365 $entryFound = TRUE;
3366 }
3367
3368 return $entryFound;
3369 }
3370
3371 /*
3372 * Adjusts dates passed in to YEAR() for fiscal year.
3373 */
3374 function fiscalYearOffset($fieldName) {
3375 $config = CRM_Core_Config::singleton();
3376 $fy = $config->fiscalYearStart;
3377 if (CRM_Utils_Array::value('yid_op', $this->_params) == 'calendar' || ($fy['d'] == 1 && $fy['M'] == 1)) {
3378 return "YEAR( $fieldName )";
3379 }
3380 return "YEAR( $fieldName - INTERVAL " . ($fy['M'] - 1) . " MONTH" . ($fy['d'] > 1 ? (" - INTERVAL " . ($fy['d'] - 1) . " DAY") : '') . " )";
3381 }
3382
3383 /*
3384 * Add Address into From Table if required
3385 */
3386 function addAddressFromClause() {
3387 // include address field if address column is to be included
3388 if ((isset($this->_addressField) &&
3389 $this->_addressField
3390 ) ||
3391 $this->isTableSelected('civicrm_address')
3392 ) {
3393 $this->_from .= "
3394 LEFT JOIN civicrm_address {$this->_aliases['civicrm_address']}
3395 ON ({$this->_aliases['civicrm_contact']}.id =
3396 {$this->_aliases['civicrm_address']}.contact_id) AND
3397 {$this->_aliases['civicrm_address']}.is_primary = 1\n";
3398 }
3399 }
3400
850e4640
E		 3401 /**
3402 * Add Phone into From Table if required
3403 */
3404 function addPhoneFromClause() {
3405 // include address field if address column is to be included
3406 if ($this->isTableSelected('civicrm_phone')
3407 ) {
3408 $this->_from .= "
3409 LEFT JOIN civicrm_phone {$this->_aliases['civicrm_phone']}
3410 ON ({$this->_aliases['civicrm_contact']}.id =
3411 {$this->_aliases['civicrm_phone']}.contact_id) AND
3412 {$this->_aliases['civicrm_phone']}.is_primary = 1\n";
3413 }
3414 }
3415
3416 /**
3417 * Get phone columns to add to array
3418 * @param array $options
3419 * - prefix Prefix to add to table (in case of more than one instance of the table)
3420 * - prefix_label Label to give columns from this phone table instance
3421 * @return array phone columns definition
3422 */
3423 function getPhoneColumns($options = array()){
3424 $defaultOptions = array(
3425 'prefix' => '',
3426 'prefix_label' => '',
3427 );
3428
3429 $options = array_merge($defaultOptions,$options);
3430
3431 $fields = array(
3432 $options['prefix'] . 'civicrm_phone' => array(
3433 'dao' => 'CRM_Core_DAO_Phone',
3434 'fields' => array(
3435 $options['prefix'] . 'phone' => array(
3436 'title' => ts($options['prefix_label'] . 'Phone'),
3437 'name' => 'phone'
3438 ),
3439 ),
3440 ),
3441 );
3442 return $fields;
3443 }
3444
3445 /**
3446 * Get address columns to add to array
3447 * @param array $options
3448 * - prefix Prefix to add to table (in case of more than one instance of the table)
3449 * - prefix_label Label to give columns from this address table instance
3450 * @return array address columns definition
3451 */
3452 function getAddressColumns($options = array()){
3453 $defaultOptions = array(
3454 'prefix' => '',
3455 'prefix_label' => '',
3456 'group_by' => TRUE,
3457 'order_by' => TRUE,
3458 'filters' => TRUE,
3459 'defaults' => array(
3460 ),
3461 );
3462 $options = array_merge($defaultOptions,$options);
3463 return $this->addAddressFields(
3464 $options['group_by'],
3465 $options['order_by'],
3466 $options['filters'],
3467 $options['defaults']
3468 );
3469
3470 }
3471
6a488035
TO		 3472 function add2group($groupID) {
3473 if (is_numeric($groupID) && isset($this->_aliases['civicrm_contact'])) {
3474 $select = "SELECT DISTINCT {$this->_aliases['civicrm_contact']}.id AS addtogroup_contact_id, ";
3475 $select = str_ireplace('SELECT SQL_CALC_FOUND_ROWS ', $select, $this->_select);
3476
3477 $sql = "{$select} {$this->_from} {$this->_where} {$this->_groupBy} {$this->_having} {$this->_orderBy}";
3478 $dao = CRM_Core_DAO::executeQuery($sql);
3479
3480 $contact_ids = array();
3481 // Add resulting contacts to group
3482 while ($dao->fetch()) {
3483 if ($dao->addtogroup_contact_id) {
3484 $contact_ids[$dao->addtogroup_contact_id] = $dao->addtogroup_contact_id;
3485 }
3486 }
3487
3488 if ( !empty($contact_ids) ) {
3489 CRM_Contact_BAO_GroupContact::addContactsToGroup($contact_ids, $groupID);
3490 CRM_Core_Session::setStatus(ts("Listed contact(s) have been added to the selected group."), ts('Contacts Added'), 'success');
3491 }
3492 else {
3493 CRM_Core_Session::setStatus(ts("The listed records(s) cannot be added to the group."));
3494 }
3495 }
3496 }
46065582
PJ		 3497
3498 /* function used for showing charts on print screen */
3499 static function uploadChartImage() {
3500 // upload strictly for '.png' images
d04d4eef
PJ		 3501 $name = trim(basename(CRM_Utils_Request::retrieve('name', 'String', CRM_Core_DAO::$_nullObject, FALSE, NULL, 'GET')));
3502 if (preg_match('/\.png$/', $name)) {
46065582
PJ		 3503 //
3504 // POST data is usually string data, but we are passing a RAW .png
3505 // so PHP is a bit confused and $_POST is empty. But it has saved
3506 // the raw bits into $HTTP_RAW_POST_DATA
3507 //
3508 $httpRawPostData = $GLOBALS['HTTP_RAW_POST_DATA'];
3509
3510 // prepare the directory
3511 $config = CRM_Core_Config::singleton();
3512 $defaultPath = str_replace('/persist/contribute/' , '/persist/', $config->imageUploadDir) . '/openFlashChart/';
3513 if (!file_exists($defaultPath)) {
3514 mkdir($defaultPath, 0777, TRUE);
3515 }
3516
3517 // full path to the saved image including filename
d04d4eef 3518 $destination = $defaultPath . $name;
46065582
PJ		 3519
3520 //write and save
3521 $jfh = fopen($destination, 'w') or die("can't open file");
3522 fwrite($jfh, $httpRawPostData);
3523 fclose($jfh);
3524 CRM_Utils_System::civiExit();
3525 }
3526 }
232624b1 3527}