projects / civicrm-core.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
replaced removed HTTP_RAW_POST_DATA with php input stream
[civicrm-core.git] / CRM / Report / Form.php
1 <?php
2 /*
3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2016 |
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 * Class CRM_Report_Form
30 */
31 class CRM_Report_Form extends CRM_Core_Form {
32 const ROW_COUNT_LIMIT = 50;
33
34 /**
35 * Operator types - used for displaying filter elements
36 */
37 const
38 OP_INT = 1,
39 OP_STRING = 2,
40 OP_DATE = 4,
41 OP_DATETIME = 5,
42 OP_FLOAT = 8,
43 OP_SELECT = 64,
44 OP_MULTISELECT = 65,
45 OP_MULTISELECT_SEPARATOR = 66,
46 OP_MONTH = 128,
47 OP_ENTITYREF = 256;
48
49 /**
50 * The id of the report instance
51 *
52 * @var integer
53 */
54 protected $_id;
55
56 /**
57 * The id of the report template
58 *
59 * @var integer;
60 */
61 protected $_templateID;
62
63 /**
64 * The report title
65 *
66 * @var string
67 */
68 protected $_title;
69 protected $_noFields = FALSE;
70
71 /**
72 * The set of all columns in the report. An associative array
73 * with column name as the key and attributes as the value
74 *
75 * @var array
76 */
77 protected $_columns = array();
78
79 /**
80 * The set of filters in the report
81 *
82 * @var array
83 */
84 protected $_filters = array();
85
86 /**
87 * The set of optional columns in the report
88 *
89 * @var array
90 */
91 protected $_options = array();
92
93 /**
94 * By default most reports hide contact id.
95 * Setting this to true makes it available
96 */
97 protected $_exposeContactID = TRUE;
98
99 /**
100 * Set of statistic fields
101 *
102 * @var array
103 */
104 protected $_statFields = array();
105
106 /**
107 * Set of statistics data
108 *
109 * @var array
110 */
111 protected $_statistics = array();
112
113 /**
114 * List of fields not to be repeated during display
115 *
116 * @var array
117 */
118 protected $_noRepeats = array();
119
120 /**
121 * List of fields not to be displayed
122 *
123 * @var array
124 */
125 protected $_noDisplay = array();
126
127 /**
128 * Object type that a custom group extends
129 *
130 * @var null
131 */
132 protected $_customGroupExtends = NULL;
133 protected $_customGroupExtendsJoin = array();
134 protected $_customGroupFilters = TRUE;
135 protected $_customGroupGroupBy = FALSE;
136 protected $_customGroupJoin = 'LEFT JOIN';
137
138 /**
139 * Build tags filter
140 */
141 protected $_tagFilter = FALSE;
142
143 /**
144 * specify entity table for tags filter
145 */
146 protected $_tagFilterTable = 'civicrm_contact';
147
148 /**
149 * Build groups filter.
150 *
151 * @var bool
152 */
153 protected $_groupFilter = FALSE;
154
155 /**
156 * Has the report been optimised for group filtering.
157 *
158 * The functionality for group filtering has been improved but not
159 * all reports have been adjusted to take care of it.
160 *
161 * This property exists to highlight the reports which are still using the
162 * slow method & allow group filtering to still work for them until they
163 * can be migrated.
164 *
165 * In order to protect extensions we have to default to TRUE - but I have
166 * separately marked every class with a groupFilter in the hope that will trigger
167 * people to fix them as they touch them.
168 *
169 * CRM-19170
170 *
171 * @var bool
172 */
173 protected $groupFilterNotOptimised = TRUE;
174
175 /**
176 * Navigation fields
177 *
178 * @var array
179 */
180 public $_navigation = array();
181
182 public $_drilldownReport = array();
183
184 /**
185 * Array of tabs to display on report.
186 *
187 * E.g we define the tab title, the tpl and the tab-specific part of the css or html link.
188 *
189 * $this->tabs['OrderBy'] = array(
190 * 'title' => ts('Sorting'),
191 * 'tpl' => 'OrderBy',
192 * 'div_label' => 'order-by',
193 * );
194 *
195 * @var array
196 */
197 protected $tabs = array();
198
199 /**
200 * Should we add paging.
201 *
202 * @var bool
203 */
204 protected $addPaging = TRUE;
205
206 /**
207 * An attribute for checkbox/radio form field layout
208 *
209 * @var array
210 */
211 protected $_fourColumnAttribute = array(
212 '</td><td width="25%">',
213 '</td><td width="25%">',
214 '</td><td width="25%">',
215 '</tr><tr><td>',
216 );
217
218 protected $_force = 1;
219
220 protected $_params = NULL;
221 protected $_formValues = NULL;
222 protected $_instanceValues = NULL;
223
224 protected $_instanceForm = FALSE;
225 protected $_criteriaForm = FALSE;
226
227 protected $_instanceButtonName = NULL;
228 protected $_createNewButtonName = NULL;
229 protected $_printButtonName = NULL;
230 protected $_pdfButtonName = NULL;
231 protected $_csvButtonName = NULL;
232 protected $_groupButtonName = NULL;
233 protected $_chartButtonName = NULL;
234 protected $_csvSupported = TRUE;
235 protected $_add2groupSupported = TRUE;
236 protected $_groups = NULL;
237 protected $_grandFlag = FALSE;
238 protected $_rowsFound = NULL;
239 protected $_selectAliases = array();
240 protected $_rollup = NULL;
241
242 /**
243 * Table containing list of contact IDs within the group filter.
244 *
245 * @var string
246 */
247 protected $groupTempTable = '';
248
249 /**
250 * @var array
251 */
252 protected $_aliases = array();
253
254 /**
255 * @var string
256 */
257 protected $_where;
258
259 /**
260 * @var string
261 */
262 protected $_from;
263
264 /**
265 * SQL Limit clause
266 * @var string
267 */
268 protected $_limit = NULL;
269
270 /**
271 * This can be set to specify a limit to the number of rows
272 * Since it is currently envisaged as part of the api usage it is only being applied
273 * when $_output mode is not 'html' or 'group' so as not to have to interpret / mess with that part
274 * of the code (see limit() fn.
275 *
276 * @var integer
277 */
278 protected $_limitValue = NULL;
279
280 /**
281 * This can be set to specify row offset
282 * See notes on _limitValue
283 * @var integer
284 */
285 protected $_offsetValue = NULL;
286 /**
287 * @var null
288 */
289 protected $_sections = NULL;
290 protected $_autoIncludeIndexedFieldsAsOrderBys = 0;
291 protected $_absoluteUrl = FALSE;
292
293 /**
294 * Flag to indicate if result-set is to be stored in a class variable which could be retrieved using getResultSet() method.
295 *
296 * @var boolean
297 */
298 protected $_storeResultSet = FALSE;
299
300 /**
301 * When _storeResultSet Flag is set use this var to store result set in form of array
302 *
303 * @var boolean
304 */
305 protected $_resultSet = array();
306
307 /**
308 * To what frequency group-by a date column
309 *
310 * @var array
311 */
312 protected $_groupByDateFreq = array(
313 'MONTH' => 'Month',
314 'YEARWEEK' => 'Week',
315 'QUARTER' => 'Quarter',
316 'YEAR' => 'Year',
317 );
318
319 /**
320 * Variables to hold the acl inner join and where clause
321 */
322 protected $_aclFrom = NULL;
323 protected $_aclWhere = NULL;
324
325 /**
326 * Array of DAO tables having columns included in SELECT or ORDER BY clause.
327 *
328 * Where has also been added to this although perhaps the 'includes both' array should have a different name.
329 *
330 * @var array
331 */
332 protected $_selectedTables;
333
334 /**
335 * Array of DAO tables having columns included in WHERE or HAVING clause
336 *
337 * @var array
338 */
339 protected $filteredTables;
340
341 /**
342 * Output mode e.g 'print', 'csv', 'pdf'.
343 *
344 * @var string
345 */
346 protected $_outputMode;
347
348 /**
349 * Format of any chart in use.
350 *
351 * (it's unclear if this could be merged with outputMode at this stage)
352 *
353 * @var
354 */
355 protected $_format;
356
357 public $_having = NULL;
358 public $_select = NULL;
359 public $_selectClauses = array();
360 public $_columnHeaders = array();
361 public $_orderBy = NULL;
362 public $_orderByFields = array();
363 public $_orderByArray = array();
364 public $_groupBy = NULL;
365 public $_whereClauses = array();
366 public $_havingClauses = array();
367
368 /**
369 * DashBoardRowCount Dashboard row count
370 * @var Integer
371 */
372 public $_dashBoardRowCount;
373
374 /**
375 * Is this being called without a form controller (ie. the report is being render outside the normal form
376 * - e.g the api is retrieving the rows
377 * @var boolean
378 */
379 public $noController = FALSE;
380
381 /**
382 * Variable to hold the currency alias
383 */
384 protected $_currencyColumn = NULL;
385
386 /**
387 * @var string
388 */
389 protected $_interval;
390
391 /**
392 * @var bool
393 */
394 protected $_sendmail;
395
396 /**
397 * @var int
398 */
399 protected $_chartId;
400
401 /**
402 * @var int
403 */
404 public $_section;
405
406 /**
407 * @var string Report description.
408 */
409 public $_description;
410
411 /**
412 * @var bool Is an address field selected.
413 * This was intended to determine if the address table should be joined in
414 * The isTableSelected function is now preferred for this purpose
415 */
416 protected $_addressField;
417
418 /**
419 * @var bool Is an email field selected.
420 * This was intended to determine if the email table should be joined in
421 * The isTableSelected function is now preferred for this purpose
422 */
423 protected $_emailField;
424
425 /**
426 * @var bool Is a phone field selected.
427 * This was intended to determine if the phone table should be joined in
428 * The isTableSelected function is now preferred for this purpose
429 */
430 protected $_phoneField;
431
432 /**
433 * @var bool Create new report instance? (or update existing) on save.
434 */
435 protected $_createNew;
436
437 /**
438 * When a grand total row has calculated the status we pop it off to here.
439 *
440 * This allows us to access it from the stats function and avoid recalculating.
441 */
442 protected $rollupRow = array();
443
444 /**
445 * SQL being run in this report.
446 *
447 * The sql in the report is stored in this variable in order to be displayed on the developer tab.
448 *
449 * @var string
450 */
451
452 protected $sql;
453
454 /**
455 * SQL being run in this report as an array.
456 *
457 * The sql in the report is stored in this variable in order to be returned to api & test calls.
458 *
459 * @var string
460 */
461
462 protected $sqlArray;
463 /**
464 * Class constructor.
465 */
466 public function __construct() {
467 parent::__construct();
468
469 $this->addClass('crm-report-form');
470
471 if ($this->_tagFilter) {
472 $this->buildTagFilter();
473 }
474 if ($this->_exposeContactID) {
475 if (array_key_exists('civicrm_contact', $this->_columns)) {
476 $this->_columns['civicrm_contact']['fields']['exposed_id'] = array(
477 'name' => 'id',
478 'title' => ts('Contact ID'),
479 'no_repeat' => TRUE,
480 );
481 }
482 }
483
484 if ($this->_groupFilter) {
485 $this->buildGroupFilter();
486 }
487
488 // Get all custom groups
489 $allGroups = CRM_Core_PseudoConstant::get('CRM_Core_DAO_CustomField', 'custom_group_id');
490
491 // Get the custom groupIds for which the user has VIEW permission
492 // If the user has 'access all custom data' permission, we'll leave $permCustomGroupIds empty
493 // and addCustomDataToColumns() will allow access to all custom groups.
494 $permCustomGroupIds = array();
495 if (!CRM_Core_Permission::check('access all custom data')) {
496 $permCustomGroupIds = CRM_ACL_API::group(CRM_Core_Permission::VIEW, NULL, 'civicrm_custom_group', $allGroups, NULL);
497 // do not allow custom data for reports if user doesn't have
498 // permission to access custom data.
499 if (!empty($this->_customGroupExtends) && empty($permCustomGroupIds)) {
500 $this->_customGroupExtends = array();
501 }
502 }
503
504 // merge custom data columns to _columns list, if any
505 $this->addCustomDataToColumns(TRUE, $permCustomGroupIds);
506
507 // add / modify display columns, filters ..etc
508 CRM_Utils_Hook::alterReportVar('columns', $this->_columns, $this);
509
510 //assign currencyColumn variable to tpl
511 $this->assign('currencyColumn', $this->_currencyColumn);
512 }
513
514 /**
515 * Shared pre-process function.
516 *
517 * If overriding preProcess function this should still be called.
518 *
519 * @throws \Exception
520 */
521 public function preProcessCommon() {
522 $this->_force
523 = CRM_Utils_Request::retrieve(
524 'force',
525 'Boolean',
526 CRM_Core_DAO::$_nullObject
527 );
528
529 $this->_dashBoardRowCount
530 = CRM_Utils_Request::retrieve(
531 'rowCount',
532 'Integer',
533 CRM_Core_DAO::$_nullObject
534 );
535
536 $this->_section = CRM_Utils_Request::retrieve('section', 'Integer', CRM_Core_DAO::$_nullObject);
537
538 $this->assign('section', $this->_section);
539 CRM_Core_Region::instance('page-header')->add(array(
540 'markup' => sprintf('<!-- Report class: [%s] -->', htmlentities(get_class($this))),
541 ));
542 if (!$this->noController) {
543 $this->setID($this->get('instanceId'));
544
545 if (!$this->_id) {
546 $this->setID(CRM_Report_Utils_Report::getInstanceID());
547 if (!$this->_id) {
548 $this->setID(CRM_Report_Utils_Report::getInstanceIDForPath());
549 }
550 }
551
552 // set qfkey so that pager picks it up and use it in the "Next > Last >>" links.
553 // FIXME: Note setting it in $_GET doesn't work, since pager generates link based on QUERY_STRING
554 $_SERVER['QUERY_STRING'] .= "&qfKey={$this->controller->_key}";
555 }
556
557 if ($this->_id) {
558 $this->assign('instanceId', $this->_id);
559 $params = array('id' => $this->_id);
560 $this->_instanceValues = array();
561 CRM_Core_DAO::commonRetrieve('CRM_Report_DAO_ReportInstance',
562 $params,
563 $this->_instanceValues
564 );
565 if (empty($this->_instanceValues)) {
566 CRM_Core_Error::fatal("Report could not be loaded.");
567 }
568 $this->_title = $this->_instanceValues['title'];
569 if (!empty($this->_instanceValues['permission']) &&
570 (!(CRM_Core_Permission::check($this->_instanceValues['permission']) ||
571 CRM_Core_Permission::check('administer Reports')
572 ))
573 ) {
574 CRM_Utils_System::permissionDenied();
575 CRM_Utils_System::civiExit();
576 }
577
578 $formValues = CRM_Utils_Array::value('form_values', $this->_instanceValues);
579 if ($formValues) {
580 $this->_formValues = unserialize($formValues);
581 }
582 else {
583 $this->_formValues = NULL;
584 }
585
586 $this->setOutputMode();
587
588 if ($this->_outputMode == 'copy') {
589 $this->_createNew = TRUE;
590 $this->_params = $this->_formValues;
591 $this->_params['view_mode'] = 'criteria';
592 $this->_params['title'] = $this->getTitle() . ts(' (copy created by %1 on %2)', array(
593 CRM_Core_Session::singleton()->getLoggedInContactDisplayName(),
594 CRM_Utils_Date::customFormat(date('Y-m-d H:i')),
595 ));
596 // Do not pass go. Do not collect another chance to re-run the same query.
597 CRM_Report_Form_Instance::postProcess($this);
598 }
599
600 // lets always do a force if reset is found in the url.
601 // Hey why not? see CRM-17225 for more about this. The use of reset to be force is historical for reasons stated
602 // in the comment line above these 2.
603 if (!empty($_REQUEST['reset'])
604 && !in_array(CRM_Utils_Request::retrieve('output', 'String'), array('save', 'criteria'))) {
605 $this->_force = 1;
606 }
607
608 // set the mode
609 $this->assign('mode', 'instance');
610 }
611 elseif (!$this->noController) {
612 list($optionValueID, $optionValue) = CRM_Report_Utils_Report::getValueIDFromUrl();
613 $instanceCount = CRM_Report_Utils_Report::getInstanceCount($optionValue);
614 if (($instanceCount > 0) && $optionValueID) {
615 $this->assign('instanceUrl',
616 CRM_Utils_System::url('civicrm/report/list',
617 "reset=1&ovid=$optionValueID"
618 )
619 );
620 }
621 if ($optionValueID) {
622 $this->_description = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionValue', $optionValueID, 'description');
623 }
624
625 // set the mode
626 $this->assign('mode', 'template');
627 }
628
629 // lets display the Report Settings section
630 $this->_instanceForm = $this->_force || $this->_id || (!empty($_POST));
631
632 // Do not display Report Settings section if administer Reports permission is absent OR
633 // if report instance is reserved and administer reserved reports absent
634 if (!CRM_Core_Permission::check('administer Reports') ||
635 ($this->_instanceValues['is_reserved'] &&
636 !CRM_Core_Permission::check('administer reserved reports'))
637 ) {
638 $this->_instanceForm = FALSE;
639 }
640
641 $this->assign('criteriaForm', FALSE);
642 // Display Report Criteria section if user has access Report Criteria OR administer Reports AND report instance is not reserved
643 if (CRM_Core_Permission::check('administer Reports') ||
644 CRM_Core_Permission::check('access Report Criteria')
645 ) {
646 if (!$this->_instanceValues['is_reserved'] ||
647 CRM_Core_Permission::check('administer reserved reports')
648 ) {
649 $this->assign('criteriaForm', TRUE);
650 $this->_criteriaForm = TRUE;
651 }
652 }
653
654 // Special permissions check for private instance if it's not the current contact instance
655 if ($this->_id &&
656 (CRM_Report_BAO_ReportInstance::reportIsPrivate($this->_id) &&
657 !CRM_Report_BAO_ReportInstance::contactIsOwner($this->_id))) {
658 if (!CRM_Core_Permission::check('access all private reports')) {
659 $this->_instanceForm = FALSE;
660 $this->assign('criteriaForm', FALSE);
661 }
662 }
663
664 $this->_instanceButtonName = $this->getButtonName('submit', 'save');
665 $this->_createNewButtonName = $this->getButtonName('submit', 'next');
666 $this->_groupButtonName = $this->getButtonName('submit', 'group');
667 $this->_chartButtonName = $this->getButtonName('submit', 'chart');
668 }
669
670 /**
671 * Add bread crumb.
672 */
673 public function addBreadCrumb() {
674 $breadCrumbs
675 = array(
676 array(
677 'title' => ts('Report Templates'),
678 'url' => CRM_Utils_System::url('civicrm/admin/report/template/list', 'reset=1'),
679 ),
680 );
681
682 CRM_Utils_System::appendBreadCrumb($breadCrumbs);
683 }
684
685 /**
686 * Pre process function.
687 *
688 * Called prior to build form.
689 */
690 public function preProcess() {
691 $this->preProcessCommon();
692
693 if (!$this->_id) {
694 $this->addBreadCrumb();
695 }
696
697 foreach ($this->_columns as $tableName => $table) {
698 // set alias
699 if (!isset($table['alias'])) {
700 $this->_columns[$tableName]['alias'] = substr($tableName, 8) .
701 '_civireport';
702 }
703 else {
704 $this->_columns[$tableName]['alias'] = $table['alias'] . '_civireport';
705 }
706
707 $this->_aliases[$tableName] = $this->_columns[$tableName]['alias'];
708
709 $daoOrBaoName = NULL;
710 // higher preference to bao object
711 if (array_key_exists('bao', $table)) {
712 $daoOrBaoName = $table['bao'];
713 $expFields = $daoOrBaoName::exportableFields();
714 }
715 elseif (array_key_exists('dao', $table)) {
716 $daoOrBaoName = $table['dao'];
717 $expFields = $daoOrBaoName::export();
718 }
719 else {
720 $expFields = array();
721 }
722
723 $doNotCopy = array('required');
724
725 $fieldGroups = array('fields', 'filters', 'group_bys', 'order_bys');
726 foreach ($fieldGroups as $fieldGrp) {
727 if (!empty($table[$fieldGrp]) && is_array($table[$fieldGrp])) {
728 foreach ($table[$fieldGrp] as $fieldName => $field) {
729 // $name is the field name used to reference the BAO/DAO export fields array
730 $name = isset($field['name']) ? $field['name'] : $fieldName;
731
732 // Sometimes the field name key in the BAO/DAO export fields array is
733 // different from the actual database field name.
734 // Unset $field['name'] so that actual database field name can be obtained
735 // from the BAO/DAO export fields array.
736 unset($field['name']);
737
738 if (array_key_exists($name, $expFields)) {
739 foreach ($doNotCopy as $dnc) {
740 // unset the values we don't want to be copied.
741 unset($expFields[$name][$dnc]);
742 }
743 if (empty($field)) {
744 $this->_columns[$tableName][$fieldGrp][$fieldName] = $expFields[$name];
745 }
746 else {
747 foreach ($expFields[$name] as $property => $val) {
748 if (!array_key_exists($property, $field)) {
749 $this->_columns[$tableName][$fieldGrp][$fieldName][$property] = $val;
750 }
751 }
752 }
753 }
754
755 // fill other vars
756 if (!empty($field['no_repeat'])) {
757 $this->_noRepeats[] = "{$tableName}_{$fieldName}";
758 }
759 if (!empty($field['no_display'])) {
760 $this->_noDisplay[] = "{$tableName}_{$fieldName}";
761 }
762
763 // set alias = table-name, unless already set
764 $alias = isset($field['alias']) ? $field['alias'] : (
765 isset($this->_columns[$tableName]['alias']) ? $this->_columns[$tableName]['alias'] : $tableName
766 );
767 $this->_columns[$tableName][$fieldGrp][$fieldName]['alias'] = $alias;
768
769 // set name = fieldName, unless already set
770 if (!isset($this->_columns[$tableName][$fieldGrp][$fieldName]['name'])) {
771 $this->_columns[$tableName][$fieldGrp][$fieldName]['name'] = $name;
772 }
773
774 // set dbAlias = alias.name, unless already set
775 if (!isset($this->_columns[$tableName][$fieldGrp][$fieldName]['dbAlias'])) {
776 $this->_columns[$tableName][$fieldGrp][$fieldName]['dbAlias']
777 = $alias . '.' .
778 $this->_columns[$tableName][$fieldGrp][$fieldName]['name'];
779 }
780
781 // a few auto fills for filters
782 if ($fieldGrp == 'filters') {
783 // fill operator types
784 if (!array_key_exists('operatorType', $this->_columns[$tableName][$fieldGrp][$fieldName])) {
785 switch (CRM_Utils_Array::value('type', $this->_columns[$tableName][$fieldGrp][$fieldName])) {
786 case CRM_Utils_Type::T_MONEY:
787 case CRM_Utils_Type::T_FLOAT:
788 $this->_columns[$tableName][$fieldGrp][$fieldName]['operatorType'] = CRM_Report_Form::OP_FLOAT;
789 break;
790
791 case CRM_Utils_Type::T_INT:
792 $this->_columns[$tableName][$fieldGrp][$fieldName]['operatorType'] = CRM_Report_Form::OP_INT;
793 break;
794
795 case CRM_Utils_Type::T_DATE:
796 $this->_columns[$tableName][$fieldGrp][$fieldName]['operatorType'] = CRM_Report_Form::OP_DATE;
797 break;
798
799 case CRM_Utils_Type::T_BOOLEAN:
800 $this->_columns[$tableName][$fieldGrp][$fieldName]['operatorType'] = CRM_Report_Form::OP_SELECT;
801 if (!array_key_exists('options', $this->_columns[$tableName][$fieldGrp][$fieldName])) {
802 $this->_columns[$tableName][$fieldGrp][$fieldName]['options']
803 = array(
804 '' => ts('Any'),
805 '0' => ts('No'),
806 '1' => ts('Yes'),
807 );
808 }
809 break;
810
811 default:
812 if ($daoOrBaoName &&
813 array_key_exists('pseudoconstant', $this->_columns[$tableName][$fieldGrp][$fieldName])
814 ) {
815 // with multiple options operator-type is generally multi-select
816 $this->_columns[$tableName][$fieldGrp][$fieldName]['operatorType'] = CRM_Report_Form::OP_MULTISELECT;
817 if (!array_key_exists('options', $this->_columns[$tableName][$fieldGrp][$fieldName])) {
818 // fill options
819 $this->_columns[$tableName][$fieldGrp][$fieldName]['options'] = CRM_Core_PseudoConstant::get($daoOrBaoName, $fieldName);
820 }
821 }
822 break;
823 }
824 }
825 }
826 }
827 }
828 }
829
830 // copy filters to a separate handy variable
831 if (array_key_exists('filters', $table)) {
832 $this->_filters[$tableName] = $this->_columns[$tableName]['filters'];
833 }
834
835 if (array_key_exists('group_bys', $table)) {
836 $groupBys[$tableName] = $this->_columns[$tableName]['group_bys'];
837 }
838
839 if (array_key_exists('fields', $table)) {
840 $reportFields[$tableName] = $this->_columns[$tableName]['fields'];
841 }
842 }
843
844 if ($this->_force) {
845 $this->setDefaultValues(FALSE);
846 }
847
848 CRM_Report_Utils_Get::processFilter($this->_filters, $this->_defaults);
849 CRM_Report_Utils_Get::processGroupBy($groupBys, $this->_defaults);
850 CRM_Report_Utils_Get::processFields($reportFields, $this->_defaults);
851 CRM_Report_Utils_Get::processChart($this->_defaults);
852
853 if ($this->_force) {
854 $this->_formValues = $this->_defaults;
855 $this->postProcess();
856 }
857 }
858
859 /**
860 * Set default values.
861 *
862 * @param bool $freeze
863 *
864 * @return array
865 */
866 public function setDefaultValues($freeze = TRUE) {
867 $freezeGroup = array();
868
869 // FIXME: generalizing form field naming conventions would reduce
870 // Lots of lines below.
871 foreach ($this->_columns as $tableName => $table) {
872 if (array_key_exists('fields', $table)) {
873 foreach ($table['fields'] as $fieldName => $field) {
874 if (empty($field['no_display'])) {
875 if (isset($field['required'])) {
876 // set default
877 $this->_defaults['fields'][$fieldName] = 1;
878
879 if ($freeze) {
880 // find element object, so that we could use quickform's freeze method
881 // for required elements
882 $obj = $this->getElementFromGroup("fields", $fieldName);
883 if ($obj) {
884 $freezeGroup[] = $obj;
885 }
886 }
887 }
888 elseif (isset($field['default'])) {
889 $this->_defaults['fields'][$fieldName] = $field['default'];
890 }
891 }
892 }
893 }
894
895 if (array_key_exists('group_bys', $table)) {
896 foreach ($table['group_bys'] as $fieldName => $field) {
897 if (isset($field['default'])) {
898 if (!empty($field['frequency'])) {
899 $this->_defaults['group_bys_freq'][$fieldName] = 'MONTH';
900 }
901 $this->_defaults['group_bys'][$fieldName] = $field['default'];
902 }
903 }
904 }
905 if (array_key_exists('filters', $table)) {
906 foreach ($table['filters'] as $fieldName => $field) {
907 if (isset($field['default'])) {
908 if (CRM_Utils_Array::value('type', $field) & CRM_Utils_Type::T_DATE
909 ) {
910 if (is_array($field['default'])) {
911 $this->_defaults["{$fieldName}_from"] = CRM_Utils_Array::value('from', $field['default']);
912 $this->_defaults["{$fieldName}_to"] = CRM_Utils_Array::value('to', $field['default']);
913 $this->_defaults["{$fieldName}_relative"] = 0;
914 }
915 else {
916 $this->_defaults["{$fieldName}_relative"] = $field['default'];
917 }
918 }
919 else {
920 if ((CRM_Utils_Array::value('type', $field) & CRM_Utils_Type::T_INT) && is_array($field['default'])) {
921 $this->_defaults["{$fieldName}_min"] = CRM_Utils_Array::value('min', $field['default']);
922 $this->_defaults["{$fieldName}_max"] = CRM_Utils_Array::value('max', $field['default']);
923 }
924 $this->_defaults["{$fieldName}_value"] = $field['default'];
925 }
926 }
927 //assign default value as "in" for multiselect
928 //operator, To freeze the select element
929 if (CRM_Utils_Array::value('operatorType', $field) ==
930 CRM_Report_Form::OP_MULTISELECT
931 ) {
932 $this->_defaults["{$fieldName}_op"] = 'in';
933 }
934 if (CRM_Utils_Array::value('operatorType', $field) ==
935 CRM_Report_Form::OP_ENTITYREF
936 ) {
937 $this->_defaults["{$fieldName}_op"] = 'in';
938 }
939 elseif (CRM_Utils_Array::value('operatorType', $field) ==
940 CRM_Report_Form::OP_MULTISELECT_SEPARATOR
941 ) {
942 $this->_defaults["{$fieldName}_op"] = 'mhas';
943 }
944 elseif ($op = CRM_Utils_Array::value('default_op', $field)) {
945 $this->_defaults["{$fieldName}_op"] = $op;
946 }
947 }
948 }
949
950 if (
951 empty($this->_formValues['order_bys']) &&
952 (array_key_exists('order_bys', $table) &&
953 is_array($table['order_bys']))
954 ) {
955 if (!array_key_exists('order_bys', $this->_defaults)) {
956 $this->_defaults['order_bys'] = array();
957 }
958 foreach ($table['order_bys'] as $fieldName => $field) {
959 if (!empty($field['default']) || !empty($field['default_order']) ||
960 CRM_Utils_Array::value('default_is_section', $field) ||
961 !empty($field['default_weight'])
962 ) {
963 $order_by = array(
964 'column' => $fieldName,
965 'order' => CRM_Utils_Array::value('default_order', $field, 'ASC'),
966 'section' => CRM_Utils_Array::value('default_is_section', $field, 0),
967 );
968
969 if (!empty($field['default_weight'])) {
970 $this->_defaults['order_bys'][(int) $field['default_weight']] = $order_by;
971 }
972 else {
973 array_unshift($this->_defaults['order_bys'], $order_by);
974 }
975 }
976 }
977 }
978
979 foreach ($this->_options as $fieldName => $field) {
980 if (isset($field['default'])) {
981 $this->_defaults['options'][$fieldName] = $field['default'];
982 }
983 }
984 }
985
986 if (!empty($this->_submitValues)) {
987 $this->preProcessOrderBy($this->_submitValues);
988 }
989 else {
990 $this->preProcessOrderBy($this->_defaults);
991 }
992
993 // lets finish freezing task here itself
994 if (!empty($freezeGroup)) {
995 foreach ($freezeGroup as $elem) {
996 $elem->freeze();
997 }
998 }
999
1000 if ($this->_formValues) {
1001 $this->_defaults = array_merge($this->_defaults, $this->_formValues);
1002 }
1003
1004 if ($this->_instanceValues) {
1005 $this->_defaults = array_merge($this->_defaults, $this->_instanceValues);
1006 }
1007
1008 CRM_Report_Form_Instance::setDefaultValues($this, $this->_defaults);
1009
1010 return $this->_defaults;
1011 }
1012
1013 /**
1014 * Get element from group.
1015 *
1016 * @param string $group
1017 * @param string $grpFieldName
1018 *
1019 * @return bool
1020 */
1021 public function getElementFromGroup($group, $grpFieldName) {
1022 $eleObj = $this->getElement($group);
1023 foreach ($eleObj->_elements as $index => $obj) {
1024 if ($grpFieldName == $obj->_attributes['name']) {
1025 return $obj;
1026 }
1027 }
1028 return FALSE;
1029 }
1030
1031 /**
1032 * Setter for $_params.
1033 *
1034 * @param array $params
1035 */
1036 public function setParams($params) {
1037 $this->_params = $params;
1038 }
1039
1040 /**
1041 * Setter for $_id.
1042 *
1043 * @param int $instanceID
1044 */
1045 public function setID($instanceID) {
1046 $this->_id = $instanceID;
1047 }
1048
1049 /**
1050 * Setter for $_force.
1051 *
1052 * @param bool $isForce
1053 */
1054 public function setForce($isForce) {
1055 $this->_force = $isForce;
1056 }
1057
1058 /**
1059 * Setter for $_limitValue.
1060 *
1061 * @param int $_limitValue
1062 */
1063 public function setLimitValue($_limitValue) {
1064 $this->_limitValue = $_limitValue;
1065 }
1066
1067 /**
1068 * Setter for $_offsetValue.
1069 *
1070 * @param int $_offsetValue
1071 */
1072 public function setOffsetValue($_offsetValue) {
1073 $this->_offsetValue = $_offsetValue;
1074 }
1075
1076 /**
1077 * Setter for $addPaging.
1078 *
1079 * @param bool $value
1080 */
1081 public function setAddPaging($value) {
1082 $this->addPaging = $value;
1083 }
1084
1085 /**
1086 * Getter for $_defaultValues.
1087 *
1088 * @return array
1089 */
1090 public function getDefaultValues() {
1091 return $this->_defaults;
1092 }
1093
1094 /**
1095 * Add columns to report.
1096 */
1097 public function addColumns() {
1098 $options = array();
1099 $colGroups = NULL;
1100 foreach ($this->_columns as $tableName => $table) {
1101 if (array_key_exists('fields', $table)) {
1102 foreach ($table['fields'] as $fieldName => $field) {
1103 $groupTitle = '';
1104 if (empty($field['no_display'])) {
1105 foreach (array('table', 'field') as $var) {
1106 if (!empty(${$var}['grouping'])) {
1107 if (!is_array(${$var}['grouping'])) {
1108 $tableName = ${$var}['grouping'];
1109 }
1110 else {
1111 $tableName = array_keys(${$var}['grouping']);
1112 $tableName = $tableName[0];
1113 $groupTitle = array_values(${$var}['grouping']);
1114 $groupTitle = $groupTitle[0];
1115 }
1116 }
1117 }
1118
1119 if (!$groupTitle && isset($table['group_title'])) {
1120 $groupTitle = $table['group_title'];
1121 // Having a group_title is secret code for being a custom group
1122 // which cryptically translates to needing an accordion.
1123 // here we make that explicit.
1124 $colGroups[$tableName]['use_accordian_for_field_selection'] = TRUE;
1125 }
1126
1127 $colGroups[$tableName]['fields'][$fieldName] = CRM_Utils_Array::value('title', $field);
1128 if ($groupTitle && empty($colGroups[$tableName]['group_title'])) {
1129 $colGroups[$tableName]['group_title'] = $groupTitle;
1130 }
1131 $options[$fieldName] = CRM_Utils_Array::value('title', $field);
1132 }
1133 }
1134 }
1135 }
1136
1137 $this->addCheckBox("fields", ts('Select Columns'), $options, NULL,
1138 NULL, NULL, NULL, $this->_fourColumnAttribute, TRUE
1139 );
1140 if (!empty($colGroups)) {
1141 $this->tabs['FieldSelection'] = array(
1142 'title' => ts('Columns'),
1143 'tpl' => 'FieldSelection',
1144 'div_label' => 'col-groups',
1145 );
1146
1147 // Note this assignment is only really required in buildForm. It is being 'over-called'
1148 // to reduce risk of being missed due to overridden functions.
1149 $this->assign('tabs', $this->tabs);
1150 }
1151
1152 $this->assign('colGroups', $colGroups);
1153 }
1154
1155 /**
1156 * Add filters to report.
1157 */
1158 public function addFilters() {
1159 $filters = $filterGroups = array();
1160 $count = 1;
1161
1162 foreach ($this->_filters as $table => $attributes) {
1163 if (isset($this->_columns[$table]['group_title'])) {
1164 // The presence of 'group_title' is secret code for 'is_a_custom_table'
1165 // which magically means to 'display in an accordian'
1166 // here we make this explicit.
1167 $filterGroups[$table] = array(
1168 'group_title' => $this->_columns[$table]['group_title'],
1169 'use_accordian_for_field_selection' => TRUE,
1170
1171 );
1172 }
1173 foreach ($attributes as $fieldName => $field) {
1174 // get ready with option value pair
1175 // @ 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
1176 // would be useful
1177 $operations = $this->getOperationPair(
1178 CRM_Utils_Array::value('operatorType', $field),
1179 $fieldName);
1180
1181 $filters[$table][$fieldName] = $field;
1182
1183 switch (CRM_Utils_Array::value('operatorType', $field)) {
1184 case CRM_Report_Form::OP_MONTH:
1185 if (!array_key_exists('options', $field) ||
1186 !is_array($field['options']) || empty($field['options'])
1187 ) {
1188 // If there's no option list for this filter, define one.
1189 $field['options'] = array(
1190 1 => ts('January'),
1191 2 => ts('February'),
1192 3 => ts('March'),
1193 4 => ts('April'),
1194 5 => ts('May'),
1195 6 => ts('June'),
1196 7 => ts('July'),
1197 8 => ts('August'),
1198 9 => ts('September'),
1199 10 => ts('October'),
1200 11 => ts('November'),
1201 12 => ts('December'),
1202 );
1203 // Add this option list to this column _columns. This is
1204 // required so that filter statistics show properly.
1205 $this->_columns[$table]['filters'][$fieldName]['options'] = $field['options'];
1206 }
1207 case CRM_Report_Form::OP_MULTISELECT:
1208 case CRM_Report_Form::OP_MULTISELECT_SEPARATOR:
1209 // assume a multi-select field
1210 if (!empty($field['options']) ||
1211 $fieldName == 'state_province_id' || $fieldName == 'county_id'
1212 ) {
1213 $element = $this->addElement('select', "{$fieldName}_op", ts('Operator:'), $operations);
1214 if (count($operations) <= 1) {
1215 $element->freeze();
1216 }
1217 if ($fieldName == 'state_province_id' ||
1218 $fieldName == 'county_id'
1219 ) {
1220 $this->addChainSelect($fieldName . '_value', array(
1221 'multiple' => TRUE,
1222 'label' => NULL,
1223 'class' => 'huge',
1224 ));
1225 }
1226 else {
1227 $this->addElement('select', "{$fieldName}_value", NULL, $field['options'], array(
1228 'style' => 'min-width:250px',
1229 'class' => 'crm-select2 huge',
1230 'multiple' => TRUE,
1231 'placeholder' => ts('- select -'),
1232 ));
1233 }
1234 }
1235 break;
1236
1237 case CRM_Report_Form::OP_SELECT:
1238 // assume a select field
1239 $this->addElement('select', "{$fieldName}_op", ts('Operator:'), $operations);
1240 if (!empty($field['options'])) {
1241 $this->addElement('select', "{$fieldName}_value", NULL, $field['options']);
1242 }
1243 break;
1244
1245 case CRM_Report_Form::OP_ENTITYREF:
1246 $this->addElement('select', "{$fieldName}_op", ts('Operator:'), $operations);
1247 $this->setEntityRefDefaults($field, $table);
1248 $this->addEntityRef("{$fieldName}_value", NULL, $field['attributes']);
1249 break;
1250
1251 case CRM_Report_Form::OP_DATE:
1252 // build datetime fields
1253 CRM_Core_Form_Date::buildDateRange($this, $fieldName, $count, '_from', '_to', ts('From:'), FALSE, $operations);
1254 $count++;
1255 break;
1256
1257 case CRM_Report_Form::OP_DATETIME:
1258 // build datetime fields
1259 CRM_Core_Form_Date::buildDateRange($this, $fieldName, $count, '_from', '_to', ts('From:'), FALSE, $operations, 'searchDate', TRUE);
1260 $count++;
1261 break;
1262
1263 case CRM_Report_Form::OP_INT:
1264 case CRM_Report_Form::OP_FLOAT:
1265 // and a min value input box
1266 $this->add('text', "{$fieldName}_min", ts('Min'));
1267 // and a max value input box
1268 $this->add('text', "{$fieldName}_max", ts('Max'));
1269 default:
1270 // default type is string
1271 $this->addElement('select', "{$fieldName}_op", ts('Operator:'), $operations,
1272 array('onchange' => "return showHideMaxMinVal( '$fieldName', this.value );")
1273 );
1274 // we need text box for value input
1275 $this->add('text', "{$fieldName}_value", NULL, array('class' => 'huge'));
1276 break;
1277 }
1278 }
1279 }
1280 if (!empty($filters)) {
1281 $this->tabs['Filters'] = array(
1282 'title' => ts('Filters'),
1283 'tpl' => 'Filters',
1284 'div_label' => 'set-filters',
1285 );
1286 }
1287 $this->assign('filters', $filters);
1288 $this->assign('filterGroups', $filterGroups);
1289 }
1290
1291 /**
1292 * Function to assign the tabs to the template in the correct order.
1293 *
1294 * We want the tabs to wind up in this order (if not overridden).
1295 *
1296 * - Field Selection
1297 * - Group Bys
1298 * - Order Bys
1299 * - Other Options
1300 * - Filters
1301 */
1302 protected function assignTabs() {
1303 $order = array(
1304 'FieldSelection',
1305 'GroupBy',
1306 'OrderBy',
1307 'ReportOptions',
1308 'Filters',
1309 );
1310 $order = array_intersect_key(array_fill_keys($order, 1), $this->tabs);
1311 $order = array_merge($order, $this->tabs);
1312 $this->assign('tabs', $order);
1313 }
1314
1315 /**
1316 * The intent is to add a tab for developers to view the sql.
1317 *
1318 * Currently using dpm.
1319 *
1320 * @param string $sql
1321 */
1322 protected function addToDeveloperTab($sql) {
1323 if (!CRM_Core_Permission::check('view report sql')) {
1324 return;
1325 }
1326 $this->tabs['Developer'] = array(
1327 'title' => ts('Developer'),
1328 'tpl' => 'Developer',
1329 'div_label' => 'set-developer',
1330 );
1331
1332 $this->assignTabs();
1333 $this->sqlArray[] = $sql;
1334 foreach ($this->sqlArray as $sql) {
1335 foreach (array('LEFT JOIN') as $term) {
1336 $sql = str_replace($term, '<br>&nbsp&nbsp' . $term, $sql);
1337 }
1338 foreach (array('FROM', 'WHERE', 'GROUP BY', 'ORDER BY', 'LIMIT', ';') as $term) {
1339 $sql = str_replace($term, '<br><br>' . $term, $sql);
1340 }
1341 $this->sqlFormattedArray[] = $sql;
1342 $this->assign('sql', implode(';<br><br><br><br>', $this->sqlFormattedArray));
1343 }
1344 }
1345
1346 /**
1347 * Add options defined in $this->_options to the report.
1348 */
1349 public function addOptions() {
1350 if (!empty($this->_options)) {
1351 // FIXME: For now lets build all elements as checkboxes.
1352 // Once we clear with the format we can build elements based on type
1353
1354 foreach ($this->_options as $fieldName => $field) {
1355 $options = array();
1356
1357 if ($field['type'] == 'select') {
1358 $this->addElement('select', "{$fieldName}", $field['title'], $field['options']);
1359 }
1360 elseif ($field['type'] == 'checkbox') {
1361 $options[$field['title']] = $fieldName;
1362 $this->addCheckBox($fieldName, NULL,
1363 $options, NULL,
1364 NULL, NULL, NULL, $this->_fourColumnAttribute
1365 );
1366 }
1367 }
1368 }
1369 if (!empty($this->_options) &&
1370 (!$this->_id
1371 || ($this->_id && CRM_Report_BAO_ReportInstance::contactCanAdministerReport($this->_id)))
1372 ) {
1373 $this->tabs['ReportOptions'] = array(
1374 'title' => ts('Display Options'),
1375 'tpl' => 'ReportOptions',
1376 'div_label' => 'other-options',
1377 );
1378 }
1379 $this->assign('otherOptions', $this->_options);
1380 }
1381
1382 /**
1383 * Add chart options to the report.
1384 */
1385 public function addChartOptions() {
1386 if (!empty($this->_charts)) {
1387 $this->addElement('select', "charts", ts('Chart'), $this->_charts);
1388 $this->assign('charts', $this->_charts);
1389 $this->addElement('submit', $this->_chartButtonName, ts('View'));
1390 }
1391 }
1392
1393 /**
1394 * Add group by options to the report.
1395 */
1396 public function addGroupBys() {
1397 $options = $freqElements = array();
1398
1399 foreach ($this->_columns as $tableName => $table) {
1400 if (array_key_exists('group_bys', $table)) {
1401 foreach ($table['group_bys'] as $fieldName => $field) {
1402 if (!empty($field)) {
1403 $options[$field['title']] = $fieldName;
1404 if (!empty($field['frequency'])) {
1405 $freqElements[$field['title']] = $fieldName;
1406 }
1407 }
1408 }
1409 }
1410 }
1411 $this->addCheckBox("group_bys", ts('Group by columns'), $options, NULL,
1412 NULL, NULL, NULL, $this->_fourColumnAttribute
1413 );
1414 $this->assign('groupByElements', $options);
1415 if (!empty($options)) {
1416 $this->tabs['GroupBy'] = array(
1417 'title' => ts('Grouping'),
1418 'tpl' => 'GroupBy',
1419 'div_label' => 'group-by-elements',
1420 );
1421 }
1422
1423 foreach ($freqElements as $name) {
1424 $this->addElement('select', "group_bys_freq[$name]",
1425 ts('Frequency'), $this->_groupByDateFreq
1426 );
1427 }
1428 }
1429
1430 /**
1431 * Add data for order by tab.
1432 */
1433 public function addOrderBys() {
1434 $options = array();
1435 foreach ($this->_columns as $tableName => $table) {
1436
1437 // Report developer may define any column to order by; include these as order-by options.
1438 if (array_key_exists('order_bys', $table)) {
1439 foreach ($table['order_bys'] as $fieldName => $field) {
1440 if (!empty($field)) {
1441 $options[$fieldName] = $field['title'];
1442 }
1443 }
1444 }
1445
1446 // Add searchable custom fields as order-by options, if so requested
1447 // (These are already indexed, so allowing to order on them is cheap.)
1448
1449 if ($this->_autoIncludeIndexedFieldsAsOrderBys &&
1450 array_key_exists('extends', $table) && !empty($table['extends'])
1451 ) {
1452 foreach ($table['fields'] as $fieldName => $field) {
1453 if (empty($field['no_display'])) {
1454 $options[$fieldName] = $field['title'];
1455 }
1456 }
1457 }
1458 }
1459
1460 asort($options);
1461
1462 $this->assign('orderByOptions', $options);
1463 if (!empty($options)) {
1464 $this->tabs['OrderBy'] = array(
1465 'title' => ts('Sorting'),
1466 'tpl' => 'OrderBy',
1467 'div_label' => 'order-by-elements',
1468 );
1469 }
1470
1471 if (!empty($options)) {
1472 $options = array(
1473 '-' => ' - none - ',
1474 ) + $options;
1475 for ($i = 1; $i <= 5; $i++) {
1476 $this->addElement('select', "order_bys[{$i}][column]", ts('Order by Column'), $options);
1477 $this->addElement('select', "order_bys[{$i}][order]", ts('Order by Order'), array(
1478 'ASC' => ts('Ascending'),
1479 'DESC' => ts('Descending'),
1480 ));
1481 $this->addElement('checkbox', "order_bys[{$i}][section]", ts('Order by Section'), FALSE, array('id' => "order_by_section_$i"));
1482 $this->addElement('checkbox', "order_bys[{$i}][pageBreak]", ts('Page Break'), FALSE, array('id' => "order_by_pagebreak_$i"));
1483 }
1484 }
1485 }
1486
1487 /**
1488 * This adds the tab referred to as Title and Format, rendered through Instance.tpl.
1489 *
1490 * @todo call this tab into the report template in the same way as OrderBy etc, ie
1491 * by adding a description of the tab to $this->tabs, causing the tab to be added in
1492 * Criteria.tpl.
1493 */
1494 public function buildInstanceAndButtons() {
1495 CRM_Report_Form_Instance::buildForm($this);
1496 $this->_actionButtonName = $this->getButtonName('submit');
1497 $this->addTaskMenu($this->getActions($this->_id));
1498
1499 $this->assign('instanceForm', $this->_instanceForm);
1500
1501 // CRM-16274 Determine if user has 'edit all contacts' or equivalent
1502 $permission = CRM_Core_Permission::getPermission();
1503 if ($permission == CRM_Core_Permission::EDIT &&
1504 $this->_add2groupSupported
1505 ) {
1506 $this->addElement('select', 'groups', ts('Group'),
1507 array('' => ts('Add Contacts to Group')) +
1508 CRM_Core_PseudoConstant::nestedGroup(),
1509 array('class' => 'crm-select2 crm-action-menu fa-plus huge')
1510 );
1511 $this->assign('group', TRUE);
1512 }
1513
1514 $this->addElement('submit', $this->_groupButtonName, '', array('style' => 'display: none;'));
1515
1516 $this->addChartOptions();
1517 $showResultsLabel = $this->getResultsLabel();
1518 $this->addButtons(array(
1519 array(
1520 'type' => 'submit',
1521 'name' => $showResultsLabel,
1522 'isDefault' => TRUE,
1523 ),
1524 )
1525 );
1526 }
1527
1528 /**
1529 * Has this form been submitted already?
1530 *
1531 * @return bool
1532 */
1533 public function resultsDisplayed() {
1534 $buttonName = $this->controller->getButtonName();
1535 return ($buttonName || $this->_outputMode);
1536 }
1537
1538 /**
1539 * Get the actions for this report instance.
1540 *
1541 * @param int $instanceId
1542 *
1543 * @return array
1544 */
1545 protected function getActions($instanceId) {
1546 $actions = CRM_Report_BAO_ReportInstance::getActionMetadata();
1547 if (empty($instanceId)) {
1548 $actions['report_instance.save'] = array(
1549 'title' => ts('Create Report'),
1550 'data' => array(
1551 'is_confirm' => TRUE,
1552 'confirm_title' => ts('Create Report'),
1553 'confirm_refresh_fields' => json_encode(array(
1554 'title' => array('selector' => '.crm-report-instanceForm-form-block-title', 'prepend' => ''),
1555 'description' => array('selector' => '.crm-report-instanceForm-form-block-description', 'prepend' => ''),
1556 )),
1557 ),
1558 );
1559 }
1560
1561 if (!$this->_csvSupported) {
1562 unset($actions['report_instance.csv']);
1563 }
1564
1565 return $actions;
1566 }
1567
1568 /**
1569 * Main build form function.
1570 */
1571 public function buildQuickForm() {
1572 $this->addColumns();
1573
1574 $this->addFilters();
1575
1576 $this->addOptions();
1577
1578 $this->addGroupBys();
1579
1580 $this->addOrderBys();
1581
1582 $this->buildInstanceAndButtons();
1583
1584 // Add form rule for report.
1585 if (is_callable(array(
1586 $this,
1587 'formRule',
1588 ))) {
1589 $this->addFormRule(array(get_class($this), 'formRule'), $this);
1590 }
1591 $this->assignTabs();
1592 }
1593
1594 /**
1595 * A form rule function for custom data.
1596 *
1597 * The rule ensures that fields selected in group_by if any) should only be the ones
1598 * present in display/select fields criteria;
1599 * note: works if and only if any custom field selected in group_by.
1600 *
1601 * @param array $fields
1602 * @param array $ignoreFields
1603 *
1604 * @return array
1605 */
1606 public function customDataFormRule($fields, $ignoreFields = array()) {
1607 $errors = array();
1608 if (!empty($this->_customGroupExtends) && $this->_customGroupGroupBy &&
1609 !empty($fields['group_bys'])
1610 ) {
1611 foreach ($this->_columns as $tableName => $table) {
1612 if ((substr($tableName, 0, 13) == 'civicrm_value' ||
1613 substr($tableName, 0, 12) == 'custom_value') &&
1614 !empty($this->_columns[$tableName]['fields'])
1615 ) {
1616 foreach ($this->_columns[$tableName]['fields'] as $fieldName => $field) {
1617 if (array_key_exists($fieldName, $fields['group_bys']) &&
1618 !array_key_exists($fieldName, $fields['fields'])
1619 ) {
1620 $errors['fields'] = "Please make sure fields selected in 'Group by Columns' section are also selected in 'Display Columns' section.";
1621 }
1622 elseif (array_key_exists($fieldName, $fields['group_bys'])) {
1623 foreach ($fields['fields'] as $fld => $val) {
1624 if (!array_key_exists($fld, $fields['group_bys']) &&
1625 !in_array($fld, $ignoreFields)
1626 ) {
1627 $errors['fields'] = "Please ensure that fields selected in 'Display Columns' are also selected in 'Group by Columns' section.";
1628 }
1629 }
1630 }
1631 }
1632 }
1633 }
1634 }
1635 return $errors;
1636 }
1637
1638 /**
1639 * Get operators to display on form.
1640 *
1641 * Note: $fieldName param allows inheriting class to build operationPairs specific to a field.
1642 *
1643 * @param string $type
1644 * @param string $fieldName
1645 *
1646 * @return array
1647 */
1648 public function getOperationPair($type = "string", $fieldName = NULL) {
1649 // FIXME: At some point we should move these key-val pairs
1650 // to option_group and option_value table.
1651 switch ($type) {
1652 case CRM_Report_Form::OP_INT:
1653 case CRM_Report_Form::OP_FLOAT:
1654
1655 $result = array(
1656 'lte' => ts('Is less than or equal to'),
1657 'gte' => ts('Is greater than or equal to'),
1658 'bw' => ts('Is between'),
1659 'eq' => ts('Is equal to'),
1660 'lt' => ts('Is less than'),
1661 'gt' => ts('Is greater than'),
1662 'neq' => ts('Is not equal to'),
1663 'nbw' => ts('Is not between'),
1664 'nll' => ts('Is empty (Null)'),
1665 'nnll' => ts('Is not empty (Null)'),
1666 );
1667 return $result;
1668
1669 case CRM_Report_Form::OP_SELECT:
1670 $result = array(
1671 'eq' => ts('Is equal to'),
1672 );
1673 return $result;
1674
1675 case CRM_Report_Form::OP_MONTH:
1676 case CRM_Report_Form::OP_MULTISELECT:
1677 case CRM_Report_Form::OP_ENTITYREF:
1678
1679 $result = array(
1680 'in' => ts('Is one of'),
1681 'notin' => ts('Is not one of'),
1682 );
1683 return $result;
1684
1685 case CRM_Report_Form::OP_DATE:
1686
1687 $result = array(
1688 'nll' => ts('Is empty (Null)'),
1689 'nnll' => ts('Is not empty (Null)'),
1690 );
1691 return $result;
1692
1693 case CRM_Report_Form::OP_MULTISELECT_SEPARATOR:
1694 // use this operator for the values, concatenated with separator. For e.g if
1695 // multiple options for a column is stored as ^A{val1}^A{val2}^A
1696 $result = array(
1697 'mhas' => ts('Is one of'),
1698 'mnot' => ts('Is not one of'),
1699 );
1700 return $result;
1701
1702 default:
1703 // type is string
1704 $result = array(
1705 'has' => ts('Contains'),
1706 'sw' => ts('Starts with'),
1707 'ew' => ts('Ends with'),
1708 'nhas' => ts('Does not contain'),
1709 'eq' => ts('Is equal to'),
1710 'neq' => ts('Is not equal to'),
1711 'nll' => ts('Is empty (Null)'),
1712 'nnll' => ts('Is not empty (Null)'),
1713 );
1714 return $result;
1715 }
1716 }
1717
1718 /**
1719 * Build the tag filter field to display on the filters tab.
1720 */
1721 public function buildTagFilter() {
1722 $contactTags = CRM_Core_BAO_Tag::getTags($this->_tagFilterTable);
1723 if (!empty($contactTags)) {
1724 $this->_columns['civicrm_tag'] = array(
1725 'dao' => 'CRM_Core_DAO_Tag',
1726 'filters' => array(
1727 'tagid' => array(
1728 'name' => 'tag_id',
1729 'title' => ts('Tag'),
1730 'type' => CRM_Utils_Type::T_INT,
1731 'tag' => TRUE,
1732 'operatorType' => CRM_Report_Form::OP_MULTISELECT,
1733 'options' => $contactTags,
1734 ),
1735 ),
1736 );
1737 }
1738 }
1739
1740 /**
1741 * Adds group filters to _columns (called from _Construct).
1742 */
1743 public function buildGroupFilter() {
1744 $this->_columns['civicrm_group']['filters'] = array(
1745 'gid' => array(
1746 'name' => 'group_id',
1747 'title' => ts('Group'),
1748 'type' => CRM_Utils_Type::T_INT,
1749 'operatorType' => CRM_Report_Form::OP_MULTISELECT,
1750 'group' => TRUE,
1751 'options' => CRM_Core_PseudoConstant::nestedGroup(),
1752 ),
1753 );
1754 if (empty($this->_columns['civicrm_group']['dao'])) {
1755 $this->_columns['civicrm_group']['dao'] = 'CRM_Contact_DAO_GroupContact';
1756 }
1757 if (empty($this->_columns['civicrm_group']['alias'])) {
1758 $this->_columns['civicrm_group']['alias'] = 'cgroup';
1759 }
1760 }
1761
1762 /**
1763 * Get SQL operator from form text version.
1764 *
1765 * @param string $operator
1766 *
1767 * @return string
1768 */
1769 public function getSQLOperator($operator = "like") {
1770 switch ($operator) {
1771 case 'eq':
1772 return '=';
1773
1774 case 'lt':
1775 return '<';
1776
1777 case 'lte':
1778 return '<=';
1779
1780 case 'gt':
1781 return '>';
1782
1783 case 'gte':
1784 return '>=';
1785
1786 case 'ne':
1787 case 'neq':
1788 return '!=';
1789
1790 case 'nhas':
1791 return 'NOT LIKE';
1792
1793 case 'in':
1794 return 'IN';
1795
1796 case 'notin':
1797 return 'NOT IN';
1798
1799 case 'nll':
1800 return 'IS NULL';
1801
1802 case 'nnll':
1803 return 'IS NOT NULL';
1804
1805 default:
1806 // type is string
1807 return 'LIKE';
1808 }
1809 }
1810
1811 /**
1812 * Generate where clause.
1813 *
1814 * This can be overridden in reports for special treatment of a field
1815 *
1816 * @param array $field Field specifications
1817 * @param string $op Query operator (not an exact match to sql)
1818 * @param mixed $value
1819 * @param float $min
1820 * @param float $max
1821 *
1822 * @return null|string
1823 */
1824 public function whereClause(&$field, $op, $value, $min, $max) {
1825
1826 $type = CRM_Utils_Type::typeToString(CRM_Utils_Array::value('type', $field));
1827
1828 // CRM-18010: Ensure type of each report filters
1829 if (!$type) {
1830 trigger_error('Type is not defined for field ' . $field['name'], E_USER_WARNING);
1831 }
1832 $clause = NULL;
1833
1834 switch ($op) {
1835 case 'bw':
1836 case 'nbw':
1837 if (($min !== NULL && strlen($min) > 0) ||
1838 ($max !== NULL && strlen($max) > 0)
1839 ) {
1840 $clauses = array();
1841 if ($min) {
1842 $min = CRM_Utils_Type::escape($min, $type);
1843 if ($op == 'bw') {
1844 $clauses[] = "( {$field['dbAlias']} >= $min )";
1845 }
1846 else {
1847 $clauses[] = "( {$field['dbAlias']} < $min OR {$field['dbAlias']} IS NULL )";
1848 }
1849 }
1850 if ($max) {
1851 $max = CRM_Utils_Type::escape($max, $type);
1852 if ($op == 'bw') {
1853 $clauses[] = "( {$field['dbAlias']} <= $max )";
1854 }
1855 else {
1856 $clauses[] = "( {$field['dbAlias']} > $max )";
1857 }
1858 }
1859
1860 if (!empty($clauses)) {
1861 if ($op == 'bw') {
1862 $clause = implode(' AND ', $clauses);
1863 }
1864 else {
1865 $clause = '(' . implode('OR', $clauses) . ')';
1866 }
1867 }
1868 }
1869 break;
1870
1871 case 'has':
1872 case 'nhas':
1873 if ($value !== NULL && strlen($value) > 0) {
1874 $value = CRM_Utils_Type::escape($value, $type);
1875 if (strpos($value, '%') === FALSE) {
1876 $value = "'%{$value}%'";
1877 }
1878 else {
1879 $value = "'{$value}'";
1880 }
1881 $sqlOP = $this->getSQLOperator($op);
1882 $clause = "( {$field['dbAlias']} $sqlOP $value )";
1883 }
1884 break;
1885
1886 case 'in':
1887 case 'notin':
1888 if ((is_string($value) || is_numeric($value)) && strlen($value)) {
1889 $value = explode(',', $value);
1890 }
1891 if ($value !== NULL && is_array($value) && count($value) > 0) {
1892 $sqlOP = $this->getSQLOperator($op);
1893 if (CRM_Utils_Array::value('type', $field) ==
1894 CRM_Utils_Type::T_STRING
1895 ) {
1896 //cycle through selections and escape values
1897 foreach ($value as $key => $selection) {
1898 $value[$key] = CRM_Utils_Type::escape($selection, $type);
1899 }
1900 $clause
1901 = "( {$field['dbAlias']} $sqlOP ( '" . implode("' , '", $value) .
1902 "') )";
1903 }
1904 else {
1905 // for numerical values
1906 $clause = "{$field['dbAlias']} $sqlOP (" . implode(', ', $value) .
1907 ")";
1908 }
1909 if ($op == 'notin') {
1910 $clause = "( " . $clause . " OR {$field['dbAlias']} IS NULL )";
1911 }
1912 else {
1913 $clause = "( " . $clause . " )";
1914 }
1915 }
1916 break;
1917
1918 case 'mhas':
1919 case 'mnot':
1920 // multiple has or multiple not
1921 if ($value !== NULL && count($value) > 0) {
1922 $value = CRM_Utils_Type::escapeAll($value, $type);
1923 $operator = $op == 'mnot' ? 'NOT' : '';
1924 $regexp = "([[:cntrl:]]|^)" . implode('([[:cntrl:]]|$)|([[:cntrl:]]|^)', (array) $value) . "([[:cntrl:]]|$)";
1925 $clause = "{$field['dbAlias']} {$operator} REGEXP '{$regexp}'";
1926 }
1927 break;
1928
1929 case 'sw':
1930 case 'ew':
1931 if ($value !== NULL && strlen($value) > 0) {
1932 $value = CRM_Utils_Type::escape($value, $type);
1933 if (strpos($value, '%') === FALSE) {
1934 if ($op == 'sw') {
1935 $value = "'{$value}%'";
1936 }
1937 else {
1938 $value = "'%{$value}'";
1939 }
1940 }
1941 else {
1942 $value = "'{$value}'";
1943 }
1944 $sqlOP = $this->getSQLOperator($op);
1945 $clause = "( {$field['dbAlias']} $sqlOP $value )";
1946 }
1947 break;
1948
1949 case 'nll':
1950 case 'nnll':
1951 $sqlOP = $this->getSQLOperator($op);
1952 $clause = "( {$field['dbAlias']} $sqlOP )";
1953 break;
1954
1955 case 'eq':
1956 case 'neq':
1957 case 'ne':
1958 //CRM-18457: some custom field passes value in array format against binary operator
1959 if (is_array($value) && count($value)) {
1960 $value = $value[0];
1961 }
1962
1963 default:
1964 if ($value !== NULL && $value !== '') {
1965 if (isset($field['clause'])) {
1966 // FIXME: we not doing escape here. Better solution is to use two
1967 // different types - data-type and filter-type
1968 $clause = $field['clause'];
1969 }
1970 elseif (!is_array($value)) {
1971 $value = CRM_Utils_Type::escape($value, $type);
1972 $sqlOP = $this->getSQLOperator($op);
1973 if ($field['type'] == CRM_Utils_Type::T_STRING) {
1974 $value = "'{$value}'";
1975 }
1976 $clause = "( {$field['dbAlias']} $sqlOP $value )";
1977 }
1978 }
1979 break;
1980 }
1981
1982 if (!empty($field['group']) && $clause) {
1983 $clause = $this->whereGroupClause($field, $value, $op);
1984 }
1985 elseif (!empty($field['tag']) && $clause) {
1986 // not using left join in query because if any contact
1987 // belongs to more than one tag, results duplicate
1988 // entries.
1989 $clause = $this->whereTagClause($field, $value, $op);
1990 }
1991 elseif (!empty($field['membership_org']) && $clause) {
1992 $clause = $this->whereMembershipOrgClause($value, $op);
1993 }
1994 elseif (!empty($field['membership_type']) && $clause) {
1995 $clause = $this->whereMembershipTypeClause($value, $op);
1996 }
1997 return $clause;
1998 }
1999
2000 /**
2001 * Get SQL where clause for a date field.
2002 *
2003 * @param string $fieldName
2004 * @param string $relative
2005 * @param string $from
2006 * @param string $to
2007 * @param string $type
2008 * @param string $fromTime
2009 * @param string $toTime
2010 *
2011 * @return null|string
2012 */
2013 public function dateClause(
2014 $fieldName,
2015 $relative, $from, $to, $type = NULL, $fromTime = NULL, $toTime = NULL
2016 ) {
2017 $clauses = array();
2018 if (in_array($relative, array_keys($this->getOperationPair(CRM_Report_Form::OP_DATE)))) {
2019 $sqlOP = $this->getSQLOperator($relative);
2020 return "( {$fieldName} {$sqlOP} )";
2021 }
2022
2023 list($from, $to) = $this->getFromTo($relative, $from, $to, $fromTime, $toTime);
2024
2025 if ($from) {
2026 $from = ($type == CRM_Utils_Type::T_DATE) ? substr($from, 0, 8) : $from;
2027 $clauses[] = "( {$fieldName} >= $from )";
2028 }
2029
2030 if ($to) {
2031 $to = ($type == CRM_Utils_Type::T_DATE) ? substr($to, 0, 8) : $to;
2032 $clauses[] = "( {$fieldName} <= {$to} )";
2033 }
2034
2035 if (!empty($clauses)) {
2036 return implode(' AND ', $clauses);
2037 }
2038
2039 return NULL;
2040 }
2041
2042 /**
2043 * Get values for from and to for date ranges.
2044 *
2045 * @param bool $relative
2046 * @param string $from
2047 * @param string $to
2048 * @param string $fromTime
2049 * @param string $toTime
2050 *
2051 * @return array
2052 */
2053 public function getFromTo($relative, $from, $to, $fromTime = NULL, $toTime = NULL) {
2054 if (empty($toTime)) {
2055 $toTime = '235959';
2056 }
2057 //FIX ME not working for relative
2058 if ($relative) {
2059 list($term, $unit) = CRM_Utils_System::explode('.', $relative, 2);
2060 $dateRange = CRM_Utils_Date::relativeToAbsolute($term, $unit);
2061 $from = substr($dateRange['from'], 0, 8);
2062 //Take only Date Part, Sometime Time part is also present in 'to'
2063 $to = substr($dateRange['to'], 0, 8);
2064 }
2065 $from = CRM_Utils_Date::processDate($from, $fromTime);
2066 $to = CRM_Utils_Date::processDate($to, $toTime);
2067 return array($from, $to);
2068 }
2069
2070 /**
2071 * Alter display of rows.
2072 *
2073 * Iterate through the rows retrieved via SQL and make changes for display purposes,
2074 * such as rendering contacts as links.
2075 *
2076 * @param array $rows
2077 * Rows generated by SQL, with an array for each row.
2078 */
2079 public function alterDisplay(&$rows) {
2080 }
2081
2082 /**
2083 * Alter the way in which custom data fields are displayed.
2084 *
2085 * @param array $rows
2086 */
2087 public function alterCustomDataDisplay(&$rows) {
2088 // custom code to alter rows having custom values
2089 if (empty($this->_customGroupExtends)) {
2090 return;
2091 }
2092
2093 $customFields = array();
2094 $customFieldIds = array();
2095 foreach ($this->_params['fields'] as $fieldAlias => $value) {
2096 if ($fieldId = CRM_Core_BAO_CustomField::getKeyID($fieldAlias)) {
2097 $customFieldIds[$fieldAlias] = $fieldId;
2098 }
2099 }
2100 if (empty($customFieldIds)) {
2101 return;
2102 }
2103
2104 // skip for type date and ContactReference since date format is already handled
2105 $query = "
2106 SELECT cg.table_name, cf.id
2107 FROM civicrm_custom_field cf
2108 INNER JOIN civicrm_custom_group cg ON cg.id = cf.custom_group_id
2109 WHERE cg.extends IN ('" . implode("','", $this->_customGroupExtends) . "') AND
2110 cg.is_active = 1 AND
2111 cf.is_active = 1 AND
2112 cf.is_searchable = 1 AND
2113 cf.data_type NOT IN ('ContactReference', 'Date') AND
2114 cf.id IN (" . implode(",", $customFieldIds) . ")";
2115
2116 $dao = CRM_Core_DAO::executeQuery($query);
2117 while ($dao->fetch()) {
2118 $customFields[$dao->table_name . '_custom_' . $dao->id] = $dao->id;
2119 }
2120 $dao->free();
2121
2122 $entryFound = FALSE;
2123 foreach ($rows as $rowNum => $row) {
2124 foreach ($row as $tableCol => $val) {
2125 if (array_key_exists($tableCol, $customFields)) {
2126 $rows[$rowNum][$tableCol] = CRM_Core_BAO_CustomField::displayValue($val, $customFields[$tableCol]);
2127 $entryFound = TRUE;
2128 }
2129 }
2130
2131 // skip looking further in rows, if first row itself doesn't
2132 // have the column we need
2133 if (!$entryFound) {
2134 break;
2135 }
2136 }
2137 }
2138
2139 /**
2140 * Remove duplicate rows.
2141 *
2142 * @param array $rows
2143 */
2144 public function removeDuplicates(&$rows) {
2145 if (empty($this->_noRepeats)) {
2146 return;
2147 }
2148 $checkList = array();
2149
2150 foreach ($rows as $key => $list) {
2151 foreach ($list as $colName => $colVal) {
2152 if (array_key_exists($colName, $checkList) &&
2153 $checkList[$colName] == $colVal
2154 ) {
2155 $rows[$key][$colName] = "";
2156 }
2157 if (in_array($colName, $this->_noRepeats)) {
2158 $checkList[$colName] = $colVal;
2159 }
2160 }
2161 }
2162 }
2163
2164 /**
2165 * Fix subtotal display.
2166 *
2167 * @param array $row
2168 * @param array $fields
2169 * @param bool $subtotal
2170 */
2171 public function fixSubTotalDisplay(&$row, $fields, $subtotal = TRUE) {
2172 foreach ($row as $colName => $colVal) {
2173 if (in_array($colName, $fields)) {
2174 }
2175 elseif (isset($this->_columnHeaders[$colName])) {
2176 if ($subtotal) {
2177 $row[$colName] = 'Subtotal';
2178 $subtotal = FALSE;
2179 }
2180 else {
2181 unset($row[$colName]);
2182 }
2183 }
2184 }
2185 }
2186
2187 /**
2188 * Calculate grant total.
2189 *
2190 * @param array $rows
2191 *
2192 * @return bool
2193 */
2194 public function grandTotal(&$rows) {
2195 if (!$this->_rollup || count($rows) == 1) {
2196 return FALSE;
2197 }
2198
2199 $this->moveSummaryColumnsToTheRightHandSide();
2200
2201 if ($this->_limit && count($rows) >= self::ROW_COUNT_LIMIT) {
2202 return FALSE;
2203 }
2204
2205 $this->rollupRow = array_pop($rows);
2206
2207 foreach ($this->_columnHeaders as $fld => $val) {
2208 if (!in_array($fld, $this->_statFields)) {
2209 if (!$this->_grandFlag) {
2210 $this->rollupRow[$fld] = ts('Grand Total');
2211 $this->_grandFlag = TRUE;
2212 }
2213 else {
2214 $this->rollupRow[$fld] = "";
2215 }
2216 }
2217 }
2218
2219 $this->assign('grandStat', $this->rollupRow);
2220 return TRUE;
2221 }
2222
2223 /**
2224 * Format display output.
2225 *
2226 * @param array $rows
2227 * @param bool $pager
2228 */
2229 public function formatDisplay(&$rows, $pager = TRUE) {
2230 // set pager based on if any limit was applied in the query.
2231 if ($pager) {
2232 $this->setPager();
2233 }
2234
2235 // allow building charts if any
2236 if (!empty($this->_params['charts']) && !empty($rows)) {
2237 $this->buildChart($rows);
2238 $this->assign('chartEnabled', TRUE);
2239 $this->_chartId = "{$this->_params['charts']}_" .
2240 ($this->_id ? $this->_id : substr(get_class($this), 16)) . '_' .
2241 session_id();
2242 $this->assign('chartId', $this->_chartId);
2243 }
2244
2245 // unset columns not to be displayed.
2246 foreach ($this->_columnHeaders as $key => $value) {
2247 if (!empty($value['no_display'])) {
2248 unset($this->_columnHeaders[$key]);
2249 }
2250 }
2251
2252 // unset columns not to be displayed.
2253 if (!empty($rows)) {
2254 foreach ($this->_noDisplay as $noDisplayField) {
2255 foreach ($rows as $rowNum => $row) {
2256 unset($this->_columnHeaders[$noDisplayField]);
2257 }
2258 }
2259 }
2260
2261 // build array of section totals
2262 $this->sectionTotals();
2263
2264 // process grand-total row
2265 $this->grandTotal($rows);
2266
2267 // use this method for formatting rows for display purpose.
2268 $this->alterDisplay($rows);
2269 CRM_Utils_Hook::alterReportVar('rows', $rows, $this);
2270
2271 // use this method for formatting custom rows for display purpose.
2272 $this->alterCustomDataDisplay($rows);
2273 }
2274
2275 /**
2276 * Build chart.
2277 *
2278 * @param array $rows
2279 */
2280 public function buildChart(&$rows) {
2281 // override this method for building charts.
2282 }
2283
2284 // select() method below has been added recently (v3.3), and many of the report templates might
2285 // still be having their own select() method. We should fix them as and when encountered and move
2286 // towards generalizing the select() method below.
2287
2288 /**
2289 * Generate the SELECT clause and set class variable $_select.
2290 */
2291 public function select() {
2292 $select = $this->_selectAliases = array();
2293
2294 foreach ($this->_columns as $tableName => $table) {
2295 if (array_key_exists('fields', $table)) {
2296 foreach ($table['fields'] as $fieldName => $field) {
2297 if ($tableName == 'civicrm_address') {
2298 $this->_addressField = TRUE;
2299 }
2300 if ($tableName == 'civicrm_email') {
2301 $this->_emailField = TRUE;
2302 }
2303 if ($tableName == 'civicrm_phone') {
2304 $this->_phoneField = TRUE;
2305 }
2306
2307 if (!empty($field['required']) ||
2308 !empty($this->_params['fields'][$fieldName])
2309 ) {
2310
2311 // 1. In many cases we want select clause to be built in slightly different way
2312 // for a particular field of a particular type.
2313 // 2. This method when used should receive params by reference and modify $this->_columnHeaders
2314 // as needed.
2315 $selectClause = $this->selectClause($tableName, 'fields', $fieldName, $field);
2316 if ($selectClause) {
2317 $select[] = $selectClause;
2318 continue;
2319 }
2320
2321 // include statistics columns only if set
2322 if (!empty($field['statistics'])) {
2323 foreach ($field['statistics'] as $stat => $label) {
2324 $alias = "{$tableName}_{$fieldName}_{$stat}";
2325 switch (strtolower($stat)) {
2326 case 'max':
2327 case 'sum':
2328 $select[] = "$stat({$field['dbAlias']}) as $alias";
2329 $this->_columnHeaders["{$tableName}_{$fieldName}_{$stat}"]['title'] = $label;
2330 $this->_columnHeaders["{$tableName}_{$fieldName}_{$stat}"]['type'] = $field['type'];
2331 $this->_statFields[$label] = $alias;
2332 $this->_selectAliases[] = $alias;
2333 break;
2334
2335 case 'count':
2336 $select[] = "COUNT({$field['dbAlias']}) as $alias";
2337 $this->_columnHeaders["{$tableName}_{$fieldName}_{$stat}"]['title'] = $label;
2338 $this->_columnHeaders["{$tableName}_{$fieldName}_{$stat}"]['type'] = CRM_Utils_Type::T_INT;
2339 $this->_statFields[$label] = $alias;
2340 $this->_selectAliases[] = $alias;
2341 break;
2342
2343 case 'count_distinct':
2344 $select[] = "COUNT(DISTINCT {$field['dbAlias']}) as $alias";
2345 $this->_columnHeaders["{$tableName}_{$fieldName}_{$stat}"]['title'] = $label;
2346 $this->_columnHeaders["{$tableName}_{$fieldName}_{$stat}"]['type'] = CRM_Utils_Type::T_INT;
2347 $this->_statFields[$label] = $alias;
2348 $this->_selectAliases[] = $alias;
2349 break;
2350
2351 case 'avg':
2352 $select[] = "ROUND(AVG({$field['dbAlias']}),2) as $alias";
2353 $this->_columnHeaders["{$tableName}_{$fieldName}_{$stat}"]['title'] = $label;
2354 $this->_columnHeaders["{$tableName}_{$fieldName}_{$stat}"]['type'] = $field['type'];
2355 $this->_statFields[$label] = $alias;
2356 $this->_selectAliases[] = $alias;
2357 break;
2358 }
2359 }
2360 }
2361 else {
2362 $alias = "{$tableName}_{$fieldName}";
2363 $select[] = "{$field['dbAlias']} as $alias";
2364 $this->_columnHeaders["{$tableName}_{$fieldName}"]['title'] = CRM_Utils_Array::value('title', $field);
2365 $this->_columnHeaders["{$tableName}_{$fieldName}"]['type'] = CRM_Utils_Array::value('type', $field);
2366 $this->_selectAliases[] = $alias;
2367 }
2368 }
2369 }
2370 }
2371
2372 // select for group bys
2373 if (array_key_exists('group_bys', $table)) {
2374 foreach ($table['group_bys'] as $fieldName => $field) {
2375
2376 if ($tableName == 'civicrm_address') {
2377 $this->_addressField = TRUE;
2378 }
2379 if ($tableName == 'civicrm_email') {
2380 $this->_emailField = TRUE;
2381 }
2382 if ($tableName == 'civicrm_phone') {
2383 $this->_phoneField = TRUE;
2384 }
2385 // 1. In many cases we want select clause to be built in slightly different way
2386 // for a particular field of a particular type.
2387 // 2. This method when used should receive params by reference and modify $this->_columnHeaders
2388 // as needed.
2389 $selectClause = $this->selectClause($tableName, 'group_bys', $fieldName, $field);
2390 if ($selectClause) {
2391 $select[] = $selectClause;
2392 continue;
2393 }
2394
2395 if (!empty($this->_params['group_bys']) &&
2396 !empty($this->_params['group_bys'][$fieldName]) &&
2397 !empty($this->_params['group_bys_freq'])
2398 ) {
2399 switch (CRM_Utils_Array::value($fieldName, $this->_params['group_bys_freq'])) {
2400 case 'YEARWEEK':
2401 $select[] = "DATE_SUB({$field['dbAlias']}, INTERVAL WEEKDAY({$field['dbAlias']}) DAY) AS {$tableName}_{$fieldName}_start";
2402 $select[] = "YEARWEEK({$field['dbAlias']}) AS {$tableName}_{$fieldName}_subtotal";
2403 $select[] = "WEEKOFYEAR({$field['dbAlias']}) AS {$tableName}_{$fieldName}_interval";
2404 $field['title'] = 'Week';
2405 break;
2406
2407 case 'YEAR':
2408 $select[] = "MAKEDATE(YEAR({$field['dbAlias']}), 1) AS {$tableName}_{$fieldName}_start";
2409 $select[] = "YEAR({$field['dbAlias']}) AS {$tableName}_{$fieldName}_subtotal";
2410 $select[] = "YEAR({$field['dbAlias']}) AS {$tableName}_{$fieldName}_interval";
2411 $field['title'] = 'Year';
2412 break;
2413
2414 case 'MONTH':
2415 $select[] = "DATE_SUB({$field['dbAlias']}, INTERVAL (DAYOFMONTH({$field['dbAlias']})-1) DAY) as {$tableName}_{$fieldName}_start";
2416 $select[] = "MONTH({$field['dbAlias']}) AS {$tableName}_{$fieldName}_subtotal";
2417 $select[] = "MONTHNAME({$field['dbAlias']}) AS {$tableName}_{$fieldName}_interval";
2418 $field['title'] = 'Month';
2419 break;
2420
2421 case 'QUARTER':
2422 $select[] = "STR_TO_DATE(CONCAT( 3 * QUARTER( {$field['dbAlias']} ) -2 , '/', '1', '/', YEAR( {$field['dbAlias']} ) ), '%m/%d/%Y') AS {$tableName}_{$fieldName}_start";
2423 $select[] = "QUARTER({$field['dbAlias']}) AS {$tableName}_{$fieldName}_subtotal";
2424 $select[] = "QUARTER({$field['dbAlias']}) AS {$tableName}_{$fieldName}_interval";
2425 $field['title'] = 'Quarter';
2426 break;
2427 }
2428 // for graphs and charts -
2429 if (!empty($this->_params['group_bys_freq'][$fieldName])) {
2430 $this->_interval = $field['title'];
2431 $this->_columnHeaders["{$tableName}_{$fieldName}_start"]['title']
2432 = $field['title'] . ' Beginning';
2433 $this->_columnHeaders["{$tableName}_{$fieldName}_start"]['type'] = $field['type'];
2434 $this->_columnHeaders["{$tableName}_{$fieldName}_start"]['group_by'] = $this->_params['group_bys_freq'][$fieldName];
2435
2436 // just to make sure these values are transferred to rows.
2437 // since we 'll need them for calculation purpose,
2438 // e.g making subtotals look nicer or graphs
2439 $this->_columnHeaders["{$tableName}_{$fieldName}_interval"] = array('no_display' => TRUE);
2440 $this->_columnHeaders["{$tableName}_{$fieldName}_subtotal"] = array('no_display' => TRUE);
2441 }
2442 }
2443 }
2444 }
2445 }
2446
2447 $this->_selectClauses = $select;
2448 $this->_select = "SELECT " . implode(', ', $select) . " ";
2449 }
2450
2451 /**
2452 * Build select clause for a single field.
2453 *
2454 * @param string $tableName
2455 * @param string $tableKey
2456 * @param string $fieldName
2457 * @param string $field
2458 *
2459 * @return bool
2460 */
2461 public function selectClause(&$tableName, $tableKey, &$fieldName, &$field) {
2462 return FALSE;
2463 }
2464
2465 /**
2466 * Build where clause.
2467 */
2468 public function where() {
2469 $this->storeWhereHavingClauseArray();
2470
2471 if (empty($this->_whereClauses)) {
2472 $this->_where = "WHERE ( 1 ) ";
2473 $this->_having = "";
2474 }
2475 else {
2476 $this->_where = "WHERE " . implode(' AND ', $this->_whereClauses);
2477 }
2478
2479 if ($this->_aclWhere) {
2480 $this->_where .= " AND {$this->_aclWhere} ";
2481 }
2482
2483 if (!empty($this->_havingClauses)) {
2484 // use this clause to construct group by clause.
2485 $this->_having = "HAVING " . implode(' AND ', $this->_havingClauses);
2486 }
2487 }
2488
2489 /**
2490 * Store Where clauses into an array.
2491 *
2492 * Breaking out this step makes over-riding more flexible as the clauses can be used in constructing a
2493 * temp table that may not be part of the final where clause or added
2494 * in other functions
2495 */
2496 public function storeWhereHavingClauseArray() {
2497 foreach ($this->_columns as $tableName => $table) {
2498 if (array_key_exists('filters', $table)) {
2499 foreach ($table['filters'] as $fieldName => $field) {
2500 // respect pseudofield to filter spec so fields can be marked as
2501 // not to be handled here
2502 if (!empty($field['pseudofield'])) {
2503 continue;
2504 }
2505 $clause = NULL;
2506 if (CRM_Utils_Array::value('type', $field) & CRM_Utils_Type::T_DATE) {
2507 if (CRM_Utils_Array::value('operatorType', $field) ==
2508 CRM_Report_Form::OP_MONTH
2509 ) {
2510 $op = CRM_Utils_Array::value("{$fieldName}_op", $this->_params);
2511 $value = CRM_Utils_Array::value("{$fieldName}_value", $this->_params);
2512 if (is_array($value) && !empty($value)) {
2513 $clause
2514 = "(month({$field['dbAlias']}) $op (" . implode(', ', $value) .
2515 '))';
2516 }
2517 }
2518 else {
2519 $relative = CRM_Utils_Array::value("{$fieldName}_relative", $this->_params);
2520 $from = CRM_Utils_Array::value("{$fieldName}_from", $this->_params);
2521 $to = CRM_Utils_Array::value("{$fieldName}_to", $this->_params);
2522 $fromTime = CRM_Utils_Array::value("{$fieldName}_from_time", $this->_params);
2523 $toTime = CRM_Utils_Array::value("{$fieldName}_to_time", $this->_params);
2524 $clause = $this->dateClause($field['dbAlias'], $relative, $from, $to, $field['type'], $fromTime, $toTime);
2525 }
2526 }
2527 else {
2528 $op = CRM_Utils_Array::value("{$fieldName}_op", $this->_params);
2529 if ($op) {
2530 $clause = $this->whereClause($field,
2531 $op,
2532 CRM_Utils_Array::value("{$fieldName}_value", $this->_params),
2533 CRM_Utils_Array::value("{$fieldName}_min", $this->_params),
2534 CRM_Utils_Array::value("{$fieldName}_max", $this->_params)
2535 );
2536 }
2537 }
2538
2539 if (!empty($clause)) {
2540 if (!empty($field['having'])) {
2541 $this->_havingClauses[] = $clause;
2542 }
2543 else {
2544 $this->_whereClauses[] = $clause;
2545 }
2546 }
2547 }
2548 }
2549 }
2550
2551 }
2552
2553 /**
2554 * Set output mode.
2555 */
2556 public function processReportMode() {
2557 $this->setOutputMode();
2558
2559 $this->_sendmail
2560 = CRM_Utils_Request::retrieve(
2561 'sendmail',
2562 'Boolean',
2563 CRM_Core_DAO::$_nullObject
2564 );
2565
2566 $this->_absoluteUrl = FALSE;
2567 $printOnly = FALSE;
2568 $this->assign('printOnly', FALSE);
2569
2570 if ($this->_outputMode == 'print' ||
2571 ($this->_sendmail && !$this->_outputMode)
2572 ) {
2573 $this->assign('printOnly', TRUE);
2574 $printOnly = TRUE;
2575 $this->addPaging = FALSE;
2576 $this->assign('outputMode', 'print');
2577 $this->_outputMode = 'print';
2578 if ($this->_sendmail) {
2579 $this->_absoluteUrl = TRUE;
2580 }
2581 }
2582 elseif ($this->_outputMode == 'pdf') {
2583 $printOnly = TRUE;
2584 $this->addPaging = FALSE;
2585 $this->_absoluteUrl = TRUE;
2586 }
2587 elseif ($this->_outputMode == 'csv') {
2588 $printOnly = TRUE;
2589 $this->_absoluteUrl = TRUE;
2590 $this->addPaging = FALSE;
2591 }
2592 elseif ($this->_outputMode == 'group') {
2593 $this->assign('outputMode', 'group');
2594 }
2595 elseif ($this->_outputMode == 'create_report' && $this->_criteriaForm) {
2596 $this->assign('outputMode', 'create_report');
2597 }
2598 elseif ($this->_outputMode == 'copy' && $this->_criteriaForm) {
2599 $this->_createNew = TRUE;
2600 }
2601
2602 $this->assign('outputMode', $this->_outputMode);
2603 $this->assign('printOnly', $printOnly);
2604 // Get today's date to include in printed reports
2605 if ($printOnly) {
2606 $reportDate = CRM_Utils_Date::customFormat(date('Y-m-d H:i'));
2607 $this->assign('reportDate', $reportDate);
2608 }
2609 }
2610
2611 /**
2612 * Post Processing function for Form.
2613 *
2614 * postProcessCommon should be used to set other variables from input as the api accesses that function.
2615 * This function is not accessed when the api calls the report.
2616 */
2617 public function beginPostProcess() {
2618 $this->setParams($this->controller->exportValues($this->_name));
2619 if (empty($this->_params) &&
2620 $this->_force
2621 ) {
2622 $this->setParams($this->_formValues);
2623 }
2624
2625 // hack to fix params when submitted from dashboard, CRM-8532
2626 // fields array is missing because form building etc is skipped
2627 // in dashboard mode for report
2628 //@todo - this could be done in the dashboard no we have a setter
2629 if (empty($this->_params['fields']) && !$this->_noFields) {
2630 $this->setParams($this->_formValues);
2631 }
2632
2633 $this->processReportMode();
2634
2635 if ($this->_outputMode == 'save' || $this->_outputMode == 'copy') {
2636 $this->_createNew = ($this->_outputMode == 'copy');
2637 CRM_Report_Form_Instance::postProcess($this);
2638 }
2639 if ($this->_outputMode == 'delete') {
2640 CRM_Report_BAO_ReportInstance::doFormDelete($this->_id, 'civicrm/report/list?reset=1', 'civicrm/report/list?reset=1');
2641 }
2642
2643 $this->_formValues = $this->_params;
2644
2645 $this->beginPostProcessCommon();
2646 }
2647
2648 /**
2649 * BeginPostProcess function run in both report mode and non-report mode (api).
2650 */
2651 public function beginPostProcessCommon() {
2652 }
2653
2654 /**
2655 * Build the report query.
2656 *
2657 * @param bool $applyLimit
2658 *
2659 * @return string
2660 */
2661 public function buildQuery($applyLimit = TRUE) {
2662 $this->buildGroupTempTable();
2663 $this->select();
2664 $this->from();
2665 $this->customDataFrom();
2666 $this->where();
2667 if (array_key_exists('civicrm_contribution', $this->getVar('_columns'))) {
2668 $this->getPermissionedFTQuery($this);
2669 }
2670 $this->groupBy();
2671 $this->orderBy();
2672
2673 // order_by columns not selected for display need to be included in SELECT
2674 $unselectedSectionColumns = $this->unselectedSectionColumns();
2675 foreach ($unselectedSectionColumns as $alias => $section) {
2676 $this->_select .= ", {$section['dbAlias']} as {$alias}";
2677 }
2678
2679 if ($applyLimit && empty($this->_params['charts'])) {
2680 $this->limit();
2681 }
2682 CRM_Utils_Hook::alterReportVar('sql', $this, $this);
2683
2684 $sql = "{$this->_select} {$this->_from} {$this->_where} {$this->_groupBy} {$this->_having} {$this->_orderBy} {$this->_limit}";
2685 $this->addToDeveloperTab($sql);
2686 return $sql;
2687 }
2688
2689 /**
2690 * Build group by clause.
2691 */
2692 public function groupBy() {
2693 $groupBys = array();
2694 if (!empty($this->_params['group_bys']) &&
2695 is_array($this->_params['group_bys'])
2696 ) {
2697 foreach ($this->_columns as $tableName => $table) {
2698 if (array_key_exists('group_bys', $table)) {
2699 foreach ($table['group_bys'] as $fieldName => $field) {
2700 if (!empty($this->_params['group_bys'][$fieldName])) {
2701 $groupBys[] = $field['dbAlias'];
2702 }
2703 }
2704 }
2705 }
2706 }
2707
2708 if (!empty($groupBys)) {
2709 $this->_groupBy = CRM_Contact_BAO_Query::getGroupByFromSelectColumns($this->_selectClauses, $groupBys);
2710 }
2711 }
2712
2713 /**
2714 * Build order by clause.
2715 */
2716 public function orderBy() {
2717 $this->_orderBy = "";
2718 $this->_sections = array();
2719 $this->storeOrderByArray();
2720 if (!empty($this->_orderByArray) && !$this->_rollup == 'WITH ROLLUP') {
2721 $this->_orderBy = "ORDER BY " . implode(', ', $this->_orderByArray);
2722 }
2723 $this->assign('sections', $this->_sections);
2724 }
2725
2726 /**
2727 * Extract order by fields and store as an array.
2728 *
2729 * In some cases other functions want to know which fields are selected for ordering by
2730 * Separating this into a separate function allows it to be called separately from constructing
2731 * the order by clause
2732 */
2733 public function storeOrderByArray() {
2734 $orderBys = array();
2735
2736 if (!empty($this->_params['order_bys']) &&
2737 is_array($this->_params['order_bys']) &&
2738 !empty($this->_params['order_bys'])
2739 ) {
2740
2741 // Process order_bys in user-specified order
2742 foreach ($this->_params['order_bys'] as $orderBy) {
2743 $orderByField = array();
2744 foreach ($this->_columns as $tableName => $table) {
2745 if (array_key_exists('order_bys', $table)) {
2746 // For DAO columns defined in $this->_columns
2747 $fields = $table['order_bys'];
2748 }
2749 elseif (array_key_exists('extends', $table)) {
2750 // For custom fields referenced in $this->_customGroupExtends
2751 $fields = CRM_Utils_Array::value('fields', $table, array());
2752 }
2753 else {
2754 continue;
2755 }
2756 if (!empty($fields) && is_array($fields)) {
2757 foreach ($fields as $fieldName => $field) {
2758 if ($fieldName == $orderBy['column']) {
2759 $orderByField = array_merge($field, $orderBy);
2760 $orderByField['tplField'] = "{$tableName}_{$fieldName}";
2761 break 2;
2762 }
2763 }
2764 }
2765 }
2766
2767 if (!empty($orderByField)) {
2768 $this->_orderByFields[$orderByField['tplField']] = $orderByField;
2769 $orderBys[] = "{$orderByField['dbAlias']} {$orderBy['order']}";
2770
2771 // Record any section headers for assignment to the template
2772 if (!empty($orderBy['section'])) {
2773 $orderByField['pageBreak'] = CRM_Utils_Array::value('pageBreak', $orderBy);
2774 $this->_sections[$orderByField['tplField']] = $orderByField;
2775 }
2776 }
2777 }
2778 }
2779
2780 $this->_orderByArray = $orderBys;
2781
2782 $this->assign('sections', $this->_sections);
2783 }
2784
2785 /**
2786 * Determine unselected columns.
2787 *
2788 * @return array
2789 */
2790 public function unselectedSectionColumns() {
2791 if (is_array($this->_sections)) {
2792 return array_diff_key($this->_sections, $this->getSelectColumns());
2793 }
2794 else {
2795 return array();
2796 }
2797 }
2798
2799 /**
2800 * Build output rows.
2801 *
2802 * @param string $sql
2803 * @param array $rows
2804 */
2805 public function buildRows($sql, &$rows) {
2806 $dao = CRM_Core_DAO::executeQuery($sql);
2807 if (!is_array($rows)) {
2808 $rows = array();
2809 }
2810
2811 // use this method to modify $this->_columnHeaders
2812 $this->modifyColumnHeaders();
2813
2814 $unselectedSectionColumns = $this->unselectedSectionColumns();
2815
2816 while ($dao->fetch()) {
2817 $row = array();
2818 foreach ($this->_columnHeaders as $key => $value) {
2819 if (property_exists($dao, $key)) {
2820 $row[$key] = $dao->$key;
2821 }
2822 }
2823
2824 // section headers not selected for display need to be added to row
2825 foreach ($unselectedSectionColumns as $key => $values) {
2826 if (property_exists($dao, $key)) {
2827 $row[$key] = $dao->$key;
2828 }
2829 }
2830
2831 $rows[] = $row;
2832 }
2833 }
2834
2835 /**
2836 * Calculate section totals.
2837 *
2838 * When "order by" fields are marked as sections, this assigns to the template
2839 * an array of total counts for each section. This data is used by the Smarty
2840 * plugin {sectionTotal}.
2841 */
2842 public function sectionTotals() {
2843
2844 // Reports using order_bys with sections must populate $this->_selectAliases in select() method.
2845 if (empty($this->_selectAliases)) {
2846 return;
2847 }
2848
2849 if (!empty($this->_sections)) {
2850 // build the query with no LIMIT clause
2851 $select = str_ireplace('SELECT SQL_CALC_FOUND_ROWS ', 'SELECT ', $this->_select);
2852 $sql = "{$select} {$this->_from} {$this->_where} {$this->_groupBy} {$this->_having} {$this->_orderBy}";
2853
2854 // pull section aliases out of $this->_sections
2855 $sectionAliases = array_keys($this->_sections);
2856
2857 $ifnulls = array();
2858 foreach (array_merge($sectionAliases, $this->_selectAliases) as $alias) {
2859 $ifnulls[] = "ifnull($alias, '') as $alias";
2860 }
2861 $this->_select = "SELECT " . implode(", ", $ifnulls);
2862 $this->_select = CRM_Contact_BAO_Query::appendAnyValueToSelect($ifnulls, $sectionAliases);
2863
2864 // Group (un-limited) report by all aliases and get counts. This might
2865 // be done more efficiently when the contents of $sql are known, ie. by
2866 // overriding this method in the report class.
2867
2868 $query = $this->_select .
2869 ", count(*) as ct from ($sql) as subquery group by " .
2870 implode(", ", $sectionAliases);
2871
2872 // initialize array of total counts
2873 $totals = array();
2874 $dao = CRM_Core_DAO::executeQuery($query);
2875 while ($dao->fetch()) {
2876
2877 // let $this->_alterDisplay translate any integer ids to human-readable values.
2878 $rows[0] = $dao->toArray();
2879 $this->alterDisplay($rows);
2880 $row = $rows[0];
2881
2882 // add totals for all permutations of section values
2883 $values = array();
2884 $i = 1;
2885 $aliasCount = count($sectionAliases);
2886 foreach ($sectionAliases as $alias) {
2887 $values[] = $row[$alias];
2888 $key = implode(CRM_Core_DAO::VALUE_SEPARATOR, $values);
2889 if ($i == $aliasCount) {
2890 // the last alias is the lowest-level section header; use count as-is
2891 $totals[$key] = $dao->ct;
2892 }
2893 else {
2894 // other aliases are higher level; roll count into their total
2895 $totals[$key] += $dao->ct;
2896 }
2897 }
2898 }
2899 $this->assign('sectionTotals', $totals);
2900 }
2901 }
2902
2903 /**
2904 * Modify column headers.
2905 */
2906 public function modifyColumnHeaders() {
2907 // use this method to modify $this->_columnHeaders
2908 }
2909
2910 /**
2911 * Move totals columns to the right edge of the table.
2912 *
2913 * It seems like a more logical layout to have any totals columns on the far right regardless of
2914 * the location of the rest of their table.
2915 */
2916 public function moveSummaryColumnsToTheRightHandSide() {
2917 $statHeaders = (array_intersect_key($this->_columnHeaders, array_flip($this->_statFields)));
2918 $this->_columnHeaders = array_merge(array_diff_key($this->_columnHeaders, $statHeaders), $this->_columnHeaders, $statHeaders);
2919 }
2920
2921 /**
2922 * Assign rows to the template.
2923 *
2924 * @param array $rows
2925 */
2926 public function doTemplateAssignment(&$rows) {
2927 $this->assign_by_ref('columnHeaders', $this->_columnHeaders);
2928 $this->assign_by_ref('rows', $rows);
2929 $this->assign('statistics', $this->statistics($rows));
2930 }
2931
2932 /**
2933 * Build report statistics.
2934 *
2935 * Override this method to build your own statistics.
2936 *
2937 * @param array $rows
2938 *
2939 * @return array
2940 */
2941 public function statistics(&$rows) {
2942 $statistics = array();
2943
2944 $count = count($rows);
2945 // Why do we increment the count for rollup seems to artificially inflate the count.
2946 // It seems perhaps intentional to include the summary row in the count of results - although
2947 // this just seems odd.
2948 if ($this->_rollup && ($this->_rollup != '') && $this->_grandFlag) {
2949 $count++;
2950 }
2951
2952 $this->countStat($statistics, $count);
2953
2954 $this->groupByStat($statistics);
2955
2956 $this->filterStat($statistics);
2957
2958 return $statistics;
2959 }
2960
2961 /**
2962 * Add count statistics.
2963 *
2964 * @param array $statistics
2965 * @param int $count
2966 */
2967 public function countStat(&$statistics, $count) {
2968 $statistics['counts']['rowCount'] = array(
2969 'title' => ts('Row(s) Listed'),
2970 'value' => $count,
2971 );
2972
2973 if ($this->_rowsFound && ($this->_rowsFound > $count)) {
2974 $statistics['counts']['rowsFound'] = array(
2975 'title' => ts('Total Row(s)'),
2976 'value' => $this->_rowsFound,
2977 );
2978 }
2979 }
2980
2981 /**
2982 * Add group by statistics.
2983 *
2984 * @param array $statistics
2985 */
2986 public function groupByStat(&$statistics) {
2987 if (!empty($this->_params['group_bys']) &&
2988 is_array($this->_params['group_bys']) &&
2989 !empty($this->_params['group_bys'])
2990 ) {
2991 foreach ($this->_columns as $tableName => $table) {
2992 if (array_key_exists('group_bys', $table)) {
2993 foreach ($table['group_bys'] as $fieldName => $field) {
2994 if (!empty($this->_params['group_bys'][$fieldName])) {
2995 $combinations[] = $field['title'];
2996 }
2997 }
2998 }
2999 }
3000 $statistics['groups'][] = array(
3001 'title' => ts('Grouping(s)'),
3002 'value' => implode(' & ', $combinations),
3003 );
3004 }
3005 }
3006
3007 /**
3008 * Filter statistics.
3009 *
3010 * @param array $statistics
3011 */
3012 public function filterStat(&$statistics) {
3013 foreach ($this->_columns as $tableName => $table) {
3014 if (array_key_exists('filters', $table)) {
3015 foreach ($table['filters'] as $fieldName => $field) {
3016 if ((CRM_Utils_Array::value('type', $field) & CRM_Utils_Type::T_DATE ||
3017 CRM_Utils_Array::value('type', $field) & CRM_Utils_Type::T_TIME) &&
3018 CRM_Utils_Array::value('operatorType', $field) !=
3019 CRM_Report_Form::OP_MONTH
3020 ) {
3021 list($from, $to)
3022 = $this->getFromTo(
3023 CRM_Utils_Array::value("{$fieldName}_relative", $this->_params),
3024 CRM_Utils_Array::value("{$fieldName}_from", $this->_params),
3025 CRM_Utils_Array::value("{$fieldName}_to", $this->_params),
3026 CRM_Utils_Array::value("{$fieldName}_from_time", $this->_params),
3027 CRM_Utils_Array::value("{$fieldName}_to_time", $this->_params)
3028 );
3029 $from_time_format = !empty($this->_params["{$fieldName}_from_time"]) ? 'h' : 'd';
3030 $from = CRM_Utils_Date::customFormat($from, NULL, array($from_time_format));
3031
3032 $to_time_format = !empty($this->_params["{$fieldName}_to_time"]) ? 'h' : 'd';
3033 $to = CRM_Utils_Date::customFormat($to, NULL, array($to_time_format));
3034
3035 if ($from || $to) {
3036 $statistics['filters'][] = array(
3037 'title' => $field['title'],
3038 'value' => ts("Between %1 and %2", array(1 => $from, 2 => $to)),
3039 );
3040 }
3041 elseif (in_array($rel = CRM_Utils_Array::value("{$fieldName}_relative", $this->_params),
3042 array_keys($this->getOperationPair(CRM_Report_Form::OP_DATE))
3043 )) {
3044 $pair = $this->getOperationPair(CRM_Report_Form::OP_DATE);
3045 $statistics['filters'][] = array(
3046 'title' => $field['title'],
3047 'value' => $pair[$rel],
3048 );
3049 }
3050 }
3051 else {
3052 $op = CRM_Utils_Array::value("{$fieldName}_op", $this->_params);
3053 $value = NULL;
3054 if ($op) {
3055 $pair = $this->getOperationPair(
3056 CRM_Utils_Array::value('operatorType', $field),
3057 $fieldName
3058 );
3059 $min = CRM_Utils_Array::value("{$fieldName}_min", $this->_params);
3060 $max = CRM_Utils_Array::value("{$fieldName}_max", $this->_params);
3061 $val = CRM_Utils_Array::value("{$fieldName}_value", $this->_params);
3062 if (in_array($op, array('bw', 'nbw')) && ($min || $max)) {
3063 $value = "{$pair[$op]} $min " . ts('and') . " $max";
3064 }
3065 elseif ($val && CRM_Utils_Array::value('operatorType', $field) & self::OP_ENTITYREF) {
3066 $this->setEntityRefDefaults($field, $tableName);
3067 $result = civicrm_api3($field['attributes']['entity'], 'getlist',
3068 array('id' => $val) +
3069 CRM_Utils_Array::value('api', $field['attributes'], array()));
3070 $values = array();
3071 foreach ($result['values'] as $v) {
3072 $values[] = $v['label'];
3073 }
3074 $value = "{$pair[$op]} " . implode(', ', $values);
3075 }
3076 elseif ($op == 'nll' || $op == 'nnll') {
3077 $value = $pair[$op];
3078 }
3079 elseif (is_array($val) && (!empty($val))) {
3080 $options = CRM_Utils_Array::value('options', $field, array());
3081 foreach ($val as $key => $valIds) {
3082 if (isset($options[$valIds])) {
3083 $val[$key] = $options[$valIds];
3084 }
3085 }
3086 $pair[$op] = (count($val) == 1) ? (($op == 'notin' || $op ==
3087 'mnot') ? ts('Is Not') : ts('Is')) : CRM_Utils_Array::value($op, $pair);
3088 $val = implode(', ', $val);
3089 $value = "{$pair[$op]} " . $val;
3090 }
3091 elseif (!is_array($val) && (!empty($val) || $val == '0') &&
3092 isset($field['options']) &&
3093 is_array($field['options']) && !empty($field['options'])
3094 ) {
3095 $value = CRM_Utils_Array::value($op, $pair) . " " .
3096 CRM_Utils_Array::value($val, $field['options'], $val);
3097 }
3098 elseif ($val) {
3099 $value = CRM_Utils_Array::value($op, $pair) . " " . $val;
3100 }
3101 }
3102 if ($value) {
3103 $statistics['filters'][] = array(
3104 'title' => CRM_Utils_Array::value('title', $field),
3105 'value' => $value,
3106 );
3107 }
3108 }
3109 }
3110 }
3111 }
3112 }
3113
3114 /**
3115 * End post processing.
3116 *
3117 * @param array|null $rows
3118 */
3119 public function endPostProcess(&$rows = NULL) {
3120 if ($this->_storeResultSet) {
3121 $this->_resultSet = $rows;
3122 }
3123
3124 if ($this->_outputMode == 'print' ||
3125 $this->_outputMode == 'pdf' ||
3126 $this->_sendmail
3127 ) {
3128
3129 $content = $this->compileContent();
3130 $url = CRM_Utils_System::url("civicrm/report/instance/{$this->_id}",
3131 "reset=1", TRUE
3132 );
3133
3134 if ($this->_sendmail) {
3135 $config = CRM_Core_Config::singleton();
3136 $attachments = array();
3137
3138 if ($this->_outputMode == 'csv') {
3139 $content
3140 = $this->_formValues['report_header'] . '<p>' . ts('Report URL') .
3141 ": {$url}</p>" . '<p>' .
3142 ts('The report is attached as a CSV file.') . '</p>' .
3143 $this->_formValues['report_footer'];
3144
3145 $csvFullFilename = $config->templateCompileDir .
3146 CRM_Utils_File::makeFileName('CiviReport.csv');
3147 $csvContent = CRM_Report_Utils_Report::makeCsv($this, $rows);
3148 file_put_contents($csvFullFilename, $csvContent);
3149 $attachments[] = array(
3150 'fullPath' => $csvFullFilename,
3151 'mime_type' => 'text/csv',
3152 'cleanName' => 'CiviReport.csv',
3153 );
3154 }
3155 if ($this->_outputMode == 'pdf') {
3156 // generate PDF content
3157 $pdfFullFilename = $config->templateCompileDir .
3158 CRM_Utils_File::makeFileName('CiviReport.pdf');
3159 file_put_contents($pdfFullFilename,
3160 CRM_Utils_PDF_Utils::html2pdf($content, "CiviReport.pdf",
3161 TRUE, array('orientation' => 'landscape')
3162 )
3163 );
3164 // generate Email Content
3165 $content
3166 = $this->_formValues['report_header'] . '<p>' . ts('Report URL') .
3167 ": {$url}</p>" . '<p>' .
3168 ts('The report is attached as a PDF file.') . '</p>' .
3169 $this->_formValues['report_footer'];
3170
3171 $attachments[] = array(
3172 'fullPath' => $pdfFullFilename,
3173 'mime_type' => 'application/pdf',
3174 'cleanName' => 'CiviReport.pdf',
3175 );
3176 }
3177
3178 if (CRM_Report_Utils_Report::mailReport($content, $this->_id,
3179 $this->_outputMode, $attachments
3180 )
3181 ) {
3182 CRM_Core_Session::setStatus(ts("Report mail has been sent."), ts('Sent'), 'success');
3183 }
3184 else {
3185 CRM_Core_Session::setStatus(ts("Report mail could not be sent."), ts('Mail Error'), 'error');
3186 }
3187 return;
3188 }
3189 elseif ($this->_outputMode == 'print') {
3190 echo $content;
3191 }
3192 else {
3193 if ($chartType = CRM_Utils_Array::value('charts', $this->_params)) {
3194 $config = CRM_Core_Config::singleton();
3195 //get chart image name
3196 $chartImg = $this->_chartId . '.png';
3197 //get image url path
3198 $uploadUrl
3199 = str_replace('/persist/contribute/', '/persist/', $config->imageUploadURL) .
3200 'openFlashChart/';
3201 $uploadUrl .= $chartImg;
3202 //get image doc path to overwrite
3203 $uploadImg
3204 = str_replace('/persist/contribute/', '/persist/', $config->imageUploadDir) .
3205 'openFlashChart/' . $chartImg;
3206 //Load the image
3207 $chart = imagecreatefrompng($uploadUrl);
3208 //convert it into formatted png
3209 CRM_Utils_System::setHttpHeader('Content-type', 'image/png');
3210 //overwrite with same image
3211 imagepng($chart, $uploadImg);
3212 //delete the object
3213 imagedestroy($chart);
3214 }
3215 CRM_Utils_PDF_Utils::html2pdf($content, "CiviReport.pdf", FALSE, array('orientation' => 'landscape'));
3216 }
3217 CRM_Utils_System::civiExit();
3218 }
3219 elseif ($this->_outputMode == 'csv') {
3220 CRM_Report_Utils_Report::export2csv($this, $rows);
3221 }
3222 elseif ($this->_outputMode == 'group') {
3223 $group = $this->_params['groups'];
3224 $this->add2group($group);
3225 }
3226 }
3227
3228 /**
3229 * Set store result set indicator to TRUE.
3230 *
3231 * @todo explain what this does
3232 */
3233 public function storeResultSet() {
3234 $this->_storeResultSet = TRUE;
3235 }
3236
3237 /**
3238 * Get result set.
3239 *
3240 * @return bool
3241 */
3242 public function getResultSet() {
3243 return $this->_resultSet;
3244 }
3245
3246 /**
3247 * Get the sql used to generate the report.
3248 *
3249 * @return string
3250 */
3251 public function getReportSql() {
3252 return $this->sqlArray;
3253 }
3254
3255 /**
3256 * Use the form name to create the tpl file name.
3257 *
3258 * @return string
3259 */
3260 public function getTemplateFileName() {
3261 $defaultTpl = parent::getTemplateFileName();
3262 $template = CRM_Core_Smarty::singleton();
3263 if (!$template->template_exists($defaultTpl)) {
3264 $defaultTpl = 'CRM/Report/Form.tpl';
3265 }
3266 return $defaultTpl;
3267 }
3268
3269 /**
3270 * Compile the report content.
3271 *
3272 * Although this function is super-short it is useful to keep separate so it can be over-ridden by report classes.
3273 *
3274 * @return string
3275 */
3276 public function compileContent() {
3277 $templateFile = $this->getHookedTemplateFileName();
3278 return CRM_Utils_Array::value('report_header', $this->_formValues) .
3279 CRM_Core_Form::$_template->fetch($templateFile) .
3280 CRM_Utils_Array::value('report_footer', $this->_formValues);
3281 }
3282
3283
3284 /**
3285 * Post process function.
3286 */
3287 public function postProcess() {
3288 // get ready with post process params
3289 $this->beginPostProcess();
3290
3291 // build query
3292 $sql = $this->buildQuery();
3293
3294 // build array of result based on column headers. This method also allows
3295 // modifying column headers before using it to build result set i.e $rows.
3296 $rows = array();
3297 $this->buildRows($sql, $rows);
3298
3299 // format result set.
3300 $this->formatDisplay($rows);
3301
3302 // assign variables to templates
3303 $this->doTemplateAssignment($rows);
3304
3305 // do print / pdf / instance stuff if needed
3306 $this->endPostProcess($rows);
3307 }
3308
3309 /**
3310 * Set limit.
3311 *
3312 * @param int $rowCount
3313 *
3314 * @return array
3315 */
3316 public function limit($rowCount = self::ROW_COUNT_LIMIT) {
3317 // lets do the pager if in html mode
3318 $this->_limit = NULL;
3319
3320 // CRM-14115, over-ride row count if rowCount is specified in URL
3321 if ($this->_dashBoardRowCount) {
3322 $rowCount = $this->_dashBoardRowCount;
3323 }
3324 if ($this->addPaging) {
3325 $this->_select = str_ireplace('SELECT ', 'SELECT SQL_CALC_FOUND_ROWS ', $this->_select);
3326
3327 $pageId = CRM_Utils_Request::retrieve('crmPID', 'Integer', CRM_Core_DAO::$_nullObject);
3328
3329 // @todo all http vars should be extracted in the preProcess
3330 // - not randomly in the class
3331 if (!$pageId && !empty($_POST)) {
3332 if (isset($_POST['PagerBottomButton']) && isset($_POST['crmPID_B'])) {
3333 $pageId = max((int) $_POST['crmPID_B'], 1);
3334 }
3335 elseif (isset($_POST['PagerTopButton']) && isset($_POST['crmPID'])) {
3336 $pageId = max((int) $_POST['crmPID'], 1);
3337 }
3338 unset($_POST['crmPID_B'], $_POST['crmPID']);
3339 }
3340
3341 $pageId = $pageId ? $pageId : 1;
3342 $this->set(CRM_Utils_Pager::PAGE_ID, $pageId);
3343 $offset = ($pageId - 1) * $rowCount;
3344
3345 $offset = CRM_Utils_Type::escape($offset, 'Int');
3346 $rowCount = CRM_Utils_Type::escape($rowCount, 'Int');
3347
3348 $this->_limit = " LIMIT $offset, $rowCount";
3349 return array($offset, $rowCount);
3350 }
3351 if ($this->_limitValue) {
3352 if ($this->_offsetValue) {
3353 $this->_limit = " LIMIT {$this->_offsetValue}, {$this->_limitValue} ";
3354 }
3355 else {
3356 $this->_limit = " LIMIT " . $this->_limitValue;
3357 }
3358 }
3359 }
3360
3361 /**
3362 * Set pager.
3363 *
3364 * @param int $rowCount
3365 */
3366 public function setPager($rowCount = self::ROW_COUNT_LIMIT) {
3367 // CRM-14115, over-ride row count if rowCount is specified in URL
3368 if ($this->_dashBoardRowCount) {
3369 $rowCount = $this->_dashBoardRowCount;
3370 }
3371
3372 if ($this->_limit && ($this->_limit != '')) {
3373 if (!$this->_rowsFound) {
3374 $sql = "SELECT FOUND_ROWS();";
3375 $this->_rowsFound = CRM_Core_DAO::singleValueQuery($sql);
3376 }
3377 $params = array(
3378 'total' => $this->_rowsFound,
3379 'rowCount' => $rowCount,
3380 'status' => ts('Records') . ' %%StatusMessage%%',
3381 'buttonBottom' => 'PagerBottomButton',
3382 'buttonTop' => 'PagerTopButton',
3383 );
3384 if (!empty($this->controller)) {
3385 // This happens when being called from the api Really we want the api to be able to
3386 // pass paging parameters, but at this stage just preventing test crashes.
3387 $params['pageID'] = $this->get(CRM_Utils_Pager::PAGE_ID);
3388 }
3389
3390 $pager = new CRM_Utils_Pager($params);
3391 $this->assign_by_ref('pager', $pager);
3392 $this->ajaxResponse['totalRows'] = $this->_rowsFound;
3393 }
3394 }
3395
3396 /**
3397 * Build a group filter with contempt for large data sets.
3398 *
3399 * This function has been retained as it takes time to migrate the reports over
3400 * to the new method which will not crash on large datasets.
3401 *
3402 * @deprecated
3403 *
3404 * @param string $field
3405 * @param mixed $value
3406 * @param string $op
3407 *
3408 * @return string
3409 */
3410 public function legacySlowGroupFilterClause($field, $value, $op) {
3411 $smartGroupQuery = "";
3412
3413 $group = new CRM_Contact_DAO_Group();
3414 $group->is_active = 1;
3415 $group->find();
3416 $smartGroups = array();
3417 while ($group->fetch()) {
3418 if (in_array($group->id, $this->_params['gid_value']) &&
3419 $group->saved_search_id
3420 ) {
3421 $smartGroups[] = $group->id;
3422 }
3423 }
3424
3425 CRM_Contact_BAO_GroupContactCache::check($smartGroups);
3426
3427 $smartGroupQuery = '';
3428 if (!empty($smartGroups)) {
3429 $smartGroups = implode(',', $smartGroups);
3430 $smartGroupQuery = " UNION DISTINCT
3431 SELECT DISTINCT smartgroup_contact.contact_id
3432 FROM civicrm_group_contact_cache smartgroup_contact
3433 WHERE smartgroup_contact.group_id IN ({$smartGroups}) ";
3434 }
3435
3436 $sqlOp = $this->getSQLOperator($op);
3437 if (!is_array($value)) {
3438 $value = array($value);
3439 }
3440 $clause = "{$field['dbAlias']} IN (" . implode(', ', $value) . ")";
3441
3442 $contactAlias = $this->_aliases['civicrm_contact'];
3443 if (!empty($this->relationType) && $this->relationType == 'b_a') {
3444 $contactAlias = $this->_aliases['civicrm_contact_b'];
3445 }
3446 return " {$contactAlias}.id {$sqlOp} (
3447 SELECT DISTINCT {$this->_aliases['civicrm_group']}.contact_id
3448 FROM civicrm_group_contact {$this->_aliases['civicrm_group']}
3449 WHERE {$clause} AND {$this->_aliases['civicrm_group']}.status = 'Added'
3450 {$smartGroupQuery} ) ";
3451 }
3452
3453 /**
3454 * Build where clause for groups.
3455 *
3456 * @param string $field
3457 * @param mixed $value
3458 * @param string $op
3459 *
3460 * @return string
3461 */
3462 public function whereGroupClause($field, $value, $op) {
3463 if ($this->groupFilterNotOptimised) {
3464 return $this->legacySlowGroupFilterClause($field, $value, $op);
3465 }
3466 if ($op === 'notin') {
3467 return " group_temp_table.id IS NULL ";
3468 }
3469 // We will have used an inner join instead.
3470 return "1";
3471 }
3472
3473
3474 /**
3475 * Create a table of the contact ids included by the group filter.
3476 *
3477 * This function is called by both the api (tests) and the UI.
3478 */
3479 public function buildGroupTempTable() {
3480 if (!empty($this->groupTempTable) || empty ($this->_params['gid_value']) || $this->groupFilterNotOptimised) {
3481 return;
3482 }
3483 $filteredGroups = (array) $this->_params['gid_value'];
3484
3485 $groups = civicrm_api3('Group', 'get', array(
3486 'is_active' => 1,
3487 'id' => array('IN' => $filteredGroups),
3488 'saved_search_id' => array('>' => 0),
3489 'return' => 'id',
3490 ));
3491 $smartGroups = array_keys($groups['values']);
3492
3493 $query = "
3494 SELECT group_contact.contact_id as id
3495 FROM civicrm_group_contact group_contact
3496 WHERE group_contact.group_id IN (" . implode(', ', $filteredGroups) . ")
3497 AND group_contact.status = 'Added' ";
3498
3499 if (!empty($smartGroups)) {
3500 CRM_Contact_BAO_GroupContactCache::check($smartGroups);
3501 $smartGroups = implode(',', $smartGroups);
3502 $query .= "
3503 UNION DISTINCT
3504 SELECT smartgroup_contact.contact_id as id
3505 FROM civicrm_group_contact_cache smartgroup_contact
3506 WHERE smartgroup_contact.group_id IN ({$smartGroups}) ";
3507 }
3508
3509 $this->groupTempTable = 'civicrm_report_temp_group_' . date('Ymd_') . uniqid();
3510 $this->executeReportQuery("
3511 CREATE TEMPORARY TABLE $this->groupTempTable
3512 $query
3513 ");
3514 CRM_Core_DAO::executeQuery("ALTER TABLE $this->groupTempTable ADD INDEX i_id(id)");
3515 }
3516
3517 /**
3518 * Execute query and add it to the developer tab.
3519 *
3520 * @param string $query
3521 * @param array $params
3522 *
3523 * @return \CRM_Core_DAO|object
3524 */
3525 protected function executeReportQuery($query, $params = array()) {
3526 $this->addToDeveloperTab($query);
3527 return CRM_Core_DAO::executeQuery($query, $params);
3528 }
3529
3530 /**
3531 * Build where clause for tags.
3532 *
3533 * @param string $field
3534 * @param mixed $value
3535 * @param string $op
3536 *
3537 * @return string
3538 */
3539 public function whereTagClause($field, $value, $op) {
3540 // not using left join in query because if any contact
3541 // belongs to more than one tag, results duplicate
3542 // entries.
3543 $sqlOp = $this->getSQLOperator($op);
3544 if (!is_array($value)) {
3545 $value = array($value);
3546 }
3547 $clause = "{$field['dbAlias']} IN (" . implode(', ', $value) . ")";
3548 $entity_table = $this->_tagFilterTable;
3549 return " {$this->_aliases[$entity_table]}.id {$sqlOp} (
3550 SELECT DISTINCT {$this->_aliases['civicrm_tag']}.entity_id
3551 FROM civicrm_entity_tag {$this->_aliases['civicrm_tag']}
3552 WHERE entity_table = '$entity_table' AND {$clause} ) ";
3553 }
3554
3555 /**
3556 * Generate membership organization clause.
3557 *
3558 * @param mixed $value
3559 * @param string $op SQL Operator
3560 *
3561 * @return string
3562 */
3563 public function whereMembershipOrgClause($value, $op) {
3564 $sqlOp = $this->getSQLOperator($op);
3565 if (!is_array($value)) {
3566 $value = array($value);
3567 }
3568
3569 $tmp_membership_org_sql_list = implode(', ', $value);
3570 return " {$this->_aliases['civicrm_contact']}.id {$sqlOp} (
3571 SELECT DISTINCT mem.contact_id
3572 FROM civicrm_membership mem
3573 LEFT JOIN civicrm_membership_status mem_status ON mem.status_id = mem_status.id
3574 LEFT JOIN civicrm_membership_type mt ON mem.membership_type_id = mt.id
3575 WHERE mt.member_of_contact_id IN (" .
3576 $tmp_membership_org_sql_list . ")
3577 AND mt.is_active = '1'
3578 AND mem_status.is_current_member = '1'
3579 AND mem_status.is_active = '1' ) ";
3580 }
3581
3582 /**
3583 * Generate Membership Type SQL Clause.
3584 *
3585 * @param mixed $value
3586 * @param string $op
3587 *
3588 * @return string
3589 * SQL query string
3590 */
3591 public function whereMembershipTypeClause($value, $op) {
3592 $sqlOp = $this->getSQLOperator($op);
3593 if (!is_array($value)) {
3594 $value = array($value);
3595 }
3596
3597 $tmp_membership_sql_list = implode(', ', $value);
3598 return " {$this->_aliases['civicrm_contact']}.id {$sqlOp} (
3599 SELECT DISTINCT mem.contact_id
3600 FROM civicrm_membership mem
3601 LEFT JOIN civicrm_membership_status mem_status ON mem.status_id = mem_status.id
3602 LEFT JOIN civicrm_membership_type mt ON mem.membership_type_id = mt.id
3603 WHERE mem.membership_type_id IN (" .
3604 $tmp_membership_sql_list . ")
3605 AND mt.is_active = '1'
3606 AND mem_status.is_current_member = '1'
3607 AND mem_status.is_active = '1' ) ";
3608 }
3609
3610 /**
3611 * Build acl clauses.
3612 *
3613 * @param string $tableAlias
3614 */
3615 public function buildACLClause($tableAlias = 'contact_a') {
3616 list($this->_aclFrom, $this->_aclWhere) = CRM_Contact_BAO_Contact_Permission::cacheClause($tableAlias);
3617 }
3618
3619 /**
3620 * Add custom data to the columns.
3621 *
3622 * @param bool $addFields
3623 * @param array $permCustomGroupIds
3624 */
3625 public function addCustomDataToColumns($addFields = TRUE, $permCustomGroupIds = array()) {
3626 if (empty($this->_customGroupExtends)) {
3627 return;
3628 }
3629 if (!is_array($this->_customGroupExtends)) {
3630 $this->_customGroupExtends = array($this->_customGroupExtends);
3631 }
3632 $customGroupWhere = '';
3633 if (!empty($permCustomGroupIds)) {
3634 $customGroupWhere = "cg.id IN (" . implode(',', $permCustomGroupIds) .
3635 ") AND";
3636 }
3637 $sql = "
3638 SELECT cg.table_name, cg.title, cg.extends, cf.id as cf_id, cf.label,
3639 cf.column_name, cf.data_type, cf.html_type, cf.option_group_id, cf.time_format
3640 FROM civicrm_custom_group cg
3641 INNER JOIN civicrm_custom_field cf ON cg.id = cf.custom_group_id
3642 WHERE cg.extends IN ('" . implode("','", $this->_customGroupExtends) . "') AND
3643 {$customGroupWhere}
3644 cg.is_active = 1 AND
3645 cf.is_active = 1 AND
3646 cf.is_searchable = 1
3647 ORDER BY cg.weight, cf.weight";
3648 $customDAO = CRM_Core_DAO::executeQuery($sql);
3649
3650 $curTable = NULL;
3651 while ($customDAO->fetch()) {
3652 if ($customDAO->table_name != $curTable) {
3653 $curTable = $customDAO->table_name;
3654 $curFields = $curFilters = array();
3655
3656 // dummy dao object
3657 $this->_columns[$curTable]['dao'] = 'CRM_Contact_DAO_Contact';
3658 $this->_columns[$curTable]['extends'] = $customDAO->extends;
3659 $this->_columns[$curTable]['grouping'] = $customDAO->table_name;
3660 $this->_columns[$curTable]['group_title'] = $customDAO->title;
3661
3662 foreach (array('fields', 'filters', 'group_bys') as $colKey) {
3663 if (!array_key_exists($colKey, $this->_columns[$curTable])) {
3664 $this->_columns[$curTable][$colKey] = array();
3665 }
3666 }
3667 }
3668 $fieldName = 'custom_' . $customDAO->cf_id;
3669
3670 if ($addFields) {
3671 // this makes aliasing work in favor
3672 $curFields[$fieldName] = array(
3673 'name' => $customDAO->column_name,
3674 'title' => $customDAO->label,
3675 'dataType' => $customDAO->data_type,
3676 'htmlType' => $customDAO->html_type,
3677 );
3678 }
3679 if ($this->_customGroupFilters) {
3680 // this makes aliasing work in favor
3681 $curFilters[$fieldName] = array(
3682 'name' => $customDAO->column_name,
3683 'title' => $customDAO->label,
3684 'dataType' => $customDAO->data_type,
3685 'htmlType' => $customDAO->html_type,
3686 );
3687 }
3688
3689 switch ($customDAO->data_type) {
3690 case 'Date':
3691 // filters
3692 $curFilters[$fieldName]['operatorType'] = CRM_Report_Form::OP_DATE;
3693 $curFilters[$fieldName]['type'] = CRM_Utils_Type::T_DATE;
3694 // CRM-6946, show time part for datetime date fields
3695 if ($customDAO->time_format) {
3696 $curFields[$fieldName]['type'] = CRM_Utils_Type::T_TIMESTAMP;
3697 }
3698 break;
3699
3700 case 'Boolean':
3701 $curFilters[$fieldName]['operatorType'] = CRM_Report_Form::OP_SELECT;
3702 $curFilters[$fieldName]['options'] = array('' => ts('- select -')) + CRM_Core_PseudoConstant::get('CRM_Core_BAO_CustomField', 'custom_' . $customDAO->cf_id, array(), 'search');
3703 $curFilters[$fieldName]['type'] = CRM_Utils_Type::T_INT;
3704 break;
3705
3706 case 'Int':
3707 $curFilters[$fieldName]['operatorType'] = CRM_Report_Form::OP_INT;
3708 $curFilters[$fieldName]['type'] = CRM_Utils_Type::T_INT;
3709 break;
3710
3711 case 'Money':
3712 $curFilters[$fieldName]['operatorType'] = CRM_Report_Form::OP_FLOAT;
3713 $curFilters[$fieldName]['type'] = CRM_Utils_Type::T_MONEY;
3714 $curFields[$fieldName]['type'] = CRM_Utils_Type::T_MONEY;
3715 break;
3716
3717 case 'Float':
3718 $curFilters[$fieldName]['operatorType'] = CRM_Report_Form::OP_FLOAT;
3719 $curFilters[$fieldName]['type'] = CRM_Utils_Type::T_FLOAT;
3720 break;
3721
3722 case 'String':
3723 case 'StateProvince':
3724 case 'Country':
3725 $curFilters[$fieldName]['type'] = CRM_Utils_Type::T_STRING;
3726
3727 $options = CRM_Core_PseudoConstant::get('CRM_Core_BAO_CustomField', 'custom_' . $customDAO->cf_id, array(), 'search');
3728 if ($options !== FALSE) {
3729 $curFilters[$fieldName]['operatorType'] = CRM_Core_BAO_CustomField::isSerialized($customDAO) ? CRM_Report_Form::OP_MULTISELECT_SEPARATOR : CRM_Report_Form::OP_MULTISELECT;
3730 $curFilters[$fieldName]['options'] = $options;
3731 }
3732 break;
3733
3734 case 'ContactReference':
3735 $curFilters[$fieldName]['type'] = CRM_Utils_Type::T_STRING;
3736 $curFilters[$fieldName]['name'] = 'display_name';
3737 $curFilters[$fieldName]['alias'] = "contact_{$fieldName}_civireport";
3738
3739 $curFields[$fieldName]['type'] = CRM_Utils_Type::T_STRING;
3740 $curFields[$fieldName]['name'] = 'display_name';
3741 $curFields[$fieldName]['alias'] = "contact_{$fieldName}_civireport";
3742 break;
3743
3744 default:
3745 $curFields[$fieldName]['type'] = CRM_Utils_Type::T_STRING;
3746 $curFilters[$fieldName]['type'] = CRM_Utils_Type::T_STRING;
3747 }
3748
3749 if (!array_key_exists('type', $curFields[$fieldName])) {
3750 $curFields[$fieldName]['type'] = CRM_Utils_Array::value('type', $curFilters[$fieldName], array());
3751 }
3752
3753 if ($addFields) {
3754 $this->_columns[$curTable]['fields'] = array_merge($this->_columns[$curTable]['fields'], $curFields);
3755 }
3756 if ($this->_customGroupFilters) {
3757 $this->_columns[$curTable]['filters'] = array_merge($this->_columns[$curTable]['filters'], $curFilters);
3758 }
3759 if ($this->_customGroupGroupBy) {
3760 $this->_columns[$curTable]['group_bys'] = array_merge($this->_columns[$curTable]['group_bys'], $curFields);
3761 }
3762 }
3763 }
3764
3765 /**
3766 * Build custom data from clause.
3767 *
3768 * @param bool $joinsForFiltersOnly
3769 * Only include joins to support filters. This would be used if creating a table of contacts to include first.
3770 */
3771 public function customDataFrom($joinsForFiltersOnly = FALSE) {
3772 if (empty($this->_customGroupExtends)) {
3773 return;
3774 }
3775 $mapper = CRM_Core_BAO_CustomQuery::$extendsMap;
3776 //CRM-18276 GROUP_CONCAT could be used with singleValueQuery and then exploded,
3777 //but by default that truncates to 1024 characters, which causes errors with installs with lots of custom field sets
3778 $customTables = array();
3779 $customTablesDAO = CRM_Core_DAO::executeQuery("SELECT table_name FROM civicrm_custom_group");
3780 while ($customTablesDAO->fetch()) {
3781 $customTables[] = $customTablesDAO->table_name;
3782 }
3783
3784 foreach ($this->_columns as $table => $prop) {
3785 if (in_array($table, $customTables)) {
3786 $extendsTable = $mapper[$prop['extends']];
3787 // Check field is required for rendering the report.
3788 if ((!$this->isFieldSelected($prop)) || ($joinsForFiltersOnly && !$this->isFieldFiltered($prop))) {
3789 continue;
3790 }
3791 $baseJoin = CRM_Utils_Array::value($prop['extends'], $this->_customGroupExtendsJoin, "{$this->_aliases[$extendsTable]}.id");
3792
3793 $customJoin = is_array($this->_customGroupJoin) ? $this->_customGroupJoin[$table] : $this->_customGroupJoin;
3794 $this->_from .= "
3795 {$customJoin} {$table} {$this->_aliases[$table]} ON {$this->_aliases[$table]}.entity_id = {$baseJoin}";
3796 // handle for ContactReference
3797 if (array_key_exists('fields', $prop)) {
3798 foreach ($prop['fields'] as $fieldName => $field) {
3799 if (CRM_Utils_Array::value('dataType', $field) ==
3800 'ContactReference'
3801 ) {
3802 $columnName = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_CustomField', CRM_Core_BAO_CustomField::getKeyID($fieldName), 'column_name');
3803 $this->_from .= "
3804 LEFT JOIN civicrm_contact {$field['alias']} ON {$field['alias']}.id = {$this->_aliases[$table]}.{$columnName} ";
3805 }
3806 }
3807 }
3808 }
3809 }
3810 }
3811
3812 /**
3813 * Check if the field is selected.
3814 *
3815 * @param string $prop
3816 *
3817 * @return bool
3818 */
3819 public function isFieldSelected($prop) {
3820 if (empty($prop)) {
3821 return FALSE;
3822 }
3823
3824 if (!empty($this->_params['fields'])) {
3825 foreach (array_keys($prop['fields']) as $fieldAlias) {
3826 $customFieldId = CRM_Core_BAO_CustomField::getKeyID($fieldAlias);
3827 if ($customFieldId) {
3828 if (array_key_exists($fieldAlias, $this->_params['fields'])) {
3829 return TRUE;
3830 }
3831
3832 //might be survey response field.
3833 if (!empty($this->_params['fields']['survey_response']) &&
3834 !empty($prop['fields'][$fieldAlias]['isSurveyResponseField'])
3835 ) {
3836 return TRUE;
3837 }
3838 }
3839 }
3840 }
3841
3842 if (!empty($this->_params['group_bys']) && $this->_customGroupGroupBy) {
3843 foreach (array_keys($prop['group_bys']) as $fieldAlias) {
3844 if (array_key_exists($fieldAlias, $this->_params['group_bys']) &&
3845 CRM_Core_BAO_CustomField::getKeyID($fieldAlias)
3846 ) {
3847 return TRUE;
3848 }
3849 }
3850 }
3851
3852 if (!empty($this->_params['order_bys'])) {
3853 foreach (array_keys($prop['fields']) as $fieldAlias) {
3854 foreach ($this->_params['order_bys'] as $orderBy) {
3855 if ($fieldAlias == $orderBy['column'] &&
3856 CRM_Core_BAO_CustomField::getKeyID($fieldAlias)
3857 ) {
3858 return TRUE;
3859 }
3860 }
3861 }
3862 }
3863 return $this->isFieldFiltered($prop);
3864
3865 }
3866
3867 /**
3868 * Check if the field is used as a filter.
3869 *
3870 * @param string $prop
3871 *
3872 * @return bool
3873 */
3874 protected function isFieldFiltered($prop) {
3875 if (!empty($prop['filters']) && $this->_customGroupFilters) {
3876 foreach ($prop['filters'] as $fieldAlias => $val) {
3877 foreach (array(
3878 'value',
3879 'min',
3880 'max',
3881 'relative',
3882 'from',
3883 'to',
3884 ) as $attach) {
3885 if (isset($this->_params[$fieldAlias . '_' . $attach]) &&
3886 (!empty($this->_params[$fieldAlias . '_' . $attach])
3887 || ($attach != 'relative' &&
3888 $this->_params[$fieldAlias . '_' . $attach] == '0')
3889 )
3890 ) {
3891 return TRUE;
3892 }
3893 }
3894 if (!empty($this->_params[$fieldAlias . '_op']) &&
3895 in_array($this->_params[$fieldAlias . '_op'], array('nll', 'nnll'))
3896 ) {
3897 return TRUE;
3898 }
3899 }
3900 }
3901
3902 return FALSE;
3903 }
3904
3905 /**
3906 * Check for empty order_by configurations and remove them.
3907 *
3908 * Also set template to hide them.
3909 *
3910 * @param array $formValues
3911 */
3912 public function preProcessOrderBy(&$formValues) {
3913 // Object to show/hide form elements
3914 $_showHide = new CRM_Core_ShowHideBlocks('', '');
3915
3916 $_showHide->addShow('optionField_1');
3917
3918 // Cycle through order_by options; skip any empty ones, and hide them as well
3919 $n = 1;
3920
3921 if (!empty($formValues['order_bys'])) {
3922 foreach ($formValues['order_bys'] as $order_by) {
3923 if ($order_by['column'] && $order_by['column'] != '-') {
3924 $_showHide->addShow('optionField_' . $n);
3925 $orderBys[$n] = $order_by;
3926 $n++;
3927 }
3928 }
3929 }
3930 for ($i = $n; $i <= 5; $i++) {
3931 if ($i > 1) {
3932 $_showHide->addHide('optionField_' . $i);
3933 }
3934 }
3935
3936 // overwrite order_by options with modified values
3937 if (!empty($orderBys)) {
3938 $formValues['order_bys'] = $orderBys;
3939 }
3940 else {
3941 $formValues['order_bys'] = array(1 => array('column' => '-'));
3942 }
3943
3944 // assign show/hide data to template
3945 $_showHide->addToTemplate();
3946 }
3947
3948 /**
3949 * Check if table name has columns in SELECT clause.
3950 *
3951 * @param string $tableName
3952 * Name of table (index of $this->_columns array).
3953 *
3954 * @return bool
3955 */
3956 public function isTableSelected($tableName) {
3957 return in_array($tableName, $this->selectedTables());
3958 }
3959
3960 /**
3961 * Check if table name has columns in WHERE or HAVING clause.
3962 *
3963 * @param string $tableName
3964 * Name of table (index of $this->_columns array).
3965 *
3966 * @return bool
3967 */
3968 public function isTableFiltered($tableName) {
3969 // Cause the array to be generated if not previously done.
3970 if (!$this->_selectedTables && !$this->filteredTables) {
3971 $this->selectedTables();
3972 }
3973 return in_array($tableName, $this->filteredTables);
3974 }
3975
3976 /**
3977 * Fetch array of DAO tables having columns included in SELECT or ORDER BY clause.
3978 *
3979 * If the array is unset it will be built.
3980 *
3981 * @return array
3982 * selectedTables
3983 */
3984 public function selectedTables() {
3985 if (!$this->_selectedTables) {
3986 $orderByColumns = array();
3987 if (array_key_exists('order_bys', $this->_params) &&
3988 is_array($this->_params['order_bys'])
3989 ) {
3990 foreach ($this->_params['order_bys'] as $orderBy) {
3991 $orderByColumns[] = $orderBy['column'];
3992 }
3993 }
3994
3995 foreach ($this->_columns as $tableName => $table) {
3996 if (array_key_exists('fields', $table)) {
3997 foreach ($table['fields'] as $fieldName => $field) {
3998 if (!empty($field['required']) ||
3999 !empty($this->_params['fields'][$fieldName])
4000 ) {
4001 $this->_selectedTables[] = $tableName;
4002 break;
4003 }
4004 }
4005 }
4006 if (array_key_exists('order_bys', $table)) {
4007 foreach ($table['order_bys'] as $orderByName => $orderBy) {
4008 if (in_array($orderByName, $orderByColumns)) {
4009 $this->_selectedTables[] = $tableName;
4010 break;
4011 }
4012 }
4013 }
4014 if (array_key_exists('filters', $table)) {
4015 foreach ($table['filters'] as $filterName => $filter) {
4016 if (!empty($this->_params["{$filterName}_value"]) ||
4017 CRM_Utils_Array::value("{$filterName}_op", $this->_params) ==
4018 'nll' ||
4019 CRM_Utils_Array::value("{$filterName}_op", $this->_params) ==
4020 'nnll'
4021 ) {
4022 $this->_selectedTables[] = $tableName;
4023 $this->filteredTables[] = $tableName;
4024 break;
4025 }
4026 }
4027 }
4028 }
4029 }
4030 return $this->_selectedTables;
4031 }
4032
4033 /**
4034 * Add address fields.
4035 *
4036 * @deprecated - use getAddressColumns which is a more accurate description
4037 * and also accepts an array of options rather than a long list
4038 *
4039 * adding address fields to construct function in reports
4040 *
4041 * @param bool $groupBy
4042 * Add GroupBy? Not appropriate for detail report.
4043 * @param bool $orderBy
4044 * Add GroupBy? Not appropriate for detail report.
4045 * @param bool $filters
4046 * @param array $defaults
4047 *
4048 * @return array
4049 * address fields for construct clause
4050 */
4051 public function addAddressFields($groupBy = TRUE, $orderBy = FALSE, $filters = TRUE, $defaults = array('country_id' => TRUE)) {
4052 $addressFields = array(
4053 'civicrm_address' => array(
4054 'dao' => 'CRM_Core_DAO_Address',
4055 'fields' => array(
4056 'address_name' => array(
4057 'title' => ts('Address Name'),
4058 'default' => CRM_Utils_Array::value('name', $defaults, FALSE),
4059 'name' => 'name',
4060 ),
4061 'street_address' => array(
4062 'title' => ts('Street Address'),
4063 'default' => CRM_Utils_Array::value('street_address', $defaults, FALSE),
4064 ),
4065 'supplemental_address_1' => array(
4066 'title' => ts('Supplementary Address Field 1'),
4067 'default' => CRM_Utils_Array::value('supplemental_address_1', $defaults, FALSE),
4068 ),
4069 'supplemental_address_2' => array(
4070 'title' => ts('Supplementary Address Field 2'),
4071 'default' => CRM_Utils_Array::value('supplemental_address_2', $defaults, FALSE),
4072 ),
4073 'street_number' => array(
4074 'name' => 'street_number',
4075 'title' => ts('Street Number'),
4076 'type' => 1,
4077 'default' => CRM_Utils_Array::value('street_number', $defaults, FALSE),
4078 ),
4079 'street_name' => array(
4080 'name' => 'street_name',
4081 'title' => ts('Street Name'),
4082 'type' => 1,
4083 'default' => CRM_Utils_Array::value('street_name', $defaults, FALSE),
4084 ),
4085 'street_unit' => array(
4086 'name' => 'street_unit',
4087 'title' => ts('Street Unit'),
4088 'type' => 1,
4089 'default' => CRM_Utils_Array::value('street_unit', $defaults, FALSE),
4090 ),
4091 'city' => array(
4092 'title' => ts('City'),
4093 'default' => CRM_Utils_Array::value('city', $defaults, FALSE),
4094 ),
4095 'postal_code' => array(
4096 'title' => ts('Postal Code'),
4097 'default' => CRM_Utils_Array::value('postal_code', $defaults, FALSE),
4098 ),
4099 'postal_code_suffix' => array(
4100 'title' => ts('Postal Code Suffix'),
4101 'default' => CRM_Utils_Array::value('postal_code_suffix', $defaults, FALSE),
4102 ),
4103 'country_id' => array(
4104 'title' => ts('Country'),
4105 'default' => CRM_Utils_Array::value('country_id', $defaults, FALSE),
4106 ),
4107 'state_province_id' => array(
4108 'title' => ts('State/Province'),
4109 'default' => CRM_Utils_Array::value('state_province_id', $defaults, FALSE),
4110 ),
4111 'county_id' => array(
4112 'title' => ts('County'),
4113 'default' => CRM_Utils_Array::value('county_id', $defaults, FALSE),
4114 ),
4115 ),
4116 'grouping' => 'location-fields',
4117 ),
4118 );
4119
4120 if ($filters) {
4121 // Address filter depends on whether street address parsing is enabled.
4122 // (CRM-18696)
4123 $addressOptions = CRM_Core_BAO_Setting::valueOptions(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
4124 'address_options'
4125 );
4126 if ($addressOptions['street_address_parsing']) {
4127 $street_address_filters = array(
4128 'street_number' => array(
4129 'title' => ts('Street Number'),
4130 'type' => 1,
4131 'name' => 'street_number',
4132 ),
4133 'street_name' => array(
4134 'title' => ts('Street Name'),
4135 'name' => 'street_name',
4136 'operator' => 'like',
4137 ),
4138 );
4139 }
4140 else {
4141 $street_address_filters = array(
4142 'street_address' => array(
4143 'title' => ts('Street Address'),
4144 'operator' => 'like',
4145 'name' => 'street_address',
4146 ),
4147 );
4148 }
4149 $general_address_filters = array(
4150 'postal_code' => array(
4151 'title' => ts('Postal Code'),
4152 'type' => 1,
4153 'name' => 'postal_code',
4154 ),
4155 'city' => array(
4156 'title' => ts('City'),
4157 'operator' => 'like',
4158 'name' => 'city',
4159 ),
4160 'country_id' => array(
4161 'name' => 'country_id',
4162 'title' => ts('Country'),
4163 'type' => CRM_Utils_Type::T_INT,
4164 'operatorType' => CRM_Report_Form::OP_MULTISELECT,
4165 'options' => CRM_Core_PseudoConstant::country(),
4166 ),
4167 'state_province_id' => array(
4168 'name' => 'state_province_id',
4169 'title' => ts('State/Province'),
4170 'type' => CRM_Utils_Type::T_INT,
4171 'operatorType' => CRM_Report_Form::OP_MULTISELECT,
4172 'options' => array(),
4173 ),
4174 'county_id' => array(
4175 'name' => 'county_id',
4176 'title' => ts('County'),
4177 'type' => CRM_Utils_Type::T_INT,
4178 'operatorType' => CRM_Report_Form::OP_MULTISELECT,
4179 'options' => array(),
4180 ),
4181 );
4182 }
4183 $addressFields['civicrm_address']['filters'] = array_merge(
4184 $street_address_filters,
4185 $general_address_filters);
4186
4187 if ($orderBy) {
4188 $addressFields['civicrm_address']['order_bys'] = array(
4189 'street_name' => array('title' => ts('Street Name')),
4190 'street_number' => array('title' => ts('Odd / Even Street Number')),
4191 'street_address' => NULL,
4192 'city' => NULL,
4193 'postal_code' => NULL,
4194 );
4195 }
4196
4197 if ($groupBy) {
4198 $addressFields['civicrm_address']['group_bys'] = array(
4199 'street_address' => NULL,
4200 'city' => NULL,
4201 'postal_code' => NULL,
4202 'state_province_id' => array(
4203 'title' => ts('State/Province'),
4204 ),
4205 'country_id' => array(
4206 'title' => ts('Country'),
4207 ),
4208 'county_id' => array(
4209 'title' => ts('County'),
4210 ),
4211 );
4212 }
4213 return $addressFields;
4214 }
4215
4216 /**
4217 * Do AlterDisplay processing on Address Fields.
4218 *
4219 * @param array $row
4220 * @param array $rows
4221 * @param int $rowNum
4222 * @param string $baseUrl
4223 * @param string $linkText
4224 *
4225 * @return bool
4226 */
4227 public function alterDisplayAddressFields(&$row, &$rows, &$rowNum, $baseUrl, $linkText) {
4228 $criteriaQueryParams = CRM_Report_Utils_Report::getPreviewCriteriaQueryParams($this->_defaults, $this->_params);
4229 $entryFound = FALSE;
4230 // handle country
4231 if (array_key_exists('civicrm_address_country_id', $row)) {
4232 if ($value = $row['civicrm_address_country_id']) {
4233 $rows[$rowNum]['civicrm_address_country_id'] = CRM_Core_PseudoConstant::country($value, FALSE);
4234 if ($baseUrl) {
4235 $url = CRM_Report_Utils_Report::getNextUrl($baseUrl,
4236 "reset=1&force=1&{$criteriaQueryParams}&" .
4237 "country_id_op=in&country_id_value={$value}",
4238 $this->_absoluteUrl, $this->_id
4239 );
4240 $rows[$rowNum]['civicrm_address_country_id_link'] = $url;
4241 $rows[$rowNum]['civicrm_address_country_id_hover'] = ts("%1 for this country.",
4242 array(1 => $linkText)
4243 );
4244 }
4245 }
4246
4247 $entryFound = TRUE;
4248 }
4249 if (array_key_exists('civicrm_address_county_id', $row)) {
4250 if ($value = $row['civicrm_address_county_id']) {
4251 $rows[$rowNum]['civicrm_address_county_id'] = CRM_Core_PseudoConstant::county($value, FALSE);
4252 if ($baseUrl) {
4253 $url = CRM_Report_Utils_Report::getNextUrl($baseUrl,
4254 "reset=1&force=1&{$criteriaQueryParams}&" .
4255 "county_id_op=in&county_id_value={$value}",
4256 $this->_absoluteUrl, $this->_id
4257 );
4258 $rows[$rowNum]['civicrm_address_county_id_link'] = $url;
4259 $rows[$rowNum]['civicrm_address_county_id_hover'] = ts("%1 for this county.",
4260 array(1 => $linkText)
4261 );
4262 }
4263 }
4264 $entryFound = TRUE;
4265 }
4266 // handle state province
4267 if (array_key_exists('civicrm_address_state_province_id', $row)) {
4268 if ($value = $row['civicrm_address_state_province_id']) {
4269 $rows[$rowNum]['civicrm_address_state_province_id'] = CRM_Core_PseudoConstant::stateProvince($value, FALSE);
4270 if ($baseUrl) {
4271 $url = CRM_Report_Utils_Report::getNextUrl($baseUrl,
4272 "reset=1&force=1&{$criteriaQueryParams}&state_province_id_op=in&state_province_id_value={$value}",
4273 $this->_absoluteUrl, $this->_id
4274 );
4275 $rows[$rowNum]['civicrm_address_state_province_id_link'] = $url;
4276 $rows[$rowNum]['civicrm_address_state_province_id_hover'] = ts("%1 for this state.",
4277 array(1 => $linkText)
4278 );
4279 }
4280 }
4281 $entryFound = TRUE;
4282 }
4283
4284 return $entryFound;
4285 }
4286
4287 /**
4288 * Do AlterDisplay processing on Address Fields.
4289 *
4290 * @param array $row
4291 * @param array $rows
4292 * @param int $rowNum
4293 * @param string $baseUrl
4294 * @param string $linkText
4295 *
4296 * @return bool
4297 */
4298 public function alterDisplayContactFields(&$row, &$rows, &$rowNum, $baseUrl, $linkText) {
4299 $entryFound = FALSE;
4300 // There is no reason not to add links for all fields but it seems a bit odd to be able to click on
4301 // 'Mrs'. Also, we don't have metadata about the title. So, add selectively to addLinks.
4302 $addLinks = array('gender_id' => 'Gender');
4303 foreach (array('prefix_id', 'suffix_id', 'gender_id') as $fieldName) {
4304 if (array_key_exists('civicrm_contact_' . $fieldName, $row)) {
4305 if (($value = $row['civicrm_contact_' . $fieldName]) != FALSE) {
4306 $rows[$rowNum]['civicrm_contact_' . $fieldName] = CRM_Core_Pseudoconstant::getLabel('CRM_Contact_BAO_Contact', $fieldName, $value);
4307 if ($baseUrl && ($title = CRM_Utils_Array::value($fieldName, $addLinks)) != FALSE) {
4308 $this->addLinkToRow($rows[$rowNum], $baseUrl, $linkText, $value, $fieldName, 'civicrm_contact', $title);
4309 }
4310 }
4311 $entryFound = TRUE;
4312 }
4313 }
4314 $yesNoFields = array(
4315 'do_not_email', 'is_deceased', 'do_not_phone', 'do_not_sms', 'do_not_mail', 'is_opt_out',
4316 );
4317 foreach ($yesNoFields as $fieldName) {
4318 if (array_key_exists('civicrm_contact_' . $fieldName, $row)) {
4319 // Since these are essentially 'negative fields' it feels like it
4320 // makes sense to only highlight the exceptions hence no 'No'.
4321 $rows[$rowNum]['civicrm_contact_' . $fieldName] = !empty($rows[$rowNum]['civicrm_contact_' . $fieldName]) ? ts('Yes') : '';
4322 $entryFound = TRUE;
4323 }
4324 }
4325 return $entryFound;
4326 }
4327
4328 /**
4329 * Adjusts dates passed in to YEAR() for fiscal year.
4330 *
4331 * @param string $fieldName
4332 *
4333 * @return string
4334 */
4335 public function fiscalYearOffset($fieldName) {
4336 $config = CRM_Core_Config::singleton();
4337 $fy = $config->fiscalYearStart;
4338 if (CRM_Utils_Array::value('yid_op', $this->_params) == 'calendar' ||
4339 ($fy['d'] == 1 && $fy['M'] == 1)
4340 ) {
4341 return "YEAR( $fieldName )";
4342 }
4343 return "YEAR( $fieldName - INTERVAL " . ($fy['M'] - 1) . " MONTH" .
4344 ($fy['d'] > 1 ? (" - INTERVAL " . ($fy['d'] - 1) . " DAY") : '') . " )";
4345 }
4346
4347 /**
4348 * Add Address into From Table if required.
4349 */
4350 public function addAddressFromClause() {
4351 // include address field if address column is to be included
4352 if ((isset($this->_addressField) &&
4353 $this->_addressField
4354 ) ||
4355 $this->isTableSelected('civicrm_address')
4356 ) {
4357 $this->_from .= "
4358 LEFT JOIN civicrm_address {$this->_aliases['civicrm_address']}
4359 ON ({$this->_aliases['civicrm_contact']}.id =
4360 {$this->_aliases['civicrm_address']}.contact_id) AND
4361 {$this->_aliases['civicrm_address']}.is_primary = 1\n";
4362 }
4363 }
4364
4365 /**
4366 * Add Phone into From Table if required.
4367 */
4368 public function addPhoneFromClause() {
4369 // include address field if address column is to be included
4370 if ($this->isTableSelected('civicrm_phone')
4371 ) {
4372 $this->_from .= "
4373 LEFT JOIN civicrm_phone {$this->_aliases['civicrm_phone']}
4374 ON ({$this->_aliases['civicrm_contact']}.id =
4375 {$this->_aliases['civicrm_phone']}.contact_id) AND
4376 {$this->_aliases['civicrm_phone']}.is_primary = 1\n";
4377 }
4378 }
4379
4380 /**
4381 * Get phone columns to add to array.
4382 *
4383 * @param array $options
4384 * - prefix Prefix to add to table (in case of more than one instance of the table)
4385 * - prefix_label Label to give columns from this phone table instance
4386 *
4387 * @return array
4388 * phone columns definition
4389 */
4390 public function getPhoneColumns($options = array()) {
4391 $defaultOptions = array(
4392 'prefix' => '',
4393 'prefix_label' => '',
4394 );
4395
4396 $options = array_merge($defaultOptions, $options);
4397
4398 $fields = array(
4399 $options['prefix'] . 'civicrm_phone' => array(
4400 'dao' => 'CRM_Core_DAO_Phone',
4401 'fields' => array(
4402 $options['prefix'] . 'phone' => array(
4403 'title' => ts($options['prefix_label'] . 'Phone'),
4404 'name' => 'phone',
4405 ),
4406 ),
4407 ),
4408 );
4409 return $fields;
4410 }
4411
4412 /**
4413 * Get address columns to add to array.
4414 *
4415 * @param array $options
4416 * - prefix Prefix to add to table (in case of more than one instance of the table)
4417 * - prefix_label Label to give columns from this address table instance
4418 *
4419 * @return array
4420 * address columns definition
4421 */
4422 public function getAddressColumns($options = array()) {
4423 $options += array(
4424 'prefix' => '',
4425 'prefix_label' => '',
4426 'group_by' => TRUE,
4427 'order_by' => TRUE,
4428 'filters' => TRUE,
4429 'defaults' => array(),
4430 );
4431 return $this->addAddressFields(
4432 $options['group_by'],
4433 $options['order_by'],
4434 $options['filters'],
4435 $options['defaults']
4436 );
4437 }
4438
4439 /**
4440 * Get a standard set of contact fields.
4441 *
4442 * @return array
4443 */
4444 public function getBasicContactFields() {
4445 return array(
4446 'sort_name' => array(
4447 'title' => ts('Contact Name'),
4448 'required' => TRUE,
4449 'default' => TRUE,
4450 ),
4451 'id' => array(
4452 'no_display' => TRUE,
4453 'required' => TRUE,
4454 ),
4455 'prefix_id' => array(
4456 'title' => ts('Contact Prefix'),
4457 ),
4458 'first_name' => array(
4459 'title' => ts('First Name'),
4460 ),
4461 'nick_name' => array(
4462 'title' => ts('Nick Name'),
4463 ),
4464 'middle_name' => array(
4465 'title' => ts('Middle Name'),
4466 ),
4467 'last_name' => array(
4468 'title' => ts('Last Name'),
4469 ),
4470 'suffix_id' => array(
4471 'title' => ts('Contact Suffix'),
4472 ),
4473 'postal_greeting_display' => array('title' => ts('Postal Greeting')),
4474 'email_greeting_display' => array('title' => ts('Email Greeting')),
4475 'addressee_display' => array('title' => ts('Addressee')),
4476 'contact_type' => array(
4477 'title' => ts('Contact Type'),
4478 ),
4479 'contact_sub_type' => array(
4480 'title' => ts('Contact Subtype'),
4481 ),
4482 'gender_id' => array(
4483 'title' => ts('Gender'),
4484 ),
4485 'birth_date' => array(
4486 'title' => ts('Birth Date'),
4487 ),
4488 'age' => array(
4489 'title' => ts('Age'),
4490 'dbAlias' => 'TIMESTAMPDIFF(YEAR, contact_civireport.birth_date, CURDATE())',
4491 ),
4492 'job_title' => array(
4493 'title' => ts('Contact Job title'),
4494 ),
4495 'organization_name' => array(
4496 'title' => ts('Organization Name'),
4497 ),
4498 'external_identifier' => array(
4499 'title' => ts('Contact identifier from external system'),
4500 ),
4501 'do_not_email' => array(),
4502 'do_not_phone' => array(),
4503 'do_not_mail' => array(),
4504 'do_not_sms' => array(),
4505 'is_opt_out' => array(),
4506 'is_deceased' => array(),
4507 );
4508 }
4509
4510 /**
4511 * Get a standard set of contact filters.
4512 *
4513 * @return array
4514 */
4515 public function getBasicContactFilters() {
4516 return array(
4517 'sort_name' => array(
4518 'title' => ts('Contact Name'),
4519 ),
4520 'source' => array(
4521 'title' => ts('Contact Source'),
4522 'type' => CRM_Utils_Type::T_STRING,
4523 ),
4524 'id' => array(
4525 'title' => ts('Contact ID'),
4526 'no_display' => TRUE,
4527 ),
4528 'gender_id' => array(
4529 'title' => ts('Gender'),
4530 'operatorType' => CRM_Report_Form::OP_MULTISELECT,
4531 'options' => CRM_Core_PseudoConstant::get('CRM_Contact_DAO_Contact', 'gender_id'),
4532 ),
4533 'birth_date' => array(
4534 'title' => ts('Birth Date'),
4535 'operatorType' => CRM_Report_Form::OP_DATE,
4536 ),
4537 'contact_type' => array(
4538 'title' => ts('Contact Type'),
4539 ),
4540 'contact_sub_type' => array(
4541 'title' => ts('Contact Subtype'),
4542 ),
4543 'modified_date' => array(
4544 'title' => ts('Contact Modified'),
4545 'operatorType' => CRM_Report_Form::OP_DATE,
4546 'type' => CRM_Utils_Type::T_DATE,
4547 ),
4548 'is_deceased' => array(
4549 'title' => ts('Deceased'),
4550 'type' => CRM_Utils_Type::T_BOOLEAN,
4551 'default' => 0,
4552 ),
4553 'do_not_email' => array(
4554 'title' => ts('Do not email'),
4555 'type' => CRM_Utils_Type::T_BOOLEAN,
4556 ),
4557 'do_not_phone' => array(
4558 'title' => ts('Do not phone'),
4559 'type' => CRM_Utils_Type::T_BOOLEAN,
4560 ),
4561 'do_not_mail' => array(
4562 'title' => ts('Do not mail'),
4563 'type' => CRM_Utils_Type::T_BOOLEAN,
4564 ),
4565 'do_not_sms' => array(
4566 'title' => ts('Do not SMS'),
4567 'type' => CRM_Utils_Type::T_BOOLEAN,
4568 ),
4569 'is_opt_out' => array(
4570 'title' => ts('Do not bulk email'),
4571 'type' => CRM_Utils_Type::T_BOOLEAN,
4572 ),
4573 );
4574 }
4575
4576 /**
4577 * Add contact to group.
4578 *
4579 * @param int $groupID
4580 */
4581 public function add2group($groupID) {
4582 if (is_numeric($groupID) && isset($this->_aliases['civicrm_contact'])) {
4583 $select = "SELECT DISTINCT {$this->_aliases['civicrm_contact']}.id AS addtogroup_contact_id, ";
4584
4585 // here are we are prepending / adding contact id field that could be used for adding group
4586 // so first check for "SELECT SQL_CALC_FOUND_ROWS" and if does not exist replace "SELECT"
4587 if (preg_match('/^SELECT SQL_CALC_FOUND_ROWS/', $this->_select)) {
4588 $select = str_ireplace('SELECT SQL_CALC_FOUND_ROWS ', $select, $this->_select);
4589 }
4590 else {
4591 $select = str_ireplace('SELECT ', $select, $this->_select);
4592 }
4593
4594 $sql = "{$select} {$this->_from} {$this->_where} {$this->_groupBy} {$this->_having} {$this->_orderBy}";
4595 $sql = str_replace('WITH ROLLUP', '', $sql);
4596 $dao = CRM_Core_DAO::executeQuery($sql);
4597
4598 $contact_ids = array();
4599 // Add resulting contacts to group
4600 while ($dao->fetch()) {
4601 if ($dao->addtogroup_contact_id) {
4602 $contact_ids[$dao->addtogroup_contact_id] = $dao->addtogroup_contact_id;
4603 }
4604 }
4605
4606 if (!empty($contact_ids)) {
4607 CRM_Contact_BAO_GroupContact::addContactsToGroup($contact_ids, $groupID);
4608 CRM_Core_Session::setStatus(ts("Listed contact(s) have been added to the selected group."), ts('Contacts Added'), 'success');
4609 }
4610 else {
4611 CRM_Core_Session::setStatus(ts("The listed records(s) cannot be added to the group."));
4612 }
4613 }
4614 }
4615
4616 /**
4617 * Show charts on print screen.
4618 */
4619 public static function uploadChartImage() {
4620 // upload strictly for '.png' images
4621 $name = trim(basename(CRM_Utils_Request::retrieve('name', 'String', CRM_Core_DAO::$_nullObject, FALSE, NULL, 'GET')));
4622 if (preg_match('/\.png$/', $name)) {
4623
4624 // Get the RAW .png from the input.
4625 $httpRawPostData = file_get_contents("php://input");
4626
4627 // prepare the directory
4628 $config = CRM_Core_Config::singleton();
4629 $defaultPath
4630 = str_replace('/persist/contribute/', '/persist/', $config->imageUploadDir) .
4631 '/openFlashChart/';
4632 if (!file_exists($defaultPath)) {
4633 mkdir($defaultPath, 0777, TRUE);
4634 }
4635
4636 // full path to the saved image including filename
4637 $destination = $defaultPath . $name;
4638
4639 //write and save
4640 $jfh = fopen($destination, 'w') or die("can't open file");
4641 fwrite($jfh, $httpRawPostData);
4642 fclose($jfh);
4643 CRM_Utils_System::civiExit();
4644 }
4645 }
4646
4647 /**
4648 * Apply common settings to entityRef fields.
4649 *
4650 * @param array $field
4651 * @param string $table
4652 */
4653 private function setEntityRefDefaults(&$field, $table) {
4654 $field['attributes'] = $field['attributes'] ? $field['attributes'] : array();
4655 $field['attributes'] += array(
4656 'entity' => CRM_Core_DAO_AllCoreTables::getBriefName(CRM_Core_DAO_AllCoreTables::getClassForTable($table)),
4657 'multiple' => TRUE,
4658 'placeholder' => ts('- select -'),
4659 );
4660 }
4661
4662 /**
4663 * Add link fields to the row.
4664 *
4665 * Function adds the _link & _hover fields to the row.
4666 *
4667 * @param array $row
4668 * @param string $baseUrl
4669 * @param string $linkText
4670 * @param string $value
4671 * @param string $fieldName
4672 * @param string $tablePrefix
4673 * @param string $fieldLabel
4674 *
4675 * @return mixed
4676 */
4677 protected function addLinkToRow(&$row, $baseUrl, $linkText, $value, $fieldName, $tablePrefix, $fieldLabel) {
4678 $criteriaQueryParams = CRM_Report_Utils_Report::getPreviewCriteriaQueryParams($this->_defaults, $this->_params);
4679 $url = CRM_Report_Utils_Report::getNextUrl($baseUrl,
4680 "reset=1&force=1&{$criteriaQueryParams}&" .
4681 $fieldName . "_op=in&{$fieldName}_value={$value}",
4682 $this->_absoluteUrl, $this->_id
4683 );
4684 $row["{$tablePrefix}_{$fieldName}_link"] = $url;
4685 $row["{$tablePrefix}_{$fieldName}_hover"] = ts("%1 for this %2.",
4686 array(1 => $linkText, 2 => $fieldLabel)
4687 );
4688 }
4689
4690 /**
4691 * Generate temporary table to hold all contributions with permissioned FTs.
4692 *
4693 * @param object $query
4694 * @param string $alias
4695 * @param bool $return
4696 */
4697 public function getPermissionedFTQuery(&$query, $alias = NULL, $return = FALSE) {
4698 if (!CRM_Financial_BAO_FinancialType::isACLFinancialTypeStatus()) {
4699 return FALSE;
4700 }
4701 $financialTypes = NULL;
4702 CRM_Financial_BAO_FinancialType::getAvailableFinancialTypes($financialTypes);
4703 if (empty($financialTypes)) {
4704 $contFTs = "0";
4705 $liFTs = implode(',', array_keys(CRM_Contribute_Pseudoconstant::financialType()));
4706 }
4707 else {
4708 $contFTs = $liFTs = implode(',', array_keys($financialTypes));
4709 }
4710 $temp = CRM_Utils_Array::value('civicrm_line_item', $query->_aliases);
4711 if ($alias) {
4712 $query->_aliases['civicrm_line_item'] = $alias;
4713 }
4714 elseif (!$temp) {
4715 $query->_aliases['civicrm_line_item'] = 'civicrm_line_item_civireport';
4716 }
4717 if (empty($query->_where)) {
4718 $query->_where = "WHERE {$query->_aliases['civicrm_contribution']}.id IS NOT NULL ";
4719 }
4720 CRM_Core_DAO::executeQuery("DROP TEMPORARY TABLE IF EXISTS civicrm_contribution_temp");
4721 $sql = "CREATE TEMPORARY TABLE civicrm_contribution_temp AS SELECT {$query->_aliases['civicrm_contribution']}.id {$query->_from}
4722 LEFT JOIN civicrm_line_item {$query->_aliases['civicrm_line_item']}
4723 ON {$query->_aliases['civicrm_contribution']}.id = {$query->_aliases['civicrm_line_item']}.contribution_id AND
4724 {$query->_aliases['civicrm_line_item']}.entity_table = 'civicrm_contribution'
4725 AND {$query->_aliases['civicrm_line_item']}.financial_type_id NOT IN (" . $liFTs . ")
4726 {$query->_where}
4727 AND {$query->_aliases['civicrm_contribution']}.financial_type_id IN (" . $contFTs . ")
4728 AND {$query->_aliases['civicrm_line_item']}.id IS NULL
4729 GROUP BY {$query->_aliases['civicrm_contribution']}.id";
4730 CRM_Core_DAO::executeQuery($sql);
4731 if (isset($temp)) {
4732 $query->_aliases['civicrm_line_item'] = $temp;
4733 }
4734 $from = " INNER JOIN civicrm_contribution_temp temp ON {$query->_aliases['civicrm_contribution']}.id = temp.id ";
4735 if ($return) {
4736 return $from;
4737 }
4738 $query->_from .= $from;
4739 }
4740
4741 /**
4742 * Get label for show results buttons.
4743 *
4744 * @return string
4745 */
4746 public function getResultsLabel() {
4747 $showResultsLabel = $this->resultsDisplayed() ? ts('Refresh results') : ts('View results');
4748 return $showResultsLabel;
4749 }
4750
4751 /**
4752 * Determine the output mode from the url or input.
4753 *
4754 * Output could be
4755 * - pdf : Render as pdf
4756 * - csv : Render as csv
4757 * - print : Render in print format
4758 * - save : save the report and display the new report
4759 * - copy : save the report as a new instance and display that.
4760 * - group : go to the add to group screen.
4761 *
4762 * Potentially chart variations could also be included but the complexity
4763 * is that we might print a bar chart as a pdf.
4764 */
4765 protected function setOutputMode() {
4766 $this->_outputMode = str_replace('report_instance.', '', CRM_Utils_Request::retrieve(
4767 'output',
4768 'String',
4769 CRM_Core_DAO::$_nullObject,
4770 FALSE,
4771 CRM_Utils_Array::value('task', $this->_params)
4772 ));
4773 // if contacts are added to group
4774 if (!empty($this->_params['groups']) && empty($this->_outputMode)) {
4775 $this->_outputMode = 'group';
4776 }
4777 if (isset($this->_params['task'])) {
4778 unset($this->_params['task']);
4779 }
4780 }
4781
4782 /**
4783 * CRM-17793 - Alter DateTime section header to group by date from the datetime field.
4784 *
4785 * @param $tempTable
4786 * @param $columnName
4787 */
4788 public function alterSectionHeaderForDateTime($tempTable, $columnName) {
4789 // add new column with date value for the datetime field
4790 $tempQuery = "ALTER TABLE {$tempTable} ADD COLUMN {$columnName}_date VARCHAR(128)";
4791 CRM_Core_DAO::executeQuery($tempQuery);
4792 $updateQuery = "UPDATE {$tempTable} SET {$columnName}_date = date({$columnName})";
4793 CRM_Core_DAO::executeQuery($updateQuery);
4794 $this->_selectClauses[] = "{$columnName}_date";
4795 $this->_select .= ", {$columnName}_date";
4796 $this->_sections["{$columnName}_date"] = $this->_sections["{$columnName}"];
4797 unset($this->_sections["{$columnName}"]);
4798 $this->assign('sections', $this->_sections);
4799 }
4800
4801 /**
4802 * Get an array of the columns that have been selected for display.
4803 *
4804 * @return array
4805 */
4806 public function getSelectColumns() {
4807 $selectColumns = array();
4808 foreach ($this->_columns as $tableName => $table) {
4809 if (array_key_exists('fields', $table)) {
4810 foreach ($table['fields'] as $fieldName => $field) {
4811 if (!empty($field['required']) ||
4812 !empty($this->_params['fields'][$fieldName])
4813 ) {
4814
4815 $selectColumns["{$tableName}_{$fieldName}"] = 1;
4816 }
4817 }
4818 }
4819 }
4820 return $selectColumns;
4821 }
4822
4823 /**
4824 * Add location tables to the query if they are used for filtering.
4825 *
4826 * This is for when we are running the query separately for filtering and retrieving display fields.
4827 */
4828 public function selectivelyAddLocationTablesJoinsToFilterQuery() {
4829 if ($this->isTableFiltered('civicrm_email')) {
4830 $this->_from .= "
4831 LEFT JOIN civicrm_email {$this->_aliases['civicrm_email']}
4832 ON {$this->_aliases['civicrm_contact']}.id = {$this->_aliases['civicrm_email']}.contact_id
4833 AND {$this->_aliases['civicrm_email']}.is_primary = 1";
4834 }
4835 if ($this->isTableFiltered('civicrm_phone')) {
4836 $this->_from .= "
4837 LEFT JOIN civicrm_phone {$this->_aliases['civicrm_phone']}
4838 ON {$this->_aliases['civicrm_contact']}.id = {$this->_aliases['civicrm_phone']}.contact_id
4839 AND {$this->_aliases['civicrm_phone']}.is_primary = 1";
4840 }
4841 if ($this->isTableFiltered('civicrm_address')) {
4842 $this->_from .= "
4843 LEFT JOIN civicrm_address {$this->_aliases['civicrm_address']}
4844 ON ({$this->_aliases['civicrm_contact']}.id = {$this->_aliases['civicrm_address']}.contact_id)
4845 AND {$this->_aliases['civicrm_address']}.is_primary = 1\n";
4846 }
4847 }
4848
4849 /**
4850 * Set the base table for the FROM clause.
4851 *
4852 * Sets up the from clause, allowing for the possibility it might be a
4853 * temp table pre-filtered by groups if a group filter is in use.
4854 *
4855 * @param string $baseTable
4856 * @param string $field
4857 * @param null $tableAlias
4858 */
4859 public function setFromBase($baseTable, $field = 'id', $tableAlias = NULL) {
4860 if (!$tableAlias) {
4861 $tableAlias = $this->_aliases[$baseTable];
4862 }
4863 $this->_from = $this->_from = " FROM $baseTable $tableAlias ";
4864 $this->joinGroupTempTable($baseTable, $field, $tableAlias);
4865 $this->_from .= " {$this->_aclFrom} ";
4866 }
4867
4868 /**
4869 * Join the temp table contacting contacts who are members of the filtered groups.
4870 *
4871 * If we are using an IN filter we use an inner join, otherwise a left join.
4872 *
4873 * @param string $baseTable
4874 * @param string $field
4875 * @param string $tableAlias
4876 */
4877 public function joinGroupTempTable($baseTable, $field, $tableAlias) {
4878 if ($this->groupTempTable) {
4879 if ($this->_params['gid_op'] == 'in') {
4880 $this->_from = " FROM $this->groupTempTable group_temp_table INNER JOIN $baseTable $tableAlias
4881 ON group_temp_table.id = $tableAlias.{$field} ";
4882 }
4883 else {
4884 $this->_from .= "
4885 LEFT JOIN $this->groupTempTable group_temp_table
4886 ON $tableAlias.{$field} = group_temp_table.id ";
4887 }
4888 }
4889 }
4890
4891 }