projects / civicrm-core.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
CRM-19170 optimise group filter on contribution summary report.
[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']['title'] = ts('Create Report');
1549 }
1550
1551 if (!$this->_csvSupported) {
1552 unset($actions['report_instance.csv']);
1553 }
1554
1555 return $actions;
1556 }
1557
1558 /**
1559 * Main build form function.
1560 */
1561 public function buildQuickForm() {
1562 $this->addColumns();
1563
1564 $this->addFilters();
1565
1566 $this->addOptions();
1567
1568 $this->addGroupBys();
1569
1570 $this->addOrderBys();
1571
1572 $this->buildInstanceAndButtons();
1573
1574 // Add form rule for report.
1575 if (is_callable(array(
1576 $this,
1577 'formRule',
1578 ))) {
1579 $this->addFormRule(array(get_class($this), 'formRule'), $this);
1580 }
1581 $this->assignTabs();
1582 }
1583
1584 /**
1585 * A form rule function for custom data.
1586 *
1587 * The rule ensures that fields selected in group_by if any) should only be the ones
1588 * present in display/select fields criteria;
1589 * note: works if and only if any custom field selected in group_by.
1590 *
1591 * @param array $fields
1592 * @param array $ignoreFields
1593 *
1594 * @return array
1595 */
1596 public function customDataFormRule($fields, $ignoreFields = array()) {
1597 $errors = array();
1598 if (!empty($this->_customGroupExtends) && $this->_customGroupGroupBy &&
1599 !empty($fields['group_bys'])
1600 ) {
1601 foreach ($this->_columns as $tableName => $table) {
1602 if ((substr($tableName, 0, 13) == 'civicrm_value' ||
1603 substr($tableName, 0, 12) == 'custom_value') &&
1604 !empty($this->_columns[$tableName]['fields'])
1605 ) {
1606 foreach ($this->_columns[$tableName]['fields'] as $fieldName => $field) {
1607 if (array_key_exists($fieldName, $fields['group_bys']) &&
1608 !array_key_exists($fieldName, $fields['fields'])
1609 ) {
1610 $errors['fields'] = "Please make sure fields selected in 'Group by Columns' section are also selected in 'Display Columns' section.";
1611 }
1612 elseif (array_key_exists($fieldName, $fields['group_bys'])) {
1613 foreach ($fields['fields'] as $fld => $val) {
1614 if (!array_key_exists($fld, $fields['group_bys']) &&
1615 !in_array($fld, $ignoreFields)
1616 ) {
1617 $errors['fields'] = "Please ensure that fields selected in 'Display Columns' are also selected in 'Group by Columns' section.";
1618 }
1619 }
1620 }
1621 }
1622 }
1623 }
1624 }
1625 return $errors;
1626 }
1627
1628 /**
1629 * Get operators to display on form.
1630 *
1631 * Note: $fieldName param allows inheriting class to build operationPairs specific to a field.
1632 *
1633 * @param string $type
1634 * @param string $fieldName
1635 *
1636 * @return array
1637 */
1638 public function getOperationPair($type = "string", $fieldName = NULL) {
1639 // FIXME: At some point we should move these key-val pairs
1640 // to option_group and option_value table.
1641 switch ($type) {
1642 case CRM_Report_Form::OP_INT:
1643 case CRM_Report_Form::OP_FLOAT:
1644
1645 $result = array(
1646 'lte' => ts('Is less than or equal to'),
1647 'gte' => ts('Is greater than or equal to'),
1648 'bw' => ts('Is between'),
1649 'eq' => ts('Is equal to'),
1650 'lt' => ts('Is less than'),
1651 'gt' => ts('Is greater than'),
1652 'neq' => ts('Is not equal to'),
1653 'nbw' => ts('Is not between'),
1654 'nll' => ts('Is empty (Null)'),
1655 'nnll' => ts('Is not empty (Null)'),
1656 );
1657 return $result;
1658
1659 case CRM_Report_Form::OP_SELECT:
1660 $result = array(
1661 'eq' => ts('Is equal to'),
1662 );
1663 return $result;
1664
1665 case CRM_Report_Form::OP_MONTH:
1666 case CRM_Report_Form::OP_MULTISELECT:
1667 case CRM_Report_Form::OP_ENTITYREF:
1668
1669 $result = array(
1670 'in' => ts('Is one of'),
1671 'notin' => ts('Is not one of'),
1672 );
1673 return $result;
1674
1675 case CRM_Report_Form::OP_DATE:
1676
1677 $result = array(
1678 'nll' => ts('Is empty (Null)'),
1679 'nnll' => ts('Is not empty (Null)'),
1680 );
1681 return $result;
1682
1683 case CRM_Report_Form::OP_MULTISELECT_SEPARATOR:
1684 // use this operator for the values, concatenated with separator. For e.g if
1685 // multiple options for a column is stored as ^A{val1}^A{val2}^A
1686 $result = array(
1687 'mhas' => ts('Is one of'),
1688 'mnot' => ts('Is not one of'),
1689 );
1690 return $result;
1691
1692 default:
1693 // type is string
1694 $result = array(
1695 'has' => ts('Contains'),
1696 'sw' => ts('Starts with'),
1697 'ew' => ts('Ends with'),
1698 'nhas' => ts('Does not contain'),
1699 'eq' => ts('Is equal to'),
1700 'neq' => ts('Is not equal to'),
1701 'nll' => ts('Is empty (Null)'),
1702 'nnll' => ts('Is not empty (Null)'),
1703 );
1704 return $result;
1705 }
1706 }
1707
1708 /**
1709 * Build the tag filter field to display on the filters tab.
1710 */
1711 public function buildTagFilter() {
1712 $contactTags = CRM_Core_BAO_Tag::getTags($this->_tagFilterTable);
1713 if (!empty($contactTags)) {
1714 $this->_columns['civicrm_tag'] = array(
1715 'dao' => 'CRM_Core_DAO_Tag',
1716 'filters' => array(
1717 'tagid' => array(
1718 'name' => 'tag_id',
1719 'title' => ts('Tag'),
1720 'type' => CRM_Utils_Type::T_INT,
1721 'tag' => TRUE,
1722 'operatorType' => CRM_Report_Form::OP_MULTISELECT,
1723 'options' => $contactTags,
1724 ),
1725 ),
1726 );
1727 }
1728 }
1729
1730 /**
1731 * Adds group filters to _columns (called from _Construct).
1732 */
1733 public function buildGroupFilter() {
1734 $this->_columns['civicrm_group']['filters'] = array(
1735 'gid' => array(
1736 'name' => 'group_id',
1737 'title' => ts('Group'),
1738 'type' => CRM_Utils_Type::T_INT,
1739 'operatorType' => CRM_Report_Form::OP_MULTISELECT,
1740 'group' => TRUE,
1741 'options' => CRM_Core_PseudoConstant::nestedGroup(),
1742 ),
1743 );
1744 if (empty($this->_columns['civicrm_group']['dao'])) {
1745 $this->_columns['civicrm_group']['dao'] = 'CRM_Contact_DAO_GroupContact';
1746 }
1747 if (empty($this->_columns['civicrm_group']['alias'])) {
1748 $this->_columns['civicrm_group']['alias'] = 'cgroup';
1749 }
1750 }
1751
1752 /**
1753 * Get SQL operator from form text version.
1754 *
1755 * @param string $operator
1756 *
1757 * @return string
1758 */
1759 public function getSQLOperator($operator = "like") {
1760 switch ($operator) {
1761 case 'eq':
1762 return '=';
1763
1764 case 'lt':
1765 return '<';
1766
1767 case 'lte':
1768 return '<=';
1769
1770 case 'gt':
1771 return '>';
1772
1773 case 'gte':
1774 return '>=';
1775
1776 case 'ne':
1777 case 'neq':
1778 return '!=';
1779
1780 case 'nhas':
1781 return 'NOT LIKE';
1782
1783 case 'in':
1784 return 'IN';
1785
1786 case 'notin':
1787 return 'NOT IN';
1788
1789 case 'nll':
1790 return 'IS NULL';
1791
1792 case 'nnll':
1793 return 'IS NOT NULL';
1794
1795 default:
1796 // type is string
1797 return 'LIKE';
1798 }
1799 }
1800
1801 /**
1802 * Generate where clause.
1803 *
1804 * This can be overridden in reports for special treatment of a field
1805 *
1806 * @param array $field Field specifications
1807 * @param string $op Query operator (not an exact match to sql)
1808 * @param mixed $value
1809 * @param float $min
1810 * @param float $max
1811 *
1812 * @return null|string
1813 */
1814 public function whereClause(&$field, $op, $value, $min, $max) {
1815
1816 $type = CRM_Utils_Type::typeToString(CRM_Utils_Array::value('type', $field));
1817
1818 // CRM-18010: Ensure type of each report filters
1819 if (!$type) {
1820 trigger_error('Type is not defined for field ' . $field['name'], E_USER_WARNING);
1821 }
1822 $clause = NULL;
1823
1824 switch ($op) {
1825 case 'bw':
1826 case 'nbw':
1827 if (($min !== NULL && strlen($min) > 0) ||
1828 ($max !== NULL && strlen($max) > 0)
1829 ) {
1830 $clauses = array();
1831 if ($min) {
1832 $min = CRM_Utils_Type::escape($min, $type);
1833 if ($op == 'bw') {
1834 $clauses[] = "( {$field['dbAlias']} >= $min )";
1835 }
1836 else {
1837 $clauses[] = "( {$field['dbAlias']} < $min OR {$field['dbAlias']} IS NULL )";
1838 }
1839 }
1840 if ($max) {
1841 $max = CRM_Utils_Type::escape($max, $type);
1842 if ($op == 'bw') {
1843 $clauses[] = "( {$field['dbAlias']} <= $max )";
1844 }
1845 else {
1846 $clauses[] = "( {$field['dbAlias']} > $max )";
1847 }
1848 }
1849
1850 if (!empty($clauses)) {
1851 if ($op == 'bw') {
1852 $clause = implode(' AND ', $clauses);
1853 }
1854 else {
1855 $clause = '(' . implode('OR', $clauses) . ')';
1856 }
1857 }
1858 }
1859 break;
1860
1861 case 'has':
1862 case 'nhas':
1863 if ($value !== NULL && strlen($value) > 0) {
1864 $value = CRM_Utils_Type::escape($value, $type);
1865 if (strpos($value, '%') === FALSE) {
1866 $value = "'%{$value}%'";
1867 }
1868 else {
1869 $value = "'{$value}'";
1870 }
1871 $sqlOP = $this->getSQLOperator($op);
1872 $clause = "( {$field['dbAlias']} $sqlOP $value )";
1873 }
1874 break;
1875
1876 case 'in':
1877 case 'notin':
1878 if ((is_string($value) || is_numeric($value)) && strlen($value)) {
1879 $value = explode(',', $value);
1880 }
1881 if ($value !== NULL && is_array($value) && count($value) > 0) {
1882 $sqlOP = $this->getSQLOperator($op);
1883 if (CRM_Utils_Array::value('type', $field) ==
1884 CRM_Utils_Type::T_STRING
1885 ) {
1886 //cycle through selections and escape values
1887 foreach ($value as $key => $selection) {
1888 $value[$key] = CRM_Utils_Type::escape($selection, $type);
1889 }
1890 $clause
1891 = "( {$field['dbAlias']} $sqlOP ( '" . implode("' , '", $value) .
1892 "') )";
1893 }
1894 else {
1895 // for numerical values
1896 $clause = "{$field['dbAlias']} $sqlOP (" . implode(', ', $value) .
1897 ")";
1898 }
1899 if ($op == 'notin') {
1900 $clause = "( " . $clause . " OR {$field['dbAlias']} IS NULL )";
1901 }
1902 else {
1903 $clause = "( " . $clause . " )";
1904 }
1905 }
1906 break;
1907
1908 case 'mhas':
1909 case 'mnot':
1910 // multiple has or multiple not
1911 if ($value !== NULL && count($value) > 0) {
1912 $value = CRM_Utils_Type::escapeAll($value, $type);
1913 $operator = $op == 'mnot' ? 'NOT' : '';
1914 $regexp = "([[:cntrl:]]|^)" . implode('([[:cntrl:]]|$)|([[:cntrl:]]|^)', (array) $value) . "([[:cntrl:]]|$)";
1915 $clause = "{$field['dbAlias']} {$operator} REGEXP '{$regexp}'";
1916 }
1917 break;
1918
1919 case 'sw':
1920 case 'ew':
1921 if ($value !== NULL && strlen($value) > 0) {
1922 $value = CRM_Utils_Type::escape($value, $type);
1923 if (strpos($value, '%') === FALSE) {
1924 if ($op == 'sw') {
1925 $value = "'{$value}%'";
1926 }
1927 else {
1928 $value = "'%{$value}'";
1929 }
1930 }
1931 else {
1932 $value = "'{$value}'";
1933 }
1934 $sqlOP = $this->getSQLOperator($op);
1935 $clause = "( {$field['dbAlias']} $sqlOP $value )";
1936 }
1937 break;
1938
1939 case 'nll':
1940 case 'nnll':
1941 $sqlOP = $this->getSQLOperator($op);
1942 $clause = "( {$field['dbAlias']} $sqlOP )";
1943 break;
1944
1945 case 'eq':
1946 case 'neq':
1947 case 'ne':
1948 //CRM-18457: some custom field passes value in array format against binary operator
1949 if (is_array($value) && count($value)) {
1950 $value = $value[0];
1951 }
1952
1953 default:
1954 if ($value !== NULL && $value !== '') {
1955 if (isset($field['clause'])) {
1956 // FIXME: we not doing escape here. Better solution is to use two
1957 // different types - data-type and filter-type
1958 $clause = $field['clause'];
1959 }
1960 elseif (!is_array($value)) {
1961 $value = CRM_Utils_Type::escape($value, $type);
1962 $sqlOP = $this->getSQLOperator($op);
1963 if ($field['type'] == CRM_Utils_Type::T_STRING) {
1964 $value = "'{$value}'";
1965 }
1966 $clause = "( {$field['dbAlias']} $sqlOP $value )";
1967 }
1968 }
1969 break;
1970 }
1971
1972 if (!empty($field['group']) && $clause) {
1973 $clause = $this->whereGroupClause($field, $value, $op);
1974 }
1975 elseif (!empty($field['tag']) && $clause) {
1976 // not using left join in query because if any contact
1977 // belongs to more than one tag, results duplicate
1978 // entries.
1979 $clause = $this->whereTagClause($field, $value, $op);
1980 }
1981 elseif (!empty($field['membership_org']) && $clause) {
1982 $clause = $this->whereMembershipOrgClause($value, $op);
1983 }
1984 elseif (!empty($field['membership_type']) && $clause) {
1985 $clause = $this->whereMembershipTypeClause($value, $op);
1986 }
1987 return $clause;
1988 }
1989
1990 /**
1991 * Get SQL where clause for a date field.
1992 *
1993 * @param string $fieldName
1994 * @param string $relative
1995 * @param string $from
1996 * @param string $to
1997 * @param string $type
1998 * @param string $fromTime
1999 * @param string $toTime
2000 *
2001 * @return null|string
2002 */
2003 public function dateClause(
2004 $fieldName,
2005 $relative, $from, $to, $type = NULL, $fromTime = NULL, $toTime = NULL
2006 ) {
2007 $clauses = array();
2008 if (in_array($relative, array_keys($this->getOperationPair(CRM_Report_Form::OP_DATE)))) {
2009 $sqlOP = $this->getSQLOperator($relative);
2010 return "( {$fieldName} {$sqlOP} )";
2011 }
2012
2013 list($from, $to) = $this->getFromTo($relative, $from, $to, $fromTime, $toTime);
2014
2015 if ($from) {
2016 $from = ($type == CRM_Utils_Type::T_DATE) ? substr($from, 0, 8) : $from;
2017 $clauses[] = "( {$fieldName} >= $from )";
2018 }
2019
2020 if ($to) {
2021 $to = ($type == CRM_Utils_Type::T_DATE) ? substr($to, 0, 8) : $to;
2022 $clauses[] = "( {$fieldName} <= {$to} )";
2023 }
2024
2025 if (!empty($clauses)) {
2026 return implode(' AND ', $clauses);
2027 }
2028
2029 return NULL;
2030 }
2031
2032 /**
2033 * Get values for from and to for date ranges.
2034 *
2035 * @param bool $relative
2036 * @param string $from
2037 * @param string $to
2038 * @param string $fromTime
2039 * @param string $toTime
2040 *
2041 * @return array
2042 */
2043 public function getFromTo($relative, $from, $to, $fromTime = NULL, $toTime = NULL) {
2044 if (empty($toTime)) {
2045 $toTime = '235959';
2046 }
2047 //FIX ME not working for relative
2048 if ($relative) {
2049 list($term, $unit) = CRM_Utils_System::explode('.', $relative, 2);
2050 $dateRange = CRM_Utils_Date::relativeToAbsolute($term, $unit);
2051 $from = substr($dateRange['from'], 0, 8);
2052 //Take only Date Part, Sometime Time part is also present in 'to'
2053 $to = substr($dateRange['to'], 0, 8);
2054 }
2055 $from = CRM_Utils_Date::processDate($from, $fromTime);
2056 $to = CRM_Utils_Date::processDate($to, $toTime);
2057 return array($from, $to);
2058 }
2059
2060 /**
2061 * Alter display of rows.
2062 *
2063 * Iterate through the rows retrieved via SQL and make changes for display purposes,
2064 * such as rendering contacts as links.
2065 *
2066 * @param array $rows
2067 * Rows generated by SQL, with an array for each row.
2068 */
2069 public function alterDisplay(&$rows) {
2070 }
2071
2072 /**
2073 * Alter the way in which custom data fields are displayed.
2074 *
2075 * @param array $rows
2076 */
2077 public function alterCustomDataDisplay(&$rows) {
2078 // custom code to alter rows having custom values
2079 if (empty($this->_customGroupExtends)) {
2080 return;
2081 }
2082
2083 $customFieldIds = array();
2084 foreach ($this->_params['fields'] as $fieldAlias => $value) {
2085 if ($fieldId = CRM_Core_BAO_CustomField::getKeyID($fieldAlias)) {
2086 $customFieldIds[$fieldAlias] = $fieldId;
2087 }
2088 }
2089 if (empty($customFieldIds)) {
2090 return;
2091 }
2092
2093 // skip for type date and ContactReference since date format is already handled
2094 $query = "
2095 SELECT cg.table_name, cf.id
2096 FROM civicrm_custom_field cf
2097 INNER JOIN civicrm_custom_group cg ON cg.id = cf.custom_group_id
2098 WHERE cg.extends IN ('" . implode("','", $this->_customGroupExtends) . "') AND
2099 cg.is_active = 1 AND
2100 cf.is_active = 1 AND
2101 cf.is_searchable = 1 AND
2102 cf.data_type NOT IN ('ContactReference', 'Date') AND
2103 cf.id IN (" . implode(",", $customFieldIds) . ")";
2104
2105 $dao = CRM_Core_DAO::executeQuery($query);
2106 while ($dao->fetch()) {
2107 $customFields[$dao->table_name . '_custom_' . $dao->id] = $dao->id;
2108 }
2109 $dao->free();
2110
2111 $entryFound = FALSE;
2112 foreach ($rows as $rowNum => $row) {
2113 foreach ($row as $tableCol => $val) {
2114 if (array_key_exists($tableCol, $customFields)) {
2115 $rows[$rowNum][$tableCol] = CRM_Core_BAO_CustomField::displayValue($val, $customFields[$tableCol]);
2116 $entryFound = TRUE;
2117 }
2118 }
2119
2120 // skip looking further in rows, if first row itself doesn't
2121 // have the column we need
2122 if (!$entryFound) {
2123 break;
2124 }
2125 }
2126 }
2127
2128 /**
2129 * Remove duplicate rows.
2130 *
2131 * @param array $rows
2132 */
2133 public function removeDuplicates(&$rows) {
2134 if (empty($this->_noRepeats)) {
2135 return;
2136 }
2137 $checkList = array();
2138
2139 foreach ($rows as $key => $list) {
2140 foreach ($list as $colName => $colVal) {
2141 if (array_key_exists($colName, $checkList) &&
2142 $checkList[$colName] == $colVal
2143 ) {
2144 $rows[$key][$colName] = "";
2145 }
2146 if (in_array($colName, $this->_noRepeats)) {
2147 $checkList[$colName] = $colVal;
2148 }
2149 }
2150 }
2151 }
2152
2153 /**
2154 * Fix subtotal display.
2155 *
2156 * @param array $row
2157 * @param array $fields
2158 * @param bool $subtotal
2159 */
2160 public function fixSubTotalDisplay(&$row, $fields, $subtotal = TRUE) {
2161 foreach ($row as $colName => $colVal) {
2162 if (in_array($colName, $fields)) {
2163 }
2164 elseif (isset($this->_columnHeaders[$colName])) {
2165 if ($subtotal) {
2166 $row[$colName] = 'Subtotal';
2167 $subtotal = FALSE;
2168 }
2169 else {
2170 unset($row[$colName]);
2171 }
2172 }
2173 }
2174 }
2175
2176 /**
2177 * Calculate grant total.
2178 *
2179 * @param array $rows
2180 *
2181 * @return bool
2182 */
2183 public function grandTotal(&$rows) {
2184 if (!$this->_rollup || count($rows) == 1) {
2185 return FALSE;
2186 }
2187
2188 $this->moveSummaryColumnsToTheRightHandSide();
2189
2190 if ($this->_limit && count($rows) >= self::ROW_COUNT_LIMIT) {
2191 return FALSE;
2192 }
2193
2194 $this->rollupRow = array_pop($rows);
2195
2196 foreach ($this->_columnHeaders as $fld => $val) {
2197 if (!in_array($fld, $this->_statFields)) {
2198 if (!$this->_grandFlag) {
2199 $this->rollupRow[$fld] = ts('Grand Total');
2200 $this->_grandFlag = TRUE;
2201 }
2202 else {
2203 $this->rollupRow[$fld] = "";
2204 }
2205 }
2206 }
2207
2208 $this->assign('grandStat', $this->rollupRow);
2209 return TRUE;
2210 }
2211
2212 /**
2213 * Format display output.
2214 *
2215 * @param array $rows
2216 * @param bool $pager
2217 */
2218 public function formatDisplay(&$rows, $pager = TRUE) {
2219 // set pager based on if any limit was applied in the query.
2220 if ($pager) {
2221 $this->setPager();
2222 }
2223
2224 // allow building charts if any
2225 if (!empty($this->_params['charts']) && !empty($rows)) {
2226 $this->buildChart($rows);
2227 $this->assign('chartEnabled', TRUE);
2228 $this->_chartId = "{$this->_params['charts']}_" .
2229 ($this->_id ? $this->_id : substr(get_class($this), 16)) . '_' .
2230 session_id();
2231 $this->assign('chartId', $this->_chartId);
2232 }
2233
2234 // unset columns not to be displayed.
2235 foreach ($this->_columnHeaders as $key => $value) {
2236 if (!empty($value['no_display'])) {
2237 unset($this->_columnHeaders[$key]);
2238 }
2239 }
2240
2241 // unset columns not to be displayed.
2242 if (!empty($rows)) {
2243 foreach ($this->_noDisplay as $noDisplayField) {
2244 foreach ($rows as $rowNum => $row) {
2245 unset($this->_columnHeaders[$noDisplayField]);
2246 }
2247 }
2248 }
2249
2250 // build array of section totals
2251 $this->sectionTotals();
2252
2253 // process grand-total row
2254 $this->grandTotal($rows);
2255
2256 // use this method for formatting rows for display purpose.
2257 $this->alterDisplay($rows);
2258 CRM_Utils_Hook::alterReportVar('rows', $rows, $this);
2259
2260 // use this method for formatting custom rows for display purpose.
2261 $this->alterCustomDataDisplay($rows);
2262 }
2263
2264 /**
2265 * Build chart.
2266 *
2267 * @param array $rows
2268 */
2269 public function buildChart(&$rows) {
2270 // override this method for building charts.
2271 }
2272
2273 // select() method below has been added recently (v3.3), and many of the report templates might
2274 // still be having their own select() method. We should fix them as and when encountered and move
2275 // towards generalizing the select() method below.
2276
2277 /**
2278 * Generate the SELECT clause and set class variable $_select.
2279 */
2280 public function select() {
2281 $select = $this->_selectAliases = array();
2282
2283 foreach ($this->_columns as $tableName => $table) {
2284 if (array_key_exists('fields', $table)) {
2285 foreach ($table['fields'] as $fieldName => $field) {
2286 if ($tableName == 'civicrm_address') {
2287 $this->_addressField = TRUE;
2288 }
2289 if ($tableName == 'civicrm_email') {
2290 $this->_emailField = TRUE;
2291 }
2292 if ($tableName == 'civicrm_phone') {
2293 $this->_phoneField = TRUE;
2294 }
2295
2296 if (!empty($field['required']) ||
2297 !empty($this->_params['fields'][$fieldName])
2298 ) {
2299
2300 // 1. In many cases we want select clause to be built in slightly different way
2301 // for a particular field of a particular type.
2302 // 2. This method when used should receive params by reference and modify $this->_columnHeaders
2303 // as needed.
2304 $selectClause = $this->selectClause($tableName, 'fields', $fieldName, $field);
2305 if ($selectClause) {
2306 $select[] = $selectClause;
2307 continue;
2308 }
2309
2310 // include statistics columns only if set
2311 if (!empty($field['statistics'])) {
2312 foreach ($field['statistics'] as $stat => $label) {
2313 $alias = "{$tableName}_{$fieldName}_{$stat}";
2314 switch (strtolower($stat)) {
2315 case 'max':
2316 case 'sum':
2317 $select[] = "$stat({$field['dbAlias']}) as $alias";
2318 $this->_columnHeaders["{$tableName}_{$fieldName}_{$stat}"]['title'] = $label;
2319 $this->_columnHeaders["{$tableName}_{$fieldName}_{$stat}"]['type'] = $field['type'];
2320 $this->_statFields[$label] = $alias;
2321 $this->_selectAliases[] = $alias;
2322 break;
2323
2324 case 'count':
2325 $select[] = "COUNT({$field['dbAlias']}) as $alias";
2326 $this->_columnHeaders["{$tableName}_{$fieldName}_{$stat}"]['title'] = $label;
2327 $this->_columnHeaders["{$tableName}_{$fieldName}_{$stat}"]['type'] = CRM_Utils_Type::T_INT;
2328 $this->_statFields[$label] = $alias;
2329 $this->_selectAliases[] = $alias;
2330 break;
2331
2332 case 'count_distinct':
2333 $select[] = "COUNT(DISTINCT {$field['dbAlias']}) as $alias";
2334 $this->_columnHeaders["{$tableName}_{$fieldName}_{$stat}"]['title'] = $label;
2335 $this->_columnHeaders["{$tableName}_{$fieldName}_{$stat}"]['type'] = CRM_Utils_Type::T_INT;
2336 $this->_statFields[$label] = $alias;
2337 $this->_selectAliases[] = $alias;
2338 break;
2339
2340 case 'avg':
2341 $select[] = "ROUND(AVG({$field['dbAlias']}),2) as $alias";
2342 $this->_columnHeaders["{$tableName}_{$fieldName}_{$stat}"]['title'] = $label;
2343 $this->_columnHeaders["{$tableName}_{$fieldName}_{$stat}"]['type'] = $field['type'];
2344 $this->_statFields[$label] = $alias;
2345 $this->_selectAliases[] = $alias;
2346 break;
2347 }
2348 }
2349 }
2350 else {
2351 $alias = "{$tableName}_{$fieldName}";
2352 $select[] = "{$field['dbAlias']} as $alias";
2353 $this->_columnHeaders["{$tableName}_{$fieldName}"]['title'] = CRM_Utils_Array::value('title', $field);
2354 $this->_columnHeaders["{$tableName}_{$fieldName}"]['type'] = CRM_Utils_Array::value('type', $field);
2355 $this->_selectAliases[] = $alias;
2356 }
2357 }
2358 }
2359 }
2360
2361 // select for group bys
2362 if (array_key_exists('group_bys', $table)) {
2363 foreach ($table['group_bys'] as $fieldName => $field) {
2364
2365 if ($tableName == 'civicrm_address') {
2366 $this->_addressField = TRUE;
2367 }
2368 if ($tableName == 'civicrm_email') {
2369 $this->_emailField = TRUE;
2370 }
2371 if ($tableName == 'civicrm_phone') {
2372 $this->_phoneField = TRUE;
2373 }
2374 // 1. In many cases we want select clause to be built in slightly different way
2375 // for a particular field of a particular type.
2376 // 2. This method when used should receive params by reference and modify $this->_columnHeaders
2377 // as needed.
2378 $selectClause = $this->selectClause($tableName, 'group_bys', $fieldName, $field);
2379 if ($selectClause) {
2380 $select[] = $selectClause;
2381 continue;
2382 }
2383
2384 if (!empty($this->_params['group_bys']) &&
2385 !empty($this->_params['group_bys'][$fieldName]) &&
2386 !empty($this->_params['group_bys_freq'])
2387 ) {
2388 switch (CRM_Utils_Array::value($fieldName, $this->_params['group_bys_freq'])) {
2389 case 'YEARWEEK':
2390 $select[] = "DATE_SUB({$field['dbAlias']}, INTERVAL WEEKDAY({$field['dbAlias']}) DAY) AS {$tableName}_{$fieldName}_start";
2391 $select[] = "YEARWEEK({$field['dbAlias']}) AS {$tableName}_{$fieldName}_subtotal";
2392 $select[] = "WEEKOFYEAR({$field['dbAlias']}) AS {$tableName}_{$fieldName}_interval";
2393 $field['title'] = 'Week';
2394 break;
2395
2396 case 'YEAR':
2397 $select[] = "MAKEDATE(YEAR({$field['dbAlias']}), 1) AS {$tableName}_{$fieldName}_start";
2398 $select[] = "YEAR({$field['dbAlias']}) AS {$tableName}_{$fieldName}_subtotal";
2399 $select[] = "YEAR({$field['dbAlias']}) AS {$tableName}_{$fieldName}_interval";
2400 $field['title'] = 'Year';
2401 break;
2402
2403 case 'MONTH':
2404 $select[] = "DATE_SUB({$field['dbAlias']}, INTERVAL (DAYOFMONTH({$field['dbAlias']})-1) DAY) as {$tableName}_{$fieldName}_start";
2405 $select[] = "MONTH({$field['dbAlias']}) AS {$tableName}_{$fieldName}_subtotal";
2406 $select[] = "MONTHNAME({$field['dbAlias']}) AS {$tableName}_{$fieldName}_interval";
2407 $field['title'] = 'Month';
2408 break;
2409
2410 case 'QUARTER':
2411 $select[] = "STR_TO_DATE(CONCAT( 3 * QUARTER( {$field['dbAlias']} ) -2 , '/', '1', '/', YEAR( {$field['dbAlias']} ) ), '%m/%d/%Y') AS {$tableName}_{$fieldName}_start";
2412 $select[] = "QUARTER({$field['dbAlias']}) AS {$tableName}_{$fieldName}_subtotal";
2413 $select[] = "QUARTER({$field['dbAlias']}) AS {$tableName}_{$fieldName}_interval";
2414 $field['title'] = 'Quarter';
2415 break;
2416 }
2417 // for graphs and charts -
2418 if (!empty($this->_params['group_bys_freq'][$fieldName])) {
2419 $this->_interval = $field['title'];
2420 $this->_columnHeaders["{$tableName}_{$fieldName}_start"]['title']
2421 = $field['title'] . ' Beginning';
2422 $this->_columnHeaders["{$tableName}_{$fieldName}_start"]['type'] = $field['type'];
2423 $this->_columnHeaders["{$tableName}_{$fieldName}_start"]['group_by'] = $this->_params['group_bys_freq'][$fieldName];
2424
2425 // just to make sure these values are transferred to rows.
2426 // since we 'll need them for calculation purpose,
2427 // e.g making subtotals look nicer or graphs
2428 $this->_columnHeaders["{$tableName}_{$fieldName}_interval"] = array('no_display' => TRUE);
2429 $this->_columnHeaders["{$tableName}_{$fieldName}_subtotal"] = array('no_display' => TRUE);
2430 }
2431 }
2432 }
2433 }
2434 }
2435
2436 $this->_selectClauses = $select;
2437 $this->_select = "SELECT " . implode(', ', $select) . " ";
2438 }
2439
2440 /**
2441 * Build select clause for a single field.
2442 *
2443 * @param string $tableName
2444 * @param string $tableKey
2445 * @param string $fieldName
2446 * @param string $field
2447 *
2448 * @return bool
2449 */
2450 public function selectClause(&$tableName, $tableKey, &$fieldName, &$field) {
2451 return FALSE;
2452 }
2453
2454 /**
2455 * Build where clause.
2456 */
2457 public function where() {
2458 $this->storeWhereHavingClauseArray();
2459
2460 if (empty($this->_whereClauses)) {
2461 $this->_where = "WHERE ( 1 ) ";
2462 $this->_having = "";
2463 }
2464 else {
2465 $this->_where = "WHERE " . implode(' AND ', $this->_whereClauses);
2466 }
2467
2468 if ($this->_aclWhere) {
2469 $this->_where .= " AND {$this->_aclWhere} ";
2470 }
2471
2472 if (!empty($this->_havingClauses)) {
2473 // use this clause to construct group by clause.
2474 $this->_having = "HAVING " . implode(' AND ', $this->_havingClauses);
2475 }
2476 }
2477
2478 /**
2479 * Store Where clauses into an array.
2480 *
2481 * Breaking out this step makes over-riding more flexible as the clauses can be used in constructing a
2482 * temp table that may not be part of the final where clause or added
2483 * in other functions
2484 */
2485 public function storeWhereHavingClauseArray() {
2486 foreach ($this->_columns as $tableName => $table) {
2487 if (array_key_exists('filters', $table)) {
2488 foreach ($table['filters'] as $fieldName => $field) {
2489 // respect pseudofield to filter spec so fields can be marked as
2490 // not to be handled here
2491 if (!empty($field['pseudofield'])) {
2492 continue;
2493 }
2494 $clause = NULL;
2495 if (CRM_Utils_Array::value('type', $field) & CRM_Utils_Type::T_DATE) {
2496 if (CRM_Utils_Array::value('operatorType', $field) ==
2497 CRM_Report_Form::OP_MONTH
2498 ) {
2499 $op = CRM_Utils_Array::value("{$fieldName}_op", $this->_params);
2500 $value = CRM_Utils_Array::value("{$fieldName}_value", $this->_params);
2501 if (is_array($value) && !empty($value)) {
2502 $clause
2503 = "(month({$field['dbAlias']}) $op (" . implode(', ', $value) .
2504 '))';
2505 }
2506 }
2507 else {
2508 $relative = CRM_Utils_Array::value("{$fieldName}_relative", $this->_params);
2509 $from = CRM_Utils_Array::value("{$fieldName}_from", $this->_params);
2510 $to = CRM_Utils_Array::value("{$fieldName}_to", $this->_params);
2511 $fromTime = CRM_Utils_Array::value("{$fieldName}_from_time", $this->_params);
2512 $toTime = CRM_Utils_Array::value("{$fieldName}_to_time", $this->_params);
2513 $clause = $this->dateClause($field['dbAlias'], $relative, $from, $to, $field['type'], $fromTime, $toTime);
2514 }
2515 }
2516 else {
2517 $op = CRM_Utils_Array::value("{$fieldName}_op", $this->_params);
2518 if ($op) {
2519 $clause = $this->whereClause($field,
2520 $op,
2521 CRM_Utils_Array::value("{$fieldName}_value", $this->_params),
2522 CRM_Utils_Array::value("{$fieldName}_min", $this->_params),
2523 CRM_Utils_Array::value("{$fieldName}_max", $this->_params)
2524 );
2525 }
2526 }
2527
2528 if (!empty($clause)) {
2529 if (!empty($field['having'])) {
2530 $this->_havingClauses[] = $clause;
2531 }
2532 else {
2533 $this->_whereClauses[] = $clause;
2534 }
2535 }
2536 }
2537 }
2538 }
2539
2540 }
2541
2542 /**
2543 * Set output mode.
2544 */
2545 public function processReportMode() {
2546 $this->setOutputMode();
2547
2548 $this->_sendmail
2549 = CRM_Utils_Request::retrieve(
2550 'sendmail',
2551 'Boolean',
2552 CRM_Core_DAO::$_nullObject
2553 );
2554
2555 $this->_absoluteUrl = FALSE;
2556 $printOnly = FALSE;
2557 $this->assign('printOnly', FALSE);
2558
2559 if ($this->_outputMode == 'print' ||
2560 ($this->_sendmail && !$this->_outputMode)
2561 ) {
2562 $this->assign('printOnly', TRUE);
2563 $printOnly = TRUE;
2564 $this->addPaging = FALSE;
2565 $this->assign('outputMode', 'print');
2566 $this->_outputMode = 'print';
2567 if ($this->_sendmail) {
2568 $this->_absoluteUrl = TRUE;
2569 }
2570 }
2571 elseif ($this->_outputMode == 'pdf') {
2572 $printOnly = TRUE;
2573 $this->addPaging = FALSE;
2574 $this->_absoluteUrl = TRUE;
2575 }
2576 elseif ($this->_outputMode == 'csv') {
2577 $printOnly = TRUE;
2578 $this->_absoluteUrl = TRUE;
2579 $this->addPaging = FALSE;
2580 }
2581 elseif ($this->_outputMode == 'group') {
2582 $this->assign('outputMode', 'group');
2583 }
2584 elseif ($this->_outputMode == 'create_report' && $this->_criteriaForm) {
2585 $this->assign('outputMode', 'create_report');
2586 }
2587 elseif ($this->_outputMode == 'copy' && $this->_criteriaForm) {
2588 $this->_createNew = TRUE;
2589 }
2590
2591 $this->assign('outputMode', $this->_outputMode);
2592 $this->assign('printOnly', $printOnly);
2593 // Get today's date to include in printed reports
2594 if ($printOnly) {
2595 $reportDate = CRM_Utils_Date::customFormat(date('Y-m-d H:i'));
2596 $this->assign('reportDate', $reportDate);
2597 }
2598 }
2599
2600 /**
2601 * Post Processing function for Form.
2602 *
2603 * postProcessCommon should be used to set other variables from input as the api accesses that function.
2604 * This function is not accessed when the api calls the report.
2605 */
2606 public function beginPostProcess() {
2607 $this->setParams($this->controller->exportValues($this->_name));
2608 if (empty($this->_params) &&
2609 $this->_force
2610 ) {
2611 $this->setParams($this->_formValues);
2612 }
2613
2614 // hack to fix params when submitted from dashboard, CRM-8532
2615 // fields array is missing because form building etc is skipped
2616 // in dashboard mode for report
2617 //@todo - this could be done in the dashboard no we have a setter
2618 if (empty($this->_params['fields']) && !$this->_noFields) {
2619 $this->setParams($this->_formValues);
2620 }
2621
2622 $this->processReportMode();
2623
2624 if ($this->_outputMode == 'save' || $this->_outputMode == 'copy') {
2625 $this->_createNew = ($this->_outputMode == 'copy');
2626 CRM_Report_Form_Instance::postProcess($this);
2627 }
2628 if ($this->_outputMode == 'delete') {
2629 CRM_Report_BAO_ReportInstance::doFormDelete($this->_id, 'civicrm/report/list?reset=1', 'civicrm/report/list?reset=1');
2630 }
2631
2632 $this->_formValues = $this->_params;
2633
2634 $this->beginPostProcessCommon();
2635 }
2636
2637 /**
2638 * BeginPostProcess function run in both report mode and non-report mode (api).
2639 */
2640 public function beginPostProcessCommon() {
2641 }
2642
2643 /**
2644 * Build the report query.
2645 *
2646 * @param bool $applyLimit
2647 *
2648 * @return string
2649 */
2650 public function buildQuery($applyLimit = TRUE) {
2651 $this->buildGroupTempTable();
2652 $this->select();
2653 $this->from();
2654 $this->customDataFrom();
2655 $this->where();
2656 if (array_key_exists('civicrm_contribution', $this->getVar('_columns'))) {
2657 $this->getPermissionedFTQuery($this);
2658 }
2659 $this->groupBy();
2660 $this->orderBy();
2661
2662 // order_by columns not selected for display need to be included in SELECT
2663 $unselectedSectionColumns = $this->unselectedSectionColumns();
2664 foreach ($unselectedSectionColumns as $alias => $section) {
2665 $this->_select .= ", {$section['dbAlias']} as {$alias}";
2666 }
2667
2668 if ($applyLimit && empty($this->_params['charts'])) {
2669 $this->limit();
2670 }
2671 CRM_Utils_Hook::alterReportVar('sql', $this, $this);
2672
2673 $sql = "{$this->_select} {$this->_from} {$this->_where} {$this->_groupBy} {$this->_having} {$this->_orderBy} {$this->_limit}";
2674 $this->addToDeveloperTab($sql);
2675 return $sql;
2676 }
2677
2678 /**
2679 * Build group by clause.
2680 */
2681 public function groupBy() {
2682 $groupBys = array();
2683 if (!empty($this->_params['group_bys']) &&
2684 is_array($this->_params['group_bys'])
2685 ) {
2686 foreach ($this->_columns as $tableName => $table) {
2687 if (array_key_exists('group_bys', $table)) {
2688 foreach ($table['group_bys'] as $fieldName => $field) {
2689 if (!empty($this->_params['group_bys'][$fieldName])) {
2690 $groupBys[] = $field['dbAlias'];
2691 }
2692 }
2693 }
2694 }
2695 }
2696
2697 if (!empty($groupBys)) {
2698 $this->_groupBy = CRM_Contact_BAO_Query::getGroupByFromSelectColumns($this->_selectClauses, $groupBys);
2699 }
2700 }
2701
2702 /**
2703 * Build order by clause.
2704 */
2705 public function orderBy() {
2706 $this->_orderBy = "";
2707 $this->_sections = array();
2708 $this->storeOrderByArray();
2709 if (!empty($this->_orderByArray) && !$this->_rollup == 'WITH ROLLUP') {
2710 $this->_orderBy = "ORDER BY " . implode(', ', $this->_orderByArray);
2711 }
2712 $this->assign('sections', $this->_sections);
2713 }
2714
2715 /**
2716 * Extract order by fields and store as an array.
2717 *
2718 * In some cases other functions want to know which fields are selected for ordering by
2719 * Separating this into a separate function allows it to be called separately from constructing
2720 * the order by clause
2721 */
2722 public function storeOrderByArray() {
2723 $orderBys = array();
2724
2725 if (!empty($this->_params['order_bys']) &&
2726 is_array($this->_params['order_bys']) &&
2727 !empty($this->_params['order_bys'])
2728 ) {
2729
2730 // Process order_bys in user-specified order
2731 foreach ($this->_params['order_bys'] as $orderBy) {
2732 $orderByField = array();
2733 foreach ($this->_columns as $tableName => $table) {
2734 if (array_key_exists('order_bys', $table)) {
2735 // For DAO columns defined in $this->_columns
2736 $fields = $table['order_bys'];
2737 }
2738 elseif (array_key_exists('extends', $table)) {
2739 // For custom fields referenced in $this->_customGroupExtends
2740 $fields = CRM_Utils_Array::value('fields', $table, array());
2741 }
2742 else {
2743 continue;
2744 }
2745 if (!empty($fields) && is_array($fields)) {
2746 foreach ($fields as $fieldName => $field) {
2747 if ($fieldName == $orderBy['column']) {
2748 $orderByField = array_merge($field, $orderBy);
2749 $orderByField['tplField'] = "{$tableName}_{$fieldName}";
2750 break 2;
2751 }
2752 }
2753 }
2754 }
2755
2756 if (!empty($orderByField)) {
2757 $this->_orderByFields[$orderByField['tplField']] = $orderByField;
2758 $orderBys[] = "{$orderByField['dbAlias']} {$orderBy['order']}";
2759
2760 // Record any section headers for assignment to the template
2761 if (!empty($orderBy['section'])) {
2762 $orderByField['pageBreak'] = CRM_Utils_Array::value('pageBreak', $orderBy);
2763 $this->_sections[$orderByField['tplField']] = $orderByField;
2764 }
2765 }
2766 }
2767 }
2768
2769 $this->_orderByArray = $orderBys;
2770
2771 $this->assign('sections', $this->_sections);
2772 }
2773
2774 /**
2775 * Determine unselected columns.
2776 *
2777 * @return array
2778 */
2779 public function unselectedSectionColumns() {
2780 if (is_array($this->_sections)) {
2781 return array_diff_key($this->_sections, $this->getSelectColumns());
2782 }
2783 else {
2784 return array();
2785 }
2786 }
2787
2788 /**
2789 * Build output rows.
2790 *
2791 * @param string $sql
2792 * @param array $rows
2793 */
2794 public function buildRows($sql, &$rows) {
2795 $dao = CRM_Core_DAO::executeQuery($sql);
2796 if (!is_array($rows)) {
2797 $rows = array();
2798 }
2799
2800 // use this method to modify $this->_columnHeaders
2801 $this->modifyColumnHeaders();
2802
2803 $unselectedSectionColumns = $this->unselectedSectionColumns();
2804
2805 while ($dao->fetch()) {
2806 $row = array();
2807 foreach ($this->_columnHeaders as $key => $value) {
2808 if (property_exists($dao, $key)) {
2809 $row[$key] = $dao->$key;
2810 }
2811 }
2812
2813 // section headers not selected for display need to be added to row
2814 foreach ($unselectedSectionColumns as $key => $values) {
2815 if (property_exists($dao, $key)) {
2816 $row[$key] = $dao->$key;
2817 }
2818 }
2819
2820 $rows[] = $row;
2821 }
2822 }
2823
2824 /**
2825 * Calculate section totals.
2826 *
2827 * When "order by" fields are marked as sections, this assigns to the template
2828 * an array of total counts for each section. This data is used by the Smarty
2829 * plugin {sectionTotal}.
2830 */
2831 public function sectionTotals() {
2832
2833 // Reports using order_bys with sections must populate $this->_selectAliases in select() method.
2834 if (empty($this->_selectAliases)) {
2835 return;
2836 }
2837
2838 if (!empty($this->_sections)) {
2839 // build the query with no LIMIT clause
2840 $select = str_ireplace('SELECT SQL_CALC_FOUND_ROWS ', 'SELECT ', $this->_select);
2841 $sql = "{$select} {$this->_from} {$this->_where} {$this->_groupBy} {$this->_having} {$this->_orderBy}";
2842
2843 // pull section aliases out of $this->_sections
2844 $sectionAliases = array_keys($this->_sections);
2845
2846 $ifnulls = array();
2847 foreach (array_merge($sectionAliases, $this->_selectAliases) as $alias) {
2848 $ifnulls[] = "ifnull($alias, '') as $alias";
2849 }
2850 $this->_select = "SELECT " . implode(", ", $ifnulls);
2851 $this->_select = CRM_Contact_BAO_Query::appendAnyValueToSelect($ifnulls, $sectionAliases);
2852
2853 // Group (un-limited) report by all aliases and get counts. This might
2854 // be done more efficiently when the contents of $sql are known, ie. by
2855 // overriding this method in the report class.
2856
2857 $query = $this->_select .
2858 ", count(*) as ct from ($sql) as subquery group by " .
2859 implode(", ", $sectionAliases);
2860
2861 // initialize array of total counts
2862 $totals = array();
2863 $dao = CRM_Core_DAO::executeQuery($query);
2864 while ($dao->fetch()) {
2865
2866 // let $this->_alterDisplay translate any integer ids to human-readable values.
2867 $rows[0] = $dao->toArray();
2868 $this->alterDisplay($rows);
2869 $row = $rows[0];
2870
2871 // add totals for all permutations of section values
2872 $values = array();
2873 $i = 1;
2874 $aliasCount = count($sectionAliases);
2875 foreach ($sectionAliases as $alias) {
2876 $values[] = $row[$alias];
2877 $key = implode(CRM_Core_DAO::VALUE_SEPARATOR, $values);
2878 if ($i == $aliasCount) {
2879 // the last alias is the lowest-level section header; use count as-is
2880 $totals[$key] = $dao->ct;
2881 }
2882 else {
2883 // other aliases are higher level; roll count into their total
2884 $totals[$key] += $dao->ct;
2885 }
2886 }
2887 }
2888 $this->assign('sectionTotals', $totals);
2889 }
2890 }
2891
2892 /**
2893 * Modify column headers.
2894 */
2895 public function modifyColumnHeaders() {
2896 // use this method to modify $this->_columnHeaders
2897 }
2898
2899 /**
2900 * Move totals columns to the right edge of the table.
2901 *
2902 * It seems like a more logical layout to have any totals columns on the far right regardless of
2903 * the location of the rest of their table.
2904 */
2905 public function moveSummaryColumnsToTheRightHandSide() {
2906 $statHeaders = (array_intersect_key($this->_columnHeaders, array_flip($this->_statFields)));
2907 $this->_columnHeaders = array_merge(array_diff_key($this->_columnHeaders, $statHeaders), $this->_columnHeaders, $statHeaders);
2908 }
2909
2910 /**
2911 * Assign rows to the template.
2912 *
2913 * @param array $rows
2914 */
2915 public function doTemplateAssignment(&$rows) {
2916 $this->assign_by_ref('columnHeaders', $this->_columnHeaders);
2917 $this->assign_by_ref('rows', $rows);
2918 $this->assign('statistics', $this->statistics($rows));
2919 }
2920
2921 /**
2922 * Build report statistics.
2923 *
2924 * Override this method to build your own statistics.
2925 *
2926 * @param array $rows
2927 *
2928 * @return array
2929 */
2930 public function statistics(&$rows) {
2931 $statistics = array();
2932
2933 $count = count($rows);
2934 // Why do we increment the count for rollup seems to artificially inflate the count.
2935 // It seems perhaps intentional to include the summary row in the count of results - although
2936 // this just seems odd.
2937 if ($this->_rollup && ($this->_rollup != '') && $this->_grandFlag) {
2938 $count++;
2939 }
2940
2941 $this->countStat($statistics, $count);
2942
2943 $this->groupByStat($statistics);
2944
2945 $this->filterStat($statistics);
2946
2947 return $statistics;
2948 }
2949
2950 /**
2951 * Add count statistics.
2952 *
2953 * @param array $statistics
2954 * @param int $count
2955 */
2956 public function countStat(&$statistics, $count) {
2957 $statistics['counts']['rowCount'] = array(
2958 'title' => ts('Row(s) Listed'),
2959 'value' => $count,
2960 );
2961
2962 if ($this->_rowsFound && ($this->_rowsFound > $count)) {
2963 $statistics['counts']['rowsFound'] = array(
2964 'title' => ts('Total Row(s)'),
2965 'value' => $this->_rowsFound,
2966 );
2967 }
2968 }
2969
2970 /**
2971 * Add group by statistics.
2972 *
2973 * @param array $statistics
2974 */
2975 public function groupByStat(&$statistics) {
2976 if (!empty($this->_params['group_bys']) &&
2977 is_array($this->_params['group_bys']) &&
2978 !empty($this->_params['group_bys'])
2979 ) {
2980 foreach ($this->_columns as $tableName => $table) {
2981 if (array_key_exists('group_bys', $table)) {
2982 foreach ($table['group_bys'] as $fieldName => $field) {
2983 if (!empty($this->_params['group_bys'][$fieldName])) {
2984 $combinations[] = $field['title'];
2985 }
2986 }
2987 }
2988 }
2989 $statistics['groups'][] = array(
2990 'title' => ts('Grouping(s)'),
2991 'value' => implode(' & ', $combinations),
2992 );
2993 }
2994 }
2995
2996 /**
2997 * Filter statistics.
2998 *
2999 * @param array $statistics
3000 */
3001 public function filterStat(&$statistics) {
3002 foreach ($this->_columns as $tableName => $table) {
3003 if (array_key_exists('filters', $table)) {
3004 foreach ($table['filters'] as $fieldName => $field) {
3005 if ((CRM_Utils_Array::value('type', $field) & CRM_Utils_Type::T_DATE ||
3006 CRM_Utils_Array::value('type', $field) & CRM_Utils_Type::T_TIME) &&
3007 CRM_Utils_Array::value('operatorType', $field) !=
3008 CRM_Report_Form::OP_MONTH
3009 ) {
3010 list($from, $to)
3011 = $this->getFromTo(
3012 CRM_Utils_Array::value("{$fieldName}_relative", $this->_params),
3013 CRM_Utils_Array::value("{$fieldName}_from", $this->_params),
3014 CRM_Utils_Array::value("{$fieldName}_to", $this->_params),
3015 CRM_Utils_Array::value("{$fieldName}_from_time", $this->_params),
3016 CRM_Utils_Array::value("{$fieldName}_to_time", $this->_params)
3017 );
3018 $from_time_format = !empty($this->_params["{$fieldName}_from_time"]) ? 'h' : 'd';
3019 $from = CRM_Utils_Date::customFormat($from, NULL, array($from_time_format));
3020
3021 $to_time_format = !empty($this->_params["{$fieldName}_to_time"]) ? 'h' : 'd';
3022 $to = CRM_Utils_Date::customFormat($to, NULL, array($to_time_format));
3023
3024 if ($from || $to) {
3025 $statistics['filters'][] = array(
3026 'title' => $field['title'],
3027 'value' => ts("Between %1 and %2", array(1 => $from, 2 => $to)),
3028 );
3029 }
3030 elseif (in_array($rel = CRM_Utils_Array::value("{$fieldName}_relative", $this->_params),
3031 array_keys($this->getOperationPair(CRM_Report_Form::OP_DATE))
3032 )) {
3033 $pair = $this->getOperationPair(CRM_Report_Form::OP_DATE);
3034 $statistics['filters'][] = array(
3035 'title' => $field['title'],
3036 'value' => $pair[$rel],
3037 );
3038 }
3039 }
3040 else {
3041 $op = CRM_Utils_Array::value("{$fieldName}_op", $this->_params);
3042 $value = NULL;
3043 if ($op) {
3044 $pair = $this->getOperationPair(
3045 CRM_Utils_Array::value('operatorType', $field),
3046 $fieldName
3047 );
3048 $min = CRM_Utils_Array::value("{$fieldName}_min", $this->_params);
3049 $max = CRM_Utils_Array::value("{$fieldName}_max", $this->_params);
3050 $val = CRM_Utils_Array::value("{$fieldName}_value", $this->_params);
3051 if (in_array($op, array('bw', 'nbw')) && ($min || $max)) {
3052 $value = "{$pair[$op]} $min " . ts('and') . " $max";
3053 }
3054 elseif ($val && CRM_Utils_Array::value('operatorType', $field) & self::OP_ENTITYREF) {
3055 $this->setEntityRefDefaults($field, $tableName);
3056 $result = civicrm_api3($field['attributes']['entity'], 'getlist',
3057 array('id' => $val) +
3058 CRM_Utils_Array::value('api', $field['attributes'], array()));
3059 $values = array();
3060 foreach ($result['values'] as $v) {
3061 $values[] = $v['label'];
3062 }
3063 $value = "{$pair[$op]} " . implode(', ', $values);
3064 }
3065 elseif ($op == 'nll' || $op == 'nnll') {
3066 $value = $pair[$op];
3067 }
3068 elseif (is_array($val) && (!empty($val))) {
3069 $options = CRM_Utils_Array::value('options', $field, array());
3070 foreach ($val as $key => $valIds) {
3071 if (isset($options[$valIds])) {
3072 $val[$key] = $options[$valIds];
3073 }
3074 }
3075 $pair[$op] = (count($val) == 1) ? (($op == 'notin' || $op ==
3076 'mnot') ? ts('Is Not') : ts('Is')) : CRM_Utils_Array::value($op, $pair);
3077 $val = implode(', ', $val);
3078 $value = "{$pair[$op]} " . $val;
3079 }
3080 elseif (!is_array($val) && (!empty($val) || $val == '0') &&
3081 isset($field['options']) &&
3082 is_array($field['options']) && !empty($field['options'])
3083 ) {
3084 $value = CRM_Utils_Array::value($op, $pair) . " " .
3085 CRM_Utils_Array::value($val, $field['options'], $val);
3086 }
3087 elseif ($val) {
3088 $value = CRM_Utils_Array::value($op, $pair) . " " . $val;
3089 }
3090 }
3091 if ($value) {
3092 $statistics['filters'][] = array(
3093 'title' => CRM_Utils_Array::value('title', $field),
3094 'value' => $value,
3095 );
3096 }
3097 }
3098 }
3099 }
3100 }
3101 }
3102
3103 /**
3104 * End post processing.
3105 *
3106 * @param array|null $rows
3107 */
3108 public function endPostProcess(&$rows = NULL) {
3109 if ($this->_storeResultSet) {
3110 $this->_resultSet = $rows;
3111 }
3112
3113 if ($this->_outputMode == 'print' ||
3114 $this->_outputMode == 'pdf' ||
3115 $this->_sendmail
3116 ) {
3117
3118 $content = $this->compileContent();
3119 $url = CRM_Utils_System::url("civicrm/report/instance/{$this->_id}",
3120 "reset=1", TRUE
3121 );
3122
3123 if ($this->_sendmail) {
3124 $config = CRM_Core_Config::singleton();
3125 $attachments = array();
3126
3127 if ($this->_outputMode == 'csv') {
3128 $content
3129 = $this->_formValues['report_header'] . '<p>' . ts('Report URL') .
3130 ": {$url}</p>" . '<p>' .
3131 ts('The report is attached as a CSV file.') . '</p>' .
3132 $this->_formValues['report_footer'];
3133
3134 $csvFullFilename = $config->templateCompileDir .
3135 CRM_Utils_File::makeFileName('CiviReport.csv');
3136 $csvContent = CRM_Report_Utils_Report::makeCsv($this, $rows);
3137 file_put_contents($csvFullFilename, $csvContent);
3138 $attachments[] = array(
3139 'fullPath' => $csvFullFilename,
3140 'mime_type' => 'text/csv',
3141 'cleanName' => 'CiviReport.csv',
3142 );
3143 }
3144 if ($this->_outputMode == 'pdf') {
3145 // generate PDF content
3146 $pdfFullFilename = $config->templateCompileDir .
3147 CRM_Utils_File::makeFileName('CiviReport.pdf');
3148 file_put_contents($pdfFullFilename,
3149 CRM_Utils_PDF_Utils::html2pdf($content, "CiviReport.pdf",
3150 TRUE, array('orientation' => 'landscape')
3151 )
3152 );
3153 // generate Email Content
3154 $content
3155 = $this->_formValues['report_header'] . '<p>' . ts('Report URL') .
3156 ": {$url}</p>" . '<p>' .
3157 ts('The report is attached as a PDF file.') . '</p>' .
3158 $this->_formValues['report_footer'];
3159
3160 $attachments[] = array(
3161 'fullPath' => $pdfFullFilename,
3162 'mime_type' => 'application/pdf',
3163 'cleanName' => 'CiviReport.pdf',
3164 );
3165 }
3166
3167 if (CRM_Report_Utils_Report::mailReport($content, $this->_id,
3168 $this->_outputMode, $attachments
3169 )
3170 ) {
3171 CRM_Core_Session::setStatus(ts("Report mail has been sent."), ts('Sent'), 'success');
3172 }
3173 else {
3174 CRM_Core_Session::setStatus(ts("Report mail could not be sent."), ts('Mail Error'), 'error');
3175 }
3176 return;
3177 }
3178 elseif ($this->_outputMode == 'print') {
3179 echo $content;
3180 }
3181 else {
3182 if ($chartType = CRM_Utils_Array::value('charts', $this->_params)) {
3183 $config = CRM_Core_Config::singleton();
3184 //get chart image name
3185 $chartImg = $this->_chartId . '.png';
3186 //get image url path
3187 $uploadUrl
3188 = str_replace('/persist/contribute/', '/persist/', $config->imageUploadURL) .
3189 'openFlashChart/';
3190 $uploadUrl .= $chartImg;
3191 //get image doc path to overwrite
3192 $uploadImg
3193 = str_replace('/persist/contribute/', '/persist/', $config->imageUploadDir) .
3194 'openFlashChart/' . $chartImg;
3195 //Load the image
3196 $chart = imagecreatefrompng($uploadUrl);
3197 //convert it into formatted png
3198 CRM_Utils_System::setHttpHeader('Content-type', 'image/png');
3199 //overwrite with same image
3200 imagepng($chart, $uploadImg);
3201 //delete the object
3202 imagedestroy($chart);
3203 }
3204 CRM_Utils_PDF_Utils::html2pdf($content, "CiviReport.pdf", FALSE, array('orientation' => 'landscape'));
3205 }
3206 CRM_Utils_System::civiExit();
3207 }
3208 elseif ($this->_outputMode == 'csv') {
3209 CRM_Report_Utils_Report::export2csv($this, $rows);
3210 }
3211 elseif ($this->_outputMode == 'group') {
3212 $group = $this->_params['groups'];
3213 $this->add2group($group);
3214 }
3215 }
3216
3217 /**
3218 * Set store result set indicator to TRUE.
3219 *
3220 * @todo explain what this does
3221 */
3222 public function storeResultSet() {
3223 $this->_storeResultSet = TRUE;
3224 }
3225
3226 /**
3227 * Get result set.
3228 *
3229 * @return bool
3230 */
3231 public function getResultSet() {
3232 return $this->_resultSet;
3233 }
3234
3235 /**
3236 * Get the sql used to generate the report.
3237 *
3238 * @return string
3239 */
3240 public function getReportSql() {
3241 return $this->sqlArray;
3242 }
3243
3244 /**
3245 * Use the form name to create the tpl file name.
3246 *
3247 * @return string
3248 */
3249 public function getTemplateFileName() {
3250 $defaultTpl = parent::getTemplateFileName();
3251 $template = CRM_Core_Smarty::singleton();
3252 if (!$template->template_exists($defaultTpl)) {
3253 $defaultTpl = 'CRM/Report/Form.tpl';
3254 }
3255 return $defaultTpl;
3256 }
3257
3258 /**
3259 * Compile the report content.
3260 *
3261 * Although this function is super-short it is useful to keep separate so it can be over-ridden by report classes.
3262 *
3263 * @return string
3264 */
3265 public function compileContent() {
3266 $templateFile = $this->getHookedTemplateFileName();
3267 return CRM_Utils_Array::value('report_header', $this->_formValues) .
3268 CRM_Core_Form::$_template->fetch($templateFile) .
3269 CRM_Utils_Array::value('report_footer', $this->_formValues);
3270 }
3271
3272
3273 /**
3274 * Post process function.
3275 */
3276 public function postProcess() {
3277 // get ready with post process params
3278 $this->beginPostProcess();
3279
3280 // build query
3281 $sql = $this->buildQuery();
3282
3283 // build array of result based on column headers. This method also allows
3284 // modifying column headers before using it to build result set i.e $rows.
3285 $rows = array();
3286 $this->buildRows($sql, $rows);
3287
3288 // format result set.
3289 $this->formatDisplay($rows);
3290
3291 // assign variables to templates
3292 $this->doTemplateAssignment($rows);
3293
3294 // do print / pdf / instance stuff if needed
3295 $this->endPostProcess($rows);
3296 }
3297
3298 /**
3299 * Set limit.
3300 *
3301 * @param int $rowCount
3302 *
3303 * @return array
3304 */
3305 public function limit($rowCount = self::ROW_COUNT_LIMIT) {
3306 // lets do the pager if in html mode
3307 $this->_limit = NULL;
3308
3309 // CRM-14115, over-ride row count if rowCount is specified in URL
3310 if ($this->_dashBoardRowCount) {
3311 $rowCount = $this->_dashBoardRowCount;
3312 }
3313 if ($this->addPaging) {
3314 $this->_select = str_ireplace('SELECT ', 'SELECT SQL_CALC_FOUND_ROWS ', $this->_select);
3315
3316 $pageId = CRM_Utils_Request::retrieve('crmPID', 'Integer', CRM_Core_DAO::$_nullObject);
3317
3318 // @todo all http vars should be extracted in the preProcess
3319 // - not randomly in the class
3320 if (!$pageId && !empty($_POST)) {
3321 if (isset($_POST['PagerBottomButton']) && isset($_POST['crmPID_B'])) {
3322 $pageId = max((int) $_POST['crmPID_B'], 1);
3323 }
3324 elseif (isset($_POST['PagerTopButton']) && isset($_POST['crmPID'])) {
3325 $pageId = max((int) $_POST['crmPID'], 1);
3326 }
3327 unset($_POST['crmPID_B'], $_POST['crmPID']);
3328 }
3329
3330 $pageId = $pageId ? $pageId : 1;
3331 $this->set(CRM_Utils_Pager::PAGE_ID, $pageId);
3332 $offset = ($pageId - 1) * $rowCount;
3333
3334 $offset = CRM_Utils_Type::escape($offset, 'Int');
3335 $rowCount = CRM_Utils_Type::escape($rowCount, 'Int');
3336
3337 $this->_limit = " LIMIT $offset, $rowCount";
3338 return array($offset, $rowCount);
3339 }
3340 if ($this->_limitValue) {
3341 if ($this->_offsetValue) {
3342 $this->_limit = " LIMIT {$this->_offsetValue}, {$this->_limitValue} ";
3343 }
3344 else {
3345 $this->_limit = " LIMIT " . $this->_limitValue;
3346 }
3347 }
3348 }
3349
3350 /**
3351 * Set pager.
3352 *
3353 * @param int $rowCount
3354 */
3355 public function setPager($rowCount = self::ROW_COUNT_LIMIT) {
3356 // CRM-14115, over-ride row count if rowCount is specified in URL
3357 if ($this->_dashBoardRowCount) {
3358 $rowCount = $this->_dashBoardRowCount;
3359 }
3360
3361 if ($this->_limit && ($this->_limit != '')) {
3362 if (!$this->_rowsFound) {
3363 $sql = "SELECT FOUND_ROWS();";
3364 $this->_rowsFound = CRM_Core_DAO::singleValueQuery($sql);
3365 }
3366 $params = array(
3367 'total' => $this->_rowsFound,
3368 'rowCount' => $rowCount,
3369 'status' => ts('Records') . ' %%StatusMessage%%',
3370 'buttonBottom' => 'PagerBottomButton',
3371 'buttonTop' => 'PagerTopButton',
3372 );
3373 if (!empty($this->controller)) {
3374 // This happens when being called from the api Really we want the api to be able to
3375 // pass paging parameters, but at this stage just preventing test crashes.
3376 $params['pageID'] = $this->get(CRM_Utils_Pager::PAGE_ID);
3377 }
3378
3379 $pager = new CRM_Utils_Pager($params);
3380 $this->assign_by_ref('pager', $pager);
3381 $this->ajaxResponse['totalRows'] = $this->_rowsFound;
3382 }
3383 }
3384
3385 /**
3386 * Build a group filter with contempt for large data sets.
3387 *
3388 * This function has been retained as it takes time to migrate the reports over
3389 * to the new method which will not crash on large datasets.
3390 *
3391 * @deprecated
3392 *
3393 * @param string $field
3394 * @param mixed $value
3395 * @param string $op
3396 *
3397 * @return string
3398 */
3399 public function legacySlowGroupFilterClause($field, $value, $op) {
3400 $smartGroupQuery = "";
3401
3402 $group = new CRM_Contact_DAO_Group();
3403 $group->is_active = 1;
3404 $group->find();
3405 $smartGroups = array();
3406 while ($group->fetch()) {
3407 if (in_array($group->id, $this->_params['gid_value']) &&
3408 $group->saved_search_id
3409 ) {
3410 $smartGroups[] = $group->id;
3411 }
3412 }
3413
3414 CRM_Contact_BAO_GroupContactCache::check($smartGroups);
3415
3416 $smartGroupQuery = '';
3417 if (!empty($smartGroups)) {
3418 $smartGroups = implode(',', $smartGroups);
3419 $smartGroupQuery = " UNION DISTINCT
3420 SELECT DISTINCT smartgroup_contact.contact_id
3421 FROM civicrm_group_contact_cache smartgroup_contact
3422 WHERE smartgroup_contact.group_id IN ({$smartGroups}) ";
3423 }
3424
3425 $sqlOp = $this->getSQLOperator($op);
3426 if (!is_array($value)) {
3427 $value = array($value);
3428 }
3429 $clause = "{$field['dbAlias']} IN (" . implode(', ', $value) . ")";
3430
3431 $contactAlias = $this->_aliases['civicrm_contact'];
3432 if (!empty($this->relationType) && $this->relationType == 'b_a') {
3433 $contactAlias = $this->_aliases['civicrm_contact_b'];
3434 }
3435 return " {$contactAlias}.id {$sqlOp} (
3436 SELECT DISTINCT {$this->_aliases['civicrm_group']}.contact_id
3437 FROM civicrm_group_contact {$this->_aliases['civicrm_group']}
3438 WHERE {$clause} AND {$this->_aliases['civicrm_group']}.status = 'Added'
3439 {$smartGroupQuery} ) ";
3440 }
3441
3442 /**
3443 * Build where clause for groups.
3444 *
3445 * @param string $field
3446 * @param mixed $value
3447 * @param string $op
3448 *
3449 * @return string
3450 */
3451 public function whereGroupClause($field, $value, $op) {
3452 if ($this->groupFilterNotOptimised) {
3453 return $this->legacySlowGroupFilterClause($field, $value, $op);
3454 }
3455 if ($op === 'notin') {
3456 return " group_temp_table.id IS NULL ";
3457 }
3458 // We will have used an inner join instead.
3459 return "1";
3460 }
3461
3462
3463 /**
3464 * Create a table of the contact ids included by the group filter.
3465 *
3466 * This function is called by both the api (tests) and the UI.
3467 */
3468 public function buildGroupTempTable() {
3469 if (!empty($this->groupTempTable) || empty ($this->_params['gid_value']) || $this->groupFilterNotOptimised) {
3470 return;
3471 }
3472 $filteredGroups = (array) $this->_params['gid_value'];
3473
3474 $groups = civicrm_api3('Group', 'get', array(
3475 'is_active' => 1,
3476 'id' => array('IN' => $filteredGroups),
3477 'saved_search_id' => array('>' => 0),
3478 'return' => 'id',
3479 ));
3480 $smartGroups = array_keys($groups['values']);
3481
3482 $query = "
3483 SELECT group_contact.contact_id as id
3484 FROM civicrm_group_contact group_contact
3485 WHERE group_contact.group_id IN (" . implode(', ', $filteredGroups) . ")
3486 AND group_contact.status = 'Added' ";
3487
3488 if (!empty($smartGroups)) {
3489 CRM_Contact_BAO_GroupContactCache::check($smartGroups);
3490 $smartGroups = implode(',', $smartGroups);
3491 $query .= "
3492 UNION DISTINCT
3493 SELECT smartgroup_contact.contact_id as id
3494 FROM civicrm_group_contact_cache smartgroup_contact
3495 WHERE smartgroup_contact.group_id IN ({$smartGroups}) ";
3496 }
3497
3498 $this->groupTempTable = 'civicrm_report_temp_group_' . date('Ymd_') . uniqid();
3499 $this->executeReportQuery("
3500 CREATE TEMPORARY TABLE $this->groupTempTable
3501 $query
3502 ");
3503 CRM_Core_DAO::executeQuery("ALTER TABLE $this->groupTempTable ADD INDEX i_id(id)");
3504 }
3505
3506 /**
3507 * Execute query and add it to the developer tab.
3508 *
3509 * @param string $query
3510 * @param array $params
3511 *
3512 * @return \CRM_Core_DAO|object
3513 */
3514 protected function executeReportQuery($query, $params = array()) {
3515 $this->addToDeveloperTab($query);
3516 return CRM_Core_DAO::executeQuery($query, $params);
3517 }
3518
3519 /**
3520 * Build where clause for tags.
3521 *
3522 * @param string $field
3523 * @param mixed $value
3524 * @param string $op
3525 *
3526 * @return string
3527 */
3528 public function whereTagClause($field, $value, $op) {
3529 // not using left join in query because if any contact
3530 // belongs to more than one tag, results duplicate
3531 // entries.
3532 $sqlOp = $this->getSQLOperator($op);
3533 if (!is_array($value)) {
3534 $value = array($value);
3535 }
3536 $clause = "{$field['dbAlias']} IN (" . implode(', ', $value) . ")";
3537 $entity_table = $this->_tagFilterTable;
3538 return " {$this->_aliases[$entity_table]}.id {$sqlOp} (
3539 SELECT DISTINCT {$this->_aliases['civicrm_tag']}.entity_id
3540 FROM civicrm_entity_tag {$this->_aliases['civicrm_tag']}
3541 WHERE entity_table = '$entity_table' AND {$clause} ) ";
3542 }
3543
3544 /**
3545 * Generate membership organization clause.
3546 *
3547 * @param mixed $value
3548 * @param string $op SQL Operator
3549 *
3550 * @return string
3551 */
3552 public function whereMembershipOrgClause($value, $op) {
3553 $sqlOp = $this->getSQLOperator($op);
3554 if (!is_array($value)) {
3555 $value = array($value);
3556 }
3557
3558 $tmp_membership_org_sql_list = implode(', ', $value);
3559 return " {$this->_aliases['civicrm_contact']}.id {$sqlOp} (
3560 SELECT DISTINCT mem.contact_id
3561 FROM civicrm_membership mem
3562 LEFT JOIN civicrm_membership_status mem_status ON mem.status_id = mem_status.id
3563 LEFT JOIN civicrm_membership_type mt ON mem.membership_type_id = mt.id
3564 WHERE mt.member_of_contact_id IN (" .
3565 $tmp_membership_org_sql_list . ")
3566 AND mt.is_active = '1'
3567 AND mem_status.is_current_member = '1'
3568 AND mem_status.is_active = '1' ) ";
3569 }
3570
3571 /**
3572 * Generate Membership Type SQL Clause.
3573 *
3574 * @param mixed $value
3575 * @param string $op
3576 *
3577 * @return string
3578 * SQL query string
3579 */
3580 public function whereMembershipTypeClause($value, $op) {
3581 $sqlOp = $this->getSQLOperator($op);
3582 if (!is_array($value)) {
3583 $value = array($value);
3584 }
3585
3586 $tmp_membership_sql_list = implode(', ', $value);
3587 return " {$this->_aliases['civicrm_contact']}.id {$sqlOp} (
3588 SELECT DISTINCT mem.contact_id
3589 FROM civicrm_membership mem
3590 LEFT JOIN civicrm_membership_status mem_status ON mem.status_id = mem_status.id
3591 LEFT JOIN civicrm_membership_type mt ON mem.membership_type_id = mt.id
3592 WHERE mem.membership_type_id IN (" .
3593 $tmp_membership_sql_list . ")
3594 AND mt.is_active = '1'
3595 AND mem_status.is_current_member = '1'
3596 AND mem_status.is_active = '1' ) ";
3597 }
3598
3599 /**
3600 * Build acl clauses.
3601 *
3602 * @param string $tableAlias
3603 */
3604 public function buildACLClause($tableAlias = 'contact_a') {
3605 list($this->_aclFrom, $this->_aclWhere) = CRM_Contact_BAO_Contact_Permission::cacheClause($tableAlias);
3606 }
3607
3608 /**
3609 * Add custom data to the columns.
3610 *
3611 * @param bool $addFields
3612 * @param array $permCustomGroupIds
3613 */
3614 public function addCustomDataToColumns($addFields = TRUE, $permCustomGroupIds = array()) {
3615 if (empty($this->_customGroupExtends)) {
3616 return;
3617 }
3618 if (!is_array($this->_customGroupExtends)) {
3619 $this->_customGroupExtends = array($this->_customGroupExtends);
3620 }
3621 $customGroupWhere = '';
3622 if (!empty($permCustomGroupIds)) {
3623 $customGroupWhere = "cg.id IN (" . implode(',', $permCustomGroupIds) .
3624 ") AND";
3625 }
3626 $sql = "
3627 SELECT cg.table_name, cg.title, cg.extends, cf.id as cf_id, cf.label,
3628 cf.column_name, cf.data_type, cf.html_type, cf.option_group_id, cf.time_format
3629 FROM civicrm_custom_group cg
3630 INNER JOIN civicrm_custom_field cf ON cg.id = cf.custom_group_id
3631 WHERE cg.extends IN ('" . implode("','", $this->_customGroupExtends) . "') AND
3632 {$customGroupWhere}
3633 cg.is_active = 1 AND
3634 cf.is_active = 1 AND
3635 cf.is_searchable = 1
3636 ORDER BY cg.weight, cf.weight";
3637 $customDAO = CRM_Core_DAO::executeQuery($sql);
3638
3639 $curTable = NULL;
3640 while ($customDAO->fetch()) {
3641 if ($customDAO->table_name != $curTable) {
3642 $curTable = $customDAO->table_name;
3643 $curFields = $curFilters = array();
3644
3645 // dummy dao object
3646 $this->_columns[$curTable]['dao'] = 'CRM_Contact_DAO_Contact';
3647 $this->_columns[$curTable]['extends'] = $customDAO->extends;
3648 $this->_columns[$curTable]['grouping'] = $customDAO->table_name;
3649 $this->_columns[$curTable]['group_title'] = $customDAO->title;
3650
3651 foreach (array('fields', 'filters', 'group_bys') as $colKey) {
3652 if (!array_key_exists($colKey, $this->_columns[$curTable])) {
3653 $this->_columns[$curTable][$colKey] = array();
3654 }
3655 }
3656 }
3657 $fieldName = 'custom_' . $customDAO->cf_id;
3658
3659 if ($addFields) {
3660 // this makes aliasing work in favor
3661 $curFields[$fieldName] = array(
3662 'name' => $customDAO->column_name,
3663 'title' => $customDAO->label,
3664 'dataType' => $customDAO->data_type,
3665 'htmlType' => $customDAO->html_type,
3666 );
3667 }
3668 if ($this->_customGroupFilters) {
3669 // this makes aliasing work in favor
3670 $curFilters[$fieldName] = array(
3671 'name' => $customDAO->column_name,
3672 'title' => $customDAO->label,
3673 'dataType' => $customDAO->data_type,
3674 'htmlType' => $customDAO->html_type,
3675 );
3676 }
3677
3678 switch ($customDAO->data_type) {
3679 case 'Date':
3680 // filters
3681 $curFilters[$fieldName]['operatorType'] = CRM_Report_Form::OP_DATE;
3682 $curFilters[$fieldName]['type'] = CRM_Utils_Type::T_DATE;
3683 // CRM-6946, show time part for datetime date fields
3684 if ($customDAO->time_format) {
3685 $curFields[$fieldName]['type'] = CRM_Utils_Type::T_TIMESTAMP;
3686 }
3687 break;
3688
3689 case 'Boolean':
3690 $curFilters[$fieldName]['operatorType'] = CRM_Report_Form::OP_SELECT;
3691 $curFilters[$fieldName]['options'] = array('' => ts('- select -')) + CRM_Core_PseudoConstant::get('CRM_Core_BAO_CustomField', 'custom_' . $customDAO->cf_id, array(), 'search');
3692 $curFilters[$fieldName]['type'] = CRM_Utils_Type::T_INT;
3693 break;
3694
3695 case 'Int':
3696 $curFilters[$fieldName]['operatorType'] = CRM_Report_Form::OP_INT;
3697 $curFilters[$fieldName]['type'] = CRM_Utils_Type::T_INT;
3698 break;
3699
3700 case 'Money':
3701 $curFilters[$fieldName]['operatorType'] = CRM_Report_Form::OP_FLOAT;
3702 $curFilters[$fieldName]['type'] = CRM_Utils_Type::T_MONEY;
3703 $curFields[$fieldName]['type'] = CRM_Utils_Type::T_MONEY;
3704 break;
3705
3706 case 'Float':
3707 $curFilters[$fieldName]['operatorType'] = CRM_Report_Form::OP_FLOAT;
3708 $curFilters[$fieldName]['type'] = CRM_Utils_Type::T_FLOAT;
3709 break;
3710
3711 case 'String':
3712 case 'StateProvince':
3713 case 'Country':
3714 $curFilters[$fieldName]['type'] = CRM_Utils_Type::T_STRING;
3715
3716 $options = CRM_Core_PseudoConstant::get('CRM_Core_BAO_CustomField', 'custom_' . $customDAO->cf_id, array(), 'search');
3717 if ($options !== FALSE) {
3718 $curFilters[$fieldName]['operatorType'] = CRM_Core_BAO_CustomField::isSerialized($customDAO) ? CRM_Report_Form::OP_MULTISELECT_SEPARATOR : CRM_Report_Form::OP_MULTISELECT;
3719 $curFilters[$fieldName]['options'] = $options;
3720 }
3721 break;
3722
3723 case 'ContactReference':
3724 $curFilters[$fieldName]['type'] = CRM_Utils_Type::T_STRING;
3725 $curFilters[$fieldName]['name'] = 'display_name';
3726 $curFilters[$fieldName]['alias'] = "contact_{$fieldName}_civireport";
3727
3728 $curFields[$fieldName]['type'] = CRM_Utils_Type::T_STRING;
3729 $curFields[$fieldName]['name'] = 'display_name';
3730 $curFields[$fieldName]['alias'] = "contact_{$fieldName}_civireport";
3731 break;
3732
3733 default:
3734 $curFields[$fieldName]['type'] = CRM_Utils_Type::T_STRING;
3735 $curFilters[$fieldName]['type'] = CRM_Utils_Type::T_STRING;
3736 }
3737
3738 if (!array_key_exists('type', $curFields[$fieldName])) {
3739 $curFields[$fieldName]['type'] = CRM_Utils_Array::value('type', $curFilters[$fieldName], array());
3740 }
3741
3742 if ($addFields) {
3743 $this->_columns[$curTable]['fields'] = array_merge($this->_columns[$curTable]['fields'], $curFields);
3744 }
3745 if ($this->_customGroupFilters) {
3746 $this->_columns[$curTable]['filters'] = array_merge($this->_columns[$curTable]['filters'], $curFilters);
3747 }
3748 if ($this->_customGroupGroupBy) {
3749 $this->_columns[$curTable]['group_bys'] = array_merge($this->_columns[$curTable]['group_bys'], $curFields);
3750 }
3751 }
3752 }
3753
3754 /**
3755 * Build custom data from clause.
3756 *
3757 * @param bool $joinsForFiltersOnly
3758 * Only include joins to support filters. This would be used if creating a table of contacts to include first.
3759 */
3760 public function customDataFrom($joinsForFiltersOnly = FALSE) {
3761 if (empty($this->_customGroupExtends)) {
3762 return;
3763 }
3764 $mapper = CRM_Core_BAO_CustomQuery::$extendsMap;
3765 //CRM-18276 GROUP_CONCAT could be used with singleValueQuery and then exploded,
3766 //but by default that truncates to 1024 characters, which causes errors with installs with lots of custom field sets
3767 $customTables = array();
3768 $customTablesDAO = CRM_Core_DAO::executeQuery("SELECT table_name FROM civicrm_custom_group");
3769 while ($customTablesDAO->fetch()) {
3770 $customTables[] = $customTablesDAO->table_name;
3771 }
3772
3773 foreach ($this->_columns as $table => $prop) {
3774 if (in_array($table, $customTables)) {
3775 $extendsTable = $mapper[$prop['extends']];
3776 // Check field is required for rendering the report.
3777 if ((!$this->isFieldSelected($prop)) || ($joinsForFiltersOnly && !$this->isFieldFiltered($prop))) {
3778 continue;
3779 }
3780 $baseJoin = CRM_Utils_Array::value($prop['extends'], $this->_customGroupExtendsJoin, "{$this->_aliases[$extendsTable]}.id");
3781
3782 $customJoin = is_array($this->_customGroupJoin) ? $this->_customGroupJoin[$table] : $this->_customGroupJoin;
3783 $this->_from .= "
3784 {$customJoin} {$table} {$this->_aliases[$table]} ON {$this->_aliases[$table]}.entity_id = {$baseJoin}";
3785 // handle for ContactReference
3786 if (array_key_exists('fields', $prop)) {
3787 foreach ($prop['fields'] as $fieldName => $field) {
3788 if (CRM_Utils_Array::value('dataType', $field) ==
3789 'ContactReference'
3790 ) {
3791 $columnName = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_CustomField', CRM_Core_BAO_CustomField::getKeyID($fieldName), 'column_name');
3792 $this->_from .= "
3793 LEFT JOIN civicrm_contact {$field['alias']} ON {$field['alias']}.id = {$this->_aliases[$table]}.{$columnName} ";
3794 }
3795 }
3796 }
3797 }
3798 }
3799 }
3800
3801 /**
3802 * Check if the field is selected.
3803 *
3804 * @param string $prop
3805 *
3806 * @return bool
3807 */
3808 public function isFieldSelected($prop) {
3809 if (empty($prop)) {
3810 return FALSE;
3811 }
3812
3813 if (!empty($this->_params['fields'])) {
3814 foreach (array_keys($prop['fields']) as $fieldAlias) {
3815 $customFieldId = CRM_Core_BAO_CustomField::getKeyID($fieldAlias);
3816 if ($customFieldId) {
3817 if (array_key_exists($fieldAlias, $this->_params['fields'])) {
3818 return TRUE;
3819 }
3820
3821 //might be survey response field.
3822 if (!empty($this->_params['fields']['survey_response']) &&
3823 !empty($prop['fields'][$fieldAlias]['isSurveyResponseField'])
3824 ) {
3825 return TRUE;
3826 }
3827 }
3828 }
3829 }
3830
3831 if (!empty($this->_params['group_bys']) && $this->_customGroupGroupBy) {
3832 foreach (array_keys($prop['group_bys']) as $fieldAlias) {
3833 if (array_key_exists($fieldAlias, $this->_params['group_bys']) &&
3834 CRM_Core_BAO_CustomField::getKeyID($fieldAlias)
3835 ) {
3836 return TRUE;
3837 }
3838 }
3839 }
3840
3841 if (!empty($this->_params['order_bys'])) {
3842 foreach (array_keys($prop['fields']) as $fieldAlias) {
3843 foreach ($this->_params['order_bys'] as $orderBy) {
3844 if ($fieldAlias == $orderBy['column'] &&
3845 CRM_Core_BAO_CustomField::getKeyID($fieldAlias)
3846 ) {
3847 return TRUE;
3848 }
3849 }
3850 }
3851 }
3852 return $this->isFieldFiltered($prop);
3853
3854 }
3855
3856 /**
3857 * Check if the field is used as a filter.
3858 *
3859 * @param string $prop
3860 *
3861 * @return bool
3862 */
3863 protected function isFieldFiltered($prop) {
3864 if (!empty($prop['filters']) && $this->_customGroupFilters) {
3865 foreach ($prop['filters'] as $fieldAlias => $val) {
3866 foreach (array(
3867 'value',
3868 'min',
3869 'max',
3870 'relative',
3871 'from',
3872 'to',
3873 ) as $attach) {
3874 if (isset($this->_params[$fieldAlias . '_' . $attach]) &&
3875 (!empty($this->_params[$fieldAlias . '_' . $attach])
3876 || ($attach != 'relative' &&
3877 $this->_params[$fieldAlias . '_' . $attach] == '0')
3878 )
3879 ) {
3880 return TRUE;
3881 }
3882 }
3883 if (!empty($this->_params[$fieldAlias . '_op']) &&
3884 in_array($this->_params[$fieldAlias . '_op'], array('nll', 'nnll'))
3885 ) {
3886 return TRUE;
3887 }
3888 }
3889 }
3890
3891 return FALSE;
3892 }
3893
3894 /**
3895 * Check for empty order_by configurations and remove them.
3896 *
3897 * Also set template to hide them.
3898 *
3899 * @param array $formValues
3900 */
3901 public function preProcessOrderBy(&$formValues) {
3902 // Object to show/hide form elements
3903 $_showHide = new CRM_Core_ShowHideBlocks('', '');
3904
3905 $_showHide->addShow('optionField_1');
3906
3907 // Cycle through order_by options; skip any empty ones, and hide them as well
3908 $n = 1;
3909
3910 if (!empty($formValues['order_bys'])) {
3911 foreach ($formValues['order_bys'] as $order_by) {
3912 if ($order_by['column'] && $order_by['column'] != '-') {
3913 $_showHide->addShow('optionField_' . $n);
3914 $orderBys[$n] = $order_by;
3915 $n++;
3916 }
3917 }
3918 }
3919 for ($i = $n; $i <= 5; $i++) {
3920 if ($i > 1) {
3921 $_showHide->addHide('optionField_' . $i);
3922 }
3923 }
3924
3925 // overwrite order_by options with modified values
3926 if (!empty($orderBys)) {
3927 $formValues['order_bys'] = $orderBys;
3928 }
3929 else {
3930 $formValues['order_bys'] = array(1 => array('column' => '-'));
3931 }
3932
3933 // assign show/hide data to template
3934 $_showHide->addToTemplate();
3935 }
3936
3937 /**
3938 * Check if table name has columns in SELECT clause.
3939 *
3940 * @param string $tableName
3941 * Name of table (index of $this->_columns array).
3942 *
3943 * @return bool
3944 */
3945 public function isTableSelected($tableName) {
3946 return in_array($tableName, $this->selectedTables());
3947 }
3948
3949 /**
3950 * Check if table name has columns in WHERE or HAVING clause.
3951 *
3952 * @param string $tableName
3953 * Name of table (index of $this->_columns array).
3954 *
3955 * @return bool
3956 */
3957 public function isTableFiltered($tableName) {
3958 // Cause the array to be generated if not previously done.
3959 if (!$this->_selectedTables && !$this->filteredTables) {
3960 $this->selectedTables();
3961 }
3962 return in_array($tableName, $this->filteredTables);
3963 }
3964
3965 /**
3966 * Fetch array of DAO tables having columns included in SELECT or ORDER BY clause.
3967 *
3968 * If the array is unset it will be built.
3969 *
3970 * @return array
3971 * selectedTables
3972 */
3973 public function selectedTables() {
3974 if (!$this->_selectedTables) {
3975 $orderByColumns = array();
3976 if (array_key_exists('order_bys', $this->_params) &&
3977 is_array($this->_params['order_bys'])
3978 ) {
3979 foreach ($this->_params['order_bys'] as $orderBy) {
3980 $orderByColumns[] = $orderBy['column'];
3981 }
3982 }
3983
3984 foreach ($this->_columns as $tableName => $table) {
3985 if (array_key_exists('fields', $table)) {
3986 foreach ($table['fields'] as $fieldName => $field) {
3987 if (!empty($field['required']) ||
3988 !empty($this->_params['fields'][$fieldName])
3989 ) {
3990 $this->_selectedTables[] = $tableName;
3991 break;
3992 }
3993 }
3994 }
3995 if (array_key_exists('order_bys', $table)) {
3996 foreach ($table['order_bys'] as $orderByName => $orderBy) {
3997 if (in_array($orderByName, $orderByColumns)) {
3998 $this->_selectedTables[] = $tableName;
3999 break;
4000 }
4001 }
4002 }
4003 if (array_key_exists('filters', $table)) {
4004 foreach ($table['filters'] as $filterName => $filter) {
4005 if (!empty($this->_params["{$filterName}_value"]) ||
4006 CRM_Utils_Array::value("{$filterName}_op", $this->_params) ==
4007 'nll' ||
4008 CRM_Utils_Array::value("{$filterName}_op", $this->_params) ==
4009 'nnll'
4010 ) {
4011 $this->_selectedTables[] = $tableName;
4012 $this->filteredTables[] = $tableName;
4013 break;
4014 }
4015 }
4016 }
4017 }
4018 }
4019 return $this->_selectedTables;
4020 }
4021
4022 /**
4023 * Add address fields.
4024 *
4025 * @deprecated - use getAddressColumns which is a more accurate description
4026 * and also accepts an array of options rather than a long list
4027 *
4028 * adding address fields to construct function in reports
4029 *
4030 * @param bool $groupBy
4031 * Add GroupBy? Not appropriate for detail report.
4032 * @param bool $orderBy
4033 * Add GroupBy? Not appropriate for detail report.
4034 * @param bool $filters
4035 * @param array $defaults
4036 *
4037 * @return array
4038 * address fields for construct clause
4039 */
4040 public function addAddressFields($groupBy = TRUE, $orderBy = FALSE, $filters = TRUE, $defaults = array('country_id' => TRUE)) {
4041 $addressFields = array(
4042 'civicrm_address' => array(
4043 'dao' => 'CRM_Core_DAO_Address',
4044 'fields' => array(
4045 'address_name' => array(
4046 'title' => ts('Address Name'),
4047 'default' => CRM_Utils_Array::value('name', $defaults, FALSE),
4048 'name' => 'name',
4049 ),
4050 'street_address' => array(
4051 'title' => ts('Street Address'),
4052 'default' => CRM_Utils_Array::value('street_address', $defaults, FALSE),
4053 ),
4054 'supplemental_address_1' => array(
4055 'title' => ts('Supplementary Address Field 1'),
4056 'default' => CRM_Utils_Array::value('supplemental_address_1', $defaults, FALSE),
4057 ),
4058 'supplemental_address_2' => array(
4059 'title' => ts('Supplementary Address Field 2'),
4060 'default' => CRM_Utils_Array::value('supplemental_address_2', $defaults, FALSE),
4061 ),
4062 'street_number' => array(
4063 'name' => 'street_number',
4064 'title' => ts('Street Number'),
4065 'type' => 1,
4066 'default' => CRM_Utils_Array::value('street_number', $defaults, FALSE),
4067 ),
4068 'street_name' => array(
4069 'name' => 'street_name',
4070 'title' => ts('Street Name'),
4071 'type' => 1,
4072 'default' => CRM_Utils_Array::value('street_name', $defaults, FALSE),
4073 ),
4074 'street_unit' => array(
4075 'name' => 'street_unit',
4076 'title' => ts('Street Unit'),
4077 'type' => 1,
4078 'default' => CRM_Utils_Array::value('street_unit', $defaults, FALSE),
4079 ),
4080 'city' => array(
4081 'title' => ts('City'),
4082 'default' => CRM_Utils_Array::value('city', $defaults, FALSE),
4083 ),
4084 'postal_code' => array(
4085 'title' => ts('Postal Code'),
4086 'default' => CRM_Utils_Array::value('postal_code', $defaults, FALSE),
4087 ),
4088 'postal_code_suffix' => array(
4089 'title' => ts('Postal Code Suffix'),
4090 'default' => CRM_Utils_Array::value('postal_code_suffix', $defaults, FALSE),
4091 ),
4092 'country_id' => array(
4093 'title' => ts('Country'),
4094 'default' => CRM_Utils_Array::value('country_id', $defaults, FALSE),
4095 ),
4096 'state_province_id' => array(
4097 'title' => ts('State/Province'),
4098 'default' => CRM_Utils_Array::value('state_province_id', $defaults, FALSE),
4099 ),
4100 'county_id' => array(
4101 'title' => ts('County'),
4102 'default' => CRM_Utils_Array::value('county_id', $defaults, FALSE),
4103 ),
4104 ),
4105 'grouping' => 'location-fields',
4106 ),
4107 );
4108
4109 if ($filters) {
4110 // Address filter depends on whether street address parsing is enabled.
4111 // (CRM-18696)
4112 $addressOptions = CRM_Core_BAO_Setting::valueOptions(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
4113 'address_options'
4114 );
4115 if ($addressOptions['street_address_parsing']) {
4116 $street_address_filters = array(
4117 'street_number' => array(
4118 'title' => ts('Street Number'),
4119 'type' => 1,
4120 'name' => 'street_number',
4121 ),
4122 'street_name' => array(
4123 'title' => ts('Street Name'),
4124 'name' => 'street_name',
4125 'operator' => 'like',
4126 ),
4127 );
4128 }
4129 else {
4130 $street_address_filters = array(
4131 'street_address' => array(
4132 'title' => ts('Street Address'),
4133 'operator' => 'like',
4134 'name' => 'street_address',
4135 ),
4136 );
4137 }
4138 $general_address_filters = array(
4139 'postal_code' => array(
4140 'title' => ts('Postal Code'),
4141 'type' => 1,
4142 'name' => 'postal_code',
4143 ),
4144 'city' => array(
4145 'title' => ts('City'),
4146 'operator' => 'like',
4147 'name' => 'city',
4148 ),
4149 'country_id' => array(
4150 'name' => 'country_id',
4151 'title' => ts('Country'),
4152 'type' => CRM_Utils_Type::T_INT,
4153 'operatorType' => CRM_Report_Form::OP_MULTISELECT,
4154 'options' => CRM_Core_PseudoConstant::country(),
4155 ),
4156 'state_province_id' => array(
4157 'name' => 'state_province_id',
4158 'title' => ts('State/Province'),
4159 'type' => CRM_Utils_Type::T_INT,
4160 'operatorType' => CRM_Report_Form::OP_MULTISELECT,
4161 'options' => array(),
4162 ),
4163 'county_id' => array(
4164 'name' => 'county_id',
4165 'title' => ts('County'),
4166 'type' => CRM_Utils_Type::T_INT,
4167 'operatorType' => CRM_Report_Form::OP_MULTISELECT,
4168 'options' => array(),
4169 ),
4170 );
4171 }
4172 $addressFields['civicrm_address']['filters'] = array_merge(
4173 $street_address_filters,
4174 $general_address_filters);
4175
4176 if ($orderBy) {
4177 $addressFields['civicrm_address']['order_bys'] = array(
4178 'street_name' => array('title' => ts('Street Name')),
4179 'street_number' => array('title' => ts('Odd / Even Street Number')),
4180 'street_address' => NULL,
4181 'city' => NULL,
4182 'postal_code' => NULL,
4183 );
4184 }
4185
4186 if ($groupBy) {
4187 $addressFields['civicrm_address']['group_bys'] = array(
4188 'street_address' => NULL,
4189 'city' => NULL,
4190 'postal_code' => NULL,
4191 'state_province_id' => array(
4192 'title' => ts('State/Province'),
4193 ),
4194 'country_id' => array(
4195 'title' => ts('Country'),
4196 ),
4197 'county_id' => array(
4198 'title' => ts('County'),
4199 ),
4200 );
4201 }
4202 return $addressFields;
4203 }
4204
4205 /**
4206 * Do AlterDisplay processing on Address Fields.
4207 *
4208 * @param array $row
4209 * @param array $rows
4210 * @param int $rowNum
4211 * @param string $baseUrl
4212 * @param string $linkText
4213 *
4214 * @return bool
4215 */
4216 public function alterDisplayAddressFields(&$row, &$rows, &$rowNum, $baseUrl, $linkText) {
4217 $criteriaQueryParams = CRM_Report_Utils_Report::getPreviewCriteriaQueryParams($this->_defaults, $this->_params);
4218 $entryFound = FALSE;
4219 // handle country
4220 if (array_key_exists('civicrm_address_country_id', $row)) {
4221 if ($value = $row['civicrm_address_country_id']) {
4222 $rows[$rowNum]['civicrm_address_country_id'] = CRM_Core_PseudoConstant::country($value, FALSE);
4223 if ($baseUrl) {
4224 $url = CRM_Report_Utils_Report::getNextUrl($baseUrl,
4225 "reset=1&force=1&{$criteriaQueryParams}&" .
4226 "country_id_op=in&country_id_value={$value}",
4227 $this->_absoluteUrl, $this->_id
4228 );
4229 $rows[$rowNum]['civicrm_address_country_id_link'] = $url;
4230 $rows[$rowNum]['civicrm_address_country_id_hover'] = ts("%1 for this country.",
4231 array(1 => $linkText)
4232 );
4233 }
4234 }
4235
4236 $entryFound = TRUE;
4237 }
4238 if (array_key_exists('civicrm_address_county_id', $row)) {
4239 if ($value = $row['civicrm_address_county_id']) {
4240 $rows[$rowNum]['civicrm_address_county_id'] = CRM_Core_PseudoConstant::county($value, FALSE);
4241 if ($baseUrl) {
4242 $url = CRM_Report_Utils_Report::getNextUrl($baseUrl,
4243 "reset=1&force=1&{$criteriaQueryParams}&" .
4244 "county_id_op=in&county_id_value={$value}",
4245 $this->_absoluteUrl, $this->_id
4246 );
4247 $rows[$rowNum]['civicrm_address_county_id_link'] = $url;
4248 $rows[$rowNum]['civicrm_address_county_id_hover'] = ts("%1 for this county.",
4249 array(1 => $linkText)
4250 );
4251 }
4252 }
4253 $entryFound = TRUE;
4254 }
4255 // handle state province
4256 if (array_key_exists('civicrm_address_state_province_id', $row)) {
4257 if ($value = $row['civicrm_address_state_province_id']) {
4258 $rows[$rowNum]['civicrm_address_state_province_id'] = CRM_Core_PseudoConstant::stateProvince($value, FALSE);
4259 if ($baseUrl) {
4260 $url = CRM_Report_Utils_Report::getNextUrl($baseUrl,
4261 "reset=1&force=1&{$criteriaQueryParams}&state_province_id_op=in&state_province_id_value={$value}",
4262 $this->_absoluteUrl, $this->_id
4263 );
4264 $rows[$rowNum]['civicrm_address_state_province_id_link'] = $url;
4265 $rows[$rowNum]['civicrm_address_state_province_id_hover'] = ts("%1 for this state.",
4266 array(1 => $linkText)
4267 );
4268 }
4269 }
4270 $entryFound = TRUE;
4271 }
4272
4273 return $entryFound;
4274 }
4275
4276 /**
4277 * Do AlterDisplay processing on Address Fields.
4278 *
4279 * @param array $row
4280 * @param array $rows
4281 * @param int $rowNum
4282 * @param string $baseUrl
4283 * @param string $linkText
4284 *
4285 * @return bool
4286 */
4287 public function alterDisplayContactFields(&$row, &$rows, &$rowNum, $baseUrl, $linkText) {
4288 $entryFound = FALSE;
4289 // There is no reason not to add links for all fields but it seems a bit odd to be able to click on
4290 // 'Mrs'. Also, we don't have metadata about the title. So, add selectively to addLinks.
4291 $addLinks = array('gender_id' => 'Gender');
4292 foreach (array('prefix_id', 'suffix_id', 'gender_id') as $fieldName) {
4293 if (array_key_exists('civicrm_contact_' . $fieldName, $row)) {
4294 if (($value = $row['civicrm_contact_' . $fieldName]) != FALSE) {
4295 $rows[$rowNum]['civicrm_contact_' . $fieldName] = CRM_Core_Pseudoconstant::getLabel('CRM_Contact_BAO_Contact', $fieldName, $value);
4296 if ($baseUrl && ($title = CRM_Utils_Array::value($fieldName, $addLinks)) != FALSE) {
4297 $this->addLinkToRow($rows[$rowNum], $baseUrl, $linkText, $value, $fieldName, 'civicrm_contact', $title);
4298 }
4299 }
4300 $entryFound = TRUE;
4301 }
4302 }
4303 $yesNoFields = array(
4304 'do_not_email', 'is_deceased', 'do_not_phone', 'do_not_sms', 'do_not_mail', 'is_opt_out',
4305 );
4306 foreach ($yesNoFields as $fieldName) {
4307 if (array_key_exists('civicrm_contact_' . $fieldName, $row)) {
4308 // Since these are essentially 'negative fields' it feels like it
4309 // makes sense to only highlight the exceptions hence no 'No'.
4310 $rows[$rowNum]['civicrm_contact_' . $fieldName] = !empty($rows[$rowNum]['civicrm_contact_' . $fieldName]) ? ts('Yes') : '';
4311 $entryFound = TRUE;
4312 }
4313 }
4314 return $entryFound;
4315 }
4316
4317 /**
4318 * Adjusts dates passed in to YEAR() for fiscal year.
4319 *
4320 * @param string $fieldName
4321 *
4322 * @return string
4323 */
4324 public function fiscalYearOffset($fieldName) {
4325 $config = CRM_Core_Config::singleton();
4326 $fy = $config->fiscalYearStart;
4327 if (CRM_Utils_Array::value('yid_op', $this->_params) == 'calendar' ||
4328 ($fy['d'] == 1 && $fy['M'] == 1)
4329 ) {
4330 return "YEAR( $fieldName )";
4331 }
4332 return "YEAR( $fieldName - INTERVAL " . ($fy['M'] - 1) . " MONTH" .
4333 ($fy['d'] > 1 ? (" - INTERVAL " . ($fy['d'] - 1) . " DAY") : '') . " )";
4334 }
4335
4336 /**
4337 * Add Address into From Table if required.
4338 */
4339 public function addAddressFromClause() {
4340 // include address field if address column is to be included
4341 if ((isset($this->_addressField) &&
4342 $this->_addressField
4343 ) ||
4344 $this->isTableSelected('civicrm_address')
4345 ) {
4346 $this->_from .= "
4347 LEFT JOIN civicrm_address {$this->_aliases['civicrm_address']}
4348 ON ({$this->_aliases['civicrm_contact']}.id =
4349 {$this->_aliases['civicrm_address']}.contact_id) AND
4350 {$this->_aliases['civicrm_address']}.is_primary = 1\n";
4351 }
4352 }
4353
4354 /**
4355 * Add Phone into From Table if required.
4356 */
4357 public function addPhoneFromClause() {
4358 // include address field if address column is to be included
4359 if ($this->isTableSelected('civicrm_phone')
4360 ) {
4361 $this->_from .= "
4362 LEFT JOIN civicrm_phone {$this->_aliases['civicrm_phone']}
4363 ON ({$this->_aliases['civicrm_contact']}.id =
4364 {$this->_aliases['civicrm_phone']}.contact_id) AND
4365 {$this->_aliases['civicrm_phone']}.is_primary = 1\n";
4366 }
4367 }
4368
4369 /**
4370 * Get phone columns to add to array.
4371 *
4372 * @param array $options
4373 * - prefix Prefix to add to table (in case of more than one instance of the table)
4374 * - prefix_label Label to give columns from this phone table instance
4375 *
4376 * @return array
4377 * phone columns definition
4378 */
4379 public function getPhoneColumns($options = array()) {
4380 $defaultOptions = array(
4381 'prefix' => '',
4382 'prefix_label' => '',
4383 );
4384
4385 $options = array_merge($defaultOptions, $options);
4386
4387 $fields = array(
4388 $options['prefix'] . 'civicrm_phone' => array(
4389 'dao' => 'CRM_Core_DAO_Phone',
4390 'fields' => array(
4391 $options['prefix'] . 'phone' => array(
4392 'title' => ts($options['prefix_label'] . 'Phone'),
4393 'name' => 'phone',
4394 ),
4395 ),
4396 ),
4397 );
4398 return $fields;
4399 }
4400
4401 /**
4402 * Get address columns to add to array.
4403 *
4404 * @param array $options
4405 * - prefix Prefix to add to table (in case of more than one instance of the table)
4406 * - prefix_label Label to give columns from this address table instance
4407 *
4408 * @return array
4409 * address columns definition
4410 */
4411 public function getAddressColumns($options = array()) {
4412 $options += array(
4413 'prefix' => '',
4414 'prefix_label' => '',
4415 'group_by' => TRUE,
4416 'order_by' => TRUE,
4417 'filters' => TRUE,
4418 'defaults' => array(),
4419 );
4420 return $this->addAddressFields(
4421 $options['group_by'],
4422 $options['order_by'],
4423 $options['filters'],
4424 $options['defaults']
4425 );
4426 }
4427
4428 /**
4429 * Get a standard set of contact fields.
4430 *
4431 * @return array
4432 */
4433 public function getBasicContactFields() {
4434 return array(
4435 'sort_name' => array(
4436 'title' => ts('Contact Name'),
4437 'required' => TRUE,
4438 'default' => TRUE,
4439 ),
4440 'id' => array(
4441 'no_display' => TRUE,
4442 'required' => TRUE,
4443 ),
4444 'prefix_id' => array(
4445 'title' => ts('Contact Prefix'),
4446 ),
4447 'first_name' => array(
4448 'title' => ts('First Name'),
4449 ),
4450 'nick_name' => array(
4451 'title' => ts('Nick Name'),
4452 ),
4453 'middle_name' => array(
4454 'title' => ts('Middle Name'),
4455 ),
4456 'last_name' => array(
4457 'title' => ts('Last Name'),
4458 ),
4459 'suffix_id' => array(
4460 'title' => ts('Contact Suffix'),
4461 ),
4462 'postal_greeting_display' => array('title' => ts('Postal Greeting')),
4463 'email_greeting_display' => array('title' => ts('Email Greeting')),
4464 'addressee_display' => array('title' => ts('Addressee')),
4465 'contact_type' => array(
4466 'title' => ts('Contact Type'),
4467 ),
4468 'contact_sub_type' => array(
4469 'title' => ts('Contact Subtype'),
4470 ),
4471 'gender_id' => array(
4472 'title' => ts('Gender'),
4473 ),
4474 'birth_date' => array(
4475 'title' => ts('Birth Date'),
4476 ),
4477 'age' => array(
4478 'title' => ts('Age'),
4479 'dbAlias' => 'TIMESTAMPDIFF(YEAR, contact_civireport.birth_date, CURDATE())',
4480 ),
4481 'job_title' => array(
4482 'title' => ts('Contact Job title'),
4483 ),
4484 'organization_name' => array(
4485 'title' => ts('Organization Name'),
4486 ),
4487 'external_identifier' => array(
4488 'title' => ts('Contact identifier from external system'),
4489 ),
4490 'do_not_email' => array(),
4491 'do_not_phone' => array(),
4492 'do_not_mail' => array(),
4493 'do_not_sms' => array(),
4494 'is_opt_out' => array(),
4495 'is_deceased' => array(),
4496 );
4497 }
4498
4499 /**
4500 * Get a standard set of contact filters.
4501 *
4502 * @return array
4503 */
4504 public function getBasicContactFilters() {
4505 return array(
4506 'sort_name' => array(
4507 'title' => ts('Contact Name'),
4508 ),
4509 'source' => array(
4510 'title' => ts('Contact Source'),
4511 'type' => CRM_Utils_Type::T_STRING,
4512 ),
4513 'id' => array(
4514 'title' => ts('Contact ID'),
4515 'no_display' => TRUE,
4516 ),
4517 'gender_id' => array(
4518 'title' => ts('Gender'),
4519 'operatorType' => CRM_Report_Form::OP_MULTISELECT,
4520 'options' => CRM_Core_PseudoConstant::get('CRM_Contact_DAO_Contact', 'gender_id'),
4521 ),
4522 'birth_date' => array(
4523 'title' => ts('Birth Date'),
4524 'operatorType' => CRM_Report_Form::OP_DATE,
4525 ),
4526 'contact_type' => array(
4527 'title' => ts('Contact Type'),
4528 ),
4529 'contact_sub_type' => array(
4530 'title' => ts('Contact Subtype'),
4531 ),
4532 'modified_date' => array(
4533 'title' => ts('Contact Modified'),
4534 'operatorType' => CRM_Report_Form::OP_DATE,
4535 'type' => CRM_Utils_Type::T_DATE,
4536 ),
4537 'is_deceased' => array(
4538 'title' => ts('Deceased'),
4539 'type' => CRM_Utils_Type::T_BOOLEAN,
4540 'default' => 0,
4541 ),
4542 );
4543 }
4544
4545 /**
4546 * Add contact to group.
4547 *
4548 * @param int $groupID
4549 */
4550 public function add2group($groupID) {
4551 if (is_numeric($groupID) && isset($this->_aliases['civicrm_contact'])) {
4552 $select = "SELECT DISTINCT {$this->_aliases['civicrm_contact']}.id AS addtogroup_contact_id, ";
4553
4554 // here are we are prepending / adding contact id field that could be used for adding group
4555 // so first check for "SELECT SQL_CALC_FOUND_ROWS" and if does not exist replace "SELECT"
4556 if (preg_match('/^SELECT SQL_CALC_FOUND_ROWS/', $this->_select)) {
4557 $select = str_ireplace('SELECT SQL_CALC_FOUND_ROWS ', $select, $this->_select);
4558 }
4559 else {
4560 $select = str_ireplace('SELECT ', $select, $this->_select);
4561 }
4562
4563 $sql = "{$select} {$this->_from} {$this->_where} {$this->_groupBy} {$this->_having} {$this->_orderBy}";
4564 $sql = str_replace('WITH ROLLUP', '', $sql);
4565 $dao = CRM_Core_DAO::executeQuery($sql);
4566
4567 $contact_ids = array();
4568 // Add resulting contacts to group
4569 while ($dao->fetch()) {
4570 if ($dao->addtogroup_contact_id) {
4571 $contact_ids[$dao->addtogroup_contact_id] = $dao->addtogroup_contact_id;
4572 }
4573 }
4574
4575 if (!empty($contact_ids)) {
4576 CRM_Contact_BAO_GroupContact::addContactsToGroup($contact_ids, $groupID);
4577 CRM_Core_Session::setStatus(ts("Listed contact(s) have been added to the selected group."), ts('Contacts Added'), 'success');
4578 }
4579 else {
4580 CRM_Core_Session::setStatus(ts("The listed records(s) cannot be added to the group."));
4581 }
4582 }
4583 }
4584
4585 /**
4586 * Show charts on print screen.
4587 */
4588 public static function uploadChartImage() {
4589 // upload strictly for '.png' images
4590 $name = trim(basename(CRM_Utils_Request::retrieve('name', 'String', CRM_Core_DAO::$_nullObject, FALSE, NULL, 'GET')));
4591 if (preg_match('/\.png$/', $name)) {
4592 //
4593 // POST data is usually string data, but we are passing a RAW .png
4594 // so PHP is a bit confused and $_POST is empty. But it has saved
4595 // the raw bits into $HTTP_RAW_POST_DATA
4596 //
4597 $httpRawPostData = $GLOBALS['HTTP_RAW_POST_DATA'];
4598
4599 // prepare the directory
4600 $config = CRM_Core_Config::singleton();
4601 $defaultPath
4602 = str_replace('/persist/contribute/', '/persist/', $config->imageUploadDir) .
4603 '/openFlashChart/';
4604 if (!file_exists($defaultPath)) {
4605 mkdir($defaultPath, 0777, TRUE);
4606 }
4607
4608 // full path to the saved image including filename
4609 $destination = $defaultPath . $name;
4610
4611 //write and save
4612 $jfh = fopen($destination, 'w') or die("can't open file");
4613 fwrite($jfh, $httpRawPostData);
4614 fclose($jfh);
4615 CRM_Utils_System::civiExit();
4616 }
4617 }
4618
4619 /**
4620 * Apply common settings to entityRef fields.
4621 *
4622 * @param array $field
4623 * @param string $table
4624 */
4625 private function setEntityRefDefaults(&$field, $table) {
4626 $field['attributes'] = $field['attributes'] ? $field['attributes'] : array();
4627 $field['attributes'] += array(
4628 'entity' => CRM_Core_DAO_AllCoreTables::getBriefName(CRM_Core_DAO_AllCoreTables::getClassForTable($table)),
4629 'multiple' => TRUE,
4630 'placeholder' => ts('- select -'),
4631 );
4632 }
4633
4634 /**
4635 * Add link fields to the row.
4636 *
4637 * Function adds the _link & _hover fields to the row.
4638 *
4639 * @param array $row
4640 * @param string $baseUrl
4641 * @param string $linkText
4642 * @param string $value
4643 * @param string $fieldName
4644 * @param string $tablePrefix
4645 * @param string $fieldLabel
4646 *
4647 * @return mixed
4648 */
4649 protected function addLinkToRow(&$row, $baseUrl, $linkText, $value, $fieldName, $tablePrefix, $fieldLabel) {
4650 $criteriaQueryParams = CRM_Report_Utils_Report::getPreviewCriteriaQueryParams($this->_defaults, $this->_params);
4651 $url = CRM_Report_Utils_Report::getNextUrl($baseUrl,
4652 "reset=1&force=1&{$criteriaQueryParams}&" .
4653 $fieldName . "_op=in&{$fieldName}_value={$value}",
4654 $this->_absoluteUrl, $this->_id
4655 );
4656 $row["{$tablePrefix}_{$fieldName}_link"] = $url;
4657 $row["{$tablePrefix}_{$fieldName}_hover"] = ts("%1 for this %2.",
4658 array(1 => $linkText, 2 => $fieldLabel)
4659 );
4660 }
4661
4662 /**
4663 * Generate temporary table to hold all contributions with permissioned FTs.
4664 *
4665 * @param object $query
4666 * @param string $alias
4667 * @param bool $return
4668 */
4669 public function getPermissionedFTQuery(&$query, $alias = NULL, $return = FALSE) {
4670 if (!CRM_Financial_BAO_FinancialType::isACLFinancialTypeStatus()) {
4671 return FALSE;
4672 }
4673 $financialTypes = NULL;
4674 CRM_Financial_BAO_FinancialType::getAvailableFinancialTypes($financialTypes);
4675 if (empty($financialTypes)) {
4676 $contFTs = "0";
4677 $liFTs = implode(',', array_keys(CRM_Contribute_Pseudoconstant::financialType()));
4678 }
4679 else {
4680 $contFTs = $liFTs = implode(',', array_keys($financialTypes));
4681 }
4682 $temp = CRM_Utils_Array::value('civicrm_line_item', $query->_aliases);
4683 if ($alias) {
4684 $query->_aliases['civicrm_line_item'] = $alias;
4685 }
4686 elseif (!$temp) {
4687 $query->_aliases['civicrm_line_item'] = 'civicrm_line_item_civireport';
4688 }
4689 if (empty($query->_where)) {
4690 $query->_where = "WHERE {$query->_aliases['civicrm_contribution']}.id IS NOT NULL ";
4691 }
4692 CRM_Core_DAO::executeQuery("DROP TEMPORARY TABLE IF EXISTS civicrm_contribution_temp");
4693 $sql = "CREATE TEMPORARY TABLE civicrm_contribution_temp AS SELECT {$query->_aliases['civicrm_contribution']}.id {$query->_from}
4694 LEFT JOIN civicrm_line_item {$query->_aliases['civicrm_line_item']}
4695 ON {$query->_aliases['civicrm_contribution']}.id = {$query->_aliases['civicrm_line_item']}.contribution_id AND
4696 {$query->_aliases['civicrm_line_item']}.entity_table = 'civicrm_contribution'
4697 AND {$query->_aliases['civicrm_line_item']}.financial_type_id NOT IN (" . $liFTs . ")
4698 {$query->_where}
4699 AND {$query->_aliases['civicrm_contribution']}.financial_type_id IN (" . $contFTs . ")
4700 AND {$query->_aliases['civicrm_line_item']}.id IS NULL
4701 GROUP BY {$query->_aliases['civicrm_contribution']}.id";
4702 CRM_Core_DAO::executeQuery($sql);
4703 if (isset($temp)) {
4704 $query->_aliases['civicrm_line_item'] = $temp;
4705 }
4706 $from = " INNER JOIN civicrm_contribution_temp temp ON {$query->_aliases['civicrm_contribution']}.id = temp.id ";
4707 if ($return) {
4708 return $from;
4709 }
4710 $query->_from .= $from;
4711 }
4712
4713 /**
4714 * Get label for show results buttons.
4715 *
4716 * @return string
4717 */
4718 public function getResultsLabel() {
4719 $showResultsLabel = $this->resultsDisplayed() ? ts('Refresh results') : ts('View results');
4720 return $showResultsLabel;
4721 }
4722
4723 /**
4724 * Determine the output mode from the url or input.
4725 *
4726 * Output could be
4727 * - pdf : Render as pdf
4728 * - csv : Render as csv
4729 * - print : Render in print format
4730 * - save : save the report and display the new report
4731 * - copy : save the report as a new instance and display that.
4732 * - group : go to the add to group screen.
4733 *
4734 * Potentially chart variations could also be included but the complexity
4735 * is that we might print a bar chart as a pdf.
4736 */
4737 protected function setOutputMode() {
4738 $this->_outputMode = str_replace('report_instance.', '', CRM_Utils_Request::retrieve(
4739 'output',
4740 'String',
4741 CRM_Core_DAO::$_nullObject,
4742 FALSE,
4743 CRM_Utils_Array::value('task', $this->_params)
4744 ));
4745 // if contacts are added to group
4746 if (!empty($this->_params['groups']) && empty($this->_outputMode)) {
4747 $this->_outputMode = 'group';
4748 }
4749 if (isset($this->_params['task'])) {
4750 unset($this->_params['task']);
4751 }
4752 }
4753
4754 /**
4755 * CRM-17793 - Alter DateTime section header to group by date from the datetime field.
4756 *
4757 * @param $tempTable
4758 * @param $columnName
4759 */
4760 public function alterSectionHeaderForDateTime($tempTable, $columnName) {
4761 // add new column with date value for the datetime field
4762 $tempQuery = "ALTER TABLE {$tempTable} ADD COLUMN {$columnName}_date VARCHAR(128)";
4763 CRM_Core_DAO::executeQuery($tempQuery);
4764 $updateQuery = "UPDATE {$tempTable} SET {$columnName}_date = date({$columnName})";
4765 CRM_Core_DAO::executeQuery($updateQuery);
4766 $this->_selectClauses[] = "{$columnName}_date";
4767 $this->_select .= ", {$columnName}_date";
4768 $this->_sections["{$columnName}_date"] = $this->_sections["{$columnName}"];
4769 unset($this->_sections["{$columnName}"]);
4770 $this->assign('sections', $this->_sections);
4771 }
4772
4773 /**
4774 * Get an array of the columns that have been selected for display.
4775 *
4776 * @return array
4777 */
4778 public function getSelectColumns() {
4779 $selectColumns = array();
4780 foreach ($this->_columns as $tableName => $table) {
4781 if (array_key_exists('fields', $table)) {
4782 foreach ($table['fields'] as $fieldName => $field) {
4783 if (!empty($field['required']) ||
4784 !empty($this->_params['fields'][$fieldName])
4785 ) {
4786
4787 $selectColumns["{$tableName}_{$fieldName}"] = 1;
4788 }
4789 }
4790 }
4791 }
4792 return $selectColumns;
4793 }
4794
4795 /**
4796 * Add location tables to the query if they are used for filtering.
4797 *
4798 * This is for when we are running the query separately for filtering and retrieving display fields.
4799 */
4800 public function selectivelyAddLocationTablesJoinsToFilterQuery() {
4801 if ($this->isTableFiltered('civicrm_email')) {
4802 $this->_from .= "
4803 LEFT JOIN civicrm_email {$this->_aliases['civicrm_email']}
4804 ON {$this->_aliases['civicrm_contact']}.id = {$this->_aliases['civicrm_email']}.contact_id
4805 AND {$this->_aliases['civicrm_email']}.is_primary = 1";
4806 }
4807 if ($this->isTableFiltered('civicrm_phone')) {
4808 $this->_from .= "
4809 LEFT JOIN civicrm_phone {$this->_aliases['civicrm_phone']}
4810 ON {$this->_aliases['civicrm_contact']}.id = {$this->_aliases['civicrm_phone']}.contact_id
4811 AND {$this->_aliases['civicrm_phone']}.is_primary = 1";
4812 }
4813 if ($this->isTableFiltered('civicrm_address')) {
4814 $this->_from .= "
4815 LEFT JOIN civicrm_address {$this->_aliases['civicrm_address']}
4816 ON ({$this->_aliases['civicrm_contact']}.id = {$this->_aliases['civicrm_address']}.contact_id)
4817 AND {$this->_aliases['civicrm_address']}.is_primary = 1\n";
4818 }
4819 }
4820
4821 /**
4822 * Set the base table for the FROM clause.
4823 *
4824 * Sets up the from clause, allowing for the possibility it might be a
4825 * temp table pre-filtered by groups if a group filter is in use.
4826 *
4827 * @param string $baseTable
4828 * @param string $field
4829 * @param null $tableAlias
4830 */
4831 public function setFromBase($baseTable, $field = 'id', $tableAlias = NULL) {
4832 if (!$tableAlias) {
4833 $tableAlias = $this->_aliases[$baseTable];
4834 }
4835 $this->_from = $this->_from = " FROM $baseTable $tableAlias ";
4836 $this->joinGroupTempTable($baseTable, $field, $tableAlias);
4837 $this->_from .= " {$this->_aclFrom} ";
4838 }
4839
4840 /**
4841 * Join the temp table contacting contacts who are members of the filtered groups.
4842 *
4843 * If we are using an IN filter we use an inner join, otherwise a left join.
4844 *
4845 * @param string $baseTable
4846 * @param string $field
4847 * @param string $tableAlias
4848 */
4849 public function joinGroupTempTable($baseTable, $field, $tableAlias) {
4850 if ($this->groupTempTable) {
4851 if ($this->_params['gid_op'] == 'in') {
4852 $this->_from = " FROM $this->groupTempTable group_temp_table INNER JOIN $baseTable $tableAlias
4853 ON group_temp_table.id = $tableAlias.{$field} ";
4854 }
4855 else {
4856 $this->_from .= "
4857 LEFT JOIN $this->groupTempTable group_temp_table
4858 ON $tableAlias.{$field} = group_temp_table.id ";
4859 }
4860 }
4861 }
4862
4863 }