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.
160 protected $groupFilterNotOptimised = TRUE;
167 public $_navigation = [];
169 public $_drilldownReport = [];
172 * Array of tabs to display on report.
174 * E.g we define the tab title, the tpl and the tab-specific part of the css or html link.
176 * $this->tabs['OrderBy'] = array(
177 * 'title' => ts('Sorting'),
178 * 'tpl' => 'OrderBy',
179 * 'div_label' => 'order-by',
184 protected $tabs = [];
187 * Should we add paging.
191 protected $addPaging = TRUE;
193 protected $isForceGroupBy = FALSE;
195 protected $groupConcatTested = FALSE;
198 * An attribute for checkbox/radio form field layout
202 protected $_fourColumnAttribute = [
203 '</td><td width="25%">',
204 '</td><td width="25%">',
205 '</td><td width="25%">',
209 protected $_force = 1;
211 protected $_params = NULL;
212 protected $_formValues = NULL;
213 protected $_instanceValues = NULL;
215 protected $_instanceForm = FALSE;
216 protected $_criteriaForm = FALSE;
218 protected $_instanceButtonName = NULL;
219 protected $_createNewButtonName = NULL;
220 protected $_printButtonName = NULL;
221 protected $_pdfButtonName = NULL;
222 protected $_csvButtonName = NULL;
223 protected $_groupButtonName = NULL;
224 protected $_chartButtonName = NULL;
225 protected $_csvSupported = TRUE;
226 protected $_add2groupSupported = TRUE;
227 protected $_groups = NULL;
228 protected $_grandFlag = FALSE;
229 protected $_rowsFound = NULL;
230 protected $_selectAliases = [];
231 protected $_rollup = NULL;
234 * Table containing list of contact IDs within the group filter.
238 protected $groupTempTable = '';
243 protected $_aliases = [];
259 protected $_limit = NULL;
262 * This can be set to specify a limit to the number of rows
263 * Since it is currently envisaged as part of the api usage it is only being applied
264 * when $_output mode is not 'html' or 'group' so as not to have to interpret / mess with that part
265 * of the code (see limit() fn.
269 protected $_limitValue = NULL;
272 * This can be set to specify row offset
273 * See notes on _limitValue
277 protected $_offsetValue = NULL;
281 protected $_sections = NULL;
282 protected $_autoIncludeIndexedFieldsAsOrderBys = 0;
283 protected $_absoluteUrl = FALSE;
286 * Flag to indicate if result-set is to be stored in a class variable which could be retrieved using getResultSet() method.
290 protected $_storeResultSet = FALSE;
293 * When _storeResultSet Flag is set use this var to store result set in form of array
297 protected $_resultSet = [];
300 * To what frequency group-by a date column
304 protected $_groupByDateFreq = [
306 'YEARWEEK' => 'Week',
307 'QUARTER' => 'Quarter',
312 * Variables to hold the acl inner join and where clause
315 protected $_aclFrom = NULL;
316 protected $_aclWhere = NULL;
319 * Array of DAO tables having columns included in SELECT or ORDER BY clause.
321 * Where has also been added to this although perhaps the 'includes both' array should have a different name.
325 protected $_selectedTables = [];
328 * Array of DAO tables having columns included in WHERE or HAVING clause
332 protected $filteredTables;
335 * Output mode e.g 'print', 'csv', 'pdf'.
339 protected $_outputMode;
342 * Format of any chart in use.
344 * (it's unclear if this could be merged with outputMode at this stage)
350 public $_having = NULL;
351 public $_select = NULL;
352 public $_selectClauses = [];
353 public $_columnHeaders = [];
354 public $_orderBy = NULL;
355 public $_orderByFields = [];
356 public $_orderByArray = [];
358 * Array of clauses to group by.
362 protected $_groupByArray = [];
363 public $_groupBy = NULL;
364 public $_whereClauses = [];
365 public $_havingClauses = [];
368 * DashBoardRowCount Dashboard row count.
372 public $_dashBoardRowCount;
375 * Is this being called without a form controller (ie. the report is being render outside the normal form
376 * - e.g the api is retrieving the rows.
380 public $noController = FALSE;
383 * Variable to hold the currency alias.
387 protected $_currencyColumn = NULL;
392 protected $_interval;
397 protected $_sendmail;
410 * Report description.
414 public $_description;
417 * Is an address field selected.
420 * This was intended to determine if the address table should be joined in
421 * The isTableSelected function is now preferred for this purpose
423 protected $_addressField;
426 * Is an email field selected.
429 * This was intended to determine if the email table should be joined in
430 * The isTableSelected function is now preferred for this purpose
432 protected $_emailField;
435 * Is a phone field selected.
438 * This was intended to determine if the phone table should be joined in
439 * The isTableSelected function is now preferred for this purpose
441 protected $_phoneField;
444 * Create new report instance? (or update existing) on save.
448 protected $_createNew;
451 * When a grand total row has calculated the status we pop it off to here.
453 * This allows us to access it from the stats function and avoid recalculating.
457 protected $rollupRow = [];
460 * Database attributes - character set and collation.
464 protected $_databaseAttributes = ' DEFAULT CHARACTER SET utf8 COLLATE utf8_unicode_ci';
467 * SQL being run in this report.
469 * The sql in the report is stored in this variable in order to be displayed on the developer tab.
477 * An instruction not to add a Group By.
479 * This is relevant where the group by might be otherwise added after the code that determines the group by array.
481 * e.g. where stat fields are being added but other settings cause it to not be desirable to add a group by
482 * such as in pivot charts when no row header is set
486 protected $noGroupBy = FALSE;
489 * SQL being run in this report as an array.
491 * The sql in the report is stored in this variable in order to be returned to api & test calls.
499 * Tables created for the report that need removal afterwards.
501 * ['civicrm_temp_report_x' => ['temporary' => TRUE, 'name' => 'civicrm_temp_report_x']
504 protected $temporaryTables = [];
507 * Can this report use the sql mode ONLY_FULL_GROUP_BY.
510 public $optimisedForOnlyFullGroupBy = TRUE;
515 public function __construct() {
516 parent
::__construct();
518 $this->addClass('crm-report-form');
520 if ($this->_tagFilter
) {
521 $this->buildTagFilter();
523 if ($this->_exposeContactID
) {
524 if (array_key_exists('civicrm_contact', $this->_columns
)) {
525 $this->_columns
['civicrm_contact']['fields']['exposed_id'] = [
527 'title' => ts('Contact ID'),
533 if ($this->_groupFilter
) {
534 $this->buildGroupFilter();
537 // Get all custom groups
538 $allGroups = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_CustomField', 'custom_group_id');
540 // Get the custom groupIds for which the user has VIEW permission
541 // If the user has 'access all custom data' permission, we'll leave $permCustomGroupIds empty
542 // and addCustomDataToColumns() will allow access to all custom groups.
543 $permCustomGroupIds = [];
544 if (!CRM_Core_Permission
::check('access all custom data')) {
545 $permCustomGroupIds = CRM_ACL_API
::group(CRM_Core_Permission
::VIEW
, NULL, 'civicrm_custom_group', $allGroups, NULL);
546 // do not allow custom data for reports if user doesn't have
547 // permission to access custom data.
548 if (!empty($this->_customGroupExtends
) && empty($permCustomGroupIds)) {
549 $this->_customGroupExtends
= [];
553 // merge custom data columns to _columns list, if any
554 $this->addCustomDataToColumns(TRUE, $permCustomGroupIds);
556 // add / modify display columns, filters ..etc
557 CRM_Utils_Hook
::alterReportVar('columns', $this->_columns
, $this);
559 //assign currencyColumn variable to tpl
560 $this->assign('currencyColumn', $this->_currencyColumn
);
564 * Shared pre-process function.
566 * If overriding preProcess function this should still be called.
570 public function preProcessCommon() {
571 $this->_force
= CRM_Utils_Request
::retrieve('force', 'Boolean');
573 $this->_dashBoardRowCount
= CRM_Utils_Request
::retrieve('rowCount', 'Integer');
575 $this->_section
= CRM_Utils_Request
::retrieve('section', 'Integer');
577 $this->assign('section', $this->_section
);
578 CRM_Core_Region
::instance('page-header')->add([
579 'markup' => sprintf('<!-- Report class: [%s] -->', htmlentities(get_class($this))),
581 if (!$this->noController
) {
582 $this->setID($this->get('instanceId'));
585 $this->setID(CRM_Report_Utils_Report
::getInstanceID());
587 $this->setID(CRM_Report_Utils_Report
::getInstanceIDForPath());
591 // set qfkey so that pager picks it up and use it in the "Next > Last >>" links.
592 // FIXME: Note setting it in $_GET doesn't work, since pager generates link based on QUERY_STRING
593 $_SERVER['QUERY_STRING'] .= "&qfKey={$this->controller->_key}";
597 $this->assign('instanceId', $this->_id
);
598 $params = ['id' => $this->_id
];
599 $this->_instanceValues
= [];
600 CRM_Core_DAO
::commonRetrieve('CRM_Report_DAO_ReportInstance',
602 $this->_instanceValues
604 if (empty($this->_instanceValues
)) {
605 CRM_Core_Error
::fatal("Report could not be loaded.");
607 $this->_title
= $this->_instanceValues
['title'];
608 if (!empty($this->_instanceValues
['permission']) &&
609 (!(CRM_Core_Permission
::check($this->_instanceValues
['permission']) ||
610 CRM_Core_Permission
::check('administer Reports')
613 CRM_Utils_System
::permissionDenied();
614 CRM_Utils_System
::civiExit();
617 $formValues = $this->_instanceValues
['form_values'] ??
NULL;
619 $this->_formValues
= CRM_Utils_String
::unserialize($formValues);
622 $this->_formValues
= NULL;
625 $this->setOutputMode();
627 if ($this->_outputMode
== 'copy') {
628 $this->_createNew
= TRUE;
629 $this->_params
= $this->_formValues
;
630 $this->_params
['view_mode'] = 'criteria';
631 $this->_params
['title'] = $this->getTitle() . ts(' (copy created by %1 on %2)', [
632 CRM_Core_Session
::singleton()->getLoggedInContactDisplayName(),
633 CRM_Utils_Date
::customFormat(date('Y-m-d H:i')),
635 // Do not pass go. Do not collect another chance to re-run the same query.
636 CRM_Report_Form_Instance
::postProcess($this);
639 // lets always do a force if reset is found in the url.
640 // Hey why not? see CRM-17225 for more about this. The use of reset to be force is historical for reasons stated
641 // in the comment line above these 2.
642 if (!empty($_REQUEST['reset'])
643 && !in_array(CRM_Utils_Request
::retrieve('output', 'String'), ['save', 'criteria'])) {
648 $this->assign('mode', 'instance');
650 elseif (!$this->noController
) {
651 list($optionValueID, $optionValue) = CRM_Report_Utils_Report
::getValueIDFromUrl();
652 $instanceCount = CRM_Report_Utils_Report
::getInstanceCount($optionValue);
653 if (($instanceCount > 0) && $optionValueID) {
654 $this->assign('instanceUrl',
655 CRM_Utils_System
::url('civicrm/report/list',
656 "reset=1&ovid=$optionValueID"
660 if ($optionValueID) {
661 $this->_description
= CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionValue', $optionValueID, 'description');
665 $this->assign('mode', 'template');
668 // lets display the Report Settings section
669 $this->_instanceForm
= $this->_force ||
$this->_id ||
(!empty($_POST));
671 // Do not display Report Settings section if administer Reports permission is absent OR
672 // if report instance is reserved and administer reserved reports absent
673 if (!CRM_Core_Permission
::check('administer Reports') ||
674 ($this->_instanceValues
['is_reserved'] &&
675 !CRM_Core_Permission
::check('administer reserved reports'))
677 $this->_instanceForm
= FALSE;
680 $this->assign('criteriaForm', FALSE);
681 // Display Report Criteria section if user has access Report Criteria OR administer Reports AND report instance is not reserved
682 if (CRM_Core_Permission
::check('administer Reports') ||
683 CRM_Core_Permission
::check('access Report Criteria')
685 if (!$this->_instanceValues
['is_reserved'] ||
686 CRM_Core_Permission
::check('administer reserved reports')
688 $this->assign('criteriaForm', TRUE);
689 $this->_criteriaForm
= TRUE;
693 // Special permissions check for private instance if it's not the current contact instance
695 (CRM_Report_BAO_ReportInstance
::reportIsPrivate($this->_id
) &&
696 !CRM_Report_BAO_ReportInstance
::contactIsOwner($this->_id
))) {
697 if (!CRM_Core_Permission
::check('access all private reports')) {
698 $this->_instanceForm
= FALSE;
699 $this->assign('criteriaForm', FALSE);
703 $this->_instanceButtonName
= $this->getButtonName('submit', 'save');
704 $this->_createNewButtonName
= $this->getButtonName('submit', 'next');
705 $this->_groupButtonName
= $this->getButtonName('submit', 'group');
706 $this->_chartButtonName
= $this->getButtonName('submit', 'chart');
712 public function addBreadCrumb() {
716 'title' => ts('Report Templates'),
717 'url' => CRM_Utils_System
::url('civicrm/admin/report/template/list', 'reset=1'),
721 CRM_Utils_System
::appendBreadCrumb($breadCrumbs);
725 * Pre process function.
727 * Called prior to build form.
729 public function preProcess() {
730 $this->preProcessCommon();
733 $this->addBreadCrumb();
736 foreach ($this->_columns
as $tableName => $table) {
737 $this->setTableAlias($table, $tableName);
740 // higher preference to bao object
741 $daoOrBaoName = CRM_Utils_Array
::value('bao', $table, CRM_Utils_Array
::value('dao', $table));
744 if (method_exists($daoOrBaoName, 'exportableFields')) {
745 $expFields = $daoOrBaoName::exportableFields();
748 $expFields = $daoOrBaoName::export();
752 $doNotCopy = ['required', 'default'];
754 $fieldGroups = ['fields', 'filters', 'group_bys', 'order_bys'];
755 foreach ($fieldGroups as $fieldGrp) {
756 if (!empty($table[$fieldGrp]) && is_array($table[$fieldGrp])) {
757 foreach ($table[$fieldGrp] as $fieldName => $field) {
758 // $name is the field name used to reference the BAO/DAO export fields array
759 $name = $field['name'] ??
$fieldName;
761 // Sometimes the field name key in the BAO/DAO export fields array is
762 // different from the actual database field name.
763 // Unset $field['name'] so that actual database field name can be obtained
764 // from the BAO/DAO export fields array.
765 unset($field['name']);
767 if (array_key_exists($name, $expFields)) {
768 foreach ($doNotCopy as $dnc) {
769 // unset the values we don't want to be copied.
770 unset($expFields[$name][$dnc]);
773 $this->_columns
[$tableName][$fieldGrp][$fieldName] = $expFields[$name];
776 foreach ($expFields[$name] as $property => $val) {
777 if (!array_key_exists($property, $field)) {
778 $this->_columns
[$tableName][$fieldGrp][$fieldName][$property] = $val;
785 if (!empty($field['no_repeat'])) {
786 $this->_noRepeats
[] = "{$tableName}_{$fieldName}";
788 if (!empty($field['no_display'])) {
789 $this->_noDisplay
[] = "{$tableName}_{$fieldName}";
792 // set alias = table-name, unless already set
793 $alias = $field['alias'] ??
(
794 $this->_columns
[$tableName]['alias'] ??
$tableName
796 $this->_columns
[$tableName][$fieldGrp][$fieldName]['alias'] = $alias;
798 // set name = fieldName, unless already set
799 if (!isset($this->_columns
[$tableName][$fieldGrp][$fieldName]['name'])) {
800 $this->_columns
[$tableName][$fieldGrp][$fieldName]['name'] = $name;
803 if (!isset($this->_columns
[$tableName][$fieldGrp][$fieldName]['table_name'])) {
804 $this->_columns
[$tableName][$fieldGrp][$fieldName]['table_name'] = $tableName;
807 // set dbAlias = alias.name, unless already set
808 if (!isset($this->_columns
[$tableName][$fieldGrp][$fieldName]['dbAlias'])) {
809 $this->_columns
[$tableName][$fieldGrp][$fieldName]['dbAlias']
811 $this->_columns
[$tableName][$fieldGrp][$fieldName]['name'];
814 // a few auto fills for filters
815 if ($fieldGrp == 'filters') {
816 // fill operator types
817 if (!array_key_exists('operatorType', $this->_columns
[$tableName][$fieldGrp][$fieldName])) {
818 switch (CRM_Utils_Array
::value('type', $this->_columns
[$tableName][$fieldGrp][$fieldName])) {
819 case CRM_Utils_Type
::T_MONEY
:
820 case CRM_Utils_Type
::T_FLOAT
:
821 $this->_columns
[$tableName][$fieldGrp][$fieldName]['operatorType'] = CRM_Report_Form
::OP_FLOAT
;
824 case CRM_Utils_Type
::T_INT
:
825 $this->_columns
[$tableName][$fieldGrp][$fieldName]['operatorType'] = CRM_Report_Form
::OP_INT
;
828 case CRM_Utils_Type
::T_DATE
:
829 $this->_columns
[$tableName][$fieldGrp][$fieldName]['operatorType'] = CRM_Report_Form
::OP_DATE
;
832 case CRM_Utils_Type
::T_BOOLEAN
:
833 $this->_columns
[$tableName][$fieldGrp][$fieldName]['operatorType'] = CRM_Report_Form
::OP_SELECT
;
834 if (!array_key_exists('options', $this->_columns
[$tableName][$fieldGrp][$fieldName])) {
835 $this->_columns
[$tableName][$fieldGrp][$fieldName]['options']
846 array_key_exists('pseudoconstant', $this->_columns
[$tableName][$fieldGrp][$fieldName])
848 // with multiple options operator-type is generally multi-select
849 $this->_columns
[$tableName][$fieldGrp][$fieldName]['operatorType'] = CRM_Report_Form
::OP_MULTISELECT
;
850 if (!array_key_exists('options', $this->_columns
[$tableName][$fieldGrp][$fieldName])) {
852 $this->_columns
[$tableName][$fieldGrp][$fieldName]['options'] = CRM_Core_PseudoConstant
::get($daoOrBaoName, $fieldName);
859 if (!isset($this->_columns
[$tableName]['metadata'][$fieldName])) {
860 $this->_columns
[$tableName]['metadata'][$fieldName] = $this->_columns
[$tableName][$fieldGrp][$fieldName];
863 $this->_columns
[$tableName]['metadata'][$fieldName] = array_merge($this->_columns
[$tableName][$fieldGrp][$fieldName], $this->_columns
[$tableName]['metadata'][$fieldName]);
869 // copy filters to a separate handy variable
870 if (array_key_exists('filters', $table)) {
871 $this->_filters
[$tableName] = $this->_columns
[$tableName]['filters'];
874 if (array_key_exists('group_bys', $table)) {
875 $groupBys[$tableName] = $this->_columns
[$tableName]['group_bys'];
878 if (array_key_exists('fields', $table)) {
879 $reportFields[$tableName] = $this->_columns
[$tableName]['fields'];
884 $this->setDefaultValues(FALSE);
887 CRM_Report_Utils_Get
::processFilter($this->_filters
, $this->_defaults
);
888 CRM_Report_Utils_Get
::processGroupBy($groupBys, $this->_defaults
);
889 CRM_Report_Utils_Get
::processFields($reportFields, $this->_defaults
);
890 CRM_Report_Utils_Get
::processChart($this->_defaults
);
893 $this->_formValues
= $this->_defaults
;
894 $this->postProcess();
899 * Set default values.
901 * @param bool $freeze
905 public function setDefaultValues($freeze = TRUE) {
908 // FIXME: generalizing form field naming conventions would reduce
909 // Lots of lines below.
910 foreach ($this->_columns
as $tableName => $table) {
911 if (array_key_exists('fields', $table)) {
912 foreach ($table['fields'] as $fieldName => $field) {
913 if (empty($field['no_display'])) {
914 if (!empty($field['required'])) {
916 $this->_defaults
['fields'][$fieldName] = 1;
919 // find element object, so that we could use quickform's freeze method
920 // for required elements
921 $obj = $this->getElementFromGroup("fields", $fieldName);
923 $freezeGroup[] = $obj;
927 elseif (isset($field['default'])) {
928 $this->_defaults
['fields'][$fieldName] = $field['default'];
934 if (array_key_exists('group_bys', $table)) {
935 foreach ($table['group_bys'] as $fieldName => $field) {
936 if (isset($field['default'])) {
937 if (!empty($field['frequency'])) {
938 $this->_defaults
['group_bys_freq'][$fieldName] = 'MONTH';
940 $this->_defaults
['group_bys'][$fieldName] = $field['default'];
944 if (array_key_exists('filters', $table)) {
945 foreach ($table['filters'] as $fieldName => $field) {
946 if (isset($field['default'])) {
947 if (CRM_Utils_Array
::value('type', $field) & CRM_Utils_Type
::T_DATE
949 if (is_array($field['default'])) {
950 $this->_defaults
["{$fieldName}_from"] = $field['default']['from'] ??
NULL;
951 $this->_defaults
["{$fieldName}_to"] = $field['default']['to'] ??
NULL;
952 $this->_defaults
["{$fieldName}_relative"] = 0;
955 $this->_defaults
["{$fieldName}_relative"] = $field['default'];
959 if ((CRM_Utils_Array
::value('type', $field) & CRM_Utils_Type
::T_INT
) && is_array($field['default'])) {
960 $this->_defaults
["{$fieldName}_min"] = $field['default']['min'] ??
NULL;
961 $this->_defaults
["{$fieldName}_max"] = $field['default']['max'] ??
NULL;
963 $this->_defaults
["{$fieldName}_value"] = $field['default'];
966 //assign default value as "in" for multiselect
967 //operator, To freeze the select element
968 if (CRM_Utils_Array
::value('operatorType', $field) ==
969 CRM_Report_Form
::OP_MULTISELECT
971 $this->_defaults
["{$fieldName}_op"] = 'in';
973 if (CRM_Utils_Array
::value('operatorType', $field) ==
974 CRM_Report_Form
::OP_ENTITYREF
976 $this->_defaults
["{$fieldName}_op"] = 'in';
978 elseif (CRM_Utils_Array
::value('operatorType', $field) ==
979 CRM_Report_Form
::OP_MULTISELECT_SEPARATOR
981 $this->_defaults
["{$fieldName}_op"] = 'mhas';
983 elseif ($op = CRM_Utils_Array
::value('default_op', $field)) {
984 $this->_defaults
["{$fieldName}_op"] = $op;
990 empty($this->_formValues
['order_bys']) &&
991 (array_key_exists('order_bys', $table) &&
992 is_array($table['order_bys']))
994 if (!array_key_exists('order_bys', $this->_defaults
)) {
995 $this->_defaults
['order_bys'] = [];
997 foreach ($table['order_bys'] as $fieldName => $field) {
998 if (!empty($field['default']) ||
!empty($field['default_order']) ||
999 CRM_Utils_Array
::value('default_is_section', $field) ||
1000 !empty($field['default_weight'])
1003 'column' => $fieldName,
1004 'order' => CRM_Utils_Array
::value('default_order', $field, 'ASC'),
1005 'section' => CRM_Utils_Array
::value('default_is_section', $field, 0),
1008 if (!empty($field['default_weight'])) {
1009 $this->_defaults
['order_bys'][(int) $field['default_weight']] = $order_by;
1012 array_unshift($this->_defaults
['order_bys'], $order_by);
1018 foreach ($this->_options
as $fieldName => $field) {
1019 if (isset($field['default'])) {
1020 $this->_defaults
['options'][$fieldName] = $field['default'];
1025 if (!empty($this->_submitValues
)) {
1026 $this->preProcessOrderBy($this->_submitValues
);
1029 $this->preProcessOrderBy($this->_defaults
);
1032 // lets finish freezing task here itself
1033 if (!empty($freezeGroup)) {
1034 foreach ($freezeGroup as $elem) {
1039 if ($this->_formValues
) {
1040 $this->_defaults
= array_merge($this->_defaults
, $this->_formValues
);
1043 if ($this->_instanceValues
) {
1044 $this->_defaults
= array_merge($this->_defaults
, $this->_instanceValues
);
1047 CRM_Report_Form_Instance
::setDefaultValues($this, $this->_defaults
);
1049 return $this->_defaults
;
1053 * Get element from group.
1055 * @param string $group
1056 * @param string $grpFieldName
1060 public function getElementFromGroup($group, $grpFieldName) {
1061 $eleObj = $this->getElement($group);
1062 foreach ($eleObj->_elements
as $index => $obj) {
1063 if ($grpFieldName == $obj->_attributes
['name']) {
1071 * Setter for $_params.
1073 * @param array $params
1075 public function setParams($params) {
1076 $this->_params
= $params;
1080 * Getter for $_params.
1082 * @return void|array $params
1084 public function getParams() {
1085 return $this->_params
;
1091 * @param int $instanceID
1093 public function setID($instanceID) {
1094 $this->_id
= $instanceID;
1098 * Setter for $_force.
1100 * @param bool $isForce
1102 public function setForce($isForce) {
1103 $this->_force
= $isForce;
1107 * Setter for $_limitValue.
1109 * @param int $_limitValue
1111 public function setLimitValue($_limitValue) {
1112 $this->_limitValue
= $_limitValue;
1116 * Setter for $_offsetValue.
1118 * @param int $_offsetValue
1120 public function setOffsetValue($_offsetValue) {
1121 $this->_offsetValue
= $_offsetValue;
1125 * Setter for $addPaging.
1127 * @param bool $value
1129 public function setAddPaging($value) {
1130 $this->addPaging
= $value;
1134 * Getter for $_defaultValues.
1138 public function getDefaultValues() {
1139 return $this->_defaults
;
1143 * Remove any temporary tables.
1145 public function cleanUpTemporaryTables() {
1146 foreach ($this->temporaryTables
as $temporaryTable) {
1147 CRM_Core_DAO
::executeQuery('DROP ' . ($temporaryTable['temporary'] ?
'TEMPORARY' : '') . ' TABLE IF EXISTS ' . $temporaryTable['name']);
1152 * Create a temporary table.
1154 * This function creates a table AND adds the details to the developer tab & $this->>temporary tables.
1156 * @param string $identifier
1157 * This is the key that will be used for the table in the temporaryTables property.
1158 * @param string $sql
1159 * Sql select statement or column description (the latter requires the columns flag)
1160 * @param bool $isColumns
1161 * Is the sql describing columns to create (rather than using a select query).
1162 * @param bool $isMemory
1163 * Create a memory table rather than a normal INNODB table.
1167 public function createTemporaryTable($identifier, $sql, $isColumns = FALSE, $isMemory = FALSE) {
1168 $tempTable = CRM_Utils_SQL_TempTable
::build();
1170 $tempTable->setMemory();
1173 $tempTable->createWithColumns($sql);
1176 $tempTable->createWithQuery($sql);
1178 $name = $tempTable->getName();
1179 // Developers may force tables to be durable to assist in debugging so lets check.
1180 $isNotTrueTemporary = $tempTable->isDurable();
1181 $this->addToDeveloperTab($tempTable->getCreateSql());
1182 $this->temporaryTables
[$identifier] = ['temporary' => !$isNotTrueTemporary, 'name' => $name];
1187 * Add columns to report.
1189 public function addColumns() {
1192 foreach ($this->_columns
as $tableName => $table) {
1193 if (array_key_exists('fields', $table)) {
1194 foreach ($table['fields'] as $fieldName => $field) {
1196 if (empty($field['no_display'])) {
1197 foreach (['table', 'field'] as $var) {
1198 if (!empty($
{$var}['grouping'])) {
1199 if (!is_array($
{$var}['grouping'])) {
1200 $tableName = $
{$var}['grouping'];
1203 $tableName = array_keys($
{$var}['grouping']);
1204 $tableName = $tableName[0];
1205 $groupTitle = array_values($
{$var}['grouping']);
1206 $groupTitle = $groupTitle[0];
1211 if (!$groupTitle && isset($table['group_title'])) {
1212 $groupTitle = $table['group_title'];
1213 // Having a group_title is secret code for being a custom group
1214 // which cryptically translates to needing an accordion.
1215 // here we make that explicit.
1216 $colGroups[$tableName]['use_accordian_for_field_selection'] = TRUE;
1219 $colGroups[$tableName]['fields'][$fieldName] = $field['title'] ??
NULL;
1220 if ($groupTitle && empty($colGroups[$tableName]['group_title'])) {
1221 $colGroups[$tableName]['group_title'] = $groupTitle;
1223 $options[$fieldName] = $field['title'] ??
NULL;
1229 $this->addCheckBox("fields", ts('Select Columns'), $options, NULL,
1230 NULL, NULL, NULL, $this->_fourColumnAttribute
, TRUE
1232 if (!empty($colGroups)) {
1233 $this->tabs
['FieldSelection'] = [
1234 'title' => ts('Columns'),
1235 'tpl' => 'FieldSelection',
1236 'div_label' => 'col-groups',
1239 // Note this assignment is only really required in buildForm. It is being 'over-called'
1240 // to reduce risk of being missed due to overridden functions.
1241 $this->assign('tabs', $this->tabs
);
1244 $this->assign('colGroups', $colGroups);
1248 * Add filters to report.
1250 public function addFilters() {
1251 $filters = $filterGroups = [];
1254 foreach ($this->_filters
as $table => $attributes) {
1255 if (isset($this->_columns
[$table]['group_title'])) {
1256 // The presence of 'group_title' is secret code for 'is_a_custom_table'
1257 // which magically means to 'display in an accordian'
1258 // here we make this explicit.
1259 $filterGroups[$table] = [
1260 'group_title' => $this->_columns
[$table]['group_title'],
1261 'use_accordian_for_field_selection' => TRUE,
1265 foreach ($attributes as $fieldName => $field) {
1266 // get ready with option value pair
1267 // @ 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
1269 $operations = $this->getOperationPair(
1270 CRM_Utils_Array
::value('operatorType', $field),
1273 $filters[$table][$fieldName] = $field;
1275 switch (CRM_Utils_Array
::value('operatorType', $field)) {
1276 case CRM_Report_Form
::OP_MONTH
:
1277 if (!array_key_exists('options', $field) ||
1278 !is_array($field['options']) ||
empty($field['options'])
1280 // If there's no option list for this filter, define one.
1281 $field['options'] = [
1283 2 => ts('February'),
1290 9 => ts('September'),
1291 10 => ts('October'),
1292 11 => ts('November'),
1293 12 => ts('December'),
1295 // Add this option list to this column _columns. This is
1296 // required so that filter statistics show properly.
1297 $this->_columns
[$table]['filters'][$fieldName]['options'] = $field['options'];
1299 case CRM_Report_Form
::OP_MULTISELECT
:
1300 case CRM_Report_Form
::OP_MULTISELECT_SEPARATOR
:
1301 // assume a multi-select field
1302 if (!empty($field['options']) ||
1303 $fieldName == 'state_province_id' ||
$fieldName == 'county_id'
1305 $element = $this->addElement('select', "{$fieldName}_op", ts('Operator:'), $operations,
1306 array('onchange' => "return showHideMaxMinVal( '$fieldName', this.value );")
1309 if (count($operations) <= 1) {
1312 if ($fieldName == 'state_province_id' ||
1313 $fieldName == 'county_id'
1315 $this->addChainSelect($fieldName . '_value', [
1322 $this->addElement('select', "{$fieldName}_value", NULL, $field['options'], [
1323 'style' => 'min-width:250px',
1324 'class' => 'crm-select2 huge',
1326 'placeholder' => ts('- select -'),
1332 case CRM_Report_Form
::OP_SELECT
:
1333 // assume a select field
1334 $this->addElement('select', "{$fieldName}_op", ts('Operator:'), $operations);
1335 if (!empty($field['options'])) {
1336 $this->addElement('select', "{$fieldName}_value", NULL, $field['options']);
1340 case CRM_Report_Form
::OP_ENTITYREF
:
1341 $this->addElement('select', "{$fieldName}_op", ts('Operator:'), $operations);
1342 $this->setEntityRefDefaults($field, $table);
1343 $this->addEntityRef("{$fieldName}_value", NULL, $field['attributes']);
1346 case CRM_Report_Form
::OP_DATE
:
1347 // build datetime fields
1348 $this->addDatePickerRange($fieldName, $field['title'], FALSE, FALSE, 'From', 'To', $operations, '_to', '_from');
1351 case CRM_Report_Form
::OP_DATETIME
:
1352 // build datetime fields
1353 $this->addDatePickerRange($fieldName, $field['title'], TRUE, FALSE, 'From', 'To', $operations, '_to', '_from');
1356 case CRM_Report_Form
::OP_INT
:
1357 case CRM_Report_Form
::OP_FLOAT
:
1358 // and a min value input box
1359 $this->add('text', "{$fieldName}_min", ts('Min'));
1360 // and a max value input box
1361 $this->add('text', "{$fieldName}_max", ts('Max'));
1363 // default type is string
1364 $this->addElement('select', "{$fieldName}_op", ts('Operator:'), $operations,
1365 ['onchange' => "return showHideMaxMinVal( '$fieldName', this.value );"]
1367 // we need text box for value input
1368 $this->add('text', "{$fieldName}_value", NULL, ['class' => 'huge']);
1373 if (!empty($filters)) {
1374 $this->tabs
['Filters'] = [
1375 'title' => ts('Filters'),
1377 'div_label' => 'set-filters',
1380 $this->assign('filters', $filters);
1381 $this->assign('filterGroups', $filterGroups);
1385 * Function to assign the tabs to the template in the correct order.
1387 * We want the tabs to wind up in this order (if not overridden).
1395 protected function assignTabs() {
1403 $order = array_intersect_key(array_fill_keys($order, 1), $this->tabs
);
1404 $order = array_merge($order, $this->tabs
);
1405 $this->assign('tabs', $order);
1409 * The intent is to add a tab for developers to view the sql.
1411 * Currently using dpm.
1413 * @param string $sql
1415 public function addToDeveloperTab($sql) {
1416 if (!CRM_Core_Permission
::check('view report sql')) {
1419 $ignored_output_modes = ['pdf', 'csv', 'print'];
1420 if (in_array($this->_outputMode
, $ignored_output_modes)) {
1423 $this->tabs
['Developer'] = [
1424 'title' => ts('Developer'),
1425 'tpl' => 'Developer',
1426 'div_label' => 'set-developer',
1429 $this->assignTabs();
1430 $this->sqlArray
[] = $sql;
1431 foreach ($this->sqlArray
as $sql) {
1432 foreach (['LEFT JOIN'] as $term) {
1433 $sql = str_replace($term, '<br> ' . $term, $sql);
1435 foreach (['FROM', 'WHERE', 'GROUP BY', 'ORDER BY', 'LIMIT', ';'] as $term) {
1436 $sql = str_replace($term, '<br><br>' . $term, $sql);
1438 $this->sqlFormattedArray
[] = $sql;
1439 $this->assign('sql', implode(';<br><br><br><br>', $this->sqlFormattedArray
));
1441 $this->assign('sqlModes', $sqlModes = CRM_Utils_SQL
::getSqlModes());
1446 * Add options defined in $this->_options to the report.
1448 public function addOptions() {
1449 if (!empty($this->_options
)) {
1450 // FIXME: For now lets build all elements as checkboxes.
1451 // Once we clear with the format we can build elements based on type
1453 foreach ($this->_options
as $fieldName => $field) {
1456 if ($field['type'] == 'select') {
1457 $this->addElement('select', "{$fieldName}", $field['title'], $field['options']);
1459 elseif ($field['type'] == 'checkbox') {
1460 $options[$field['title']] = $fieldName;
1461 $this->addCheckBox($fieldName, NULL,
1463 NULL, NULL, NULL, $this->_fourColumnAttribute
1468 if (!empty($this->_options
) &&
1470 ||
($this->_id
&& CRM_Report_BAO_ReportInstance
::contactCanAdministerReport($this->_id
)))
1472 $this->tabs
['ReportOptions'] = [
1473 'title' => ts('Display Options'),
1474 'tpl' => 'ReportOptions',
1475 'div_label' => 'other-options',
1478 $this->assign('otherOptions', $this->_options
);
1482 * Add chart options to the report.
1484 public function addChartOptions() {
1485 if (!empty($this->_charts
)) {
1486 $this->addElement('select', "charts", ts('Chart'), $this->_charts
);
1487 $this->assign('charts', $this->_charts
);
1488 $this->addElement('submit', $this->_chartButtonName
, ts('View'));
1493 * Add group by options to the report.
1495 public function addGroupBys() {
1496 $options = $freqElements = [];
1498 foreach ($this->_columns
as $tableName => $table) {
1499 if (array_key_exists('group_bys', $table)) {
1500 foreach ($table['group_bys'] as $fieldName => $field) {
1501 if (!empty($field) && empty($field['no_display'])) {
1502 $options[$field['title']] = $fieldName;
1503 if (!empty($field['frequency'])) {
1504 $freqElements[$field['title']] = $fieldName;
1510 $this->addCheckBox("group_bys", ts('Group by columns'), $options, NULL,
1511 NULL, NULL, NULL, $this->_fourColumnAttribute
1513 $this->assign('groupByElements', $options);
1514 if (!empty($options)) {
1515 $this->tabs
['GroupBy'] = [
1516 'title' => ts('Grouping'),
1518 'div_label' => 'group-by-elements',
1522 foreach ($freqElements as $name) {
1523 $this->addElement('select', "group_bys_freq[$name]",
1524 ts('Frequency'), $this->_groupByDateFreq
1530 * Add data for order by tab.
1532 public function addOrderBys() {
1534 foreach ($this->_columns
as $tableName => $table) {
1536 // Report developer may define any column to order by; include these as order-by options.
1537 if (array_key_exists('order_bys', $table)) {
1538 foreach ($table['order_bys'] as $fieldName => $field) {
1539 if (!empty($field)) {
1540 $options[$fieldName] = $field['title'];
1545 // Add searchable custom fields as order-by options, if so requested
1546 // (These are already indexed, so allowing to order on them is cheap.)
1548 if ($this->_autoIncludeIndexedFieldsAsOrderBys
&&
1549 array_key_exists('extends', $table) && !empty($table['extends'])
1551 foreach ($table['fields'] as $fieldName => $field) {
1552 if (empty($field['no_display'])) {
1553 $options[$fieldName] = $field['title'];
1561 $this->assign('orderByOptions', $options);
1562 if (!empty($options)) {
1563 $this->tabs
['OrderBy'] = [
1564 'title' => ts('Sorting'),
1566 'div_label' => 'order-by-elements',
1570 if (!empty($options)) {
1572 '-' => ' - none - ',
1574 for ($i = 1; $i <= 5; $i++
) {
1575 $this->addElement('select', "order_bys[{$i}][column]", ts('Order by Column'), $options);
1576 $this->addElement('select', "order_bys[{$i}][order]", ts('Order by Order'), [
1577 'ASC' => ts('Ascending'),
1578 'DESC' => ts('Descending'),
1580 $this->addElement('checkbox', "order_bys[{$i}][section]", ts('Order by Section'), FALSE, ['id' => "order_by_section_$i"]);
1581 $this->addElement('checkbox', "order_bys[{$i}][pageBreak]", ts('Page Break'), FALSE, ['id' => "order_by_pagebreak_$i"]);
1587 * This adds the tab referred to as Title and Format, rendered through Instance.tpl.
1589 * @todo call this tab into the report template in the same way as OrderBy etc, ie
1590 * by adding a description of the tab to $this->tabs, causing the tab to be added in
1593 public function buildInstanceAndButtons() {
1594 CRM_Report_Form_Instance
::buildForm($this);
1595 $this->_actionButtonName
= $this->getButtonName('submit');
1596 $this->addTaskMenu($this->getActions($this->_id
));
1598 $this->assign('instanceForm', $this->_instanceForm
);
1600 // CRM-16274 Determine if user has 'edit all contacts' or equivalent
1601 $permission = CRM_Core_Permission
::getPermission();
1602 if ($this->_instanceForm
&& $permission == CRM_Core_Permission
::EDIT
&&
1603 $this->_add2groupSupported
1605 $this->addElement('select', 'groups', ts('Group'),
1606 ['' => ts('Add Contacts to Group')] +
1607 CRM_Core_PseudoConstant
::nestedGroup(),
1608 ['class' => 'crm-select2 crm-action-menu fa-plus huge']
1610 $this->assign('group', TRUE);
1613 $this->addElement('submit', $this->_groupButtonName
, '', ['style' => 'display: none;']);
1615 $this->addChartOptions();
1616 $showResultsLabel = $this->getResultsLabel();
1620 'name' => $showResultsLabel,
1621 'isDefault' => TRUE,
1627 * Has this form been submitted already?
1631 public function resultsDisplayed() {
1632 $buttonName = $this->controller
->getButtonName();
1633 return ($buttonName ||
$this->_outputMode
);
1637 * Get the actions for this report instance.
1639 * @param int $instanceId
1643 protected function getActions($instanceId) {
1644 $actions = CRM_Report_BAO_ReportInstance
::getActionMetadata();
1645 if (empty($instanceId)) {
1646 $actions['report_instance.save'] = [
1647 'title' => ts('Create Report'),
1649 'is_confirm' => TRUE,
1650 'confirm_title' => ts('Create Report'),
1651 'confirm_refresh_fields' => json_encode([
1652 'title' => ['selector' => '.crm-report-instanceForm-form-block-title', 'prepend' => ''],
1653 'description' => ['selector' => '.crm-report-instanceForm-form-block-description', 'prepend' => ''],
1657 unset($actions['report_instance.delete']);
1660 if (!$this->_csvSupported
) {
1661 unset($actions['report_instance.csv']);
1668 * Main build form function.
1670 public function buildQuickForm() {
1671 $this->addColumns();
1673 $this->addFilters();
1675 $this->addOptions();
1677 $this->addGroupBys();
1679 $this->addOrderBys();
1681 $this->buildInstanceAndButtons();
1683 // Add form rule for report.
1688 $this->addFormRule([get_class($this), 'formRule'], $this);
1690 $this->assignTabs();
1694 * A form rule function for custom data.
1696 * The rule ensures that fields selected in group_by if any) should only be the ones
1697 * present in display/select fields criteria;
1698 * note: works if and only if any custom field selected in group_by.
1700 * @param array $fields
1701 * @param array $ignoreFields
1705 public function customDataFormRule($fields, $ignoreFields = []) {
1707 if (!empty($this->_customGroupExtends
) && $this->_customGroupGroupBy
&&
1708 !empty($fields['group_bys'])
1710 foreach ($this->_columns
as $tableName => $table) {
1711 if ((substr($tableName, 0, 13) == 'civicrm_value' ||
1712 substr($tableName, 0, 12) == 'custom_value') &&
1713 !empty($this->_columns
[$tableName]['fields'])
1715 foreach ($this->_columns
[$tableName]['fields'] as $fieldName => $field) {
1716 if (array_key_exists($fieldName, $fields['group_bys']) &&
1717 !array_key_exists($fieldName, $fields['fields'])
1719 $errors['fields'] = "Please make sure fields selected in 'Group by Columns' section are also selected in 'Display Columns' section.";
1721 elseif (array_key_exists($fieldName, $fields['group_bys'])) {
1722 foreach ($fields['fields'] as $fld => $val) {
1723 if (!array_key_exists($fld, $fields['group_bys']) &&
1724 !in_array($fld, $ignoreFields)
1726 $errors['fields'] = "Please ensure that fields selected in 'Display Columns' are also selected in 'Group by Columns' section.";
1738 * Get operators to display on form.
1740 * Note: $fieldName param allows inheriting class to build operationPairs specific to a field.
1742 * @param string $type
1743 * @param string $fieldName
1747 public function getOperationPair($type = "string", $fieldName = NULL) {
1748 // FIXME: At some point we should move these key-val pairs
1749 // to option_group and option_value table.
1751 case CRM_Report_Form
::OP_INT
:
1752 case CRM_Report_Form
::OP_FLOAT
:
1755 'lte' => ts('Is less than or equal to'),
1756 'gte' => ts('Is greater than or equal to'),
1757 'bw' => ts('Is between'),
1758 'eq' => ts('Is equal to'),
1759 'lt' => ts('Is less than'),
1760 'gt' => ts('Is greater than'),
1761 'neq' => ts('Is not equal to'),
1762 'nbw' => ts('Is not between'),
1763 'nll' => ts('Is empty (Null)'),
1764 'nnll' => ts('Is not empty (Null)'),
1768 case CRM_Report_Form
::OP_SELECT
:
1770 'eq' => ts('Is equal to'),
1774 case CRM_Report_Form
::OP_MONTH
:
1775 case CRM_Report_Form
::OP_MULTISELECT
:
1776 case CRM_Report_Form
::OP_ENTITYREF
:
1779 'in' => ts('Is one of'),
1780 'notin' => ts('Is not one of'),
1781 'nll' => ts('Is empty (Null)'),
1782 'nnll' => ts('Is not empty (Null)'),
1786 case CRM_Report_Form
::OP_DATE
:
1789 'nll' => ts('Is empty (Null)'),
1790 'nnll' => ts('Is not empty (Null)'),
1794 case CRM_Report_Form
::OP_MULTISELECT_SEPARATOR
:
1795 // use this operator for the values, concatenated with separator. For e.g if
1796 // multiple options for a column is stored as ^A{val1}^A{val2}^A
1798 'mhas' => ts('Is one of'),
1799 'mnot' => ts('Is not one of'),
1806 'has' => ts('Contains'),
1807 'sw' => ts('Starts with'),
1808 'ew' => ts('Ends with'),
1809 'nhas' => ts('Does not contain'),
1810 'eq' => ts('Is equal to'),
1811 'neq' => ts('Is not equal to'),
1812 'nll' => ts('Is empty (Null)'),
1813 'nnll' => ts('Is not empty (Null)'),
1820 * Build the tag filter field to display on the filters tab.
1822 public function buildTagFilter() {
1823 $contactTags = CRM_Core_BAO_Tag
::getTags($this->_tagFilterTable
);
1824 if (!empty($contactTags)) {
1825 $this->_columns
['civicrm_tag'] = [
1826 'dao' => 'CRM_Core_DAO_Tag',
1830 'title' => ts('Tag'),
1831 'type' => CRM_Utils_Type
::T_INT
,
1833 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
1834 'options' => $contactTags,
1842 * Adds group filters to _columns (called from _Construct).
1844 public function buildGroupFilter() {
1845 $this->_columns
['civicrm_group']['filters'] = [
1847 'name' => 'group_id',
1848 'title' => ts('Group'),
1849 'type' => CRM_Utils_Type
::T_INT
,
1850 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
1852 'options' => CRM_Core_PseudoConstant
::nestedGroup(),
1855 if (empty($this->_columns
['civicrm_group']['dao'])) {
1856 $this->_columns
['civicrm_group']['dao'] = 'CRM_Contact_DAO_GroupContact';
1858 if (empty($this->_columns
['civicrm_group']['alias'])) {
1859 $this->_columns
['civicrm_group']['alias'] = 'cgroup';
1864 * Get SQL operator from form text version.
1866 * @param string $operator
1870 public function getSQLOperator($operator = "like") {
1871 switch ($operator) {
1904 return 'IS NOT NULL';
1913 * Generate where clause.
1915 * This can be overridden in reports for special treatment of a field
1917 * @param array $field Field specifications
1918 * @param string $op Query operator (not an exact match to sql)
1919 * @param mixed $value
1923 * @return null|string
1925 public function whereClause(&$field, $op, $value, $min, $max) {
1927 $type = CRM_Utils_Type
::typeToString(CRM_Utils_Array
::value('type', $field));
1929 // CRM-18010: Ensure type of each report filters
1931 trigger_error('Type is not defined for field ' . $field['name'], E_USER_WARNING
);
1938 if (($min !== NULL && strlen($min) > 0) ||
1939 ($max !== NULL && strlen($max) > 0)
1943 $min = CRM_Utils_Type
::escape($min, $type);
1945 $clauses[] = "( {$field['dbAlias']} >= $min )";
1948 $clauses[] = "( {$field['dbAlias']} < $min OR {$field['dbAlias']} IS NULL )";
1952 $max = CRM_Utils_Type
::escape($max, $type);
1954 $clauses[] = "( {$field['dbAlias']} <= $max )";
1957 $clauses[] = "( {$field['dbAlias']} > $max )";
1961 if (!empty($clauses)) {
1963 $clause = implode(' AND ', $clauses);
1966 $clause = '(' . implode('OR', $clauses) . ')';
1974 if ($value !== NULL && strlen($value) > 0) {
1975 $value = CRM_Utils_Type
::escape($value, $type);
1976 if (strpos($value, '%') === FALSE) {
1977 $value = "'%{$value}%'";
1980 $value = "'{$value}'";
1982 $sqlOP = $this->getSQLOperator($op);
1983 $clause = "( {$field['dbAlias']} $sqlOP $value )";
1989 if ((is_string($value) ||
is_numeric($value)) && strlen($value)) {
1990 $value = explode(',', $value);
1992 if ($value !== NULL && is_array($value) && count($value) > 0) {
1993 $sqlOP = $this->getSQLOperator($op);
1994 if (CRM_Utils_Array
::value('type', $field) ==
1995 CRM_Utils_Type
::T_STRING
1997 //cycle through selections and escape values
1998 foreach ($value as $key => $selection) {
1999 $value[$key] = CRM_Utils_Type
::escape($selection, $type);
2002 = "( {$field['dbAlias']} $sqlOP ( '" . implode("' , '", $value) .
2006 // for numerical values
2007 $clause = "{$field['dbAlias']} $sqlOP (" . implode(', ', $value) .
2010 if ($op == 'notin') {
2011 $clause = "( " . $clause . " OR {$field['dbAlias']} IS NULL )";
2014 $clause = "( " . $clause . " )";
2021 // multiple has or multiple not
2022 if ($value !== NULL && count($value) > 0) {
2023 $value = CRM_Utils_Type
::escapeAll($value, $type);
2024 $operator = $op == 'mnot' ?
'NOT' : '';
2025 $regexp = "([[:cntrl:]]|^)" . implode('([[:cntrl:]]|$)|([[:cntrl:]]|^)', (array) $value) . "([[:cntrl:]]|$)";
2026 $clause = "{$field['dbAlias']} {$operator} REGEXP '{$regexp}'";
2032 if ($value !== NULL && strlen($value) > 0) {
2033 $value = CRM_Utils_Type
::escape($value, $type);
2034 if (strpos($value, '%') === FALSE) {
2036 $value = "'{$value}%'";
2039 $value = "'%{$value}'";
2043 $value = "'{$value}'";
2045 $sqlOP = $this->getSQLOperator($op);
2046 $clause = "( {$field['dbAlias']} $sqlOP $value )";
2052 $sqlOP = $this->getSQLOperator($op);
2053 $clause = "( {$field['dbAlias']} $sqlOP )";
2059 //CRM-18457: some custom field passes value in array format against binary operator
2060 if (is_array($value) && count($value)) {
2065 if ($value !== NULL && $value !== '') {
2066 if (isset($field['clause'])) {
2067 // FIXME: we not doing escape here. Better solution is to use two
2068 // different types - data-type and filter-type
2069 $clause = $field['clause'];
2071 elseif (!is_array($value)) {
2072 $value = CRM_Utils_Type
::escape($value, $type);
2073 $sqlOP = $this->getSQLOperator($op);
2074 if ($field['type'] == CRM_Utils_Type
::T_STRING
) {
2075 $value = "'{$value}'";
2077 $clause = "( {$field['dbAlias']} $sqlOP $value )";
2083 //dev/core/544 Add report support for multiple contact subTypes
2084 if ($field['name'] == 'contact_sub_type' && $clause) {
2085 $clause = $this->whereSubtypeClause($field, $value, $op);
2087 if (!empty($field['group']) && $clause) {
2088 $clause = $this->whereGroupClause($field, $value, $op);
2090 elseif (!empty($field['tag']) && $clause) {
2091 // not using left join in query because if any contact
2092 // belongs to more than one tag, results duplicate
2094 $clause = $this->whereTagClause($field, $value, $op);
2096 elseif (!empty($field['membership_org']) && $clause) {
2097 $clause = $this->whereMembershipOrgClause($value, $op);
2099 elseif (!empty($field['membership_type']) && $clause) {
2100 $clause = $this->whereMembershipTypeClause($value, $op);
2106 * Get SQL where clause for contact subtypes
2107 * @param string $field
2108 * @param mixed $value
2109 * @param string $op SQL Operator
2113 public function whereSubtypeClause($field, $value, $op) {
2114 // Get the correct SQL operator.
2119 $clauseSeparator = ' AND ';
2125 $clauseSeparator = ' OR ';
2128 $sqlOp = $this->getSQLOperator($op);
2129 if ($sqlOp == 'IS NULL' ||
$sqlOp == 'IS NOT NULL') {
2130 $clause = "{$field['dbAlias']} $sqlOp";
2134 foreach ($value as $item) {
2135 $subclauses[] = "( {$field['dbAlias']} $sqlOp '%" . CRM_Core_DAO
::VALUE_SEPARATOR
. $item . CRM_Core_DAO
::VALUE_SEPARATOR
. "%' )";
2137 $clause = implode($clauseSeparator, $subclauses);
2139 $clause = "( $clause )";
2141 $clause = "( ( {$field['dbAlias']} IS NULL ) OR $clause )";
2147 * Get SQL where clause for a date field.
2149 * @param string $fieldName
2150 * @param string $relative
2151 * @param string $from
2153 * @param string $type
2154 * @param string $fromTime
2155 * @param string $toTime
2157 * @return null|string
2159 public function dateClause(
2161 $relative, $from, $to, $type = NULL, $fromTime = NULL, $toTime = NULL
2164 if (in_array($relative, array_keys($this->getOperationPair(CRM_Report_Form
::OP_DATE
)))) {
2165 $sqlOP = $this->getSQLOperator($relative);
2166 return "( {$fieldName} {$sqlOP} )";
2170 list($from, $to) = $this->getFromTo($relative, $from, $to, $fromTime, $toTime);
2174 $clauses[] = "( {$fieldName} >= " . date('YmdHis', strtotime($from)) . ')';
2178 $clauses[] = "( {$fieldName} <= " . date('YmdHis', strtotime($to)) . ')';
2180 if (!empty($clauses)) {
2181 return implode(' AND ', $clauses);
2188 * Get values for from and to for date ranges.
2192 * @param bool $relative
2193 * @param string $from
2195 * @param string $fromTime
2196 * @param string $toTime
2200 public function getFromTo($relative, $from, $to, $fromTime = NULL, $toTime = NULL) {
2201 if (!empty($fromTime) ||
!empty($toTime)) {
2202 throw new CRM_Core_Exception('Report template needs to be updated as getFromTo no longer supports fromTime or ToTime Parameters');
2204 return CRM_Utils_Date
::getFromTo($relative, $from, $to);
2208 * Alter display of rows.
2210 * Iterate through the rows retrieved via SQL and make changes for display purposes,
2211 * such as rendering contacts as links.
2213 * @param array $rows
2214 * Rows generated by SQL, with an array for each row.
2216 public function alterDisplay(&$rows) {
2220 * Alter the way in which custom data fields are displayed.
2222 * @param array $rows
2224 public function alterCustomDataDisplay(&$rows) {
2225 // custom code to alter rows having custom values
2226 if (empty($this->_customGroupExtends
)) {
2231 $customFieldIds = [];
2232 foreach ($this->_params
['fields'] as $fieldAlias => $value) {
2233 if ($fieldId = CRM_Core_BAO_CustomField
::getKeyID($fieldAlias)) {
2234 $customFieldIds[$fieldAlias] = $fieldId;
2237 if (empty($customFieldIds)) {
2241 // skip for type date and ContactReference since date format is already handled
2243 SELECT cg.table_name, cf.id
2244 FROM civicrm_custom_field cf
2245 INNER JOIN civicrm_custom_group cg ON cg.id = cf.custom_group_id
2246 WHERE cg.extends IN ('" . implode("','", $this->_customGroupExtends
) . "') AND
2247 cg.is_active = 1 AND
2248 cf.is_active = 1 AND
2249 cf.is_searchable = 1 AND
2250 cf.data_type NOT IN ('ContactReference', 'Date') AND
2251 cf.id IN (" . implode(",", $customFieldIds) . ")";
2253 $dao = CRM_Core_DAO
::executeQuery($query);
2254 while ($dao->fetch()) {
2255 $customFields[$dao->table_name
. '_custom_' . $dao->id
] = $dao->id
;
2258 $entryFound = FALSE;
2259 foreach ($rows as $rowNum => $row) {
2260 foreach ($row as $tableCol => $val) {
2261 if (array_key_exists($tableCol, $customFields)) {
2262 $rows[$rowNum][$tableCol] = CRM_Core_BAO_CustomField
::displayValue($val, $customFields[$tableCol]);
2267 // skip looking further in rows, if first row itself doesn't
2268 // have the column we need
2276 * Remove duplicate rows.
2278 * @param array $rows
2280 public function removeDuplicates(&$rows) {
2281 if (empty($this->_noRepeats
)) {
2286 foreach ($rows as $key => $list) {
2287 foreach ($list as $colName => $colVal) {
2288 if (array_key_exists($colName, $checkList) &&
2289 $checkList[$colName] == $colVal
2291 $rows[$key][$colName] = "";
2293 if (in_array($colName, $this->_noRepeats
)) {
2294 $checkList[$colName] = $colVal;
2301 * Fix subtotal display.
2304 * @param array $fields
2305 * @param bool $subtotal
2307 public function fixSubTotalDisplay(&$row, $fields, $subtotal = TRUE) {
2308 foreach ($row as $colName => $colVal) {
2309 if (in_array($colName, $fields)) {
2311 elseif (isset($this->_columnHeaders
[$colName])) {
2313 $row[$colName] = 'Subtotal';
2317 unset($row[$colName]);
2324 * Calculate grant total.
2326 * @param array $rows
2330 public function grandTotal(&$rows) {
2331 if (!$this->_rollup ||
count($rows) == 1) {
2335 $this->moveSummaryColumnsToTheRightHandSide();
2337 if ($this->_limit
&& count($rows) >= self
::ROW_COUNT_LIMIT
) {
2341 $this->rollupRow
= array_pop($rows);
2343 foreach ($this->_columnHeaders
as $fld => $val) {
2344 if (!in_array($fld, $this->_statFields
)) {
2345 if (!$this->_grandFlag
) {
2346 $this->rollupRow
[$fld] = ts('Grand Total');
2347 $this->_grandFlag
= TRUE;
2350 $this->rollupRow
[$fld] = "";
2355 $this->assign('grandStat', $this->rollupRow
);
2360 * Format display output.
2362 * @param array $rows
2363 * @param bool $pager
2365 public function formatDisplay(&$rows, $pager = TRUE) {
2366 // set pager based on if any limit was applied in the query.
2371 // allow building charts if any
2372 if (!empty($this->_params
['charts']) && !empty($rows)) {
2373 $this->buildChart($rows);
2374 $this->assign('chartEnabled', TRUE);
2375 $this->_chartId
= "{$this->_params['charts']}_" .
2376 ($this->_id ?
$this->_id
: substr(get_class($this), 16)) . '_' .
2378 $this->assign('chartId', $this->_chartId
);
2381 // unset columns not to be displayed.
2382 foreach ($this->_columnHeaders
as $key => $value) {
2383 if (!empty($value['no_display'])) {
2384 unset($this->_columnHeaders
[$key]);
2388 // unset columns not to be displayed.
2389 if (!empty($rows)) {
2390 foreach ($this->_noDisplay
as $noDisplayField) {
2391 foreach ($rows as $rowNum => $row) {
2392 unset($this->_columnHeaders
[$noDisplayField]);
2397 // Find alter display functions.
2398 $firstRow = reset($rows);
2400 $selectedFields = array_keys($firstRow);
2401 $alterFunctions = $alterMap = $alterSpecs = [];
2402 foreach ($this->_columns
as $tableName => $table) {
2403 if (array_key_exists('metadata', $table)) {
2404 foreach ($table['metadata'] as $field => $specs) {
2405 if (in_array($tableName . '_' . $field, $selectedFields)) {
2406 if (array_key_exists('alter_display', $specs)) {
2407 $alterFunctions[$tableName . '_' . $field] = $specs['alter_display'];
2408 $alterMap[$tableName . '_' . $field] = $field;
2409 $alterSpecs[$tableName . '_' . $field] = NULL;
2411 // Add any alters that can be intuited from the field specs.
2412 // So far only boolean but a lot more could be.
2413 if (empty($alterSpecs[$tableName . '_' . $field]) && isset($specs['type']) && $specs['type'] == CRM_Utils_Type
::T_BOOLEAN
) {
2414 $alterFunctions[$tableName . '_' . $field] = 'alterBoolean';
2415 $alterMap[$tableName . '_' . $field] = $field;
2416 $alterSpecs[$tableName . '_' . $field] = NULL;
2423 // Run the alter display functions
2424 foreach ($rows as $index => & $row) {
2425 foreach ($row as $selectedField => $value) {
2426 if (array_key_exists($selectedField, $alterFunctions) && isset($value)) {
2427 $rows[$index][$selectedField] = $this->{$alterFunctions[$selectedField]}($value, $row, $selectedField, $alterMap[$selectedField], $alterSpecs[$selectedField]);
2433 // use this method for formatting rows for display purpose.
2434 $this->alterDisplay($rows);
2435 CRM_Utils_Hook
::alterReportVar('rows', $rows, $this);
2437 // build array of section totals
2438 $this->sectionTotals();
2440 // process grand-total row
2441 $this->grandTotal($rows);
2443 // use this method for formatting custom rows for display purpose.
2444 $this->alterCustomDataDisplay($rows);
2450 * @param $selectedfield
2451 * @param $criteriaFieldName
2455 protected function alterStateProvinceID($value, &$row, $selectedfield, $criteriaFieldName) {
2456 $url = CRM_Utils_System
::url(CRM_Utils_System
::currentPath(), "reset=1&force=1&{$criteriaFieldName}_op=in&{$criteriaFieldName}_value={$value}", $this->_absoluteUrl
);
2457 $row[$selectedfield . '_link'] = $url;
2458 $row[$selectedfield . '_hover'] = ts("%1 for this state.", [
2462 $states = CRM_Core_PseudoConstant
::stateProvince($value, FALSE);
2463 if (!is_array($states)) {
2471 * @param $selectedField
2472 * @param $criteriaFieldName
2476 protected function alterCountryID($value, &$row, $selectedField, $criteriaFieldName) {
2477 $url = CRM_Utils_System
::url(CRM_Utils_System
::currentPath(), "reset=1&force=1&{$criteriaFieldName}_op=in&{$criteriaFieldName}_value={$value}", $this->_absoluteUrl
);
2478 $row[$selectedField . '_link'] = $url;
2479 $row[$selectedField . '_hover'] = ts("%1 for this country.", [
2482 $countries = CRM_Core_PseudoConstant
::country($value, FALSE);
2483 if (!is_array($countries)) {
2491 * @param $selectedfield
2492 * @param $criteriaFieldName
2496 protected function alterCountyID($value, &$row, $selectedfield, $criteriaFieldName) {
2497 $url = CRM_Utils_System
::url(CRM_Utils_System
::currentPath(), "reset=1&force=1&{$criteriaFieldName}_op=in&{$criteriaFieldName}_value={$value}", $this->_absoluteUrl
);
2498 $row[$selectedfield . '_link'] = $url;
2499 $row[$selectedfield . '_hover'] = ts("%1 for this county.", [
2502 $counties = CRM_Core_PseudoConstant
::county($value, FALSE);
2503 if (!is_array($counties)) {
2511 * @param $selectedfield
2512 * @param $criteriaFieldName
2516 protected function alterLocationTypeID($value, &$row, $selectedfield, $criteriaFieldName) {
2517 return CRM_Core_PseudoConstant
::getLabel('CRM_Core_DAO_Address', 'location_type_id', $value);
2527 protected function alterContactID($value, &$row, $fieldname) {
2528 $nameField = substr($fieldname, 0, -2) . 'name';
2529 static $first = TRUE;
2530 static $viewContactList = FALSE;
2532 $viewContactList = CRM_Core_Permission
::check('access CiviCRM');
2535 if (!$viewContactList) {
2538 if (array_key_exists($nameField, $row)) {
2539 $row[$nameField . '_link'] = CRM_Utils_System
::url("civicrm/contact/view", 'reset=1&cid=' . $value, $this->_absoluteUrl
);
2542 $row[$fieldname . '_link'] = CRM_Utils_System
::url("civicrm/contact/view", 'reset=1&cid=' . $value, $this->_absoluteUrl
);
2554 protected function alterCommunicationtMethod($value, &$row, $fieldname) {
2555 $communicationMethods = CRM_Core_PseudoConstant
::get('CRM_Contact_DAO_Contact', 'preferred_communication_method');
2557 // Explode padded values.
2558 $values = CRM_utils_array
::explodePadded($value);
2559 // Flip values, compute intersection with $communicationMethods, and implode with commas.
2560 $value = implode(', ', array_intersect_key($communicationMethods, array_flip($values)));
2569 protected function alterBoolean($value) {
2570 $options = [0 => '', 1 => ts('Yes')];
2571 if (isset($options[$value])) {
2572 return $options[$value];
2580 * @param array $rows
2582 public function buildChart(&$rows) {
2583 // override this method for building charts.
2586 // select() method below has been added recently (v3.3), and many of the report templates might
2587 // still be having their own select() method. We should fix them as and when encountered and move
2588 // towards generalizing the select() method below.
2591 * Generate the SELECT clause and set class variable $_select.
2593 public function select() {
2594 $select = $this->_selectAliases
= [];
2595 $this->storeGroupByArray();
2597 foreach ($this->_columns
as $tableName => $table) {
2598 if (array_key_exists('fields', $table)) {
2599 foreach ($table['fields'] as $fieldName => $field) {
2600 if ($tableName == 'civicrm_address') {
2601 // deprecated, use $this->isTableSelected.
2602 $this->_addressField
= TRUE;
2604 if ($tableName == 'civicrm_email') {
2605 $this->_emailField
= TRUE;
2607 if ($tableName == 'civicrm_phone') {
2608 $this->_phoneField
= TRUE;
2611 if (!empty($field['required']) ||
2612 !empty($this->_params
['fields'][$fieldName])
2615 // 1. In many cases we want select clause to be built in slightly different way
2616 // for a particular field of a particular type.
2617 // 2. This method when used should receive params by reference and modify $this->_columnHeaders
2619 $selectClause = $this->selectClause($tableName, 'fields', $fieldName, $field);
2620 if ($selectClause) {
2621 $select[] = $selectClause;
2625 // include statistics columns only if set
2626 if (!empty($field['statistics']) && !empty($this->_groupByArray
)) {
2627 $select = $this->addStatisticsToSelect($field, $tableName, $fieldName, $select);
2631 $selectClause = $this->getSelectClauseWithGroupConcatIfNotGroupedBy($tableName, $fieldName, $field);
2632 if ($selectClause) {
2633 $select[] = $selectClause;
2636 $select = $this->addBasicFieldToSelect($tableName, $fieldName, $field, $select);
2643 // select for group bys
2644 if (array_key_exists('group_bys', $table)) {
2645 foreach ($table['group_bys'] as $fieldName => $field) {
2647 if ($tableName == 'civicrm_address') {
2648 $this->_addressField
= TRUE;
2650 if ($tableName == 'civicrm_email') {
2651 $this->_emailField
= TRUE;
2653 if ($tableName == 'civicrm_phone') {
2654 $this->_phoneField
= TRUE;
2656 // 1. In many cases we want select clause to be built in slightly different way
2657 // for a particular field of a particular type.
2658 // 2. This method when used should receive params by reference and modify $this->_columnHeaders
2660 $selectClause = $this->selectClause($tableName, 'group_bys', $fieldName, $field);
2661 if ($selectClause) {
2662 $select[] = $selectClause;
2666 if (!empty($this->_params
['group_bys']) &&
2667 !empty($this->_params
['group_bys'][$fieldName]) &&
2668 !empty($this->_params
['group_bys_freq'])
2670 switch (CRM_Utils_Array
::value($fieldName, $this->_params
['group_bys_freq'])) {
2672 $select[] = "DATE_SUB({$field['dbAlias']}, INTERVAL WEEKDAY({$field['dbAlias']}) DAY) AS {$tableName}_{$fieldName}_start";
2673 $select[] = "YEARWEEK({$field['dbAlias']}) AS {$tableName}_{$fieldName}_subtotal";
2674 $select[] = "WEEKOFYEAR({$field['dbAlias']}) AS {$tableName}_{$fieldName}_interval";
2675 $field['title'] = 'Week';
2679 $select[] = "MAKEDATE(YEAR({$field['dbAlias']}), 1) AS {$tableName}_{$fieldName}_start";
2680 $select[] = "YEAR({$field['dbAlias']}) AS {$tableName}_{$fieldName}_subtotal";
2681 $select[] = "YEAR({$field['dbAlias']}) AS {$tableName}_{$fieldName}_interval";
2682 $field['title'] = 'Year';
2686 $select[] = "DATE_SUB({$field['dbAlias']}, INTERVAL (DAYOFMONTH({$field['dbAlias']})-1) DAY) as {$tableName}_{$fieldName}_start";
2687 $select[] = "MONTH({$field['dbAlias']}) AS {$tableName}_{$fieldName}_subtotal";
2688 $select[] = "MONTHNAME({$field['dbAlias']}) AS {$tableName}_{$fieldName}_interval";
2689 $field['title'] = 'Month';
2693 $select[] = "STR_TO_DATE(CONCAT( 3 * QUARTER( {$field['dbAlias']} ) -2 , '/', '1', '/', YEAR( {$field['dbAlias']} ) ), '%m/%d/%Y') AS {$tableName}_{$fieldName}_start";
2694 $select[] = "QUARTER({$field['dbAlias']}) AS {$tableName}_{$fieldName}_subtotal";
2695 $select[] = "QUARTER({$field['dbAlias']}) AS {$tableName}_{$fieldName}_interval";
2696 $field['title'] = 'Quarter';
2699 // for graphs and charts -
2700 if (!empty($this->_params
['group_bys_freq'][$fieldName])) {
2701 $this->_interval
= $field['title'];
2702 $this->_columnHeaders
["{$tableName}_{$fieldName}_start"]['title']
2703 = $field['title'] . ' Beginning';
2704 $this->_columnHeaders
["{$tableName}_{$fieldName}_start"]['type'] = $field['type'];
2705 $this->_columnHeaders
["{$tableName}_{$fieldName}_start"]['group_by'] = $this->_params
['group_bys_freq'][$fieldName];
2707 // just to make sure these values are transferred to rows.
2708 // since we 'll need them for calculation purpose,
2709 // e.g making subtotals look nicer or graphs
2710 $this->_columnHeaders
["{$tableName}_{$fieldName}_interval"] = ['no_display' => TRUE];
2711 $this->_columnHeaders
["{$tableName}_{$fieldName}_subtotal"] = ['no_display' => TRUE];
2718 if (empty($select)) {
2719 // CRM-21412 Do not give fatal error on report when no fields selected
2723 $this->_selectClauses
= $select;
2724 $this->_select
= "SELECT " . implode(', ', $select) . " ";
2728 * Build select clause for a single field.
2730 * @param string $tableName
2731 * @param string $tableKey
2732 * @param string $fieldName
2733 * @param string $field
2737 public function selectClause(&$tableName, $tableKey, &$fieldName, &$field) {
2738 if (!empty($field['pseudofield'])) {
2739 $alias = "{$tableName}_{$fieldName}";
2740 $this->_columnHeaders
["{$tableName}_{$fieldName}"]['title'] = $field['title'] ??
NULL;
2741 $this->_columnHeaders
["{$tableName}_{$fieldName}"]['type'] = $field['type'] ??
NULL;
2742 $this->_columnHeaders
["{$tableName}_{$fieldName}"]['dbAlias'] = $field['dbAlias'] ??
NULL;
2743 $this->_selectAliases
[] = $alias;
2744 return ' 1 as ' . $alias;
2750 * Build where clause.
2752 public function where() {
2753 $this->storeWhereHavingClauseArray();
2755 if (empty($this->_whereClauses
)) {
2756 $this->_where
= "WHERE ( 1 ) ";
2757 $this->_having
= "";
2760 $this->_where
= "WHERE " . implode(' AND ', $this->_whereClauses
);
2763 if ($this->_aclWhere
) {
2764 $this->_where
.= " AND {$this->_aclWhere} ";
2767 if (!empty($this->_havingClauses
)) {
2768 // use this clause to construct group by clause.
2769 $this->_having
= "HAVING " . implode(' AND ', $this->_havingClauses
);
2774 * Store Where clauses into an array.
2776 * Breaking out this step makes over-riding more flexible as the clauses can be used in constructing a
2777 * temp table that may not be part of the final where clause or added
2778 * in other functions
2780 public function storeWhereHavingClauseArray() {
2781 foreach ($this->_columns
as $tableName => $table) {
2782 if (array_key_exists('filters', $table)) {
2783 foreach ($table['filters'] as $fieldName => $field) {
2784 // respect pseudofield to filter spec so fields can be marked as
2785 // not to be handled here
2786 if (!empty($field['pseudofield'])) {
2789 $clause = $this->generateFilterClause($field, $fieldName);
2791 if (!empty($clause)) {
2792 if (!empty($field['having'])) {
2793 $this->_havingClauses
[] = $clause;
2796 $this->_whereClauses
[] = $clause;
2808 public function processReportMode() {
2809 $this->setOutputMode();
2812 = CRM_Utils_Request
::retrieve(
2815 CRM_Core_DAO
::$_nullObject
2818 $this->_absoluteUrl
= FALSE;
2820 $this->assign('printOnly', FALSE);
2822 if ($this->_outputMode
== 'print' ||
2823 ($this->_sendmail
&& !$this->_outputMode
)
2825 $this->assign('printOnly', TRUE);
2827 $this->addPaging
= FALSE;
2828 $this->assign('outputMode', 'print');
2829 $this->_outputMode
= 'print';
2830 if ($this->_sendmail
) {
2831 $this->_absoluteUrl
= TRUE;
2834 elseif ($this->_outputMode
== 'pdf') {
2836 $this->addPaging
= FALSE;
2837 $this->_absoluteUrl
= TRUE;
2839 elseif ($this->_outputMode
== 'csv') {
2841 $this->_absoluteUrl
= TRUE;
2842 $this->addPaging
= FALSE;
2844 elseif ($this->_outputMode
== 'group') {
2845 $this->assign('outputMode', 'group');
2847 elseif ($this->_outputMode
== 'create_report' && $this->_criteriaForm
) {
2848 $this->assign('outputMode', 'create_report');
2850 elseif ($this->_outputMode
== 'copy' && $this->_criteriaForm
) {
2851 $this->_createNew
= TRUE;
2854 $this->assign('outputMode', $this->_outputMode
);
2855 $this->assign('printOnly', $printOnly);
2856 // Get today's date to include in printed reports
2858 $reportDate = CRM_Utils_Date
::customFormat(date('Y-m-d H:i'));
2859 $this->assign('reportDate', $reportDate);
2864 * Post Processing function for Form.
2866 * postProcessCommon should be used to set other variables from input as the api accesses that function.
2867 * This function is not accessed when the api calls the report.
2869 public function beginPostProcess() {
2870 $this->setParams($this->controller
->exportValues($this->_name
));
2871 if (empty($this->_params
) &&
2874 $this->setParams($this->_formValues
);
2877 // hack to fix params when submitted from dashboard, CRM-8532
2878 // fields array is missing because form building etc is skipped
2879 // in dashboard mode for report
2880 //@todo - this could be done in the dashboard no we have a setter
2881 if (empty($this->_params
['fields']) && !$this->_noFields
) {
2882 $this->setParams($this->_formValues
);
2885 $this->processReportMode();
2887 if ($this->_outputMode
== 'save' ||
$this->_outputMode
== 'copy') {
2888 $this->_createNew
= ($this->_outputMode
== 'copy');
2889 CRM_Report_Form_Instance
::postProcess($this);
2891 if ($this->_outputMode
== 'delete') {
2892 CRM_Report_BAO_ReportInstance
::doFormDelete($this->_id
, 'civicrm/report/list?reset=1', 'civicrm/report/list?reset=1');
2895 $this->_formValues
= $this->_params
;
2897 $this->beginPostProcessCommon();
2901 * BeginPostProcess function run in both report mode and non-report mode (api).
2903 public function beginPostProcessCommon() {
2907 * Build the report query.
2909 * @param bool $applyLimit
2913 public function buildQuery($applyLimit = TRUE) {
2914 $this->buildGroupTempTable();
2917 $this->customDataFrom();
2918 $this->buildPermissionClause();
2923 foreach ($this->unselectedOrderByColumns() as $alias => $field) {
2924 $clause = $this->getSelectClauseWithGroupConcatIfNotGroupedBy($field['table_name'], $field['name'], $field);
2926 $clause = "{$field['dbAlias']} as {$alias}";
2928 $this->_select
.= ", $clause ";
2931 if ($applyLimit && empty($this->_params
['charts'])) {
2934 CRM_Utils_Hook
::alterReportVar('sql', $this, $this);
2936 $sql = "{$this->_select} {$this->_from} {$this->_where} {$this->_groupBy} {$this->_having} {$this->_orderBy} {$this->_limit}";
2937 $this->addToDeveloperTab($sql);
2942 * Build group by clause.
2944 public function groupBy() {
2945 $this->storeGroupByArray();
2947 if (!empty($this->_groupByArray
)) {
2948 if ($this->optimisedForOnlyFullGroupBy
) {
2949 // We should probably deprecate this code path. What happens here is that
2950 // the group by is amended to reflect the select columns. This often breaks the
2951 // results. Retrofitting group strict group by onto existing report classes
2953 $this->_groupBy
= CRM_Contact_BAO_Query
::getGroupByFromSelectColumns($this->_selectClauses
, $this->_groupByArray
);
2956 $this->_groupBy
= ' GROUP BY ' . implode($this->_groupByArray
);
2962 * Build order by clause.
2964 public function orderBy() {
2965 $this->_orderBy
= "";
2966 $this->_sections
= [];
2967 $this->storeOrderByArray();
2968 if (!empty($this->_orderByArray
) && !$this->_rollup
== 'WITH ROLLUP') {
2969 $this->_orderBy
= "ORDER BY " . implode(', ', $this->_orderByArray
);
2971 $this->assign('sections', $this->_sections
);
2975 * Extract order by fields and store as an array.
2977 * In some cases other functions want to know which fields are selected for ordering by
2978 * Separating this into a separate function allows it to be called separately from constructing
2979 * the order by clause
2981 public function storeOrderByArray() {
2984 if (!empty($this->_params
['order_bys']) &&
2985 is_array($this->_params
['order_bys']) &&
2986 !empty($this->_params
['order_bys'])
2989 // Process order_bys in user-specified order
2990 foreach ($this->_params
['order_bys'] as $orderBy) {
2992 foreach ($this->_columns
as $tableName => $table) {
2993 if (array_key_exists('order_bys', $table)) {
2994 // For DAO columns defined in $this->_columns
2995 $fields = $table['order_bys'];
2997 elseif (array_key_exists('extends', $table)) {
2998 // For custom fields referenced in $this->_customGroupExtends
2999 $fields = CRM_Utils_Array
::value('fields', $table, []);
3004 if (!empty($fields) && is_array($fields)) {
3005 foreach ($fields as $fieldName => $field) {
3006 if ($fieldName == $orderBy['column']) {
3007 $orderByField = array_merge($field, $orderBy);
3008 $orderByField['tplField'] = "{$tableName}_{$fieldName}";
3015 if (!empty($orderByField)) {
3016 $this->_orderByFields
[$orderByField['tplField']] = $orderByField;
3017 if ($this->groupConcatTested
) {
3018 $orderBys[$orderByField['tplField']] = "{$orderByField['tplField']} {$orderBy['order']}";
3021 // Not sure when this is preferable to using tplField (which has
3022 // definitely been tested to work in cases then this does not.
3023 // in caution not switching unless report has been tested for
3024 // group concat functionality.
3025 $orderBys[$orderByField['tplField']] = "{$orderByField['dbAlias']} {$orderBy['order']}";
3028 // Record any section headers for assignment to the template
3029 if (!empty($orderBy['section'])) {
3030 $orderByField['pageBreak'] = $orderBy['pageBreak'] ??
NULL;
3031 $this->_sections
[$orderByField['tplField']] = $orderByField;
3037 $this->_orderByArray
= $orderBys;
3039 $this->assign('sections', $this->_sections
);
3043 * Determine unselected columns.
3047 public function unselectedOrderByColumns() {
3048 return array_diff_key($this->_orderByFields
, $this->getSelectColumns());
3052 * Determine unselected columns.
3056 public function unselectedSectionColumns() {
3057 if (is_array($this->_sections
)) {
3058 return array_diff_key($this->_sections
, $this->getSelectColumns());
3066 * Build output rows.
3068 * @param string $sql
3069 * @param array $rows
3071 public function buildRows($sql, &$rows) {
3072 if (!$this->optimisedForOnlyFullGroupBy
) {
3073 CRM_Core_DAO
::disableFullGroupByMode();
3075 $dao = CRM_Core_DAO
::executeQuery($sql);
3076 if (stristr($this->_select
, 'SQL_CALC_FOUND_ROWS')) {
3077 $this->_rowsFound
= CRM_Core_DAO
::singleValueQuery('SELECT FOUND_ROWS()');
3079 CRM_Core_DAO
::reenableFullGroupByMode();
3080 if (!is_array($rows)) {
3084 // use this method to modify $this->_columnHeaders
3085 $this->modifyColumnHeaders();
3087 $unselectedSectionColumns = $this->unselectedSectionColumns();
3089 while ($dao->fetch()) {
3091 foreach ($this->_columnHeaders
as $key => $value) {
3092 if (property_exists($dao, $key)) {
3093 $row[$key] = $dao->$key;
3097 // section headers not selected for display need to be added to row
3098 foreach ($unselectedSectionColumns as $key => $values) {
3099 if (property_exists($dao, $key)) {
3100 $row[$key] = $dao->$key;
3109 * Calculate section totals.
3111 * When "order by" fields are marked as sections, this assigns to the template
3112 * an array of total counts for each section. This data is used by the Smarty
3113 * plugin {sectionTotal}.
3115 public function sectionTotals() {
3117 // Reports using order_bys with sections must populate $this->_selectAliases in select() method.
3118 if (empty($this->_selectAliases
)) {
3122 if (!empty($this->_sections
)) {
3123 // build the query with no LIMIT clause
3124 $select = str_ireplace('SELECT SQL_CALC_FOUND_ROWS ', 'SELECT ', $this->_select
);
3125 $sql = "{$select} {$this->_from} {$this->_where} {$this->_groupBy} {$this->_having} {$this->_orderBy}";
3127 // pull section aliases out of $this->_sections
3128 $sectionAliases = array_keys($this->_sections
);
3131 foreach (array_merge($sectionAliases, $this->_selectAliases
) as $alias) {
3132 $ifnulls[] = "ifnull($alias, '') as $alias";
3134 $this->_select
= "SELECT " . implode(", ", $ifnulls);
3135 $this->_select
= CRM_Contact_BAO_Query
::appendAnyValueToSelect($ifnulls, $sectionAliases);
3137 // Group (un-limited) report by all aliases and get counts. This might
3138 // be done more efficiently when the contents of $sql are known, ie. by
3139 // overriding this method in the report class.
3141 $query = $this->_select
.
3142 ", count(*) as ct from ($sql) as subquery group by " .
3143 implode(", ", $sectionAliases);
3145 // initialize array of total counts
3147 $dao = CRM_Core_DAO
::executeQuery($query);
3148 while ($dao->fetch()) {
3150 // let $this->_alterDisplay translate any integer ids to human-readable values.
3151 $rows[0] = $dao->toArray();
3152 $this->alterDisplay($rows);
3155 // add totals for all permutations of section values
3158 $aliasCount = count($sectionAliases);
3159 foreach ($sectionAliases as $alias) {
3160 $values[] = $row[$alias];
3161 $key = implode(CRM_Core_DAO
::VALUE_SEPARATOR
, $values);
3162 if ($i == $aliasCount) {
3163 // the last alias is the lowest-level section header; use count as-is
3164 $totals[$key] = $dao->ct
;
3167 // other aliases are higher level; roll count into their total
3168 $totals[$key] +
= $dao->ct
;
3172 $this->assign('sectionTotals', $totals);
3177 * Modify column headers.
3179 public function modifyColumnHeaders() {
3180 // use this method to modify $this->_columnHeaders
3184 * Move totals columns to the right edge of the table.
3186 * It seems like a more logical layout to have any totals columns on the far right regardless of
3187 * the location of the rest of their table.
3189 public function moveSummaryColumnsToTheRightHandSide() {
3190 $statHeaders = (array_intersect_key($this->_columnHeaders
, array_flip($this->_statFields
)));
3191 $this->_columnHeaders
= array_merge(array_diff_key($this->_columnHeaders
, $statHeaders), $this->_columnHeaders
, $statHeaders);
3195 * Assign rows to the template.
3197 * @param array $rows
3199 public function doTemplateAssignment(&$rows) {
3200 $this->assign_by_ref('columnHeaders', $this->_columnHeaders
);
3201 $this->assign_by_ref('rows', $rows);
3202 $this->assign('statistics', $this->statistics($rows));
3206 * Build report statistics.
3208 * Override this method to build your own statistics.
3210 * @param array $rows
3214 public function statistics(&$rows) {
3217 $count = count($rows);
3218 // Why do we increment the count for rollup seems to artificially inflate the count.
3219 // It seems perhaps intentional to include the summary row in the count of results - although
3220 // this just seems odd.
3221 if ($this->_rollup
&& ($this->_rollup
!= '') && $this->_grandFlag
) {
3225 $this->countStat($statistics, $count);
3227 $this->groupByStat($statistics);
3229 $this->filterStat($statistics);
3235 * Add count statistics.
3237 * @param array $statistics
3240 public function countStat(&$statistics, $count) {
3241 $statistics['counts']['rowCount'] = [
3242 'title' => ts('Row(s) Listed'),
3246 if ($this->_rowsFound
&& ($this->_rowsFound
> $count)) {
3247 $statistics['counts']['rowsFound'] = [
3248 'title' => ts('Total Row(s)'),
3249 'value' => $this->_rowsFound
,
3255 * Add group by statistics.
3257 * @param array $statistics
3259 public function groupByStat(&$statistics) {
3260 if (!empty($this->_params
['group_bys']) &&
3261 is_array($this->_params
['group_bys']) &&
3262 !empty($this->_params
['group_bys'])
3264 foreach ($this->_columns
as $tableName => $table) {
3265 if (array_key_exists('group_bys', $table)) {
3266 foreach ($table['group_bys'] as $fieldName => $field) {
3267 if (!empty($this->_params
['group_bys'][$fieldName])) {
3268 $combinations[] = $field['title'];
3273 $statistics['groups'][] = [
3274 'title' => ts('Grouping(s)'),
3275 'value' => implode(' & ', $combinations),
3281 * Filter statistics.
3283 * @param array $statistics
3285 public function filterStat(&$statistics) {
3286 foreach ($this->_columns
as $tableName => $table) {
3287 if (array_key_exists('filters', $table)) {
3288 foreach ($table['filters'] as $fieldName => $field) {
3289 if ((CRM_Utils_Array
::value('type', $field) & CRM_Utils_Type
::T_DATE ||
3290 CRM_Utils_Array
::value('type', $field) & CRM_Utils_Type
::T_TIME
) &&
3291 CRM_Utils_Array
::value('operatorType', $field) !=
3292 CRM_Report_Form
::OP_MONTH
3294 $from = $this->_params
["{$fieldName}_from"] ??
NULL;
3295 $to = $this->_params
["{$fieldName}_to"] ??
NULL;
3296 if (!empty($this->_params
["{$fieldName}_relative"])) {
3297 list($from, $to) = CRM_Utils_Date
::getFromTo($this->_params
["{$fieldName}_relative"], NULL, NULL);
3302 $from = date('l j F Y, g:iA', strtotime($from));
3305 $to = date('l j F Y, g:iA', strtotime($to));
3307 $statistics['filters'][] = [
3308 'title' => $field['title'],
3309 'value' => ts("Between %1 and %2", [1 => $from, 2 => $to]),
3312 elseif (in_array($rel = CRM_Utils_Array
::value("{$fieldName}_relative", $this->_params
),
3313 array_keys($this->getOperationPair(CRM_Report_Form
::OP_DATE
))
3315 $pair = $this->getOperationPair(CRM_Report_Form
::OP_DATE
);
3316 $statistics['filters'][] = [
3317 'title' => $field['title'],
3318 'value' => $pair[$rel],
3323 $op = $this->_params
["{$fieldName}_op"] ??
NULL;
3326 $pair = $this->getOperationPair(
3327 CRM_Utils_Array
::value('operatorType', $field),
3330 $min = $this->_params
["{$fieldName}_min"] ??
NULL;
3331 $max = $this->_params
["{$fieldName}_max"] ??
NULL;
3332 $val = $this->_params
["{$fieldName}_value"] ??
NULL;
3333 if (in_array($op, ['bw', 'nbw']) && ($min ||
$max)) {
3334 $value = "{$pair[$op]} $min " . ts('and') . " $max";
3336 elseif ($val && CRM_Utils_Array
::value('operatorType', $field) & self
::OP_ENTITYREF
) {
3337 $this->setEntityRefDefaults($field, $tableName);
3338 $result = civicrm_api3($field['attributes']['entity'], 'getlist',
3340 CRM_Utils_Array
::value('api', $field['attributes'], []));
3342 foreach ($result['values'] as $v) {
3343 $values[] = $v['label'];
3345 $value = "{$pair[$op]} " . implode(', ', $values);
3347 elseif ($op == 'nll' ||
$op == 'nnll') {
3348 $value = $pair[$op];
3350 elseif (is_array($val) && (!empty($val))) {
3351 $options = CRM_Utils_Array
::value('options', $field, []);
3352 foreach ($val as $key => $valIds) {
3353 if (isset($options[$valIds])) {
3354 $val[$key] = $options[$valIds];
3357 $pair[$op] = (count($val) == 1) ?
(($op == 'notin' ||
$op ==
3358 'mnot') ?
ts('Is Not') : ts('Is')) : CRM_Utils_Array
::value($op, $pair);
3359 $val = implode(', ', $val);
3360 $value = "{$pair[$op]} " . $val;
3362 elseif (!is_array($val) && (!empty($val) ||
$val == '0') &&
3363 isset($field['options']) &&
3364 is_array($field['options']) && !empty($field['options'])
3366 $value = CRM_Utils_Array
::value($op, $pair) . " " .
3367 CRM_Utils_Array
::value($val, $field['options'], $val);
3370 $value = CRM_Utils_Array
::value($op, $pair) . " " . $val;
3373 if ($value && empty($field['no_display'])) {
3374 $statistics['filters'][] = [
3375 'title' => $field['title'] ??
NULL,
3376 'value' => CRM_Utils_String
::htmlToText($value),
3386 * End post processing.
3388 * @param array|null $rows
3390 public function endPostProcess(&$rows = NULL) {
3391 $this->assign('report_class', get_class($this));
3392 if ($this->_storeResultSet
) {
3393 $this->_resultSet
= $rows;
3396 if ($this->_outputMode
== 'print' ||
3397 $this->_outputMode
== 'pdf' ||
3401 $content = $this->compileContent();
3402 $url = CRM_Utils_System
::url("civicrm/report/instance/{$this->_id}",
3406 if ($this->_sendmail
) {
3407 $config = CRM_Core_Config
::singleton();
3410 if ($this->_outputMode
== 'csv') {
3412 = $this->_formValues
['report_header'] . '<p>' . ts('Report URL') .
3413 ": {$url}</p>" . '<p>' .
3414 ts('The report is attached as a CSV file.') . '</p>' .
3415 $this->_formValues
['report_footer'];
3417 $csvFullFilename = $config->templateCompileDir
.
3418 CRM_Utils_File
::makeFileName('CiviReport.csv');
3419 $csvContent = CRM_Report_Utils_Report
::makeCsv($this, $rows);
3420 file_put_contents($csvFullFilename, $csvContent);
3422 'fullPath' => $csvFullFilename,
3423 'mime_type' => 'text/csv',
3424 'cleanName' => 'CiviReport.csv',
3427 if ($this->_outputMode
== 'pdf') {
3428 // generate PDF content
3429 $pdfFullFilename = $config->templateCompileDir
.
3430 CRM_Utils_File
::makeFileName('CiviReport.pdf');
3431 file_put_contents($pdfFullFilename,
3432 CRM_Utils_PDF_Utils
::html2pdf($content, "CiviReport.pdf",
3433 TRUE, ['orientation' => 'landscape']
3436 // generate Email Content
3438 = $this->_formValues
['report_header'] . '<p>' . ts('Report URL') .
3439 ": {$url}</p>" . '<p>' .
3440 ts('The report is attached as a PDF file.') . '</p>' .
3441 $this->_formValues
['report_footer'];
3444 'fullPath' => $pdfFullFilename,
3445 'mime_type' => 'application/pdf',
3446 'cleanName' => 'CiviReport.pdf',
3450 if (CRM_Report_Utils_Report
::mailReport($content, $this->_id
,
3451 $this->_outputMode
, $attachments
3454 CRM_Core_Session
::setStatus(ts("Report mail has been sent."), ts('Sent'), 'success');
3457 CRM_Core_Session
::setStatus(ts("Report mail could not be sent."), ts('Mail Error'), 'error');
3461 elseif ($this->_outputMode
== 'print') {
3465 // Nb. Once upon a time we used a package called Open Flash Charts to
3466 // draw charts, and we had a feature whereby a browser could send the
3467 // server a PNG version of the chart, which could then be included in a
3468 // PDF by including <img> tags in the HTML for the conversion below.
3470 // This feature stopped working when browsers stopped supporting Flash,
3471 // and although we have a different client-side charting library in
3472 // place, we decided not to reimplement the (rather convoluted)
3473 // browser-sending-rendered-chart-to-server process.
3475 // If this feature is required in future we should find a better way to
3476 // render charts on the server side, e.g. server-created SVG.
3477 CRM_Utils_PDF_Utils
::html2pdf($content, "CiviReport.pdf", FALSE, ['orientation' => 'landscape']);
3479 CRM_Utils_System
::civiExit();
3481 elseif ($this->_outputMode
== 'csv') {
3482 CRM_Report_Utils_Report
::export2csv($this, $rows);
3484 elseif ($this->_outputMode
== 'group') {
3485 $group = $this->_params
['groups'];
3486 $this->add2group($group);
3491 * Set store result set indicator to TRUE.
3493 * @todo explain what this does
3495 public function storeResultSet() {
3496 $this->_storeResultSet
= TRUE;
3504 public function getResultSet() {
3505 return $this->_resultSet
;
3509 * Get the sql used to generate the report.
3513 public function getReportSql() {
3514 return $this->sqlArray
;
3518 * Use the form name to create the tpl file name.
3522 public function getTemplateFileName() {
3523 $defaultTpl = parent
::getTemplateFileName();
3524 $template = CRM_Core_Smarty
::singleton();
3525 if (!$template->template_exists($defaultTpl)) {
3526 $defaultTpl = 'CRM/Report/Form.tpl';
3532 * Compile the report content.
3534 * Although this function is super-short it is useful to keep separate so it can be over-ridden by report classes.
3538 public function compileContent() {
3539 $templateFile = $this->getHookedTemplateFileName();
3540 return CRM_Utils_Array
::value('report_header', $this->_formValues
) .
3541 CRM_Core_Form
::$_template->fetch($templateFile) .
3542 CRM_Utils_Array
::value('report_footer', $this->_formValues
);
3546 * Post process function.
3548 public function postProcess() {
3549 // get ready with post process params
3550 $this->beginPostProcess();
3553 $sql = $this->buildQuery();
3555 // build array of result based on column headers. This method also allows
3556 // modifying column headers before using it to build result set i.e $rows.
3558 $this->buildRows($sql, $rows);
3560 // format result set.
3561 $this->formatDisplay($rows);
3563 // assign variables to templates
3564 $this->doTemplateAssignment($rows);
3566 // do print / pdf / instance stuff if needed
3567 $this->endPostProcess($rows);
3573 * @param int $rowCount
3577 public function limit($rowCount = self
::ROW_COUNT_LIMIT
) {
3578 // lets do the pager if in html mode
3579 $this->_limit
= NULL;
3581 // CRM-14115, over-ride row count if rowCount is specified in URL
3582 if ($this->_dashBoardRowCount
) {
3583 $rowCount = $this->_dashBoardRowCount
;
3585 if ($this->addPaging
) {
3586 $this->_select
= preg_replace('/SELECT(\s+SQL_CALC_FOUND_ROWS)?\s+/i', 'SELECT SQL_CALC_FOUND_ROWS ', $this->_select
);
3588 $pageId = CRM_Utils_Request
::retrieve('crmPID', 'Integer');
3590 // @todo all http vars should be extracted in the preProcess
3591 // - not randomly in the class
3592 if (!$pageId && !empty($_POST)) {
3593 if (isset($_POST['PagerBottomButton']) && isset($_POST['crmPID_B'])) {
3594 $pageId = max((int) $_POST['crmPID_B'], 1);
3596 elseif (isset($_POST['PagerTopButton']) && isset($_POST['crmPID'])) {
3597 $pageId = max((int) $_POST['crmPID'], 1);
3599 unset($_POST['crmPID_B'], $_POST['crmPID']);
3602 $pageId = $pageId ?
$pageId : 1;
3603 $this->set(CRM_Utils_Pager
::PAGE_ID
, $pageId);
3604 $offset = ($pageId - 1) * $rowCount;
3606 $offset = CRM_Utils_Type
::escape($offset, 'Int');
3607 $rowCount = CRM_Utils_Type
::escape($rowCount, 'Int');
3609 $this->_limit
= " LIMIT $offset, $rowCount";
3610 return [$offset, $rowCount];
3612 if ($this->_limitValue
) {
3613 if ($this->_offsetValue
) {
3614 $this->_limit
= " LIMIT {$this->_offsetValue}, {$this->_limitValue} ";
3617 $this->_limit
= " LIMIT " . $this->_limitValue
;
3625 * @param int $rowCount
3627 public function setPager($rowCount = self
::ROW_COUNT_LIMIT
) {
3628 // CRM-14115, over-ride row count if rowCount is specified in URL
3629 if ($this->_dashBoardRowCount
) {
3630 $rowCount = $this->_dashBoardRowCount
;
3633 if ($this->_limit
&& ($this->_limit
!= '')) {
3634 if (!$this->_rowsFound
) {
3635 $sql = "SELECT FOUND_ROWS();";
3636 $this->_rowsFound
= CRM_Core_DAO
::singleValueQuery($sql);
3639 'total' => $this->_rowsFound
,
3640 'rowCount' => $rowCount,
3641 'status' => ts('Records') . ' %%StatusMessage%%',
3642 'buttonBottom' => 'PagerBottomButton',
3643 'buttonTop' => 'PagerTopButton',
3645 if (!empty($this->controller
)) {
3646 // This happens when being called from the api Really we want the api to be able to
3647 // pass paging parameters, but at this stage just preventing test crashes.
3648 $params['pageID'] = $this->get(CRM_Utils_Pager
::PAGE_ID
);
3651 $pager = new CRM_Utils_Pager($params);
3652 $this->assign_by_ref('pager', $pager);
3653 $this->ajaxResponse
['totalRows'] = $this->_rowsFound
;
3658 * Build a group filter with contempt for large data sets.
3660 * This function has been retained as it takes time to migrate the reports over
3661 * to the new method which will not crash on large datasets.
3665 * @param string $field
3666 * @param mixed $value
3671 public function legacySlowGroupFilterClause($field, $value, $op) {
3672 $smartGroupQuery = "";
3674 $group = new CRM_Contact_DAO_Group();
3675 $group->is_active
= 1;
3678 while ($group->fetch()) {
3679 if (in_array($group->id
, (array) $this->_params
['gid_value']) &&
3680 $group->saved_search_id
3682 $smartGroups[] = $group->id
;
3686 CRM_Contact_BAO_GroupContactCache
::check($smartGroups);
3688 $smartGroupQuery = '';
3689 if (!empty($smartGroups)) {
3690 $smartGroups = implode(',', $smartGroups);
3691 $smartGroupQuery = " UNION DISTINCT
3692 SELECT DISTINCT smartgroup_contact.contact_id
3693 FROM civicrm_group_contact_cache smartgroup_contact
3694 WHERE smartgroup_contact.group_id IN ({$smartGroups}) ";
3697 $sqlOp = $this->getSQLOperator($op);
3698 if (!is_array($value)) {
3701 //include child groups if any
3702 $value = array_merge($value, CRM_Contact_BAO_Group
::getChildGroupIds($value));
3704 $clause = "{$field['dbAlias']} IN (" . implode(', ', $value) . ")";
3706 $contactAlias = $this->_aliases
['civicrm_contact'];
3707 if (!empty($this->relationType
) && $this->relationType
== 'b_a') {
3708 $contactAlias = $this->_aliases
['civicrm_contact_b'];
3710 return " {$contactAlias}.id {$sqlOp} (
3711 SELECT DISTINCT {$this->_aliases['civicrm_group']}.contact_id
3712 FROM civicrm_group_contact {$this->_aliases['civicrm_group']}
3713 WHERE {$clause} AND {$this->_aliases['civicrm_group']}.status = 'Added'
3714 {$smartGroupQuery} ) ";
3718 * Build where clause for groups.
3720 * @param string $field
3721 * @param mixed $value
3726 public function whereGroupClause($field, $value, $op) {
3727 if ($this->groupFilterNotOptimised
) {
3728 return $this->legacySlowGroupFilterClause($field, $value, $op);
3730 if ($op === 'notin') {
3731 return " group_temp_table.id IS NULL ";
3733 // We will have used an inner join instead.
3738 * Create a table of the contact ids included by the group filter.
3740 * This function is called by both the api (tests) and the UI.
3742 public function buildGroupTempTable() {
3743 if (!empty($this->groupTempTable
) ||
empty($this->_params
['gid_value']) ||
$this->groupFilterNotOptimised
) {
3746 $filteredGroups = (array) $this->_params
['gid_value'];
3748 $groups = civicrm_api3('Group', 'get', [
3750 'id' => ['IN' => $filteredGroups],
3751 'saved_search_id' => ['>' => 0],
3754 $smartGroups = array_keys($groups['values']);
3757 SELECT DISTINCT group_contact.contact_id as id
3758 FROM civicrm_group_contact group_contact
3759 WHERE group_contact.group_id IN (" . implode(', ', $filteredGroups) . ")
3760 AND group_contact.status = 'Added' ";
3762 if (!empty($smartGroups)) {
3763 CRM_Contact_BAO_GroupContactCache
::check($smartGroups);
3764 $smartGroups = implode(',', $smartGroups);
3767 SELECT smartgroup_contact.contact_id as id
3768 FROM civicrm_group_contact_cache smartgroup_contact
3769 WHERE smartgroup_contact.group_id IN ({$smartGroups}) ";
3772 $this->groupTempTable
= $this->createTemporaryTable('rptgrp', $query);
3773 CRM_Core_DAO
::executeQuery("ALTER TABLE $this->groupTempTable ADD INDEX i_id(id)");
3777 * Execute query and add it to the developer tab.
3779 * @param string $query
3780 * @param array $params
3782 * @return \CRM_Core_DAO|object
3784 protected function executeReportQuery($query, $params = []) {
3785 $this->addToDeveloperTab($query);
3786 return CRM_Core_DAO
::executeQuery($query, $params);
3790 * Build where clause for tags.
3792 * @param string $field
3793 * @param mixed $value
3798 public function whereTagClause($field, $value, $op) {
3799 // not using left join in query because if any contact
3800 // belongs to more than one tag, results duplicate
3802 $sqlOp = $this->getSQLOperator($op);
3803 if (!is_array($value)) {
3806 $clause = "{$field['dbAlias']} IN (" . implode(', ', $value) . ")";
3807 $entity_table = $this->_tagFilterTable
;
3808 return " {$this->_aliases[$entity_table]}.id {$sqlOp} (
3809 SELECT DISTINCT {$this->_aliases['civicrm_tag']}.entity_id
3810 FROM civicrm_entity_tag {$this->_aliases['civicrm_tag']}
3811 WHERE entity_table = '$entity_table' AND {$clause} ) ";
3815 * Generate membership organization clause.
3817 * @param mixed $value
3818 * @param string $op SQL Operator
3822 public function whereMembershipOrgClause($value, $op) {
3823 $sqlOp = $this->getSQLOperator($op);
3824 if (!is_array($value)) {
3828 $tmp_membership_org_sql_list = implode(', ', $value);
3829 return " {$this->_aliases['civicrm_contact']}.id {$sqlOp} (
3830 SELECT DISTINCT mem.contact_id
3831 FROM civicrm_membership mem
3832 LEFT JOIN civicrm_membership_status mem_status ON mem.status_id = mem_status.id
3833 LEFT JOIN civicrm_membership_type mt ON mem.membership_type_id = mt.id
3834 WHERE mt.member_of_contact_id IN (" .
3835 $tmp_membership_org_sql_list . ")
3836 AND mt.is_active = '1'
3837 AND mem_status.is_current_member = '1'
3838 AND mem_status.is_active = '1' ) ";
3842 * Generate Membership Type SQL Clause.
3844 * @param mixed $value
3850 public function whereMembershipTypeClause($value, $op) {
3851 $sqlOp = $this->getSQLOperator($op);
3852 if (!is_array($value)) {
3856 $tmp_membership_sql_list = implode(', ', $value);
3857 return " {$this->_aliases['civicrm_contact']}.id {$sqlOp} (
3858 SELECT DISTINCT mem.contact_id
3859 FROM civicrm_membership mem
3860 LEFT JOIN civicrm_membership_status mem_status ON mem.status_id = mem_status.id
3861 LEFT JOIN civicrm_membership_type mt ON mem.membership_type_id = mt.id
3862 WHERE mem.membership_type_id IN (" .
3863 $tmp_membership_sql_list . ")
3864 AND mt.is_active = '1'
3865 AND mem_status.is_current_member = '1'
3866 AND mem_status.is_active = '1' ) ";
3870 * Buld contact acl clause
3871 * @deprecated in favor of buildPermissionClause
3873 * Note that if the buildPermissionClause function is called (which most reports do from
3874 * buildQuery then the results of this function are re-calculated and overwritten.
3876 * @param string $tableAlias
3878 public function buildACLClause($tableAlias = 'contact_a') {
3879 list($this->_aclFrom
, $this->_aclWhere
) = CRM_Contact_BAO_Contact_Permission
::cacheClause($tableAlias);
3883 * Build the permision clause for all entities in this report
3885 public function buildPermissionClause() {
3887 foreach ($this->selectedTables() as $tableName) {
3888 $baoName = str_replace('_DAO_', '_BAO_', CRM_Core_DAO_AllCoreTables
::getClassForTable($tableName));
3889 if ($baoName && class_exists($baoName) && !empty($this->_columns
[$tableName]['alias'])) {
3890 $tableAlias = $this->_columns
[$tableName]['alias'];
3891 $clauses = array_filter($baoName::getSelectWhereClause($tableAlias));
3892 foreach ($clauses as $field => $clause) {
3893 // Skip contact_id field if redundant
3894 if ($field != 'contact_id' ||
!in_array('civicrm_contact', $this->selectedTables())) {
3895 $ret["$tableName.$field"] = $clause;
3900 // Override output from buildACLClause
3901 $this->_aclFrom
= NULL;
3902 $this->_aclWhere
= implode(' AND ', $ret);
3906 * Add custom data to the columns.
3908 * @param bool $addFields
3909 * @param array $permCustomGroupIds
3911 public function addCustomDataToColumns($addFields = TRUE, $permCustomGroupIds = []) {
3912 if (empty($this->_customGroupExtends
)) {
3915 if (!is_array($this->_customGroupExtends
)) {
3916 $this->_customGroupExtends
= [$this->_customGroupExtends
];
3918 $customGroupWhere = '';
3919 if (!empty($permCustomGroupIds)) {
3920 $customGroupWhere = "cg.id IN (" . implode(',', $permCustomGroupIds) .
3924 SELECT cg.table_name, cg.title, cg.extends, cf.id as cf_id, cf.label,
3925 cf.column_name, cf.data_type, cf.html_type, cf.option_group_id, cf.time_format
3926 FROM civicrm_custom_group cg
3927 INNER JOIN civicrm_custom_field cf ON cg.id = cf.custom_group_id
3928 WHERE cg.extends IN ('" . implode("','", $this->_customGroupExtends
) . "') AND
3930 cg.is_active = 1 AND
3931 cf.is_active = 1 AND
3932 cf.is_searchable = 1
3933 ORDER BY cg.weight, cf.weight";
3934 $customDAO = CRM_Core_DAO
::executeQuery($sql);
3937 while ($customDAO->fetch()) {
3938 if ($customDAO->table_name
!= $curTable) {
3939 $curTable = $customDAO->table_name
;
3940 $curFields = $curFilters = [];
3943 $this->_columns
[$curTable]['dao'] = 'CRM_Contact_DAO_Contact';
3944 $this->_columns
[$curTable]['extends'] = $customDAO->extends;
3945 $this->_columns
[$curTable]['grouping'] = $customDAO->table_name
;
3946 $this->_columns
[$curTable]['group_title'] = $customDAO->title
;
3948 foreach (['fields', 'filters', 'group_bys'] as $colKey) {
3949 if (!array_key_exists($colKey, $this->_columns
[$curTable])) {
3950 $this->_columns
[$curTable][$colKey] = [];
3954 $fieldName = 'custom_' . $customDAO->cf_id
;
3957 // this makes aliasing work in favor
3958 $curFields[$fieldName] = [
3959 'name' => $customDAO->column_name
,
3960 'title' => $customDAO->label
,
3961 'dataType' => $customDAO->data_type
,
3962 'htmlType' => $customDAO->html_type
,
3965 if ($this->_customGroupFilters
) {
3966 // this makes aliasing work in favor
3967 $curFilters[$fieldName] = [
3968 'name' => $customDAO->column_name
,
3969 'title' => $customDAO->label
,
3970 'dataType' => $customDAO->data_type
,
3971 'htmlType' => $customDAO->html_type
,
3975 switch ($customDAO->data_type
) {
3978 $curFilters[$fieldName]['operatorType'] = CRM_Report_Form
::OP_DATE
;
3979 $curFilters[$fieldName]['type'] = CRM_Utils_Type
::T_DATE
;
3980 // CRM-6946, show time part for datetime date fields
3981 if ($customDAO->time_format
) {
3982 $curFields[$fieldName]['type'] = CRM_Utils_Type
::T_TIMESTAMP
;
3987 $curFilters[$fieldName]['operatorType'] = CRM_Report_Form
::OP_SELECT
;
3988 $curFilters[$fieldName]['options'] = ['' => ts('- select -')] + CRM_Core_PseudoConstant
::get('CRM_Core_BAO_CustomField', 'custom_' . $customDAO->cf_id
, [], 'search');
3989 $curFilters[$fieldName]['type'] = CRM_Utils_Type
::T_INT
;
3993 $curFilters[$fieldName]['operatorType'] = CRM_Report_Form
::OP_INT
;
3994 $curFilters[$fieldName]['type'] = CRM_Utils_Type
::T_INT
;
3998 $curFilters[$fieldName]['operatorType'] = CRM_Report_Form
::OP_FLOAT
;
3999 $curFilters[$fieldName]['type'] = CRM_Utils_Type
::T_MONEY
;
4000 $curFields[$fieldName]['type'] = CRM_Utils_Type
::T_MONEY
;
4004 $curFilters[$fieldName]['operatorType'] = CRM_Report_Form
::OP_FLOAT
;
4005 $curFilters[$fieldName]['type'] = CRM_Utils_Type
::T_FLOAT
;
4009 case 'StateProvince':
4011 $curFilters[$fieldName]['type'] = CRM_Utils_Type
::T_STRING
;
4013 $options = CRM_Core_PseudoConstant
::get('CRM_Core_BAO_CustomField', 'custom_' . $customDAO->cf_id
, [], 'search');
4014 if ((is_array($options) && count($options) != 0) ||
(!is_array($options) && $options !== FALSE)) {
4015 $curFilters[$fieldName]['operatorType'] = CRM_Core_BAO_CustomField
::isSerialized($customDAO) ? CRM_Report_Form
::OP_MULTISELECT_SEPARATOR
: CRM_Report_Form
::OP_MULTISELECT
;
4016 $curFilters[$fieldName]['options'] = $options;
4020 case 'ContactReference':
4021 $curFilters[$fieldName]['type'] = CRM_Utils_Type
::T_STRING
;
4022 $curFilters[$fieldName]['name'] = 'display_name';
4023 $curFilters[$fieldName]['alias'] = "contact_{$fieldName}_civireport";
4025 $curFields[$fieldName]['type'] = CRM_Utils_Type
::T_STRING
;
4026 $curFields[$fieldName]['name'] = 'display_name';
4027 $curFields[$fieldName]['alias'] = "contact_{$fieldName}_civireport";
4031 $curFields[$fieldName]['type'] = CRM_Utils_Type
::T_STRING
;
4032 $curFilters[$fieldName]['type'] = CRM_Utils_Type
::T_STRING
;
4036 if ($customDAO->html_type
== 'Select' && !array_key_exists('options', $curFilters[$fieldName])) {
4037 $options = CRM_Core_PseudoConstant
::get('CRM_Core_BAO_CustomField', 'custom_' . $customDAO->cf_id
, [], 'search');
4038 if ($options !== FALSE) {
4039 $curFilters[$fieldName]['operatorType'] = CRM_Core_BAO_CustomField
::isSerialized($customDAO) ? CRM_Report_Form
::OP_MULTISELECT_SEPARATOR
: CRM_Report_Form
::OP_MULTISELECT
;
4040 $curFilters[$fieldName]['options'] = $options;
4044 if (!array_key_exists('type', $curFields[$fieldName])) {
4045 $curFields[$fieldName]['type'] = CRM_Utils_Array
::value('type', $curFilters[$fieldName], []);
4049 $this->_columns
[$curTable]['fields'] = array_merge($this->_columns
[$curTable]['fields'], $curFields);
4051 if ($this->_customGroupFilters
) {
4052 $this->_columns
[$curTable]['filters'] = array_merge($this->_columns
[$curTable]['filters'], $curFilters);
4054 if ($this->_customGroupGroupBy
) {
4055 $this->_columns
[$curTable]['group_bys'] = array_merge($this->_columns
[$curTable]['group_bys'], $curFields);
4061 * Build custom data from clause.
4063 * @param bool $joinsForFiltersOnly
4064 * Only include joins to support filters. This would be used if creating a table of contacts to include first.
4066 public function customDataFrom($joinsForFiltersOnly = FALSE) {
4067 if (empty($this->_customGroupExtends
)) {
4070 $mapper = CRM_Core_BAO_CustomQuery
::$extendsMap;
4071 //CRM-18276 GROUP_CONCAT could be used with singleValueQuery and then exploded,
4072 //but by default that truncates to 1024 characters, which causes errors with installs with lots of custom field sets
4074 $customTablesDAO = CRM_Core_DAO
::executeQuery("SELECT table_name FROM civicrm_custom_group");
4075 while ($customTablesDAO->fetch()) {
4076 $customTables[] = $customTablesDAO->table_name
;
4079 foreach ($this->_columns
as $table => $prop) {
4080 if (in_array($table, $customTables)) {
4081 $extendsTable = $mapper[$prop['extends']];
4082 // Check field is required for rendering the report.
4083 if ((!$this->isFieldSelected($prop)) ||
($joinsForFiltersOnly && !$this->isFieldFiltered($prop))) {
4086 $baseJoin = CRM_Utils_Array
::value($prop['extends'], $this->_customGroupExtendsJoin
, "{$this->_aliases[$extendsTable]}.id");
4088 $customJoin = is_array($this->_customGroupJoin
) ?
$this->_customGroupJoin
[$table] : $this->_customGroupJoin
;
4090 {$customJoin} {$table} {$this->_aliases[$table]} ON {$this->_aliases[$table]}.entity_id = {$baseJoin}";
4091 // handle for ContactReference
4092 if (array_key_exists('fields', $prop)) {
4093 foreach ($prop['fields'] as $fieldName => $field) {
4094 if (CRM_Utils_Array
::value('dataType', $field) ==
4097 $columnName = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_CustomField', CRM_Core_BAO_CustomField
::getKeyID($fieldName), 'column_name');
4099 LEFT JOIN civicrm_contact {$field['alias']} ON {$field['alias']}.id = {$this->_aliases[$table]}.{$columnName} ";
4108 * Check if the field is selected.
4110 * @param string $prop
4114 public function isFieldSelected($prop) {
4119 if (!empty($this->_params
['fields'])) {
4120 foreach (array_keys($prop['fields']) as $fieldAlias) {
4121 $customFieldId = CRM_Core_BAO_CustomField
::getKeyID($fieldAlias);
4122 if ($customFieldId) {
4123 if (array_key_exists($fieldAlias, $this->_params
['fields'])) {
4127 //might be survey response field.
4128 if (!empty($this->_params
['fields']['survey_response']) &&
4129 !empty($prop['fields'][$fieldAlias]['isSurveyResponseField'])
4137 if (!empty($this->_params
['group_bys']) && $this->_customGroupGroupBy
) {
4138 foreach (array_keys($prop['group_bys']) as $fieldAlias) {
4139 if (array_key_exists($fieldAlias, $this->_params
['group_bys']) &&
4140 CRM_Core_BAO_CustomField
::getKeyID($fieldAlias)
4147 if (!empty($this->_params
['order_bys'])) {
4148 foreach (array_keys($prop['fields']) as $fieldAlias) {
4149 foreach ($this->_params
['order_bys'] as $orderBy) {
4150 if ($fieldAlias == $orderBy['column'] &&
4151 CRM_Core_BAO_CustomField
::getKeyID($fieldAlias)
4158 return $this->isFieldFiltered($prop);
4163 * Check if the field is used as a filter.
4165 * @param string $prop
4169 protected function isFieldFiltered($prop) {
4170 if (!empty($prop['filters']) && $this->_customGroupFilters
) {
4171 foreach ($prop['filters'] as $fieldAlias => $val) {
4180 if (isset($this->_params
[$fieldAlias . '_' . $attach]) &&
4181 (!empty($this->_params
[$fieldAlias . '_' . $attach])
4182 ||
($attach != 'relative' &&
4183 $this->_params
[$fieldAlias . '_' . $attach] == '0')
4189 if (!empty($this->_params
[$fieldAlias . '_op']) &&
4190 in_array($this->_params
[$fieldAlias . '_op'], ['nll', 'nnll'])
4201 * Check for empty order_by configurations and remove them.
4203 * Also set template to hide them.
4205 * @param array $formValues
4207 public function preProcessOrderBy(&$formValues) {
4208 // Object to show/hide form elements
4209 $_showHide = new CRM_Core_ShowHideBlocks('', '');
4211 $_showHide->addShow('optionField_1');
4213 // Cycle through order_by options; skip any empty ones, and hide them as well
4216 if (!empty($formValues['order_bys'])) {
4217 foreach ($formValues['order_bys'] as $order_by) {
4218 if ($order_by['column'] && $order_by['column'] != '-') {
4219 $_showHide->addShow('optionField_' . $n);
4220 $orderBys[$n] = $order_by;
4225 for ($i = $n; $i <= 5; $i++
) {
4227 $_showHide->addHide('optionField_' . $i);
4231 // overwrite order_by options with modified values
4232 if (!empty($orderBys)) {
4233 $formValues['order_bys'] = $orderBys;
4236 $formValues['order_bys'] = [1 => ['column' => '-']];
4239 // assign show/hide data to template
4240 $_showHide->addToTemplate();
4244 * Check if table name has columns in SELECT clause.
4246 * @param string $tableName
4247 * Name of table (index of $this->_columns array).
4251 public function isTableSelected($tableName) {
4252 return in_array($tableName, $this->selectedTables());
4256 * Check if table name has columns in WHERE or HAVING clause.
4258 * @param string $tableName
4259 * Name of table (index of $this->_columns array).
4263 public function isTableFiltered($tableName) {
4264 // Cause the array to be generated if not previously done.
4265 if (!$this->_selectedTables
&& !$this->filteredTables
) {
4266 $this->selectedTables();
4268 return in_array($tableName, $this->filteredTables
);
4272 * Fetch array of DAO tables having columns included in SELECT or ORDER BY clause.
4274 * If the array is unset it will be built.
4279 public function selectedTables() {
4280 if (!$this->_selectedTables
) {
4281 $orderByColumns = [];
4282 if (array_key_exists('order_bys', $this->_params
) &&
4283 is_array($this->_params
['order_bys'])
4285 foreach ($this->_params
['order_bys'] as $orderBy) {
4286 $orderByColumns[] = $orderBy['column'];
4290 foreach ($this->_columns
as $tableName => $table) {
4291 if (array_key_exists('fields', $table)) {
4292 foreach ($table['fields'] as $fieldName => $field) {
4293 if (!empty($field['required']) ||
4294 !empty($this->_params
['fields'][$fieldName])
4296 $this->_selectedTables
[] = $tableName;
4301 if (array_key_exists('order_bys', $table)) {
4302 foreach ($table['order_bys'] as $orderByName => $orderBy) {
4303 if (in_array($orderByName, $orderByColumns)) {
4304 $this->_selectedTables
[] = $tableName;
4309 if (array_key_exists('filters', $table)) {
4310 foreach ($table['filters'] as $filterName => $filter) {
4311 if ((isset($this->_params
["{$filterName}_value"])
4312 && !CRM_Utils_System
::isNull($this->_params
["{$filterName}_value"]))
4313 ||
!empty($this->_params
["{$filterName}_relative"])
4314 || CRM_Utils_Array
::value("{$filterName}_op", $this->_params
) ==
4316 || CRM_Utils_Array
::value("{$filterName}_op", $this->_params
) ==
4319 $this->_selectedTables
[] = $tableName;
4320 $this->filteredTables
[] = $tableName;
4327 return $this->_selectedTables
;
4331 * Add campaign fields.
4332 * @param string $entityTable
4333 * @param bool $groupBy
4334 * Add GroupBy? Not appropriate for detail report.
4335 * @param bool $orderBy
4336 * Add OrderBy? Not appropriate for detail report.
4337 * @param bool $filters
4340 public function addCampaignFields($entityTable = 'civicrm_contribution', $groupBy = FALSE, $orderBy = FALSE, $filters = TRUE) {
4341 // Check if CiviCampaign is a) enabled and b) has active campaigns
4342 $config = CRM_Core_Config
::singleton();
4343 $campaignEnabled = in_array('CiviCampaign', $config->enableComponents
);
4344 if ($campaignEnabled) {
4345 $getCampaigns = CRM_Campaign_BAO_Campaign
::getPermissionedCampaigns(NULL, NULL, FALSE, FALSE, TRUE);
4346 // If we have a campaign, build out the relevant elements
4347 if (!empty($getCampaigns['campaigns'])) {
4348 $this->campaigns
= $getCampaigns['campaigns'];
4349 asort($this->campaigns
);
4350 $this->_columns
[$entityTable]['fields']['campaign_id'] = ['title' => ts('Campaign'), 'default' => 'false'];
4352 $this->_columns
[$entityTable]['filters']['campaign_id'] = [
4353 'title' => ts('Campaign'),
4354 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
4355 'options' => $this->campaigns
,
4356 'type' => CRM_Utils_Type
::T_INT
,
4361 $this->_columns
[$entityTable]['group_bys']['campaign_id'] = ['title' => ts('Campaign')];
4365 $this->_columns
[$entityTable]['order_bys']['campaign_id'] = ['title' => ts('Campaign')];
4372 * Add address fields.
4374 * @deprecated - use getAddressColumns which is a more accurate description
4375 * and also accepts an array of options rather than a long list
4377 * adding address fields to construct function in reports
4379 * @param bool $groupBy
4380 * Add GroupBy? Not appropriate for detail report.
4381 * @param bool $orderBy
4382 * Add GroupBy? Not appropriate for detail report.
4383 * @param bool $filters
4384 * @param array $defaults
4387 * address fields for construct clause
4389 public function addAddressFields($groupBy = TRUE, $orderBy = FALSE, $filters = TRUE, $defaults = ['country_id' => TRUE]) {
4390 $defaultAddressFields = [
4391 'street_address' => ts('Street Address'),
4392 'supplemental_address_1' => ts('Supplementary Address Field 1'),
4393 'supplemental_address_2' => ts('Supplementary Address Field 2'),
4394 'supplemental_address_3' => ts('Supplementary Address Field 3'),
4395 'street_number' => ts('Street Number'),
4396 'street_name' => ts('Street Name'),
4397 'street_unit' => ts('Street Unit'),
4398 'city' => ts('City'),
4399 'postal_code' => ts('Postal Code'),
4400 'postal_code_suffix' => ts('Postal Code Suffix'),
4401 'country_id' => ts('Country'),
4402 'state_province_id' => ts('State/Province'),
4403 'county_id' => ts('County'),
4406 'civicrm_address' => [
4407 'dao' => 'CRM_Core_DAO_Address',
4410 'title' => ts('Address Name'),
4411 'default' => $defaults['name'] ??
FALSE,
4415 'grouping' => 'location-fields',
4418 foreach ($defaultAddressFields as $fieldName => $fieldLabel) {
4419 $addressFields['civicrm_address']['fields'][$fieldName] = [
4420 'title' => $fieldLabel,
4421 'default' => $defaults[$fieldName] ??
FALSE,
4425 $street_address_filters = $general_address_filters = [];
4427 // Address filter depends on whether street address parsing is enabled.
4429 $addressOptions = CRM_Core_BAO_Setting
::valueOptions(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
4432 if ($addressOptions['street_address_parsing']) {
4433 $street_address_filters = [
4434 'street_number' => [
4435 'title' => ts('Street Number'),
4436 'type' => CRM_Utils_Type
::T_INT
,
4437 'name' => 'street_number',
4440 'title' => ts('Street Name'),
4441 'name' => 'street_name',
4442 'type' => CRM_Utils_Type
::T_STRING
,
4447 $street_address_filters = [
4448 'street_address' => [
4449 'title' => ts('Street Address'),
4450 'type' => CRM_Utils_Type
::T_STRING
,
4451 'name' => 'street_address',
4455 $general_address_filters = [
4457 'title' => ts('Postal Code'),
4458 'type' => CRM_Utils_Type
::T_STRING
,
4459 'name' => 'postal_code',
4462 'title' => ts('City'),
4463 'type' => CRM_Utils_Type
::T_STRING
,
4467 'name' => 'country_id',
4468 'title' => ts('Country'),
4469 'type' => CRM_Utils_Type
::T_INT
,
4470 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
4471 'options' => CRM_Core_PseudoConstant
::country(),
4473 'state_province_id' => [
4474 'name' => 'state_province_id',
4475 'title' => ts('State/Province'),
4476 'type' => CRM_Utils_Type
::T_INT
,
4477 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
4481 'name' => 'county_id',
4482 'title' => ts('County'),
4483 'type' => CRM_Utils_Type
::T_INT
,
4484 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
4489 $addressFields['civicrm_address']['filters'] = array_merge(
4490 $street_address_filters,
4491 $general_address_filters);
4494 $addressFields['civicrm_address']['order_bys'] = [
4495 'street_name' => ['title' => ts('Street Name')],
4496 'street_number' => ['title' => ts('Odd / Even Street Number')],
4497 'street_address' => NULL,
4499 'postal_code' => NULL,
4504 $addressFields['civicrm_address']['group_bys'] = [
4505 'street_address' => NULL,
4507 'postal_code' => NULL,
4508 'state_province_id' => [
4509 'title' => ts('State/Province'),
4512 'title' => ts('Country'),
4515 'title' => ts('County'),
4519 return $addressFields;
4523 * Do AlterDisplay processing on Address Fields.
4524 * If there are multiple address field values then
4525 * on basis of provided separator the code values are translated into respective labels
4528 * @param array $rows
4529 * @param int $rowNum
4530 * @param string $baseUrl
4531 * @param string $linkText
4532 * @param string $separator
4536 public function alterDisplayAddressFields(&$row, &$rows, &$rowNum, $baseUrl, $linkText, $separator = ',') {
4537 $criteriaQueryParams = CRM_Report_Utils_Report
::getPreviewCriteriaQueryParams($this->_defaults
, $this->_params
);
4538 $entryFound = FALSE;
4540 'civicrm_address_country_id' => 'country',
4541 'civicrm_address_county_id' => 'county',
4542 'civicrm_address_state_province_id' => 'stateProvince',
4544 foreach ($columnMap as $fieldName => $fnName) {
4545 if (array_key_exists($fieldName, $row)) {
4546 if ($values = $row[$fieldName]) {
4547 $values = (array) explode($separator, $values);
4548 $rows[$rowNum][$fieldName] = [];
4549 $addressField = $fnName == 'stateProvince' ?
'state' : $fnName;
4550 foreach ($values as $value) {
4551 $rows[$rowNum][$fieldName][] = CRM_Core_PseudoConstant
::$fnName($value);
4553 $rows[$rowNum][$fieldName] = implode($separator, $rows[$rowNum][$fieldName]);
4555 $url = CRM_Report_Utils_Report
::getNextUrl($baseUrl,
4556 sprintf("reset=1&force=1&%s&%s_op=in&%s_value=%s",
4557 $criteriaQueryParams,
4558 str_replace('civicrm_address_', '', $fieldName),
4559 str_replace('civicrm_address_', '', $fieldName),
4560 implode(',', $values)
4561 ), $this->_absoluteUrl
, $this->_id
4563 $rows[$rowNum]["{$fieldName}_link"] = $url;
4564 $rows[$rowNum]["{$fieldName}_hover"] = ts("%1 for this %2.", [1 => $linkText, 2 => $addressField]);
4575 * Do AlterDisplay processing on Address Fields.
4578 * @param array $rows
4579 * @param int $rowNum
4580 * @param string $baseUrl
4581 * @param string $linkText
4585 public function alterDisplayContactFields(&$row, &$rows, &$rowNum, $baseUrl, $linkText) {
4586 $entryFound = FALSE;
4587 // There is no reason not to add links for all fields but it seems a bit odd to be able to click on
4588 // 'Mrs'. Also, we don't have metadata about the title. So, add selectively to addLinks.
4589 $addLinks = ['gender_id' => 'Gender'];
4590 foreach (['prefix_id', 'suffix_id', 'gender_id', 'contact_sub_type', 'preferred_language'] as $fieldName) {
4591 if (array_key_exists('civicrm_contact_' . $fieldName, $row)) {
4592 if (($value = $row['civicrm_contact_' . $fieldName]) != FALSE) {
4593 $rowValues = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $value);
4595 foreach ($rowValues as $rowValue) {
4597 $rowLabels[] = CRM_Core_PseudoConstant
::getLabel('CRM_Contact_BAO_Contact', $fieldName, $rowValue);
4600 $rows[$rowNum]['civicrm_contact_' . $fieldName] = implode(', ', $rowLabels);
4601 if ($baseUrl && ($title = CRM_Utils_Array
::value($fieldName, $addLinks)) != FALSE) {
4602 $this->addLinkToRow($rows[$rowNum], $baseUrl, $linkText, $value, $fieldName, 'civicrm_contact', $title);
4609 'do_not_email', 'is_deceased', 'do_not_phone', 'do_not_sms', 'do_not_mail', 'is_opt_out',
4611 foreach ($yesNoFields as $fieldName) {
4612 if (array_key_exists('civicrm_contact_' . $fieldName, $row)) {
4613 // Since these are essentially 'negative fields' it feels like it
4614 // makes sense to only highlight the exceptions hence no 'No'.
4615 $rows[$rowNum]['civicrm_contact_' . $fieldName] = !empty($rows[$rowNum]['civicrm_contact_' . $fieldName]) ?
ts('Yes') : '';
4620 // Handle employer id
4621 if (array_key_exists('civicrm_contact_employer_id', $row)) {
4622 $employerId = $row['civicrm_contact_employer_id'];
4624 $rows[$rowNum]['civicrm_contact_employer_id'] = CRM_Contact_BAO_Contact
::displayName($employerId);
4625 $rows[$rowNum]['civicrm_contact_employer_id_link'] = CRM_Utils_System
::url('civicrm/contact/view', 'reset=1&cid=' . $employerId, $this->_absoluteUrl
);
4626 $rows[$rowNum]['civicrm_contact_employer_id_hover'] = ts('View Contact Summary for Employer.');
4635 * Adjusts dates passed in to YEAR() for fiscal year.
4637 * @param string $fieldName
4641 public function fiscalYearOffset($fieldName) {
4642 $config = CRM_Core_Config
::singleton();
4643 $fy = $config->fiscalYearStart
;
4644 if (CRM_Utils_Array
::value('yid_op', $this->_params
) == 'calendar' ||
4645 ($fy['d'] == 1 && $fy['M'] == 1)
4647 return "YEAR( $fieldName )";
4649 return "YEAR( $fieldName - INTERVAL " . ($fy['M'] - 1) . " MONTH" .
4650 ($fy['d'] > 1 ?
(" - INTERVAL " . ($fy['d'] - 1) . " DAY") : '') . " )";
4654 * Add Address into From Table if required.
4656 * Prefix will be added to both tables as
4657 * it is assumed you are using it to get address of a secondary contact.
4659 * @param string $prefix
4660 * @param array $extra Additional options.
4661 * Not currently used in core but may be used in override extensions.
4663 protected function joinAddressFromContact($prefix = '', $extra = []) {
4664 $defaults = ['primary_only' => TRUE];
4665 $params = array_merge($defaults, $extra);
4666 $addressTables = ['civicrm_address', 'civicrm_country', 'civicrm_worldregion', 'civicrm_state_province'];
4667 $isJoinRequired = $this->_addressField
;
4668 foreach ($addressTables as $addressTable) {
4669 if ($this->isTableSelected($prefix . $addressTable)) {
4670 $isJoinRequired = TRUE;
4673 if ($isJoinRequired) {
4675 LEFT JOIN civicrm_address {$this->_aliases[$prefix . 'civicrm_address']}
4676 ON ({$this->_aliases[$prefix . 'civicrm_contact']}.id =
4677 {$this->_aliases[$prefix . 'civicrm_address']}.contact_id)";
4678 if ($params['primary_only']) {
4680 {$this->_aliases[$prefix . 'civicrm_address']}.is_primary = 1\n";
4682 $this->_from
.= $fromJoin;
4687 * Add Country into From Table if required.
4689 * Prefix will be added to both tables as
4690 * it is assumed you are using it to get address of a secondary contact.
4692 * @param string $prefix
4693 * @param array $extra Additional options.
4694 * Not currently used in core but may be used in override extensions.
4696 protected function joinCountryFromAddress($prefix = '', $extra = []) {
4697 $defaults = ['primary_only' => TRUE];
4698 $params = array_merge($defaults, $extra);
4699 // include country field if country column is to be included
4700 if ($this->isTableSelected($prefix . 'civicrm_country') ||
$this->isTableSelected($prefix . 'civicrm_worldregion')) {
4701 if (empty($this->_aliases
[$prefix . 'civicrm_country'])) {
4702 $this->_aliases
[$prefix . 'civicrm_country'] = $prefix . '_report_country';
4705 LEFT JOIN civicrm_country {$this->_aliases[$prefix . 'civicrm_country']}
4706 ON {$this->_aliases[$prefix . 'civicrm_address']}.country_id = {$this->_aliases[$prefix . 'civicrm_country']}.id";
4707 if ($params['primary_only']) {
4709 {$this->_aliases[$prefix . 'civicrm_address']}.is_primary = 1 ";
4711 $this->_from
.= $fromJoin;
4716 * Add Phone into From Table if required.
4718 * Prefix will be added to both tables as
4719 * it is assumed you are using it to get address of a secondary contact.
4721 * @param string $prefix
4722 * @param array $extra Additional options.
4723 * Not currently used in core but may be used in override extensions.
4725 protected function joinPhoneFromContact($prefix = '', $extra = []) {
4726 $defaults = ['primary_only' => TRUE];
4727 $params = array_merge($defaults, $extra);
4728 // include phone field if phone column is to be included
4729 if ($this->isTableSelected($prefix . 'civicrm_phone')) {
4731 LEFT JOIN civicrm_phone {$this->_aliases[$prefix . 'civicrm_phone']}
4732 ON {$this->_aliases[$prefix . 'civicrm_contact']}.id = {$this->_aliases[$prefix . 'civicrm_phone']}.contact_id";
4733 if ($params['primary_only']) {
4735 {$this->_aliases[$prefix . 'civicrm_phone']}.is_primary = 1\n";
4737 $this->_from
.= $fromJoin;
4742 * Add Email into From Table if required.
4744 * Prefix will be added to both tables as
4745 * it is assumed you are using it to get address of a secondary contact.
4747 * @param string $prefix
4748 * @param array $extra Additional options.
4749 * Not currently used in core but may be used in override extensions.
4751 protected function joinEmailFromContact($prefix = '', $extra = []) {
4752 $defaults = ['primary_only' => TRUE];
4753 $params = array_merge($defaults, $extra);
4754 // include email field if email column is to be included
4755 if ($this->isTableSelected($prefix . 'civicrm_email')) {
4757 LEFT JOIN civicrm_email {$this->_aliases[$prefix . 'civicrm_email']}
4758 ON {$this->_aliases[$prefix . 'civicrm_contact']}.id = {$this->_aliases[$prefix . 'civicrm_email']}.contact_id";
4759 if ($params['primary_only']) {
4761 {$this->_aliases[$prefix . 'civicrm_email']}.is_primary = 1 ";
4763 $this->_from
.= $fromJoin;
4768 * Add Financial Transaction into From Table if required.
4770 public function addFinancialTrxnFromClause() {
4771 if ($this->isTableSelected('civicrm_financial_trxn')) {
4773 LEFT JOIN civicrm_entity_financial_trxn eftcc
4774 ON ({$this->_aliases['civicrm_contribution']}.id = eftcc.entity_id AND
4775 eftcc.entity_table = 'civicrm_contribution')
4776 LEFT JOIN civicrm_financial_trxn {$this->_aliases['civicrm_financial_trxn']}
4777 ON {$this->_aliases['civicrm_financial_trxn']}.id = eftcc.financial_trxn_id \n";
4782 * Get phone columns to add to array.
4784 * @param array $options
4785 * - prefix Prefix to add to table (in case of more than one instance of the table)
4786 * - prefix_label Label to give columns from this phone table instance
4789 * phone columns definition
4791 public function getPhoneColumns($options = []) {
4794 'prefix_label' => '',
4797 $options = array_merge($defaultOptions, $options);
4800 $options['prefix'] . 'civicrm_phone' => [
4801 'dao' => 'CRM_Core_DAO_Phone',
4803 $options['prefix'] . 'phone' => [
4804 'title' => $options['prefix_label'] . ts('Phone'),
4814 * Get a standard set of contact fields.
4815 * @deprecated - use getColumns('Contact') instead
4818 public function getBasicContactFields() {
4821 'title' => ts('Contact Name'),
4826 'no_display' => TRUE,
4830 'title' => ts('Contact Prefix'),
4833 'title' => ts('First Name'),
4836 'title' => ts('Nick Name'),
4839 'title' => ts('Middle Name'),
4842 'title' => ts('Last Name'),
4845 'title' => ts('Contact Suffix'),
4847 'postal_greeting_display' => ['title' => ts('Postal Greeting')],
4848 'email_greeting_display' => ['title' => ts('Email Greeting')],
4849 'addressee_display' => ['title' => ts('Addressee')],
4851 'title' => ts('Contact Type'),
4853 'contact_sub_type' => [
4854 'title' => ts('Contact Subtype'),
4857 'title' => ts('Gender'),
4860 'title' => ts('Birth Date'),
4863 'title' => ts('Age'),
4864 'dbAlias' => 'TIMESTAMPDIFF(YEAR, contact_civireport.birth_date, CURDATE())',
4867 'title' => ts('Contact Job title'),
4869 'organization_name' => [
4870 'title' => ts('Organization Name'),
4872 'external_identifier' => [
4873 'title' => ts('Contact identifier from external system'),
4875 'do_not_email' => [],
4876 'do_not_phone' => [],
4877 'do_not_mail' => [],
4880 'is_deceased' => [],
4881 'preferred_language' => [],
4883 'title' => ts('Current Employer'),
4889 * Get a standard set of contact filters.
4891 * @param array $defaults
4895 public function getBasicContactFilters($defaults = []) {
4898 'title' => ts('Contact Name'),
4901 'title' => ts('Contact Source'),
4902 'type' => CRM_Utils_Type
::T_STRING
,
4905 'title' => ts('Contact ID'),
4906 'no_display' => TRUE,
4909 'title' => ts('Gender'),
4910 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
4911 'options' => CRM_Core_PseudoConstant
::get('CRM_Contact_DAO_Contact', 'gender_id'),
4914 'title' => ts('Birth Date'),
4915 'operatorType' => CRM_Report_Form
::OP_DATE
,
4918 'title' => ts('Contact Type'),
4920 'contact_sub_type' => [
4921 'title' => ts('Contact Subtype'),
4923 'modified_date' => [
4924 'title' => ts('Contact Modified'),
4925 'operatorType' => CRM_Report_Form
::OP_DATE
,
4926 'type' => CRM_Utils_Type
::T_DATE
,
4929 'title' => ts('Deceased'),
4930 'type' => CRM_Utils_Type
::T_BOOLEAN
,
4931 'default' => CRM_Utils_Array
::value('deceased', $defaults, 0),
4934 'title' => ts('Do not email'),
4935 'type' => CRM_Utils_Type
::T_BOOLEAN
,
4938 'title' => ts('Do not phone'),
4939 'type' => CRM_Utils_Type
::T_BOOLEAN
,
4942 'title' => ts('Do not mail'),
4943 'type' => CRM_Utils_Type
::T_BOOLEAN
,
4946 'title' => ts('Do not SMS'),
4947 'type' => CRM_Utils_Type
::T_BOOLEAN
,
4950 'title' => ts('Do not bulk email'),
4951 'type' => CRM_Utils_Type
::T_BOOLEAN
,
4953 'preferred_language' => [
4954 'title' => ts('Preferred Language'),
4957 'no_display' => TRUE,
4959 'type' => CRM_Utils_Type
::T_BOOLEAN
,
4965 * Add contact to group.
4967 * @param int $groupID
4969 public function add2group($groupID) {
4970 if (is_numeric($groupID) && isset($this->_aliases
['civicrm_contact'])) {
4971 $select = "SELECT DISTINCT {$this->_aliases['civicrm_contact']}.id AS addtogroup_contact_id, ";
4972 $select = preg_replace('/SELECT(\s+SQL_CALC_FOUND_ROWS)?\s+/i', $select, $this->_select
);
4973 $sql = "{$select} {$this->_from} {$this->_where} {$this->_groupBy} {$this->_having} {$this->_orderBy}";
4974 $sql = str_replace('WITH ROLLUP', '', $sql);
4975 $dao = CRM_Core_DAO
::executeQuery($sql);
4978 // Add resulting contacts to group
4979 while ($dao->fetch()) {
4980 if ($dao->addtogroup_contact_id
) {
4981 $contact_ids[$dao->addtogroup_contact_id
] = $dao->addtogroup_contact_id
;
4985 if (!empty($contact_ids)) {
4986 CRM_Contact_BAO_GroupContact
::addContactsToGroup($contact_ids, $groupID);
4987 CRM_Core_Session
::setStatus(ts("Listed contact(s) have been added to the selected group."), ts('Contacts Added'), 'success');
4990 CRM_Core_Session
::setStatus(ts("The listed records(s) cannot be added to the group."));
4996 * Apply common settings to entityRef fields.
4998 * @param array $field
4999 * @param string $table
5001 public function setEntityRefDefaults(&$field, $table) {
5002 $field['attributes'] = $field['attributes'] ?
$field['attributes'] : [];
5003 $field['attributes'] +
= [
5004 'entity' => CRM_Core_DAO_AllCoreTables
::getBriefName(CRM_Core_DAO_AllCoreTables
::getClassForTable($table)),
5006 'placeholder' => ts('- select -'),
5011 * Add link fields to the row.
5013 * Function adds the _link & _hover fields to the row.
5016 * @param string $baseUrl
5017 * @param string $linkText
5018 * @param string $value
5019 * @param string $fieldName
5020 * @param string $tablePrefix
5021 * @param string $fieldLabel
5025 protected function addLinkToRow(&$row, $baseUrl, $linkText, $value, $fieldName, $tablePrefix, $fieldLabel) {
5026 $criteriaQueryParams = CRM_Report_Utils_Report
::getPreviewCriteriaQueryParams($this->_defaults
, $this->_params
);
5027 $url = CRM_Report_Utils_Report
::getNextUrl($baseUrl,
5028 "reset=1&force=1&{$criteriaQueryParams}&" .
5029 $fieldName . "_op=in&{$fieldName}_value={$value}",
5030 $this->_absoluteUrl
, $this->_id
5032 $row["{$tablePrefix}_{$fieldName}_link"] = $url;
5033 $row["{$tablePrefix}_{$fieldName}_hover"] = ts("%1 for this %2.",
5034 [1 => $linkText, 2 => $fieldLabel]
5039 * Get label for show results buttons.
5043 public function getResultsLabel() {
5044 $showResultsLabel = $this->resultsDisplayed() ?
ts('Refresh results') : ts('View results');
5045 return $showResultsLabel;
5049 * Determine the output mode from the url or input.
5052 * - pdf : Render as pdf
5053 * - csv : Render as csv
5054 * - print : Render in print format
5055 * - save : save the report and display the new report
5056 * - copy : save the report as a new instance and display that.
5057 * - group : go to the add to group screen.
5059 * Potentially chart variations could also be included but the complexity
5060 * is that we might print a bar chart as a pdf.
5062 protected function setOutputMode() {
5063 $this->_outputMode
= str_replace('report_instance.', '', CRM_Utils_Request
::retrieve(
5066 CRM_Core_DAO
::$_nullObject,
5068 CRM_Utils_Array
::value('task', $this->_params
)
5070 // if contacts are added to group
5071 if (!empty($this->_params
['groups']) && empty($this->_outputMode
)) {
5072 $this->_outputMode
= 'group';
5074 if (isset($this->_params
['task'])) {
5075 unset($this->_params
['task']);
5080 * CRM-17793 - Alter DateTime section header to group by date from the datetime field.
5083 * @param $columnName
5085 public function alterSectionHeaderForDateTime($tempTable, $columnName) {
5086 // add new column with date value for the datetime field
5087 $tempQuery = "ALTER TABLE {$tempTable} ADD COLUMN {$columnName}_date VARCHAR(128)";
5088 CRM_Core_DAO
::executeQuery($tempQuery);
5089 $updateQuery = "UPDATE {$tempTable} SET {$columnName}_date = date({$columnName})";
5090 CRM_Core_DAO
::executeQuery($updateQuery);
5091 $this->_selectClauses
[] = "{$columnName}_date";
5092 $this->_select
.= ", {$columnName}_date";
5093 $this->_sections
["{$columnName}_date"] = $this->_sections
["{$columnName}"];
5094 unset($this->_sections
["{$columnName}"]);
5095 $this->assign('sections', $this->_sections
);
5099 * Get an array of the columns that have been selected for display.
5103 public function getSelectColumns() {
5104 $selectColumns = [];
5105 foreach ($this->_columns
as $tableName => $table) {
5106 if (array_key_exists('fields', $table)) {
5107 foreach ($table['fields'] as $fieldName => $field) {
5108 if (!empty($field['required']) ||
5109 !empty($this->_params
['fields'][$fieldName])
5112 $selectColumns["{$tableName}_{$fieldName}"] = 1;
5117 return $selectColumns;
5121 * Add location tables to the query if they are used for filtering.
5123 * This is for when we are running the query separately for filtering and retrieving display fields.
5125 public function selectivelyAddLocationTablesJoinsToFilterQuery() {
5126 if ($this->isTableFiltered('civicrm_email')) {
5128 LEFT JOIN civicrm_email {$this->_aliases['civicrm_email']}
5129 ON {$this->_aliases['civicrm_contact']}.id = {$this->_aliases['civicrm_email']}.contact_id
5130 AND {$this->_aliases['civicrm_email']}.is_primary = 1";
5132 if ($this->isTableFiltered('civicrm_phone')) {
5134 LEFT JOIN civicrm_phone {$this->_aliases['civicrm_phone']}
5135 ON {$this->_aliases['civicrm_contact']}.id = {$this->_aliases['civicrm_phone']}.contact_id
5136 AND {$this->_aliases['civicrm_phone']}.is_primary = 1";
5138 if ($this->isTableFiltered('civicrm_address')) {
5140 LEFT JOIN civicrm_address {$this->_aliases['civicrm_address']}
5141 ON ({$this->_aliases['civicrm_contact']}.id = {$this->_aliases['civicrm_address']}.contact_id)
5142 AND {$this->_aliases['civicrm_address']}.is_primary = 1\n";
5147 * Set the base table for the FROM clause.
5149 * Sets up the from clause, allowing for the possibility it might be a
5150 * temp table pre-filtered by groups if a group filter is in use.
5152 * @param string $baseTable
5153 * @param string $field
5154 * @param null $tableAlias
5156 public function setFromBase($baseTable, $field = 'id', $tableAlias = NULL) {
5158 $tableAlias = $this->_aliases
[$baseTable];
5160 $this->_from
= $this->_from
= " FROM $baseTable $tableAlias ";
5161 $this->joinGroupTempTable($baseTable, $field, $tableAlias);
5162 $this->_from
.= " {$this->_aclFrom} ";
5166 * Join the temp table contacting contacts who are members of the filtered groups.
5168 * If we are using an IN filter we use an inner join, otherwise a left join.
5170 * @param string $baseTable
5171 * @param string $field
5172 * @param string $tableAlias
5174 public function joinGroupTempTable($baseTable, $field, $tableAlias) {
5175 if ($this->groupTempTable
) {
5176 if ($this->_params
['gid_op'] == 'in') {
5177 $this->_from
= " FROM $this->groupTempTable group_temp_table INNER JOIN $baseTable $tableAlias
5178 ON group_temp_table.id = $tableAlias.{$field} ";
5182 LEFT JOIN $this->groupTempTable group_temp_table
5183 ON $tableAlias.{$field} = group_temp_table.id ";
5189 * Get all labels for fields that are used in a group concat.
5191 * @param string $options
5192 * comma separated option values.
5193 * @param string $baoName
5194 * The BAO name for the field.
5195 * @param string $fieldName
5196 * The name of the field for which labels should be retrieved.
5200 public function getLabels($options, $baoName, $fieldName) {
5201 $types = explode(',', $options);
5203 foreach ($types as $value) {
5204 $labels[$value] = CRM_Core_PseudoConstant
::getLabel($baoName, $fieldName, $value);
5206 return implode(', ', array_filter($labels));
5210 * Add statistics columns.
5212 * If a group by is in play then add columns for the statistics fields.
5214 * This would lead to a new field in the $row such as $fieldName_sum and a new, matching
5215 * column header field.
5217 * @param array $field
5218 * @param string $tableName
5219 * @param string $fieldName
5220 * @param array $select
5224 protected function addStatisticsToSelect($field, $tableName, $fieldName, $select) {
5225 foreach ($field['statistics'] as $stat => $label) {
5226 $alias = "{$tableName}_{$fieldName}_{$stat}";
5227 switch (strtolower($stat)) {
5230 $select[] = "$stat({$field['dbAlias']}) as $alias";
5231 $this->_columnHeaders
["{$tableName}_{$fieldName}_{$stat}"]['title'] = $label;
5232 $this->_columnHeaders
["{$tableName}_{$fieldName}_{$stat}"]['type'] = $field['type'];
5233 $this->_statFields
[$label] = $alias;
5234 $this->_selectAliases
[] = $alias;
5238 $select[] = "COUNT({$field['dbAlias']}) as $alias";
5239 $this->_columnHeaders
["{$tableName}_{$fieldName}_{$stat}"]['title'] = $label;
5240 $this->_columnHeaders
["{$tableName}_{$fieldName}_{$stat}"]['type'] = CRM_Utils_Type
::T_INT
;
5241 $this->_statFields
[$label] = $alias;
5242 $this->_selectAliases
[] = $alias;
5245 case 'count_distinct':
5246 $select[] = "COUNT(DISTINCT {$field['dbAlias']}) as $alias";
5247 $this->_columnHeaders
["{$tableName}_{$fieldName}_{$stat}"]['title'] = $label;
5248 $this->_columnHeaders
["{$tableName}_{$fieldName}_{$stat}"]['type'] = CRM_Utils_Type
::T_INT
;
5249 $this->_statFields
[$label] = $alias;
5250 $this->_selectAliases
[] = $alias;
5254 $select[] = "ROUND(AVG({$field['dbAlias']}),2) as $alias";
5255 $this->_columnHeaders
["{$tableName}_{$fieldName}_{$stat}"]['title'] = $label;
5256 $this->_columnHeaders
["{$tableName}_{$fieldName}_{$stat}"]['type'] = $field['type'];
5257 $this->_statFields
[$label] = $alias;
5258 $this->_selectAliases
[] = $alias;
5266 * Add a basic field to the select clause.
5268 * @param string $tableName
5269 * @param string $fieldName
5270 * @param array $field
5271 * @param string $select
5274 protected function addBasicFieldToSelect($tableName, $fieldName, $field, $select) {
5275 $alias = "{$tableName}_{$fieldName}";
5276 $select[] = "{$field['dbAlias']} as $alias";
5277 $this->_columnHeaders
["{$tableName}_{$fieldName}"]['title'] = $field['title'] ??
NULL;
5278 $this->_columnHeaders
["{$tableName}_{$fieldName}"]['type'] = $field['type'] ??
NULL;
5279 $this->_selectAliases
[] = $alias;
5286 * @param array $table
5287 * @param string $tableName
5292 protected function setTableAlias($table, $tableName) {
5293 if (!isset($table['alias'])) {
5294 $this->_columns
[$tableName]['alias'] = substr($tableName, 8) .
5298 $this->_columns
[$tableName]['alias'] = $table['alias'] . '_civireport';
5301 $this->_aliases
[$tableName] = $this->_columns
[$tableName]['alias'];
5302 return $this->_aliases
[$tableName];
5306 * Function to add columns to reports.
5308 * This is ported from extended reports, which also adds join filters to the options.
5310 * @param string $type
5311 * @param array $options
5312 * - prefix - A string to prepend to the table name
5313 * - prefix_label A string to prepend to the fields
5314 * - fields (bool) - should the fields for this table be made available
5315 * - group_by (bool) - should the group bys for this table be made available.
5316 * - order_by (bool) - should the group bys for this table be made available.
5317 * - filters (bool) - should the filters for this table by made available.
5318 * - fields_defaults (array) array of fields that should be displayed by default.
5319 * - filters_defaults (array) array of fields that should be filtered by default.
5320 * - join_filters (array) fields available for filtering joins (requires additional custom code).
5321 * - join_fields (array) fields available from join (requires additional custom code).
5322 * - group_by_defaults (array) array of group bys that should be applied by default.
5323 * - order_by_defaults (array) array of order bys that should be applied by default.
5324 * - custom_fields (array) array of entity types for custom fields (not usually required).
5325 * - contact_type (string) optional restriction on contact type for some tables.
5326 * - fields_excluded (array) fields that are in the generic set for the table but not in the report.
5330 protected function getColumns($type, $options = []) {
5333 'prefix_label' => '',
5335 'group_bys' => FALSE,
5336 'order_bys' => TRUE,
5338 'join_filters' => FALSE,
5339 'fields_defaults' => [],
5340 'filters_defaults' => [],
5341 'group_bys_defaults' => [],
5342 'order_bys_defaults' => [],
5344 $options = array_merge($defaultOptions, $options);
5346 $fn = 'get' . $type . 'Columns';
5347 return $this->$fn($options);
5351 * Get columns for contact table.
5353 * @param array $options
5357 protected function getContactColumns($options = []) {
5359 'custom_fields' => ['Individual', 'Contact', 'Organization'],
5360 'fields_defaults' => ['display_name', 'id'],
5361 'order_bys_defaults' => ['sort_name ASC'],
5362 'contact_type' => NULL,
5365 $options = array_merge($defaultOptions, $options);
5367 $tableAlias = $options['prefix'] . 'contact';
5370 $options['prefix'] . 'display_name' => [
5371 'name' => 'display_name',
5372 'title' => $options['prefix_label'] . ts('Contact Name'),
5373 'is_fields' => TRUE,
5375 $options['prefix'] . 'sort_name' => [
5376 'name' => 'sort_name',
5377 'title' => $options['prefix_label'] . ts('Contact Name (in sort format)'),
5378 'is_fields' => TRUE,
5379 'is_filters' => TRUE,
5380 'is_order_bys' => TRUE,
5382 $options['prefix'] . 'id' => [
5384 'title' => $options['prefix_label'] . ts('Contact ID'),
5385 'alter_display' => 'alterContactID',
5386 'type' => CRM_Utils_Type
::T_INT
,
5387 'is_order_bys' => TRUE,
5388 'is_group_bys' => TRUE,
5389 'is_fields' => TRUE,
5390 'is_filters' => TRUE,
5392 $options['prefix'] . 'external_identifier' => [
5393 'name' => 'external_identifier',
5394 'title' => $options['prefix_label'] . ts('External ID'),
5395 'type' => CRM_Utils_Type
::T_INT
,
5396 'is_fields' => TRUE,
5398 $options['prefix'] . 'contact_type' => [
5399 'title' => $options['prefix_label'] . ts('Contact Type'),
5400 'name' => 'contact_type',
5401 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
5402 'options' => CRM_Contact_BAO_Contact
::buildOptions('contact_type'),
5403 'is_fields' => TRUE,
5404 'is_filters' => TRUE,
5405 'is_group_bys' => TRUE,
5407 $options['prefix'] . 'contact_sub_type' => [
5408 'title' => $options['prefix_label'] . ts('Contact Sub Type'),
5409 'name' => 'contact_sub_type',
5410 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
5411 'options' => CRM_Contact_BAO_Contact
::buildOptions('contact_sub_type'),
5412 'is_fields' => TRUE,
5413 'is_filters' => TRUE,
5414 'is_group_bys' => TRUE,
5416 $options['prefix'] . 'is_deleted' => [
5417 'title' => $options['prefix_label'] . ts('Is deleted'),
5418 'name' => 'is_deleted',
5419 'type' => CRM_Utils_Type
::T_BOOLEAN
,
5420 'is_fields' => FALSE,
5421 'is_filters' => TRUE,
5422 'is_group_bys' => FALSE,
5424 $options['prefix'] . 'external_identifier' => [
5425 'title' => $options['prefix_label'] . ts('Contact identifier from external system'),
5426 'name' => 'external_identifier',
5427 'is_fields' => TRUE,
5428 'is_filters' => FALSE,
5429 'is_group_bys' => FALSE,
5430 'is_order_bys' => TRUE,
5432 $options['prefix'] . 'preferred_language' => [
5433 'title' => $options['prefix_label'] . ts('Preferred Language'),
5434 'name' => 'preferred_language',
5435 'is_fields' => TRUE,
5436 'is_filters' => TRUE,
5437 'is_group_bys' => TRUE,
5438 'is_order_bys' => TRUE,
5440 $options['prefix'] . 'preferred_communication_method' => [
5441 'title' => $options['prefix_label'] . ts('Preferred Communication Method'),
5442 'alter_display' => 'alterCommunicationtMethod',
5443 'name' => 'preferred_communication_method',
5444 'is_fields' => TRUE,
5445 'is_filters' => FALSE,
5446 'is_group_bys' => FALSE,
5447 'is_order_bys' => FALSE,
5451 'postal_greeting_display' => 'Postal Greeting',
5452 'email_greeting_display' => 'Email Greeting',
5453 'addressee_display' => 'Addressee',
5454 ] as $field => $title) {
5455 $spec[$options['prefix'] . $field] = [
5456 'title' => $options['prefix_label'] . ts($title),
5458 'is_fields' => TRUE,
5459 'is_filters' => FALSE,
5460 'is_group_bys' => FALSE,
5463 foreach (['do_not_email', 'do_not_phone', 'do_not_mail', 'do_not_sms', 'is_opt_out'] as $field) {
5464 $spec[$options['prefix'] . $field] = [
5466 'type' => CRM_Utils_Type
::T_BOOLEAN
,
5467 'is_fields' => TRUE,
5468 'is_filters' => TRUE,
5469 'is_group_bys' => FALSE,
5472 $individualFields = [
5473 $options['prefix'] . 'first_name' => [
5474 'name' => 'first_name',
5475 'title' => $options['prefix_label'] . ts('First Name'),
5476 'is_fields' => TRUE,
5477 'is_filters' => TRUE,
5478 'is_order_bys' => TRUE,
5480 $options['prefix'] . 'middle_name' => [
5481 'name' => 'middle_name',
5482 'title' => $options['prefix_label'] . ts('Middle Name'),
5483 'is_fields' => TRUE,
5485 $options['prefix'] . 'last_name' => [
5486 'name' => 'last_name',
5487 'title' => $options['prefix_label'] . ts('Last Name'),
5488 'default_order' => 'ASC',
5489 'is_fields' => TRUE,
5491 $options['prefix'] . 'nick_name' => [
5492 'name' => 'nick_name',
5493 'title' => $options['prefix_label'] . ts('Nick Name'),
5494 'is_fields' => TRUE,
5496 $options['prefix'] . 'prefix_id' => [
5497 'name' => 'prefix_id',
5498 'title' => $options['prefix_label'] . ts('Prefix'),
5499 'options' => CRM_Contact_BAO_Contact
::buildOptions('prefix_id'),
5500 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
5501 'is_fields' => TRUE,
5502 'is_filters' => TRUE,
5504 $options['prefix'] . 'suffix_id' => [
5505 'name' => 'suffix_id',
5506 'title' => $options['prefix_label'] . ts('Suffix'),
5507 'options' => CRM_Contact_BAO_Contact
::buildOptions('suffix_id'),
5508 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
5509 'is_fields' => TRUE,
5510 'is_filters' => TRUE,
5512 $options['prefix'] . 'gender_id' => [
5513 'name' => 'gender_id',
5514 'title' => $options['prefix_label'] . ts('Gender'),
5515 'options' => CRM_Contact_BAO_Contact
::buildOptions('gender_id'),
5516 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
5517 'is_fields' => TRUE,
5518 'is_filters' => TRUE,
5521 'title' => $options['prefix_label'] . ts('Birth Date'),
5522 'operatorType' => CRM_Report_Form
::OP_DATE
,
5523 'type' => CRM_Utils_Type
::T_DATE
,
5524 'is_fields' => TRUE,
5525 'is_filters' => TRUE,
5528 'title' => $options['prefix_label'] . ts('Age'),
5529 'dbAlias' => 'TIMESTAMPDIFF(YEAR, ' . $tableAlias . '_civireport.birth_date, CURDATE())',
5530 'type' => CRM_Utils_Type
::T_INT
,
5531 'is_fields' => TRUE,
5533 $options['prefix'] . 'is_deceased' => [
5534 'title' => $options['prefix_label'] . ts('Is deceased'),
5535 'name' => 'is_deceased',
5536 'type' => CRM_Utils_Type
::T_BOOLEAN
,
5537 'is_fields' => FALSE,
5538 'is_filters' => TRUE,
5539 'is_group_bys' => FALSE,
5541 $options['prefix'] . 'job_title' => [
5542 'name' => 'job_title',
5543 'is_fields' => TRUE,
5544 'is_filters' => FALSE,
5545 'is_group_bys' => FALSE,
5547 $options['prefix'] . 'employer_id' => [
5548 'title' => $options['prefix_label'] . ts('Current Employer'),
5549 'type' => CRM_Utils_Type
::T_INT
,
5550 'name' => 'employer_id',
5551 'is_fields' => TRUE,
5552 'is_filters' => FALSE,
5553 'is_group_bys' => TRUE,
5556 if (!$options['contact_type'] ||
$options['contact_type'] === 'Individual') {
5557 $spec = array_merge($spec, $individualFields);
5560 if (!empty($options['custom_fields'])) {
5561 $this->_customGroupExtended
[$options['prefix'] . 'civicrm_contact'] = [
5562 'extends' => $options['custom_fields'],
5563 'title' => $options['prefix_label'],
5564 'filters' => $options['filters'],
5565 'prefix' => $options['prefix'],
5566 'prefix_label' => $options['prefix_label'],
5570 return $this->buildColumns($spec, $options['prefix'] . 'civicrm_contact', 'CRM_Contact_DAO_Contact', $tableAlias, $this->getDefaultsFromOptions($options), $options);
5574 * Get address columns to add to array.
5576 * @param array $options
5577 * - prefix Prefix to add to table (in case of more than one instance of the table)
5578 * - prefix_label Label to give columns from this address table instance
5579 * - group_bys enable these fields for group by - default false
5580 * - order_bys enable these fields for order by
5581 * - filters enable these fields for filtering
5583 * @return array address columns definition
5585 protected function getAddressColumns($options = []) {
5588 'prefix_label' => '',
5590 'group_bys' => FALSE,
5591 'order_bys' => TRUE,
5593 'join_filters' => FALSE,
5594 'fields_defaults' => [],
5595 'filters_defaults' => [],
5596 'group_bys_defaults' => [],
5597 'order_bys_defaults' => [],
5600 $options = array_merge($defaultOptions, $options);
5601 $defaults = $this->getDefaultsFromOptions($options);
5602 $tableAlias = $options['prefix'] . 'address';
5605 $options['prefix'] . 'name' => [
5606 'title' => $options['prefix_label'] . ts('Address Name'),
5608 'is_fields' => TRUE,
5610 $options['prefix'] . 'street_number' => [
5611 'name' => 'street_number',
5612 'title' => $options['prefix_label'] . ts('Street Number'),
5614 'is_fields' => TRUE,
5616 $options['prefix'] . 'odd_street_number' => [
5617 'title' => ts('Odd / Even Street Number'),
5618 'name' => 'odd_street_number',
5619 'type' => CRM_Utils_Type
::T_INT
,
5620 'no_display' => TRUE,
5622 'dbAlias' => "({$tableAlias}_civireport.street_number % 2)",
5623 'is_fields' => TRUE,
5624 'is_order_bys' => TRUE,
5626 $options['prefix'] . 'street_name' => [
5627 'name' => 'street_name',
5628 'title' => $options['prefix_label'] . ts('Street Name'),
5630 'is_fields' => TRUE,
5631 'is_filters' => TRUE,
5632 'operator' => 'like',
5633 'is_order_bys' => TRUE,
5635 $options['prefix'] . 'street_address' => [
5636 'title' => $options['prefix_label'] . ts('Street Address'),
5637 'name' => 'street_address',
5638 'is_fields' => TRUE,
5639 'is_filters' => TRUE,
5640 'is_group_bys' => TRUE,
5642 $options['prefix'] . 'supplemental_address_1' => [
5643 'title' => $options['prefix_label'] . ts('Supplementary Address Field 1'),
5644 'name' => 'supplemental_address_1',
5645 'is_fields' => TRUE,
5647 $options['prefix'] . 'supplemental_address_2' => [
5648 'title' => $options['prefix_label'] . ts('Supplementary Address Field 2'),
5649 'name' => 'supplemental_address_2',
5650 'is_fields' => TRUE,
5652 $options['prefix'] . 'supplemental_address_3' => [
5653 'title' => $options['prefix_label'] . ts('Supplementary Address Field 3'),
5654 'name' => 'supplemental_address_3',
5655 'is_fields' => TRUE,
5657 $options['prefix'] . 'street_number' => [
5658 'name' => 'street_number',
5659 'title' => $options['prefix_label'] . ts('Street Number'),
5661 'is_order_bys' => TRUE,
5662 'is_filters' => TRUE,
5663 'is_fields' => TRUE,
5665 $options['prefix'] . 'street_unit' => [
5666 'name' => 'street_unit',
5667 'title' => $options['prefix_label'] . ts('Street Unit'),
5669 'is_fields' => TRUE,
5671 $options['prefix'] . 'city' => [
5672 'title' => $options['prefix_label'] . ts('City'),
5674 'operator' => 'like',
5675 'is_fields' => TRUE,
5676 'is_filters' => TRUE,
5677 'is_group_bys' => TRUE,
5678 'is_order_bys' => TRUE,
5680 $options['prefix'] . 'postal_code' => [
5681 'title' => $options['prefix_label'] . ts('Postal Code'),
5682 'name' => 'postal_code',
5684 'is_fields' => TRUE,
5685 'is_filters' => TRUE,
5686 'is_group_bys' => TRUE,
5687 'is_order_bys' => TRUE,
5689 $options['prefix'] . 'postal_code_suffix' => [
5690 'title' => $options['prefix_label'] . ts('Postal Code Suffix'),
5691 'name' => 'postal_code_suffix',
5693 'is_fields' => TRUE,
5694 'is_filters' => TRUE,
5695 'is_group_bys' => TRUE,
5696 'is_order_bys' => TRUE,
5698 $options['prefix'] . 'county_id' => [
5699 'title' => $options['prefix_label'] . ts('County'),
5700 'alter_display' => 'alterCountyID',
5701 'name' => 'county_id',
5702 'type' => CRM_Utils_Type
::T_INT
,
5703 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
5704 'options' => CRM_Core_PseudoConstant
::county(),
5705 'is_fields' => TRUE,
5706 'is_filters' => TRUE,
5707 'is_group_bys' => TRUE,
5709 $options['prefix'] . 'state_province_id' => [
5710 'title' => $options['prefix_label'] . ts('State/Province'),
5711 'alter_display' => 'alterStateProvinceID',
5712 'name' => 'state_province_id',
5713 'type' => CRM_Utils_Type
::T_INT
,
5714 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
5715 'options' => CRM_Core_PseudoConstant
::stateProvince(),
5716 'is_fields' => TRUE,
5717 'is_filters' => TRUE,
5718 'is_group_bys' => TRUE,
5720 $options['prefix'] . 'country_id' => [
5721 'title' => $options['prefix_label'] . ts('Country'),
5722 'alter_display' => 'alterCountryID',
5723 'name' => 'country_id',
5724 'is_fields' => TRUE,
5725 'is_filters' => TRUE,
5726 'is_group_bys' => TRUE,
5727 'type' => CRM_Utils_Type
::T_INT
,
5728 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
5729 'options' => CRM_Core_PseudoConstant
::country(),
5731 $options['prefix'] . 'location_type_id' => [
5732 'name' => 'location_type_id',
5733 'title' => $options['prefix_label'] . ts('Location Type'),
5734 'type' => CRM_Utils_Type
::T_INT
,
5735 'is_fields' => TRUE,
5736 'alter_display' => 'alterLocationTypeID',
5738 $options['prefix'] . 'id' => [
5739 'title' => $options['prefix_label'] . ts('ID'),
5741 'is_fields' => TRUE,
5743 $options['prefix'] . 'is_primary' => [
5744 'name' => 'is_primary',
5745 'title' => $options['prefix_label'] . ts('Primary Address?'),
5746 'type' => CRM_Utils_Type
::T_BOOLEAN
,
5747 'is_fields' => TRUE,
5750 return $this->buildColumns($spec, $options['prefix'] . 'civicrm_address', 'CRM_Core_DAO_Address', $tableAlias, $defaults, $options);
5754 * Build the columns.
5756 * The normal report class needs you to remember to do a few things that are often erratic
5758 * 1) use a unique key for any field that might not be unique (e.g. start date, label)
5759 * - this class will prepend an alias to the key & set the 'name' if you don't set it yourself.
5760 * You can suppress the alias with 'no_field_disambiguation' if transitioning existing reports. This
5761 * means any saved filters / fields on saved report instances. This will mean that matching names from
5762 * different tables may be ambigious, but it will smooth any code transition.
5763 * - note that it assumes the value being passed in is the actual table field name
5765 * 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
5766 * contexts - the code looks up the fields array for data - so it both defines the field spec & the fields you want to show
5768 * 3) this function also sets the 'metadata' array - the extended report class now uses this in place
5769 * of the fields array to reduce the issues caused when metadata is needed but 'fields' are not defined. Code in
5770 * the core classes can start to move towards that.
5772 * @param array $specs
5773 * @param string $tableName
5774 * @param string $daoName
5775 * @param string $tableAlias
5776 * @param array $defaults
5777 * @param array $options
5781 protected function buildColumns($specs, $tableName, $daoName = NULL, $tableAlias = NULL, $defaults = [], $options = []) {
5783 $tableAlias = str_replace('civicrm_', '', $tableName);
5785 $types = ['filters', 'group_bys', 'order_bys', 'join_filters'];
5786 $columns = [$tableName => array_fill_keys($types, [])];
5787 // The code that uses this no longer cares if it is a DAO or BAO so just call it a DAO.
5788 $columns[$tableName]['dao'] = $daoName;
5789 $columns[$tableName]['alias'] = $tableAlias;
5791 foreach ($specs as $specName => $spec) {
5792 if (empty($spec['name'])) {
5793 $spec['name'] = $specName;
5796 $fieldAlias = (empty($options['no_field_disambiguation']) ?
$tableAlias . '_' : '') . $specName;
5797 $columns[$tableName]['metadata'][$fieldAlias] = $spec;
5798 $columns[$tableName]['fields'][$fieldAlias] = $spec;
5799 if (isset($defaults['fields_defaults']) && in_array($spec['name'], $defaults['fields_defaults'])) {
5800 $columns[$tableName]['fields'][$fieldAlias]['default'] = TRUE;
5803 if (!$spec['is_fields'] ||
(isset($options['fields_excluded']) && in_array($specName, $options['fields_excluded']))) {
5804 $columns[$tableName]['fields'][$fieldAlias]['no_display'] = TRUE;
5807 if (isset($options['fields_required']) && in_array($specName, $options['fields_required'])) {
5808 $columns[$tableName]['fields'][$fieldAlias]['required'] = TRUE;
5811 foreach ($types as $type) {
5812 if ($options[$type] && !empty($spec['is_' . $type])) {
5813 $columns[$tableName][$type][$fieldAlias] = $spec;
5814 if (isset($defaults[$type . '_defaults']) && isset($defaults[$type . '_defaults'][$spec['name']])) {
5815 $columns[$tableName][$type][$fieldAlias]['default'] = $defaults[$type . '_defaults'][$spec['name']];
5824 * Store group bys into array - so we can check elsewhere what is grouped.
5826 protected function storeGroupByArray() {
5828 if (!CRM_Utils_Array
::value('group_bys', $this->_params
)
5829 ||
!is_array($this->_params
['group_bys'])) {
5830 $this->_params
['group_bys'] = [];
5833 foreach ($this->_columns
as $tableName => $table) {
5834 $table = $this->_columns
[$tableName];
5835 if (array_key_exists('group_bys', $table)) {
5836 foreach ($table['group_bys'] as $fieldName => $fieldData) {
5837 $field = $this->_columns
[$tableName]['metadata'][$fieldName];
5838 if (!empty($this->_params
['group_bys'][$fieldName]) ||
!empty($fieldData['required'])) {
5839 if (!empty($field['chart'])) {
5840 $this->assign('chartSupported', TRUE);
5843 if (!empty($table['group_bys'][$fieldName]['frequency']) &&
5844 !empty($this->_params
['group_bys_freq'][$fieldName])
5847 switch ($this->_params
['group_bys_freq'][$fieldName]) {
5849 $this->_groupByArray
[$tableName . '_' . $fieldName . '_start'] = self
::fiscalYearOffset($field['dbAlias']);
5853 $this->_groupByArray
[$tableName . '_' . $fieldName . '_start'] = " YEAR({$field['dbAlias']})";
5857 $this->_groupByArray
[$tableName . '_' . $fieldName . '_start'] = "YEAR({$field['dbAlias']}), QUARTER({$field['dbAlias']})";
5861 $this->_groupByArray
[$tableName . '_' . $fieldName . '_start'] = "YEARWEEK({$field['dbAlias']})";
5865 $this->_groupByArray
[$tableName . '_' . $fieldName . '_start'] = "EXTRACT(YEAR_MONTH FROM {$field['dbAlias']})";
5869 $this->_groupByArray
[$tableName . '_' . $fieldName . '_start'] = "DATE({$field['dbAlias']})";
5874 if (!in_array($field['dbAlias'], $this->_groupByArray
)) {
5875 $this->_groupByArray
[$tableName . '_' . $fieldName] = $field['dbAlias'];
5890 protected function getDefaultsFromOptions($options) {
5892 'fields_defaults' => $options['fields_defaults'],
5893 'filters_defaults' => $options['filters_defaults'],
5894 'group_bys_defaults' => $options['group_bys_defaults'],
5895 'order_bys_defaults' => $options['order_bys_defaults'],
5901 * Get the select clause for a field, wrapping in GROUP_CONCAT if appropriate.
5903 * Full group by mode dictates that a field must either be in the group by function or
5904 * wrapped in a aggregate function. Here we wrap the field in GROUP_CONCAT if it is not in the
5907 * @param string $tableName
5908 * @param string $fieldName
5909 * @param string $field
5912 protected function getSelectClauseWithGroupConcatIfNotGroupedBy($tableName, &$fieldName, &$field) {
5913 if ($this->groupConcatTested
&& (!empty($this->_groupByArray
) ||
$this->isForceGroupBy
)) {
5914 if ((empty($field['statistics']) ||
in_array('GROUP_CONCAT', $field['statistics']))) {
5915 $label = $field['title'] ??
NULL;
5916 $alias = $field['tplField'] ??
"{$tableName}_{$fieldName}";
5917 $this->_columnHeaders
["{$tableName}_{$fieldName}"]['title'] = $label;
5918 $this->_selectAliases
[] = $alias;
5919 if (empty($this->_groupByArray
[$tableName . '_' . $fieldName])) {
5920 return "GROUP_CONCAT(DISTINCT {$field['dbAlias']}) as $alias";
5922 return "({$field['dbAlias']}) as $alias";
5928 * Generate clause for the selected filter.
5930 * @param array $field
5931 * Field specification
5932 * @param string $fieldName
5936 * Relevant where clause.
5938 protected function generateFilterClause($field, $fieldName) {
5939 if (CRM_Utils_Array
::value('type', $field) & CRM_Utils_Type
::T_DATE
) {
5940 if (CRM_Utils_Array
::value('operatorType', $field) ==
5941 CRM_Report_Form
::OP_MONTH
5943 $op = $this->_params
["{$fieldName}_op"] ??
NULL;
5944 $value = $this->_params
["{$fieldName}_value"] ??
NULL;
5945 if (is_array($value) && !empty($value)) {
5946 return "(month({$field['dbAlias']}) $op (" . implode(', ', $value) .
5951 $relative = $this->_params
["{$fieldName}_relative"] ??
NULL;
5952 $from = $this->_params
["{$fieldName}_from"] ??
NULL;
5953 $to = $this->_params
["{$fieldName}_to"] ??
NULL;
5954 return $this->dateClause($field['dbAlias'], $relative, $from, $to, $field['type']);
5958 $op = $this->_params
["{$fieldName}_op"] ??
NULL;
5960 return $this->whereClause($field,
5962 CRM_Utils_Array
::value("{$fieldName}_value", $this->_params
),
5963 CRM_Utils_Array
::value("{$fieldName}_min", $this->_params
),
5964 CRM_Utils_Array
::value("{$fieldName}_max", $this->_params
)