3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
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 +--------------------------------------------------------------------+
13 * Class CRM_Report_Form
15 class CRM_Report_Form
extends CRM_Core_Form
{
16 const ROW_COUNT_LIMIT
= 50;
19 * Operator types - used for displaying filter elements
29 OP_MULTISELECT_SEPARATOR
= 66,
34 * The id of the report instance
41 * The id of the report template
45 protected $_templateID;
53 protected $_noFields = FALSE;
56 * The set of all columns in the report. An associative array
57 * with column name as the key and attributes as the value
61 protected $_columns = [];
64 * The set of filters in the report
68 protected $_filters = [];
71 * The set of optional columns in the report
75 public $_options = [];
78 * By default most reports hide contact id.
79 * Setting this to true makes it available
82 protected $_exposeContactID = TRUE;
85 * Set of statistic fields
89 protected $_statFields = [];
92 * Set of statistics data
96 protected $_statistics = [];
99 * List of fields not to be repeated during display
103 protected $_noRepeats = [];
106 * List of fields not to be displayed
110 protected $_noDisplay = [];
113 * Object type that a custom group extends
117 protected $_customGroupExtends = NULL;
118 protected $_customGroupExtendsJoin = [];
119 protected $_customGroupFilters = TRUE;
120 protected $_customGroupGroupBy = FALSE;
121 protected $_customGroupJoin = 'LEFT JOIN';
127 protected $_tagFilter = FALSE;
130 * specify entity table for tags filter
133 protected $_tagFilterTable = 'civicrm_contact';
136 * Build groups filter.
140 protected $_groupFilter = FALSE;
143 * Has the report been optimised for group filtering.
145 * The functionality for group filtering has been improved but not
146 * all reports have been adjusted to take care of it.
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
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.
157 * @see https://issues.civicrm.org/jira/browse/CRM-19170
159 protected $groupFilterNotOptimised = TRUE;
166 public $_navigation = [];
168 public $_drilldownReport = [];
171 * Array of tabs to display on report.
173 * E.g we define the tab title, the tpl and the tab-specific part of the css or html link.
175 * $this->tabs['OrderBy'] = array(
176 * 'title' => ts('Sorting'),
177 * 'tpl' => 'OrderBy',
178 * 'div_label' => 'order-by',
183 protected $tabs = [];
186 * Should we add paging.
190 protected $addPaging = TRUE;
192 protected $isForceGroupBy = FALSE;
194 protected $groupConcatTested = FALSE;
197 * Are we in print mode. Can be set by another outputMode, ex: sendmail.
201 public $printOnly = FALSE;
204 * An attribute for checkbox/radio form field layout
208 protected $_fourColumnAttribute = [
209 '</td><td width="25%">',
210 '</td><td width="25%">',
211 '</td><td width="25%">',
215 protected $_force = 1;
217 protected $_params = NULL;
218 protected $_formValues = NULL;
219 protected $_instanceValues = NULL;
221 protected $_instanceForm = FALSE;
222 protected $_criteriaForm = FALSE;
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;
237 * Table containing list of contact IDs within the group filter.
241 protected $groupTempTable = '';
246 protected $_aliases = [];
262 protected $_limit = NULL;
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.
272 protected $_limitValue = NULL;
275 * This can be set to specify row offset
276 * See notes on _limitValue
280 protected $_offsetValue = NULL;
284 protected $_sections = NULL;
285 protected $_autoIncludeIndexedFieldsAsOrderBys = 0;
288 * Whether to generate absolute URLs (ex: in report emails).
292 public $_absoluteUrl = FALSE;
295 * Flag to indicate if result-set is to be stored in a class variable which could be retrieved using getResultSet() method.
299 protected $_storeResultSet = FALSE;
302 * When _storeResultSet Flag is set use this var to store result set in form of array
306 protected $_resultSet = [];
309 * To what frequency group-by a date column
313 protected $_groupByDateFreq = [
315 'YEARWEEK' => 'Week',
316 'QUARTER' => 'Quarter',
321 * Variables to hold the acl inner join and where clause
324 protected $_aclFrom = NULL;
325 protected $_aclWhere = NULL;
328 * Array of DAO tables having columns included in SELECT or ORDER BY clause.
330 * Where has also been added to this although perhaps the 'includes both' array should have a different name.
334 protected $_selectedTables = [];
337 * Array of DAO tables having columns included in WHERE or HAVING clause
341 protected $filteredTables;
344 * Output mode e.g 'print', 'csv', 'pdf'.
348 protected $_outputMode;
351 * Format of any chart in use.
353 * (it's unclear if this could be merged with outputMode at this stage)
359 public $_having = NULL;
360 public $_select = NULL;
361 public $_selectClauses = [];
362 public $_columnHeaders = [];
363 public $_orderBy = NULL;
364 public $_orderByFields = [];
365 public $_orderByArray = [];
367 * Array of clauses to group by.
371 protected $_groupByArray = [];
372 public $_groupBy = NULL;
373 public $_whereClauses = [];
374 public $_havingClauses = [];
377 * DashBoardRowCount Dashboard row count.
381 public $_dashBoardRowCount;
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.
389 public $noController = FALSE;
392 * Variable to hold the currency alias.
396 protected $_currencyColumn = NULL;
401 protected $_interval;
406 protected $_sendmail;
419 * Report description.
423 public $_description;
426 * Is an address field selected.
429 * This was intended to determine if the address table should be joined in
430 * The isTableSelected function is now preferred for this purpose
432 protected $_addressField;
435 * Is an email field selected.
438 * This was intended to determine if the email table should be joined in
439 * The isTableSelected function is now preferred for this purpose
441 protected $_emailField;
444 * Is a phone field selected.
447 * This was intended to determine if the phone table should be joined in
448 * The isTableSelected function is now preferred for this purpose
450 protected $_phoneField;
453 * Create new report instance? (or update existing) on save.
457 protected $_createNew;
460 * When a grand total row has calculated the status we pop it off to here.
462 * This allows us to access it from the stats function and avoid recalculating.
466 protected $rollupRow = [];
469 * Database attributes - character set and collation.
473 protected $_databaseAttributes = ' DEFAULT CHARACTER SET utf8 COLLATE utf8_unicode_ci';
476 * SQL being run in this report.
478 * The sql in the report is stored in this variable in order to be displayed on the developer tab.
486 * An instruction not to add a Group By.
488 * This is relevant where the group by might be otherwise added after the code that determines the group by array.
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
495 protected $noGroupBy = FALSE;
498 * SQL being run in this report as an array.
500 * The sql in the report is stored in this variable in order to be returned to api & test calls.
508 * Tables created for the report that need removal afterwards.
510 * ['civicrm_temp_report_x' => ['temporary' => TRUE, 'name' => 'civicrm_temp_report_x']
513 protected $temporaryTables = [];
516 * Can this report use the sql mode ONLY_FULL_GROUP_BY.
519 public $optimisedForOnlyFullGroupBy = TRUE;
524 public function __construct() {
525 parent
::__construct();
527 $this->addClass('crm-report-form');
529 if ($this->_tagFilter
) {
530 $this->buildTagFilter();
532 if ($this->_exposeContactID
) {
533 if (array_key_exists('civicrm_contact', $this->_columns
)) {
534 $this->_columns
['civicrm_contact']['fields']['exposed_id'] = [
536 'title' => ts('Contact ID'),
542 if ($this->_groupFilter
) {
543 $this->buildGroupFilter();
546 // Get all custom groups
547 $allGroups = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_CustomField', 'custom_group_id');
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
= [];
562 // merge custom data columns to _columns list, if any
563 $this->addCustomDataToColumns(TRUE, $permCustomGroupIds);
565 // add / modify display columns, filters ..etc
566 CRM_Utils_Hook
::alterReportVar('columns', $this->_columns
, $this);
568 //assign currencyColumn variable to tpl
569 $this->assign('currencyColumn', $this->_currencyColumn
);
573 * Shared pre-process function.
575 * If overriding preProcess function this should still be called.
579 public function preProcessCommon() {
580 $this->_force
= CRM_Utils_Request
::retrieve('force', 'Boolean');
582 $this->_dashBoardRowCount
= CRM_Utils_Request
::retrieve('rowCount', 'Integer');
584 $this->_section
= CRM_Utils_Request
::retrieve('section', 'Integer');
586 $this->assign('section', $this->_section
);
587 CRM_Core_Region
::instance('page-header')->add([
588 'markup' => sprintf('<!-- Report class: [%s] -->', htmlentities(get_class($this))),
590 if (!$this->noController
) {
591 $this->setID($this->get('instanceId'));
594 $this->setID(CRM_Report_Utils_Report
::getInstanceID());
596 $this->setID(CRM_Report_Utils_Report
::getInstanceIDForPath());
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}";
606 $this->assign('instanceId', $this->_id
);
607 $params = ['id' => $this->_id
];
608 $this->_instanceValues
= [];
609 CRM_Core_DAO
::commonRetrieve('CRM_Report_DAO_ReportInstance',
611 $this->_instanceValues
613 if (empty($this->_instanceValues
)) {
614 CRM_Core_Error
::statusBounce("Report could not be loaded.");
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')
622 CRM_Utils_System
::permissionDenied();
623 CRM_Utils_System
::civiExit();
626 $formValues = $this->_instanceValues
['form_values'] ??
NULL;
628 $this->_formValues
= CRM_Utils_String
::unserialize($formValues);
631 $this->_formValues
= NULL;
634 $this->setOutputMode();
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')),
644 // Do not pass go. Do not collect another chance to re-run the same query.
645 CRM_Report_Form_Instance
::postProcess($this);
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'])) {
657 $this->assign('mode', 'instance');
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"
669 if ($optionValueID) {
670 $this->_description
= CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionValue', $optionValueID, 'description');
674 $this->assign('mode', 'template');
677 // lets display the Report Settings section
678 $this->_instanceForm
= $this->_force ||
$this->_id ||
(!empty($_POST));
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'))
686 $this->_instanceForm
= FALSE;
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')
694 if (empty($this->_instanceValues
['is_reserved']) ||
695 CRM_Core_Permission
::check('administer reserved reports')
697 $this->assign('criteriaForm', TRUE);
698 $this->_criteriaForm
= TRUE;
702 // Special permissions check for private instance if it's not the current contact instance
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);
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');
721 public function addBreadCrumb() {
725 'title' => ts('Report Templates'),
726 'url' => CRM_Utils_System
::url('civicrm/admin/report/template/list', 'reset=1'),
730 CRM_Utils_System
::appendBreadCrumb($breadCrumbs);
734 * Pre process function.
736 * Called prior to build form.
738 public function preProcess() {
739 $this->preProcessCommon();
742 $this->addBreadCrumb();
745 foreach ($this->_columns
as $tableName => $table) {
746 $this->setTableAlias($table, $tableName);
749 // higher preference to bao object
750 $daoOrBaoName = CRM_Utils_Array
::value('bao', $table, CRM_Utils_Array
::value('dao', $table));
753 if (method_exists($daoOrBaoName, 'exportableFields')) {
754 $expFields = $daoOrBaoName::exportableFields();
757 $expFields = $daoOrBaoName::export();
761 $doNotCopy = ['required', 'default'];
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;
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']);
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]);
782 $this->_columns
[$tableName][$fieldGrp][$fieldName] = $expFields[$name];
785 foreach ($expFields[$name] as $property => $val) {
786 if (!array_key_exists($property, $field)) {
787 $this->_columns
[$tableName][$fieldGrp][$fieldName][$property] = $val;
794 if (!empty($field['no_repeat'])) {
795 $this->_noRepeats
[] = "{$tableName}_{$fieldName}";
797 if (!empty($field['no_display'])) {
798 $this->_noDisplay
[] = "{$tableName}_{$fieldName}";
801 // set alias = table-name, unless already set
802 $alias = $field['alias'] ??
(
803 $this->_columns
[$tableName]['alias'] ??
$tableName
805 $this->_columns
[$tableName][$fieldGrp][$fieldName]['alias'] = $alias;
807 // set name = fieldName, unless already set
808 if (!isset($this->_columns
[$tableName][$fieldGrp][$fieldName]['name'])) {
809 $this->_columns
[$tableName][$fieldGrp][$fieldName]['name'] = $name;
812 if (!isset($this->_columns
[$tableName][$fieldGrp][$fieldName]['table_name'])) {
813 $this->_columns
[$tableName][$fieldGrp][$fieldName]['table_name'] = $tableName;
816 // set dbAlias = alias.name, unless already set
817 if (!isset($this->_columns
[$tableName][$fieldGrp][$fieldName]['dbAlias'])) {
818 $this->_columns
[$tableName][$fieldGrp][$fieldName]['dbAlias']
820 $this->_columns
[$tableName][$fieldGrp][$fieldName]['name'];
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
;
833 case CRM_Utils_Type
::T_INT
:
834 $this->_columns
[$tableName][$fieldGrp][$fieldName]['operatorType'] = CRM_Report_Form
::OP_INT
;
837 case CRM_Utils_Type
::T_DATE
:
838 $this->_columns
[$tableName][$fieldGrp][$fieldName]['operatorType'] = CRM_Report_Form
::OP_DATE
;
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']
855 array_key_exists('pseudoconstant', $this->_columns
[$tableName][$fieldGrp][$fieldName])
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])) {
861 $this->_columns
[$tableName][$fieldGrp][$fieldName]['options'] = CRM_Core_PseudoConstant
::get($daoOrBaoName, $fieldName);
868 if (!isset($this->_columns
[$tableName]['metadata'][$fieldName])) {
869 $this->_columns
[$tableName]['metadata'][$fieldName] = $this->_columns
[$tableName][$fieldGrp][$fieldName];
872 $this->_columns
[$tableName]['metadata'][$fieldName] = array_merge($this->_columns
[$tableName][$fieldGrp][$fieldName], $this->_columns
[$tableName]['metadata'][$fieldName]);
878 // copy filters to a separate handy variable
879 if (array_key_exists('filters', $table)) {
880 $this->_filters
[$tableName] = $this->_columns
[$tableName]['filters'];
883 if (array_key_exists('group_bys', $table)) {
884 $groupBys[$tableName] = $this->_columns
[$tableName]['group_bys'];
887 if (array_key_exists('fields', $table)) {
888 $reportFields[$tableName] = $this->_columns
[$tableName]['fields'];
893 $this->setDefaultValues(FALSE);
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
);
902 $this->_formValues
= $this->_defaults
;
903 $this->postProcess();
908 * Set default values.
910 * @param bool $freeze
914 public function setDefaultValues($freeze = TRUE) {
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'])) {
925 $this->_defaults
['fields'][$fieldName] = 1;
928 // find element object, so that we could use quickform's freeze method
929 // for required elements
930 $obj = $this->getElementFromGroup("fields", $fieldName);
932 $freezeGroup[] = $obj;
936 elseif (isset($field['default'])) {
937 $this->_defaults
['fields'][$fieldName] = $field['default'];
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';
949 $this->_defaults
['group_bys'][$fieldName] = $field['default'];
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
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;
964 $this->_defaults
["{$fieldName}_relative"] = $field['default'];
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;
972 $this->_defaults
["{$fieldName}_value"] = $field['default'];
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
980 $this->_defaults
["{$fieldName}_op"] = 'in';
982 if (CRM_Utils_Array
::value('operatorType', $field) ==
983 CRM_Report_Form
::OP_ENTITYREF
985 $this->_defaults
["{$fieldName}_op"] = 'in';
987 elseif (CRM_Utils_Array
::value('operatorType', $field) ==
988 CRM_Report_Form
::OP_MULTISELECT_SEPARATOR
990 $this->_defaults
["{$fieldName}_op"] = 'mhas';
992 elseif ($op = CRM_Utils_Array
::value('default_op', $field)) {
993 $this->_defaults
["{$fieldName}_op"] = $op;
999 empty($this->_formValues
['order_bys']) &&
1000 (array_key_exists('order_bys', $table) &&
1001 is_array($table['order_bys']))
1003 if (!array_key_exists('order_bys', $this->_defaults
)) {
1004 $this->_defaults
['order_bys'] = [];
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'])
1012 'column' => $fieldName,
1013 'order' => CRM_Utils_Array
::value('default_order', $field, 'ASC'),
1014 'section' => CRM_Utils_Array
::value('default_is_section', $field, 0),
1017 if (!empty($field['default_weight'])) {
1018 $this->_defaults
['order_bys'][(int) $field['default_weight']] = $order_by;
1021 array_unshift($this->_defaults
['order_bys'], $order_by);
1027 foreach ($this->_options
as $fieldName => $field) {
1028 if (isset($field['default'])) {
1029 $this->_defaults
['options'][$fieldName] = $field['default'];
1034 if (!empty($this->_submitValues
)) {
1035 $this->preProcessOrderBy($this->_submitValues
);
1038 $this->preProcessOrderBy($this->_defaults
);
1041 // lets finish freezing task here itself
1042 if (!empty($freezeGroup)) {
1043 foreach ($freezeGroup as $elem) {
1048 if ($this->_formValues
) {
1049 $this->_defaults
= array_merge($this->_defaults
, $this->_formValues
);
1052 if ($this->_instanceValues
) {
1053 $this->_defaults
= array_merge($this->_defaults
, $this->_instanceValues
);
1056 CRM_Report_Form_Instance
::setDefaultValues($this, $this->_defaults
);
1058 return $this->_defaults
;
1062 * Get element from group.
1064 * @param string $group
1065 * @param string $grpFieldName
1069 public function getElementFromGroup($group, $grpFieldName) {
1070 $eleObj = $this->getElement($group);
1071 foreach ($eleObj->_elements
as $index => $obj) {
1072 if ($grpFieldName == $obj->_attributes
['name']) {
1080 * Setter for $_params.
1082 * @param array $params
1084 public function setParams($params) {
1085 $this->_params
= $params;
1089 * Getter for $_params.
1091 * @return void|array $params
1093 public function getParams() {
1094 return $this->_params
;
1100 * @param int $instanceID
1102 public function setID($instanceID) {
1103 $this->_id
= $instanceID;
1111 public function getID() {
1116 * Getter for _outputMode
1118 * Note you can implement hook_civicrm_alterReportVar('actions', ...)
1119 * which indirectly allows setting _outputMode if the user chooses
1124 public function getOutputMode():string {
1125 return $this->_outputMode
;
1129 * Getter for report header form field value
1133 public function getReportHeader():string {
1134 return $this->_formValues
['report_header'] ??
'';
1138 * Getter for report footer form field value
1142 public function getReportFooter():string {
1143 return $this->_formValues
['report_footer'] ??
'';
1147 * Setter for $_force.
1149 * @param bool $isForce
1151 public function setForce($isForce) {
1152 $this->_force
= $isForce;
1156 * Setter for $_limitValue.
1158 * @param int $_limitValue
1160 public function setLimitValue($_limitValue) {
1161 $this->_limitValue
= $_limitValue;
1165 * Setter for $_offsetValue.
1167 * @param int $_offsetValue
1169 public function setOffsetValue($_offsetValue) {
1170 $this->_offsetValue
= $_offsetValue;
1174 * Setter for $addPaging.
1176 * @param bool $value
1178 public function setAddPaging($value) {
1179 $this->addPaging
= $value;
1183 * Getter for $_defaultValues.
1187 public function getDefaultValues() {
1188 return $this->_defaults
;
1192 * Remove any temporary tables.
1194 public function cleanUpTemporaryTables() {
1195 foreach ($this->temporaryTables
as $temporaryTable) {
1196 CRM_Core_DAO
::executeQuery('DROP ' . ($temporaryTable['temporary'] ?
'TEMPORARY' : '') . ' TABLE IF EXISTS ' . $temporaryTable['name']);
1201 * Create a temporary table.
1203 * This function creates a table AND adds the details to the developer tab & $this->>temporary tables.
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.
1216 public function createTemporaryTable($identifier, $sql, $isColumns = FALSE, $isMemory = FALSE) {
1217 $tempTable = CRM_Utils_SQL_TempTable
::build();
1219 $tempTable->setMemory();
1222 $tempTable->createWithColumns($sql);
1225 $tempTable->createWithQuery($sql);
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];
1236 * Add columns to report.
1238 public function addColumns() {
1241 foreach ($this->_columns
as $tableName => $table) {
1242 if (array_key_exists('fields', $table)) {
1243 foreach ($table['fields'] as $fieldName => $field) {
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'];
1252 $tableName = array_keys($
{$var}['grouping']);
1253 $tableName = $tableName[0];
1254 $groupTitle = array_values($
{$var}['grouping']);
1255 $groupTitle = $groupTitle[0];
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;
1268 $colGroups[$tableName]['fields'][$fieldName] = $field['title'] ??
NULL;
1269 if ($groupTitle && empty($colGroups[$tableName]['group_title'])) {
1270 $colGroups[$tableName]['group_title'] = $groupTitle;
1272 $options[$fieldName] = $field['title'] ??
NULL;
1278 $this->addCheckBox("fields", ts('Select Columns'), $options, NULL,
1279 NULL, NULL, NULL, $this->_fourColumnAttribute
, TRUE
1281 if (!empty($colGroups)) {
1282 $this->tabs
['FieldSelection'] = [
1283 'title' => ts('Columns'),
1284 'tpl' => 'FieldSelection',
1285 'div_label' => 'col-groups',
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
);
1293 $this->assign('colGroups', $colGroups);
1297 * Add filters to report.
1299 public function addFilters() {
1300 $filters = $filterGroups = [];
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,
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
1318 $operations = $this->getOperationPair(
1319 CRM_Utils_Array
::value('operatorType', $field),
1322 $filters[$table][$fieldName] = $field;
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'])
1329 // If there's no option list for this filter, define one.
1330 $field['options'] = [
1332 2 => ts('February'),
1339 9 => ts('September'),
1340 10 => ts('October'),
1341 11 => ts('November'),
1342 12 => ts('December'),
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'];
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'
1354 $element = $this->addElement('select', "{$fieldName}_op", ts('Operator:'), $operations,
1355 array('onchange' => "return showHideMaxMinVal( '$fieldName', this.value );")
1358 if (count($operations) <= 1) {
1361 if ($fieldName == 'state_province_id' ||
1362 $fieldName == 'county_id'
1364 $this->addChainSelect($fieldName . '_value', [
1371 $this->addElement('select', "{$fieldName}_value", NULL, $field['options'], [
1372 'style' => 'min-width:250px',
1373 'class' => 'crm-select2 huge',
1375 'placeholder' => ts('- select -'),
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']);
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']);
1395 case CRM_Report_Form
::OP_DATE
:
1396 // build datetime fields
1397 $this->addDatePickerRange($fieldName, $field['title'], FALSE, FALSE, 'From', 'To', $operations, '_to', '_from');
1400 case CRM_Report_Form
::OP_DATETIME
:
1401 // build datetime fields
1402 $this->addDatePickerRange($fieldName, $field['title'], TRUE, FALSE, 'From', 'To', $operations, '_to', '_from');
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'));
1412 // default type is string
1413 $this->addElement('select', "{$fieldName}_op", ts('Operator:'), $operations,
1414 ['onchange' => "return showHideMaxMinVal( '$fieldName', this.value );"]
1416 // we need text box for value input
1417 $this->add('text', "{$fieldName}_value", NULL, ['class' => 'huge']);
1422 if (!empty($filters)) {
1423 $this->tabs
['Filters'] = [
1424 'title' => ts('Filters'),
1426 'div_label' => 'set-filters',
1429 $this->assign('filters', $filters);
1430 $this->assign('filterGroups', $filterGroups);
1434 * Function to assign the tabs to the template in the correct order.
1436 * We want the tabs to wind up in this order (if not overridden).
1444 protected function assignTabs() {
1452 $order = array_intersect_key(array_fill_keys($order, 1), $this->tabs
);
1453 $order = array_merge($order, $this->tabs
);
1454 $this->assign('tabs', $order);
1458 * The intent is to add a tab for developers to view the sql.
1460 * Currently using dpm.
1462 * @param string $sql
1464 public function addToDeveloperTab($sql) {
1465 if (!CRM_Core_Permission
::check('view report sql')) {
1468 $ignored_output_modes = ['pdf', 'csv', 'print'];
1469 if (in_array($this->_outputMode
, $ignored_output_modes)) {
1472 $this->tabs
['Developer'] = [
1473 'title' => ts('Developer'),
1474 'tpl' => 'Developer',
1475 'div_label' => 'set-developer',
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);
1485 foreach (['FROM', 'WHERE', 'GROUP BY', 'ORDER BY', 'LIMIT', ';'] as $term) {
1486 $sql = str_replace($term, '<br><br>' . $term, $sql);
1488 $this->sqlFormattedArray
[] = $sql;
1489 $this->assign('sql', implode(';<br><br><br><br>', $this->sqlFormattedArray
));
1491 $this->assign('sqlModes', $sqlModes = CRM_Utils_SQL
::getSqlModes());
1496 * Add options defined in $this->_options to the report.
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
1503 foreach ($this->_options
as $fieldName => $field) {
1506 if ($field['type'] == 'select') {
1507 $this->addElement('select', "{$fieldName}", $field['title'], $field['options']);
1509 elseif ($field['type'] == 'checkbox') {
1510 $options[$field['title']] = $fieldName;
1511 $this->addCheckBox($fieldName, NULL,
1513 NULL, NULL, NULL, $this->_fourColumnAttribute
1518 if (!empty($this->_options
) &&
1520 ||
($this->_id
&& CRM_Report_BAO_ReportInstance
::contactCanAdministerReport($this->_id
)))
1522 $this->tabs
['ReportOptions'] = [
1523 'title' => ts('Display Options'),
1524 'tpl' => 'ReportOptions',
1525 'div_label' => 'other-options',
1528 $this->assign('otherOptions', $this->_options
);
1532 * Add chart options to the report.
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('xbutton', $this->_chartButtonName
, ts('View'), ['type' => 'submit']);
1543 * Add group by options to the report.
1545 public function addGroupBys() {
1546 $options = $freqElements = [];
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;
1560 $this->addCheckBox("group_bys", ts('Group by columns'), $options, NULL,
1561 NULL, NULL, NULL, $this->_fourColumnAttribute
1563 $this->assign('groupByElements', $options);
1564 if (!empty($options)) {
1565 $this->tabs
['GroupBy'] = [
1566 'title' => ts('Grouping'),
1568 'div_label' => 'group-by-elements',
1572 foreach ($freqElements as $name) {
1573 $this->addElement('select', "group_bys_freq[$name]",
1574 ts('Frequency'), $this->_groupByDateFreq
1580 * Add data for order by tab.
1582 public function addOrderBys() {
1584 foreach ($this->_columns
as $tableName => $table) {
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'];
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.)
1598 if ($this->_autoIncludeIndexedFieldsAsOrderBys
&&
1599 array_key_exists('extends', $table) && !empty($table['extends'])
1601 foreach ($table['fields'] as $fieldName => $field) {
1602 if (empty($field['no_display'])) {
1603 $options[$fieldName] = $field['title'];
1611 $this->assign('orderByOptions', $options);
1612 if (!empty($options)) {
1613 $this->tabs
['OrderBy'] = [
1614 'title' => ts('Sorting'),
1616 'div_label' => 'order-by-elements',
1620 if (!empty($options)) {
1622 '-' => ' - none - ',
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'),
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"]);
1637 * This adds the tab referred to as Title and Format, rendered through Instance.tpl.
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
1643 public function buildInstanceAndButtons() {
1644 CRM_Report_Form_Instance
::buildForm($this);
1645 $this->_actionButtonName
= $this->getButtonName('submit');
1646 $this->addTaskMenu($this->getActions($this->_id
));
1648 $this->assign('instanceForm', $this->_instanceForm
);
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
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']
1660 $this->assign('group', TRUE);
1663 $this->addElement('xbutton', $this->_groupButtonName
, '', [
1665 'style' => 'display: none;',
1668 $this->addChartOptions();
1669 $showResultsLabel = $this->getResultsLabel();
1673 'name' => $showResultsLabel,
1674 'isDefault' => TRUE,
1680 * Has this form been submitted already?
1684 public function resultsDisplayed() {
1685 $buttonName = $this->controller
->getButtonName();
1686 return ($buttonName ||
$this->_outputMode
);
1690 * Get the actions for this report instance.
1692 * @param int $instanceId
1696 protected function getActions($instanceId) {
1697 $actions = CRM_Report_BAO_ReportInstance
::getActionMetadata();
1698 if (empty($instanceId)) {
1699 $actions['report_instance.save'] = [
1700 'title' => ts('Create Report'),
1702 'is_confirm' => TRUE,
1703 'confirm_title' => ts('Create Report'),
1704 'confirm_refresh_fields' => json_encode([
1705 'title' => ['selector' => '.crm-report-instanceForm-form-block-title', 'prepend' => ''],
1706 'description' => ['selector' => '.crm-report-instanceForm-form-block-description', 'prepend' => ''],
1710 unset($actions['report_instance.delete']);
1713 if (!$this->_csvSupported
) {
1714 unset($actions['report_instance.csv']);
1717 CRM_Utils_Hook
::alterReportVar('actions', $actions, $this);
1723 * Main build form function.
1725 public function buildQuickForm() {
1726 $this->addColumns();
1728 $this->addFilters();
1730 $this->addOptions();
1732 $this->addGroupBys();
1734 $this->addOrderBys();
1736 $this->buildInstanceAndButtons();
1738 // Add form rule for report.
1743 $this->addFormRule([get_class($this), 'formRule'], $this);
1745 $this->assignTabs();
1749 * A form rule function for custom data.
1751 * The rule ensures that fields selected in group_by if any) should only be the ones
1752 * present in display/select fields criteria;
1753 * note: works if and only if any custom field selected in group_by.
1755 * @param array $fields
1756 * @param array $ignoreFields
1760 public function customDataFormRule($fields, $ignoreFields = []) {
1762 if (!empty($this->_customGroupExtends
) && $this->_customGroupGroupBy
&&
1763 !empty($fields['group_bys'])
1765 foreach ($this->_columns
as $tableName => $table) {
1766 if ((substr($tableName, 0, 13) == 'civicrm_value' ||
1767 substr($tableName, 0, 12) == 'custom_value') &&
1768 !empty($this->_columns
[$tableName]['fields'])
1770 foreach ($this->_columns
[$tableName]['fields'] as $fieldName => $field) {
1771 if (array_key_exists($fieldName, $fields['group_bys']) &&
1772 !array_key_exists($fieldName, $fields['fields'])
1774 $errors['fields'] = "Please make sure fields selected in 'Group by Columns' section are also selected in 'Display Columns' section.";
1776 elseif (array_key_exists($fieldName, $fields['group_bys'])) {
1777 foreach ($fields['fields'] as $fld => $val) {
1778 if (!array_key_exists($fld, $fields['group_bys']) &&
1779 !in_array($fld, $ignoreFields)
1781 $errors['fields'] = "Please ensure that fields selected in 'Display Columns' are also selected in 'Group by Columns' section.";
1793 * Get operators to display on form.
1795 * Note: $fieldName param allows inheriting class to build operationPairs specific to a field.
1797 * @param string $type
1798 * @param string $fieldName
1802 public function getOperationPair($type = "string", $fieldName = NULL) {
1803 // FIXME: At some point we should move these key-val pairs
1804 // to option_group and option_value table.
1806 case CRM_Report_Form
::OP_INT
:
1807 case CRM_Report_Form
::OP_FLOAT
:
1810 'lte' => ts('Is less than or equal to'),
1811 'gte' => ts('Is greater than or equal to'),
1812 'bw' => ts('Is between'),
1813 'eq' => ts('Is equal to'),
1814 'lt' => ts('Is less than'),
1815 'gt' => ts('Is greater than'),
1816 'neq' => ts('Is not equal to'),
1817 'nbw' => ts('Is not between'),
1818 'nll' => ts('Is empty (Null)'),
1819 'nnll' => ts('Is not empty (Null)'),
1823 case CRM_Report_Form
::OP_SELECT
:
1825 'eq' => ts('Is equal to'),
1829 case CRM_Report_Form
::OP_MONTH
:
1830 case CRM_Report_Form
::OP_MULTISELECT
:
1831 case CRM_Report_Form
::OP_ENTITYREF
:
1834 'in' => ts('Is one of'),
1835 'notin' => ts('Is not one of'),
1836 'nll' => ts('Is empty (Null)'),
1837 'nnll' => ts('Is not empty (Null)'),
1841 case CRM_Report_Form
::OP_DATE
:
1844 'nll' => ts('Is empty (Null)'),
1845 'nnll' => ts('Is not empty (Null)'),
1849 case CRM_Report_Form
::OP_MULTISELECT_SEPARATOR
:
1850 // use this operator for the values, concatenated with separator. For e.g if
1851 // multiple options for a column is stored as ^A{val1}^A{val2}^A
1853 'mhas' => ts('Is one of'),
1854 'mnot' => ts('Is not one of'),
1861 'has' => ts('Contains'),
1862 'sw' => ts('Starts with'),
1863 'ew' => ts('Ends with'),
1864 'nhas' => ts('Does not contain'),
1865 'eq' => ts('Is equal to'),
1866 'neq' => ts('Is not equal to'),
1867 'nll' => ts('Is empty (Null)'),
1868 'nnll' => ts('Is not empty (Null)'),
1875 * Build the tag filter field to display on the filters tab.
1877 public function buildTagFilter() {
1878 $contactTags = CRM_Core_BAO_Tag
::getTags($this->_tagFilterTable
);
1879 if (!empty($contactTags)) {
1880 $this->_columns
['civicrm_tag'] = [
1881 'dao' => 'CRM_Core_DAO_Tag',
1885 'title' => ts('Tag'),
1886 'type' => CRM_Utils_Type
::T_INT
,
1888 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
1889 'options' => $contactTags,
1897 * Adds group filters to _columns (called from _Construct).
1899 public function buildGroupFilter() {
1900 $this->_columns
['civicrm_group']['filters'] = [
1902 'name' => 'group_id',
1903 'title' => ts('Group'),
1904 'type' => CRM_Utils_Type
::T_INT
,
1905 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
1907 'options' => CRM_Core_PseudoConstant
::nestedGroup(),
1910 if (empty($this->_columns
['civicrm_group']['dao'])) {
1911 $this->_columns
['civicrm_group']['dao'] = 'CRM_Contact_DAO_GroupContact';
1913 if (empty($this->_columns
['civicrm_group']['alias'])) {
1914 $this->_columns
['civicrm_group']['alias'] = 'cgroup';
1919 * Get SQL operator from form text version.
1921 * @param string $operator
1925 public function getSQLOperator($operator = "like") {
1926 switch ($operator) {
1959 return 'IS NOT NULL';
1968 * Generate where clause.
1970 * This can be overridden in reports for special treatment of a field
1972 * @param array $field Field specifications
1973 * @param string $op Query operator (not an exact match to sql)
1974 * @param mixed $value
1978 * @return null|string
1980 public function whereClause(&$field, $op, $value, $min, $max) {
1982 $type = CRM_Utils_Type
::typeToString(CRM_Utils_Array
::value('type', $field));
1984 // CRM-18010: Ensure type of each report filters
1986 trigger_error('Type is not defined for field ' . $field['name'], E_USER_WARNING
);
1993 if (($min !== NULL && strlen($min) > 0) ||
1994 ($max !== NULL && strlen($max) > 0)
1998 $min = CRM_Utils_Type
::escape($min, $type);
2000 $clauses[] = "( {$field['dbAlias']} >= $min )";
2003 $clauses[] = "( {$field['dbAlias']} < $min OR {$field['dbAlias']} IS NULL )";
2007 $max = CRM_Utils_Type
::escape($max, $type);
2009 $clauses[] = "( {$field['dbAlias']} <= $max )";
2012 $clauses[] = "( {$field['dbAlias']} > $max )";
2016 if (!empty($clauses)) {
2018 $clause = implode(' AND ', $clauses);
2021 $clause = '(' . implode('OR', $clauses) . ')';
2029 if ($value !== NULL && strlen($value) > 0) {
2030 $value = CRM_Utils_Type
::escape($value, $type);
2031 if (strpos($value, '%') === FALSE) {
2032 $value = "'%{$value}%'";
2035 $value = "'{$value}'";
2037 $sqlOP = $this->getSQLOperator($op);
2038 $clause = "( {$field['dbAlias']} $sqlOP $value )";
2044 if ((is_string($value) ||
is_numeric($value)) && strlen($value)) {
2045 $value = explode(',', $value);
2047 if ($value !== NULL && is_array($value) && count($value) > 0) {
2048 $sqlOP = $this->getSQLOperator($op);
2049 if (CRM_Utils_Array
::value('type', $field) ==
2050 CRM_Utils_Type
::T_STRING
2052 //cycle through selections and escape values
2053 foreach ($value as $key => $selection) {
2054 $value[$key] = CRM_Utils_Type
::escape($selection, $type);
2057 = "( {$field['dbAlias']} $sqlOP ( '" . implode("' , '", $value) .
2061 // for numerical values
2062 $clause = "{$field['dbAlias']} $sqlOP (" . implode(', ', $value) .
2065 if ($op == 'notin') {
2066 $clause = "( " . $clause . " OR {$field['dbAlias']} IS NULL )";
2069 $clause = "( " . $clause . " )";
2076 // multiple has or multiple not
2077 if ($value !== NULL && count($value) > 0) {
2078 $value = CRM_Utils_Type
::escapeAll($value, $type);
2079 $operator = $op == 'mnot' ?
'NOT' : '';
2080 $regexp = "([[:cntrl:]]|^)" . implode('([[:cntrl:]]|$)|([[:cntrl:]]|^)', (array) $value) . "([[:cntrl:]]|$)";
2081 $clause = "{$field['dbAlias']} {$operator} REGEXP '{$regexp}'";
2087 if ($value !== NULL && strlen($value) > 0) {
2088 $value = CRM_Utils_Type
::escape($value, $type);
2089 if (strpos($value, '%') === FALSE) {
2091 $value = "'{$value}%'";
2094 $value = "'%{$value}'";
2098 $value = "'{$value}'";
2100 $sqlOP = $this->getSQLOperator($op);
2101 $clause = "( {$field['dbAlias']} $sqlOP $value )";
2107 $sqlOP = $this->getSQLOperator($op);
2108 $clause = "( {$field['dbAlias']} $sqlOP )";
2114 //CRM-18457: some custom field passes value in array format against binary operator
2115 if (is_array($value) && count($value)) {
2120 if ($value !== NULL && $value !== '') {
2121 if (isset($field['clause'])) {
2122 // FIXME: we not doing escape here. Better solution is to use two
2123 // different types - data-type and filter-type
2124 $clause = $field['clause'];
2126 elseif (!is_array($value)) {
2127 $value = CRM_Utils_Type
::escape($value, $type);
2128 $sqlOP = $this->getSQLOperator($op);
2129 if ($field['type'] == CRM_Utils_Type
::T_STRING
) {
2130 $value = "'{$value}'";
2132 $clause = "( {$field['dbAlias']} $sqlOP $value )";
2138 //dev/core/544 Add report support for multiple contact subTypes
2139 if ($field['name'] == 'contact_sub_type' && $clause) {
2140 $clause = $this->whereSubtypeClause($field, $value, $op);
2142 if (!empty($field['group']) && $clause) {
2143 $clause = $this->whereGroupClause($field, $value, $op);
2145 elseif (!empty($field['tag']) && $clause) {
2146 // not using left join in query because if any contact
2147 // belongs to more than one tag, results duplicate
2149 $clause = $this->whereTagClause($field, $value, $op);
2151 elseif (!empty($field['membership_org']) && $clause) {
2152 $clause = $this->whereMembershipOrgClause($value, $op);
2154 elseif (!empty($field['membership_type']) && $clause) {
2155 $clause = $this->whereMembershipTypeClause($value, $op);
2161 * Get SQL where clause for contact subtypes
2162 * @param string $field
2163 * @param mixed $value
2164 * @param string $op SQL Operator
2168 public function whereSubtypeClause($field, $value, $op) {
2169 // Get the correct SQL operator.
2174 $clauseSeparator = ' AND ';
2180 $clauseSeparator = ' OR ';
2183 $sqlOp = $this->getSQLOperator($op);
2184 if ($sqlOp == 'IS NULL' ||
$sqlOp == 'IS NOT NULL') {
2185 $clause = "{$field['dbAlias']} $sqlOp";
2189 foreach ($value as $item) {
2190 $subclauses[] = "( {$field['dbAlias']} $sqlOp '%" . CRM_Core_DAO
::VALUE_SEPARATOR
. $item . CRM_Core_DAO
::VALUE_SEPARATOR
. "%' )";
2192 $clause = implode($clauseSeparator, $subclauses);
2194 $clause = "( $clause )";
2196 $clause = "( ( {$field['dbAlias']} IS NULL ) OR $clause )";
2202 * Get SQL where clause for a date field.
2204 * @param string $fieldName
2205 * @param string $relative
2206 * @param string $from
2208 * @param string $type
2209 * @param string $fromTime
2210 * @param string $toTime
2212 * @return null|string
2214 public function dateClause(
2216 $relative, $from, $to, $type = NULL, $fromTime = NULL, $toTime = NULL
2219 if (in_array($relative, array_keys($this->getOperationPair(CRM_Report_Form
::OP_DATE
)))) {
2220 $sqlOP = $this->getSQLOperator($relative);
2221 return "( {$fieldName} {$sqlOP} )";
2223 if (strlen($to) === 10) {
2224 // If we just have the date we assume the end of that day.
2229 list($from, $to) = $this->getFromTo($relative, $from, $to, $fromTime, $toTime);
2233 $clauses[] = "( {$fieldName} >= " . date('YmdHis', strtotime($from)) . ')';
2237 $clauses[] = "( {$fieldName} <= " . date('YmdHis', strtotime($to)) . ')';
2239 if (!empty($clauses)) {
2240 return implode(' AND ', $clauses);
2247 * Get values for from and to for date ranges.
2251 * @param bool $relative
2252 * @param string $from
2254 * @param string $fromTime
2255 * @param string $toTime
2259 public function getFromTo($relative, $from, $to, $fromTime = NULL, $toTime = NULL) {
2260 if (!empty($fromTime) ||
!empty($toTime)) {
2261 throw new CRM_Core_Exception('Report template needs to be updated as getFromTo no longer supports fromTime or ToTime Parameters');
2263 return CRM_Utils_Date
::getFromTo($relative, $from, $to);
2267 * Alter display of rows.
2269 * Iterate through the rows retrieved via SQL and make changes for display purposes,
2270 * such as rendering contacts as links.
2272 * @param array $rows
2273 * Rows generated by SQL, with an array for each row.
2275 public function alterDisplay(&$rows) {
2279 * Alter the way in which custom data fields are displayed.
2281 * @param array $rows
2283 public function alterCustomDataDisplay(&$rows) {
2284 // custom code to alter rows having custom values
2285 if (empty($this->_customGroupExtends
)) {
2290 $customFieldIds = [];
2291 foreach ($this->_params
['fields'] as $fieldAlias => $value) {
2292 if ($fieldId = CRM_Core_BAO_CustomField
::getKeyID($fieldAlias)) {
2293 $customFieldIds[$fieldAlias] = $fieldId;
2296 if (empty($customFieldIds)) {
2300 // skip for type date and ContactReference since date format is already handled
2302 SELECT cg.table_name, cf.id
2303 FROM civicrm_custom_field cf
2304 INNER JOIN civicrm_custom_group cg ON cg.id = cf.custom_group_id
2305 WHERE cg.extends IN ('" . implode("','", $this->_customGroupExtends
) . "') AND
2306 cg.is_active = 1 AND
2307 cf.is_active = 1 AND
2308 cf.is_searchable = 1 AND
2309 cf.data_type NOT IN ('ContactReference', 'Date') AND
2310 cf.id IN (" . implode(",", $customFieldIds) . ")";
2312 $dao = CRM_Core_DAO
::executeQuery($query);
2313 while ($dao->fetch()) {
2314 $customFields[$dao->table_name
. '_custom_' . $dao->id
] = $dao->id
;
2317 $entryFound = FALSE;
2318 foreach ($rows as $rowNum => $row) {
2319 foreach ($row as $tableCol => $val) {
2320 if (array_key_exists($tableCol, $customFields)) {
2321 $rows[$rowNum][$tableCol] = CRM_Core_BAO_CustomField
::displayValue($val, $customFields[$tableCol]);
2326 // skip looking further in rows, if first row itself doesn't
2327 // have the column we need
2335 * Remove duplicate rows.
2337 * @param array $rows
2339 public function removeDuplicates(&$rows) {
2340 if (empty($this->_noRepeats
)) {
2345 foreach ($rows as $key => $list) {
2346 foreach ($list as $colName => $colVal) {
2347 if (array_key_exists($colName, $checkList) &&
2348 $checkList[$colName] == $colVal
2350 $rows[$key][$colName] = "";
2352 if (in_array($colName, $this->_noRepeats
)) {
2353 $checkList[$colName] = $colVal;
2360 * Fix subtotal display.
2363 * @param array $fields
2364 * @param bool $subtotal
2366 public function fixSubTotalDisplay(&$row, $fields, $subtotal = TRUE) {
2367 foreach ($row as $colName => $colVal) {
2368 if (in_array($colName, $fields)) {
2370 elseif (isset($this->_columnHeaders
[$colName])) {
2372 $row[$colName] = 'Subtotal';
2376 unset($row[$colName]);
2383 * Calculate grant total.
2385 * @param array $rows
2389 public function grandTotal(&$rows) {
2390 if (!$this->_rollup ||
count($rows) == 1) {
2394 $this->moveSummaryColumnsToTheRightHandSide();
2396 if ($this->_limit
&& count($rows) >= self
::ROW_COUNT_LIMIT
) {
2400 $this->rollupRow
= array_pop($rows);
2402 foreach ($this->_columnHeaders
as $fld => $val) {
2403 if (!in_array($fld, $this->_statFields
)) {
2404 if (!$this->_grandFlag
) {
2405 $this->rollupRow
[$fld] = ts('Grand Total');
2406 $this->_grandFlag
= TRUE;
2409 $this->rollupRow
[$fld] = "";
2414 $this->assign('grandStat', $this->rollupRow
);
2419 * Format display output.
2421 * @param array $rows
2422 * @param bool $pager
2424 public function formatDisplay(&$rows, $pager = TRUE) {
2425 // set pager based on if any limit was applied in the query.
2430 // allow building charts if any
2431 if (!empty($this->_params
['charts']) && !empty($rows)) {
2432 $this->buildChart($rows);
2433 $this->assign('chartEnabled', TRUE);
2434 $this->_chartId
= "{$this->_params['charts']}_" .
2435 ($this->_id ?
$this->_id
: substr(get_class($this), 16)) . '_' .
2437 $this->assign('chartId', $this->_chartId
);
2440 // unset columns not to be displayed.
2441 foreach ($this->_columnHeaders
as $key => $value) {
2442 if (!empty($value['no_display'])) {
2443 unset($this->_columnHeaders
[$key]);
2447 // unset columns not to be displayed.
2448 if (!empty($rows)) {
2449 foreach ($this->_noDisplay
as $noDisplayField) {
2450 foreach ($rows as $rowNum => $row) {
2451 unset($this->_columnHeaders
[$noDisplayField]);
2456 // Find alter display functions.
2457 $firstRow = reset($rows);
2459 $selectedFields = array_keys($firstRow);
2460 $alterFunctions = $alterMap = $alterSpecs = [];
2461 foreach ($this->_columns
as $tableName => $table) {
2462 if (array_key_exists('metadata', $table)) {
2463 foreach ($table['metadata'] as $field => $specs) {
2464 if (in_array($tableName . '_' . $field, $selectedFields)) {
2465 if (array_key_exists('alter_display', $specs)) {
2466 $alterFunctions[$tableName . '_' . $field] = $specs['alter_display'];
2467 $alterMap[$tableName . '_' . $field] = $field;
2468 $alterSpecs[$tableName . '_' . $field] = NULL;
2470 // Add any alters that can be intuited from the field specs.
2471 // So far only boolean but a lot more could be.
2472 if (empty($alterSpecs[$tableName . '_' . $field]) && isset($specs['type']) && $specs['type'] == CRM_Utils_Type
::T_BOOLEAN
) {
2473 $alterFunctions[$tableName . '_' . $field] = 'alterBoolean';
2474 $alterMap[$tableName . '_' . $field] = $field;
2475 $alterSpecs[$tableName . '_' . $field] = NULL;
2482 // Run the alter display functions
2483 foreach ($rows as $index => & $row) {
2484 foreach ($row as $selectedField => $value) {
2485 if (array_key_exists($selectedField, $alterFunctions) && isset($value)) {
2486 $rows[$index][$selectedField] = $this->{$alterFunctions[$selectedField]}($value, $row, $selectedField, $alterMap[$selectedField], $alterSpecs[$selectedField]);
2492 // use this method for formatting rows for display purpose.
2493 $this->alterDisplay($rows);
2494 CRM_Utils_Hook
::alterReportVar('rows', $rows, $this);
2496 // build array of section totals
2497 $this->sectionTotals();
2499 // process grand-total row
2500 $this->grandTotal($rows);
2502 // use this method for formatting custom rows for display purpose.
2503 $this->alterCustomDataDisplay($rows);
2509 * @param $selectedfield
2510 * @param $criteriaFieldName
2514 protected function alterStateProvinceID($value, &$row, $selectedfield, $criteriaFieldName) {
2515 $url = CRM_Utils_System
::url(CRM_Utils_System
::currentPath(), "reset=1&force=1&{$criteriaFieldName}_op=in&{$criteriaFieldName}_value={$value}", $this->_absoluteUrl
);
2516 $row[$selectedfield . '_link'] = $url;
2517 $row[$selectedfield . '_hover'] = ts("%1 for this state.", [
2521 $states = CRM_Core_PseudoConstant
::stateProvince($value, FALSE);
2522 if (!is_array($states)) {
2530 * @param $selectedField
2531 * @param $criteriaFieldName
2535 protected function alterCountryID($value, &$row, $selectedField, $criteriaFieldName) {
2536 $url = CRM_Utils_System
::url(CRM_Utils_System
::currentPath(), "reset=1&force=1&{$criteriaFieldName}_op=in&{$criteriaFieldName}_value={$value}", $this->_absoluteUrl
);
2537 $row[$selectedField . '_link'] = $url;
2538 $row[$selectedField . '_hover'] = ts("%1 for this country.", [
2541 $countries = CRM_Core_PseudoConstant
::country($value, FALSE);
2542 if (!is_array($countries)) {
2550 * @param $selectedfield
2551 * @param $criteriaFieldName
2555 protected function alterCountyID($value, &$row, $selectedfield, $criteriaFieldName) {
2556 $url = CRM_Utils_System
::url(CRM_Utils_System
::currentPath(), "reset=1&force=1&{$criteriaFieldName}_op=in&{$criteriaFieldName}_value={$value}", $this->_absoluteUrl
);
2557 $row[$selectedfield . '_link'] = $url;
2558 $row[$selectedfield . '_hover'] = ts("%1 for this county.", [
2561 $counties = CRM_Core_PseudoConstant
::county($value, FALSE);
2562 if (!is_array($counties)) {
2570 * @param $selectedfield
2571 * @param $criteriaFieldName
2575 protected function alterLocationTypeID($value, &$row, $selectedfield, $criteriaFieldName) {
2576 return CRM_Core_PseudoConstant
::getLabel('CRM_Core_DAO_Address', 'location_type_id', $value);
2586 protected function alterContactID($value, &$row, $fieldname) {
2587 $nameField = substr($fieldname, 0, -2) . 'name';
2588 static $first = TRUE;
2589 static $viewContactList = FALSE;
2591 $viewContactList = CRM_Core_Permission
::check('access CiviCRM');
2594 if (!$viewContactList) {
2597 if (array_key_exists($nameField, $row)) {
2598 $row[$nameField . '_link'] = CRM_Utils_System
::url("civicrm/contact/view", 'reset=1&cid=' . $value, $this->_absoluteUrl
);
2601 $row[$fieldname . '_link'] = CRM_Utils_System
::url("civicrm/contact/view", 'reset=1&cid=' . $value, $this->_absoluteUrl
);
2613 protected function alterCommunicationtMethod($value, &$row, $fieldname) {
2614 $communicationMethods = CRM_Core_PseudoConstant
::get('CRM_Contact_DAO_Contact', 'preferred_communication_method');
2616 // Explode padded values.
2617 $values = CRM_utils_array
::explodePadded($value);
2618 // Flip values, compute intersection with $communicationMethods, and implode with commas.
2619 $value = implode(', ', array_intersect_key($communicationMethods, array_flip($values)));
2628 protected function alterBoolean($value) {
2629 $options = [0 => '', 1 => ts('Yes')];
2630 if (isset($options[$value])) {
2631 return $options[$value];
2639 * @param array $rows
2641 public function buildChart(&$rows) {
2642 // override this method for building charts.
2645 // select() method below has been added recently (v3.3), and many of the report templates might
2646 // still be having their own select() method. We should fix them as and when encountered and move
2647 // towards generalizing the select() method below.
2650 * Generate the SELECT clause and set class variable $_select.
2652 public function select() {
2653 $select = $this->_selectAliases
= [];
2654 $this->storeGroupByArray();
2656 foreach ($this->_columns
as $tableName => $table) {
2657 if (array_key_exists('fields', $table)) {
2658 foreach ($table['fields'] as $fieldName => $field) {
2659 if ($tableName == 'civicrm_address') {
2660 // deprecated, use $this->isTableSelected.
2661 $this->_addressField
= TRUE;
2663 if ($tableName == 'civicrm_email') {
2664 $this->_emailField
= TRUE;
2666 if ($tableName == 'civicrm_phone') {
2667 $this->_phoneField
= TRUE;
2670 if (!empty($field['required']) ||
2671 !empty($this->_params
['fields'][$fieldName])
2674 // 1. In many cases we want select clause to be built in slightly different way
2675 // for a particular field of a particular type.
2676 // 2. This method when used should receive params by reference and modify $this->_columnHeaders
2678 $selectClause = $this->selectClause($tableName, 'fields', $fieldName, $field);
2679 if ($selectClause) {
2680 $select[] = $selectClause;
2684 // include statistics columns only if set
2685 if (!empty($field['statistics']) && !empty($this->_groupByArray
)) {
2686 $select = $this->addStatisticsToSelect($field, $tableName, $fieldName, $select);
2690 $selectClause = $this->getSelectClauseWithGroupConcatIfNotGroupedBy($tableName, $fieldName, $field);
2691 if ($selectClause) {
2692 $select[] = $selectClause;
2695 $select = $this->addBasicFieldToSelect($tableName, $fieldName, $field, $select);
2702 // select for group bys
2703 if (array_key_exists('group_bys', $table)) {
2704 foreach ($table['group_bys'] as $fieldName => $field) {
2706 if ($tableName == 'civicrm_address') {
2707 $this->_addressField
= TRUE;
2709 if ($tableName == 'civicrm_email') {
2710 $this->_emailField
= TRUE;
2712 if ($tableName == 'civicrm_phone') {
2713 $this->_phoneField
= TRUE;
2715 // 1. In many cases we want select clause to be built in slightly different way
2716 // for a particular field of a particular type.
2717 // 2. This method when used should receive params by reference and modify $this->_columnHeaders
2719 $selectClause = $this->selectClause($tableName, 'group_bys', $fieldName, $field);
2720 if ($selectClause) {
2721 $select[] = $selectClause;
2725 if (!empty($this->_params
['group_bys']) &&
2726 !empty($this->_params
['group_bys'][$fieldName]) &&
2727 !empty($this->_params
['group_bys_freq'])
2729 switch (CRM_Utils_Array
::value($fieldName, $this->_params
['group_bys_freq'])) {
2731 $select[] = "DATE_SUB({$field['dbAlias']}, INTERVAL WEEKDAY({$field['dbAlias']}) DAY) AS {$tableName}_{$fieldName}_start";
2732 $select[] = "YEARWEEK({$field['dbAlias']}) AS {$tableName}_{$fieldName}_subtotal";
2733 $select[] = "WEEKOFYEAR({$field['dbAlias']}) AS {$tableName}_{$fieldName}_interval";
2734 $field['title'] = 'Week';
2738 $select[] = "MAKEDATE(YEAR({$field['dbAlias']}), 1) AS {$tableName}_{$fieldName}_start";
2739 $select[] = "YEAR({$field['dbAlias']}) AS {$tableName}_{$fieldName}_subtotal";
2740 $select[] = "YEAR({$field['dbAlias']}) AS {$tableName}_{$fieldName}_interval";
2741 $field['title'] = 'Year';
2745 $select[] = "DATE_SUB({$field['dbAlias']}, INTERVAL (DAYOFMONTH({$field['dbAlias']})-1) DAY) as {$tableName}_{$fieldName}_start";
2746 $select[] = "MONTH({$field['dbAlias']}) AS {$tableName}_{$fieldName}_subtotal";
2747 $select[] = "MONTHNAME({$field['dbAlias']}) AS {$tableName}_{$fieldName}_interval";
2748 $field['title'] = 'Month';
2752 $select[] = "STR_TO_DATE(CONCAT( 3 * QUARTER( {$field['dbAlias']} ) -2 , '/', '1', '/', YEAR( {$field['dbAlias']} ) ), '%m/%d/%Y') AS {$tableName}_{$fieldName}_start";
2753 $select[] = "QUARTER({$field['dbAlias']}) AS {$tableName}_{$fieldName}_subtotal";
2754 $select[] = "QUARTER({$field['dbAlias']}) AS {$tableName}_{$fieldName}_interval";
2755 $field['title'] = 'Quarter';
2758 // for graphs and charts -
2759 if (!empty($this->_params
['group_bys_freq'][$fieldName])) {
2760 $this->_interval
= $field['title'];
2761 $this->_columnHeaders
["{$tableName}_{$fieldName}_start"]['title']
2762 = $field['title'] . ' Beginning';
2763 $this->_columnHeaders
["{$tableName}_{$fieldName}_start"]['type'] = $field['type'];
2764 $this->_columnHeaders
["{$tableName}_{$fieldName}_start"]['group_by'] = $this->_params
['group_bys_freq'][$fieldName];
2766 // just to make sure these values are transferred to rows.
2767 // since we 'll need them for calculation purpose,
2768 // e.g making subtotals look nicer or graphs
2769 $this->_columnHeaders
["{$tableName}_{$fieldName}_interval"] = ['no_display' => TRUE];
2770 $this->_columnHeaders
["{$tableName}_{$fieldName}_subtotal"] = ['no_display' => TRUE];
2777 if (empty($select)) {
2778 // CRM-21412 Do not give fatal error on report when no fields selected
2782 $this->_selectClauses
= $select;
2783 $this->_select
= "SELECT " . implode(', ', $select) . " ";
2787 * Build select clause for a single field.
2789 * @param string $tableName
2790 * @param string $tableKey
2791 * @param string $fieldName
2792 * @param string $field
2796 public function selectClause(&$tableName, $tableKey, &$fieldName, &$field) {
2797 if (!empty($field['pseudofield'])) {
2798 $alias = "{$tableName}_{$fieldName}";
2799 $this->_columnHeaders
["{$tableName}_{$fieldName}"]['title'] = $field['title'] ??
NULL;
2800 $this->_columnHeaders
["{$tableName}_{$fieldName}"]['type'] = $field['type'] ??
NULL;
2801 $this->_columnHeaders
["{$tableName}_{$fieldName}"]['dbAlias'] = $field['dbAlias'] ??
NULL;
2802 $this->_selectAliases
[] = $alias;
2803 return ' 1 as ' . $alias;
2809 * Build where clause.
2811 public function where() {
2812 $this->storeWhereHavingClauseArray();
2814 if (empty($this->_whereClauses
)) {
2815 $this->_where
= "WHERE ( 1 ) ";
2816 $this->_having
= "";
2819 $this->_where
= "WHERE " . implode(' AND ', $this->_whereClauses
);
2822 if ($this->_aclWhere
) {
2823 $this->_where
.= " AND {$this->_aclWhere} ";
2826 if (!empty($this->_havingClauses
)) {
2827 // use this clause to construct group by clause.
2828 $this->_having
= "HAVING " . implode(' AND ', $this->_havingClauses
);
2833 * Store Where clauses into an array.
2835 * Breaking out this step makes over-riding more flexible as the clauses can be used in constructing a
2836 * temp table that may not be part of the final where clause or added
2837 * in other functions
2839 public function storeWhereHavingClauseArray() {
2840 foreach ($this->_columns
as $tableName => $table) {
2841 if (array_key_exists('filters', $table)) {
2842 foreach ($table['filters'] as $fieldName => $field) {
2843 // respect pseudofield to filter spec so fields can be marked as
2844 // not to be handled here
2845 if (!empty($field['pseudofield'])) {
2848 $clause = $this->generateFilterClause($field, $fieldName);
2850 if (!empty($clause)) {
2851 if (!empty($field['having'])) {
2852 $this->_havingClauses
[] = $clause;
2855 $this->_whereClauses
[] = $clause;
2867 public function processReportMode() {
2868 $this->setOutputMode();
2871 = CRM_Utils_Request
::retrieve(
2874 CRM_Core_DAO
::$_nullObject
2877 if ($this->_sendmail
&& !$this->_outputMode
) {
2878 // If we're here from the mail_report job, then the default there gets
2879 // set to pdf before we get here, but if we're somehow here and sending
2880 // by email and don't have a format set, then use print.
2881 // @todo Is this on purpose - why would they be different defaults?
2882 $this->_outputMode
= 'print';
2885 // _outputMode means multiple things and can cover export to file formats,
2886 // like csv, or actions with no output, like save. So this will only set
2887 // a handler if it's one of the former. But it's also possible we have a
2888 // really interesting handler out there. But the point is we don't need to
2889 // know, just to know that a handler doesn't always get set by this call.
2890 $this->setOutputHandler();
2892 if (!empty($this->outputHandler
)) {
2893 if ($this->_sendmail
) {
2894 // If we're sending by email these are the only options that make
2896 $this->printOnly
= TRUE;
2897 $this->addPaging
= FALSE;
2898 $this->_absoluteUrl
= TRUE;
2901 // otherwise ask the handler
2902 $this->printOnly
= $this->outputHandler
->isPrintOnly();
2903 $this->addPaging
= $this->outputHandler
->isAddPaging();
2904 $this->_absoluteUrl
= $this->outputHandler
->isAbsoluteUrl();
2907 elseif ($this->_outputMode
== 'copy' && $this->_criteriaForm
) {
2908 $this->_createNew
= TRUE;
2911 $this->assign('outputMode', $this->_outputMode
);
2912 $this->assign('printOnly', $this->printOnly
);
2913 // Get today's date to include in printed reports
2914 if ($this->printOnly
) {
2915 $reportDate = CRM_Utils_Date
::customFormat(date('Y-m-d H:i'));
2916 $this->assign('reportDate', $reportDate);
2921 * Post Processing function for Form.
2923 * postProcessCommon should be used to set other variables from input as the api accesses that function.
2924 * This function is not accessed when the api calls the report.
2926 public function beginPostProcess() {
2927 $this->setParams($this->controller
->exportValues($this->_name
));
2928 if (empty($this->_params
) &&
2931 $this->setParams($this->_formValues
);
2934 // hack to fix params when submitted from dashboard, CRM-8532
2935 // fields array is missing because form building etc is skipped
2936 // in dashboard mode for report
2937 //@todo - this could be done in the dashboard no we have a setter
2938 if (empty($this->_params
['fields']) && !$this->_noFields
) {
2939 $this->setParams($this->_formValues
);
2942 $this->processReportMode();
2944 if ($this->_outputMode
== 'save' ||
$this->_outputMode
== 'copy') {
2945 $this->_createNew
= ($this->_outputMode
== 'copy');
2946 CRM_Report_Form_Instance
::postProcess($this);
2948 if ($this->_outputMode
== 'delete') {
2949 CRM_Report_BAO_ReportInstance
::doFormDelete($this->_id
, 'civicrm/report/list?reset=1', 'civicrm/report/list?reset=1');
2952 $this->_formValues
= $this->_params
;
2954 $this->beginPostProcessCommon();
2958 * BeginPostProcess function run in both report mode and non-report mode (api).
2960 public function beginPostProcessCommon() {
2964 * Build the report query.
2966 * @param bool $applyLimit
2970 public function buildQuery($applyLimit = TRUE) {
2971 $this->buildGroupTempTable();
2974 $this->customDataFrom();
2975 $this->buildPermissionClause();
2980 foreach ($this->unselectedOrderByColumns() as $alias => $field) {
2981 $clause = $this->getSelectClauseWithGroupConcatIfNotGroupedBy($field['table_name'], $field['name'], $field);
2983 $clause = "{$field['dbAlias']} as {$alias}";
2985 $this->_select
.= ", $clause ";
2988 if ($applyLimit && empty($this->_params
['charts'])) {
2991 CRM_Utils_Hook
::alterReportVar('sql', $this, $this);
2993 $sql = "{$this->_select} {$this->_from} {$this->_where} {$this->_groupBy} {$this->_having} {$this->_orderBy} {$this->_limit}";
2994 $this->addToDeveloperTab($sql);
2999 * Build group by clause.
3001 public function groupBy() {
3002 $this->storeGroupByArray();
3004 if (!empty($this->_groupByArray
)) {
3005 if ($this->optimisedForOnlyFullGroupBy
) {
3006 // We should probably deprecate this code path. What happens here is that
3007 // the group by is amended to reflect the select columns. This often breaks the
3008 // results. Retrofitting group strict group by onto existing report classes
3010 $this->_groupBy
= CRM_Contact_BAO_Query
::getGroupByFromSelectColumns($this->_selectClauses
, $this->_groupByArray
);
3013 $this->_groupBy
= ' GROUP BY ' . implode($this->_groupByArray
);
3019 * Build order by clause.
3021 public function orderBy() {
3022 $this->_orderBy
= "";
3023 $this->_sections
= [];
3024 $this->storeOrderByArray();
3025 if (!empty($this->_orderByArray
) && !$this->_rollup
== 'WITH ROLLUP') {
3026 $this->_orderBy
= "ORDER BY " . implode(', ', $this->_orderByArray
);
3028 $this->assign('sections', $this->_sections
);
3032 * Extract order by fields and store as an array.
3034 * In some cases other functions want to know which fields are selected for ordering by
3035 * Separating this into a separate function allows it to be called separately from constructing
3036 * the order by clause
3038 public function storeOrderByArray() {
3041 if (!empty($this->_params
['order_bys']) &&
3042 is_array($this->_params
['order_bys']) &&
3043 !empty($this->_params
['order_bys'])
3046 // Process order_bys in user-specified order
3047 foreach ($this->_params
['order_bys'] as $orderBy) {
3049 foreach ($this->_columns
as $tableName => $table) {
3050 if (array_key_exists('order_bys', $table)) {
3051 // For DAO columns defined in $this->_columns
3052 $fields = $table['order_bys'];
3054 elseif (array_key_exists('extends', $table)) {
3055 // For custom fields referenced in $this->_customGroupExtends
3056 $fields = CRM_Utils_Array
::value('fields', $table, []);
3061 if (!empty($fields) && is_array($fields)) {
3062 foreach ($fields as $fieldName => $field) {
3063 if ($fieldName == $orderBy['column']) {
3064 $orderByField = array_merge($field, $orderBy);
3065 $orderByField['tplField'] = "{$tableName}_{$fieldName}";
3072 if (!empty($orderByField)) {
3073 $this->_orderByFields
[$orderByField['tplField']] = $orderByField;
3074 if ($this->groupConcatTested
) {
3075 $orderBys[$orderByField['tplField']] = "{$orderByField['tplField']} {$orderBy['order']}";
3078 // Not sure when this is preferable to using tplField (which has
3079 // definitely been tested to work in cases then this does not.
3080 // in caution not switching unless report has been tested for
3081 // group concat functionality.
3082 $orderBys[$orderByField['tplField']] = "{$orderByField['dbAlias']} {$orderBy['order']}";
3085 // Record any section headers for assignment to the template
3086 if (!empty($orderBy['section'])) {
3087 $orderByField['pageBreak'] = $orderBy['pageBreak'] ??
NULL;
3088 $this->_sections
[$orderByField['tplField']] = $orderByField;
3094 $this->_orderByArray
= $orderBys;
3096 $this->assign('sections', $this->_sections
);
3100 * Determine unselected columns.
3104 public function unselectedOrderByColumns() {
3105 return array_diff_key($this->_orderByFields
, $this->getSelectColumns());
3109 * Determine unselected columns.
3113 public function unselectedSectionColumns() {
3114 if (is_array($this->_sections
)) {
3115 return array_diff_key($this->_sections
, $this->getSelectColumns());
3123 * Build output rows.
3125 * @param string $sql
3126 * @param array $rows
3128 public function buildRows($sql, &$rows) {
3129 if (!$this->optimisedForOnlyFullGroupBy
) {
3130 CRM_Core_DAO
::disableFullGroupByMode();
3132 $dao = CRM_Core_DAO
::executeQuery($sql);
3133 if (stristr($this->_select
, 'SQL_CALC_FOUND_ROWS')) {
3134 $this->_rowsFound
= CRM_Core_DAO
::singleValueQuery('SELECT FOUND_ROWS()');
3136 CRM_Core_DAO
::reenableFullGroupByMode();
3137 if (!is_array($rows)) {
3141 // use this method to modify $this->_columnHeaders
3142 $this->modifyColumnHeaders();
3144 $unselectedSectionColumns = $this->unselectedSectionColumns();
3146 while ($dao->fetch()) {
3148 foreach ($this->_columnHeaders
as $key => $value) {
3149 if (property_exists($dao, $key)) {
3150 $row[$key] = $dao->$key;
3154 // section headers not selected for display need to be added to row
3155 foreach ($unselectedSectionColumns as $key => $values) {
3156 if (property_exists($dao, $key)) {
3157 $row[$key] = $dao->$key;
3166 * Calculate section totals.
3168 * When "order by" fields are marked as sections, this assigns to the template
3169 * an array of total counts for each section. This data is used by the Smarty
3170 * plugin {sectionTotal}.
3172 public function sectionTotals() {
3174 // Reports using order_bys with sections must populate $this->_selectAliases in select() method.
3175 if (empty($this->_selectAliases
)) {
3179 if (!empty($this->_sections
)) {
3180 // build the query with no LIMIT clause
3181 $select = str_ireplace('SELECT SQL_CALC_FOUND_ROWS ', 'SELECT ', $this->_select
);
3182 $sql = "{$select} {$this->_from} {$this->_where} {$this->_groupBy} {$this->_having} {$this->_orderBy}";
3184 // pull section aliases out of $this->_sections
3185 $sectionAliases = array_keys($this->_sections
);
3188 foreach (array_merge($sectionAliases, $this->_selectAliases
) as $alias) {
3189 $ifnulls[] = "ifnull($alias, '') as $alias";
3191 $this->_select
= "SELECT " . implode(", ", $ifnulls);
3192 $this->_select
= CRM_Contact_BAO_Query
::appendAnyValueToSelect($ifnulls, $sectionAliases);
3194 // Group (un-limited) report by all aliases and get counts. This might
3195 // be done more efficiently when the contents of $sql are known, ie. by
3196 // overriding this method in the report class.
3198 $query = $this->_select
.
3199 ", count(*) as ct from ($sql) as subquery group by " .
3200 implode(", ", $sectionAliases);
3202 // initialize array of total counts
3204 $dao = CRM_Core_DAO
::executeQuery($query);
3205 while ($dao->fetch()) {
3207 // let $this->_alterDisplay translate any integer ids to human-readable values.
3208 $rows[0] = $dao->toArray();
3209 $this->alterDisplay($rows);
3212 // add totals for all permutations of section values
3215 $aliasCount = count($sectionAliases);
3216 foreach ($sectionAliases as $alias) {
3217 $values[] = $row[$alias];
3218 $key = implode(CRM_Core_DAO
::VALUE_SEPARATOR
, $values);
3219 if ($i == $aliasCount) {
3220 // the last alias is the lowest-level section header; use count as-is
3221 $totals[$key] = $dao->ct
;
3224 // other aliases are higher level; roll count into their total
3225 $totals[$key] +
= $dao->ct
;
3229 $this->assign('sectionTotals', $totals);
3234 * Modify column headers.
3236 public function modifyColumnHeaders() {
3237 // use this method to modify $this->_columnHeaders
3241 * Move totals columns to the right edge of the table.
3243 * It seems like a more logical layout to have any totals columns on the far right regardless of
3244 * the location of the rest of their table.
3246 public function moveSummaryColumnsToTheRightHandSide() {
3247 $statHeaders = (array_intersect_key($this->_columnHeaders
, array_flip($this->_statFields
)));
3248 $this->_columnHeaders
= array_merge(array_diff_key($this->_columnHeaders
, $statHeaders), $this->_columnHeaders
, $statHeaders);
3252 * Assign rows to the template.
3254 * @param array $rows
3256 public function doTemplateAssignment(&$rows) {
3257 $this->assign_by_ref('columnHeaders', $this->_columnHeaders
);
3258 $this->assign_by_ref('rows', $rows);
3259 $this->assign('statistics', $this->statistics($rows));
3263 * Build report statistics.
3265 * Override this method to build your own statistics.
3267 * @param array $rows
3271 public function statistics(&$rows) {
3274 $count = count($rows);
3275 // Why do we increment the count for rollup seems to artificially inflate the count.
3276 // It seems perhaps intentional to include the summary row in the count of results - although
3277 // this just seems odd.
3278 if ($this->_rollup
&& ($this->_rollup
!= '') && $this->_grandFlag
) {
3282 $this->countStat($statistics, $count);
3284 $this->groupByStat($statistics);
3286 $this->filterStat($statistics);
3292 * Add count statistics.
3294 * @param array $statistics
3297 public function countStat(&$statistics, $count) {
3298 $statistics['counts']['rowCount'] = [
3299 'title' => ts('Row(s) Listed'),
3303 if ($this->_rowsFound
&& ($this->_rowsFound
> $count)) {
3304 $statistics['counts']['rowsFound'] = [
3305 'title' => ts('Total Row(s)'),
3306 'value' => $this->_rowsFound
,
3312 * Add group by statistics.
3314 * @param array $statistics
3316 public function groupByStat(&$statistics) {
3317 if (!empty($this->_params
['group_bys']) &&
3318 is_array($this->_params
['group_bys']) &&
3319 !empty($this->_params
['group_bys'])
3321 foreach ($this->_columns
as $tableName => $table) {
3322 if (array_key_exists('group_bys', $table)) {
3323 foreach ($table['group_bys'] as $fieldName => $field) {
3324 if (!empty($this->_params
['group_bys'][$fieldName])) {
3325 $combinations[] = $field['title'];
3330 $statistics['groups'][] = [
3331 'title' => ts('Grouping(s)'),
3332 'value' => implode(' & ', $combinations),
3338 * Filter statistics.
3340 * @param array $statistics
3342 public function filterStat(&$statistics) {
3343 foreach ($this->_columns
as $tableName => $table) {
3344 if (array_key_exists('filters', $table)) {
3345 foreach ($table['filters'] as $fieldName => $field) {
3346 if ((CRM_Utils_Array
::value('type', $field) & CRM_Utils_Type
::T_DATE ||
3347 CRM_Utils_Array
::value('type', $field) & CRM_Utils_Type
::T_TIME
) &&
3348 CRM_Utils_Array
::value('operatorType', $field) !=
3349 CRM_Report_Form
::OP_MONTH
3351 $from = $this->_params
["{$fieldName}_from"] ??
NULL;
3352 $to = $this->_params
["{$fieldName}_to"] ??
NULL;
3353 if (!empty($this->_params
["{$fieldName}_relative"])) {
3354 list($from, $to) = CRM_Utils_Date
::getFromTo($this->_params
["{$fieldName}_relative"], NULL, NULL);
3356 if (strlen($to) === 10) {
3357 // If we just have the date we assume the end of that day.
3362 $from = date('l j F Y, g:iA', strtotime($from));
3365 $to = date('l j F Y, g:iA', strtotime($to));
3367 $statistics['filters'][] = [
3368 'title' => $field['title'],
3369 'value' => ts("Between %1 and %2", [1 => $from, 2 => $to]),
3372 elseif (in_array($rel = CRM_Utils_Array
::value("{$fieldName}_relative", $this->_params
),
3373 array_keys($this->getOperationPair(CRM_Report_Form
::OP_DATE
))
3375 $pair = $this->getOperationPair(CRM_Report_Form
::OP_DATE
);
3376 $statistics['filters'][] = [
3377 'title' => $field['title'],
3378 'value' => $pair[$rel],
3383 $op = $this->_params
["{$fieldName}_op"] ??
NULL;
3386 $pair = $this->getOperationPair(
3387 CRM_Utils_Array
::value('operatorType', $field),
3390 $min = $this->_params
["{$fieldName}_min"] ??
NULL;
3391 $max = $this->_params
["{$fieldName}_max"] ??
NULL;
3392 $val = $this->_params
["{$fieldName}_value"] ??
NULL;
3393 if (in_array($op, ['bw', 'nbw']) && ($min ||
$max)) {
3394 $value = "{$pair[$op]} $min " . ts('and') . " $max";
3396 elseif ($val && CRM_Utils_Array
::value('operatorType', $field) & self
::OP_ENTITYREF
) {
3397 $this->setEntityRefDefaults($field, $tableName);
3398 $result = civicrm_api3($field['attributes']['entity'], 'getlist',
3400 CRM_Utils_Array
::value('api', $field['attributes'], []));
3402 foreach ($result['values'] as $v) {
3403 $values[] = $v['label'];
3405 $value = "{$pair[$op]} " . implode(', ', $values);
3407 elseif ($op == 'nll' ||
$op == 'nnll') {
3408 $value = $pair[$op];
3410 elseif (is_array($val) && (!empty($val))) {
3411 $options = CRM_Utils_Array
::value('options', $field, []);
3412 foreach ($val as $key => $valIds) {
3413 if (isset($options[$valIds])) {
3414 $val[$key] = $options[$valIds];
3417 $pair[$op] = (count($val) == 1) ?
(($op == 'notin' ||
$op ==
3418 'mnot') ?
ts('Is Not') : ts('Is')) : CRM_Utils_Array
::value($op, $pair);
3419 $val = implode(', ', $val);
3420 $value = "{$pair[$op]} " . $val;
3422 elseif (!is_array($val) && (!empty($val) ||
$val == '0') &&
3423 isset($field['options']) &&
3424 is_array($field['options']) && !empty($field['options'])
3426 $value = CRM_Utils_Array
::value($op, $pair) . " " .
3427 CRM_Utils_Array
::value($val, $field['options'], $val);
3430 $value = CRM_Utils_Array
::value($op, $pair) . " " . $val;
3433 if ($value && empty($field['no_display'])) {
3434 $statistics['filters'][] = [
3435 'title' => $field['title'] ??
NULL,
3436 'value' => CRM_Utils_String
::htmlToText($value),
3446 * End post processing.
3448 * @param array|null $rows
3450 public function endPostProcess(&$rows = NULL) {
3451 $this->assign('report_class', get_class($this));
3453 // This is used by unit tests, where _outputMode is intentionally blank.
3454 // Is there a reason it couldn't just always do this? It effectively does
3455 // the same thing anyway by assigning it to the template (in
3456 // doTemplateAssignment()).
3457 if ($this->_storeResultSet
) {
3458 $this->_resultSet
= $rows;
3461 // Add contacts to group
3462 if ($this->_outputMode
== 'group') {
3463 $group = $this->_params
['groups'];
3464 $this->add2group($group);
3467 if ($this->_sendmail
) {
3470 elseif (!empty($this->outputHandler
)) {
3471 $this->outputHandler
->download();
3472 CRM_Utils_System
::civiExit();
3474 // else we don't need to do anything here since it must have been
3475 // outputMode=save or something like that
3480 * Set store result set indicator to TRUE.
3482 * This is used by unit tests, along with getResultSet(), to get just
3483 * the output rows unformatted.
3485 public function storeResultSet() {
3486 $this->_storeResultSet
= TRUE;
3494 public function getResultSet() {
3495 return $this->_resultSet
;
3499 * Get the sql used to generate the report.
3503 public function getReportSql() {
3504 return $this->sqlArray
;
3508 * Use the form name to create the tpl file name.
3512 public function getTemplateFileName() {
3513 $defaultTpl = parent
::getTemplateFileName();
3514 $template = CRM_Core_Smarty
::singleton();
3515 if (!$template->template_exists($defaultTpl)) {
3516 $defaultTpl = 'CRM/Report/Form.tpl';
3522 * Compile the report content.
3524 * Although this function is super-short it is useful to keep separate so it can be over-ridden by report classes.
3528 public function compileContent() {
3529 $templateFile = $this->getHookedTemplateFileName();
3530 return CRM_Utils_Array
::value('report_header', $this->_formValues
) .
3531 CRM_Core_Form
::$_template->fetch($templateFile) .
3532 CRM_Utils_Array
::value('report_footer', $this->_formValues
);
3536 * Post process function.
3538 public function postProcess() {
3539 // get ready with post process params
3540 $this->beginPostProcess();
3543 $sql = $this->buildQuery();
3545 // build array of result based on column headers. This method also allows
3546 // modifying column headers before using it to build result set i.e $rows.
3548 $this->buildRows($sql, $rows);
3550 // format result set.
3551 $this->formatDisplay($rows);
3553 // assign variables to templates
3554 $this->doTemplateAssignment($rows);
3556 // do print / pdf / instance stuff if needed
3557 $this->endPostProcess($rows);
3563 * @param int $rowCount
3567 public function limit($rowCount = self
::ROW_COUNT_LIMIT
) {
3568 // lets do the pager if in html mode
3569 $this->_limit
= NULL;
3571 // CRM-14115, over-ride row count if rowCount is specified in URL
3572 if ($this->_dashBoardRowCount
) {
3573 $rowCount = $this->_dashBoardRowCount
;
3575 if ($this->addPaging
) {
3576 $this->_select
= preg_replace('/SELECT(\s+SQL_CALC_FOUND_ROWS)?\s+/i', 'SELECT SQL_CALC_FOUND_ROWS ', $this->_select
);
3578 $pageId = CRM_Utils_Request
::retrieve('crmPID', 'Integer');
3580 // @todo all http vars should be extracted in the preProcess
3581 // - not randomly in the class
3582 if (!$pageId && !empty($_POST)) {
3583 if (isset($_POST['PagerBottomButton']) && isset($_POST['crmPID_B'])) {
3584 $pageId = max((int) $_POST['crmPID_B'], 1);
3586 elseif (isset($_POST['PagerTopButton']) && isset($_POST['crmPID'])) {
3587 $pageId = max((int) $_POST['crmPID'], 1);
3589 unset($_POST['crmPID_B'], $_POST['crmPID']);
3592 $pageId = $pageId ?
$pageId : 1;
3593 $this->set(CRM_Utils_Pager
::PAGE_ID
, $pageId);
3594 $offset = ($pageId - 1) * $rowCount;
3596 $offset = CRM_Utils_Type
::escape($offset, 'Int');
3597 $rowCount = CRM_Utils_Type
::escape($rowCount, 'Int');
3599 $this->_limit
= " LIMIT $offset, $rowCount";
3600 return [$offset, $rowCount];
3602 if ($this->_limitValue
) {
3603 if ($this->_offsetValue
) {
3604 $this->_limit
= " LIMIT {$this->_offsetValue}, {$this->_limitValue} ";
3607 $this->_limit
= " LIMIT " . $this->_limitValue
;
3615 * @param int $rowCount
3617 public function setPager($rowCount = self
::ROW_COUNT_LIMIT
) {
3618 // CRM-14115, over-ride row count if rowCount is specified in URL
3619 if ($this->_dashBoardRowCount
) {
3620 $rowCount = $this->_dashBoardRowCount
;
3623 if ($this->_limit
&& ($this->_limit
!= '')) {
3624 if (!$this->_rowsFound
) {
3625 $sql = "SELECT FOUND_ROWS();";
3626 $this->_rowsFound
= CRM_Core_DAO
::singleValueQuery($sql);
3629 'total' => $this->_rowsFound
,
3630 'rowCount' => $rowCount,
3631 'status' => ts('Records') . ' %%StatusMessage%%',
3632 'buttonBottom' => 'PagerBottomButton',
3633 'buttonTop' => 'PagerTopButton',
3635 if (!empty($this->controller
)) {
3636 // This happens when being called from the api Really we want the api to be able to
3637 // pass paging parameters, but at this stage just preventing test crashes.
3638 $params['pageID'] = $this->get(CRM_Utils_Pager
::PAGE_ID
);
3641 $pager = new CRM_Utils_Pager($params);
3642 $this->assign_by_ref('pager', $pager);
3643 $this->ajaxResponse
['totalRows'] = $this->_rowsFound
;
3648 * Build a group filter with contempt for large data sets.
3650 * This function has been retained as it takes time to migrate the reports over
3651 * to the new method which will not crash on large datasets.
3655 * @param string $field
3656 * @param mixed $value
3661 public function legacySlowGroupFilterClause($field, $value, $op) {
3662 $smartGroupQuery = "";
3664 $group = new CRM_Contact_DAO_Group();
3665 $group->is_active
= 1;
3668 while ($group->fetch()) {
3669 if (in_array($group->id
, (array) $this->_params
['gid_value']) &&
3670 $group->saved_search_id
3672 $smartGroups[] = $group->id
;
3676 CRM_Contact_BAO_GroupContactCache
::check($smartGroups);
3678 $smartGroupQuery = '';
3679 if (!empty($smartGroups)) {
3680 $smartGroups = implode(',', $smartGroups);
3681 $smartGroupQuery = " UNION DISTINCT
3682 SELECT DISTINCT smartgroup_contact.contact_id
3683 FROM civicrm_group_contact_cache smartgroup_contact
3684 WHERE smartgroup_contact.group_id IN ({$smartGroups}) ";
3687 $sqlOp = $this->getSQLOperator($op);
3688 if (!is_array($value)) {
3691 //include child groups if any
3692 $value = array_merge($value, CRM_Contact_BAO_Group
::getChildGroupIds($value));
3694 $clause = "{$field['dbAlias']} IN (" . implode(', ', $value) . ")";
3696 $contactAlias = $this->_aliases
['civicrm_contact'];
3697 if (!empty($this->relationType
) && $this->relationType
== 'b_a') {
3698 $contactAlias = $this->_aliases
['civicrm_contact_b'];
3700 return " {$contactAlias}.id {$sqlOp} (
3701 SELECT DISTINCT {$this->_aliases['civicrm_group']}.contact_id
3702 FROM civicrm_group_contact {$this->_aliases['civicrm_group']}
3703 WHERE {$clause} AND {$this->_aliases['civicrm_group']}.status = 'Added'
3704 {$smartGroupQuery} ) ";
3708 * Build where clause for groups.
3710 * @param string $field
3711 * @param mixed $value
3716 public function whereGroupClause($field, $value, $op) {
3717 if ($this->groupFilterNotOptimised
) {
3718 return $this->legacySlowGroupFilterClause($field, $value, $op);
3720 if ($op === 'notin') {
3721 return " group_temp_table.id IS NULL ";
3723 // We will have used an inner join instead.
3728 * Create a table of the contact ids included by the group filter.
3730 * This function is called by both the api (tests) and the UI.
3732 public function buildGroupTempTable() {
3733 if (!empty($this->groupTempTable
) ||
empty($this->_params
['gid_value']) ||
$this->groupFilterNotOptimised
) {
3736 $filteredGroups = (array) $this->_params
['gid_value'];
3738 $groups = civicrm_api3('Group', 'get', [
3740 'id' => ['IN' => $filteredGroups],
3741 'saved_search_id' => ['>' => 0],
3744 $smartGroups = array_keys($groups['values']);
3747 SELECT DISTINCT group_contact.contact_id as id
3748 FROM civicrm_group_contact group_contact
3749 WHERE group_contact.group_id IN (" . implode(', ', $filteredGroups) . ")
3750 AND group_contact.status = 'Added' ";
3752 if (!empty($smartGroups)) {
3753 CRM_Contact_BAO_GroupContactCache
::check($smartGroups);
3754 $smartGroups = implode(',', $smartGroups);
3757 SELECT smartgroup_contact.contact_id as id
3758 FROM civicrm_group_contact_cache smartgroup_contact
3759 WHERE smartgroup_contact.group_id IN ({$smartGroups}) ";
3762 $this->groupTempTable
= $this->createTemporaryTable('rptgrp', $query);
3763 CRM_Core_DAO
::executeQuery("ALTER TABLE $this->groupTempTable ADD INDEX i_id(id)");
3767 * Execute query and add it to the developer tab.
3769 * @param string $query
3770 * @param array $params
3772 * @return \CRM_Core_DAO|object
3774 protected function executeReportQuery($query, $params = []) {
3775 $this->addToDeveloperTab($query);
3776 return CRM_Core_DAO
::executeQuery($query, $params);
3780 * Build where clause for tags.
3782 * @param string $field
3783 * @param mixed $value
3788 public function whereTagClause($field, $value, $op) {
3789 // not using left join in query because if any contact
3790 // belongs to more than one tag, results duplicate
3792 $sqlOp = $this->getSQLOperator($op);
3793 if (!is_array($value)) {
3796 $clause = "{$field['dbAlias']} IN (" . implode(', ', $value) . ")";
3797 $entity_table = $this->_tagFilterTable
;
3798 return " {$this->_aliases[$entity_table]}.id {$sqlOp} (
3799 SELECT DISTINCT {$this->_aliases['civicrm_tag']}.entity_id
3800 FROM civicrm_entity_tag {$this->_aliases['civicrm_tag']}
3801 WHERE entity_table = '$entity_table' AND {$clause} ) ";
3805 * Generate membership organization clause.
3807 * @param mixed $value
3808 * @param string $op SQL Operator
3812 public function whereMembershipOrgClause($value, $op) {
3813 $sqlOp = $this->getSQLOperator($op);
3814 if (!is_array($value)) {
3818 $tmp_membership_org_sql_list = implode(', ', $value);
3819 return " {$this->_aliases['civicrm_contact']}.id {$sqlOp} (
3820 SELECT DISTINCT mem.contact_id
3821 FROM civicrm_membership mem
3822 LEFT JOIN civicrm_membership_status mem_status ON mem.status_id = mem_status.id
3823 LEFT JOIN civicrm_membership_type mt ON mem.membership_type_id = mt.id
3824 WHERE mt.member_of_contact_id IN (" .
3825 $tmp_membership_org_sql_list . ")
3826 AND mt.is_active = '1'
3827 AND mem_status.is_current_member = '1'
3828 AND mem_status.is_active = '1' ) ";
3832 * Generate Membership Type SQL Clause.
3834 * @param mixed $value
3840 public function whereMembershipTypeClause($value, $op) {
3841 $sqlOp = $this->getSQLOperator($op);
3842 if (!is_array($value)) {
3846 $tmp_membership_sql_list = implode(', ', $value);
3847 return " {$this->_aliases['civicrm_contact']}.id {$sqlOp} (
3848 SELECT DISTINCT mem.contact_id
3849 FROM civicrm_membership mem
3850 LEFT JOIN civicrm_membership_status mem_status ON mem.status_id = mem_status.id
3851 LEFT JOIN civicrm_membership_type mt ON mem.membership_type_id = mt.id
3852 WHERE mem.membership_type_id IN (" .
3853 $tmp_membership_sql_list . ")
3854 AND mt.is_active = '1'
3855 AND mem_status.is_current_member = '1'
3856 AND mem_status.is_active = '1' ) ";
3860 * Buld contact acl clause
3861 * @deprecated in favor of buildPermissionClause
3863 * Note that if the buildPermissionClause function is called (which most reports do from
3864 * buildQuery then the results of this function are re-calculated and overwritten.
3866 * @param string $tableAlias
3868 public function buildACLClause($tableAlias = 'contact_a') {
3869 list($this->_aclFrom
, $this->_aclWhere
) = CRM_Contact_BAO_Contact_Permission
::cacheClause($tableAlias);
3873 * Build the permision clause for all entities in this report
3875 public function buildPermissionClause() {
3877 foreach ($this->selectedTables() as $tableName) {
3878 $baoName = str_replace('_DAO_', '_BAO_', CRM_Core_DAO_AllCoreTables
::getClassForTable($tableName));
3879 if ($baoName && class_exists($baoName) && !empty($this->_columns
[$tableName]['alias'])) {
3880 $tableAlias = $this->_columns
[$tableName]['alias'];
3881 $clauses = array_filter($baoName::getSelectWhereClause($tableAlias));
3882 foreach ($clauses as $field => $clause) {
3883 // Skip contact_id field if redundant
3884 if ($field != 'contact_id' ||
!in_array('civicrm_contact', $this->selectedTables())) {
3885 $ret["$tableName.$field"] = $clause;
3890 // Override output from buildACLClause
3891 $this->_aclFrom
= NULL;
3892 $this->_aclWhere
= implode(' AND ', $ret);
3896 * Add custom data to the columns.
3898 * @param bool $addFields
3899 * @param array $permCustomGroupIds
3901 public function addCustomDataToColumns($addFields = TRUE, $permCustomGroupIds = []) {
3902 if (empty($this->_customGroupExtends
)) {
3905 if (!is_array($this->_customGroupExtends
)) {
3906 $this->_customGroupExtends
= [$this->_customGroupExtends
];
3908 $customGroupWhere = '';
3909 if (!empty($permCustomGroupIds)) {
3910 $customGroupWhere = "cg.id IN (" . implode(',', $permCustomGroupIds) .
3914 SELECT cg.table_name, cg.title, cg.extends, cf.id as cf_id, cf.label,
3915 cf.column_name, cf.data_type, cf.html_type, cf.option_group_id, cf.time_format
3916 FROM civicrm_custom_group cg
3917 INNER JOIN civicrm_custom_field cf ON cg.id = cf.custom_group_id
3918 WHERE cg.extends IN ('" . implode("','", $this->_customGroupExtends
) . "') AND
3920 cg.is_active = 1 AND
3921 cf.is_active = 1 AND
3922 cf.is_searchable = 1
3923 ORDER BY cg.weight, cf.weight";
3924 $customDAO = CRM_Core_DAO
::executeQuery($sql);
3927 while ($customDAO->fetch()) {
3928 if ($customDAO->table_name
!= $curTable) {
3929 $curTable = $customDAO->table_name
;
3930 $curFields = $curFilters = [];
3933 $this->_columns
[$curTable]['dao'] = 'CRM_Contact_DAO_Contact';
3934 $this->_columns
[$curTable]['extends'] = $customDAO->extends;
3935 $this->_columns
[$curTable]['grouping'] = $customDAO->table_name
;
3936 $this->_columns
[$curTable]['group_title'] = $customDAO->title
;
3938 foreach (['fields', 'filters', 'group_bys'] as $colKey) {
3939 if (!array_key_exists($colKey, $this->_columns
[$curTable])) {
3940 $this->_columns
[$curTable][$colKey] = [];
3944 $fieldName = 'custom_' . $customDAO->cf_id
;
3947 // this makes aliasing work in favor
3948 $curFields[$fieldName] = [
3949 'name' => $customDAO->column_name
,
3950 'title' => $customDAO->label
,
3951 'dataType' => $customDAO->data_type
,
3952 'htmlType' => $customDAO->html_type
,
3955 if ($this->_customGroupFilters
) {
3956 // this makes aliasing work in favor
3957 $curFilters[$fieldName] = [
3958 'name' => $customDAO->column_name
,
3959 'title' => $customDAO->label
,
3960 'dataType' => $customDAO->data_type
,
3961 'htmlType' => $customDAO->html_type
,
3965 switch ($customDAO->data_type
) {
3968 $curFilters[$fieldName]['operatorType'] = CRM_Report_Form
::OP_DATE
;
3969 $curFilters[$fieldName]['type'] = CRM_Utils_Type
::T_DATE
;
3970 // CRM-6946, show time part for datetime date fields
3971 if ($customDAO->time_format
) {
3972 $curFields[$fieldName]['type'] = CRM_Utils_Type
::T_TIMESTAMP
;
3977 $curFilters[$fieldName]['operatorType'] = CRM_Report_Form
::OP_SELECT
;
3978 $curFilters[$fieldName]['options'] = ['' => ts('- select -')] + CRM_Core_PseudoConstant
::get('CRM_Core_BAO_CustomField', 'custom_' . $customDAO->cf_id
, [], 'search');
3979 $curFilters[$fieldName]['type'] = CRM_Utils_Type
::T_INT
;
3983 $curFilters[$fieldName]['operatorType'] = CRM_Report_Form
::OP_INT
;
3984 $curFilters[$fieldName]['type'] = CRM_Utils_Type
::T_INT
;
3988 $curFilters[$fieldName]['operatorType'] = CRM_Report_Form
::OP_FLOAT
;
3989 $curFilters[$fieldName]['type'] = CRM_Utils_Type
::T_MONEY
;
3990 $curFields[$fieldName]['type'] = CRM_Utils_Type
::T_MONEY
;
3994 $curFilters[$fieldName]['operatorType'] = CRM_Report_Form
::OP_FLOAT
;
3995 $curFilters[$fieldName]['type'] = CRM_Utils_Type
::T_FLOAT
;
3999 case 'StateProvince':
4001 $curFilters[$fieldName]['type'] = CRM_Utils_Type
::T_STRING
;
4003 $options = CRM_Core_PseudoConstant
::get('CRM_Core_BAO_CustomField', 'custom_' . $customDAO->cf_id
, [], 'search');
4004 if ((is_array($options) && count($options) != 0) ||
(!is_array($options) && $options !== FALSE)) {
4005 $curFilters[$fieldName]['operatorType'] = CRM_Core_BAO_CustomField
::isSerialized($customDAO) ? CRM_Report_Form
::OP_MULTISELECT_SEPARATOR
: CRM_Report_Form
::OP_MULTISELECT
;
4006 $curFilters[$fieldName]['options'] = $options;
4010 case 'ContactReference':
4011 $curFilters[$fieldName]['type'] = CRM_Utils_Type
::T_STRING
;
4012 $curFilters[$fieldName]['name'] = 'display_name';
4013 $curFilters[$fieldName]['alias'] = "contact_{$fieldName}_civireport";
4015 $curFields[$fieldName]['type'] = CRM_Utils_Type
::T_STRING
;
4016 $curFields[$fieldName]['name'] = 'display_name';
4017 $curFields[$fieldName]['alias'] = "contact_{$fieldName}_civireport";
4021 $curFields[$fieldName]['type'] = CRM_Utils_Type
::T_STRING
;
4022 $curFilters[$fieldName]['type'] = CRM_Utils_Type
::T_STRING
;
4026 if ($customDAO->html_type
== 'Select' && !array_key_exists('options', $curFilters[$fieldName])) {
4027 $options = CRM_Core_PseudoConstant
::get('CRM_Core_BAO_CustomField', 'custom_' . $customDAO->cf_id
, [], 'search');
4028 if ($options !== FALSE) {
4029 $curFilters[$fieldName]['operatorType'] = CRM_Core_BAO_CustomField
::isSerialized($customDAO) ? CRM_Report_Form
::OP_MULTISELECT_SEPARATOR
: CRM_Report_Form
::OP_MULTISELECT
;
4030 $curFilters[$fieldName]['options'] = $options;
4034 if (!array_key_exists('type', $curFields[$fieldName])) {
4035 $curFields[$fieldName]['type'] = CRM_Utils_Array
::value('type', $curFilters[$fieldName], []);
4039 $this->_columns
[$curTable]['fields'] = array_merge($this->_columns
[$curTable]['fields'], $curFields);
4041 if ($this->_customGroupFilters
) {
4042 $this->_columns
[$curTable]['filters'] = array_merge($this->_columns
[$curTable]['filters'], $curFilters);
4044 if ($this->_customGroupGroupBy
) {
4045 $this->_columns
[$curTable]['group_bys'] = array_merge($this->_columns
[$curTable]['group_bys'], $curFields);
4051 * Build custom data from clause.
4053 * @param bool $joinsForFiltersOnly
4054 * Only include joins to support filters. This would be used if creating a table of contacts to include first.
4056 public function customDataFrom($joinsForFiltersOnly = FALSE) {
4057 if (empty($this->_customGroupExtends
)) {
4060 $mapper = CRM_Core_BAO_CustomQuery
::$extendsMap;
4061 //CRM-18276 GROUP_CONCAT could be used with singleValueQuery and then exploded,
4062 //but by default that truncates to 1024 characters, which causes errors with installs with lots of custom field sets
4064 $customTablesDAO = CRM_Core_DAO
::executeQuery("SELECT table_name FROM civicrm_custom_group");
4065 while ($customTablesDAO->fetch()) {
4066 $customTables[] = $customTablesDAO->table_name
;
4069 foreach ($this->_columns
as $table => $prop) {
4070 if (in_array($table, $customTables)) {
4071 $extendsTable = $mapper[$prop['extends']];
4072 // Check field is required for rendering the report.
4073 if ((!$this->isFieldSelected($prop)) ||
($joinsForFiltersOnly && !$this->isFieldFiltered($prop))) {
4076 $baseJoin = CRM_Utils_Array
::value($prop['extends'], $this->_customGroupExtendsJoin
, "{$this->_aliases[$extendsTable]}.id");
4078 $customJoin = is_array($this->_customGroupJoin
) ?
$this->_customGroupJoin
[$table] : $this->_customGroupJoin
;
4080 {$customJoin} {$table} {$this->_aliases[$table]} ON {$this->_aliases[$table]}.entity_id = {$baseJoin}";
4081 // handle for ContactReference
4082 if (array_key_exists('fields', $prop)) {
4083 foreach ($prop['fields'] as $fieldName => $field) {
4084 if (CRM_Utils_Array
::value('dataType', $field) ==
4087 $columnName = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_CustomField', CRM_Core_BAO_CustomField
::getKeyID($fieldName), 'column_name');
4089 LEFT JOIN civicrm_contact {$field['alias']} ON {$field['alias']}.id = {$this->_aliases[$table]}.{$columnName} ";
4098 * Check if the field is selected.
4100 * @param string $prop
4104 public function isFieldSelected($prop) {
4109 if (!empty($this->_params
['fields'])) {
4110 foreach (array_keys($prop['fields']) as $fieldAlias) {
4111 $customFieldId = CRM_Core_BAO_CustomField
::getKeyID($fieldAlias);
4112 if ($customFieldId) {
4113 if (array_key_exists($fieldAlias, $this->_params
['fields'])) {
4117 //might be survey response field.
4118 if (!empty($this->_params
['fields']['survey_response']) &&
4119 !empty($prop['fields'][$fieldAlias]['isSurveyResponseField'])
4127 if (!empty($this->_params
['group_bys']) && $this->_customGroupGroupBy
) {
4128 foreach (array_keys($prop['group_bys']) as $fieldAlias) {
4129 if (array_key_exists($fieldAlias, $this->_params
['group_bys']) &&
4130 CRM_Core_BAO_CustomField
::getKeyID($fieldAlias)
4137 if (!empty($this->_params
['order_bys'])) {
4138 foreach (array_keys($prop['fields']) as $fieldAlias) {
4139 foreach ($this->_params
['order_bys'] as $orderBy) {
4140 if ($fieldAlias == $orderBy['column'] &&
4141 CRM_Core_BAO_CustomField
::getKeyID($fieldAlias)
4148 return $this->isFieldFiltered($prop);
4153 * Check if the field is used as a filter.
4155 * @param string $prop
4159 protected function isFieldFiltered($prop) {
4160 if (!empty($prop['filters']) && $this->_customGroupFilters
) {
4161 foreach ($prop['filters'] as $fieldAlias => $val) {
4170 if (isset($this->_params
[$fieldAlias . '_' . $attach]) &&
4171 (!empty($this->_params
[$fieldAlias . '_' . $attach])
4172 ||
($attach != 'relative' &&
4173 $this->_params
[$fieldAlias . '_' . $attach] == '0')
4179 if (!empty($this->_params
[$fieldAlias . '_op']) &&
4180 in_array($this->_params
[$fieldAlias . '_op'], ['nll', 'nnll'])
4191 * Check for empty order_by configurations and remove them.
4193 * Also set template to hide them.
4195 * @param array $formValues
4197 public function preProcessOrderBy(&$formValues) {
4198 // Object to show/hide form elements
4199 $_showHide = new CRM_Core_ShowHideBlocks('', '');
4201 $_showHide->addShow('optionField_1');
4203 // Cycle through order_by options; skip any empty ones, and hide them as well
4206 if (!empty($formValues['order_bys'])) {
4207 foreach ($formValues['order_bys'] as $order_by) {
4208 if ($order_by['column'] && $order_by['column'] != '-') {
4209 $_showHide->addShow('optionField_' . $n);
4210 $orderBys[$n] = $order_by;
4215 for ($i = $n; $i <= 5; $i++
) {
4217 $_showHide->addHide('optionField_' . $i);
4221 // overwrite order_by options with modified values
4222 if (!empty($orderBys)) {
4223 $formValues['order_bys'] = $orderBys;
4226 $formValues['order_bys'] = [1 => ['column' => '-']];
4229 // assign show/hide data to template
4230 $_showHide->addToTemplate();
4234 * Check if table name has columns in SELECT clause.
4236 * @param string $tableName
4237 * Name of table (index of $this->_columns array).
4241 public function isTableSelected($tableName) {
4242 return in_array($tableName, $this->selectedTables());
4246 * Check if table name has columns in WHERE or HAVING clause.
4248 * @param string $tableName
4249 * Name of table (index of $this->_columns array).
4253 public function isTableFiltered($tableName) {
4254 // Cause the array to be generated if not previously done.
4255 if (!$this->_selectedTables
&& !$this->filteredTables
) {
4256 $this->selectedTables();
4258 return in_array($tableName, $this->filteredTables
);
4262 * Fetch array of DAO tables having columns included in SELECT or ORDER BY clause.
4264 * If the array is unset it will be built.
4269 public function selectedTables() {
4270 if (!$this->_selectedTables
) {
4271 $orderByColumns = [];
4272 if (array_key_exists('order_bys', $this->_params
) &&
4273 is_array($this->_params
['order_bys'])
4275 foreach ($this->_params
['order_bys'] as $orderBy) {
4276 $orderByColumns[] = $orderBy['column'];
4280 foreach ($this->_columns
as $tableName => $table) {
4281 if (array_key_exists('fields', $table)) {
4282 foreach ($table['fields'] as $fieldName => $field) {
4283 if (!empty($field['required']) ||
4284 !empty($this->_params
['fields'][$fieldName])
4286 $this->_selectedTables
[] = $tableName;
4291 if (array_key_exists('order_bys', $table)) {
4292 foreach ($table['order_bys'] as $orderByName => $orderBy) {
4293 if (in_array($orderByName, $orderByColumns)) {
4294 $this->_selectedTables
[] = $tableName;
4299 if (array_key_exists('filters', $table)) {
4300 foreach ($table['filters'] as $filterName => $filter) {
4301 $filterOp = $this->_params
["{$filterName}_op"] ??
'';
4302 if ((isset($this->_params
["{$filterName}_value"])
4303 && !CRM_Utils_System
::isNull($this->_params
["{$filterName}_value"]))
4304 ||
!empty($this->_params
["{$filterName}_relative"])
4305 ||
$filterOp === 'nll'
4306 ||
$filterOp === 'nnll'
4308 $this->_selectedTables
[] = $tableName;
4309 $this->filteredTables
[] = $tableName;
4316 return $this->_selectedTables
;
4320 * Add campaign fields.
4321 * @param string $entityTable
4322 * @param bool $groupBy
4323 * Add GroupBy? Not appropriate for detail report.
4324 * @param bool $orderBy
4325 * Add OrderBy? Not appropriate for detail report.
4326 * @param bool $filters
4329 public function addCampaignFields($entityTable = 'civicrm_contribution', $groupBy = FALSE, $orderBy = FALSE, $filters = TRUE) {
4330 // Check if CiviCampaign is a) enabled and b) has active campaigns
4331 $config = CRM_Core_Config
::singleton();
4332 $campaignEnabled = in_array('CiviCampaign', $config->enableComponents
);
4333 if ($campaignEnabled) {
4334 $getCampaigns = CRM_Campaign_BAO_Campaign
::getPermissionedCampaigns(NULL, NULL, FALSE, FALSE, TRUE);
4335 // If we have a campaign, build out the relevant elements
4336 if (!empty($getCampaigns['campaigns'])) {
4337 $this->campaigns
= $getCampaigns['campaigns'];
4338 asort($this->campaigns
);
4339 $this->_columns
[$entityTable]['fields']['campaign_id'] = ['title' => ts('Campaign'), 'default' => 'false'];
4341 $this->_columns
[$entityTable]['filters']['campaign_id'] = [
4342 'title' => ts('Campaign'),
4343 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
4344 'options' => $this->campaigns
,
4345 'type' => CRM_Utils_Type
::T_INT
,
4350 $this->_columns
[$entityTable]['group_bys']['campaign_id'] = ['title' => ts('Campaign')];
4354 $this->_columns
[$entityTable]['order_bys']['campaign_id'] = ['title' => ts('Campaign')];
4361 * Add address fields.
4363 * @deprecated - use getAddressColumns which is a more accurate description
4364 * and also accepts an array of options rather than a long list
4366 * adding address fields to construct function in reports
4368 * @param bool $groupBy
4369 * Add GroupBy? Not appropriate for detail report.
4370 * @param bool $orderBy
4371 * Add GroupBy? Not appropriate for detail report.
4372 * @param bool $filters
4373 * @param array $defaults
4376 * address fields for construct clause
4378 public function addAddressFields($groupBy = TRUE, $orderBy = FALSE, $filters = TRUE, $defaults = ['country_id' => TRUE]) {
4379 $defaultAddressFields = [
4380 'street_address' => ts('Street Address'),
4381 'supplemental_address_1' => ts('Supplementary Address Field 1'),
4382 'supplemental_address_2' => ts('Supplementary Address Field 2'),
4383 'supplemental_address_3' => ts('Supplementary Address Field 3'),
4384 'street_number' => ts('Street Number'),
4385 'street_name' => ts('Street Name'),
4386 'street_unit' => ts('Street Unit'),
4387 'city' => ts('City'),
4388 'postal_code' => ts('Postal Code'),
4389 'postal_code_suffix' => ts('Postal Code Suffix'),
4390 'country_id' => ts('Country'),
4391 'state_province_id' => ts('State/Province'),
4392 'county_id' => ts('County'),
4395 'civicrm_address' => [
4396 'dao' => 'CRM_Core_DAO_Address',
4399 'title' => ts('Address Name'),
4400 'default' => $defaults['name'] ??
FALSE,
4404 'grouping' => 'location-fields',
4407 foreach ($defaultAddressFields as $fieldName => $fieldLabel) {
4408 $addressFields['civicrm_address']['fields'][$fieldName] = [
4409 'title' => $fieldLabel,
4410 'default' => $defaults[$fieldName] ??
FALSE,
4414 $street_address_filters = $general_address_filters = [];
4416 // Address filter depends on whether street address parsing is enabled.
4418 $addressOptions = CRM_Core_BAO_Setting
::valueOptions(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
4421 if ($addressOptions['street_address_parsing']) {
4422 $street_address_filters = [
4423 'street_number' => [
4424 'title' => ts('Street Number'),
4425 'type' => CRM_Utils_Type
::T_INT
,
4426 'name' => 'street_number',
4429 'title' => ts('Street Name'),
4430 'name' => 'street_name',
4431 'type' => CRM_Utils_Type
::T_STRING
,
4436 $street_address_filters = [
4437 'street_address' => [
4438 'title' => ts('Street Address'),
4439 'type' => CRM_Utils_Type
::T_STRING
,
4440 'name' => 'street_address',
4444 $general_address_filters = [
4446 'title' => ts('Postal Code'),
4447 'type' => CRM_Utils_Type
::T_STRING
,
4448 'name' => 'postal_code',
4451 'title' => ts('City'),
4452 'type' => CRM_Utils_Type
::T_STRING
,
4456 'name' => 'country_id',
4457 'title' => ts('Country'),
4458 'type' => CRM_Utils_Type
::T_INT
,
4459 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
4460 'options' => CRM_Core_PseudoConstant
::country(),
4462 'state_province_id' => [
4463 'name' => 'state_province_id',
4464 'title' => ts('State/Province'),
4465 'type' => CRM_Utils_Type
::T_INT
,
4466 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
4470 'name' => 'county_id',
4471 'title' => ts('County'),
4472 'type' => CRM_Utils_Type
::T_INT
,
4473 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
4478 $addressFields['civicrm_address']['filters'] = array_merge(
4479 $street_address_filters,
4480 $general_address_filters);
4483 $addressFields['civicrm_address']['order_bys'] = [
4484 'street_name' => ['title' => ts('Street Name')],
4485 'street_number' => ['title' => ts('Odd / Even Street Number')],
4486 'street_address' => NULL,
4488 'postal_code' => NULL,
4493 $addressFields['civicrm_address']['group_bys'] = [
4494 'street_address' => NULL,
4496 'postal_code' => NULL,
4497 'state_province_id' => [
4498 'title' => ts('State/Province'),
4501 'title' => ts('Country'),
4504 'title' => ts('County'),
4508 return $addressFields;
4512 * Do AlterDisplay processing on Address Fields.
4513 * If there are multiple address field values then
4514 * on basis of provided separator the code values are translated into respective labels
4517 * @param array $rows
4518 * @param int $rowNum
4519 * @param string $baseUrl
4520 * @param string $linkText
4521 * @param string $separator
4525 public function alterDisplayAddressFields(&$row, &$rows, &$rowNum, $baseUrl, $linkText, $separator = ',') {
4526 $criteriaQueryParams = CRM_Report_Utils_Report
::getPreviewCriteriaQueryParams($this->_defaults
, $this->_params
);
4527 $entryFound = FALSE;
4529 'civicrm_address_country_id' => 'country',
4530 'civicrm_address_county_id' => 'county',
4531 'civicrm_address_state_province_id' => 'stateProvince',
4533 foreach ($columnMap as $fieldName => $fnName) {
4534 if (array_key_exists($fieldName, $row)) {
4535 if ($values = $row[$fieldName]) {
4536 $values = (array) explode($separator, $values);
4537 $rows[$rowNum][$fieldName] = [];
4538 $addressField = $fnName == 'stateProvince' ?
'state' : $fnName;
4539 foreach ($values as $value) {
4540 $rows[$rowNum][$fieldName][] = CRM_Core_PseudoConstant
::$fnName($value);
4542 $rows[$rowNum][$fieldName] = implode($separator, $rows[$rowNum][$fieldName]);
4544 $url = CRM_Report_Utils_Report
::getNextUrl($baseUrl,
4545 sprintf("reset=1&force=1&%s&%s_op=in&%s_value=%s",
4546 $criteriaQueryParams,
4547 str_replace('civicrm_address_', '', $fieldName),
4548 str_replace('civicrm_address_', '', $fieldName),
4549 implode(',', $values)
4550 ), $this->_absoluteUrl
, $this->_id
4552 $rows[$rowNum]["{$fieldName}_link"] = $url;
4553 $rows[$rowNum]["{$fieldName}_hover"] = ts("%1 for this %2.", [1 => $linkText, 2 => $addressField]);
4564 * Do AlterDisplay processing on Address Fields.
4567 * @param array $rows
4568 * @param int $rowNum
4569 * @param string $baseUrl
4570 * @param string $linkText
4574 public function alterDisplayContactFields(&$row, &$rows, &$rowNum, $baseUrl, $linkText) {
4575 $entryFound = FALSE;
4576 // There is no reason not to add links for all fields but it seems a bit odd to be able to click on
4577 // 'Mrs'. Also, we don't have metadata about the title. So, add selectively to addLinks.
4578 $addLinks = ['gender_id' => 'Gender'];
4579 foreach (['prefix_id', 'suffix_id', 'gender_id', 'contact_sub_type', 'preferred_language'] as $fieldName) {
4580 if (array_key_exists('civicrm_contact_' . $fieldName, $row)) {
4581 if (($value = $row['civicrm_contact_' . $fieldName]) != FALSE) {
4582 $rowValues = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $value);
4584 foreach ($rowValues as $rowValue) {
4586 $rowLabels[] = CRM_Core_PseudoConstant
::getLabel('CRM_Contact_BAO_Contact', $fieldName, $rowValue);
4589 $rows[$rowNum]['civicrm_contact_' . $fieldName] = implode(', ', $rowLabels);
4590 if ($baseUrl && ($title = CRM_Utils_Array
::value($fieldName, $addLinks)) != FALSE) {
4591 $this->addLinkToRow($rows[$rowNum], $baseUrl, $linkText, $value, $fieldName, 'civicrm_contact', $title);
4598 'do_not_email', 'is_deceased', 'do_not_phone', 'do_not_sms', 'do_not_mail', 'is_opt_out',
4600 foreach ($yesNoFields as $fieldName) {
4601 if (array_key_exists('civicrm_contact_' . $fieldName, $row)) {
4602 // Since these are essentially 'negative fields' it feels like it
4603 // makes sense to only highlight the exceptions hence no 'No'.
4604 $rows[$rowNum]['civicrm_contact_' . $fieldName] = !empty($rows[$rowNum]['civicrm_contact_' . $fieldName]) ?
ts('Yes') : '';
4609 // Handle employer id
4610 if (array_key_exists('civicrm_contact_employer_id', $row)) {
4611 $employerId = $row['civicrm_contact_employer_id'];
4613 $rows[$rowNum]['civicrm_contact_employer_id'] = CRM_Contact_BAO_Contact
::displayName($employerId);
4614 $rows[$rowNum]['civicrm_contact_employer_id_link'] = CRM_Utils_System
::url('civicrm/contact/view', 'reset=1&cid=' . $employerId, $this->_absoluteUrl
);
4615 $rows[$rowNum]['civicrm_contact_employer_id_hover'] = ts('View Contact Summary for Employer.');
4624 * Adjusts dates passed in to YEAR() for fiscal year.
4626 * @param string $fieldName
4630 public function fiscalYearOffset($fieldName) {
4631 $config = CRM_Core_Config
::singleton();
4632 $fy = $config->fiscalYearStart
;
4633 if (CRM_Utils_Array
::value('yid_op', $this->_params
) == 'calendar' ||
4634 ($fy['d'] == 1 && $fy['M'] == 1)
4636 return "YEAR( $fieldName )";
4638 return "YEAR( $fieldName - INTERVAL " . ($fy['M'] - 1) . " MONTH" .
4639 ($fy['d'] > 1 ?
(" - INTERVAL " . ($fy['d'] - 1) . " DAY") : '') . " )";
4643 * Add Address into From Table if required.
4645 * Prefix will be added to both tables as
4646 * it is assumed you are using it to get address of a secondary contact.
4648 * @param string $prefix
4649 * @param array $extra Additional options.
4650 * Not currently used in core but may be used in override extensions.
4652 protected function joinAddressFromContact($prefix = '', $extra = []) {
4653 $defaults = ['primary_only' => TRUE];
4654 $params = array_merge($defaults, $extra);
4655 $addressTables = ['civicrm_address', 'civicrm_country', 'civicrm_worldregion', 'civicrm_state_province'];
4656 $isJoinRequired = $this->_addressField
;
4657 foreach ($addressTables as $addressTable) {
4658 if ($this->isTableSelected($prefix . $addressTable)) {
4659 $isJoinRequired = TRUE;
4662 if ($isJoinRequired) {
4664 LEFT JOIN civicrm_address {$this->_aliases[$prefix . 'civicrm_address']}
4665 ON ({$this->_aliases[$prefix . 'civicrm_contact']}.id =
4666 {$this->_aliases[$prefix . 'civicrm_address']}.contact_id)";
4667 if ($params['primary_only']) {
4669 {$this->_aliases[$prefix . 'civicrm_address']}.is_primary = 1\n";
4671 $this->_from
.= $fromJoin;
4676 * Add Country into From Table if required.
4678 * Prefix will be added to both tables as
4679 * it is assumed you are using it to get address of a secondary contact.
4681 * @param string $prefix
4682 * @param array $extra Additional options.
4683 * Not currently used in core but may be used in override extensions.
4685 protected function joinCountryFromAddress($prefix = '', $extra = []) {
4686 $defaults = ['primary_only' => TRUE];
4687 $params = array_merge($defaults, $extra);
4688 // include country field if country column is to be included
4689 if ($this->isTableSelected($prefix . 'civicrm_country') ||
$this->isTableSelected($prefix . 'civicrm_worldregion')) {
4690 if (empty($this->_aliases
[$prefix . 'civicrm_country'])) {
4691 $this->_aliases
[$prefix . 'civicrm_country'] = $prefix . '_report_country';
4694 LEFT JOIN civicrm_country {$this->_aliases[$prefix . 'civicrm_country']}
4695 ON {$this->_aliases[$prefix . 'civicrm_address']}.country_id = {$this->_aliases[$prefix . 'civicrm_country']}.id";
4696 if ($params['primary_only']) {
4698 {$this->_aliases[$prefix . 'civicrm_address']}.is_primary = 1 ";
4700 $this->_from
.= $fromJoin;
4705 * Add Phone into From Table if required.
4707 * Prefix will be added to both tables as
4708 * it is assumed you are using it to get address of a secondary contact.
4710 * @param string $prefix
4711 * @param array $extra Additional options.
4712 * Not currently used in core but may be used in override extensions.
4714 protected function joinPhoneFromContact($prefix = '', $extra = []) {
4715 $defaults = ['primary_only' => TRUE];
4716 $params = array_merge($defaults, $extra);
4717 // include phone field if phone column is to be included
4718 if ($this->isTableSelected($prefix . 'civicrm_phone')) {
4720 LEFT JOIN civicrm_phone {$this->_aliases[$prefix . 'civicrm_phone']}
4721 ON {$this->_aliases[$prefix . 'civicrm_contact']}.id = {$this->_aliases[$prefix . 'civicrm_phone']}.contact_id";
4722 if ($params['primary_only']) {
4724 {$this->_aliases[$prefix . 'civicrm_phone']}.is_primary = 1\n";
4726 $this->_from
.= $fromJoin;
4731 * Add Email into From Table if required.
4733 * Prefix will be added to both tables as
4734 * it is assumed you are using it to get address of a secondary contact.
4736 * @param string $prefix
4737 * @param array $extra Additional options.
4738 * Not currently used in core but may be used in override extensions.
4740 protected function joinEmailFromContact($prefix = '', $extra = []) {
4741 $defaults = ['primary_only' => TRUE];
4742 $params = array_merge($defaults, $extra);
4743 // include email field if email column is to be included
4744 if ($this->isTableSelected($prefix . 'civicrm_email')) {
4746 LEFT JOIN civicrm_email {$this->_aliases[$prefix . 'civicrm_email']}
4747 ON {$this->_aliases[$prefix . 'civicrm_contact']}.id = {$this->_aliases[$prefix . 'civicrm_email']}.contact_id";
4748 if ($params['primary_only']) {
4750 {$this->_aliases[$prefix . 'civicrm_email']}.is_primary = 1 ";
4752 $this->_from
.= $fromJoin;
4757 * Add Financial Transaction into From Table if required.
4759 public function addFinancialTrxnFromClause() {
4760 if ($this->isTableSelected('civicrm_financial_trxn')) {
4762 LEFT JOIN civicrm_entity_financial_trxn eftcc
4763 ON ({$this->_aliases['civicrm_contribution']}.id = eftcc.entity_id AND
4764 eftcc.entity_table = 'civicrm_contribution')
4765 LEFT JOIN civicrm_financial_trxn {$this->_aliases['civicrm_financial_trxn']}
4766 ON {$this->_aliases['civicrm_financial_trxn']}.id = eftcc.financial_trxn_id \n";
4771 * Get phone columns to add to array.
4773 * @param array $options
4774 * - prefix Prefix to add to table (in case of more than one instance of the table)
4775 * - prefix_label Label to give columns from this phone table instance
4778 * phone columns definition
4780 public function getPhoneColumns($options = []) {
4783 'prefix_label' => '',
4786 $options = array_merge($defaultOptions, $options);
4789 $options['prefix'] . 'civicrm_phone' => [
4790 'dao' => 'CRM_Core_DAO_Phone',
4792 $options['prefix'] . 'phone' => [
4793 'title' => $options['prefix_label'] . ts('Phone'),
4803 * Get a standard set of contact fields.
4804 * @deprecated - use getColumns('Contact') instead
4807 public function getBasicContactFields() {
4810 'title' => ts('Contact Name'),
4815 'no_display' => TRUE,
4819 'title' => ts('Contact Prefix'),
4822 'title' => ts('First Name'),
4825 'title' => ts('Nick Name'),
4828 'title' => ts('Middle Name'),
4831 'title' => ts('Last Name'),
4834 'title' => ts('Contact Suffix'),
4836 'postal_greeting_display' => ['title' => ts('Postal Greeting')],
4837 'email_greeting_display' => ['title' => ts('Email Greeting')],
4838 'addressee_display' => ['title' => ts('Addressee')],
4840 'title' => ts('Contact Type'),
4842 'contact_sub_type' => [
4843 'title' => ts('Contact Subtype'),
4846 'title' => ts('Gender'),
4849 'title' => ts('Birth Date'),
4852 'title' => ts('Age'),
4853 'dbAlias' => 'TIMESTAMPDIFF(YEAR, contact_civireport.birth_date, CURDATE())',
4856 'title' => ts('Contact Job title'),
4858 'organization_name' => [
4859 'title' => ts('Organization Name'),
4861 'external_identifier' => [
4862 'title' => ts('Contact identifier from external system'),
4864 'do_not_email' => [],
4865 'do_not_phone' => [],
4866 'do_not_mail' => [],
4869 'is_deceased' => [],
4870 'preferred_language' => [],
4872 'title' => ts('Current Employer'),
4878 * Get a standard set of contact filters.
4880 * @param array $defaults
4884 public function getBasicContactFilters($defaults = []) {
4887 'title' => ts('Contact Name'),
4890 'title' => ts('Contact Source'),
4891 'type' => CRM_Utils_Type
::T_STRING
,
4894 'title' => ts('Contact ID'),
4895 'no_display' => TRUE,
4898 'title' => ts('Gender'),
4899 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
4900 'options' => CRM_Core_PseudoConstant
::get('CRM_Contact_DAO_Contact', 'gender_id'),
4903 'title' => ts('Birth Date'),
4904 'operatorType' => CRM_Report_Form
::OP_DATE
,
4907 'title' => ts('Contact Type'),
4909 'contact_sub_type' => [
4910 'title' => ts('Contact Subtype'),
4912 'modified_date' => [
4913 'title' => ts('Contact Modified'),
4914 'operatorType' => CRM_Report_Form
::OP_DATE
,
4915 'type' => CRM_Utils_Type
::T_DATE
,
4918 'title' => ts('Deceased'),
4919 'type' => CRM_Utils_Type
::T_BOOLEAN
,
4920 'default' => CRM_Utils_Array
::value('deceased', $defaults, 0),
4923 'title' => ts('Do not email'),
4924 'type' => CRM_Utils_Type
::T_BOOLEAN
,
4927 'title' => ts('Do not phone'),
4928 'type' => CRM_Utils_Type
::T_BOOLEAN
,
4931 'title' => ts('Do not mail'),
4932 'type' => CRM_Utils_Type
::T_BOOLEAN
,
4935 'title' => ts('Do not SMS'),
4936 'type' => CRM_Utils_Type
::T_BOOLEAN
,
4939 'title' => ts('Do not bulk email'),
4940 'type' => CRM_Utils_Type
::T_BOOLEAN
,
4942 'preferred_language' => [
4943 'title' => ts('Preferred Language'),
4946 'no_display' => TRUE,
4948 'type' => CRM_Utils_Type
::T_BOOLEAN
,
4954 * Add contact to group.
4956 * @param int $groupID
4958 public function add2group($groupID) {
4959 if (is_numeric($groupID) && isset($this->_aliases
['civicrm_contact'])) {
4960 $select = "SELECT DISTINCT {$this->_aliases['civicrm_contact']}.id AS addtogroup_contact_id, ";
4961 $select = preg_replace('/SELECT(\s+SQL_CALC_FOUND_ROWS)?\s+/i', $select, $this->_select
);
4962 $sql = "{$select} {$this->_from} {$this->_where} {$this->_groupBy} {$this->_having} {$this->_orderBy}";
4963 $sql = str_replace('WITH ROLLUP', '', $sql);
4964 $dao = CRM_Core_DAO
::executeQuery($sql);
4967 // Add resulting contacts to group
4968 while ($dao->fetch()) {
4969 if ($dao->addtogroup_contact_id
) {
4970 $contact_ids[$dao->addtogroup_contact_id
] = $dao->addtogroup_contact_id
;
4974 if (!empty($contact_ids)) {
4975 CRM_Contact_BAO_GroupContact
::addContactsToGroup($contact_ids, $groupID);
4976 CRM_Core_Session
::setStatus(ts("Listed contact(s) have been added to the selected group."), ts('Contacts Added'), 'success');
4979 CRM_Core_Session
::setStatus(ts("The listed records(s) cannot be added to the group."));
4985 * Apply common settings to entityRef fields.
4987 * @param array $field
4988 * @param string $table
4990 public function setEntityRefDefaults(&$field, $table) {
4991 $field['attributes'] = $field['attributes'] ?
$field['attributes'] : [];
4992 $field['attributes'] +
= [
4993 'entity' => CRM_Core_DAO_AllCoreTables
::getBriefName(CRM_Core_DAO_AllCoreTables
::getClassForTable($table)),
4995 'placeholder' => ts('- select -'),
5000 * Add link fields to the row.
5002 * Function adds the _link & _hover fields to the row.
5005 * @param string $baseUrl
5006 * @param string $linkText
5007 * @param string $value
5008 * @param string $fieldName
5009 * @param string $tablePrefix
5010 * @param string $fieldLabel
5014 protected function addLinkToRow(&$row, $baseUrl, $linkText, $value, $fieldName, $tablePrefix, $fieldLabel) {
5015 $criteriaQueryParams = CRM_Report_Utils_Report
::getPreviewCriteriaQueryParams($this->_defaults
, $this->_params
);
5016 $url = CRM_Report_Utils_Report
::getNextUrl($baseUrl,
5017 "reset=1&force=1&{$criteriaQueryParams}&" .
5018 $fieldName . "_op=in&{$fieldName}_value={$value}",
5019 $this->_absoluteUrl
, $this->_id
5021 $row["{$tablePrefix}_{$fieldName}_link"] = $url;
5022 $row["{$tablePrefix}_{$fieldName}_hover"] = ts("%1 for this %2.",
5023 [1 => $linkText, 2 => $fieldLabel]
5028 * Get label for show results buttons.
5032 public function getResultsLabel() {
5033 $showResultsLabel = $this->resultsDisplayed() ?
ts('Refresh results') : ts('View results');
5034 return $showResultsLabel;
5038 * Determine the output mode from the url or input.
5041 * - pdf : Render as pdf
5042 * - csv : Render as csv
5043 * - print : Render in print format
5044 * - save : save the report and display the new report
5045 * - copy : save the report as a new instance and display that.
5046 * - group : go to the add to group screen.
5048 * Potentially chart variations could also be included but the complexity
5049 * is that we might print a bar chart as a pdf.
5051 protected function setOutputMode() {
5052 $this->_outputMode
= str_replace('report_instance.', '', CRM_Utils_Request
::retrieve(
5055 CRM_Core_DAO
::$_nullObject,
5057 CRM_Utils_Array
::value('task', $this->_params
)
5059 // if contacts are added to group
5060 if (!empty($this->_params
['groups']) && empty($this->_outputMode
)) {
5061 $this->_outputMode
= 'group';
5063 if (isset($this->_params
['task'])) {
5064 unset($this->_params
['task']);
5069 * CRM-17793 - Alter DateTime section header to group by date from the datetime field.
5072 * @param $columnName
5074 public function alterSectionHeaderForDateTime($tempTable, $columnName) {
5075 // add new column with date value for the datetime field
5076 $tempQuery = "ALTER TABLE {$tempTable} ADD COLUMN {$columnName}_date VARCHAR(128)";
5077 CRM_Core_DAO
::executeQuery($tempQuery);
5078 $updateQuery = "UPDATE {$tempTable} SET {$columnName}_date = date({$columnName})";
5079 CRM_Core_DAO
::executeQuery($updateQuery);
5080 $this->_selectClauses
[] = "{$columnName}_date";
5081 $this->_select
.= ", {$columnName}_date";
5082 $this->_sections
["{$columnName}_date"] = $this->_sections
["{$columnName}"];
5083 unset($this->_sections
["{$columnName}"]);
5084 $this->assign('sections', $this->_sections
);
5088 * Get an array of the columns that have been selected for display.
5092 public function getSelectColumns() {
5093 $selectColumns = [];
5094 foreach ($this->_columns
as $tableName => $table) {
5095 if (array_key_exists('fields', $table)) {
5096 foreach ($table['fields'] as $fieldName => $field) {
5097 if (!empty($field['required']) ||
5098 !empty($this->_params
['fields'][$fieldName])
5101 $selectColumns["{$tableName}_{$fieldName}"] = 1;
5106 return $selectColumns;
5110 * Add location tables to the query if they are used for filtering.
5112 * This is for when we are running the query separately for filtering and retrieving display fields.
5114 public function selectivelyAddLocationTablesJoinsToFilterQuery() {
5115 if ($this->isTableFiltered('civicrm_email')) {
5117 LEFT JOIN civicrm_email {$this->_aliases['civicrm_email']}
5118 ON {$this->_aliases['civicrm_contact']}.id = {$this->_aliases['civicrm_email']}.contact_id
5119 AND {$this->_aliases['civicrm_email']}.is_primary = 1";
5121 if ($this->isTableFiltered('civicrm_phone')) {
5123 LEFT JOIN civicrm_phone {$this->_aliases['civicrm_phone']}
5124 ON {$this->_aliases['civicrm_contact']}.id = {$this->_aliases['civicrm_phone']}.contact_id
5125 AND {$this->_aliases['civicrm_phone']}.is_primary = 1";
5127 if ($this->isTableFiltered('civicrm_address')) {
5129 LEFT JOIN civicrm_address {$this->_aliases['civicrm_address']}
5130 ON ({$this->_aliases['civicrm_contact']}.id = {$this->_aliases['civicrm_address']}.contact_id)
5131 AND {$this->_aliases['civicrm_address']}.is_primary = 1\n";
5136 * Set the base table for the FROM clause.
5138 * Sets up the from clause, allowing for the possibility it might be a
5139 * temp table pre-filtered by groups if a group filter is in use.
5141 * @param string $baseTable
5142 * @param string $field
5143 * @param null $tableAlias
5145 public function setFromBase($baseTable, $field = 'id', $tableAlias = NULL) {
5147 $tableAlias = $this->_aliases
[$baseTable];
5149 $this->_from
= $this->_from
= " FROM $baseTable $tableAlias ";
5150 $this->joinGroupTempTable($baseTable, $field, $tableAlias);
5151 $this->_from
.= " {$this->_aclFrom} ";
5155 * Join the temp table contacting contacts who are members of the filtered groups.
5157 * If we are using an IN filter we use an inner join, otherwise a left join.
5159 * @param string $baseTable
5160 * @param string $field
5161 * @param string $tableAlias
5163 public function joinGroupTempTable($baseTable, $field, $tableAlias) {
5164 if ($this->groupTempTable
) {
5165 if ($this->_params
['gid_op'] == 'in') {
5166 $this->_from
= " FROM $this->groupTempTable group_temp_table INNER JOIN $baseTable $tableAlias
5167 ON group_temp_table.id = $tableAlias.{$field} ";
5171 LEFT JOIN $this->groupTempTable group_temp_table
5172 ON $tableAlias.{$field} = group_temp_table.id ";
5178 * Get all labels for fields that are used in a group concat.
5180 * @param string $options
5181 * comma separated option values.
5182 * @param string $baoName
5183 * The BAO name for the field.
5184 * @param string $fieldName
5185 * The name of the field for which labels should be retrieved.
5189 public function getLabels($options, $baoName, $fieldName) {
5190 $types = explode(',', $options);
5192 foreach ($types as $value) {
5193 $labels[$value] = CRM_Core_PseudoConstant
::getLabel($baoName, $fieldName, $value);
5195 return implode(', ', array_filter($labels));
5199 * Add statistics columns.
5201 * If a group by is in play then add columns for the statistics fields.
5203 * This would lead to a new field in the $row such as $fieldName_sum and a new, matching
5204 * column header field.
5206 * @param array $field
5207 * @param string $tableName
5208 * @param string $fieldName
5209 * @param array $select
5213 protected function addStatisticsToSelect($field, $tableName, $fieldName, $select) {
5214 foreach ($field['statistics'] as $stat => $label) {
5215 $alias = "{$tableName}_{$fieldName}_{$stat}";
5216 switch (strtolower($stat)) {
5219 $select[] = "$stat({$field['dbAlias']}) as $alias";
5220 $this->_columnHeaders
["{$tableName}_{$fieldName}_{$stat}"]['title'] = $label;
5221 $this->_columnHeaders
["{$tableName}_{$fieldName}_{$stat}"]['type'] = $field['type'];
5222 $this->_statFields
[$label] = $alias;
5223 $this->_selectAliases
[] = $alias;
5227 $select[] = "COUNT({$field['dbAlias']}) as $alias";
5228 $this->_columnHeaders
["{$tableName}_{$fieldName}_{$stat}"]['title'] = $label;
5229 $this->_columnHeaders
["{$tableName}_{$fieldName}_{$stat}"]['type'] = CRM_Utils_Type
::T_INT
;
5230 $this->_statFields
[$label] = $alias;
5231 $this->_selectAliases
[] = $alias;
5234 case 'count_distinct':
5235 $select[] = "COUNT(DISTINCT {$field['dbAlias']}) as $alias";
5236 $this->_columnHeaders
["{$tableName}_{$fieldName}_{$stat}"]['title'] = $label;
5237 $this->_columnHeaders
["{$tableName}_{$fieldName}_{$stat}"]['type'] = CRM_Utils_Type
::T_INT
;
5238 $this->_statFields
[$label] = $alias;
5239 $this->_selectAliases
[] = $alias;
5243 $select[] = "ROUND(AVG({$field['dbAlias']}),2) as $alias";
5244 $this->_columnHeaders
["{$tableName}_{$fieldName}_{$stat}"]['title'] = $label;
5245 $this->_columnHeaders
["{$tableName}_{$fieldName}_{$stat}"]['type'] = $field['type'];
5246 $this->_statFields
[$label] = $alias;
5247 $this->_selectAliases
[] = $alias;
5255 * Add a basic field to the select clause.
5257 * @param string $tableName
5258 * @param string $fieldName
5259 * @param array $field
5260 * @param string $select
5263 protected function addBasicFieldToSelect($tableName, $fieldName, $field, $select) {
5264 $alias = "{$tableName}_{$fieldName}";
5265 $select[] = "{$field['dbAlias']} as $alias";
5266 $this->_columnHeaders
["{$tableName}_{$fieldName}"]['title'] = $field['title'] ??
NULL;
5267 $this->_columnHeaders
["{$tableName}_{$fieldName}"]['type'] = $field['type'] ??
NULL;
5268 $this->_selectAliases
[] = $alias;
5275 * @param array $table
5276 * @param string $tableName
5281 protected function setTableAlias($table, $tableName) {
5282 if (!isset($table['alias'])) {
5283 $this->_columns
[$tableName]['alias'] = substr($tableName, 8) .
5287 $this->_columns
[$tableName]['alias'] = $table['alias'] . '_civireport';
5290 $this->_aliases
[$tableName] = $this->_columns
[$tableName]['alias'];
5291 return $this->_aliases
[$tableName];
5295 * Function to add columns to reports.
5297 * This is ported from extended reports, which also adds join filters to the options.
5299 * @param string $type
5300 * @param array $options
5301 * - prefix - A string to prepend to the table name
5302 * - prefix_label A string to prepend to the fields
5303 * - fields (bool) - should the fields for this table be made available
5304 * - group_by (bool) - should the group bys for this table be made available.
5305 * - order_by (bool) - should the group bys for this table be made available.
5306 * - filters (bool) - should the filters for this table by made available.
5307 * - fields_defaults (array) array of fields that should be displayed by default.
5308 * - filters_defaults (array) array of fields that should be filtered by default.
5309 * - join_filters (array) fields available for filtering joins (requires additional custom code).
5310 * - join_fields (array) fields available from join (requires additional custom code).
5311 * - group_by_defaults (array) array of group bys that should be applied by default.
5312 * - order_by_defaults (array) array of order bys that should be applied by default.
5313 * - custom_fields (array) array of entity types for custom fields (not usually required).
5314 * - contact_type (string) optional restriction on contact type for some tables.
5315 * - fields_excluded (array) fields that are in the generic set for the table but not in the report.
5319 protected function getColumns($type, $options = []) {
5322 'prefix_label' => '',
5324 'group_bys' => FALSE,
5325 'order_bys' => TRUE,
5327 'join_filters' => FALSE,
5328 'fields_defaults' => [],
5329 'filters_defaults' => [],
5330 'group_bys_defaults' => [],
5331 'order_bys_defaults' => [],
5333 $options = array_merge($defaultOptions, $options);
5335 $fn = 'get' . $type . 'Columns';
5336 return $this->$fn($options);
5340 * Get columns for contact table.
5342 * @param array $options
5346 protected function getContactColumns($options = []) {
5348 'custom_fields' => ['Individual', 'Contact', 'Organization'],
5349 'fields_defaults' => ['display_name', 'id'],
5350 'order_bys_defaults' => ['sort_name ASC'],
5351 'contact_type' => NULL,
5354 $options = array_merge($defaultOptions, $options);
5356 $tableAlias = $options['prefix'] . 'contact';
5359 $options['prefix'] . 'display_name' => [
5360 'name' => 'display_name',
5361 'title' => $options['prefix_label'] . ts('Contact Name'),
5362 'is_fields' => TRUE,
5364 $options['prefix'] . 'sort_name' => [
5365 'name' => 'sort_name',
5366 'title' => $options['prefix_label'] . ts('Contact Name (in sort format)'),
5367 'is_fields' => TRUE,
5368 'is_filters' => TRUE,
5369 'is_order_bys' => TRUE,
5371 $options['prefix'] . 'id' => [
5373 'title' => $options['prefix_label'] . ts('Contact ID'),
5374 'alter_display' => 'alterContactID',
5375 'type' => CRM_Utils_Type
::T_INT
,
5376 'is_order_bys' => TRUE,
5377 'is_group_bys' => TRUE,
5378 'is_fields' => TRUE,
5379 'is_filters' => TRUE,
5381 $options['prefix'] . 'external_identifier' => [
5382 'name' => 'external_identifier',
5383 'title' => $options['prefix_label'] . ts('External ID'),
5384 'type' => CRM_Utils_Type
::T_INT
,
5385 'is_fields' => TRUE,
5387 $options['prefix'] . 'contact_type' => [
5388 'title' => $options['prefix_label'] . ts('Contact Type'),
5389 'name' => 'contact_type',
5390 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
5391 'options' => CRM_Contact_BAO_Contact
::buildOptions('contact_type'),
5392 'is_fields' => TRUE,
5393 'is_filters' => TRUE,
5394 'is_group_bys' => TRUE,
5396 $options['prefix'] . 'contact_sub_type' => [
5397 'title' => $options['prefix_label'] . ts('Contact Sub Type'),
5398 'name' => 'contact_sub_type',
5399 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
5400 'options' => CRM_Contact_BAO_Contact
::buildOptions('contact_sub_type'),
5401 'is_fields' => TRUE,
5402 'is_filters' => TRUE,
5403 'is_group_bys' => TRUE,
5405 $options['prefix'] . 'is_deleted' => [
5406 'title' => $options['prefix_label'] . ts('Is deleted'),
5407 'name' => 'is_deleted',
5408 'type' => CRM_Utils_Type
::T_BOOLEAN
,
5409 'is_fields' => FALSE,
5410 'is_filters' => TRUE,
5411 'is_group_bys' => FALSE,
5413 $options['prefix'] . 'external_identifier' => [
5414 'title' => $options['prefix_label'] . ts('Contact identifier from external system'),
5415 'name' => 'external_identifier',
5416 'is_fields' => TRUE,
5417 'is_filters' => FALSE,
5418 'is_group_bys' => FALSE,
5419 'is_order_bys' => TRUE,
5421 $options['prefix'] . 'preferred_language' => [
5422 'title' => $options['prefix_label'] . ts('Preferred Language'),
5423 'name' => 'preferred_language',
5424 'is_fields' => TRUE,
5425 'is_filters' => TRUE,
5426 'is_group_bys' => TRUE,
5427 'is_order_bys' => TRUE,
5429 $options['prefix'] . 'preferred_communication_method' => [
5430 'title' => $options['prefix_label'] . ts('Preferred Communication Method'),
5431 'alter_display' => 'alterCommunicationtMethod',
5432 'name' => 'preferred_communication_method',
5433 'is_fields' => TRUE,
5434 'is_filters' => FALSE,
5435 'is_group_bys' => FALSE,
5436 'is_order_bys' => FALSE,
5440 'postal_greeting_display' => 'Postal Greeting',
5441 'email_greeting_display' => 'Email Greeting',
5442 'addressee_display' => 'Addressee',
5443 ] as $field => $title) {
5444 $spec[$options['prefix'] . $field] = [
5445 'title' => $options['prefix_label'] . ts($title),
5447 'is_fields' => TRUE,
5448 'is_filters' => FALSE,
5449 'is_group_bys' => FALSE,
5452 foreach (['do_not_email', 'do_not_phone', 'do_not_mail', 'do_not_sms', 'is_opt_out'] as $field) {
5453 $spec[$options['prefix'] . $field] = [
5455 'type' => CRM_Utils_Type
::T_BOOLEAN
,
5456 'is_fields' => TRUE,
5457 'is_filters' => TRUE,
5458 'is_group_bys' => FALSE,
5461 $individualFields = [
5462 $options['prefix'] . 'first_name' => [
5463 'name' => 'first_name',
5464 'title' => $options['prefix_label'] . ts('First Name'),
5465 'is_fields' => TRUE,
5466 'is_filters' => TRUE,
5467 'is_order_bys' => TRUE,
5469 $options['prefix'] . 'middle_name' => [
5470 'name' => 'middle_name',
5471 'title' => $options['prefix_label'] . ts('Middle Name'),
5472 'is_fields' => TRUE,
5474 $options['prefix'] . 'last_name' => [
5475 'name' => 'last_name',
5476 'title' => $options['prefix_label'] . ts('Last Name'),
5477 'default_order' => 'ASC',
5478 'is_fields' => TRUE,
5480 $options['prefix'] . 'nick_name' => [
5481 'name' => 'nick_name',
5482 'title' => $options['prefix_label'] . ts('Nick Name'),
5483 'is_fields' => TRUE,
5485 $options['prefix'] . 'prefix_id' => [
5486 'name' => 'prefix_id',
5487 'title' => $options['prefix_label'] . ts('Prefix'),
5488 'options' => CRM_Contact_BAO_Contact
::buildOptions('prefix_id'),
5489 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
5490 'is_fields' => TRUE,
5491 'is_filters' => TRUE,
5493 $options['prefix'] . 'suffix_id' => [
5494 'name' => 'suffix_id',
5495 'title' => $options['prefix_label'] . ts('Suffix'),
5496 'options' => CRM_Contact_BAO_Contact
::buildOptions('suffix_id'),
5497 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
5498 'is_fields' => TRUE,
5499 'is_filters' => TRUE,
5501 $options['prefix'] . 'gender_id' => [
5502 'name' => 'gender_id',
5503 'title' => $options['prefix_label'] . ts('Gender'),
5504 'options' => CRM_Contact_BAO_Contact
::buildOptions('gender_id'),
5505 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
5506 'is_fields' => TRUE,
5507 'is_filters' => TRUE,
5510 'title' => $options['prefix_label'] . ts('Birth Date'),
5511 'operatorType' => CRM_Report_Form
::OP_DATE
,
5512 'type' => CRM_Utils_Type
::T_DATE
,
5513 'is_fields' => TRUE,
5514 'is_filters' => TRUE,
5517 'title' => $options['prefix_label'] . ts('Age'),
5518 'dbAlias' => 'TIMESTAMPDIFF(YEAR, ' . $tableAlias . '_civireport.birth_date, CURDATE())',
5519 'type' => CRM_Utils_Type
::T_INT
,
5520 'is_fields' => TRUE,
5522 $options['prefix'] . 'is_deceased' => [
5523 'title' => $options['prefix_label'] . ts('Is deceased'),
5524 'name' => 'is_deceased',
5525 'type' => CRM_Utils_Type
::T_BOOLEAN
,
5526 'is_fields' => FALSE,
5527 'is_filters' => TRUE,
5528 'is_group_bys' => FALSE,
5530 $options['prefix'] . 'job_title' => [
5531 'name' => 'job_title',
5532 'is_fields' => TRUE,
5533 'is_filters' => FALSE,
5534 'is_group_bys' => FALSE,
5536 $options['prefix'] . 'employer_id' => [
5537 'title' => $options['prefix_label'] . ts('Current Employer'),
5538 'type' => CRM_Utils_Type
::T_INT
,
5539 'name' => 'employer_id',
5540 'is_fields' => TRUE,
5541 'is_filters' => FALSE,
5542 'is_group_bys' => TRUE,
5545 if (!$options['contact_type'] ||
$options['contact_type'] === 'Individual') {
5546 $spec = array_merge($spec, $individualFields);
5549 if (!empty($options['custom_fields'])) {
5550 $this->_customGroupExtended
[$options['prefix'] . 'civicrm_contact'] = [
5551 'extends' => $options['custom_fields'],
5552 'title' => $options['prefix_label'],
5553 'filters' => $options['filters'],
5554 'prefix' => $options['prefix'],
5555 'prefix_label' => $options['prefix_label'],
5559 return $this->buildColumns($spec, $options['prefix'] . 'civicrm_contact', 'CRM_Contact_DAO_Contact', $tableAlias, $this->getDefaultsFromOptions($options), $options);
5563 * Get address columns to add to array.
5565 * @param array $options
5566 * - prefix Prefix to add to table (in case of more than one instance of the table)
5567 * - prefix_label Label to give columns from this address table instance
5568 * - group_bys enable these fields for group by - default false
5569 * - order_bys enable these fields for order by
5570 * - filters enable these fields for filtering
5572 * @return array address columns definition
5574 protected function getAddressColumns($options = []) {
5577 'prefix_label' => '',
5579 'group_bys' => FALSE,
5580 'order_bys' => TRUE,
5582 'join_filters' => FALSE,
5583 'fields_defaults' => [],
5584 'filters_defaults' => [],
5585 'group_bys_defaults' => [],
5586 'order_bys_defaults' => [],
5589 $options = array_merge($defaultOptions, $options);
5590 $defaults = $this->getDefaultsFromOptions($options);
5591 $tableAlias = $options['prefix'] . 'address';
5594 $options['prefix'] . 'name' => [
5595 'title' => $options['prefix_label'] . ts('Address Name'),
5597 'is_fields' => TRUE,
5599 $options['prefix'] . 'street_number' => [
5600 'name' => 'street_number',
5601 'title' => $options['prefix_label'] . ts('Street Number'),
5603 'is_fields' => TRUE,
5605 $options['prefix'] . 'odd_street_number' => [
5606 'title' => ts('Odd / Even Street Number'),
5607 'name' => 'odd_street_number',
5608 'type' => CRM_Utils_Type
::T_INT
,
5609 'no_display' => TRUE,
5611 'dbAlias' => "({$tableAlias}_civireport.street_number % 2)",
5612 'is_fields' => TRUE,
5613 'is_order_bys' => TRUE,
5615 $options['prefix'] . 'street_name' => [
5616 'name' => 'street_name',
5617 'title' => $options['prefix_label'] . ts('Street Name'),
5619 'is_fields' => TRUE,
5620 'is_filters' => TRUE,
5621 'operator' => 'like',
5622 'is_order_bys' => TRUE,
5624 $options['prefix'] . 'street_address' => [
5625 'title' => $options['prefix_label'] . ts('Street Address'),
5626 'name' => 'street_address',
5627 'is_fields' => TRUE,
5628 'is_filters' => TRUE,
5629 'is_group_bys' => TRUE,
5631 $options['prefix'] . 'supplemental_address_1' => [
5632 'title' => $options['prefix_label'] . ts('Supplementary Address Field 1'),
5633 'name' => 'supplemental_address_1',
5634 'is_fields' => TRUE,
5636 $options['prefix'] . 'supplemental_address_2' => [
5637 'title' => $options['prefix_label'] . ts('Supplementary Address Field 2'),
5638 'name' => 'supplemental_address_2',
5639 'is_fields' => TRUE,
5641 $options['prefix'] . 'supplemental_address_3' => [
5642 'title' => $options['prefix_label'] . ts('Supplementary Address Field 3'),
5643 'name' => 'supplemental_address_3',
5644 'is_fields' => TRUE,
5646 $options['prefix'] . 'street_number' => [
5647 'name' => 'street_number',
5648 'title' => $options['prefix_label'] . ts('Street Number'),
5650 'is_order_bys' => TRUE,
5651 'is_filters' => TRUE,
5652 'is_fields' => TRUE,
5654 $options['prefix'] . 'street_unit' => [
5655 'name' => 'street_unit',
5656 'title' => $options['prefix_label'] . ts('Street Unit'),
5658 'is_fields' => TRUE,
5660 $options['prefix'] . 'city' => [
5661 'title' => $options['prefix_label'] . ts('City'),
5663 'operator' => 'like',
5664 'is_fields' => TRUE,
5665 'is_filters' => TRUE,
5666 'is_group_bys' => TRUE,
5667 'is_order_bys' => TRUE,
5669 $options['prefix'] . 'postal_code' => [
5670 'title' => $options['prefix_label'] . ts('Postal Code'),
5671 'name' => 'postal_code',
5673 'is_fields' => TRUE,
5674 'is_filters' => TRUE,
5675 'is_group_bys' => TRUE,
5676 'is_order_bys' => TRUE,
5678 $options['prefix'] . 'postal_code_suffix' => [
5679 'title' => $options['prefix_label'] . ts('Postal Code Suffix'),
5680 'name' => 'postal_code_suffix',
5682 'is_fields' => TRUE,
5683 'is_filters' => TRUE,
5684 'is_group_bys' => TRUE,
5685 'is_order_bys' => TRUE,
5687 $options['prefix'] . 'county_id' => [
5688 'title' => $options['prefix_label'] . ts('County'),
5689 'alter_display' => 'alterCountyID',
5690 'name' => 'county_id',
5691 'type' => CRM_Utils_Type
::T_INT
,
5692 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
5693 'options' => CRM_Core_PseudoConstant
::county(),
5694 'is_fields' => TRUE,
5695 'is_filters' => TRUE,
5696 'is_group_bys' => TRUE,
5698 $options['prefix'] . 'state_province_id' => [
5699 'title' => $options['prefix_label'] . ts('State/Province'),
5700 'alter_display' => 'alterStateProvinceID',
5701 'name' => 'state_province_id',
5702 'type' => CRM_Utils_Type
::T_INT
,
5703 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
5704 'options' => CRM_Core_PseudoConstant
::stateProvince(),
5705 'is_fields' => TRUE,
5706 'is_filters' => TRUE,
5707 'is_group_bys' => TRUE,
5709 $options['prefix'] . 'country_id' => [
5710 'title' => $options['prefix_label'] . ts('Country'),
5711 'alter_display' => 'alterCountryID',
5712 'name' => 'country_id',
5713 'is_fields' => TRUE,
5714 'is_filters' => TRUE,
5715 'is_group_bys' => TRUE,
5716 'type' => CRM_Utils_Type
::T_INT
,
5717 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
5718 'options' => CRM_Core_PseudoConstant
::country(),
5720 $options['prefix'] . 'location_type_id' => [
5721 'name' => 'location_type_id',
5722 'title' => $options['prefix_label'] . ts('Location Type'),
5723 'type' => CRM_Utils_Type
::T_INT
,
5724 'is_fields' => TRUE,
5725 'alter_display' => 'alterLocationTypeID',
5727 $options['prefix'] . 'id' => [
5728 'title' => $options['prefix_label'] . ts('ID'),
5730 'is_fields' => TRUE,
5732 $options['prefix'] . 'is_primary' => [
5733 'name' => 'is_primary',
5734 'title' => $options['prefix_label'] . ts('Primary Address?'),
5735 'type' => CRM_Utils_Type
::T_BOOLEAN
,
5736 'is_fields' => TRUE,
5739 return $this->buildColumns($spec, $options['prefix'] . 'civicrm_address', 'CRM_Core_DAO_Address', $tableAlias, $defaults, $options);
5743 * Build the columns.
5745 * The normal report class needs you to remember to do a few things that are often erratic
5747 * 1) use a unique key for any field that might not be unique (e.g. start date, label)
5748 * - this class will prepend an alias to the key & set the 'name' if you don't set it yourself.
5749 * You can suppress the alias with 'no_field_disambiguation' if transitioning existing reports. This
5750 * means any saved filters / fields on saved report instances. This will mean that matching names from
5751 * different tables may be ambigious, but it will smooth any code transition.
5752 * - note that it assumes the value being passed in is the actual table field name
5754 * 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
5755 * contexts - the code looks up the fields array for data - so it both defines the field spec & the fields you want to show
5757 * 3) this function also sets the 'metadata' array - the extended report class now uses this in place
5758 * of the fields array to reduce the issues caused when metadata is needed but 'fields' are not defined. Code in
5759 * the core classes can start to move towards that.
5761 * @param array $specs
5762 * @param string $tableName
5763 * @param string $daoName
5764 * @param string $tableAlias
5765 * @param array $defaults
5766 * @param array $options
5770 protected function buildColumns($specs, $tableName, $daoName = NULL, $tableAlias = NULL, $defaults = [], $options = []) {
5772 $tableAlias = str_replace('civicrm_', '', $tableName);
5774 $types = ['filters', 'group_bys', 'order_bys', 'join_filters'];
5775 $columns = [$tableName => array_fill_keys($types, [])];
5776 // The code that uses this no longer cares if it is a DAO or BAO so just call it a DAO.
5777 $columns[$tableName]['dao'] = $daoName;
5778 $columns[$tableName]['alias'] = $tableAlias;
5780 foreach ($specs as $specName => $spec) {
5781 if (empty($spec['name'])) {
5782 $spec['name'] = $specName;
5785 $fieldAlias = (empty($options['no_field_disambiguation']) ?
$tableAlias . '_' : '') . $specName;
5786 $columns[$tableName]['metadata'][$fieldAlias] = $spec;
5787 $columns[$tableName]['fields'][$fieldAlias] = $spec;
5788 if (isset($defaults['fields_defaults']) && in_array($spec['name'], $defaults['fields_defaults'])) {
5789 $columns[$tableName]['fields'][$fieldAlias]['default'] = TRUE;
5792 if (!$spec['is_fields'] ||
(isset($options['fields_excluded']) && in_array($specName, $options['fields_excluded']))) {
5793 $columns[$tableName]['fields'][$fieldAlias]['no_display'] = TRUE;
5796 if (isset($options['fields_required']) && in_array($specName, $options['fields_required'])) {
5797 $columns[$tableName]['fields'][$fieldAlias]['required'] = TRUE;
5800 foreach ($types as $type) {
5801 if ($options[$type] && !empty($spec['is_' . $type])) {
5802 $columns[$tableName][$type][$fieldAlias] = $spec;
5803 if (isset($defaults[$type . '_defaults']) && isset($defaults[$type . '_defaults'][$spec['name']])) {
5804 $columns[$tableName][$type][$fieldAlias]['default'] = $defaults[$type . '_defaults'][$spec['name']];
5813 * Store group bys into array - so we can check elsewhere what is grouped.
5815 protected function storeGroupByArray() {
5817 if (empty($this->_params
['group_bys'])
5818 ||
!is_array($this->_params
['group_bys'])) {
5819 $this->_params
['group_bys'] = [];
5822 foreach ($this->_columns
as $tableName => $table) {
5823 $table = $this->_columns
[$tableName];
5824 if (array_key_exists('group_bys', $table)) {
5825 foreach ($table['group_bys'] as $fieldName => $fieldData) {
5826 $field = $this->_columns
[$tableName]['metadata'][$fieldName];
5827 if (!empty($this->_params
['group_bys'][$fieldName]) ||
!empty($fieldData['required'])) {
5828 if (!empty($field['chart'])) {
5829 $this->assign('chartSupported', TRUE);
5832 if (!empty($table['group_bys'][$fieldName]['frequency']) &&
5833 !empty($this->_params
['group_bys_freq'][$fieldName])
5836 switch ($this->_params
['group_bys_freq'][$fieldName]) {
5838 $this->_groupByArray
[$tableName . '_' . $fieldName . '_start'] = self
::fiscalYearOffset($field['dbAlias']);
5842 $this->_groupByArray
[$tableName . '_' . $fieldName . '_start'] = " YEAR({$field['dbAlias']})";
5846 $this->_groupByArray
[$tableName . '_' . $fieldName . '_start'] = "YEAR({$field['dbAlias']}), QUARTER({$field['dbAlias']})";
5850 $this->_groupByArray
[$tableName . '_' . $fieldName . '_start'] = "YEARWEEK({$field['dbAlias']})";
5854 $this->_groupByArray
[$tableName . '_' . $fieldName . '_start'] = "EXTRACT(YEAR_MONTH FROM {$field['dbAlias']})";
5858 $this->_groupByArray
[$tableName . '_' . $fieldName . '_start'] = "DATE({$field['dbAlias']})";
5863 if (!in_array($field['dbAlias'], $this->_groupByArray
)) {
5864 $this->_groupByArray
[$tableName . '_' . $fieldName] = $field['dbAlias'];
5879 protected function getDefaultsFromOptions($options) {
5881 'fields_defaults' => $options['fields_defaults'],
5882 'filters_defaults' => $options['filters_defaults'],
5883 'group_bys_defaults' => $options['group_bys_defaults'],
5884 'order_bys_defaults' => $options['order_bys_defaults'],
5890 * Get the select clause for a field, wrapping in GROUP_CONCAT if appropriate.
5892 * Full group by mode dictates that a field must either be in the group by function or
5893 * wrapped in a aggregate function. Here we wrap the field in GROUP_CONCAT if it is not in the
5896 * @param string $tableName
5897 * @param string $fieldName
5898 * @param string $field
5901 protected function getSelectClauseWithGroupConcatIfNotGroupedBy($tableName, &$fieldName, &$field) {
5902 if ($this->groupConcatTested
&& (!empty($this->_groupByArray
) ||
$this->isForceGroupBy
)) {
5903 if ((empty($field['statistics']) ||
in_array('GROUP_CONCAT', $field['statistics']))) {
5904 $label = $field['title'] ??
NULL;
5905 $alias = $field['tplField'] ??
"{$tableName}_{$fieldName}";
5906 $this->_columnHeaders
["{$tableName}_{$fieldName}"]['title'] = $label;
5907 $this->_selectAliases
[] = $alias;
5908 if (empty($this->_groupByArray
[$tableName . '_' . $fieldName])) {
5909 return "GROUP_CONCAT(DISTINCT {$field['dbAlias']}) as $alias";
5911 return "({$field['dbAlias']}) as $alias";
5917 * Generate clause for the selected filter.
5919 * @param array $field
5920 * Field specification
5921 * @param string $fieldName
5925 * Relevant where clause.
5927 protected function generateFilterClause($field, $fieldName) {
5928 if (CRM_Utils_Array
::value('type', $field) & CRM_Utils_Type
::T_DATE
) {
5929 if (CRM_Utils_Array
::value('operatorType', $field) ==
5930 CRM_Report_Form
::OP_MONTH
5932 $op = $this->_params
["{$fieldName}_op"] ??
NULL;
5933 $value = $this->_params
["{$fieldName}_value"] ??
NULL;
5934 if (is_array($value) && !empty($value)) {
5935 return "(month({$field['dbAlias']}) $op (" . implode(', ', $value) .
5940 $relative = $this->_params
["{$fieldName}_relative"] ??
NULL;
5941 $from = $this->_params
["{$fieldName}_from"] ??
NULL;
5942 $to = $this->_params
["{$fieldName}_to"] ??
NULL;
5943 $fromTime = $this->_params
["{$fieldName}_from_time"] ??
NULL;
5944 $toTime = $this->_params
["{$fieldName}_to_time"] ??
NULL;
5945 return $this->dateClause($field['dbAlias'], $relative, $from, $to, $field['type'], $fromTime, $toTime);
5949 $op = $this->_params
["{$fieldName}_op"] ??
NULL;
5951 return $this->whereClause($field,
5953 CRM_Utils_Array
::value("{$fieldName}_value", $this->_params
),
5954 CRM_Utils_Array
::value("{$fieldName}_min", $this->_params
),
5955 CRM_Utils_Array
::value("{$fieldName}_max", $this->_params
)
5963 * Retrieve a suitable object from the factory depending on the report
5964 * parameters, which typically might just be dependent on outputMode.
5966 * If there is no suitable output handler, e.g. if outputMode is "copy",
5967 * then this sets it to NULL.
5969 public function setOutputHandler() {
5970 $this->outputHandler
= \Civi\Report\OutputHandlerFactory
::singleton()->create($this);
5974 * Send report by email
5976 public function sendEmail() {
5977 if (empty($this->outputHandler
)) {
5978 // It's possible to end up here with outputMode unset, so we use
5979 // the "print" handler which was the default before, i.e. include
5980 // it as html in the body.
5981 $oldOutputMode = $this->_outputMode ??
NULL;
5982 $this->_outputMode
= 'print';
5983 $this->setOutputHandler();
5984 $this->_outputMode
= $oldOutputMode;
5987 $mailBody = $this->outputHandler
->getMailBody();
5990 $attachmentFileName = $this->outputHandler
->getFileName();
5991 // It's not always in the form of an attachment, e.g. for 'print' the
5992 // output ends up in $mailBody above.
5993 if ($attachmentFileName) {
5994 $fullFilename = CRM_Core_Config
::singleton()->templateCompileDir
. CRM_Utils_File
::makeFileName($attachmentFileName);
5995 file_put_contents($fullFilename, $this->outputHandler
->getOutputString());
5997 'fullPath' => $fullFilename,
5998 'mime_type' => $this->outputHandler
->getMimeType(),
5999 'cleanName' => $attachmentFileName,
6000 'charset' => $this->outputHandler
->getCharset(),
6005 // @todo outputMode doesn't seem to get used by mailReport, which is good
6006 // since it shouldn't have any outputMode-related `if` statements in it.
6007 // Someday could remove the param from the function call.
6008 if (CRM_Report_Utils_Report
::mailReport($mailBody, $this->_id
, $this->_outputMode
, $attachments)) {
6009 CRM_Core_Session
::setStatus(ts("Report mail has been sent."), ts('Sent'), 'success');
6012 CRM_Core_Session
::setStatus(ts("Report mail could not be sent."), ts('Mail Error'), 'error');