CRM/Report/Form.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | Copyright CiviCRM LLC. All rights reserved.                        |
   5  |                                                                    |
   6  | This work is published under the GNU AGPLv3 license with some      |
   7  | permitted exceptions and without any warranty. For full license    |
   8  | and copyright information, see https://civicrm.org/licensing       |
   9  +--------------------------------------------------------------------+
  10  */
  11
  12 /**
  13  * Class CRM_Report_Form
  14  */
  15 class CRM_Report_Form extends CRM_Core_Form {
  16   const ROW_COUNT_LIMIT = 50;
  17
  18   /**
  19    * Operator types - used for displaying filter elements
  20    */
  21   const
  22     OP_INT = 1,
  23     OP_STRING = 2,
  24     OP_DATE = 4,
  25     OP_DATETIME = 5,
  26     OP_FLOAT = 8,
  27     OP_SELECT = 64,
  28     OP_MULTISELECT = 65,
  29     OP_MULTISELECT_SEPARATOR = 66,
  30     OP_MONTH = 128,
  31     OP_ENTITYREF = 256;
  32
  33   /**
  34    * The id of the report instance
  35    *
  36    * @var int
  37    */
  38   protected $_id;
  39
  40   /**
  41    * The id of the report template
  42    *
  43    * @var int
  44    */
  45   protected $_templateID;
  46
  47   /**
  48    * The report title
  49    *
  50    * @var string
  51    */
  52   protected $_title;
  53   protected $_noFields = FALSE;
  54
  55   /**
  56    * The set of all columns in the report. An associative array
  57    * with column name as the key and attributes as the value
  58    *
  59    * @var array
  60    */
  61   protected $_columns = [];
  62
  63   /**
  64    * The set of filters in the report
  65    *
  66    * @var array
  67    */
  68   protected $_filters = [];
  69
  70   /**
  71    * The set of optional columns in the report
  72    *
  73    * @var array
  74    */
  75   public $_options = [];
  76
  77   /**
  78    * By default most reports hide contact id.
  79    * Setting this to true makes it available
  80    * @var bool
  81    */
  82   protected $_exposeContactID = TRUE;
  83
  84   /**
  85    * Set of statistic fields
  86    *
  87    * @var array
  88    */
  89   protected $_statFields = [];
  90
  91   /**
  92    * Set of statistics data
  93    *
  94    * @var array
  95    */
  96   protected $_statistics = [];
  97
  98   /**
  99    * List of fields not to be repeated during display
 100    *
 101    * @var array
 102    */
 103   protected $_noRepeats = [];
 104
 105   /**
 106    * List of fields not to be displayed
 107    *
 108    * @var array
 109    */
 110   protected $_noDisplay = [];
 111
 112   /**
 113    * Object type that a custom group extends
 114    *
 115    * @var null
 116    */
 117   protected $_customGroupExtends = NULL;
 118   protected $_customGroupExtendsJoin = [];
 119   protected $_customGroupFilters = TRUE;
 120   protected $_customGroupGroupBy = FALSE;
 121   protected $_customGroupJoin = 'LEFT JOIN';
 122
 123   /**
 124    * Build tags filter
 125    * @var bool
 126    */
 127   protected $_tagFilter = FALSE;
 128
 129   /**
 130    * specify entity table for tags filter
 131    * @var string
 132    */
 133   protected $_tagFilterTable = 'civicrm_contact';
 134
 135   /**
 136    * Build groups filter.
 137    *
 138    * @var bool
 139    */
 140   protected $_groupFilter = FALSE;
 141
 142   /**
 143    * Has the report been optimised for group filtering.
 144    *
 145    * The functionality for group filtering has been improved but not
 146    * all reports have been adjusted to take care of it.
 147    *
 148    * This property exists to highlight the reports which are still using the
 149    * slow method & allow group filtering to still work for them until they
 150    * can be migrated.
 151    *
 152    * In order to protect extensions we have to default to TRUE - but I have
 153    * separately marked every class with a groupFilter in the hope that will trigger
 154    * people to fix them as they touch them.
 155    *
 156    * @var bool
 157    * @see https://issues.civicrm.org/jira/browse/CRM-19170
 158    */
 159   protected $groupFilterNotOptimised = TRUE;
 160
 161   /**
 162    * Navigation fields
 163    *
 164    * @var array
 165    */
 166   public $_navigation = [];
 167
 168   public $_drilldownReport = [];
 169
 170   /**
 171    * Array of tabs to display on report.
 172    *
 173    * E.g we define the tab title, the tpl and the tab-specific part of the css or  html link.
 174    *
 175    *  $this->tabs['OrderBy'] = array(
 176    *    'title' => ts('Sorting'),
 177    *    'tpl' => 'OrderBy',
 178    *    'div_label' => 'order-by',
 179    *  );
 180    *
 181    * @var array
 182    */
 183   protected $tabs = [];
 184
 185   /**
 186    * Should we add paging.
 187    *
 188    * @var bool
 189    */
 190   protected $addPaging = TRUE;
 191
 192   protected $isForceGroupBy = FALSE;
 193
 194   protected $groupConcatTested = FALSE;
 195
 196   /**
 197    * Are we in print mode. Can be set by another outputMode, ex: sendmail.
 198    *
 199    * @var bool
 200    */
 201   public $printOnly = FALSE;
 202
 203   /**
 204    * An attribute for checkbox/radio form field layout
 205    *
 206    * @var array
 207    */
 208   protected $_fourColumnAttribute = [
 209     '</td><td width="25%">',
 210     '</td><td width="25%">',
 211     '</td><td width="25%">',
 212     '</tr><tr><td>',
 213   ];
 214
 215   protected $_force = 1;
 216
 217   protected $_params = NULL;
 218   protected $_formValues = NULL;
 219   protected $_instanceValues = NULL;
 220
 221   protected $_instanceForm = FALSE;
 222   protected $_criteriaForm = FALSE;
 223
 224   protected $_instanceButtonName = NULL;
 225   protected $_createNewButtonName = NULL;
 226   protected $_groupButtonName = NULL;
 227   protected $_chartButtonName = NULL;
 228   protected $_csvSupported = TRUE;
 229   protected $_add2groupSupported = TRUE;
 230   protected $_groups = NULL;
 231   protected $_grandFlag = FALSE;
 232   protected $_rowsFound = NULL;
 233   protected $_selectAliases = [];
 234   protected $_rollup = NULL;
 235
 236   /**
 237    * Table containing list of contact IDs within the group filter.
 238    *
 239    * @var string
 240    */
 241   protected $groupTempTable = '';
 242
 243   /**
 244    * @var array
 245    */
 246   protected $_aliases = [];
 247
 248   /**
 249    * @var string
 250    */
 251   protected $_where;
 252
 253   /**
 254    * @var string
 255    */
 256   protected $_from;
 257
 258   /**
 259    * SQL Limit clause
 260    * @var  string
 261    */
 262   protected $_limit = NULL;
 263
 264   /**
 265    * This can be set to specify a limit to the number of rows
 266    * Since it is currently envisaged as part of the api usage it is only being applied
 267    * when $_output mode is not 'html' or 'group' so as not to have to interpret / mess with that part
 268    * of the code (see limit() fn.
 269    *
 270    * @var int
 271    */
 272   protected $_limitValue = NULL;
 273
 274   /**
 275    * This can be set to specify row offset
 276    * See notes on _limitValue
 277    *
 278    * @var int
 279    */
 280   protected $_offsetValue = NULL;
 281   /**
 282    * @var null
 283    */
 284   protected $_sections = NULL;
 285   protected $_autoIncludeIndexedFieldsAsOrderBys = 0;
 286
 287   /**
 288    * Whether to generate absolute URLs (ex: in report emails).
 289    *
 290    * @var bool
 291    */
 292   public $_absoluteUrl = FALSE;
 293
 294   /**
 295    * Flag to indicate if result-set is to be stored in a class variable which could be retrieved using getResultSet() method.
 296    *
 297    * @var bool
 298    */
 299   protected $_storeResultSet = FALSE;
 300
 301   /**
 302    * When _storeResultSet Flag is set use this var to store result set in form of array
 303    *
 304    * @var bool
 305    */
 306   protected $_resultSet = [];
 307
 308   /**
 309    * To what frequency group-by a date column
 310    *
 311    * @var array
 312    */
 313   protected $_groupByDateFreq = [
 314     'MONTH' => 'Month',
 315     'YEARWEEK' => 'Week',
 316     'QUARTER' => 'Quarter',
 317     'YEAR' => 'Year',
 318   ];
 319
 320   /**
 321    * Variables to hold the acl inner join and where clause
 322    * @var string|null
 323    */
 324   protected $_aclFrom = NULL;
 325   protected $_aclWhere = NULL;
 326
 327   /**
 328    * Array of DAO tables having columns included in SELECT or ORDER BY clause.
 329    *
 330    * Where has also been added to this although perhaps the 'includes both' array should have a different name.
 331    *
 332    * @var array
 333    */
 334   protected $_selectedTables = [];
 335
 336   /**
 337    * Array of DAO tables having columns included in WHERE or HAVING clause
 338    *
 339    * @var array
 340    */
 341   protected $filteredTables;
 342
 343   /**
 344    * Output mode e.g 'print', 'csv', 'pdf'.
 345    *
 346    * @var string
 347    */
 348   protected $_outputMode;
 349
 350   /**
 351    * Format of any chart in use.
 352    *
 353    * (it's unclear if this could be merged with outputMode at this stage)
 354    *
 355    * @var string|null
 356    */
 357   protected $_format;
 358
 359   public $_having = NULL;
 360   public $_select = NULL;
 361   public $_selectClauses = [];
 362   public $_columnHeaders = [];
 363   public $_orderBy = NULL;
 364   public $_orderByFields = [];
 365   public $_orderByArray = [];
 366   /**
 367    * Array of clauses to group by.
 368    *
 369    * @var array
 370    */
 371   protected $_groupByArray = [];
 372   public $_groupBy = NULL;
 373   public $_whereClauses = [];
 374   public $_havingClauses = [];
 375
 376   /**
 377    * DashBoardRowCount Dashboard row count.
 378    *
 379    * @var int
 380    */
 381   public $_dashBoardRowCount;
 382
 383   /**
 384    * Is this being called without a form controller (ie. the report is being render outside the normal form
 385    * - e.g the api is retrieving the rows.
 386    *
 387    * @var bool
 388    */
 389   public $noController = FALSE;
 390
 391   /**
 392    * Variable to hold the currency alias.
 393    *
 394    * @var string|null
 395    */
 396   protected $_currencyColumn = NULL;
 397
 398   /**
 399    * @var string
 400    */
 401   protected $_interval;
 402
 403   /**
 404    * @var bool
 405    */
 406   protected $_sendmail;
 407
 408   /**
 409    * @var int
 410    */
 411   protected $_chartId;
 412
 413   /**
 414    * @var int
 415    */
 416   public $_section;
 417
 418   /**
 419    * Report description.
 420    *
 421    * @var string
 422    */
 423   public $_description;
 424
 425   /**
 426    * Is an address field selected.
 427    *
 428    * @var bool
 429    *   This was intended to determine if the address table should be joined in
 430    *   The isTableSelected function is now preferred for this purpose
 431    */
 432   protected $_addressField;
 433
 434   /**
 435    * Is an email field selected.
 436    *
 437    * @var bool
 438    *   This was intended to determine if the email table should be joined in
 439    *   The isTableSelected function is now preferred for this purpose
 440    */
 441   protected $_emailField;
 442
 443   /**
 444    * Is a phone field selected.
 445    *
 446    * @var bool
 447    *   This was intended to determine if the phone table should be joined in
 448    *   The isTableSelected function is now preferred for this purpose
 449    */
 450   protected $_phoneField;
 451
 452   /**
 453    * Create new report instance? (or update existing) on save.
 454    *
 455    * @var bool
 456    */
 457   protected $_createNew;
 458
 459   /**
 460    *  When a grand total row has calculated the status we pop it off to here.
 461    *
 462    * This allows us to access it from the stats function and avoid recalculating.
 463    *
 464    * @var array
 465    */
 466   protected $rollupRow = [];
 467
 468   /**
 469    * Database attributes - character set and collation.
 470    *
 471    * @var string
 472    */
 473   protected $_databaseAttributes = ' DEFAULT CHARACTER SET utf8 COLLATE utf8_unicode_ci';
 474
 475   /**
 476    * SQL being run in this report.
 477    *
 478    * The sql in the report is stored in this variable in order to be displayed on the developer tab.
 479    *
 480    * @var string
 481    */
 482
 483   protected $sql;
 484
 485   /**
 486    * An instruction not to add a Group By.
 487    *
 488    * This is relevant where the group by might be otherwise added after the code that determines the group by array.
 489    *
 490    * e.g. where stat fields are being added but other settings cause it to not be desirable to add a group by
 491    * such as in pivot charts when no row header is set
 492    *
 493    * @var bool
 494    */
 495   protected $noGroupBy = FALSE;
 496
 497   /**
 498    * SQL being run in this report as an array.
 499    *
 500    * The sql in the report is stored in this variable in order to be returned to api & test calls.
 501    *
 502    * @var string
 503    */
 504
 505   protected $sqlArray;
 506
 507   /**
 508    * Tables created for the report that need removal afterwards.
 509    *
 510    * ['civicrm_temp_report_x' => ['temporary' => TRUE, 'name' => 'civicrm_temp_report_x']
 511    * @var array
 512    */
 513   protected $temporaryTables = [];
 514
 515   /**
 516    * Can this report use the sql mode ONLY_FULL_GROUP_BY.
 517    * @var bool
 518    */
 519   public $optimisedForOnlyFullGroupBy = TRUE;
 520
 521   /**
 522    * Class constructor.
 523    */
 524   public function __construct() {
 525     parent::__construct();
 526
 527     $this->addClass('crm-report-form');
 528
 529     if ($this->_tagFilter) {
 530       $this->buildTagFilter();
 531     }
 532     if ($this->_exposeContactID) {
 533       if (array_key_exists('civicrm_contact', $this->_columns)) {
 534         $this->_columns['civicrm_contact']['fields']['exposed_id'] = [
 535           'name' => 'id',
 536           'title' => ts('Contact ID'),
 537           'no_repeat' => TRUE,
 538         ];
 539       }
 540     }
 541
 542     if ($this->_groupFilter) {
 543       $this->buildGroupFilter();
 544     }
 545
 546     // Get all custom groups
 547     $allGroups = CRM_Core_PseudoConstant::get('CRM_Core_DAO_CustomField', 'custom_group_id');
 548
 549     // Get the custom groupIds for which the user has VIEW permission
 550     // If the user has 'access all custom data' permission, we'll leave $permCustomGroupIds empty
 551     // and addCustomDataToColumns() will allow access to all custom groups.
 552     $permCustomGroupIds = [];
 553     if (!CRM_Core_Permission::check('access all custom data')) {
 554       $permCustomGroupIds = CRM_ACL_API::group(CRM_Core_Permission::VIEW, NULL, 'civicrm_custom_group', $allGroups, NULL);
 555       // do not allow custom data for reports if user doesn't have
 556       // permission to access custom data.
 557       if (!empty($this->_customGroupExtends) && empty($permCustomGroupIds)) {
 558         $this->_customGroupExtends = [];
 559       }
 560     }
 561
 562     // merge custom data columns to _columns list, if any
 563     $this->addCustomDataToColumns(TRUE, $permCustomGroupIds);
 564
 565     // add / modify display columns, filters ..etc
 566     CRM_Utils_Hook::alterReportVar('columns', $this->_columns, $this);
 567
 568     //assign currencyColumn variable to tpl
 569     $this->assign('currencyColumn', $this->_currencyColumn);
 570   }
 571
 572   /**
 573    * Shared pre-process function.
 574    *
 575    * If overriding preProcess function this should still be called.
 576    *
 577    * @throws \Exception
 578    */
 579   public function preProcessCommon() {
 580     $this->_force = CRM_Utils_Request::retrieve('force', 'Boolean');
 581
 582     $this->_dashBoardRowCount = CRM_Utils_Request::retrieve('rowCount', 'Integer');
 583
 584     $this->_section = CRM_Utils_Request::retrieve('section', 'Integer');
 585
 586     $this->assign('section', $this->_section);
 587     CRM_Core_Region::instance('page-header')->add([
 588       'markup' => sprintf('<!-- Report class: [%s] -->', htmlentities(get_class($this))),
 589     ]);
 590     if (!$this->noController) {
 591       $this->setID($this->get('instanceId'));
 592
 593       if (!$this->_id) {
 594         $this->setID(CRM_Report_Utils_Report::getInstanceID());
 595         if (!$this->_id) {
 596           $this->setID(CRM_Report_Utils_Report::getInstanceIDForPath());
 597         }
 598       }
 599
 600       // set qfkey so that pager picks it up and use it in the "Next > Last >>" links.
 601       // FIXME: Note setting it in $_GET doesn't work, since pager generates link based on QUERY_STRING
 602       $_SERVER['QUERY_STRING'] .= "&qfKey={$this->controller->_key}";
 603     }
 604
 605     if ($this->_id) {
 606       $this->assign('instanceId', $this->_id);
 607       $params = ['id' => $this->_id];
 608       $this->_instanceValues = [];
 609       CRM_Core_DAO::commonRetrieve('CRM_Report_DAO_ReportInstance',
 610         $params,
 611         $this->_instanceValues
 612       );
 613       if (empty($this->_instanceValues)) {
 614         CRM_Core_Error::statusBounce("Report could not be loaded.");
 615       }
 616       $this->_title = $this->_instanceValues['title'];
 617       if (!empty($this->_instanceValues['permission']) &&
 618         (!(CRM_Core_Permission::check($this->_instanceValues['permission']) ||
 619           CRM_Core_Permission::check('administer Reports')
 620         ))
 621       ) {
 622         CRM_Utils_System::permissionDenied();
 623         CRM_Utils_System::civiExit();
 624       }
 625
 626       $formValues = $this->_instanceValues['form_values'] ?? NULL;
 627       if ($formValues) {
 628         $this->_formValues = CRM_Utils_String::unserialize($formValues);
 629       }
 630       else {
 631         $this->_formValues = NULL;
 632       }
 633
 634       $this->setOutputMode();
 635
 636       if ($this->_outputMode == 'copy') {
 637         $this->_createNew = TRUE;
 638         $this->_params = $this->_formValues;
 639         $this->_params['view_mode'] = 'criteria';
 640         $this->_params['title'] = $this->getTitle() . ts(' (copy created by %1 on %2)', [
 641           CRM_Core_Session::singleton()->getLoggedInContactDisplayName(),
 642           CRM_Utils_Date::customFormat(date('Y-m-d H:i')),
 643         ]);
 644         // Do not pass go. Do not collect another chance to re-run the same query.
 645         CRM_Report_Form_Instance::postProcess($this);
 646       }
 647
 648       // lets always do a force if reset is found in the url.
 649       // Hey why not? see CRM-17225 for more about this. The use of reset to be force is historical for reasons stated
 650       // in the comment line above these 2.
 651       if (!empty($_REQUEST['reset'])
 652           && !in_array(CRM_Utils_Request::retrieve('output', 'String'), ['save', 'criteria'])) {
 653         $this->_force = 1;
 654       }
 655
 656       // set the mode
 657       $this->assign('mode', 'instance');
 658     }
 659     elseif (!$this->noController) {
 660       list($optionValueID, $optionValue) = CRM_Report_Utils_Report::getValueIDFromUrl();
 661       $instanceCount = CRM_Report_Utils_Report::getInstanceCount($optionValue);
 662       if (($instanceCount > 0) && $optionValueID) {
 663         $this->assign('instanceUrl',
 664           CRM_Utils_System::url('civicrm/report/list',
 665             "reset=1&ovid=$optionValueID"
 666           )
 667         );
 668       }
 669       if ($optionValueID) {
 670         $this->_description = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionValue', $optionValueID, 'description');
 671       }
 672
 673       // set the mode
 674       $this->assign('mode', 'template');
 675     }
 676
 677     // lets display the Report Settings section
 678     $this->_instanceForm = $this->_force || $this->_id || (!empty($_POST));
 679
 680     // Do not display Report Settings section if administer Reports permission is absent OR
 681     // if report instance is reserved and administer reserved reports absent
 682     if (!CRM_Core_Permission::check('administer Reports') ||
 683       (!empty($this->_instanceValues['is_reserved']) &&
 684         !CRM_Core_Permission::check('administer reserved reports'))
 685     ) {
 686       $this->_instanceForm = FALSE;
 687     }
 688
 689     $this->assign('criteriaForm', FALSE);
 690     // Display Report Criteria section if user has access Report Criteria OR administer Reports AND report instance is not reserved
 691     if (CRM_Core_Permission::check('administer Reports') ||
 692       CRM_Core_Permission::check('access Report Criteria')
 693     ) {
 694       if (empty($this->_instanceValues['is_reserved']) ||
 695         CRM_Core_Permission::check('administer reserved reports')
 696       ) {
 697         $this->assign('criteriaForm', TRUE);
 698         $this->_criteriaForm = TRUE;
 699       }
 700     }
 701
 702     // Special permissions check for private instance if it's not the current contact instance
 703     if ($this->_id &&
 704       (CRM_Report_BAO_ReportInstance::reportIsPrivate($this->_id) &&
 705       !CRM_Report_BAO_ReportInstance::contactIsOwner($this->_id))) {
 706       if (!CRM_Core_Permission::check('access all private reports')) {
 707         $this->_instanceForm = FALSE;
 708         $this->assign('criteriaForm', FALSE);
 709       }
 710     }
 711
 712     $this->_instanceButtonName = $this->getButtonName('submit', 'save');
 713     $this->_createNewButtonName = $this->getButtonName('submit', 'next');
 714     $this->_groupButtonName = $this->getButtonName('submit', 'group');
 715     $this->_chartButtonName = $this->getButtonName('submit', 'chart');
 716   }
 717
 718   /**
 719    * Add bread crumb.
 720    */
 721   public function addBreadCrumb() {
 722     $breadCrumbs
 723       = [
 724         [
 725           'title' => ts('Report Templates'),
 726           'url' => CRM_Utils_System::url('civicrm/admin/report/template/list', 'reset=1'),
 727         ],
 728       ];
 729
 730     CRM_Utils_System::appendBreadCrumb($breadCrumbs);
 731   }
 732
 733   /**
 734    * Pre process function.
 735    *
 736    * Called prior to build form.
 737    */
 738   public function preProcess() {
 739     $this->preProcessCommon();
 740
 741     if (!$this->_id) {
 742       $this->addBreadCrumb();
 743     }
 744
 745     foreach ($this->_columns as $tableName => $table) {
 746       $this->setTableAlias($table, $tableName);
 747
 748       $expFields = [];
 749       // higher preference to bao object
 750       $daoOrBaoName = CRM_Utils_Array::value('bao', $table, CRM_Utils_Array::value('dao', $table));
 751
 752       if ($daoOrBaoName) {
 753         if (method_exists($daoOrBaoName, 'exportableFields')) {
 754           $expFields = $daoOrBaoName::exportableFields();
 755         }
 756         else {
 757           $expFields = $daoOrBaoName::export();
 758         }
 759       }
 760
 761       $doNotCopy = ['required', 'default'];
 762
 763       $fieldGroups = ['fields', 'filters', 'group_bys', 'order_bys'];
 764       foreach ($fieldGroups as $fieldGrp) {
 765         if (!empty($table[$fieldGrp]) && is_array($table[$fieldGrp])) {
 766           foreach ($table[$fieldGrp] as $fieldName => $field) {
 767             // $name is the field name used to reference the BAO/DAO export fields array
 768             $name = $field['name'] ?? $fieldName;
 769
 770             // Sometimes the field name key in the BAO/DAO export fields array is
 771             // different from the actual database field name.
 772             // Unset $field['name'] so that actual database field name can be obtained
 773             // from the BAO/DAO export fields array.
 774             unset($field['name']);
 775
 776             if (array_key_exists($name, $expFields)) {
 777               foreach ($doNotCopy as $dnc) {
 778                 // unset the values we don't want to be copied.
 779                 unset($expFields[$name][$dnc]);
 780               }
 781               if (empty($field)) {
 782                 $this->_columns[$tableName][$fieldGrp][$fieldName] = $expFields[$name];
 783               }
 784               else {
 785                 foreach ($expFields[$name] as $property => $val) {
 786                   if (!array_key_exists($property, $field)) {
 787                     $this->_columns[$tableName][$fieldGrp][$fieldName][$property] = $val;
 788                   }
 789                 }
 790               }
 791             }
 792
 793             // fill other vars
 794             if (!empty($field['no_repeat'])) {
 795               $this->_noRepeats[] = "{$tableName}_{$fieldName}";
 796             }
 797             if (!empty($field['no_display'])) {
 798               $this->_noDisplay[] = "{$tableName}_{$fieldName}";
 799             }
 800
 801             // set alias = table-name, unless already set
 802             $alias = $field['alias'] ?? (
 803               $this->_columns[$tableName]['alias'] ?? $tableName
 804             );
 805             $this->_columns[$tableName][$fieldGrp][$fieldName]['alias'] = $alias;
 806
 807             // set name = fieldName, unless already set
 808             if (!isset($this->_columns[$tableName][$fieldGrp][$fieldName]['name'])) {
 809               $this->_columns[$tableName][$fieldGrp][$fieldName]['name'] = $name;
 810             }
 811
 812             if (!isset($this->_columns[$tableName][$fieldGrp][$fieldName]['table_name'])) {
 813               $this->_columns[$tableName][$fieldGrp][$fieldName]['table_name'] = $tableName;
 814             }
 815
 816             // set dbAlias = alias.name, unless already set
 817             if (!isset($this->_columns[$tableName][$fieldGrp][$fieldName]['dbAlias'])) {
 818               $this->_columns[$tableName][$fieldGrp][$fieldName]['dbAlias']
 819                 = $alias . '.' .
 820                 $this->_columns[$tableName][$fieldGrp][$fieldName]['name'];
 821             }
 822
 823             // a few auto fills for filters
 824             if ($fieldGrp == 'filters') {
 825               // fill operator types
 826               if (!array_key_exists('operatorType', $this->_columns[$tableName][$fieldGrp][$fieldName])) {
 827                 switch (CRM_Utils_Array::value('type', $this->_columns[$tableName][$fieldGrp][$fieldName])) {
 828                   case CRM_Utils_Type::T_MONEY:
 829                   case CRM_Utils_Type::T_FLOAT:
 830                     $this->_columns[$tableName][$fieldGrp][$fieldName]['operatorType'] = CRM_Report_Form::OP_FLOAT;
 831                     break;
 832
 833                   case CRM_Utils_Type::T_INT:
 834                     $this->_columns[$tableName][$fieldGrp][$fieldName]['operatorType'] = CRM_Report_Form::OP_INT;
 835                     break;
 836
 837                   case CRM_Utils_Type::T_DATE:
 838                     $this->_columns[$tableName][$fieldGrp][$fieldName]['operatorType'] = CRM_Report_Form::OP_DATE;
 839                     break;
 840
 841                   case CRM_Utils_Type::T_BOOLEAN:
 842                     $this->_columns[$tableName][$fieldGrp][$fieldName]['operatorType'] = CRM_Report_Form::OP_SELECT;
 843                     if (!array_key_exists('options', $this->_columns[$tableName][$fieldGrp][$fieldName])) {
 844                       $this->_columns[$tableName][$fieldGrp][$fieldName]['options']
 845                         = [
 846                           '' => ts('Any'),
 847                           '0' => ts('No'),
 848                           '1' => ts('Yes'),
 849                         ];
 850                     }
 851                     break;
 852
 853                   default:
 854                     if ($daoOrBaoName &&
 855                       array_key_exists('pseudoconstant', $this->_columns[$tableName][$fieldGrp][$fieldName])
 856                     ) {
 857                       // with multiple options operator-type is generally multi-select
 858                       $this->_columns[$tableName][$fieldGrp][$fieldName]['operatorType'] = CRM_Report_Form::OP_MULTISELECT;
 859                       if (!array_key_exists('options', $this->_columns[$tableName][$fieldGrp][$fieldName])) {
 860                         // fill options
 861                         $this->_columns[$tableName][$fieldGrp][$fieldName]['options'] = CRM_Core_PseudoConstant::get($daoOrBaoName, $fieldName);
 862                       }
 863                     }
 864                     break;
 865                 }
 866               }
 867             }
 868             if (!isset($this->_columns[$tableName]['metadata'][$fieldName])) {
 869               $this->_columns[$tableName]['metadata'][$fieldName] = $this->_columns[$tableName][$fieldGrp][$fieldName];
 870             }
 871             else {
 872               $this->_columns[$tableName]['metadata'][$fieldName] = array_merge($this->_columns[$tableName][$fieldGrp][$fieldName], $this->_columns[$tableName]['metadata'][$fieldName]);
 873             }
 874           }
 875         }
 876       }
 877
 878       // copy filters to a separate handy variable
 879       if (array_key_exists('filters', $table)) {
 880         $this->_filters[$tableName] = $this->_columns[$tableName]['filters'];
 881       }
 882
 883       if (array_key_exists('group_bys', $table)) {
 884         $groupBys[$tableName] = $this->_columns[$tableName]['group_bys'];
 885       }
 886
 887       if (array_key_exists('fields', $table)) {
 888         $reportFields[$tableName] = $this->_columns[$tableName]['fields'];
 889       }
 890     }
 891
 892     if ($this->_force) {
 893       $this->setDefaultValues(FALSE);
 894     }
 895
 896     CRM_Report_Utils_Get::processFilter($this->_filters, $this->_defaults);
 897     CRM_Report_Utils_Get::processGroupBy($groupBys, $this->_defaults);
 898     CRM_Report_Utils_Get::processFields($reportFields, $this->_defaults);
 899     CRM_Report_Utils_Get::processChart($this->_defaults);
 900
 901     if ($this->_force) {
 902       $this->_formValues = $this->_defaults;
 903       $this->postProcess();
 904     }
 905   }
 906
 907   /**
 908    * Set default values.
 909    *
 910    * @param bool $freeze
 911    *
 912    * @return array
 913    */
 914   public function setDefaultValues($freeze = TRUE) {
 915     $freezeGroup = [];
 916
 917     // FIXME: generalizing form field naming conventions would reduce
 918     // Lots of lines below.
 919     foreach ($this->_columns as $tableName => $table) {
 920       if (array_key_exists('fields', $table)) {
 921         foreach ($table['fields'] as $fieldName => $field) {
 922           if (empty($field['no_display'])) {
 923             if (!empty($field['required'])) {
 924               // set default
 925               $this->_defaults['fields'][$fieldName] = 1;
 926
 927               if ($freeze) {
 928                 // find element object, so that we could use quickform's freeze method
 929                 // for required elements
 930                 $obj = $this->getElementFromGroup("fields", $fieldName);
 931                 if ($obj) {
 932                   $freezeGroup[] = $obj;
 933                 }
 934               }
 935             }
 936             elseif (isset($field['default'])) {
 937               $this->_defaults['fields'][$fieldName] = $field['default'];
 938             }
 939           }
 940         }
 941       }
 942
 943       if (array_key_exists('group_bys', $table)) {
 944         foreach ($table['group_bys'] as $fieldName => $field) {
 945           if (isset($field['default'])) {
 946             if (!empty($field['frequency'])) {
 947               $this->_defaults['group_bys_freq'][$fieldName] = 'MONTH';
 948             }
 949             $this->_defaults['group_bys'][$fieldName] = $field['default'];
 950           }
 951         }
 952       }
 953       if (array_key_exists('filters', $table)) {
 954         foreach ($table['filters'] as $fieldName => $field) {
 955           if (isset($field['default'])) {
 956             if (CRM_Utils_Array::value('type', $field) & CRM_Utils_Type::T_DATE
 957             ) {
 958               if (is_array($field['default'])) {
 959                 $this->_defaults["{$fieldName}_from"] = $field['default']['from'] ?? NULL;
 960                 $this->_defaults["{$fieldName}_to"] = $field['default']['to'] ?? NULL;
 961                 $this->_defaults["{$fieldName}_relative"] = 0;
 962               }
 963               else {
 964                 $this->_defaults["{$fieldName}_relative"] = $field['default'];
 965               }
 966             }
 967             else {
 968               if ((CRM_Utils_Array::value('type', $field) & CRM_Utils_Type::T_INT) && is_array($field['default'])) {
 969                 $this->_defaults["{$fieldName}_min"] = $field['default']['min'] ?? NULL;
 970                 $this->_defaults["{$fieldName}_max"] = $field['default']['max'] ?? NULL;
 971               }
 972               $this->_defaults["{$fieldName}_value"] = $field['default'];
 973             }
 974           }
 975           //assign default value as "in" for multiselect
 976           //operator, To freeze the select element
 977           if (CRM_Utils_Array::value('operatorType', $field) ==
 978             CRM_Report_Form::OP_MULTISELECT
 979           ) {
 980             $this->_defaults["{$fieldName}_op"] = 'in';
 981           }
 982           if (CRM_Utils_Array::value('operatorType', $field) ==
 983             CRM_Report_Form::OP_ENTITYREF
 984           ) {
 985             $this->_defaults["{$fieldName}_op"] = 'in';
 986           }
 987           elseif (CRM_Utils_Array::value('operatorType', $field) ==
 988             CRM_Report_Form::OP_MULTISELECT_SEPARATOR
 989           ) {
 990             $this->_defaults["{$fieldName}_op"] = 'mhas';
 991           }
 992           elseif ($op = CRM_Utils_Array::value('default_op', $field)) {
 993             $this->_defaults["{$fieldName}_op"] = $op;
 994           }
 995         }
 996       }
 997
 998       if (
 999         empty($this->_formValues['order_bys']) &&
1000         (array_key_exists('order_bys', $table) &&
1001         is_array($table['order_bys']))
1002       ) {
1003         if (!array_key_exists('order_bys', $this->_defaults)) {
1004           $this->_defaults['order_bys'] = [];
1005         }
1006         foreach ($table['order_bys'] as $fieldName => $field) {
1007           if (!empty($field['default']) || !empty($field['default_order']) ||
1008             CRM_Utils_Array::value('default_is_section', $field) ||
1009             !empty($field['default_weight'])
1010           ) {
1011             $order_by = [
1012               'column' => $fieldName,
1013               'order' => CRM_Utils_Array::value('default_order', $field, 'ASC'),
1014               'section' => CRM_Utils_Array::value('default_is_section', $field, 0),
1015             ];
1016
1017             if (!empty($field['default_weight'])) {
1018               $this->_defaults['order_bys'][(int) $field['default_weight']] = $order_by;
1019             }
1020             else {
1021               array_unshift($this->_defaults['order_bys'], $order_by);
1022             }
1023           }
1024         }
1025       }
1026
1027       foreach ($this->_options as $fieldName => $field) {
1028         if (isset($field['default'])) {
1029           $this->_defaults['options'][$fieldName] = $field['default'];
1030         }
1031       }
1032     }
1033
1034     if (!empty($this->_submitValues)) {
1035       $this->preProcessOrderBy($this->_submitValues);
1036     }
1037     else {
1038       $this->preProcessOrderBy($this->_defaults);
1039     }
1040
1041     // lets finish freezing task here itself
1042     if (!empty($freezeGroup)) {
1043       foreach ($freezeGroup as $elem) {
1044         $elem->freeze();
1045       }
1046     }
1047
1048     if ($this->_formValues) {
1049       $this->_defaults = array_merge($this->_defaults, $this->_formValues);
1050     }
1051
1052     if ($this->_instanceValues) {
1053       $this->_defaults = array_merge($this->_defaults, $this->_instanceValues);
1054     }
1055
1056     CRM_Report_Form_Instance::setDefaultValues($this, $this->_defaults);
1057
1058     return $this->_defaults;
1059   }
1060
1061   /**
1062    * Get element from group.
1063    *
1064    * @param string $group
1065    * @param string $grpFieldName
1066    *
1067    * @return bool
1068    */
1069   public function getElementFromGroup($group, $grpFieldName) {
1070     $eleObj = $this->getElement($group);
1071     foreach ($eleObj->_elements as $index => $obj) {
1072       if ($grpFieldName == $obj->_attributes['name']) {
1073         return $obj;
1074       }
1075     }
1076     return FALSE;
1077   }
1078
1079   /**
1080    * Setter for $_params.
1081    *
1082    * @param array $params
1083    */
1084   public function setParams($params) {
1085     $this->_params = $params;
1086   }
1087
1088   /**
1089    * Getter for $_params.
1090    *
1091    * @return void|array $params
1092    */
1093   public function getParams() {
1094     return $this->_params;
1095   }
1096
1097   /**
1098    * Setter for $_id.
1099    *
1100    * @param int $instanceID
1101    */
1102   public function setID($instanceID) {
1103     $this->_id = $instanceID;
1104   }
1105
1106   /**
1107    * Getter for $_id.
1108    *
1109    * @return int
1110    */
1111   public function getID() {
1112     return $this->_id;
1113   }
1114
1115   /**
1116    * Getter for _outputMode
1117    *
1118    * Note you can implement hook_civicrm_alterReportVar('actions', ...)
1119    * which indirectly allows setting _outputMode if the user chooses
1120    * your action.
1121    *
1122    * @return string
1123    */
1124   public function getOutputMode():string {
1125     return $this->_outputMode;
1126   }
1127
1128   /**
1129    * Getter for report header form field value
1130    *
1131    * @return string
1132    */
1133   public function getReportHeader():string {
1134     return $this->_formValues['report_header'] ?? '';
1135   }
1136
1137   /**
1138    * Getter for report footer form field value
1139    *
1140    * @return string
1141    */
1142   public function getReportFooter():string {
1143     return $this->_formValues['report_footer'] ?? '';
1144   }
1145
1146   /**
1147    * Setter for $_force.
1148    *
1149    * @param bool $isForce
1150    */
1151   public function setForce($isForce) {
1152     $this->_force = $isForce;
1153   }
1154
1155   /**
1156    * Setter for $_limitValue.
1157    *
1158    * @param int $_limitValue
1159    */
1160   public function setLimitValue($_limitValue) {
1161     $this->_limitValue = $_limitValue;
1162   }
1163
1164   /**
1165    * Setter for $_offsetValue.
1166    *
1167    * @param int $_offsetValue
1168    */
1169   public function setOffsetValue($_offsetValue) {
1170     $this->_offsetValue = $_offsetValue;
1171   }
1172
1173   /**
1174    * Setter for $addPaging.
1175    *
1176    * @param bool $value
1177    */
1178   public function setAddPaging($value) {
1179     $this->addPaging = $value;
1180   }
1181
1182   /**
1183    * Getter for $_defaultValues.
1184    *
1185    * @return array
1186    */
1187   public function getDefaultValues() {
1188     return $this->_defaults;
1189   }
1190
1191   /**
1192    * Remove any temporary tables.
1193    */
1194   public function cleanUpTemporaryTables() {
1195     foreach ($this->temporaryTables as $temporaryTable) {
1196       CRM_Core_DAO::executeQuery('DROP ' . ($temporaryTable['temporary'] ? 'TEMPORARY' : '') . ' TABLE IF EXISTS ' . $temporaryTable['name']);
1197     }
1198   }
1199
1200   /**
1201    * Create a temporary table.
1202    *
1203    * This function creates a table AND adds the details to the developer tab & $this->>temporary tables.
1204    *
1205    * @param string $identifier
1206    *   This is the key that will be used for the table in the temporaryTables property.
1207    * @param string $sql
1208    *   Sql select statement or column description (the latter requires the columns flag)
1209    * @param bool $isColumns
1210    *   Is the sql describing columns to create (rather than using a select query).
1211    * @param bool $isMemory
1212    *   Create a memory table rather than a normal INNODB table.
1213    *
1214    * @return string
1215    */
1216   public function createTemporaryTable($identifier, $sql, $isColumns = FALSE, $isMemory = FALSE) {
1217     $tempTable = CRM_Utils_SQL_TempTable::build();
1218     if ($isMemory) {
1219       $tempTable->setMemory();
1220     }
1221     if ($isColumns) {
1222       $tempTable->createWithColumns($sql);
1223     }
1224     else {
1225       $tempTable->createWithQuery($sql);
1226     }
1227     $name = $tempTable->getName();
1228     // Developers may force tables to be durable to assist in debugging so lets check.
1229     $isNotTrueTemporary = $tempTable->isDurable();
1230     $this->addToDeveloperTab($tempTable->getCreateSql());
1231     $this->temporaryTables[$identifier] = ['temporary' => !$isNotTrueTemporary, 'name' => $name];
1232     return $name;
1233   }
1234
1235   /**
1236    * Add columns to report.
1237    */
1238   public function addColumns() {
1239     $options = [];
1240     $colGroups = NULL;
1241     foreach ($this->_columns as $tableName => $table) {
1242       if (array_key_exists('fields', $table)) {
1243         foreach ($table['fields'] as $fieldName => $field) {
1244           $groupTitle = '';
1245           if (empty($field['no_display'])) {
1246             foreach (['table', 'field'] as $var) {
1247               if (!empty(${$var}['grouping'])) {
1248                 if (!is_array(${$var}['grouping'])) {
1249                   $tableName = ${$var}['grouping'];
1250                 }
1251                 else {
1252                   $tableName = array_keys(${$var}['grouping']);
1253                   $tableName = $tableName[0];
1254                   $groupTitle = array_values(${$var}['grouping']);
1255                   $groupTitle = $groupTitle[0];
1256                 }
1257               }
1258             }
1259
1260             if (!$groupTitle && isset($table['group_title'])) {
1261               $groupTitle = $table['group_title'];
1262               // Having a group_title is secret code for being a custom group
1263               // which cryptically translates to needing an accordion.
1264               // here we make that explicit.
1265               $colGroups[$tableName]['use_accordian_for_field_selection'] = TRUE;
1266             }
1267
1268             $colGroups[$tableName]['fields'][$fieldName] = $field['title'] ?? NULL;
1269             if ($groupTitle && empty($colGroups[$tableName]['group_title'])) {
1270               $colGroups[$tableName]['group_title'] = $groupTitle;
1271             }
1272             $options[$fieldName] = $field['title'] ?? NULL;
1273           }
1274         }
1275       }
1276     }
1277
1278     $this->addCheckBox("fields", ts('Select Columns'), $options, NULL,
1279       NULL, NULL, NULL, $this->_fourColumnAttribute, TRUE
1280     );
1281     if (!empty($colGroups)) {
1282       $this->tabs['FieldSelection'] = [
1283         'title' => ts('Columns'),
1284         'tpl' => 'FieldSelection',
1285         'div_label' => 'col-groups',
1286       ];
1287
1288       // Note this assignment is only really required in buildForm. It is being 'over-called'
1289       // to reduce risk of being missed due to overridden functions.
1290       $this->assign('tabs', $this->tabs);
1291     }
1292
1293     $this->assign('colGroups', $colGroups);
1294   }
1295
1296   /**
1297    * Add filters to report.
1298    */
1299   public function addFilters() {
1300     $filters = $filterGroups = [];
1301     $count = 1;
1302
1303     foreach ($this->_filters as $table => $attributes) {
1304       if (isset($this->_columns[$table]['group_title'])) {
1305         // The presence of 'group_title' is secret code for 'is_a_custom_table'
1306         // which magically means to 'display in an accordian'
1307         // here we make this explicit.
1308         $filterGroups[$table] = [
1309           'group_title' => $this->_columns[$table]['group_title'],
1310           'use_accordian_for_field_selection' => TRUE,
1311
1312         ];
1313       }
1314       foreach ($attributes as $fieldName => $field) {
1315         // get ready with option value pair
1316         // @ 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
1317         // would be useful
1318         $operations = $this->getOperationPair(
1319           CRM_Utils_Array::value('operatorType', $field),
1320           $fieldName);
1321
1322         $filters[$table][$fieldName] = $field;
1323
1324         switch (CRM_Utils_Array::value('operatorType', $field)) {
1325           case CRM_Report_Form::OP_MONTH:
1326             if (!array_key_exists('options', $field) ||
1327               !is_array($field['options']) || empty($field['options'])
1328             ) {
1329               // If there's no option list for this filter, define one.
1330               $field['options'] = [
1331                 1 => ts('January'),
1332                 2 => ts('February'),
1333                 3 => ts('March'),
1334                 4 => ts('April'),
1335                 5 => ts('May'),
1336                 6 => ts('June'),
1337                 7 => ts('July'),
1338                 8 => ts('August'),
1339                 9 => ts('September'),
1340                 10 => ts('October'),
1341                 11 => ts('November'),
1342                 12 => ts('December'),
1343               ];
1344               // Add this option list to this column _columns. This is
1345               // required so that filter statistics show properly.
1346               $this->_columns[$table]['filters'][$fieldName]['options'] = $field['options'];
1347             }
1348           case CRM_Report_Form::OP_MULTISELECT:
1349           case CRM_Report_Form::OP_MULTISELECT_SEPARATOR:
1350             // assume a multi-select field
1351             if (!empty($field['options']) ||
1352               $fieldName == 'state_province_id' || $fieldName == 'county_id'
1353             ) {
1354               $element = $this->addElement('select', "{$fieldName}_op", ts('Operator:'), $operations,
1355                 array('onchange' => "return showHideMaxMinVal( '$fieldName', this.value );")
1356               );
1357
1358               if (count($operations) <= 1) {
1359                 $element->freeze();
1360               }
1361               if ($fieldName == 'state_province_id' ||
1362                 $fieldName == 'county_id'
1363               ) {
1364                 $this->addChainSelect($fieldName . '_value', [
1365                   'multiple' => TRUE,
1366                   'label' => NULL,
1367                   'class' => 'huge',
1368                 ]);
1369               }
1370               else {
1371                 $this->addElement('select', "{$fieldName}_value", NULL, $field['options'], [
1372                   'style' => 'min-width:250px',
1373                   'class' => 'crm-select2 huge',
1374                   'multiple' => TRUE,
1375                   'placeholder' => ts('- select -'),
1376                 ]);
1377               }
1378             }
1379             break;
1380
1381           case CRM_Report_Form::OP_SELECT:
1382             // assume a select field
1383             $this->addElement('select', "{$fieldName}_op", ts('Operator:'), $operations);
1384             if (!empty($field['options'])) {
1385               $this->addElement('select', "{$fieldName}_value", NULL, $field['options']);
1386             }
1387             break;
1388
1389           case CRM_Report_Form::OP_ENTITYREF:
1390             $this->addElement('select', "{$fieldName}_op", ts('Operator:'), $operations);
1391             $this->setEntityRefDefaults($field, $table);
1392             $this->addEntityRef("{$fieldName}_value", NULL, $field['attributes']);
1393             break;
1394
1395           case CRM_Report_Form::OP_DATE:
1396             // build datetime fields
1397             $this->addDatePickerRange($fieldName, $field['title'], FALSE, FALSE, 'From', 'To', $operations, '_to', '_from');
1398             break;
1399
1400           case CRM_Report_Form::OP_DATETIME:
1401             // build datetime fields
1402             $this->addDatePickerRange($fieldName, $field['title'], TRUE, FALSE, 'From', 'To', $operations, '_to', '_from');
1403             break;
1404
1405           case CRM_Report_Form::OP_INT:
1406           case CRM_Report_Form::OP_FLOAT:
1407             // and a min value input box
1408             $this->add('text', "{$fieldName}_min", ts('Min'));
1409             // and a max value input box
1410             $this->add('text', "{$fieldName}_max", ts('Max'));
1411           default:
1412             // default type is string
1413             $this->addElement('select', "{$fieldName}_op", ts('Operator:'), $operations,
1414               ['onchange' => "return showHideMaxMinVal( '$fieldName', this.value );"]
1415             );
1416             // we need text box for value input
1417             $this->add('text', "{$fieldName}_value", NULL, ['class' => 'huge']);
1418             break;
1419         }
1420       }
1421     }
1422     if (!empty($filters)) {
1423       $this->tabs['Filters'] = [
1424         'title' => ts('Filters'),
1425         'tpl' => 'Filters',
1426         'div_label' => 'set-filters',
1427       ];
1428     }
1429     $this->assign('filters', $filters);
1430     $this->assign('filterGroups', $filterGroups);
1431   }
1432
1433   /**
1434    * Function to assign the tabs to the template in the correct order.
1435    *
1436    * We want the tabs to wind up in this order (if not overridden).
1437    *
1438    *   - Field Selection
1439    *   - Group Bys
1440    *   - Order Bys
1441    *   - Other Options
1442    *   - Filters
1443    */
1444   protected function assignTabs() {
1445     $order = [
1446       'FieldSelection',
1447       'GroupBy',
1448       'OrderBy',
1449       'ReportOptions',
1450       'Filters',
1451     ];
1452     $order = array_intersect_key(array_fill_keys($order, 1), $this->tabs);
1453     $order = array_merge($order, $this->tabs);
1454     $this->assign('tabs', $order);
1455   }
1456
1457   /**
1458    * The intent is to add a tab for developers to view the sql.
1459    *
1460    * Currently using dpm.
1461    *
1462    * @param string $sql
1463    */
1464   public function addToDeveloperTab($sql) {
1465     if (!CRM_Core_Permission::check('view report sql')) {
1466       return;
1467     }
1468     $ignored_output_modes = ['pdf', 'csv', 'print'];
1469     if (in_array($this->_outputMode, $ignored_output_modes)) {
1470       return;
1471     }
1472     $this->tabs['Developer'] = [
1473       'title' => ts('Developer'),
1474       'tpl' => 'Developer',
1475       'div_label' => 'set-developer',
1476     ];
1477
1478     $this->assignTabs();
1479     $this->sqlFormattedArray = [];
1480     $this->sqlArray[] = $sql;
1481     foreach ($this->sqlArray as $sql) {
1482       foreach (['LEFT JOIN'] as $term) {
1483         $sql = str_replace($term, '<br>  ' . $term, $sql);
1484       }
1485       foreach (['FROM', 'WHERE', 'GROUP BY', 'ORDER BY', 'LIMIT', ';'] as $term) {
1486         $sql = str_replace($term, '<br><br>' . $term, $sql);
1487       }
1488       $this->sqlFormattedArray[] = $sql;
1489       $this->assign('sql', implode(';<br><br><br><br>', $this->sqlFormattedArray));
1490     }
1491     $this->assign('sqlModes', $sqlModes = CRM_Utils_SQL::getSqlModes());
1492
1493   }
1494
1495   /**
1496    * Add options defined in $this->_options to the report.
1497    */
1498   public function addOptions() {
1499     if (!empty($this->_options)) {
1500       // FIXME: For now lets build all elements as checkboxes.
1501       // Once we clear with the format we can build elements based on type
1502
1503       foreach ($this->_options as $fieldName => $field) {
1504         $options = [];
1505
1506         if ($field['type'] == 'select') {
1507           $this->addElement('select', "{$fieldName}", $field['title'], $field['options']);
1508         }
1509         elseif ($field['type'] == 'checkbox') {
1510           $options[$field['title']] = $fieldName;
1511           $this->addCheckBox($fieldName, NULL,
1512             $options, NULL,
1513             NULL, NULL, NULL, $this->_fourColumnAttribute
1514           );
1515         }
1516       }
1517     }
1518     if (!empty($this->_options) &&
1519         (!$this->_id
1520           || ($this->_id && CRM_Report_BAO_ReportInstance::contactCanAdministerReport($this->_id)))
1521     ) {
1522       $this->tabs['ReportOptions'] = [
1523         'title' => ts('Display Options'),
1524         'tpl' => 'ReportOptions',
1525         'div_label' => 'other-options',
1526       ];
1527     }
1528     $this->assign('otherOptions', $this->_options);
1529   }
1530
1531   /**
1532    * Add chart options to the report.
1533    */
1534   public function addChartOptions() {
1535     if (!empty($this->_charts)) {
1536       $this->addElement('select', "charts", ts('Chart'), $this->_charts);
1537       $this->assign('charts', $this->_charts);
1538       $this->addElement('submit', $this->_chartButtonName, ts('View'));
1539     }
1540   }
1541
1542   /**
1543    * Add group by options to the report.
1544    */
1545   public function addGroupBys() {
1546     $options = $freqElements = [];
1547
1548     foreach ($this->_columns as $tableName => $table) {
1549       if (array_key_exists('group_bys', $table)) {
1550         foreach ($table['group_bys'] as $fieldName => $field) {
1551           if (!empty($field) && empty($field['no_display'])) {
1552             $options[$field['title']] = $fieldName;
1553             if (!empty($field['frequency'])) {
1554               $freqElements[$field['title']] = $fieldName;
1555             }
1556           }
1557         }
1558       }
1559     }
1560     $this->addCheckBox("group_bys", ts('Group by columns'), $options, NULL,
1561       NULL, NULL, NULL, $this->_fourColumnAttribute
1562     );
1563     $this->assign('groupByElements', $options);
1564     if (!empty($options)) {
1565       $this->tabs['GroupBy'] = [
1566         'title' => ts('Grouping'),
1567         'tpl' => 'GroupBy',
1568         'div_label' => 'group-by-elements',
1569       ];
1570     }
1571
1572     foreach ($freqElements as $name) {
1573       $this->addElement('select', "group_bys_freq[$name]",
1574         ts('Frequency'), $this->_groupByDateFreq
1575       );
1576     }
1577   }
1578
1579   /**
1580    * Add data for order by tab.
1581    */
1582   public function addOrderBys() {
1583     $options = [];
1584     foreach ($this->_columns as $tableName => $table) {
1585
1586       // Report developer may define any column to order by; include these as order-by options.
1587       if (array_key_exists('order_bys', $table)) {
1588         foreach ($table['order_bys'] as $fieldName => $field) {
1589           if (!empty($field)) {
1590             $options[$fieldName] = $field['title'];
1591           }
1592         }
1593       }
1594
1595       // Add searchable custom fields as order-by options, if so requested
1596       // (These are already indexed, so allowing to order on them is cheap.)
1597
1598       if ($this->_autoIncludeIndexedFieldsAsOrderBys &&
1599         array_key_exists('extends', $table) && !empty($table['extends'])
1600       ) {
1601         foreach ($table['fields'] as $fieldName => $field) {
1602           if (empty($field['no_display'])) {
1603             $options[$fieldName] = $field['title'];
1604           }
1605         }
1606       }
1607     }
1608
1609     asort($options);
1610
1611     $this->assign('orderByOptions', $options);
1612     if (!empty($options)) {
1613       $this->tabs['OrderBy'] = [
1614         'title' => ts('Sorting'),
1615         'tpl' => 'OrderBy',
1616         'div_label' => 'order-by-elements',
1617       ];
1618     }
1619
1620     if (!empty($options)) {
1621       $options = [
1622         '-' => ' - none - ',
1623       ] + $options;
1624       for ($i = 1; $i <= 5; $i++) {
1625         $this->addElement('select', "order_bys[{$i}][column]", ts('Order by Column'), $options);
1626         $this->addElement('select', "order_bys[{$i}][order]", ts('Order by Order'), [
1627           'ASC' => ts('Ascending'),
1628           'DESC' => ts('Descending'),
1629         ]);
1630         $this->addElement('checkbox', "order_bys[{$i}][section]", ts('Order by Section'), FALSE, ['id' => "order_by_section_$i"]);
1631         $this->addElement('checkbox', "order_bys[{$i}][pageBreak]", ts('Page Break'), FALSE, ['id' => "order_by_pagebreak_$i"]);
1632       }
1633     }
1634   }
1635
1636   /**
1637    * This adds the tab referred to as Title and Format, rendered through Instance.tpl.
1638    *
1639    * @todo call this tab into the report template in the same way as OrderBy etc, ie
1640    * by adding a description of the tab to $this->tabs, causing the tab to be added in
1641    * Criteria.tpl.
1642    */
1643   public function buildInstanceAndButtons() {
1644     CRM_Report_Form_Instance::buildForm($this);
1645     $this->_actionButtonName = $this->getButtonName('submit');
1646     $this->addTaskMenu($this->getActions($this->_id));
1647
1648     $this->assign('instanceForm', $this->_instanceForm);
1649
1650     // CRM-16274 Determine if user has 'edit all contacts' or equivalent
1651     $permission = CRM_Core_Permission::getPermission();
1652     if ($this->_instanceForm && $permission == CRM_Core_Permission::EDIT &&
1653       $this->_add2groupSupported
1654     ) {
1655       $this->addElement('select', 'groups', ts('Group'),
1656         ['' => ts('Add Contacts to Group')] +
1657         CRM_Core_PseudoConstant::nestedGroup(),
1658         ['class' => 'crm-select2 crm-action-menu fa-plus huge']
1659       );
1660       $this->assign('group', TRUE);
1661     }
1662
1663     $this->addElement('submit', $this->_groupButtonName, '', ['style' => 'display: none;']);
1664
1665     $this->addChartOptions();
1666     $showResultsLabel = $this->getResultsLabel();
1667     $this->addButtons([
1668         [
1669           'type' => 'submit',
1670           'name' => $showResultsLabel,
1671           'isDefault' => TRUE,
1672         ],
1673     ]);
1674   }
1675
1676   /**
1677    * Has this form been submitted already?
1678    *
1679    * @return bool
1680    */
1681   public function resultsDisplayed() {
1682     $buttonName = $this->controller->getButtonName();
1683     return ($buttonName || $this->_outputMode);
1684   }
1685
1686   /**
1687    * Get the actions for this report instance.
1688    *
1689    * @param int $instanceId
1690    *
1691    * @return array
1692    */
1693   protected function getActions($instanceId) {
1694     $actions = CRM_Report_BAO_ReportInstance::getActionMetadata();
1695     if (empty($instanceId)) {
1696       $actions['report_instance.save'] = [
1697         'title' => ts('Create Report'),
1698         'data' => [
1699           'is_confirm' => TRUE,
1700           'confirm_title' => ts('Create Report'),
1701           'confirm_refresh_fields' => json_encode([
1702             'title' => ['selector' => '.crm-report-instanceForm-form-block-title', 'prepend' => ''],
1703             'description' => ['selector' => '.crm-report-instanceForm-form-block-description', 'prepend' => ''],
1704           ]),
1705         ],
1706       ];
1707       unset($actions['report_instance.delete']);
1708     }
1709
1710     if (!$this->_csvSupported) {
1711       unset($actions['report_instance.csv']);
1712     }
1713
1714     CRM_Utils_Hook::alterReportVar('actions', $actions, $this);
1715
1716     return $actions;
1717   }
1718
1719   /**
1720    * Main build form function.
1721    */
1722   public function buildQuickForm() {
1723     $this->addColumns();
1724
1725     $this->addFilters();
1726
1727     $this->addOptions();
1728
1729     $this->addGroupBys();
1730
1731     $this->addOrderBys();
1732
1733     $this->buildInstanceAndButtons();
1734
1735     // Add form rule for report.
1736     if (is_callable([
1737       $this,
1738       'formRule',
1739     ])) {
1740       $this->addFormRule([get_class($this), 'formRule'], $this);
1741     }
1742     $this->assignTabs();
1743   }
1744
1745   /**
1746    * A form rule function for custom data.
1747    *
1748    * The rule ensures that fields selected in group_by if any) should only be the ones
1749    * present in display/select fields criteria;
1750    * note: works if and only if any custom field selected in group_by.
1751    *
1752    * @param array $fields
1753    * @param array $ignoreFields
1754    *
1755    * @return array
1756    */
1757   public function customDataFormRule($fields, $ignoreFields = []) {
1758     $errors = [];
1759     if (!empty($this->_customGroupExtends) && $this->_customGroupGroupBy &&
1760       !empty($fields['group_bys'])
1761     ) {
1762       foreach ($this->_columns as $tableName => $table) {
1763         if ((substr($tableName, 0, 13) == 'civicrm_value' ||
1764             substr($tableName, 0, 12) == 'custom_value') &&
1765           !empty($this->_columns[$tableName]['fields'])
1766         ) {
1767           foreach ($this->_columns[$tableName]['fields'] as $fieldName => $field) {
1768             if (array_key_exists($fieldName, $fields['group_bys']) &&
1769               !array_key_exists($fieldName, $fields['fields'])
1770             ) {
1771               $errors['fields'] = "Please make sure fields selected in 'Group by Columns' section are also selected in 'Display Columns' section.";
1772             }
1773             elseif (array_key_exists($fieldName, $fields['group_bys'])) {
1774               foreach ($fields['fields'] as $fld => $val) {
1775                 if (!array_key_exists($fld, $fields['group_bys']) &&
1776                   !in_array($fld, $ignoreFields)
1777                 ) {
1778                   $errors['fields'] = "Please ensure that fields selected in 'Display Columns' are also selected in 'Group by Columns' section.";
1779                 }
1780               }
1781             }
1782           }
1783         }
1784       }
1785     }
1786     return $errors;
1787   }
1788
1789   /**
1790    * Get operators to display on form.
1791    *
1792    * Note: $fieldName param allows inheriting class to build operationPairs specific to a field.
1793    *
1794    * @param string $type
1795    * @param string $fieldName
1796    *
1797    * @return array
1798    */
1799   public function getOperationPair($type = "string", $fieldName = NULL) {
1800     // FIXME: At some point we should move these key-val pairs
1801     // to option_group and option_value table.
1802     switch ($type) {
1803       case CRM_Report_Form::OP_INT:
1804       case CRM_Report_Form::OP_FLOAT:
1805
1806         $result = [
1807           'lte' => ts('Is less than or equal to'),
1808           'gte' => ts('Is greater than or equal to'),
1809           'bw' => ts('Is between'),
1810           'eq' => ts('Is equal to'),
1811           'lt' => ts('Is less than'),
1812           'gt' => ts('Is greater than'),
1813           'neq' => ts('Is not equal to'),
1814           'nbw' => ts('Is not between'),
1815           'nll' => ts('Is empty (Null)'),
1816           'nnll' => ts('Is not empty (Null)'),
1817         ];
1818         return $result;
1819
1820       case CRM_Report_Form::OP_SELECT:
1821         $result = [
1822           'eq' => ts('Is equal to'),
1823         ];
1824         return $result;
1825
1826       case CRM_Report_Form::OP_MONTH:
1827       case CRM_Report_Form::OP_MULTISELECT:
1828       case CRM_Report_Form::OP_ENTITYREF:
1829
1830         $result = [
1831           'in' => ts('Is one of'),
1832           'notin' => ts('Is not one of'),
1833           'nll' => ts('Is empty (Null)'),
1834           'nnll' => ts('Is not empty (Null)'),
1835         ];
1836         return $result;
1837
1838       case CRM_Report_Form::OP_DATE:
1839
1840         $result = [
1841           'nll' => ts('Is empty (Null)'),
1842           'nnll' => ts('Is not empty (Null)'),
1843         ];
1844         return $result;
1845
1846       case CRM_Report_Form::OP_MULTISELECT_SEPARATOR:
1847         // use this operator for the values, concatenated with separator. For e.g if
1848         // multiple options for a column is stored as ^A{val1}^A{val2}^A
1849         $result = [
1850           'mhas' => ts('Is one of'),
1851           'mnot' => ts('Is not one of'),
1852         ];
1853         return $result;
1854
1855       default:
1856         // type is string
1857         $result = [
1858           'has' => ts('Contains'),
1859           'sw' => ts('Starts with'),
1860           'ew' => ts('Ends with'),
1861           'nhas' => ts('Does not contain'),
1862           'eq' => ts('Is equal to'),
1863           'neq' => ts('Is not equal to'),
1864           'nll' => ts('Is empty (Null)'),
1865           'nnll' => ts('Is not empty (Null)'),
1866         ];
1867         return $result;
1868     }
1869   }
1870
1871   /**
1872    * Build the tag filter field to display on the filters tab.
1873    */
1874   public function buildTagFilter() {
1875     $contactTags = CRM_Core_BAO_Tag::getTags($this->_tagFilterTable);
1876     if (!empty($contactTags)) {
1877       $this->_columns['civicrm_tag'] = [
1878         'dao' => 'CRM_Core_DAO_Tag',
1879         'filters' => [
1880           'tagid' => [
1881             'name' => 'tag_id',
1882             'title' => ts('Tag'),
1883             'type' => CRM_Utils_Type::T_INT,
1884             'tag' => TRUE,
1885             'operatorType' => CRM_Report_Form::OP_MULTISELECT,
1886             'options' => $contactTags,
1887           ],
1888         ],
1889       ];
1890     }
1891   }
1892
1893   /**
1894    * Adds group filters to _columns (called from _Construct).
1895    */
1896   public function buildGroupFilter() {
1897     $this->_columns['civicrm_group']['filters'] = [
1898       'gid' => [
1899         'name' => 'group_id',
1900         'title' => ts('Group'),
1901         'type' => CRM_Utils_Type::T_INT,
1902         'operatorType' => CRM_Report_Form::OP_MULTISELECT,
1903         'group' => TRUE,
1904         'options' => CRM_Core_PseudoConstant::nestedGroup(),
1905       ],
1906     ];
1907     if (empty($this->_columns['civicrm_group']['dao'])) {
1908       $this->_columns['civicrm_group']['dao'] = 'CRM_Contact_DAO_GroupContact';
1909     }
1910     if (empty($this->_columns['civicrm_group']['alias'])) {
1911       $this->_columns['civicrm_group']['alias'] = 'cgroup';
1912     }
1913   }
1914
1915   /**
1916    * Get SQL operator from form text version.
1917    *
1918    * @param string $operator
1919    *
1920    * @return string
1921    */
1922   public function getSQLOperator($operator = "like") {
1923     switch ($operator) {
1924       case 'eq':
1925         return '=';
1926
1927       case 'lt':
1928         return '<';
1929
1930       case 'lte':
1931         return '<=';
1932
1933       case 'gt':
1934         return '>';
1935
1936       case 'gte':
1937         return '>=';
1938
1939       case 'ne':
1940       case 'neq':
1941         return '!=';
1942
1943       case 'nhas':
1944         return 'NOT LIKE';
1945
1946       case 'in':
1947         return 'IN';
1948
1949       case 'notin':
1950         return 'NOT IN';
1951
1952       case 'nll':
1953         return 'IS NULL';
1954
1955       case 'nnll':
1956         return 'IS NOT NULL';
1957
1958       default:
1959         // type is string
1960         return 'LIKE';
1961     }
1962   }
1963
1964   /**
1965    * Generate where clause.
1966    *
1967    * This can be overridden in reports for special treatment of a field
1968    *
1969    * @param array $field Field specifications
1970    * @param string $op Query operator (not an exact match to sql)
1971    * @param mixed $value
1972    * @param float $min
1973    * @param float $max
1974    *
1975    * @return null|string
1976    */
1977   public function whereClause(&$field, $op, $value, $min, $max) {
1978
1979     $type = CRM_Utils_Type::typeToString(CRM_Utils_Array::value('type', $field));
1980
1981     // CRM-18010: Ensure type of each report filters
1982     if (!$type) {
1983       trigger_error('Type is not defined for field ' . $field['name'], E_USER_WARNING);
1984     }
1985     $clause = NULL;
1986
1987     switch ($op) {
1988       case 'bw':
1989       case 'nbw':
1990         if (($min !== NULL && strlen($min) > 0) ||
1991           ($max !== NULL && strlen($max) > 0)
1992         ) {
1993           $clauses = [];
1994           if ($min) {
1995             $min = CRM_Utils_Type::escape($min, $type);
1996             if ($op == 'bw') {
1997               $clauses[] = "( {$field['dbAlias']} >= $min )";
1998             }
1999             else {
2000               $clauses[] = "( {$field['dbAlias']} < $min OR {$field['dbAlias']} IS NULL )";
2001             }
2002           }
2003           if ($max) {
2004             $max = CRM_Utils_Type::escape($max, $type);
2005             if ($op == 'bw') {
2006               $clauses[] = "( {$field['dbAlias']} <= $max )";
2007             }
2008             else {
2009               $clauses[] = "( {$field['dbAlias']} > $max )";
2010             }
2011           }
2012
2013           if (!empty($clauses)) {
2014             if ($op == 'bw') {
2015               $clause = implode(' AND ', $clauses);
2016             }
2017             else {
2018               $clause = '(' . implode('OR', $clauses) . ')';
2019             }
2020           }
2021         }
2022         break;
2023
2024       case 'has':
2025       case 'nhas':
2026         if ($value !== NULL && strlen($value) > 0) {
2027           $value = CRM_Utils_Type::escape($value, $type);
2028           if (strpos($value, '%') === FALSE) {
2029             $value = "'%{$value}%'";
2030           }
2031           else {
2032             $value = "'{$value}'";
2033           }
2034           $sqlOP = $this->getSQLOperator($op);
2035           $clause = "( {$field['dbAlias']} $sqlOP $value )";
2036         }
2037         break;
2038
2039       case 'in':
2040       case 'notin':
2041         if ((is_string($value) || is_numeric($value)) && strlen($value)) {
2042           $value = explode(',', $value);
2043         }
2044         if ($value !== NULL && is_array($value) && count($value) > 0) {
2045           $sqlOP = $this->getSQLOperator($op);
2046           if (CRM_Utils_Array::value('type', $field) ==
2047             CRM_Utils_Type::T_STRING
2048           ) {
2049             //cycle through selections and escape values
2050             foreach ($value as $key => $selection) {
2051               $value[$key] = CRM_Utils_Type::escape($selection, $type);
2052             }
2053             $clause
2054               = "( {$field['dbAlias']} $sqlOP ( '" . implode("' , '", $value) .
2055               "') )";
2056           }
2057           else {
2058             // for numerical values
2059             $clause = "{$field['dbAlias']} $sqlOP (" . implode(', ', $value) .
2060               ")";
2061           }
2062           if ($op == 'notin') {
2063             $clause = "( " . $clause . " OR {$field['dbAlias']} IS NULL )";
2064           }
2065           else {
2066             $clause = "( " . $clause . " )";
2067           }
2068         }
2069         break;
2070
2071       case 'mhas':
2072       case 'mnot':
2073         // multiple has or multiple not
2074         if ($value !== NULL && count($value) > 0) {
2075           $value = CRM_Utils_Type::escapeAll($value, $type);
2076           $operator = $op == 'mnot' ? 'NOT' : '';
2077           $regexp = "([[:cntrl:]]|^)" . implode('([[:cntrl:]]|$)|([[:cntrl:]]|^)', (array) $value) . "([[:cntrl:]]|$)";
2078           $clause = "{$field['dbAlias']} {$operator} REGEXP '{$regexp}'";
2079         }
2080         break;
2081
2082       case 'sw':
2083       case 'ew':
2084         if ($value !== NULL && strlen($value) > 0) {
2085           $value = CRM_Utils_Type::escape($value, $type);
2086           if (strpos($value, '%') === FALSE) {
2087             if ($op == 'sw') {
2088               $value = "'{$value}%'";
2089             }
2090             else {
2091               $value = "'%{$value}'";
2092             }
2093           }
2094           else {
2095             $value = "'{$value}'";
2096           }
2097           $sqlOP = $this->getSQLOperator($op);
2098           $clause = "( {$field['dbAlias']} $sqlOP $value )";
2099         }
2100         break;
2101
2102       case 'nll':
2103       case 'nnll':
2104         $sqlOP = $this->getSQLOperator($op);
2105         $clause = "( {$field['dbAlias']} $sqlOP )";
2106         break;
2107
2108       case 'eq':
2109       case 'neq':
2110       case 'ne':
2111         //CRM-18457: some custom field passes value in array format against binary operator
2112         if (is_array($value) && count($value)) {
2113           $value = $value[0];
2114         }
2115
2116       default:
2117         if ($value !== NULL && $value !== '') {
2118           if (isset($field['clause'])) {
2119             // FIXME: we not doing escape here. Better solution is to use two
2120             // different types - data-type and filter-type
2121             $clause = $field['clause'];
2122           }
2123           elseif (!is_array($value)) {
2124             $value = CRM_Utils_Type::escape($value, $type);
2125             $sqlOP = $this->getSQLOperator($op);
2126             if ($field['type'] == CRM_Utils_Type::T_STRING) {
2127               $value = "'{$value}'";
2128             }
2129             $clause = "( {$field['dbAlias']} $sqlOP $value )";
2130           }
2131         }
2132         break;
2133     }
2134
2135     //dev/core/544 Add report support for multiple contact subTypes
2136     if ($field['name'] == 'contact_sub_type' && $clause) {
2137       $clause = $this->whereSubtypeClause($field, $value, $op);
2138     }
2139     if (!empty($field['group']) && $clause) {
2140       $clause = $this->whereGroupClause($field, $value, $op);
2141     }
2142     elseif (!empty($field['tag']) && $clause) {
2143       // not using left join in query because if any contact
2144       // belongs to more than one tag, results duplicate
2145       // entries.
2146       $clause = $this->whereTagClause($field, $value, $op);
2147     }
2148     elseif (!empty($field['membership_org']) && $clause) {
2149       $clause = $this->whereMembershipOrgClause($value, $op);
2150     }
2151     elseif (!empty($field['membership_type']) && $clause) {
2152       $clause = $this->whereMembershipTypeClause($value, $op);
2153     }
2154     return $clause;
2155   }
2156
2157   /**
2158    * Get SQL where clause for contact subtypes
2159    * @param string $field
2160    * @param mixed $value
2161    * @param string $op SQL Operator
2162    *
2163    * @return string
2164    */
2165   public function whereSubtypeClause($field, $value, $op) {
2166     // Get the correct SQL operator.
2167     $orNull = FALSE;
2168     switch ($op) {
2169       case 'notin':
2170         $op = 'nhas';
2171         $clauseSeparator = ' AND ';
2172         $orNull = TRUE;
2173         break;
2174
2175       case 'in':
2176         $op = 'has';
2177         $clauseSeparator = ' OR ';
2178         break;
2179     }
2180     $sqlOp = $this->getSQLOperator($op);
2181     if ($sqlOp == 'IS NULL' || $sqlOp == 'IS NOT NULL') {
2182       $clause = "{$field['dbAlias']} $sqlOp";
2183     }
2184     else {
2185       $subclauses = [];
2186       foreach ($value as $item) {
2187         $subclauses[] = "( {$field['dbAlias']} $sqlOp '%" . CRM_Core_DAO::VALUE_SEPARATOR . $item . CRM_Core_DAO::VALUE_SEPARATOR . "%' )";
2188       }
2189       $clause = implode($clauseSeparator, $subclauses);
2190     }
2191     $clause = "( $clause )";
2192     if ($orNull) {
2193       $clause = "( ( {$field['dbAlias']} IS NULL ) OR $clause )";
2194     }
2195     return $clause;
2196   }
2197
2198   /**
2199    * Get SQL where clause for a date field.
2200    *
2201    * @param string $fieldName
2202    * @param string $relative
2203    * @param string $from
2204    * @param string $to
2205    * @param string $type
2206    * @param string $fromTime
2207    * @param string $toTime
2208    *
2209    * @return null|string
2210    */
2211   public function dateClause(
2212     $fieldName,
2213     $relative, $from, $to, $type = NULL, $fromTime = NULL, $toTime = NULL
2214   ) {
2215     $clauses = [];
2216     if (in_array($relative, array_keys($this->getOperationPair(CRM_Report_Form::OP_DATE)))) {
2217       $sqlOP = $this->getSQLOperator($relative);
2218       return "( {$fieldName} {$sqlOP} )";
2219     }
2220     if (strlen($to) === 10) {
2221       // If we just have the date we assume the end of that day.
2222       $to .= ' 23:59:59';
2223     }
2224
2225     if ($relative) {
2226       list($from, $to) = $this->getFromTo($relative, $from, $to, $fromTime, $toTime);
2227     }
2228
2229     if ($from) {
2230       $clauses[] = "( {$fieldName} >= " . date('YmdHis', strtotime($from)) . ')';
2231     }
2232
2233     if ($to) {
2234       $clauses[] = "( {$fieldName} <= " . date('YmdHis', strtotime($to)) . ')';
2235     }
2236     if (!empty($clauses)) {
2237       return implode(' AND ', $clauses);
2238     }
2239
2240     return NULL;
2241   }
2242
2243   /**
2244    * Get values for from and to for date ranges.
2245    *
2246    * @deprecated
2247    *
2248    * @param bool $relative
2249    * @param string $from
2250    * @param string $to
2251    * @param string $fromTime
2252    * @param string $toTime
2253    *
2254    * @return array
2255    */
2256   public function getFromTo($relative, $from, $to, $fromTime = NULL, $toTime = NULL) {
2257     if (!empty($fromTime) || !empty($toTime)) {
2258       throw new CRM_Core_Exception('Report template needs to be updated as getFromTo no longer supports fromTime or ToTime Parameters');
2259     }
2260     return CRM_Utils_Date::getFromTo($relative, $from, $to);
2261   }
2262
2263   /**
2264    * Alter display of rows.
2265    *
2266    * Iterate through the rows retrieved via SQL and make changes for display purposes,
2267    * such as rendering contacts as links.
2268    *
2269    * @param array $rows
2270    *   Rows generated by SQL, with an array for each row.
2271    */
2272   public function alterDisplay(&$rows) {
2273   }
2274
2275   /**
2276    * Alter the way in which custom data fields are displayed.
2277    *
2278    * @param array $rows
2279    */
2280   public function alterCustomDataDisplay(&$rows) {
2281     // custom code to alter rows having custom values
2282     if (empty($this->_customGroupExtends)) {
2283       return;
2284     }
2285
2286     $customFields = [];
2287     $customFieldIds = [];
2288     foreach ($this->_params['fields'] as $fieldAlias => $value) {
2289       if ($fieldId = CRM_Core_BAO_CustomField::getKeyID($fieldAlias)) {
2290         $customFieldIds[$fieldAlias] = $fieldId;
2291       }
2292     }
2293     if (empty($customFieldIds)) {
2294       return;
2295     }
2296
2297     // skip for type date and ContactReference since date format is already handled
2298     $query = "
2299 SELECT cg.table_name, cf.id
2300 FROM  civicrm_custom_field cf
2301 INNER JOIN civicrm_custom_group cg ON cg.id = cf.custom_group_id
2302 WHERE cg.extends IN ('" . implode("','", $this->_customGroupExtends) . "') AND
2303       cg.is_active = 1 AND
2304       cf.is_active = 1 AND
2305       cf.is_searchable = 1 AND
2306       cf.data_type   NOT IN ('ContactReference', 'Date') AND
2307       cf.id IN (" . implode(",", $customFieldIds) . ")";
2308
2309     $dao = CRM_Core_DAO::executeQuery($query);
2310     while ($dao->fetch()) {
2311       $customFields[$dao->table_name . '_custom_' . $dao->id] = $dao->id;
2312     }
2313
2314     $entryFound = FALSE;
2315     foreach ($rows as $rowNum => $row) {
2316       foreach ($row as $tableCol => $val) {
2317         if (array_key_exists($tableCol, $customFields)) {
2318           $rows[$rowNum][$tableCol] = CRM_Core_BAO_CustomField::displayValue($val, $customFields[$tableCol]);
2319           $entryFound = TRUE;
2320         }
2321       }
2322
2323       // skip looking further in rows, if first row itself doesn't
2324       // have the column we need
2325       if (!$entryFound) {
2326         break;
2327       }
2328     }
2329   }
2330
2331   /**
2332    * Remove duplicate rows.
2333    *
2334    * @param array $rows
2335    */
2336   public function removeDuplicates(&$rows) {
2337     if (empty($this->_noRepeats)) {
2338       return;
2339     }
2340     $checkList = [];
2341
2342     foreach ($rows as $key => $list) {
2343       foreach ($list as $colName => $colVal) {
2344         if (array_key_exists($colName, $checkList) &&
2345           $checkList[$colName] == $colVal
2346         ) {
2347           $rows[$key][$colName] = "";
2348         }
2349         if (in_array($colName, $this->_noRepeats)) {
2350           $checkList[$colName] = $colVal;
2351         }
2352       }
2353     }
2354   }
2355
2356   /**
2357    * Fix subtotal display.
2358    *
2359    * @param array $row
2360    * @param array $fields
2361    * @param bool $subtotal
2362    */
2363   public function fixSubTotalDisplay(&$row, $fields, $subtotal = TRUE) {
2364     foreach ($row as $colName => $colVal) {
2365       if (in_array($colName, $fields)) {
2366       }
2367       elseif (isset($this->_columnHeaders[$colName])) {
2368         if ($subtotal) {
2369           $row[$colName] = 'Subtotal';
2370           $subtotal = FALSE;
2371         }
2372         else {
2373           unset($row[$colName]);
2374         }
2375       }
2376     }
2377   }
2378
2379   /**
2380    * Calculate grant total.
2381    *
2382    * @param array $rows
2383    *
2384    * @return bool
2385    */
2386   public function grandTotal(&$rows) {
2387     if (!$this->_rollup  || count($rows) == 1) {
2388       return FALSE;
2389     }
2390
2391     $this->moveSummaryColumnsToTheRightHandSide();
2392
2393     if ($this->_limit && count($rows) >= self::ROW_COUNT_LIMIT) {
2394       return FALSE;
2395     }
2396
2397     $this->rollupRow = array_pop($rows);
2398
2399     foreach ($this->_columnHeaders as $fld => $val) {
2400       if (!in_array($fld, $this->_statFields)) {
2401         if (!$this->_grandFlag) {
2402           $this->rollupRow[$fld] = ts('Grand Total');
2403           $this->_grandFlag = TRUE;
2404         }
2405         else {
2406           $this->rollupRow[$fld] = "";
2407         }
2408       }
2409     }
2410
2411     $this->assign('grandStat', $this->rollupRow);
2412     return TRUE;
2413   }
2414
2415   /**
2416    * Format display output.
2417    *
2418    * @param array $rows
2419    * @param bool $pager
2420    */
2421   public function formatDisplay(&$rows, $pager = TRUE) {
2422     // set pager based on if any limit was applied in the query.
2423     if ($pager) {
2424       $this->setPager();
2425     }
2426
2427     // allow building charts if any
2428     if (!empty($this->_params['charts']) && !empty($rows)) {
2429       $this->buildChart($rows);
2430       $this->assign('chartEnabled', TRUE);
2431       $this->_chartId = "{$this->_params['charts']}_" .
2432         ($this->_id ? $this->_id : substr(get_class($this), 16)) . '_' .
2433         session_id();
2434       $this->assign('chartId', $this->_chartId);
2435     }
2436
2437     // unset columns not to be displayed.
2438     foreach ($this->_columnHeaders as $key => $value) {
2439       if (!empty($value['no_display'])) {
2440         unset($this->_columnHeaders[$key]);
2441       }
2442     }
2443
2444     // unset columns not to be displayed.
2445     if (!empty($rows)) {
2446       foreach ($this->_noDisplay as $noDisplayField) {
2447         foreach ($rows as $rowNum => $row) {
2448           unset($this->_columnHeaders[$noDisplayField]);
2449         }
2450       }
2451     }
2452
2453     // Find alter display functions.
2454     $firstRow = reset($rows);
2455     if ($firstRow) {
2456       $selectedFields = array_keys($firstRow);
2457       $alterFunctions = $alterMap = $alterSpecs = [];
2458       foreach ($this->_columns as $tableName => $table) {
2459         if (array_key_exists('metadata', $table)) {
2460           foreach ($table['metadata'] as $field => $specs) {
2461             if (in_array($tableName . '_' . $field, $selectedFields)) {
2462               if (array_key_exists('alter_display', $specs)) {
2463                 $alterFunctions[$tableName . '_' . $field] = $specs['alter_display'];
2464                 $alterMap[$tableName . '_' . $field] = $field;
2465                 $alterSpecs[$tableName . '_' . $field] = NULL;
2466               }
2467               // Add any alters that can be intuited from the field specs.
2468               // So far only boolean but a lot more could be.
2469               if (empty($alterSpecs[$tableName . '_' . $field]) && isset($specs['type']) && $specs['type'] == CRM_Utils_Type::T_BOOLEAN) {
2470                 $alterFunctions[$tableName . '_' . $field] = 'alterBoolean';
2471                 $alterMap[$tableName . '_' . $field] = $field;
2472                 $alterSpecs[$tableName . '_' . $field] = NULL;
2473               }
2474             }
2475           }
2476         }
2477       }
2478
2479       // Run the alter display functions
2480       foreach ($rows as $index => & $row) {
2481         foreach ($row as $selectedField => $value) {
2482           if (array_key_exists($selectedField, $alterFunctions) && isset($value)) {
2483             $rows[$index][$selectedField] = $this->{$alterFunctions[$selectedField]}($value, $row, $selectedField, $alterMap[$selectedField], $alterSpecs[$selectedField]);
2484           }
2485         }
2486       }
2487     }
2488
2489     // use this method for formatting rows for display purpose.
2490     $this->alterDisplay($rows);
2491     CRM_Utils_Hook::alterReportVar('rows', $rows, $this);
2492
2493     // build array of section totals
2494     $this->sectionTotals();
2495
2496     // process grand-total row
2497     $this->grandTotal($rows);
2498
2499     // use this method for formatting custom rows for display purpose.
2500     $this->alterCustomDataDisplay($rows);
2501   }
2502
2503   /**
2504    * @param $value
2505    * @param $row
2506    * @param $selectedfield
2507    * @param $criteriaFieldName
2508    *
2509    * @return array
2510    */
2511   protected function alterStateProvinceID($value, &$row, $selectedfield, $criteriaFieldName) {
2512     $url = CRM_Utils_System::url(CRM_Utils_System::currentPath(), "reset=1&force=1&{$criteriaFieldName}_op=in&{$criteriaFieldName}_value={$value}", $this->_absoluteUrl);
2513     $row[$selectedfield . '_link'] = $url;
2514     $row[$selectedfield . '_hover'] = ts("%1 for this state.", [
2515       1 => $value,
2516     ]);
2517
2518     $states = CRM_Core_PseudoConstant::stateProvince($value, FALSE);
2519     if (!is_array($states)) {
2520       return $states;
2521     }
2522   }
2523
2524   /**
2525    * @param $value
2526    * @param $row
2527    * @param $selectedField
2528    * @param $criteriaFieldName
2529    *
2530    * @return array
2531    */
2532   protected function alterCountryID($value, &$row, $selectedField, $criteriaFieldName) {
2533     $url = CRM_Utils_System::url(CRM_Utils_System::currentPath(), "reset=1&force=1&{$criteriaFieldName}_op=in&{$criteriaFieldName}_value={$value}", $this->_absoluteUrl);
2534     $row[$selectedField . '_link'] = $url;
2535     $row[$selectedField . '_hover'] = ts("%1 for this country.", [
2536       1 => $value,
2537     ]);
2538     $countries = CRM_Core_PseudoConstant::country($value, FALSE);
2539     if (!is_array($countries)) {
2540       return $countries;
2541     }
2542   }
2543
2544   /**
2545    * @param $value
2546    * @param $row
2547    * @param $selectedfield
2548    * @param $criteriaFieldName
2549    *
2550    * @return array
2551    */
2552   protected function alterCountyID($value, &$row, $selectedfield, $criteriaFieldName) {
2553     $url = CRM_Utils_System::url(CRM_Utils_System::currentPath(), "reset=1&force=1&{$criteriaFieldName}_op=in&{$criteriaFieldName}_value={$value}", $this->_absoluteUrl);
2554     $row[$selectedfield . '_link'] = $url;
2555     $row[$selectedfield . '_hover'] = ts("%1 for this county.", [
2556       1 => $value,
2557     ]);
2558     $counties = CRM_Core_PseudoConstant::county($value, FALSE);
2559     if (!is_array($counties)) {
2560       return $counties;
2561     }
2562   }
2563
2564   /**
2565    * @param $value
2566    * @param $row
2567    * @param $selectedfield
2568    * @param $criteriaFieldName
2569    *
2570    * @return mixed
2571    */
2572   protected function alterLocationTypeID($value, &$row, $selectedfield, $criteriaFieldName) {
2573     return CRM_Core_PseudoConstant::getLabel('CRM_Core_DAO_Address', 'location_type_id', $value);
2574   }
2575
2576   /**
2577    * @param $value
2578    * @param $row
2579    * @param $fieldname
2580    *
2581    * @return mixed
2582    */
2583   protected function alterContactID($value, &$row, $fieldname) {
2584     $nameField = substr($fieldname, 0, -2) . 'name';
2585     static $first = TRUE;
2586     static $viewContactList = FALSE;
2587     if ($first) {
2588       $viewContactList = CRM_Core_Permission::check('access CiviCRM');
2589       $first = FALSE;
2590     }
2591     if (!$viewContactList) {
2592       return $value;
2593     }
2594     if (array_key_exists($nameField, $row)) {
2595       $row[$nameField . '_link'] = CRM_Utils_System::url("civicrm/contact/view", 'reset=1&cid=' . $value, $this->_absoluteUrl);
2596     }
2597     else {
2598       $row[$fieldname . '_link'] = CRM_Utils_System::url("civicrm/contact/view", 'reset=1&cid=' . $value, $this->_absoluteUrl);
2599     }
2600     return $value;
2601   }
2602
2603   /**
2604    * @param $value
2605    * @param $row
2606    * @param $fieldname
2607    *
2608    * @return mixed
2609    */
2610   protected function alterCommunicationtMethod($value, &$row, $fieldname) {
2611     $communicationMethods = CRM_Core_PseudoConstant::get('CRM_Contact_DAO_Contact', 'preferred_communication_method');
2612
2613     // Explode padded values.
2614     $values = CRM_utils_array::explodePadded($value);
2615     // Flip values, compute intersection with $communicationMethods, and implode with commas.
2616     $value = implode(', ', array_intersect_key($communicationMethods, array_flip($values)));
2617     return $value;
2618   }
2619
2620   /**
2621    * @param $value
2622    *
2623    * @return mixed
2624    */
2625   protected function alterBoolean($value) {
2626     $options = [0 => '', 1 => ts('Yes')];
2627     if (isset($options[$value])) {
2628       return $options[$value];
2629     }
2630     return $value;
2631   }
2632
2633   /**
2634    * Build chart.
2635    *
2636    * @param array $rows
2637    */
2638   public function buildChart(&$rows) {
2639     // override this method for building charts.
2640   }
2641
2642   // select() method below has been added recently (v3.3), and many of the report templates might
2643   // still be having their own select() method. We should fix them as and when encountered and move
2644   // towards generalizing the select() method below.
2645
2646   /**
2647    * Generate the SELECT clause and set class variable $_select.
2648    */
2649   public function select() {
2650     $select = $this->_selectAliases = [];
2651     $this->storeGroupByArray();
2652
2653     foreach ($this->_columns as $tableName => $table) {
2654       if (array_key_exists('fields', $table)) {
2655         foreach ($table['fields'] as $fieldName => $field) {
2656           if ($tableName == 'civicrm_address') {
2657             // deprecated, use $this->isTableSelected.
2658             $this->_addressField = TRUE;
2659           }
2660           if ($tableName == 'civicrm_email') {
2661             $this->_emailField = TRUE;
2662           }
2663           if ($tableName == 'civicrm_phone') {
2664             $this->_phoneField = TRUE;
2665           }
2666
2667           if (!empty($field['required']) ||
2668             !empty($this->_params['fields'][$fieldName])
2669           ) {
2670
2671             // 1. In many cases we want select clause to be built in slightly different way
2672             // for a particular field of a particular type.
2673             // 2. This method when used should receive params by reference and modify $this->_columnHeaders
2674             // as needed.
2675             $selectClause = $this->selectClause($tableName, 'fields', $fieldName, $field);
2676             if ($selectClause) {
2677               $select[] = $selectClause;
2678               continue;
2679             }
2680
2681             // include statistics columns only if set
2682             if (!empty($field['statistics']) && !empty($this->_groupByArray)) {
2683               $select = $this->addStatisticsToSelect($field, $tableName, $fieldName, $select);
2684             }
2685             else {
2686
2687               $selectClause = $this->getSelectClauseWithGroupConcatIfNotGroupedBy($tableName, $fieldName, $field);
2688               if ($selectClause) {
2689                 $select[] = $selectClause;
2690               }
2691               else {
2692                 $select = $this->addBasicFieldToSelect($tableName, $fieldName, $field, $select);
2693               }
2694             }
2695           }
2696         }
2697       }
2698
2699       // select for group bys
2700       if (array_key_exists('group_bys', $table)) {
2701         foreach ($table['group_bys'] as $fieldName => $field) {
2702
2703           if ($tableName == 'civicrm_address') {
2704             $this->_addressField = TRUE;
2705           }
2706           if ($tableName == 'civicrm_email') {
2707             $this->_emailField = TRUE;
2708           }
2709           if ($tableName == 'civicrm_phone') {
2710             $this->_phoneField = TRUE;
2711           }
2712           // 1. In many cases we want select clause to be built in slightly different way
2713           // for a particular field of a particular type.
2714           // 2. This method when used should receive params by reference and modify $this->_columnHeaders
2715           // as needed.
2716           $selectClause = $this->selectClause($tableName, 'group_bys', $fieldName, $field);
2717           if ($selectClause) {
2718             $select[] = $selectClause;
2719             continue;
2720           }
2721
2722           if (!empty($this->_params['group_bys']) &&
2723             !empty($this->_params['group_bys'][$fieldName]) &&
2724             !empty($this->_params['group_bys_freq'])
2725           ) {
2726             switch (CRM_Utils_Array::value($fieldName, $this->_params['group_bys_freq'])) {
2727               case 'YEARWEEK':
2728                 $select[] = "DATE_SUB({$field['dbAlias']}, INTERVAL WEEKDAY({$field['dbAlias']}) DAY) AS {$tableName}_{$fieldName}_start";
2729                 $select[] = "YEARWEEK({$field['dbAlias']}) AS {$tableName}_{$fieldName}_subtotal";
2730                 $select[] = "WEEKOFYEAR({$field['dbAlias']}) AS {$tableName}_{$fieldName}_interval";
2731                 $field['title'] = 'Week';
2732                 break;
2733
2734               case 'YEAR':
2735                 $select[] = "MAKEDATE(YEAR({$field['dbAlias']}), 1)  AS {$tableName}_{$fieldName}_start";
2736                 $select[] = "YEAR({$field['dbAlias']}) AS {$tableName}_{$fieldName}_subtotal";
2737                 $select[] = "YEAR({$field['dbAlias']}) AS {$tableName}_{$fieldName}_interval";
2738                 $field['title'] = 'Year';
2739                 break;
2740
2741               case 'MONTH':
2742                 $select[] = "DATE_SUB({$field['dbAlias']}, INTERVAL (DAYOFMONTH({$field['dbAlias']})-1) DAY) as {$tableName}_{$fieldName}_start";
2743                 $select[] = "MONTH({$field['dbAlias']}) AS {$tableName}_{$fieldName}_subtotal";
2744                 $select[] = "MONTHNAME({$field['dbAlias']}) AS {$tableName}_{$fieldName}_interval";
2745                 $field['title'] = 'Month';
2746                 break;
2747
2748               case 'QUARTER':
2749                 $select[] = "STR_TO_DATE(CONCAT( 3 * QUARTER( {$field['dbAlias']} ) -2 , '/', '1', '/', YEAR( {$field['dbAlias']} ) ), '%m/%d/%Y') AS {$tableName}_{$fieldName}_start";
2750                 $select[] = "QUARTER({$field['dbAlias']}) AS {$tableName}_{$fieldName}_subtotal";
2751                 $select[] = "QUARTER({$field['dbAlias']}) AS {$tableName}_{$fieldName}_interval";
2752                 $field['title'] = 'Quarter';
2753                 break;
2754             }
2755             // for graphs and charts -
2756             if (!empty($this->_params['group_bys_freq'][$fieldName])) {
2757               $this->_interval = $field['title'];
2758               $this->_columnHeaders["{$tableName}_{$fieldName}_start"]['title']
2759                 = $field['title'] . ' Beginning';
2760               $this->_columnHeaders["{$tableName}_{$fieldName}_start"]['type'] = $field['type'];
2761               $this->_columnHeaders["{$tableName}_{$fieldName}_start"]['group_by'] = $this->_params['group_bys_freq'][$fieldName];
2762
2763               // just to make sure these values are transferred to rows.
2764               // since we 'll need them for calculation purpose,
2765               // e.g making subtotals look nicer or graphs
2766               $this->_columnHeaders["{$tableName}_{$fieldName}_interval"] = ['no_display' => TRUE];
2767               $this->_columnHeaders["{$tableName}_{$fieldName}_subtotal"] = ['no_display' => TRUE];
2768             }
2769           }
2770         }
2771       }
2772     }
2773
2774     if (empty($select)) {
2775       // CRM-21412 Do not give fatal error on report when no fields selected
2776       $select = [1];
2777     }
2778
2779     $this->_selectClauses = $select;
2780     $this->_select = "SELECT " . implode(', ', $select) . " ";
2781   }
2782
2783   /**
2784    * Build select clause for a single field.
2785    *
2786    * @param string $tableName
2787    * @param string $tableKey
2788    * @param string $fieldName
2789    * @param string $field
2790    *
2791    * @return bool
2792    */
2793   public function selectClause(&$tableName, $tableKey, &$fieldName, &$field) {
2794     if (!empty($field['pseudofield'])) {
2795       $alias = "{$tableName}_{$fieldName}";
2796       $this->_columnHeaders["{$tableName}_{$fieldName}"]['title'] = $field['title'] ?? NULL;
2797       $this->_columnHeaders["{$tableName}_{$fieldName}"]['type'] = $field['type'] ?? NULL;
2798       $this->_columnHeaders["{$tableName}_{$fieldName}"]['dbAlias'] = $field['dbAlias'] ?? NULL;
2799       $this->_selectAliases[] = $alias;
2800       return ' 1 as  ' . $alias;
2801     }
2802     return FALSE;
2803   }
2804
2805   /**
2806    * Build where clause.
2807    */
2808   public function where() {
2809     $this->storeWhereHavingClauseArray();
2810
2811     if (empty($this->_whereClauses)) {
2812       $this->_where = "WHERE ( 1 ) ";
2813       $this->_having = "";
2814     }
2815     else {
2816       $this->_where = "WHERE " . implode(' AND ', $this->_whereClauses);
2817     }
2818
2819     if ($this->_aclWhere) {
2820       $this->_where .= " AND {$this->_aclWhere} ";
2821     }
2822
2823     if (!empty($this->_havingClauses)) {
2824       // use this clause to construct group by clause.
2825       $this->_having = "HAVING " . implode(' AND ', $this->_havingClauses);
2826     }
2827   }
2828
2829   /**
2830    * Store Where clauses into an array.
2831    *
2832    * Breaking out this step makes over-riding more flexible as the clauses can be used in constructing a
2833    * temp table that may not be part of the final where clause or added
2834    * in other functions
2835    */
2836   public function storeWhereHavingClauseArray() {
2837     foreach ($this->_columns as $tableName => $table) {
2838       if (array_key_exists('filters', $table)) {
2839         foreach ($table['filters'] as $fieldName => $field) {
2840           // respect pseudofield to filter spec so fields can be marked as
2841           // not to be handled here
2842           if (!empty($field['pseudofield'])) {
2843             continue;
2844           }
2845           $clause = $this->generateFilterClause($field, $fieldName);
2846
2847           if (!empty($clause)) {
2848             if (!empty($field['having'])) {
2849               $this->_havingClauses[] = $clause;
2850             }
2851             else {
2852               $this->_whereClauses[] = $clause;
2853             }
2854           }
2855         }
2856       }
2857     }
2858
2859   }
2860
2861   /**
2862    * Set output mode.
2863    */
2864   public function processReportMode() {
2865     $this->setOutputMode();
2866
2867     $this->_sendmail
2868       = CRM_Utils_Request::retrieve(
2869         'sendmail',
2870         'Boolean',
2871         CRM_Core_DAO::$_nullObject
2872       );
2873
2874     if ($this->_sendmail && !$this->_outputMode) {
2875       // If we're here from the mail_report job, then the default there gets
2876       // set to pdf before we get here, but if we're somehow here and sending
2877       // by email and don't have a format set, then use print.
2878       // @todo Is this on purpose - why would they be different defaults?
2879       $this->_outputMode = 'print';
2880     }
2881
2882     // _outputMode means multiple things and can cover export to file formats,
2883     // like csv, or actions with no output, like save. So this will only set
2884     // a handler if it's one of the former. But it's also possible we have a
2885     // really interesting handler out there. But the point is we don't need to
2886     // know, just to know that a handler doesn't always get set by this call.
2887     $this->setOutputHandler();
2888
2889     if (!empty($this->outputHandler)) {
2890       if ($this->_sendmail) {
2891         // If we're sending by email these are the only options that make
2892         // sense.
2893         $this->printOnly = TRUE;
2894         $this->addPaging = FALSE;
2895         $this->_absoluteUrl = TRUE;
2896       }
2897       else {
2898         // otherwise ask the handler
2899         $this->printOnly = $this->outputHandler->isPrintOnly();
2900         $this->addPaging = $this->outputHandler->isAddPaging();
2901         $this->_absoluteUrl = $this->outputHandler->isAbsoluteUrl();
2902       }
2903     }
2904     elseif ($this->_outputMode == 'copy' && $this->_criteriaForm) {
2905       $this->_createNew = TRUE;
2906     }
2907
2908     $this->assign('outputMode', $this->_outputMode);
2909     $this->assign('printOnly', $this->printOnly);
2910     // Get today's date to include in printed reports
2911     if ($this->printOnly) {
2912       $reportDate = CRM_Utils_Date::customFormat(date('Y-m-d H:i'));
2913       $this->assign('reportDate', $reportDate);
2914     }
2915   }
2916
2917   /**
2918    * Post Processing function for Form.
2919    *
2920    * postProcessCommon should be used to set other variables from input as the api accesses that function.
2921    * This function is not accessed when the api calls the report.
2922    */
2923   public function beginPostProcess() {
2924     $this->setParams($this->controller->exportValues($this->_name));
2925     if (empty($this->_params) &&
2926       $this->_force
2927     ) {
2928       $this->setParams($this->_formValues);
2929     }
2930
2931     // hack to fix params when submitted from dashboard, CRM-8532
2932     // fields array is missing because form building etc is skipped
2933     // in dashboard mode for report
2934     //@todo - this could be done in the dashboard no we have a setter
2935     if (empty($this->_params['fields']) && !$this->_noFields) {
2936       $this->setParams($this->_formValues);
2937     }
2938
2939     $this->processReportMode();
2940
2941     if ($this->_outputMode == 'save' || $this->_outputMode == 'copy') {
2942       $this->_createNew = ($this->_outputMode == 'copy');
2943       CRM_Report_Form_Instance::postProcess($this);
2944     }
2945     if ($this->_outputMode == 'delete') {
2946       CRM_Report_BAO_ReportInstance::doFormDelete($this->_id, 'civicrm/report/list?reset=1', 'civicrm/report/list?reset=1');
2947     }
2948
2949     $this->_formValues = $this->_params;
2950
2951     $this->beginPostProcessCommon();
2952   }
2953
2954   /**
2955    * BeginPostProcess function run in both report mode and non-report mode (api).
2956    */
2957   public function beginPostProcessCommon() {
2958   }
2959
2960   /**
2961    * Build the report query.
2962    *
2963    * @param bool $applyLimit
2964    *
2965    * @return string
2966    */
2967   public function buildQuery($applyLimit = TRUE) {
2968     $this->buildGroupTempTable();
2969     $this->select();
2970     $this->from();
2971     $this->customDataFrom();
2972     $this->buildPermissionClause();
2973     $this->where();
2974     $this->groupBy();
2975     $this->orderBy();
2976
2977     foreach ($this->unselectedOrderByColumns() as $alias => $field) {
2978       $clause = $this->getSelectClauseWithGroupConcatIfNotGroupedBy($field['table_name'], $field['name'], $field);
2979       if (!$clause) {
2980         $clause = "{$field['dbAlias']} as {$alias}";
2981       }
2982       $this->_select .= ", $clause ";
2983     }
2984
2985     if ($applyLimit && empty($this->_params['charts'])) {
2986       $this->limit();
2987     }
2988     CRM_Utils_Hook::alterReportVar('sql', $this, $this);
2989
2990     $sql = "{$this->_select} {$this->_from} {$this->_where} {$this->_groupBy} {$this->_having} {$this->_orderBy} {$this->_limit}";
2991     $this->addToDeveloperTab($sql);
2992     return $sql;
2993   }
2994
2995   /**
2996    * Build group by clause.
2997    */
2998   public function groupBy() {
2999     $this->storeGroupByArray();
3000
3001     if (!empty($this->_groupByArray)) {
3002       if ($this->optimisedForOnlyFullGroupBy) {
3003         // We should probably deprecate this code path. What happens here is that
3004         // the group by is amended to reflect the select columns. This often breaks the
3005         // results. Retrofitting group strict group by onto existing report classes
3006         // went badly.
3007         $this->_groupBy = CRM_Contact_BAO_Query::getGroupByFromSelectColumns($this->_selectClauses, $this->_groupByArray);
3008       }
3009       else {
3010         $this->_groupBy = ' GROUP BY ' . implode($this->_groupByArray);
3011       }
3012     }
3013   }
3014
3015   /**
3016    * Build order by clause.
3017    */
3018   public function orderBy() {
3019     $this->_orderBy = "";
3020     $this->_sections = [];
3021     $this->storeOrderByArray();
3022     if (!empty($this->_orderByArray) && !$this->_rollup == 'WITH ROLLUP') {
3023       $this->_orderBy = "ORDER BY " . implode(', ', $this->_orderByArray);
3024     }
3025     $this->assign('sections', $this->_sections);
3026   }
3027
3028   /**
3029    * Extract order by fields and store as an array.
3030    *
3031    * In some cases other functions want to know which fields are selected for ordering by
3032    * Separating this into a separate function allows it to be called separately from constructing
3033    * the order by clause
3034    */
3035   public function storeOrderByArray() {
3036     $orderBys = [];
3037
3038     if (!empty($this->_params['order_bys']) &&
3039       is_array($this->_params['order_bys']) &&
3040       !empty($this->_params['order_bys'])
3041     ) {
3042
3043       // Process order_bys in user-specified order
3044       foreach ($this->_params['order_bys'] as $orderBy) {
3045         $orderByField = [];
3046         foreach ($this->_columns as $tableName => $table) {
3047           if (array_key_exists('order_bys', $table)) {
3048             // For DAO columns defined in $this->_columns
3049             $fields = $table['order_bys'];
3050           }
3051           elseif (array_key_exists('extends', $table)) {
3052             // For custom fields referenced in $this->_customGroupExtends
3053             $fields = CRM_Utils_Array::value('fields', $table, []);
3054           }
3055           else {
3056             continue;
3057           }
3058           if (!empty($fields) && is_array($fields)) {
3059             foreach ($fields as $fieldName => $field) {
3060               if ($fieldName == $orderBy['column']) {
3061                 $orderByField = array_merge($field, $orderBy);
3062                 $orderByField['tplField'] = "{$tableName}_{$fieldName}";
3063                 break 2;
3064               }
3065             }
3066           }
3067         }
3068
3069         if (!empty($orderByField)) {
3070           $this->_orderByFields[$orderByField['tplField']] = $orderByField;
3071           if ($this->groupConcatTested) {
3072             $orderBys[$orderByField['tplField']] = "{$orderByField['tplField']} {$orderBy['order']}";
3073           }
3074           else {
3075             // Not sure when this is preferable to using tplField (which has
3076             // definitely been tested to work in cases then this does not.
3077             // in caution not switching unless report has been tested for
3078             // group concat functionality.
3079             $orderBys[$orderByField['tplField']] = "{$orderByField['dbAlias']} {$orderBy['order']}";
3080           }
3081
3082           // Record any section headers for assignment to the template
3083           if (!empty($orderBy['section'])) {
3084             $orderByField['pageBreak'] = $orderBy['pageBreak'] ?? NULL;
3085             $this->_sections[$orderByField['tplField']] = $orderByField;
3086           }
3087         }
3088       }
3089     }
3090
3091     $this->_orderByArray = $orderBys;
3092
3093     $this->assign('sections', $this->_sections);
3094   }
3095
3096   /**
3097    * Determine unselected columns.
3098    *
3099    * @return array
3100    */
3101   public function unselectedOrderByColumns() {
3102     return array_diff_key($this->_orderByFields, $this->getSelectColumns());
3103   }
3104
3105   /**
3106    * Determine unselected columns.
3107    *
3108    * @return array
3109    */
3110   public function unselectedSectionColumns() {
3111     if (is_array($this->_sections)) {
3112       return array_diff_key($this->_sections, $this->getSelectColumns());
3113     }
3114     else {
3115       return [];
3116     }
3117   }
3118
3119   /**
3120    * Build output rows.
3121    *
3122    * @param string $sql
3123    * @param array $rows
3124    */
3125   public function buildRows($sql, &$rows) {
3126     if (!$this->optimisedForOnlyFullGroupBy) {
3127       CRM_Core_DAO::disableFullGroupByMode();
3128     }
3129     $dao = CRM_Core_DAO::executeQuery($sql);
3130     if (stristr($this->_select, 'SQL_CALC_FOUND_ROWS')) {
3131       $this->_rowsFound = CRM_Core_DAO::singleValueQuery('SELECT FOUND_ROWS()');
3132     }
3133     CRM_Core_DAO::reenableFullGroupByMode();
3134     if (!is_array($rows)) {
3135       $rows = [];
3136     }
3137
3138     // use this method to modify $this->_columnHeaders
3139     $this->modifyColumnHeaders();
3140
3141     $unselectedSectionColumns = $this->unselectedSectionColumns();
3142
3143     while ($dao->fetch()) {
3144       $row = [];
3145       foreach ($this->_columnHeaders as $key => $value) {
3146         if (property_exists($dao, $key)) {
3147           $row[$key] = $dao->$key;
3148         }
3149       }
3150
3151       // section headers not selected for display need to be added to row
3152       foreach ($unselectedSectionColumns as $key => $values) {
3153         if (property_exists($dao, $key)) {
3154           $row[$key] = $dao->$key;
3155         }
3156       }
3157
3158       $rows[] = $row;
3159     }
3160   }
3161
3162   /**
3163    * Calculate section totals.
3164    *
3165    * When "order by" fields are marked as sections, this assigns to the template
3166    * an array of total counts for each section. This data is used by the Smarty
3167    * plugin {sectionTotal}.
3168    */
3169   public function sectionTotals() {
3170
3171     // Reports using order_bys with sections must populate $this->_selectAliases in select() method.
3172     if (empty($this->_selectAliases)) {
3173       return;
3174     }
3175
3176     if (!empty($this->_sections)) {
3177       // build the query with no LIMIT clause
3178       $select = str_ireplace('SELECT SQL_CALC_FOUND_ROWS ', 'SELECT ', $this->_select);
3179       $sql = "{$select} {$this->_from} {$this->_where} {$this->_groupBy} {$this->_having} {$this->_orderBy}";
3180
3181       // pull section aliases out of $this->_sections
3182       $sectionAliases = array_keys($this->_sections);
3183
3184       $ifnulls = [];
3185       foreach (array_merge($sectionAliases, $this->_selectAliases) as $alias) {
3186         $ifnulls[] = "ifnull($alias, '') as $alias";
3187       }
3188       $this->_select = "SELECT " . implode(", ", $ifnulls);
3189       $this->_select = CRM_Contact_BAO_Query::appendAnyValueToSelect($ifnulls, $sectionAliases);
3190
3191       // Group (un-limited) report by all aliases and get counts. This might
3192       // be done more efficiently when the contents of $sql are known, ie. by
3193       // overriding this method in the report class.
3194
3195       $query = $this->_select .
3196         ", count(*) as ct from ($sql) as subquery group by " .
3197         implode(", ", $sectionAliases);
3198
3199       // initialize array of total counts
3200       $totals = [];
3201       $dao = CRM_Core_DAO::executeQuery($query);
3202       while ($dao->fetch()) {
3203
3204         // let $this->_alterDisplay translate any integer ids to human-readable values.
3205         $rows[0] = $dao->toArray();
3206         $this->alterDisplay($rows);
3207         $row = $rows[0];
3208
3209         // add totals for all permutations of section values
3210         $values = [];
3211         $i = 1;
3212         $aliasCount = count($sectionAliases);
3213         foreach ($sectionAliases as $alias) {
3214           $values[] = $row[$alias];
3215           $key = implode(CRM_Core_DAO::VALUE_SEPARATOR, $values);
3216           if ($i == $aliasCount) {
3217             // the last alias is the lowest-level section header; use count as-is
3218             $totals[$key] = $dao->ct;
3219           }
3220           else {
3221             // other aliases are higher level; roll count into their total
3222             $totals[$key] += $dao->ct;
3223           }
3224         }
3225       }
3226       $this->assign('sectionTotals', $totals);
3227     }
3228   }
3229
3230   /**
3231    * Modify column headers.
3232    */
3233   public function modifyColumnHeaders() {
3234     // use this method to modify $this->_columnHeaders
3235   }
3236
3237   /**
3238    * Move totals columns to the right edge of the table.
3239    *
3240    * It seems like a more logical layout to have any totals columns on the far right regardless of
3241    * the location of the rest of their table.
3242    */
3243   public function moveSummaryColumnsToTheRightHandSide() {
3244     $statHeaders = (array_intersect_key($this->_columnHeaders, array_flip($this->_statFields)));
3245     $this->_columnHeaders = array_merge(array_diff_key($this->_columnHeaders, $statHeaders), $this->_columnHeaders, $statHeaders);
3246   }
3247
3248   /**
3249    * Assign rows to the template.
3250    *
3251    * @param array $rows
3252    */
3253   public function doTemplateAssignment(&$rows) {
3254     $this->assign_by_ref('columnHeaders', $this->_columnHeaders);
3255     $this->assign_by_ref('rows', $rows);
3256     $this->assign('statistics', $this->statistics($rows));
3257   }
3258
3259   /**
3260    * Build report statistics.
3261    *
3262    * Override this method to build your own statistics.
3263    *
3264    * @param array $rows
3265    *
3266    * @return array
3267    */
3268   public function statistics(&$rows) {
3269     $statistics = [];
3270
3271     $count = count($rows);
3272     // Why do we increment the count for rollup seems to artificially inflate the count.
3273     // It seems perhaps intentional to include the summary row in the count of results - although
3274     // this just seems odd.
3275     if ($this->_rollup && ($this->_rollup != '') && $this->_grandFlag) {
3276       $count++;
3277     }
3278
3279     $this->countStat($statistics, $count);
3280
3281     $this->groupByStat($statistics);
3282
3283     $this->filterStat($statistics);
3284
3285     return $statistics;
3286   }
3287
3288   /**
3289    * Add count statistics.
3290    *
3291    * @param array $statistics
3292    * @param int $count
3293    */
3294   public function countStat(&$statistics, $count) {
3295     $statistics['counts']['rowCount'] = [
3296       'title' => ts('Row(s) Listed'),
3297       'value' => $count,
3298     ];
3299
3300     if ($this->_rowsFound && ($this->_rowsFound > $count)) {
3301       $statistics['counts']['rowsFound'] = [
3302         'title' => ts('Total Row(s)'),
3303         'value' => $this->_rowsFound,
3304       ];
3305     }
3306   }
3307
3308   /**
3309    * Add group by statistics.
3310    *
3311    * @param array $statistics
3312    */
3313   public function groupByStat(&$statistics) {
3314     if (!empty($this->_params['group_bys']) &&
3315       is_array($this->_params['group_bys']) &&
3316       !empty($this->_params['group_bys'])
3317     ) {
3318       foreach ($this->_columns as $tableName => $table) {
3319         if (array_key_exists('group_bys', $table)) {
3320           foreach ($table['group_bys'] as $fieldName => $field) {
3321             if (!empty($this->_params['group_bys'][$fieldName])) {
3322               $combinations[] = $field['title'];
3323             }
3324           }
3325         }
3326       }
3327       $statistics['groups'][] = [
3328         'title' => ts('Grouping(s)'),
3329         'value' => implode(' & ', $combinations),
3330       ];
3331     }
3332   }
3333
3334   /**
3335    * Filter statistics.
3336    *
3337    * @param array $statistics
3338    */
3339   public function filterStat(&$statistics) {
3340     foreach ($this->_columns as $tableName => $table) {
3341       if (array_key_exists('filters', $table)) {
3342         foreach ($table['filters'] as $fieldName => $field) {
3343           if ((CRM_Utils_Array::value('type', $field) & CRM_Utils_Type::T_DATE ||
3344               CRM_Utils_Array::value('type', $field) & CRM_Utils_Type::T_TIME) &&
3345             CRM_Utils_Array::value('operatorType', $field) !=
3346             CRM_Report_Form::OP_MONTH
3347           ) {
3348             $from = $this->_params["{$fieldName}_from"] ?? NULL;
3349             $to = $this->_params["{$fieldName}_to"] ?? NULL;
3350             if (!empty($this->_params["{$fieldName}_relative"])) {
3351               list($from, $to) = CRM_Utils_Date::getFromTo($this->_params["{$fieldName}_relative"], NULL, NULL);
3352             }
3353             if (strlen($to) === 10) {
3354               // If we just have the date we assume the end of that day.
3355               $to .= ' 23:59:59';
3356             }
3357             if ($from || $to) {
3358               if ($from) {
3359                 $from = date('l j F Y, g:iA', strtotime($from));
3360               }
3361               if ($to) {
3362                 $to = date('l j F Y, g:iA', strtotime($to));
3363               }
3364               $statistics['filters'][] = [
3365                 'title' => $field['title'],
3366                 'value' => ts("Between %1 and %2", [1 => $from, 2 => $to]),
3367               ];
3368             }
3369             elseif (in_array($rel = CRM_Utils_Array::value("{$fieldName}_relative", $this->_params),
3370               array_keys($this->getOperationPair(CRM_Report_Form::OP_DATE))
3371             )) {
3372               $pair = $this->getOperationPair(CRM_Report_Form::OP_DATE);
3373               $statistics['filters'][] = [
3374                 'title' => $field['title'],
3375                 'value' => $pair[$rel],
3376               ];
3377             }
3378           }
3379           else {
3380             $op = $this->_params["{$fieldName}_op"] ?? NULL;
3381             $value = NULL;
3382             if ($op) {
3383               $pair = $this->getOperationPair(
3384                 CRM_Utils_Array::value('operatorType', $field),
3385                 $fieldName
3386               );
3387               $min = $this->_params["{$fieldName}_min"] ?? NULL;
3388               $max = $this->_params["{$fieldName}_max"] ?? NULL;
3389               $val = $this->_params["{$fieldName}_value"] ?? NULL;
3390               if (in_array($op, ['bw', 'nbw']) && ($min || $max)) {
3391                 $value = "{$pair[$op]} $min " . ts('and') . " $max";
3392               }
3393               elseif ($val && CRM_Utils_Array::value('operatorType', $field) & self::OP_ENTITYREF) {
3394                 $this->setEntityRefDefaults($field, $tableName);
3395                 $result = civicrm_api3($field['attributes']['entity'], 'getlist',
3396                   ['id' => $val] +
3397                   CRM_Utils_Array::value('api', $field['attributes'], []));
3398                 $values = [];
3399                 foreach ($result['values'] as $v) {
3400                   $values[] = $v['label'];
3401                 }
3402                 $value = "{$pair[$op]} " . implode(', ', $values);
3403               }
3404               elseif ($op == 'nll' || $op == 'nnll') {
3405                 $value = $pair[$op];
3406               }
3407               elseif (is_array($val) && (!empty($val))) {
3408                 $options = CRM_Utils_Array::value('options', $field, []);
3409                 foreach ($val as $key => $valIds) {
3410                   if (isset($options[$valIds])) {
3411                     $val[$key] = $options[$valIds];
3412                   }
3413                 }
3414                 $pair[$op] = (count($val) == 1) ? (($op == 'notin' || $op ==
3415                   'mnot') ? ts('Is Not') : ts('Is')) : CRM_Utils_Array::value($op, $pair);
3416                 $val = implode(', ', $val);
3417                 $value = "{$pair[$op]} " . $val;
3418               }
3419               elseif (!is_array($val) && (!empty($val) || $val == '0') &&
3420                 isset($field['options']) &&
3421                 is_array($field['options']) && !empty($field['options'])
3422               ) {
3423                 $value = CRM_Utils_Array::value($op, $pair) . " " .
3424                   CRM_Utils_Array::value($val, $field['options'], $val);
3425               }
3426               elseif ($val) {
3427                 $value = CRM_Utils_Array::value($op, $pair) . " " . $val;
3428               }
3429             }
3430             if ($value && empty($field['no_display'])) {
3431               $statistics['filters'][] = [
3432                 'title' => $field['title'] ?? NULL,
3433                 'value' => CRM_Utils_String::htmlToText($value),
3434               ];
3435             }
3436           }
3437         }
3438       }
3439     }
3440   }
3441
3442   /**
3443    * End post processing.
3444    *
3445    * @param array|null $rows
3446    */
3447   public function endPostProcess(&$rows = NULL) {
3448     $this->assign('report_class', get_class($this));
3449
3450     // This is used by unit tests, where _outputMode is intentionally blank.
3451     // Is there a reason it couldn't just always do this? It effectively does
3452     // the same thing anyway by assigning it to the template (in
3453     // doTemplateAssignment()).
3454     if ($this->_storeResultSet) {
3455       $this->_resultSet = $rows;
3456     }
3457
3458     // Add contacts to group
3459     if ($this->_outputMode == 'group') {
3460       $group = $this->_params['groups'];
3461       $this->add2group($group);
3462     }
3463     else {
3464       if ($this->_sendmail) {
3465         $this->sendEmail();
3466       }
3467       elseif (!empty($this->outputHandler)) {
3468         $this->outputHandler->download();
3469         CRM_Utils_System::civiExit();
3470       }
3471       // else we don't need to do anything here since it must have been
3472       // outputMode=save or something like that
3473     }
3474   }
3475
3476   /**
3477    * Set store result set indicator to TRUE.
3478    *
3479    * This is used by unit tests, along with getResultSet(), to get just
3480    * the output rows unformatted.
3481    */
3482   public function storeResultSet() {
3483     $this->_storeResultSet = TRUE;
3484   }
3485
3486   /**
3487    * Get result set.
3488    *
3489    * @return bool
3490    */
3491   public function getResultSet() {
3492     return $this->_resultSet;
3493   }
3494
3495   /**
3496    * Get the sql used to generate the report.
3497    *
3498    * @return string
3499    */
3500   public function getReportSql() {
3501     return $this->sqlArray;
3502   }
3503
3504   /**
3505    * Use the form name to create the tpl file name.
3506    *
3507    * @return string
3508    */
3509   public function getTemplateFileName() {
3510     $defaultTpl = parent::getTemplateFileName();
3511     $template = CRM_Core_Smarty::singleton();
3512     if (!$template->template_exists($defaultTpl)) {
3513       $defaultTpl = 'CRM/Report/Form.tpl';
3514     }
3515     return $defaultTpl;
3516   }
3517
3518   /**
3519    * Compile the report content.
3520    *
3521    * Although this function is super-short it is useful to keep separate so it can be over-ridden by report classes.
3522    *
3523    * @return string
3524    */
3525   public function compileContent() {
3526     $templateFile = $this->getHookedTemplateFileName();
3527     return CRM_Utils_Array::value('report_header', $this->_formValues) .
3528     CRM_Core_Form::$_template->fetch($templateFile) .
3529     CRM_Utils_Array::value('report_footer', $this->_formValues);
3530   }
3531
3532   /**
3533    * Post process function.
3534    */
3535   public function postProcess() {
3536     // get ready with post process params
3537     $this->beginPostProcess();
3538
3539     // build query
3540     $sql = $this->buildQuery();
3541
3542     // build array of result based on column headers. This method also allows
3543     // modifying column headers before using it to build result set i.e $rows.
3544     $rows = [];
3545     $this->buildRows($sql, $rows);
3546
3547     // format result set.
3548     $this->formatDisplay($rows);
3549
3550     // assign variables to templates
3551     $this->doTemplateAssignment($rows);
3552
3553     // do print / pdf / instance stuff if needed
3554     $this->endPostProcess($rows);
3555   }
3556
3557   /**
3558    * Set limit.
3559    *
3560    * @param int $rowCount
3561    *
3562    * @return array
3563    */
3564   public function limit($rowCount = self::ROW_COUNT_LIMIT) {
3565     // lets do the pager if in html mode
3566     $this->_limit = NULL;
3567
3568     // CRM-14115, over-ride row count if rowCount is specified in URL
3569     if ($this->_dashBoardRowCount) {
3570       $rowCount = $this->_dashBoardRowCount;
3571     }
3572     if ($this->addPaging) {
3573       $this->_select = preg_replace('/SELECT(\s+SQL_CALC_FOUND_ROWS)?\s+/i', 'SELECT SQL_CALC_FOUND_ROWS ', $this->_select);
3574
3575       $pageId = CRM_Utils_Request::retrieve('crmPID', 'Integer');
3576
3577       // @todo all http vars should be extracted in the preProcess
3578       // - not randomly in the class
3579       if (!$pageId && !empty($_POST)) {
3580         if (isset($_POST['PagerBottomButton']) && isset($_POST['crmPID_B'])) {
3581           $pageId = max((int) $_POST['crmPID_B'], 1);
3582         }
3583         elseif (isset($_POST['PagerTopButton']) && isset($_POST['crmPID'])) {
3584           $pageId = max((int) $_POST['crmPID'], 1);
3585         }
3586         unset($_POST['crmPID_B'], $_POST['crmPID']);
3587       }
3588
3589       $pageId = $pageId ? $pageId : 1;
3590       $this->set(CRM_Utils_Pager::PAGE_ID, $pageId);
3591       $offset = ($pageId - 1) * $rowCount;
3592
3593       $offset = CRM_Utils_Type::escape($offset, 'Int');
3594       $rowCount = CRM_Utils_Type::escape($rowCount, 'Int');
3595
3596       $this->_limit = " LIMIT $offset, $rowCount";
3597       return [$offset, $rowCount];
3598     }
3599     if ($this->_limitValue) {
3600       if ($this->_offsetValue) {
3601         $this->_limit = " LIMIT {$this->_offsetValue}, {$this->_limitValue} ";
3602       }
3603       else {
3604         $this->_limit = " LIMIT " . $this->_limitValue;
3605       }
3606     }
3607   }
3608
3609   /**
3610    * Set pager.
3611    *
3612    * @param int $rowCount
3613    */
3614   public function setPager($rowCount = self::ROW_COUNT_LIMIT) {
3615     // CRM-14115, over-ride row count if rowCount is specified in URL
3616     if ($this->_dashBoardRowCount) {
3617       $rowCount = $this->_dashBoardRowCount;
3618     }
3619
3620     if ($this->_limit && ($this->_limit != '')) {
3621       if (!$this->_rowsFound) {
3622         $sql = "SELECT FOUND_ROWS();";
3623         $this->_rowsFound = CRM_Core_DAO::singleValueQuery($sql);
3624       }
3625       $params = [
3626         'total' => $this->_rowsFound,
3627         'rowCount' => $rowCount,
3628         'status' => ts('Records') . ' %%StatusMessage%%',
3629         'buttonBottom' => 'PagerBottomButton',
3630         'buttonTop' => 'PagerTopButton',
3631       ];
3632       if (!empty($this->controller)) {
3633         // This happens when being called from the api Really we want the api to be able to
3634         // pass paging parameters, but at this stage just preventing test crashes.
3635         $params['pageID'] = $this->get(CRM_Utils_Pager::PAGE_ID);
3636       }
3637
3638       $pager = new CRM_Utils_Pager($params);
3639       $this->assign_by_ref('pager', $pager);
3640       $this->ajaxResponse['totalRows'] = $this->_rowsFound;
3641     }
3642   }
3643
3644   /**
3645    * Build a group filter with contempt for large data sets.
3646    *
3647    * This function has been retained as it takes time to migrate the reports over
3648    * to the new method which will not crash on large datasets.
3649    *
3650    * @deprecated
3651    *
3652    * @param string $field
3653    * @param mixed $value
3654    * @param string $op
3655    *
3656    * @return string
3657    */
3658   public function legacySlowGroupFilterClause($field, $value, $op) {
3659     $smartGroupQuery = "";
3660
3661     $group = new CRM_Contact_DAO_Group();
3662     $group->is_active = 1;
3663     $group->find();
3664     $smartGroups = [];
3665     while ($group->fetch()) {
3666       if (in_array($group->id, (array) $this->_params['gid_value']) &&
3667         $group->saved_search_id
3668       ) {
3669         $smartGroups[] = $group->id;
3670       }
3671     }
3672
3673     CRM_Contact_BAO_GroupContactCache::check($smartGroups);
3674
3675     $smartGroupQuery = '';
3676     if (!empty($smartGroups)) {
3677       $smartGroups = implode(',', $smartGroups);
3678       $smartGroupQuery = " UNION DISTINCT
3679                   SELECT DISTINCT smartgroup_contact.contact_id
3680                   FROM civicrm_group_contact_cache smartgroup_contact
3681                   WHERE smartgroup_contact.group_id IN ({$smartGroups}) ";
3682     }
3683
3684     $sqlOp = $this->getSQLOperator($op);
3685     if (!is_array($value)) {
3686       $value = [$value];
3687     }
3688     //include child groups if any
3689     $value = array_merge($value, CRM_Contact_BAO_Group::getChildGroupIds($value));
3690
3691     $clause = "{$field['dbAlias']} IN (" . implode(', ', $value) . ")";
3692
3693     $contactAlias = $this->_aliases['civicrm_contact'];
3694     if (!empty($this->relationType) && $this->relationType == 'b_a') {
3695       $contactAlias = $this->_aliases['civicrm_contact_b'];
3696     }
3697     return " {$contactAlias}.id {$sqlOp} (
3698                           SELECT DISTINCT {$this->_aliases['civicrm_group']}.contact_id
3699                           FROM civicrm_group_contact {$this->_aliases['civicrm_group']}
3700                           WHERE {$clause} AND {$this->_aliases['civicrm_group']}.status = 'Added'
3701                           {$smartGroupQuery} ) ";
3702   }
3703
3704   /**
3705    * Build where clause for groups.
3706    *
3707    * @param string $field
3708    * @param mixed $value
3709    * @param string $op
3710    *
3711    * @return string
3712    */
3713   public function whereGroupClause($field, $value, $op) {
3714     if ($this->groupFilterNotOptimised) {
3715       return $this->legacySlowGroupFilterClause($field, $value, $op);
3716     }
3717     if ($op === 'notin') {
3718       return " group_temp_table.id IS NULL ";
3719     }
3720     // We will have used an inner join instead.
3721     return "1";
3722   }
3723
3724   /**
3725    * Create a table of the contact ids included by the group filter.
3726    *
3727    * This function is called by both the api (tests) and the UI.
3728    */
3729   public function buildGroupTempTable() {
3730     if (!empty($this->groupTempTable) || empty($this->_params['gid_value']) || $this->groupFilterNotOptimised) {
3731       return;
3732     }
3733     $filteredGroups = (array) $this->_params['gid_value'];
3734
3735     $groups = civicrm_api3('Group', 'get', [
3736       'is_active' => 1,
3737       'id' => ['IN' => $filteredGroups],
3738       'saved_search_id' => ['>' => 0],
3739       'return' => 'id',
3740     ]);
3741     $smartGroups = array_keys($groups['values']);
3742
3743     $query = "
3744        SELECT DISTINCT group_contact.contact_id as id
3745        FROM civicrm_group_contact group_contact
3746        WHERE group_contact.group_id IN (" . implode(', ', $filteredGroups) . ")
3747        AND group_contact.status = 'Added' ";
3748
3749     if (!empty($smartGroups)) {
3750       CRM_Contact_BAO_GroupContactCache::check($smartGroups);
3751       $smartGroups = implode(',', $smartGroups);
3752       $query .= "
3753         UNION DISTINCT
3754         SELECT smartgroup_contact.contact_id as id
3755         FROM civicrm_group_contact_cache smartgroup_contact
3756         WHERE smartgroup_contact.group_id IN ({$smartGroups}) ";
3757     }
3758
3759     $this->groupTempTable = $this->createTemporaryTable('rptgrp', $query);
3760     CRM_Core_DAO::executeQuery("ALTER TABLE $this->groupTempTable ADD INDEX i_id(id)");
3761   }
3762
3763   /**
3764    * Execute query and add it to the developer tab.
3765    *
3766    * @param string $query
3767    * @param array $params
3768    *
3769    * @return \CRM_Core_DAO|object
3770    */
3771   protected function executeReportQuery($query, $params = []) {
3772     $this->addToDeveloperTab($query);
3773     return CRM_Core_DAO::executeQuery($query, $params);
3774   }
3775
3776   /**
3777    * Build where clause for tags.
3778    *
3779    * @param string $field
3780    * @param mixed $value
3781    * @param string $op
3782    *
3783    * @return string
3784    */
3785   public function whereTagClause($field, $value, $op) {
3786     // not using left join in query because if any contact
3787     // belongs to more than one tag, results duplicate
3788     // entries.
3789     $sqlOp = $this->getSQLOperator($op);
3790     if (!is_array($value)) {
3791       $value = [$value];
3792     }
3793     $clause = "{$field['dbAlias']} IN (" . implode(', ', $value) . ")";
3794     $entity_table = $this->_tagFilterTable;
3795     return " {$this->_aliases[$entity_table]}.id {$sqlOp} (
3796                           SELECT DISTINCT {$this->_aliases['civicrm_tag']}.entity_id
3797                           FROM civicrm_entity_tag {$this->_aliases['civicrm_tag']}
3798                           WHERE entity_table = '$entity_table' AND {$clause} ) ";
3799   }
3800
3801   /**
3802    * Generate membership organization clause.
3803    *
3804    * @param mixed $value
3805    * @param string $op SQL Operator
3806    *
3807    * @return string
3808    */
3809   public function whereMembershipOrgClause($value, $op) {
3810     $sqlOp = $this->getSQLOperator($op);
3811     if (!is_array($value)) {
3812       $value = [$value];
3813     }
3814
3815     $tmp_membership_org_sql_list = implode(', ', $value);
3816     return " {$this->_aliases['civicrm_contact']}.id {$sqlOp} (
3817                           SELECT DISTINCT mem.contact_id
3818                           FROM civicrm_membership mem
3819                           LEFT JOIN civicrm_membership_status mem_status ON mem.status_id = mem_status.id
3820                           LEFT JOIN civicrm_membership_type mt ON mem.membership_type_id = mt.id
3821                           WHERE mt.member_of_contact_id IN (" .
3822     $tmp_membership_org_sql_list . ")
3823                           AND mt.is_active = '1'
3824                           AND mem_status.is_current_member = '1'
3825                           AND mem_status.is_active = '1' )  ";
3826   }
3827
3828   /**
3829    * Generate Membership Type SQL Clause.
3830    *
3831    * @param mixed $value
3832    * @param string $op
3833    *
3834    * @return string
3835    *   SQL query string
3836    */
3837   public function whereMembershipTypeClause($value, $op) {
3838     $sqlOp = $this->getSQLOperator($op);
3839     if (!is_array($value)) {
3840       $value = [$value];
3841     }
3842
3843     $tmp_membership_sql_list = implode(', ', $value);
3844     return " {$this->_aliases['civicrm_contact']}.id {$sqlOp} (
3845                           SELECT DISTINCT mem.contact_id
3846                           FROM civicrm_membership mem
3847                           LEFT JOIN civicrm_membership_status mem_status ON mem.status_id = mem_status.id
3848                           LEFT JOIN civicrm_membership_type mt ON mem.membership_type_id = mt.id
3849                           WHERE mem.membership_type_id IN (" .
3850     $tmp_membership_sql_list . ")
3851                           AND mt.is_active = '1'
3852                           AND mem_status.is_current_member = '1'
3853                           AND mem_status.is_active = '1' ) ";
3854   }
3855
3856   /**
3857    * Buld contact acl clause
3858    * @deprecated in favor of buildPermissionClause
3859    *
3860    * Note that if the buildPermissionClause function is called (which most reports do from
3861    * buildQuery then the results of this function are re-calculated and overwritten.
3862    *
3863    * @param string $tableAlias
3864    */
3865   public function buildACLClause($tableAlias = 'contact_a') {
3866     list($this->_aclFrom, $this->_aclWhere) = CRM_Contact_BAO_Contact_Permission::cacheClause($tableAlias);
3867   }
3868
3869   /**
3870    * Build the permision clause for all entities in this report
3871    */
3872   public function buildPermissionClause() {
3873     $ret = [];
3874     foreach ($this->selectedTables() as $tableName) {
3875       $baoName = str_replace('_DAO_', '_BAO_', CRM_Core_DAO_AllCoreTables::getClassForTable($tableName));
3876       if ($baoName && class_exists($baoName) && !empty($this->_columns[$tableName]['alias'])) {
3877         $tableAlias = $this->_columns[$tableName]['alias'];
3878         $clauses = array_filter($baoName::getSelectWhereClause($tableAlias));
3879         foreach ($clauses as $field => $clause) {
3880           // Skip contact_id field if redundant
3881           if ($field != 'contact_id' || !in_array('civicrm_contact', $this->selectedTables())) {
3882             $ret["$tableName.$field"] = $clause;
3883           }
3884         }
3885       }
3886     }
3887     // Override output from buildACLClause
3888     $this->_aclFrom = NULL;
3889     $this->_aclWhere = implode(' AND ', $ret);
3890   }
3891
3892   /**
3893    * Add custom data to the columns.
3894    *
3895    * @param bool $addFields
3896    * @param array $permCustomGroupIds
3897    */
3898   public function addCustomDataToColumns($addFields = TRUE, $permCustomGroupIds = []) {
3899     if (empty($this->_customGroupExtends)) {
3900       return;
3901     }
3902     if (!is_array($this->_customGroupExtends)) {
3903       $this->_customGroupExtends = [$this->_customGroupExtends];
3904     }
3905     $customGroupWhere = '';
3906     if (!empty($permCustomGroupIds)) {
3907       $customGroupWhere = "cg.id IN (" . implode(',', $permCustomGroupIds) .
3908         ") AND";
3909     }
3910     $sql = "
3911 SELECT cg.table_name, cg.title, cg.extends, cf.id as cf_id, cf.label,
3912        cf.column_name, cf.data_type, cf.html_type, cf.option_group_id, cf.time_format
3913 FROM   civicrm_custom_group cg
3914 INNER  JOIN civicrm_custom_field cf ON cg.id = cf.custom_group_id
3915 WHERE cg.extends IN ('" . implode("','", $this->_customGroupExtends) . "') AND
3916       {$customGroupWhere}
3917       cg.is_active = 1 AND
3918       cf.is_active = 1 AND
3919       cf.is_searchable = 1
3920 ORDER BY cg.weight, cf.weight";
3921     $customDAO = CRM_Core_DAO::executeQuery($sql);
3922
3923     $curTable = NULL;
3924     while ($customDAO->fetch()) {
3925       if ($customDAO->table_name != $curTable) {
3926         $curTable = $customDAO->table_name;
3927         $curFields = $curFilters = [];
3928
3929         // dummy dao object
3930         $this->_columns[$curTable]['dao'] = 'CRM_Contact_DAO_Contact';
3931         $this->_columns[$curTable]['extends'] = $customDAO->extends;
3932         $this->_columns[$curTable]['grouping'] = $customDAO->table_name;
3933         $this->_columns[$curTable]['group_title'] = $customDAO->title;
3934
3935         foreach (['fields', 'filters', 'group_bys'] as $colKey) {
3936           if (!array_key_exists($colKey, $this->_columns[$curTable])) {
3937             $this->_columns[$curTable][$colKey] = [];
3938           }
3939         }
3940       }
3941       $fieldName = 'custom_' . $customDAO->cf_id;
3942
3943       if ($addFields) {
3944         // this makes aliasing work in favor
3945         $curFields[$fieldName] = [
3946           'name' => $customDAO->column_name,
3947           'title' => $customDAO->label,
3948           'dataType' => $customDAO->data_type,
3949           'htmlType' => $customDAO->html_type,
3950         ];
3951       }
3952       if ($this->_customGroupFilters) {
3953         // this makes aliasing work in favor
3954         $curFilters[$fieldName] = [
3955           'name' => $customDAO->column_name,
3956           'title' => $customDAO->label,
3957           'dataType' => $customDAO->data_type,
3958           'htmlType' => $customDAO->html_type,
3959         ];
3960       }
3961
3962       switch ($customDAO->data_type) {
3963         case 'Date':
3964           // filters
3965           $curFilters[$fieldName]['operatorType'] = CRM_Report_Form::OP_DATE;
3966           $curFilters[$fieldName]['type'] = CRM_Utils_Type::T_DATE;
3967           // CRM-6946, show time part for datetime date fields
3968           if ($customDAO->time_format) {
3969             $curFields[$fieldName]['type'] = CRM_Utils_Type::T_TIMESTAMP;
3970           }
3971           break;
3972
3973         case 'Boolean':
3974           $curFilters[$fieldName]['operatorType'] = CRM_Report_Form::OP_SELECT;
3975           $curFilters[$fieldName]['options'] = ['' => ts('- select -')] + CRM_Core_PseudoConstant::get('CRM_Core_BAO_CustomField', 'custom_' . $customDAO->cf_id, [], 'search');
3976           $curFilters[$fieldName]['type'] = CRM_Utils_Type::T_INT;
3977           break;
3978
3979         case 'Int':
3980           $curFilters[$fieldName]['operatorType'] = CRM_Report_Form::OP_INT;
3981           $curFilters[$fieldName]['type'] = CRM_Utils_Type::T_INT;
3982           break;
3983
3984         case 'Money':
3985           $curFilters[$fieldName]['operatorType'] = CRM_Report_Form::OP_FLOAT;
3986           $curFilters[$fieldName]['type'] = CRM_Utils_Type::T_MONEY;
3987           $curFields[$fieldName]['type'] = CRM_Utils_Type::T_MONEY;
3988           break;
3989
3990         case 'Float':
3991           $curFilters[$fieldName]['operatorType'] = CRM_Report_Form::OP_FLOAT;
3992           $curFilters[$fieldName]['type'] = CRM_Utils_Type::T_FLOAT;
3993           break;
3994
3995         case 'String':
3996         case 'StateProvince':
3997         case 'Country':
3998           $curFilters[$fieldName]['type'] = CRM_Utils_Type::T_STRING;
3999
4000           $options = CRM_Core_PseudoConstant::get('CRM_Core_BAO_CustomField', 'custom_' . $customDAO->cf_id, [], 'search');
4001           if ((is_array($options) && count($options) != 0) || (!is_array($options) && $options !== FALSE)) {
4002             $curFilters[$fieldName]['operatorType'] = CRM_Core_BAO_CustomField::isSerialized($customDAO) ? CRM_Report_Form::OP_MULTISELECT_SEPARATOR : CRM_Report_Form::OP_MULTISELECT;
4003             $curFilters[$fieldName]['options'] = $options;
4004           }
4005           break;
4006
4007         case 'ContactReference':
4008           $curFilters[$fieldName]['type'] = CRM_Utils_Type::T_STRING;
4009           $curFilters[$fieldName]['name'] = 'display_name';
4010           $curFilters[$fieldName]['alias'] = "contact_{$fieldName}_civireport";
4011
4012           $curFields[$fieldName]['type'] = CRM_Utils_Type::T_STRING;
4013           $curFields[$fieldName]['name'] = 'display_name';
4014           $curFields[$fieldName]['alias'] = "contact_{$fieldName}_civireport";
4015           break;
4016
4017         default:
4018           $curFields[$fieldName]['type'] = CRM_Utils_Type::T_STRING;
4019           $curFilters[$fieldName]['type'] = CRM_Utils_Type::T_STRING;
4020       }
4021
4022       // CRM-19401 fix
4023       if ($customDAO->html_type == 'Select' && !array_key_exists('options', $curFilters[$fieldName])) {
4024         $options = CRM_Core_PseudoConstant::get('CRM_Core_BAO_CustomField', 'custom_' . $customDAO->cf_id, [], 'search');
4025         if ($options !== FALSE) {
4026           $curFilters[$fieldName]['operatorType'] = CRM_Core_BAO_CustomField::isSerialized($customDAO) ? CRM_Report_Form::OP_MULTISELECT_SEPARATOR : CRM_Report_Form::OP_MULTISELECT;
4027           $curFilters[$fieldName]['options'] = $options;
4028         }
4029       }
4030
4031       if (!array_key_exists('type', $curFields[$fieldName])) {
4032         $curFields[$fieldName]['type'] = CRM_Utils_Array::value('type', $curFilters[$fieldName], []);
4033       }
4034
4035       if ($addFields) {
4036         $this->_columns[$curTable]['fields'] = array_merge($this->_columns[$curTable]['fields'], $curFields);
4037       }
4038       if ($this->_customGroupFilters) {
4039         $this->_columns[$curTable]['filters'] = array_merge($this->_columns[$curTable]['filters'], $curFilters);
4040       }
4041       if ($this->_customGroupGroupBy) {
4042         $this->_columns[$curTable]['group_bys'] = array_merge($this->_columns[$curTable]['group_bys'], $curFields);
4043       }
4044     }
4045   }
4046
4047   /**
4048    * Build custom data from clause.
4049    *
4050    * @param bool $joinsForFiltersOnly
4051    *   Only include joins to support filters. This would be used if creating a table of contacts to include first.
4052    */
4053   public function customDataFrom($joinsForFiltersOnly = FALSE) {
4054     if (empty($this->_customGroupExtends)) {
4055       return;
4056     }
4057     $mapper = CRM_Core_BAO_CustomQuery::$extendsMap;
4058     //CRM-18276 GROUP_CONCAT could be used with singleValueQuery and then exploded,
4059     //but by default that truncates to 1024 characters, which causes errors with installs with lots of custom field sets
4060     $customTables = [];
4061     $customTablesDAO = CRM_Core_DAO::executeQuery("SELECT table_name FROM civicrm_custom_group");
4062     while ($customTablesDAO->fetch()) {
4063       $customTables[] = $customTablesDAO->table_name;
4064     }
4065
4066     foreach ($this->_columns as $table => $prop) {
4067       if (in_array($table, $customTables)) {
4068         $extendsTable = $mapper[$prop['extends']];
4069         // Check field is required for rendering the report.
4070         if ((!$this->isFieldSelected($prop)) || ($joinsForFiltersOnly && !$this->isFieldFiltered($prop))) {
4071           continue;
4072         }
4073         $baseJoin = CRM_Utils_Array::value($prop['extends'], $this->_customGroupExtendsJoin, "{$this->_aliases[$extendsTable]}.id");
4074
4075         $customJoin = is_array($this->_customGroupJoin) ? $this->_customGroupJoin[$table] : $this->_customGroupJoin;
4076         $this->_from .= "
4077 {$customJoin} {$table} {$this->_aliases[$table]} ON {$this->_aliases[$table]}.entity_id = {$baseJoin}";
4078         // handle for ContactReference
4079         if (array_key_exists('fields', $prop)) {
4080           foreach ($prop['fields'] as $fieldName => $field) {
4081             if (CRM_Utils_Array::value('dataType', $field) ==
4082               'ContactReference'
4083             ) {
4084               $columnName = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_CustomField', CRM_Core_BAO_CustomField::getKeyID($fieldName), 'column_name');
4085               $this->_from .= "
4086 LEFT JOIN civicrm_contact {$field['alias']} ON {$field['alias']}.id = {$this->_aliases[$table]}.{$columnName} ";
4087             }
4088           }
4089         }
4090       }
4091     }
4092   }
4093
4094   /**
4095    * Check if the field is selected.
4096    *
4097    * @param string $prop
4098    *
4099    * @return bool
4100    */
4101   public function isFieldSelected($prop) {
4102     if (empty($prop)) {
4103       return FALSE;
4104     }
4105
4106     if (!empty($this->_params['fields'])) {
4107       foreach (array_keys($prop['fields']) as $fieldAlias) {
4108         $customFieldId = CRM_Core_BAO_CustomField::getKeyID($fieldAlias);
4109         if ($customFieldId) {
4110           if (array_key_exists($fieldAlias, $this->_params['fields'])) {
4111             return TRUE;
4112           }
4113
4114           //might be survey response field.
4115           if (!empty($this->_params['fields']['survey_response']) &&
4116             !empty($prop['fields'][$fieldAlias]['isSurveyResponseField'])
4117           ) {
4118             return TRUE;
4119           }
4120         }
4121       }
4122     }
4123
4124     if (!empty($this->_params['group_bys']) && $this->_customGroupGroupBy) {
4125       foreach (array_keys($prop['group_bys']) as $fieldAlias) {
4126         if (array_key_exists($fieldAlias, $this->_params['group_bys']) &&
4127           CRM_Core_BAO_CustomField::getKeyID($fieldAlias)
4128         ) {
4129           return TRUE;
4130         }
4131       }
4132     }
4133
4134     if (!empty($this->_params['order_bys'])) {
4135       foreach (array_keys($prop['fields']) as $fieldAlias) {
4136         foreach ($this->_params['order_bys'] as $orderBy) {
4137           if ($fieldAlias == $orderBy['column'] &&
4138             CRM_Core_BAO_CustomField::getKeyID($fieldAlias)
4139           ) {
4140             return TRUE;
4141           }
4142         }
4143       }
4144     }
4145     return $this->isFieldFiltered($prop);
4146
4147   }
4148
4149   /**
4150    * Check if the field is used as a filter.
4151    *
4152    * @param string $prop
4153    *
4154    * @return bool
4155    */
4156   protected function isFieldFiltered($prop) {
4157     if (!empty($prop['filters']) && $this->_customGroupFilters) {
4158       foreach ($prop['filters'] as $fieldAlias => $val) {
4159         foreach ([
4160           'value',
4161           'min',
4162           'max',
4163           'relative',
4164           'from',
4165           'to',
4166         ] as $attach) {
4167           if (isset($this->_params[$fieldAlias . '_' . $attach]) &&
4168             (!empty($this->_params[$fieldAlias . '_' . $attach])
4169               || ($attach != 'relative' &&
4170                 $this->_params[$fieldAlias . '_' . $attach] == '0')
4171             )
4172           ) {
4173             return TRUE;
4174           }
4175         }
4176         if (!empty($this->_params[$fieldAlias . '_op']) &&
4177           in_array($this->_params[$fieldAlias . '_op'], ['nll', 'nnll'])
4178         ) {
4179           return TRUE;
4180         }
4181       }
4182     }
4183
4184     return FALSE;
4185   }
4186
4187   /**
4188    * Check for empty order_by configurations and remove them.
4189    *
4190    * Also set template to hide them.
4191    *
4192    * @param array $formValues
4193    */
4194   public function preProcessOrderBy(&$formValues) {
4195     // Object to show/hide form elements
4196     $_showHide = new CRM_Core_ShowHideBlocks('', '');
4197
4198     $_showHide->addShow('optionField_1');
4199
4200     // Cycle through order_by options; skip any empty ones, and hide them as well
4201     $n = 1;
4202
4203     if (!empty($formValues['order_bys'])) {
4204       foreach ($formValues['order_bys'] as $order_by) {
4205         if ($order_by['column'] && $order_by['column'] != '-') {
4206           $_showHide->addShow('optionField_' . $n);
4207           $orderBys[$n] = $order_by;
4208           $n++;
4209         }
4210       }
4211     }
4212     for ($i = $n; $i <= 5; $i++) {
4213       if ($i > 1) {
4214         $_showHide->addHide('optionField_' . $i);
4215       }
4216     }
4217
4218     // overwrite order_by options with modified values
4219     if (!empty($orderBys)) {
4220       $formValues['order_bys'] = $orderBys;
4221     }
4222     else {
4223       $formValues['order_bys'] = [1 => ['column' => '-']];
4224     }
4225
4226     // assign show/hide data to template
4227     $_showHide->addToTemplate();
4228   }
4229
4230   /**
4231    * Check if table name has columns in SELECT clause.
4232    *
4233    * @param string $tableName
4234    *   Name of table (index of $this->_columns array).
4235    *
4236    * @return bool
4237    */
4238   public function isTableSelected($tableName) {
4239     return in_array($tableName, $this->selectedTables());
4240   }
4241
4242   /**
4243    * Check if table name has columns in WHERE or HAVING clause.
4244    *
4245    * @param string $tableName
4246    *   Name of table (index of $this->_columns array).
4247    *
4248    * @return bool
4249    */
4250   public function isTableFiltered($tableName) {
4251     // Cause the array to be generated if not previously done.
4252     if (!$this->_selectedTables && !$this->filteredTables) {
4253       $this->selectedTables();
4254     }
4255     return in_array($tableName, $this->filteredTables);
4256   }
4257
4258   /**
4259    * Fetch array of DAO tables having columns included in SELECT or ORDER BY clause.
4260    *
4261    * If the array is unset it will be built.
4262    *
4263    * @return array
4264    *   selectedTables
4265    */
4266   public function selectedTables() {
4267     if (!$this->_selectedTables) {
4268       $orderByColumns = [];
4269       if (array_key_exists('order_bys', $this->_params) &&
4270         is_array($this->_params['order_bys'])
4271       ) {
4272         foreach ($this->_params['order_bys'] as $orderBy) {
4273           $orderByColumns[] = $orderBy['column'];
4274         }
4275       }
4276
4277       foreach ($this->_columns as $tableName => $table) {
4278         if (array_key_exists('fields', $table)) {
4279           foreach ($table['fields'] as $fieldName => $field) {
4280             if (!empty($field['required']) ||
4281               !empty($this->_params['fields'][$fieldName])
4282             ) {
4283               $this->_selectedTables[] = $tableName;
4284               break;
4285             }
4286           }
4287         }
4288         if (array_key_exists('order_bys', $table)) {
4289           foreach ($table['order_bys'] as $orderByName => $orderBy) {
4290             if (in_array($orderByName, $orderByColumns)) {
4291               $this->_selectedTables[] = $tableName;
4292               break;
4293             }
4294           }
4295         }
4296         if (array_key_exists('filters', $table)) {
4297           foreach ($table['filters'] as $filterName => $filter) {
4298             $filterOp = $this->_params["{$filterName}_op"] ?? '';
4299             if ((isset($this->_params["{$filterName}_value"])
4300                 && !CRM_Utils_System::isNull($this->_params["{$filterName}_value"]))
4301               || !empty($this->_params["{$filterName}_relative"])
4302               || $filterOp === 'nll'
4303               || $filterOp === 'nnll'
4304             ) {
4305               $this->_selectedTables[] = $tableName;
4306               $this->filteredTables[] = $tableName;
4307               break;
4308             }
4309           }
4310         }
4311       }
4312     }
4313     return $this->_selectedTables;
4314   }
4315
4316   /**
4317    * Add campaign fields.
4318    * @param string $entityTable
4319    * @param bool $groupBy
4320    *   Add GroupBy? Not appropriate for detail report.
4321    * @param bool $orderBy
4322    *   Add OrderBy? Not appropriate for detail report.
4323    * @param bool $filters
4324    *
4325    */
4326   public function addCampaignFields($entityTable = 'civicrm_contribution', $groupBy = FALSE, $orderBy = FALSE, $filters = TRUE) {
4327     // Check if CiviCampaign is a) enabled and b) has active campaigns
4328     $config = CRM_Core_Config::singleton();
4329     $campaignEnabled = in_array('CiviCampaign', $config->enableComponents);
4330     if ($campaignEnabled) {
4331       $getCampaigns = CRM_Campaign_BAO_Campaign::getPermissionedCampaigns(NULL, NULL, FALSE, FALSE, TRUE);
4332       // If we have a campaign, build out the relevant elements
4333       if (!empty($getCampaigns['campaigns'])) {
4334         $this->campaigns = $getCampaigns['campaigns'];
4335         asort($this->campaigns);
4336         $this->_columns[$entityTable]['fields']['campaign_id'] = ['title' => ts('Campaign'), 'default' => 'false'];
4337         if ($filters) {
4338           $this->_columns[$entityTable]['filters']['campaign_id'] = [
4339             'title' => ts('Campaign'),
4340             'operatorType' => CRM_Report_Form::OP_MULTISELECT,
4341             'options' => $this->campaigns,
4342             'type' => CRM_Utils_Type::T_INT,
4343           ];
4344         }
4345
4346         if ($groupBy) {
4347           $this->_columns[$entityTable]['group_bys']['campaign_id'] = ['title' => ts('Campaign')];
4348         }
4349
4350         if ($orderBy) {
4351           $this->_columns[$entityTable]['order_bys']['campaign_id'] = ['title' => ts('Campaign')];
4352         }
4353       }
4354     }
4355   }
4356
4357   /**
4358    * Add address fields.
4359    *
4360    * @deprecated - use getAddressColumns which is a more accurate description
4361    * and also accepts an array of options rather than a long list
4362    *
4363    * adding address fields to construct function in reports
4364    *
4365    * @param bool $groupBy
4366    *   Add GroupBy? Not appropriate for detail report.
4367    * @param bool $orderBy
4368    *   Add GroupBy? Not appropriate for detail report.
4369    * @param bool $filters
4370    * @param array $defaults
4371    *
4372    * @return array
4373    *   address fields for construct clause
4374    */
4375   public function addAddressFields($groupBy = TRUE, $orderBy = FALSE, $filters = TRUE, $defaults = ['country_id' => TRUE]) {
4376     $defaultAddressFields = [
4377       'street_address' => ts('Street Address'),
4378       'supplemental_address_1' => ts('Supplementary Address Field 1'),
4379       'supplemental_address_2' => ts('Supplementary Address Field 2'),
4380       'supplemental_address_3' => ts('Supplementary Address Field 3'),
4381       'street_number' => ts('Street Number'),
4382       'street_name' => ts('Street Name'),
4383       'street_unit' => ts('Street Unit'),
4384       'city' => ts('City'),
4385       'postal_code' => ts('Postal Code'),
4386       'postal_code_suffix' => ts('Postal Code Suffix'),
4387       'country_id' => ts('Country'),
4388       'state_province_id' => ts('State/Province'),
4389       'county_id' => ts('County'),
4390     ];
4391     $addressFields = [
4392       'civicrm_address' => [
4393         'dao' => 'CRM_Core_DAO_Address',
4394         'fields' => [
4395           'address_name' => [
4396             'title' => ts('Address Name'),
4397             'default' => $defaults['name'] ?? FALSE,
4398             'name' => 'name',
4399           ],
4400         ],
4401         'grouping' => 'location-fields',
4402       ],
4403     ];
4404     foreach ($defaultAddressFields as $fieldName => $fieldLabel) {
4405       $addressFields['civicrm_address']['fields'][$fieldName] = [
4406         'title' => $fieldLabel,
4407         'default' => $defaults[$fieldName] ?? FALSE,
4408       ];
4409     }
4410
4411     $street_address_filters = $general_address_filters = [];
4412     if ($filters) {
4413       // Address filter depends on whether street address parsing is enabled.
4414       // (CRM-18696)
4415       $addressOptions = CRM_Core_BAO_Setting::valueOptions(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
4416         'address_options'
4417       );
4418       if ($addressOptions['street_address_parsing']) {
4419         $street_address_filters = [
4420           'street_number' => [
4421             'title' => ts('Street Number'),
4422             'type' => CRM_Utils_Type::T_INT,
4423             'name' => 'street_number',
4424           ],
4425           'street_name' => [
4426             'title' => ts('Street Name'),
4427             'name' => 'street_name',
4428             'type' => CRM_Utils_Type::T_STRING,
4429           ],
4430         ];
4431       }
4432       else {
4433         $street_address_filters = [
4434           'street_address' => [
4435             'title' => ts('Street Address'),
4436             'type' => CRM_Utils_Type::T_STRING,
4437             'name' => 'street_address',
4438           ],
4439         ];
4440       }
4441       $general_address_filters = [
4442         'postal_code' => [
4443           'title' => ts('Postal Code'),
4444           'type' => CRM_Utils_Type::T_STRING,
4445           'name' => 'postal_code',
4446         ],
4447         'city' => [
4448           'title' => ts('City'),
4449           'type' => CRM_Utils_Type::T_STRING,
4450           'name' => 'city',
4451         ],
4452         'country_id' => [
4453           'name' => 'country_id',
4454           'title' => ts('Country'),
4455           'type' => CRM_Utils_Type::T_INT,
4456           'operatorType' => CRM_Report_Form::OP_MULTISELECT,
4457           'options' => CRM_Core_PseudoConstant::country(),
4458         ],
4459         'state_province_id' => [
4460           'name' => 'state_province_id',
4461           'title' => ts('State/Province'),
4462           'type' => CRM_Utils_Type::T_INT,
4463           'operatorType' => CRM_Report_Form::OP_MULTISELECT,
4464           'options' => [],
4465         ],
4466         'county_id' => [
4467           'name' => 'county_id',
4468           'title' => ts('County'),
4469           'type' => CRM_Utils_Type::T_INT,
4470           'operatorType' => CRM_Report_Form::OP_MULTISELECT,
4471           'options' => [],
4472         ],
4473       ];
4474     }
4475     $addressFields['civicrm_address']['filters'] = array_merge(
4476         $street_address_filters,
4477         $general_address_filters);
4478
4479     if ($orderBy) {
4480       $addressFields['civicrm_address']['order_bys'] = [
4481         'street_name' => ['title' => ts('Street Name')],
4482         'street_number' => ['title' => ts('Odd / Even Street Number')],
4483         'street_address' => NULL,
4484         'city' => NULL,
4485         'postal_code' => NULL,
4486       ];
4487     }
4488
4489     if ($groupBy) {
4490       $addressFields['civicrm_address']['group_bys'] = [
4491         'street_address' => NULL,
4492         'city' => NULL,
4493         'postal_code' => NULL,
4494         'state_province_id' => [
4495           'title' => ts('State/Province'),
4496         ],
4497         'country_id' => [
4498           'title' => ts('Country'),
4499         ],
4500         'county_id' => [
4501           'title' => ts('County'),
4502         ],
4503       ];
4504     }
4505     return $addressFields;
4506   }
4507
4508   /**
4509    * Do AlterDisplay processing on Address Fields.
4510    *  If there are multiple address field values then
4511    *  on basis of provided separator the code values are translated into respective labels
4512    *
4513    * @param array $row
4514    * @param array $rows
4515    * @param int $rowNum
4516    * @param string $baseUrl
4517    * @param string $linkText
4518    * @param string $separator
4519    *
4520    * @return bool
4521    */
4522   public function alterDisplayAddressFields(&$row, &$rows, &$rowNum, $baseUrl, $linkText, $separator = ',') {
4523     $criteriaQueryParams = CRM_Report_Utils_Report::getPreviewCriteriaQueryParams($this->_defaults, $this->_params);
4524     $entryFound = FALSE;
4525     $columnMap = [
4526       'civicrm_address_country_id' => 'country',
4527       'civicrm_address_county_id' => 'county',
4528       'civicrm_address_state_province_id' => 'stateProvince',
4529     ];
4530     foreach ($columnMap as $fieldName => $fnName) {
4531       if (array_key_exists($fieldName, $row)) {
4532         if ($values = $row[$fieldName]) {
4533           $values = (array) explode($separator, $values);
4534           $rows[$rowNum][$fieldName] = [];
4535           $addressField = $fnName == 'stateProvince' ? 'state' : $fnName;
4536           foreach ($values as $value) {
4537             $rows[$rowNum][$fieldName][] = CRM_Core_PseudoConstant::$fnName($value);
4538           }
4539           $rows[$rowNum][$fieldName] = implode($separator, $rows[$rowNum][$fieldName]);
4540           if ($baseUrl) {
4541             $url = CRM_Report_Utils_Report::getNextUrl($baseUrl,
4542               sprintf("reset=1&force=1&%s&%s_op=in&%s_value=%s",
4543                 $criteriaQueryParams,
4544                 str_replace('civicrm_address_', '', $fieldName),
4545                 str_replace('civicrm_address_', '', $fieldName),
4546                 implode(',', $values)
4547               ), $this->_absoluteUrl, $this->_id
4548             );
4549             $rows[$rowNum]["{$fieldName}_link"] = $url;
4550             $rows[$rowNum]["{$fieldName}_hover"] = ts("%1 for this %2.", [1 => $linkText, 2 => $addressField]);
4551           }
4552         }
4553         $entryFound = TRUE;
4554       }
4555     }
4556
4557     return $entryFound;
4558   }
4559
4560   /**
4561    * Do AlterDisplay processing on Address Fields.
4562    *
4563    * @param array $row
4564    * @param array $rows
4565    * @param int $rowNum
4566    * @param string $baseUrl
4567    * @param string $linkText
4568    *
4569    * @return bool
4570    */
4571   public function alterDisplayContactFields(&$row, &$rows, &$rowNum, $baseUrl, $linkText) {
4572     $entryFound = FALSE;
4573     // There is no reason not to add links for all fields but it seems a bit odd to be able to click on
4574     // 'Mrs'. Also, we don't have metadata about the title. So, add selectively to addLinks.
4575     $addLinks = ['gender_id' => 'Gender'];
4576     foreach (['prefix_id', 'suffix_id', 'gender_id', 'contact_sub_type', 'preferred_language'] as $fieldName) {
4577       if (array_key_exists('civicrm_contact_' . $fieldName, $row)) {
4578         if (($value = $row['civicrm_contact_' . $fieldName]) != FALSE) {
4579           $rowValues = explode(CRM_Core_DAO::VALUE_SEPARATOR, $value);
4580           $rowLabels = [];
4581           foreach ($rowValues as $rowValue) {
4582             if ($rowValue) {
4583               $rowLabels[] = CRM_Core_PseudoConstant::getLabel('CRM_Contact_BAO_Contact', $fieldName, $rowValue);
4584             }
4585           }
4586           $rows[$rowNum]['civicrm_contact_' . $fieldName] = implode(', ', $rowLabels);
4587           if ($baseUrl && ($title = CRM_Utils_Array::value($fieldName, $addLinks)) != FALSE) {
4588             $this->addLinkToRow($rows[$rowNum], $baseUrl, $linkText, $value, $fieldName, 'civicrm_contact', $title);
4589           }
4590         }
4591         $entryFound = TRUE;
4592       }
4593     }
4594     $yesNoFields = [
4595       'do_not_email', 'is_deceased', 'do_not_phone', 'do_not_sms', 'do_not_mail', 'is_opt_out',
4596     ];
4597     foreach ($yesNoFields as $fieldName) {
4598       if (array_key_exists('civicrm_contact_' . $fieldName, $row)) {
4599         // Since these are essentially 'negative fields' it feels like it
4600         // makes sense to only highlight the exceptions hence no 'No'.
4601         $rows[$rowNum]['civicrm_contact_' . $fieldName] = !empty($rows[$rowNum]['civicrm_contact_' . $fieldName]) ? ts('Yes') : '';
4602         $entryFound = TRUE;
4603       }
4604     }
4605
4606     // Handle employer id
4607     if (array_key_exists('civicrm_contact_employer_id', $row)) {
4608       $employerId = $row['civicrm_contact_employer_id'];
4609       if ($employerId) {
4610         $rows[$rowNum]['civicrm_contact_employer_id'] = CRM_Contact_BAO_Contact::displayName($employerId);
4611         $rows[$rowNum]['civicrm_contact_employer_id_link'] = CRM_Utils_System::url('civicrm/contact/view', 'reset=1&cid=' . $employerId, $this->_absoluteUrl);
4612         $rows[$rowNum]['civicrm_contact_employer_id_hover'] = ts('View Contact Summary for Employer.');
4613         $entryFound = TRUE;
4614       }
4615     }
4616
4617     return $entryFound;
4618   }
4619
4620   /**
4621    * Adjusts dates passed in to YEAR() for fiscal year.
4622    *
4623    * @param string $fieldName
4624    *
4625    * @return string
4626    */
4627   public function fiscalYearOffset($fieldName) {
4628     $config = CRM_Core_Config::singleton();
4629     $fy = $config->fiscalYearStart;
4630     if (CRM_Utils_Array::value('yid_op', $this->_params) == 'calendar' ||
4631       ($fy['d'] == 1 && $fy['M'] == 1)
4632     ) {
4633       return "YEAR( $fieldName )";
4634     }
4635     return "YEAR( $fieldName - INTERVAL " . ($fy['M'] - 1) . " MONTH" .
4636     ($fy['d'] > 1 ? (" - INTERVAL " . ($fy['d'] - 1) . " DAY") : '') . " )";
4637   }
4638
4639   /**
4640    * Add Address into From Table if required.
4641    *
4642    * Prefix will be added to both tables as
4643    * it is assumed you are using it to get address of a secondary contact.
4644    *
4645    * @param string $prefix
4646    * @param array $extra Additional options.
4647    *      Not currently used in core but may be used in override extensions.
4648    */
4649   protected function joinAddressFromContact($prefix = '', $extra = []) {
4650     $defaults = ['primary_only' => TRUE];
4651     $params = array_merge($defaults, $extra);
4652     $addressTables = ['civicrm_address', 'civicrm_country', 'civicrm_worldregion', 'civicrm_state_province'];
4653     $isJoinRequired = $this->_addressField;
4654     foreach ($addressTables as $addressTable) {
4655       if ($this->isTableSelected($prefix . $addressTable)) {
4656         $isJoinRequired = TRUE;
4657       }
4658     }
4659     if ($isJoinRequired) {
4660       $fromJoin = "
4661                  LEFT JOIN civicrm_address {$this->_aliases[$prefix . 'civicrm_address']}
4662                            ON ({$this->_aliases[$prefix . 'civicrm_contact']}.id =
4663                                {$this->_aliases[$prefix . 'civicrm_address']}.contact_id)";
4664       if ($params['primary_only']) {
4665         $fromJoin .= "  AND
4666                                {$this->_aliases[$prefix . 'civicrm_address']}.is_primary = 1\n";
4667       }
4668       $this->_from .= $fromJoin;
4669     }
4670   }
4671
4672   /**
4673    * Add Country into From Table if required.
4674    *
4675    * Prefix will be added to both tables as
4676    * it is assumed you are using it to get address of a secondary contact.
4677    *
4678    * @param string $prefix
4679    * @param array $extra Additional options.
4680    *      Not currently used in core but may be used in override extensions.
4681    */
4682   protected function joinCountryFromAddress($prefix = '', $extra = []) {
4683     $defaults = ['primary_only' => TRUE];
4684     $params = array_merge($defaults, $extra);
4685     // include country field if country column is to be included
4686     if ($this->isTableSelected($prefix . 'civicrm_country') || $this->isTableSelected($prefix . 'civicrm_worldregion')) {
4687       if (empty($this->_aliases[$prefix . 'civicrm_country'])) {
4688         $this->_aliases[$prefix . 'civicrm_country'] = $prefix . '_report_country';
4689       }
4690       $fromJoin = "
4691             LEFT JOIN civicrm_country {$this->_aliases[$prefix . 'civicrm_country']}
4692                    ON {$this->_aliases[$prefix . 'civicrm_address']}.country_id = {$this->_aliases[$prefix . 'civicrm_country']}.id";
4693       if ($params['primary_only']) {
4694         $fromJoin .= " AND
4695                       {$this->_aliases[$prefix . 'civicrm_address']}.is_primary = 1 ";
4696       }
4697       $this->_from .= $fromJoin;
4698     }
4699   }
4700
4701   /**
4702    * Add Phone into From Table if required.
4703    *
4704    * Prefix will be added to both tables as
4705    * it is assumed you are using it to get address of a secondary contact.
4706    *
4707    * @param string $prefix
4708    * @param array $extra Additional options.
4709    *      Not currently used in core but may be used in override extensions.
4710    */
4711   protected function joinPhoneFromContact($prefix = '', $extra = []) {
4712     $defaults = ['primary_only' => TRUE];
4713     $params = array_merge($defaults, $extra);
4714     // include phone field if phone column is to be included
4715     if ($this->isTableSelected($prefix . 'civicrm_phone')) {
4716       $fromJoin = "
4717       LEFT JOIN civicrm_phone {$this->_aliases[$prefix . 'civicrm_phone']}
4718              ON {$this->_aliases[$prefix . 'civicrm_contact']}.id = {$this->_aliases[$prefix . 'civicrm_phone']}.contact_id";
4719       if ($params['primary_only']) {
4720         $fromJoin .= " AND
4721                 {$this->_aliases[$prefix . 'civicrm_phone']}.is_primary = 1\n";
4722       }
4723       $this->_from .= $fromJoin;
4724     }
4725   }
4726
4727   /**
4728    * Add Email into From Table if required.
4729    *
4730    * Prefix will be added to both tables as
4731    * it is assumed you are using it to get address of a secondary contact.
4732    *
4733    * @param string $prefix
4734    * @param array $extra Additional options.
4735    *      Not currently used in core but may be used in override extensions.
4736    */
4737   protected function joinEmailFromContact($prefix = '', $extra = []) {
4738     $defaults = ['primary_only' => TRUE];
4739     $params = array_merge($defaults, $extra);
4740     // include email field if email column is to be included
4741     if ($this->isTableSelected($prefix . 'civicrm_email')) {
4742       $fromJoin = "
4743             LEFT JOIN  civicrm_email {$this->_aliases[$prefix . 'civicrm_email']}
4744                    ON {$this->_aliases[$prefix . 'civicrm_contact']}.id = {$this->_aliases[$prefix . 'civicrm_email']}.contact_id";
4745       if ($params['primary_only']) {
4746         $fromJoin .= " AND
4747                        {$this->_aliases[$prefix . 'civicrm_email']}.is_primary = 1 ";
4748       }
4749       $this->_from .= $fromJoin;
4750     }
4751   }
4752
4753   /**
4754    * Add Financial Transaction into From Table if required.
4755    */
4756   public function addFinancialTrxnFromClause() {
4757     if ($this->isTableSelected('civicrm_financial_trxn')) {
4758       $this->_from .= "
4759          LEFT JOIN civicrm_entity_financial_trxn eftcc
4760            ON ({$this->_aliases['civicrm_contribution']}.id = eftcc.entity_id AND
4761              eftcc.entity_table = 'civicrm_contribution')
4762          LEFT JOIN civicrm_financial_trxn {$this->_aliases['civicrm_financial_trxn']}
4763            ON {$this->_aliases['civicrm_financial_trxn']}.id = eftcc.financial_trxn_id \n";
4764     }
4765   }
4766
4767   /**
4768    * Get phone columns to add to array.
4769    *
4770    * @param array $options
4771    *   - prefix Prefix to add to table (in case of more than one instance of the table)
4772    *   - prefix_label Label to give columns from this phone table instance
4773    *
4774    * @return array
4775    *   phone columns definition
4776    */
4777   public function getPhoneColumns($options = []) {
4778     $defaultOptions = [
4779       'prefix' => '',
4780       'prefix_label' => '',
4781     ];
4782
4783     $options = array_merge($defaultOptions, $options);
4784
4785     $fields = [
4786       $options['prefix'] . 'civicrm_phone' => [
4787         'dao' => 'CRM_Core_DAO_Phone',
4788         'fields' => [
4789           $options['prefix'] . 'phone' => [
4790             'title' => $options['prefix_label'] . ts('Phone'),
4791             'name' => 'phone',
4792           ],
4793         ],
4794       ],
4795     ];
4796     return $fields;
4797   }
4798
4799   /**
4800    * Get a standard set of contact fields.
4801    * @deprecated - use getColumns('Contact') instead
4802    * @return array
4803    */
4804   public function getBasicContactFields() {
4805     return [
4806       'sort_name' => [
4807         'title' => ts('Contact Name'),
4808         'required' => TRUE,
4809         'default' => TRUE,
4810       ],
4811       'id' => [
4812         'no_display' => TRUE,
4813         'required' => TRUE,
4814       ],
4815       'prefix_id' => [
4816         'title' => ts('Contact Prefix'),
4817       ],
4818       'first_name' => [
4819         'title' => ts('First Name'),
4820       ],
4821       'nick_name' => [
4822         'title' => ts('Nick Name'),
4823       ],
4824       'middle_name' => [
4825         'title' => ts('Middle Name'),
4826       ],
4827       'last_name' => [
4828         'title' => ts('Last Name'),
4829       ],
4830       'suffix_id' => [
4831         'title' => ts('Contact Suffix'),
4832       ],
4833       'postal_greeting_display' => ['title' => ts('Postal Greeting')],
4834       'email_greeting_display' => ['title' => ts('Email Greeting')],
4835       'addressee_display' => ['title' => ts('Addressee')],
4836       'contact_type' => [
4837         'title' => ts('Contact Type'),
4838       ],
4839       'contact_sub_type' => [
4840         'title' => ts('Contact Subtype'),
4841       ],
4842       'gender_id' => [
4843         'title' => ts('Gender'),
4844       ],
4845       'birth_date' => [
4846         'title' => ts('Birth Date'),
4847       ],
4848       'age' => [
4849         'title' => ts('Age'),
4850         'dbAlias' => 'TIMESTAMPDIFF(YEAR, contact_civireport.birth_date, CURDATE())',
4851       ],
4852       'job_title' => [
4853         'title' => ts('Contact Job title'),
4854       ],
4855       'organization_name' => [
4856         'title' => ts('Organization Name'),
4857       ],
4858       'external_identifier' => [
4859         'title' => ts('Contact identifier from external system'),
4860       ],
4861       'do_not_email' => [],
4862       'do_not_phone' => [],
4863       'do_not_mail' => [],
4864       'do_not_sms' => [],
4865       'is_opt_out' => [],
4866       'is_deceased' => [],
4867       'preferred_language' => [],
4868       'employer_id' => [
4869         'title' => ts('Current Employer'),
4870       ],
4871     ];
4872   }
4873
4874   /**
4875    * Get a standard set of contact filters.
4876    *
4877    * @param array $defaults
4878    *
4879    * @return array
4880    */
4881   public function getBasicContactFilters($defaults = []) {
4882     return [
4883       'sort_name' => [
4884         'title' => ts('Contact Name'),
4885       ],
4886       'source' => [
4887         'title' => ts('Contact Source'),
4888         'type' => CRM_Utils_Type::T_STRING,
4889       ],
4890       'id' => [
4891         'title' => ts('Contact ID'),
4892         'no_display' => TRUE,
4893       ],
4894       'gender_id' => [
4895         'title' => ts('Gender'),
4896         'operatorType' => CRM_Report_Form::OP_MULTISELECT,
4897         'options' => CRM_Core_PseudoConstant::get('CRM_Contact_DAO_Contact', 'gender_id'),
4898       ],
4899       'birth_date' => [
4900         'title' => ts('Birth Date'),
4901         'operatorType' => CRM_Report_Form::OP_DATE,
4902       ],
4903       'contact_type' => [
4904         'title' => ts('Contact Type'),
4905       ],
4906       'contact_sub_type' => [
4907         'title' => ts('Contact Subtype'),
4908       ],
4909       'modified_date' => [
4910         'title' => ts('Contact Modified'),
4911         'operatorType' => CRM_Report_Form::OP_DATE,
4912         'type' => CRM_Utils_Type::T_DATE,
4913       ],
4914       'is_deceased' => [
4915         'title' => ts('Deceased'),
4916         'type' => CRM_Utils_Type::T_BOOLEAN,
4917         'default' => CRM_Utils_Array::value('deceased', $defaults, 0),
4918       ],
4919       'do_not_email' => [
4920         'title' => ts('Do not email'),
4921         'type' => CRM_Utils_Type::T_BOOLEAN,
4922       ],
4923       'do_not_phone' => [
4924         'title' => ts('Do not phone'),
4925         'type' => CRM_Utils_Type::T_BOOLEAN,
4926       ],
4927       'do_not_mail' => [
4928         'title' => ts('Do not mail'),
4929         'type' => CRM_Utils_Type::T_BOOLEAN,
4930       ],
4931       'do_not_sms' => [
4932         'title' => ts('Do not SMS'),
4933         'type' => CRM_Utils_Type::T_BOOLEAN,
4934       ],
4935       'is_opt_out' => [
4936         'title' => ts('Do not bulk email'),
4937         'type' => CRM_Utils_Type::T_BOOLEAN,
4938       ],
4939       'preferred_language' => [
4940         'title' => ts('Preferred Language'),
4941       ],
4942       'is_deleted' => [
4943         'no_display' => TRUE,
4944         'default' => 0,
4945         'type' => CRM_Utils_Type::T_BOOLEAN,
4946       ],
4947     ];
4948   }
4949
4950   /**
4951    * Add contact to group.
4952    *
4953    * @param int $groupID
4954    */
4955   public function add2group($groupID) {
4956     if (is_numeric($groupID) && isset($this->_aliases['civicrm_contact'])) {
4957       $select = "SELECT DISTINCT {$this->_aliases['civicrm_contact']}.id AS addtogroup_contact_id, ";
4958       $select = preg_replace('/SELECT(\s+SQL_CALC_FOUND_ROWS)?\s+/i', $select, $this->_select);
4959       $sql = "{$select} {$this->_from} {$this->_where} {$this->_groupBy} {$this->_having} {$this->_orderBy}";
4960       $sql = str_replace('WITH ROLLUP', '', $sql);
4961       $dao = CRM_Core_DAO::executeQuery($sql);
4962
4963       $contact_ids = [];
4964       // Add resulting contacts to group
4965       while ($dao->fetch()) {
4966         if ($dao->addtogroup_contact_id) {
4967           $contact_ids[$dao->addtogroup_contact_id] = $dao->addtogroup_contact_id;
4968         }
4969       }
4970
4971       if (!empty($contact_ids)) {
4972         CRM_Contact_BAO_GroupContact::addContactsToGroup($contact_ids, $groupID);
4973         CRM_Core_Session::setStatus(ts("Listed contact(s) have been added to the selected group."), ts('Contacts Added'), 'success');
4974       }
4975       else {
4976         CRM_Core_Session::setStatus(ts("The listed records(s) cannot be added to the group."));
4977       }
4978     }
4979   }
4980
4981   /**
4982    * Apply common settings to entityRef fields.
4983    *
4984    * @param array $field
4985    * @param string $table
4986    */
4987   public function setEntityRefDefaults(&$field, $table) {
4988     $field['attributes'] = $field['attributes'] ? $field['attributes'] : [];
4989     $field['attributes'] += [
4990       'entity' => CRM_Core_DAO_AllCoreTables::getBriefName(CRM_Core_DAO_AllCoreTables::getClassForTable($table)),
4991       'multiple' => TRUE,
4992       'placeholder' => ts('- select -'),
4993     ];
4994   }
4995
4996   /**
4997    * Add link fields to the row.
4998    *
4999    * Function adds the _link & _hover fields to the row.
5000    *
5001    * @param array $row
5002    * @param string $baseUrl
5003    * @param string $linkText
5004    * @param string $value
5005    * @param string $fieldName
5006    * @param string $tablePrefix
5007    * @param string $fieldLabel
5008    *
5009    * @return mixed
5010    */
5011   protected function addLinkToRow(&$row, $baseUrl, $linkText, $value, $fieldName, $tablePrefix, $fieldLabel) {
5012     $criteriaQueryParams = CRM_Report_Utils_Report::getPreviewCriteriaQueryParams($this->_defaults, $this->_params);
5013     $url = CRM_Report_Utils_Report::getNextUrl($baseUrl,
5014       "reset=1&force=1&{$criteriaQueryParams}&" .
5015       $fieldName . "_op=in&{$fieldName}_value={$value}",
5016       $this->_absoluteUrl, $this->_id
5017     );
5018     $row["{$tablePrefix}_{$fieldName}_link"] = $url;
5019     $row["{$tablePrefix}_{$fieldName}_hover"] = ts("%1 for this %2.",
5020       [1 => $linkText, 2 => $fieldLabel]
5021     );
5022   }
5023
5024   /**
5025    * Get label for show results buttons.
5026    *
5027    * @return string
5028    */
5029   public function getResultsLabel() {
5030     $showResultsLabel = $this->resultsDisplayed() ? ts('Refresh results') : ts('View results');
5031     return $showResultsLabel;
5032   }
5033
5034   /**
5035    * Determine the output mode from the url or input.
5036    *
5037    * Output could be
5038    *   - pdf : Render as pdf
5039    *   - csv : Render as csv
5040    *   - print : Render in print format
5041    *   - save : save the report and display the new report
5042    *   - copy : save the report as a new instance and display that.
5043    *   - group : go to the add to group screen.
5044    *
5045    *  Potentially chart variations could also be included but the complexity
5046    *   is that we might print a bar chart as a pdf.
5047    */
5048   protected function setOutputMode() {
5049     $this->_outputMode = str_replace('report_instance.', '', CRM_Utils_Request::retrieve(
5050       'output',
5051       'String',
5052       CRM_Core_DAO::$_nullObject,
5053       FALSE,
5054       CRM_Utils_Array::value('task', $this->_params)
5055     ));
5056     // if contacts are added to group
5057     if (!empty($this->_params['groups']) && empty($this->_outputMode)) {
5058       $this->_outputMode = 'group';
5059     }
5060     if (isset($this->_params['task'])) {
5061       unset($this->_params['task']);
5062     }
5063   }
5064
5065   /**
5066    * CRM-17793 - Alter DateTime section header to group by date from the datetime field.
5067    *
5068    * @param $tempTable
5069    * @param $columnName
5070    */
5071   public function alterSectionHeaderForDateTime($tempTable, $columnName) {
5072     // add new column with date value for the datetime field
5073     $tempQuery = "ALTER TABLE {$tempTable} ADD COLUMN {$columnName}_date VARCHAR(128)";
5074     CRM_Core_DAO::executeQuery($tempQuery);
5075     $updateQuery = "UPDATE {$tempTable} SET {$columnName}_date = date({$columnName})";
5076     CRM_Core_DAO::executeQuery($updateQuery);
5077     $this->_selectClauses[] = "{$columnName}_date";
5078     $this->_select .= ", {$columnName}_date";
5079     $this->_sections["{$columnName}_date"] = $this->_sections["{$columnName}"];
5080     unset($this->_sections["{$columnName}"]);
5081     $this->assign('sections', $this->_sections);
5082   }
5083
5084   /**
5085    * Get an array of the columns that have been selected for display.
5086    *
5087    * @return array
5088    */
5089   public function getSelectColumns() {
5090     $selectColumns = [];
5091     foreach ($this->_columns as $tableName => $table) {
5092       if (array_key_exists('fields', $table)) {
5093         foreach ($table['fields'] as $fieldName => $field) {
5094           if (!empty($field['required']) ||
5095             !empty($this->_params['fields'][$fieldName])
5096           ) {
5097
5098             $selectColumns["{$tableName}_{$fieldName}"] = 1;
5099           }
5100         }
5101       }
5102     }
5103     return $selectColumns;
5104   }
5105
5106   /**
5107    * Add location tables to the query if they are used for filtering.
5108    *
5109    * This is for when we are running the query separately for filtering and retrieving display fields.
5110    */
5111   public function selectivelyAddLocationTablesJoinsToFilterQuery() {
5112     if ($this->isTableFiltered('civicrm_email')) {
5113       $this->_from .= "
5114           LEFT  JOIN civicrm_email  {$this->_aliases['civicrm_email']}
5115             ON {$this->_aliases['civicrm_contact']}.id = {$this->_aliases['civicrm_email']}.contact_id
5116             AND {$this->_aliases['civicrm_email']}.is_primary = 1";
5117     }
5118     if ($this->isTableFiltered('civicrm_phone')) {
5119       $this->_from .= "
5120           LEFT  JOIN civicrm_phone  {$this->_aliases['civicrm_phone']}
5121             ON {$this->_aliases['civicrm_contact']}.id = {$this->_aliases['civicrm_phone']}.contact_id
5122             AND {$this->_aliases['civicrm_phone']}.is_primary = 1";
5123     }
5124     if ($this->isTableFiltered('civicrm_address')) {
5125       $this->_from .= "
5126           LEFT JOIN civicrm_address {$this->_aliases['civicrm_address']}
5127           ON ({$this->_aliases['civicrm_contact']}.id = {$this->_aliases['civicrm_address']}.contact_id)
5128           AND {$this->_aliases['civicrm_address']}.is_primary = 1\n";
5129     }
5130   }
5131
5132   /**
5133    * Set the base table for the FROM clause.
5134    *
5135    * Sets up the from clause, allowing for the possibility it might be a
5136    * temp table pre-filtered by groups if a group filter is in use.
5137    *
5138    * @param string $baseTable
5139    * @param string $field
5140    * @param null $tableAlias
5141    */
5142   public function setFromBase($baseTable, $field = 'id', $tableAlias = NULL) {
5143     if (!$tableAlias) {
5144       $tableAlias = $this->_aliases[$baseTable];
5145     }
5146     $this->_from = $this->_from = " FROM $baseTable $tableAlias ";
5147     $this->joinGroupTempTable($baseTable, $field, $tableAlias);
5148     $this->_from .= " {$this->_aclFrom} ";
5149   }
5150
5151   /**
5152    * Join the temp table contacting contacts who are members of the filtered groups.
5153    *
5154    * If we are using an IN filter we use an inner join, otherwise a left join.
5155    *
5156    * @param string $baseTable
5157    * @param string $field
5158    * @param string $tableAlias
5159    */
5160   public function joinGroupTempTable($baseTable, $field, $tableAlias) {
5161     if ($this->groupTempTable) {
5162       if ($this->_params['gid_op'] == 'in') {
5163         $this->_from = " FROM $this->groupTempTable group_temp_table INNER JOIN $baseTable $tableAlias
5164         ON group_temp_table.id = $tableAlias.{$field} ";
5165       }
5166       else {
5167         $this->_from .= "
5168           LEFT JOIN $this->groupTempTable group_temp_table
5169           ON $tableAlias.{$field} = group_temp_table.id ";
5170       }
5171     }
5172   }
5173
5174   /**
5175    * Get all labels for fields that are used in a group concat.
5176    *
5177    * @param string $options
5178    *   comma separated option values.
5179    * @param string $baoName
5180    *   The BAO name for the field.
5181    * @param string $fieldName
5182    *   The name of the field for which labels should be retrieved.
5183    *
5184    * return string
5185    */
5186   public function getLabels($options, $baoName, $fieldName) {
5187     $types = explode(',', $options);
5188     $labels = [];
5189     foreach ($types as $value) {
5190       $labels[$value] = CRM_Core_PseudoConstant::getLabel($baoName, $fieldName, $value);
5191     }
5192     return implode(', ', array_filter($labels));
5193   }
5194
5195   /**
5196    * Add statistics columns.
5197    *
5198    * If a group by is in play then add columns for the statistics fields.
5199    *
5200    * This would lead to a new field in the $row such as $fieldName_sum and a new, matching
5201    * column header field.
5202    *
5203    * @param array $field
5204    * @param string $tableName
5205    * @param string $fieldName
5206    * @param array $select
5207    *
5208    * @return array
5209    */
5210   protected function addStatisticsToSelect($field, $tableName, $fieldName, $select) {
5211     foreach ($field['statistics'] as $stat => $label) {
5212       $alias = "{$tableName}_{$fieldName}_{$stat}";
5213       switch (strtolower($stat)) {
5214         case 'max':
5215         case 'sum':
5216           $select[] = "$stat({$field['dbAlias']}) as $alias";
5217           $this->_columnHeaders["{$tableName}_{$fieldName}_{$stat}"]['title'] = $label;
5218           $this->_columnHeaders["{$tableName}_{$fieldName}_{$stat}"]['type'] = $field['type'];
5219           $this->_statFields[$label] = $alias;
5220           $this->_selectAliases[] = $alias;
5221           break;
5222
5223         case 'count':
5224           $select[] = "COUNT({$field['dbAlias']}) as $alias";
5225           $this->_columnHeaders["{$tableName}_{$fieldName}_{$stat}"]['title'] = $label;
5226           $this->_columnHeaders["{$tableName}_{$fieldName}_{$stat}"]['type'] = CRM_Utils_Type::T_INT;
5227           $this->_statFields[$label] = $alias;
5228           $this->_selectAliases[] = $alias;
5229           break;
5230
5231         case 'count_distinct':
5232           $select[] = "COUNT(DISTINCT {$field['dbAlias']}) as $alias";
5233           $this->_columnHeaders["{$tableName}_{$fieldName}_{$stat}"]['title'] = $label;
5234           $this->_columnHeaders["{$tableName}_{$fieldName}_{$stat}"]['type'] = CRM_Utils_Type::T_INT;
5235           $this->_statFields[$label] = $alias;
5236           $this->_selectAliases[] = $alias;
5237           break;
5238
5239         case 'avg':
5240           $select[] = "ROUND(AVG({$field['dbAlias']}),2) as $alias";
5241           $this->_columnHeaders["{$tableName}_{$fieldName}_{$stat}"]['title'] = $label;
5242           $this->_columnHeaders["{$tableName}_{$fieldName}_{$stat}"]['type'] = $field['type'];
5243           $this->_statFields[$label] = $alias;
5244           $this->_selectAliases[] = $alias;
5245           break;
5246       }
5247     }
5248     return $select;
5249   }
5250
5251   /**
5252    * Add a basic field to the select clause.
5253    *
5254    * @param string $tableName
5255    * @param string $fieldName
5256    * @param array $field
5257    * @param string $select
5258    * @return array
5259    */
5260   protected function addBasicFieldToSelect($tableName, $fieldName, $field, $select) {
5261     $alias = "{$tableName}_{$fieldName}";
5262     $select[] = "{$field['dbAlias']} as $alias";
5263     $this->_columnHeaders["{$tableName}_{$fieldName}"]['title'] = $field['title'] ?? NULL;
5264     $this->_columnHeaders["{$tableName}_{$fieldName}"]['type'] = $field['type'] ?? NULL;
5265     $this->_selectAliases[] = $alias;
5266     return $select;
5267   }
5268
5269   /**
5270    * Set table alias.
5271    *
5272    * @param array $table
5273    * @param string $tableName
5274    *
5275    * @return string
5276    *   Alias for table.
5277    */
5278   protected function setTableAlias($table, $tableName) {
5279     if (!isset($table['alias'])) {
5280       $this->_columns[$tableName]['alias'] = substr($tableName, 8) .
5281         '_civireport';
5282     }
5283     else {
5284       $this->_columns[$tableName]['alias'] = $table['alias'] . '_civireport';
5285     }
5286
5287     $this->_aliases[$tableName] = $this->_columns[$tableName]['alias'];
5288     return $this->_aliases[$tableName];
5289   }
5290
5291   /**
5292    * Function to add columns to reports.
5293    *
5294    * This is ported from extended reports, which also adds join filters to the options.
5295    *
5296    * @param string $type
5297    * @param array $options
5298    *  - prefix - A string to prepend to the table name
5299    *  - prefix_label  A string to prepend to the fields
5300    *  - fields (bool) - should the fields for this table be made available
5301    *  - group_by (bool) - should the group bys for this table be made available.
5302    *  - order_by (bool) - should the group bys for this table be made available.
5303    *  - filters (bool) - should the filters for this table by made available.
5304    *  - fields_defaults (array) array of fields that should be displayed by default.
5305    *  - filters_defaults (array) array of fields that should be filtered by default.
5306    *  - join_filters (array) fields available for filtering joins (requires additional custom code).
5307    *  - join_fields (array) fields available from join (requires additional custom code).
5308    *  - group_by_defaults (array) array of group bys that should be applied by default.
5309    *  - order_by_defaults (array) array of order bys that should be applied by default.
5310    *  - custom_fields (array) array of entity types for custom fields (not usually required).
5311    *  - contact_type (string) optional restriction on contact type for some tables.
5312    *  - fields_excluded (array) fields that are in the generic set for the table but not in the report.
5313    *
5314    * @return array
5315    */
5316   protected function getColumns($type, $options = []) {
5317     $defaultOptions = [
5318       'prefix' => '',
5319       'prefix_label' => '',
5320       'fields' => TRUE,
5321       'group_bys' => FALSE,
5322       'order_bys' => TRUE,
5323       'filters' => TRUE,
5324       'join_filters' => FALSE,
5325       'fields_defaults' => [],
5326       'filters_defaults' => [],
5327       'group_bys_defaults' => [],
5328       'order_bys_defaults' => [],
5329     ];
5330     $options = array_merge($defaultOptions, $options);
5331
5332     $fn = 'get' . $type . 'Columns';
5333     return $this->$fn($options);
5334   }
5335
5336   /**
5337    * Get columns for contact table.
5338    *
5339    * @param array $options
5340    *
5341    * @return array
5342    */
5343   protected function getContactColumns($options = []) {
5344     $defaultOptions = [
5345       'custom_fields' => ['Individual', 'Contact', 'Organization'],
5346       'fields_defaults' => ['display_name', 'id'],
5347       'order_bys_defaults' => ['sort_name ASC'],
5348       'contact_type' => NULL,
5349     ];
5350
5351     $options = array_merge($defaultOptions, $options);
5352
5353     $tableAlias = $options['prefix'] . 'contact';
5354
5355     $spec = [
5356       $options['prefix'] . 'display_name' => [
5357         'name' => 'display_name',
5358         'title' => $options['prefix_label'] . ts('Contact Name'),
5359         'is_fields' => TRUE,
5360       ],
5361       $options['prefix'] . 'sort_name' => [
5362         'name' => 'sort_name',
5363         'title' => $options['prefix_label'] . ts('Contact Name (in sort format)'),
5364         'is_fields' => TRUE,
5365         'is_filters' => TRUE,
5366         'is_order_bys' => TRUE,
5367       ],
5368       $options['prefix'] . 'id' => [
5369         'name' => 'id',
5370         'title' => $options['prefix_label'] . ts('Contact ID'),
5371         'alter_display' => 'alterContactID',
5372         'type' => CRM_Utils_Type::T_INT,
5373         'is_order_bys' => TRUE,
5374         'is_group_bys' => TRUE,
5375         'is_fields' => TRUE,
5376         'is_filters' => TRUE,
5377       ],
5378       $options['prefix'] . 'external_identifier' => [
5379         'name' => 'external_identifier',
5380         'title' => $options['prefix_label'] . ts('External ID'),
5381         'type' => CRM_Utils_Type::T_INT,
5382         'is_fields' => TRUE,
5383       ],
5384       $options['prefix'] . 'contact_type' => [
5385         'title' => $options['prefix_label'] . ts('Contact Type'),
5386         'name' => 'contact_type',
5387         'operatorType' => CRM_Report_Form::OP_MULTISELECT,
5388         'options' => CRM_Contact_BAO_Contact::buildOptions('contact_type'),
5389         'is_fields' => TRUE,
5390         'is_filters' => TRUE,
5391         'is_group_bys' => TRUE,
5392       ],
5393       $options['prefix'] . 'contact_sub_type' => [
5394         'title' => $options['prefix_label'] . ts('Contact Sub Type'),
5395         'name' => 'contact_sub_type',
5396         'operatorType' => CRM_Report_Form::OP_MULTISELECT,
5397         'options' => CRM_Contact_BAO_Contact::buildOptions('contact_sub_type'),
5398         'is_fields' => TRUE,
5399         'is_filters' => TRUE,
5400         'is_group_bys' => TRUE,
5401       ],
5402       $options['prefix'] . 'is_deleted' => [
5403         'title' => $options['prefix_label'] . ts('Is deleted'),
5404         'name' => 'is_deleted',
5405         'type' => CRM_Utils_Type::T_BOOLEAN,
5406         'is_fields' => FALSE,
5407         'is_filters' => TRUE,
5408         'is_group_bys' => FALSE,
5409       ],
5410       $options['prefix'] . 'external_identifier' => [
5411         'title' => $options['prefix_label'] . ts('Contact identifier from external system'),
5412         'name' => 'external_identifier',
5413         'is_fields' => TRUE,
5414         'is_filters' => FALSE,
5415         'is_group_bys' => FALSE,
5416         'is_order_bys' => TRUE,
5417       ],
5418       $options['prefix'] . 'preferred_language' => [
5419         'title' => $options['prefix_label'] . ts('Preferred Language'),
5420         'name' => 'preferred_language',
5421         'is_fields' => TRUE,
5422         'is_filters' => TRUE,
5423         'is_group_bys' => TRUE,
5424         'is_order_bys' => TRUE,
5425       ],
5426       $options['prefix'] . 'preferred_communication_method' => [
5427         'title' => $options['prefix_label'] . ts('Preferred Communication Method'),
5428         'alter_display' => 'alterCommunicationtMethod',
5429         'name' => 'preferred_communication_method',
5430         'is_fields' => TRUE,
5431         'is_filters' => FALSE,
5432         'is_group_bys' => FALSE,
5433         'is_order_bys' => FALSE,
5434       ],
5435     ];
5436     foreach ([
5437       'postal_greeting_display' => 'Postal Greeting',
5438       'email_greeting_display' => 'Email Greeting',
5439       'addressee_display' => 'Addressee',
5440     ] as $field => $title) {
5441       $spec[$options['prefix'] . $field] = [
5442         'title' => $options['prefix_label'] . ts($title),
5443         'name' => $field,
5444         'is_fields' => TRUE,
5445         'is_filters' => FALSE,
5446         'is_group_bys' => FALSE,
5447       ];
5448     }
5449     foreach (['do_not_email', 'do_not_phone', 'do_not_mail', 'do_not_sms', 'is_opt_out'] as $field) {
5450       $spec[$options['prefix'] . $field] = [
5451         'name' => $field,
5452         'type' => CRM_Utils_Type::T_BOOLEAN,
5453         'is_fields' => TRUE,
5454         'is_filters' => TRUE,
5455         'is_group_bys' => FALSE,
5456       ];
5457     }
5458     $individualFields = [
5459       $options['prefix'] . 'first_name' => [
5460         'name' => 'first_name',
5461         'title' => $options['prefix_label'] . ts('First Name'),
5462         'is_fields' => TRUE,
5463         'is_filters' => TRUE,
5464         'is_order_bys' => TRUE,
5465       ],
5466       $options['prefix'] . 'middle_name' => [
5467         'name' => 'middle_name',
5468         'title' => $options['prefix_label'] . ts('Middle Name'),
5469         'is_fields' => TRUE,
5470       ],
5471       $options['prefix'] . 'last_name' => [
5472         'name' => 'last_name',
5473         'title' => $options['prefix_label'] . ts('Last Name'),
5474         'default_order' => 'ASC',
5475         'is_fields' => TRUE,
5476       ],
5477       $options['prefix'] . 'nick_name' => [
5478         'name' => 'nick_name',
5479         'title' => $options['prefix_label'] . ts('Nick Name'),
5480         'is_fields' => TRUE,
5481       ],
5482       $options['prefix'] . 'prefix_id' => [
5483         'name' => 'prefix_id',
5484         'title' => $options['prefix_label'] . ts('Prefix'),
5485         'options' => CRM_Contact_BAO_Contact::buildOptions('prefix_id'),
5486         'operatorType' => CRM_Report_Form::OP_MULTISELECT,
5487         'is_fields' => TRUE,
5488         'is_filters' => TRUE,
5489       ],
5490       $options['prefix'] . 'suffix_id' => [
5491         'name' => 'suffix_id',
5492         'title' => $options['prefix_label'] . ts('Suffix'),
5493         'options' => CRM_Contact_BAO_Contact::buildOptions('suffix_id'),
5494         'operatorType' => CRM_Report_Form::OP_MULTISELECT,
5495         'is_fields' => TRUE,
5496         'is_filters' => TRUE,
5497       ],
5498       $options['prefix'] . 'gender_id' => [
5499         'name' => 'gender_id',
5500         'title' => $options['prefix_label'] . ts('Gender'),
5501         'options' => CRM_Contact_BAO_Contact::buildOptions('gender_id'),
5502         'operatorType' => CRM_Report_Form::OP_MULTISELECT,
5503         'is_fields' => TRUE,
5504         'is_filters' => TRUE,
5505       ],
5506       'birth_date' => [
5507         'title' => $options['prefix_label'] . ts('Birth Date'),
5508         'operatorType' => CRM_Report_Form::OP_DATE,
5509         'type' => CRM_Utils_Type::T_DATE,
5510         'is_fields' => TRUE,
5511         'is_filters' => TRUE,
5512       ],
5513       'age' => [
5514         'title' => $options['prefix_label'] . ts('Age'),
5515         'dbAlias' => 'TIMESTAMPDIFF(YEAR, ' . $tableAlias . '_civireport.birth_date, CURDATE())',
5516         'type' => CRM_Utils_Type::T_INT,
5517         'is_fields' => TRUE,
5518       ],
5519       $options['prefix'] . 'is_deceased' => [
5520         'title' => $options['prefix_label'] . ts('Is deceased'),
5521         'name' => 'is_deceased',
5522         'type' => CRM_Utils_Type::T_BOOLEAN,
5523         'is_fields' => FALSE,
5524         'is_filters' => TRUE,
5525         'is_group_bys' => FALSE,
5526       ],
5527       $options['prefix'] . 'job_title' => [
5528         'name' => 'job_title',
5529         'is_fields' => TRUE,
5530         'is_filters' => FALSE,
5531         'is_group_bys' => FALSE,
5532       ],
5533       $options['prefix'] . 'employer_id' => [
5534         'title' => $options['prefix_label'] . ts('Current Employer'),
5535         'type' => CRM_Utils_Type::T_INT,
5536         'name' => 'employer_id',
5537         'is_fields' => TRUE,
5538         'is_filters' => FALSE,
5539         'is_group_bys' => TRUE,
5540       ],
5541     ];
5542     if (!$options['contact_type'] || $options['contact_type'] === 'Individual') {
5543       $spec = array_merge($spec, $individualFields);
5544     }
5545
5546     if (!empty($options['custom_fields'])) {
5547       $this->_customGroupExtended[$options['prefix'] . 'civicrm_contact'] = [
5548         'extends' => $options['custom_fields'],
5549         'title' => $options['prefix_label'],
5550         'filters' => $options['filters'],
5551         'prefix' => $options['prefix'],
5552         'prefix_label' => $options['prefix_label'],
5553       ];
5554     }
5555
5556     return $this->buildColumns($spec, $options['prefix'] . 'civicrm_contact', 'CRM_Contact_DAO_Contact', $tableAlias, $this->getDefaultsFromOptions($options), $options);
5557   }
5558
5559   /**
5560    * Get address columns to add to array.
5561    *
5562    * @param array $options
5563    *  - prefix Prefix to add to table (in case of more than one instance of the table)
5564    *  - prefix_label Label to give columns from this address table instance
5565    *  - group_bys enable these fields for group by - default false
5566    *  - order_bys enable these fields for order by
5567    *  - filters enable these fields for filtering
5568    *
5569    * @return array address columns definition
5570    */
5571   protected function getAddressColumns($options = []) {
5572     $defaultOptions = [
5573       'prefix' => '',
5574       'prefix_label' => '',
5575       'fields' => TRUE,
5576       'group_bys' => FALSE,
5577       'order_bys' => TRUE,
5578       'filters' => TRUE,
5579       'join_filters' => FALSE,
5580       'fields_defaults' => [],
5581       'filters_defaults' => [],
5582       'group_bys_defaults' => [],
5583       'order_bys_defaults' => [],
5584     ];
5585
5586     $options = array_merge($defaultOptions, $options);
5587     $defaults = $this->getDefaultsFromOptions($options);
5588     $tableAlias = $options['prefix'] . 'address';
5589
5590     $spec = [
5591       $options['prefix'] . 'name' => [
5592         'title' => $options['prefix_label'] . ts('Address Name'),
5593         'name' => 'name',
5594         'is_fields' => TRUE,
5595       ],
5596       $options['prefix'] . 'street_number' => [
5597         'name' => 'street_number',
5598         'title' => $options['prefix_label'] . ts('Street Number'),
5599         'type' => 1,
5600         'is_fields' => TRUE,
5601       ],
5602       $options['prefix'] . 'odd_street_number' => [
5603         'title' => ts('Odd / Even Street Number'),
5604         'name' => 'odd_street_number',
5605         'type' => CRM_Utils_Type::T_INT,
5606         'no_display' => TRUE,
5607         'required' => TRUE,
5608         'dbAlias' => "({$tableAlias}_civireport.street_number % 2)",
5609         'is_fields' => TRUE,
5610         'is_order_bys' => TRUE,
5611       ],
5612       $options['prefix'] . 'street_name' => [
5613         'name' => 'street_name',
5614         'title' => $options['prefix_label'] . ts('Street Name'),
5615         'type' => 1,
5616         'is_fields' => TRUE,
5617         'is_filters' => TRUE,
5618         'operator' => 'like',
5619         'is_order_bys' => TRUE,
5620       ],
5621       $options['prefix'] . 'street_address' => [
5622         'title' => $options['prefix_label'] . ts('Street Address'),
5623         'name' => 'street_address',
5624         'is_fields' => TRUE,
5625         'is_filters' => TRUE,
5626         'is_group_bys' => TRUE,
5627       ],
5628       $options['prefix'] . 'supplemental_address_1' => [
5629         'title' => $options['prefix_label'] . ts('Supplementary Address Field 1'),
5630         'name' => 'supplemental_address_1',
5631         'is_fields' => TRUE,
5632       ],
5633       $options['prefix'] . 'supplemental_address_2' => [
5634         'title' => $options['prefix_label'] . ts('Supplementary Address Field 2'),
5635         'name' => 'supplemental_address_2',
5636         'is_fields' => TRUE,
5637       ],
5638       $options['prefix'] . 'supplemental_address_3' => [
5639         'title' => $options['prefix_label'] . ts('Supplementary Address Field 3'),
5640         'name' => 'supplemental_address_3',
5641         'is_fields' => TRUE,
5642       ],
5643       $options['prefix'] . 'street_number' => [
5644         'name' => 'street_number',
5645         'title' => $options['prefix_label'] . ts('Street Number'),
5646         'type' => 1,
5647         'is_order_bys' => TRUE,
5648         'is_filters' => TRUE,
5649         'is_fields' => TRUE,
5650       ],
5651       $options['prefix'] . 'street_unit' => [
5652         'name' => 'street_unit',
5653         'title' => $options['prefix_label'] . ts('Street Unit'),
5654         'type' => 1,
5655         'is_fields' => TRUE,
5656       ],
5657       $options['prefix'] . 'city' => [
5658         'title' => $options['prefix_label'] . ts('City'),
5659         'name' => 'city',
5660         'operator' => 'like',
5661         'is_fields' => TRUE,
5662         'is_filters' => TRUE,
5663         'is_group_bys' => TRUE,
5664         'is_order_bys' => TRUE,
5665       ],
5666       $options['prefix'] . 'postal_code' => [
5667         'title' => $options['prefix_label'] . ts('Postal Code'),
5668         'name' => 'postal_code',
5669         'type' => 2,
5670         'is_fields' => TRUE,
5671         'is_filters' => TRUE,
5672         'is_group_bys' => TRUE,
5673         'is_order_bys' => TRUE,
5674       ],
5675       $options['prefix'] . 'postal_code_suffix' => [
5676         'title' => $options['prefix_label'] . ts('Postal Code Suffix'),
5677         'name' => 'postal_code_suffix',
5678         'type' => 2,
5679         'is_fields' => TRUE,
5680         'is_filters' => TRUE,
5681         'is_group_bys' => TRUE,
5682         'is_order_bys' => TRUE,
5683       ],
5684       $options['prefix'] . 'county_id' => [
5685         'title' => $options['prefix_label'] . ts('County'),
5686         'alter_display' => 'alterCountyID',
5687         'name' => 'county_id',
5688         'type' => CRM_Utils_Type::T_INT,
5689         'operatorType' => CRM_Report_Form::OP_MULTISELECT,
5690         'options' => CRM_Core_PseudoConstant::county(),
5691         'is_fields' => TRUE,
5692         'is_filters' => TRUE,
5693         'is_group_bys' => TRUE,
5694       ],
5695       $options['prefix'] . 'state_province_id' => [
5696         'title' => $options['prefix_label'] . ts('State/Province'),
5697         'alter_display' => 'alterStateProvinceID',
5698         'name' => 'state_province_id',
5699         'type' => CRM_Utils_Type::T_INT,
5700         'operatorType' => CRM_Report_Form::OP_MULTISELECT,
5701         'options' => CRM_Core_PseudoConstant::stateProvince(),
5702         'is_fields' => TRUE,
5703         'is_filters' => TRUE,
5704         'is_group_bys' => TRUE,
5705       ],
5706       $options['prefix'] . 'country_id' => [
5707         'title' => $options['prefix_label'] . ts('Country'),
5708         'alter_display' => 'alterCountryID',
5709         'name' => 'country_id',
5710         'is_fields' => TRUE,
5711         'is_filters' => TRUE,
5712         'is_group_bys' => TRUE,
5713         'type' => CRM_Utils_Type::T_INT,
5714         'operatorType' => CRM_Report_Form::OP_MULTISELECT,
5715         'options' => CRM_Core_PseudoConstant::country(),
5716       ],
5717       $options['prefix'] . 'location_type_id' => [
5718         'name' => 'location_type_id',
5719         'title' => $options['prefix_label'] . ts('Location Type'),
5720         'type' => CRM_Utils_Type::T_INT,
5721         'is_fields' => TRUE,
5722         'alter_display' => 'alterLocationTypeID',
5723       ],
5724       $options['prefix'] . 'id' => [
5725         'title' => $options['prefix_label'] . ts('ID'),
5726         'name' => 'id',
5727         'is_fields' => TRUE,
5728       ],
5729       $options['prefix'] . 'is_primary' => [
5730         'name' => 'is_primary',
5731         'title' => $options['prefix_label'] . ts('Primary Address?'),
5732         'type' => CRM_Utils_Type::T_BOOLEAN,
5733         'is_fields' => TRUE,
5734       ],
5735     ];
5736     return $this->buildColumns($spec, $options['prefix'] . 'civicrm_address', 'CRM_Core_DAO_Address', $tableAlias, $defaults, $options);
5737   }
5738
5739   /**
5740    * Build the columns.
5741    *
5742    * The normal report class needs you to remember to do a few things that are often erratic
5743    *
5744    * 1) use a unique key for any field that might not be unique (e.g. start date, label)
5745    * - this class will prepend an alias to the key & set the 'name' if you don't set it yourself.
5746    *  You can suppress the alias with 'no_field_disambiguation' if transitioning existing reports. This
5747    *  means any saved filters / fields on saved report instances. This will mean that matching names from
5748    *  different tables may be ambigious, but it will smooth any code transition.
5749    * - note that it assumes the value being passed in is the actual table field name
5750    *
5751    * 2) set the field & set it to no display if you don't want the field but you might want to use the field in other
5752    * contexts - the code looks up the fields array for data - so it both defines the field spec & the fields you want to show
5753    *
5754    * 3) this function also sets the 'metadata' array - the extended report class now uses this in place
5755    *  of the fields array to reduce the issues caused when metadata is needed but 'fields' are not defined. Code in
5756    *  the core classes can start to move towards that.
5757    *
5758    * @param array $specs
5759    * @param string $tableName
5760    * @param string $daoName
5761    * @param string $tableAlias
5762    * @param array $defaults
5763    * @param array $options
5764    *
5765    * @return array
5766    */
5767   protected function buildColumns($specs, $tableName, $daoName = NULL, $tableAlias = NULL, $defaults = [], $options = []) {
5768     if (!$tableAlias) {
5769       $tableAlias = str_replace('civicrm_', '', $tableName);
5770     }
5771     $types = ['filters', 'group_bys', 'order_bys', 'join_filters'];
5772     $columns = [$tableName => array_fill_keys($types, [])];
5773     // The code that uses this no longer cares if it is a DAO or BAO so just call it a DAO.
5774     $columns[$tableName]['dao'] = $daoName;
5775     $columns[$tableName]['alias'] = $tableAlias;
5776
5777     foreach ($specs as $specName => $spec) {
5778       if (empty($spec['name'])) {
5779         $spec['name'] = $specName;
5780       }
5781
5782       $fieldAlias = (empty($options['no_field_disambiguation']) ? $tableAlias . '_' : '') . $specName;
5783       $columns[$tableName]['metadata'][$fieldAlias] = $spec;
5784       $columns[$tableName]['fields'][$fieldAlias] = $spec;
5785       if (isset($defaults['fields_defaults']) && in_array($spec['name'], $defaults['fields_defaults'])) {
5786         $columns[$tableName]['fields'][$fieldAlias]['default'] = TRUE;
5787       }
5788
5789       if (!$spec['is_fields'] || (isset($options['fields_excluded']) && in_array($specName, $options['fields_excluded']))) {
5790         $columns[$tableName]['fields'][$fieldAlias]['no_display'] = TRUE;
5791       }
5792
5793       if (isset($options['fields_required']) && in_array($specName, $options['fields_required'])) {
5794         $columns[$tableName]['fields'][$fieldAlias]['required'] = TRUE;
5795       }
5796
5797       foreach ($types as $type) {
5798         if ($options[$type] && !empty($spec['is_' . $type])) {
5799           $columns[$tableName][$type][$fieldAlias] = $spec;
5800           if (isset($defaults[$type . '_defaults']) && isset($defaults[$type . '_defaults'][$spec['name']])) {
5801             $columns[$tableName][$type][$fieldAlias]['default'] = $defaults[$type . '_defaults'][$spec['name']];
5802           }
5803         }
5804       }
5805     }
5806     return $columns;
5807   }
5808
5809   /**
5810    * Store group bys into array - so we can check elsewhere what is grouped.
5811    */
5812   protected function storeGroupByArray() {
5813
5814     if (empty($this->_params['group_bys'])
5815       || !is_array($this->_params['group_bys'])) {
5816       $this->_params['group_bys'] = [];
5817     }
5818
5819     foreach ($this->_columns as $tableName => $table) {
5820       $table = $this->_columns[$tableName];
5821       if (array_key_exists('group_bys', $table)) {
5822         foreach ($table['group_bys'] as $fieldName => $fieldData) {
5823           $field = $this->_columns[$tableName]['metadata'][$fieldName];
5824           if (!empty($this->_params['group_bys'][$fieldName]) || !empty($fieldData['required'])) {
5825             if (!empty($field['chart'])) {
5826               $this->assign('chartSupported', TRUE);
5827             }
5828
5829             if (!empty($table['group_bys'][$fieldName]['frequency']) &&
5830               !empty($this->_params['group_bys_freq'][$fieldName])
5831             ) {
5832
5833               switch ($this->_params['group_bys_freq'][$fieldName]) {
5834                 case 'FISCALYEAR':
5835                   $this->_groupByArray[$tableName . '_' . $fieldName . '_start'] = self::fiscalYearOffset($field['dbAlias']);
5836                   break;
5837
5838                 case 'YEAR':
5839                   $this->_groupByArray[$tableName . '_' . $fieldName . '_start'] = " YEAR({$field['dbAlias']})";
5840                   break;
5841
5842                 case 'QUARTER':
5843                   $this->_groupByArray[$tableName . '_' . $fieldName . '_start'] = "YEAR({$field['dbAlias']}), QUARTER({$field['dbAlias']})";
5844                   break;
5845
5846                 case 'YEARWEEK':
5847                   $this->_groupByArray[$tableName . '_' . $fieldName . '_start'] = "YEARWEEK({$field['dbAlias']})";
5848                   break;
5849
5850                 case 'MONTH':
5851                   $this->_groupByArray[$tableName . '_' . $fieldName . '_start'] = "EXTRACT(YEAR_MONTH FROM {$field['dbAlias']})";
5852                   break;
5853
5854                 case 'DATE':
5855                   $this->_groupByArray[$tableName . '_' . $fieldName . '_start'] = "DATE({$field['dbAlias']})";
5856                   break;
5857               }
5858             }
5859             else {
5860               if (!in_array($field['dbAlias'], $this->_groupByArray)) {
5861                 $this->_groupByArray[$tableName . '_' . $fieldName] = $field['dbAlias'];
5862               }
5863             }
5864           }
5865         }
5866
5867       }
5868     }
5869   }
5870
5871   /**
5872    * @param $options
5873    *
5874    * @return array
5875    */
5876   protected function getDefaultsFromOptions($options) {
5877     $defaults = [
5878       'fields_defaults' => $options['fields_defaults'],
5879       'filters_defaults' => $options['filters_defaults'],
5880       'group_bys_defaults' => $options['group_bys_defaults'],
5881       'order_bys_defaults' => $options['order_bys_defaults'],
5882     ];
5883     return $defaults;
5884   }
5885
5886   /**
5887    * Get the select clause for a field, wrapping in GROUP_CONCAT if appropriate.
5888    *
5889    * Full group by mode dictates that a field must either be in the group by function or
5890    * wrapped in a aggregate function. Here we wrap the field in GROUP_CONCAT if it is not in the
5891    * group concat.
5892    *
5893    * @param string $tableName
5894    * @param string $fieldName
5895    * @param string $field
5896    * @return string
5897    */
5898   protected function getSelectClauseWithGroupConcatIfNotGroupedBy($tableName, &$fieldName, &$field) {
5899     if ($this->groupConcatTested && (!empty($this->_groupByArray) || $this->isForceGroupBy)) {
5900       if ((empty($field['statistics']) || in_array('GROUP_CONCAT', $field['statistics']))) {
5901         $label = $field['title'] ?? NULL;
5902         $alias = $field['tplField'] ?? "{$tableName}_{$fieldName}";
5903         $this->_columnHeaders["{$tableName}_{$fieldName}"]['title'] = $label;
5904         $this->_selectAliases[] = $alias;
5905         if (empty($this->_groupByArray[$tableName . '_' . $fieldName])) {
5906           return "GROUP_CONCAT(DISTINCT {$field['dbAlias']}) as $alias";
5907         }
5908         return "({$field['dbAlias']}) as $alias";
5909       }
5910     }
5911   }
5912
5913   /**
5914    * Generate clause for the selected filter.
5915    *
5916    * @param array $field
5917    *   Field specification
5918    * @param string $fieldName
5919    *   Field name.
5920    *
5921    * @return string
5922    *   Relevant where clause.
5923    */
5924   protected function generateFilterClause($field, $fieldName) {
5925     if (CRM_Utils_Array::value('type', $field) & CRM_Utils_Type::T_DATE) {
5926       if (CRM_Utils_Array::value('operatorType', $field) ==
5927         CRM_Report_Form::OP_MONTH
5928       ) {
5929         $op = $this->_params["{$fieldName}_op"] ?? NULL;
5930         $value = $this->_params["{$fieldName}_value"] ?? NULL;
5931         if (is_array($value) && !empty($value)) {
5932           return "(month({$field['dbAlias']}) $op (" . implode(', ', $value) .
5933             '))';
5934         }
5935       }
5936       else {
5937         $relative = $this->_params["{$fieldName}_relative"] ?? NULL;
5938         $from = $this->_params["{$fieldName}_from"] ?? NULL;
5939         $to = $this->_params["{$fieldName}_to"] ?? NULL;
5940         return $this->dateClause($field['dbAlias'], $relative, $from, $to, $field['type']);
5941       }
5942     }
5943     else {
5944       $op = $this->_params["{$fieldName}_op"] ?? NULL;
5945       if ($op) {
5946         return $this->whereClause($field,
5947           $op,
5948           CRM_Utils_Array::value("{$fieldName}_value", $this->_params),
5949           CRM_Utils_Array::value("{$fieldName}_min", $this->_params),
5950           CRM_Utils_Array::value("{$fieldName}_max", $this->_params)
5951         );
5952       }
5953     }
5954     return '';
5955   }
5956
5957   /**
5958    * Retrieve a suitable object from the factory depending on the report
5959    * parameters, which typically might just be dependent on outputMode.
5960    *
5961    * If there is no suitable output handler, e.g. if outputMode is "copy",
5962    * then this sets it to NULL.
5963    */
5964   public function setOutputHandler() {
5965     $this->outputHandler = \Civi\Report\OutputHandlerFactory::singleton()->create($this);
5966   }
5967
5968   /**
5969    * Send report by email
5970    */
5971   public function sendEmail() {
5972     if (empty($this->outputHandler)) {
5973       // It's possible to end up here with outputMode unset, so we use
5974       // the "print" handler which was the default before, i.e. include
5975       // it as html in the body.
5976       $oldOutputMode = $this->_outputMode ?? NULL;
5977       $this->_outputMode = 'print';
5978       $this->setOutputHandler();
5979       $this->_outputMode = $oldOutputMode;
5980     }
5981
5982     $mailBody = $this->outputHandler->getMailBody();
5983
5984     $attachments = [];
5985     $attachmentFileName = $this->outputHandler->getFileName();
5986     // It's not always in the form of an attachment, e.g. for 'print' the
5987     // output ends up in $mailBody above.
5988     if ($attachmentFileName) {
5989       $fullFilename = CRM_Core_Config::singleton()->templateCompileDir . CRM_Utils_File::makeFileName($attachmentFileName);
5990       file_put_contents($fullFilename, $this->outputHandler->getOutputString());
5991       $attachments[] = [
5992         'fullPath' => $fullFilename,
5993         'mime_type' => $this->outputHandler->getMimeType(),
5994         'cleanName' => $attachmentFileName,
5995         'charset' => $this->outputHandler->getCharset(),
5996       ];
5997     }
5998
5999     // Send the email
6000     // @todo outputMode doesn't seem to get used by mailReport, which is good
6001     // since it shouldn't have any outputMode-related `if` statements in it.
6002     // Someday could remove the param from the function call.
6003     if (CRM_Report_Utils_Report::mailReport($mailBody, $this->_id, $this->_outputMode, $attachments)) {
6004       CRM_Core_Session::setStatus(ts("Report mail has been sent."), ts('Sent'), 'success');
6005     }
6006     else {
6007       CRM_Core_Session::setStatus(ts("Report mail could not be sent."), ts('Mail Error'), 'error');
6008     }
6009   }
6010
6011 }