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 = CRM_Utils_Array
::value('form_values', $this->_instanceValues
);
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 = isset($field['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 = isset($field['alias']) ?
$field['alias'] : (
794 isset($this->_columns
[$tableName]['alias']) ?
$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"] = CRM_Utils_Array
::value('from', $field['default']);
951 $this->_defaults
["{$fieldName}_to"] = CRM_Utils_Array
::value('to', $field['default']);
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"] = CRM_Utils_Array
::value('min', $field['default']);
961 $this->_defaults
["{$fieldName}_max"] = CRM_Utils_Array
::value('max', $field['default']);
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] = CRM_Utils_Array
::value('title', $field);
1220 if ($groupTitle && empty($colGroups[$tableName]['group_title'])) {
1221 $colGroups[$tableName]['group_title'] = $groupTitle;
1223 $options[$fieldName] = CRM_Utils_Array
::value('title', $field);
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 CRM_Core_Form_Date
::buildDateRange($this, $fieldName, $count, '_from', '_to', ts('From:'), FALSE, $operations);
1352 case CRM_Report_Form
::OP_DATETIME
:
1353 // build datetime fields
1354 CRM_Core_Form_Date
::buildDateRange($this, $fieldName, $count, '_from', '_to', ts('From:'), FALSE, $operations, 'searchDate', TRUE);
1358 case CRM_Report_Form
::OP_INT
:
1359 case CRM_Report_Form
::OP_FLOAT
:
1360 // and a min value input box
1361 $this->add('text', "{$fieldName}_min", ts('Min'));
1362 // and a max value input box
1363 $this->add('text', "{$fieldName}_max", ts('Max'));
1365 // default type is string
1366 $this->addElement('select', "{$fieldName}_op", ts('Operator:'), $operations,
1367 ['onchange' => "return showHideMaxMinVal( '$fieldName', this.value );"]
1369 // we need text box for value input
1370 $this->add('text', "{$fieldName}_value", NULL, ['class' => 'huge']);
1375 if (!empty($filters)) {
1376 $this->tabs
['Filters'] = [
1377 'title' => ts('Filters'),
1379 'div_label' => 'set-filters',
1382 $this->assign('filters', $filters);
1383 $this->assign('filterGroups', $filterGroups);
1387 * Function to assign the tabs to the template in the correct order.
1389 * We want the tabs to wind up in this order (if not overridden).
1397 protected function assignTabs() {
1405 $order = array_intersect_key(array_fill_keys($order, 1), $this->tabs
);
1406 $order = array_merge($order, $this->tabs
);
1407 $this->assign('tabs', $order);
1411 * The intent is to add a tab for developers to view the sql.
1413 * Currently using dpm.
1415 * @param string $sql
1417 public function addToDeveloperTab($sql) {
1418 if (!CRM_Core_Permission
::check('view report sql')) {
1421 $ignored_output_modes = ['pdf', 'csv', 'print'];
1422 if (in_array($this->_outputMode
, $ignored_output_modes)) {
1425 $this->tabs
['Developer'] = [
1426 'title' => ts('Developer'),
1427 'tpl' => 'Developer',
1428 'div_label' => 'set-developer',
1431 $this->assignTabs();
1432 $this->sqlArray
[] = $sql;
1433 foreach ($this->sqlArray
as $sql) {
1434 foreach (['LEFT JOIN'] as $term) {
1435 $sql = str_replace($term, '<br> ' . $term, $sql);
1437 foreach (['FROM', 'WHERE', 'GROUP BY', 'ORDER BY', 'LIMIT', ';'] as $term) {
1438 $sql = str_replace($term, '<br><br>' . $term, $sql);
1440 $this->sqlFormattedArray
[] = $sql;
1441 $this->assign('sql', implode(';<br><br><br><br>', $this->sqlFormattedArray
));
1443 $this->assign('sqlModes', $sqlModes = CRM_Utils_SQL
::getSqlModes());
1448 * Add options defined in $this->_options to the report.
1450 public function addOptions() {
1451 if (!empty($this->_options
)) {
1452 // FIXME: For now lets build all elements as checkboxes.
1453 // Once we clear with the format we can build elements based on type
1455 foreach ($this->_options
as $fieldName => $field) {
1458 if ($field['type'] == 'select') {
1459 $this->addElement('select', "{$fieldName}", $field['title'], $field['options']);
1461 elseif ($field['type'] == 'checkbox') {
1462 $options[$field['title']] = $fieldName;
1463 $this->addCheckBox($fieldName, NULL,
1465 NULL, NULL, NULL, $this->_fourColumnAttribute
1470 if (!empty($this->_options
) &&
1472 ||
($this->_id
&& CRM_Report_BAO_ReportInstance
::contactCanAdministerReport($this->_id
)))
1474 $this->tabs
['ReportOptions'] = [
1475 'title' => ts('Display Options'),
1476 'tpl' => 'ReportOptions',
1477 'div_label' => 'other-options',
1480 $this->assign('otherOptions', $this->_options
);
1484 * Add chart options to the report.
1486 public function addChartOptions() {
1487 if (!empty($this->_charts
)) {
1488 $this->addElement('select', "charts", ts('Chart'), $this->_charts
);
1489 $this->assign('charts', $this->_charts
);
1490 $this->addElement('submit', $this->_chartButtonName
, ts('View'));
1495 * Add group by options to the report.
1497 public function addGroupBys() {
1498 $options = $freqElements = [];
1500 foreach ($this->_columns
as $tableName => $table) {
1501 if (array_key_exists('group_bys', $table)) {
1502 foreach ($table['group_bys'] as $fieldName => $field) {
1503 if (!empty($field) && empty($field['no_display'])) {
1504 $options[$field['title']] = $fieldName;
1505 if (!empty($field['frequency'])) {
1506 $freqElements[$field['title']] = $fieldName;
1512 $this->addCheckBox("group_bys", ts('Group by columns'), $options, NULL,
1513 NULL, NULL, NULL, $this->_fourColumnAttribute
1515 $this->assign('groupByElements', $options);
1516 if (!empty($options)) {
1517 $this->tabs
['GroupBy'] = [
1518 'title' => ts('Grouping'),
1520 'div_label' => 'group-by-elements',
1524 foreach ($freqElements as $name) {
1525 $this->addElement('select', "group_bys_freq[$name]",
1526 ts('Frequency'), $this->_groupByDateFreq
1532 * Add data for order by tab.
1534 public function addOrderBys() {
1536 foreach ($this->_columns
as $tableName => $table) {
1538 // Report developer may define any column to order by; include these as order-by options.
1539 if (array_key_exists('order_bys', $table)) {
1540 foreach ($table['order_bys'] as $fieldName => $field) {
1541 if (!empty($field)) {
1542 $options[$fieldName] = $field['title'];
1547 // Add searchable custom fields as order-by options, if so requested
1548 // (These are already indexed, so allowing to order on them is cheap.)
1550 if ($this->_autoIncludeIndexedFieldsAsOrderBys
&&
1551 array_key_exists('extends', $table) && !empty($table['extends'])
1553 foreach ($table['fields'] as $fieldName => $field) {
1554 if (empty($field['no_display'])) {
1555 $options[$fieldName] = $field['title'];
1563 $this->assign('orderByOptions', $options);
1564 if (!empty($options)) {
1565 $this->tabs
['OrderBy'] = [
1566 'title' => ts('Sorting'),
1568 'div_label' => 'order-by-elements',
1572 if (!empty($options)) {
1574 '-' => ' - none - ',
1576 for ($i = 1; $i <= 5; $i++
) {
1577 $this->addElement('select', "order_bys[{$i}][column]", ts('Order by Column'), $options);
1578 $this->addElement('select', "order_bys[{$i}][order]", ts('Order by Order'), [
1579 'ASC' => ts('Ascending'),
1580 'DESC' => ts('Descending'),
1582 $this->addElement('checkbox', "order_bys[{$i}][section]", ts('Order by Section'), FALSE, ['id' => "order_by_section_$i"]);
1583 $this->addElement('checkbox', "order_bys[{$i}][pageBreak]", ts('Page Break'), FALSE, ['id' => "order_by_pagebreak_$i"]);
1589 * This adds the tab referred to as Title and Format, rendered through Instance.tpl.
1591 * @todo call this tab into the report template in the same way as OrderBy etc, ie
1592 * by adding a description of the tab to $this->tabs, causing the tab to be added in
1595 public function buildInstanceAndButtons() {
1596 CRM_Report_Form_Instance
::buildForm($this);
1597 $this->_actionButtonName
= $this->getButtonName('submit');
1598 $this->addTaskMenu($this->getActions($this->_id
));
1600 $this->assign('instanceForm', $this->_instanceForm
);
1602 // CRM-16274 Determine if user has 'edit all contacts' or equivalent
1603 $permission = CRM_Core_Permission
::getPermission();
1604 if ($this->_instanceForm
&& $permission == CRM_Core_Permission
::EDIT
&&
1605 $this->_add2groupSupported
1607 $this->addElement('select', 'groups', ts('Group'),
1608 ['' => ts('Add Contacts to Group')] +
1609 CRM_Core_PseudoConstant
::nestedGroup(),
1610 ['class' => 'crm-select2 crm-action-menu fa-plus huge']
1612 $this->assign('group', TRUE);
1615 $this->addElement('submit', $this->_groupButtonName
, '', ['style' => 'display: none;']);
1617 $this->addChartOptions();
1618 $showResultsLabel = $this->getResultsLabel();
1622 'name' => $showResultsLabel,
1623 'isDefault' => TRUE,
1629 * Has this form been submitted already?
1633 public function resultsDisplayed() {
1634 $buttonName = $this->controller
->getButtonName();
1635 return ($buttonName ||
$this->_outputMode
);
1639 * Get the actions for this report instance.
1641 * @param int $instanceId
1645 protected function getActions($instanceId) {
1646 $actions = CRM_Report_BAO_ReportInstance
::getActionMetadata();
1647 if (empty($instanceId)) {
1648 $actions['report_instance.save'] = [
1649 'title' => ts('Create Report'),
1651 'is_confirm' => TRUE,
1652 'confirm_title' => ts('Create Report'),
1653 'confirm_refresh_fields' => json_encode([
1654 'title' => ['selector' => '.crm-report-instanceForm-form-block-title', 'prepend' => ''],
1655 'description' => ['selector' => '.crm-report-instanceForm-form-block-description', 'prepend' => ''],
1659 unset($actions['report_instance.delete']);
1662 if (!$this->_csvSupported
) {
1663 unset($actions['report_instance.csv']);
1670 * Main build form function.
1672 public function buildQuickForm() {
1673 $this->addColumns();
1675 $this->addFilters();
1677 $this->addOptions();
1679 $this->addGroupBys();
1681 $this->addOrderBys();
1683 $this->buildInstanceAndButtons();
1685 // Add form rule for report.
1690 $this->addFormRule([get_class($this), 'formRule'], $this);
1692 $this->assignTabs();
1696 * A form rule function for custom data.
1698 * The rule ensures that fields selected in group_by if any) should only be the ones
1699 * present in display/select fields criteria;
1700 * note: works if and only if any custom field selected in group_by.
1702 * @param array $fields
1703 * @param array $ignoreFields
1707 public function customDataFormRule($fields, $ignoreFields = []) {
1709 if (!empty($this->_customGroupExtends
) && $this->_customGroupGroupBy
&&
1710 !empty($fields['group_bys'])
1712 foreach ($this->_columns
as $tableName => $table) {
1713 if ((substr($tableName, 0, 13) == 'civicrm_value' ||
1714 substr($tableName, 0, 12) == 'custom_value') &&
1715 !empty($this->_columns
[$tableName]['fields'])
1717 foreach ($this->_columns
[$tableName]['fields'] as $fieldName => $field) {
1718 if (array_key_exists($fieldName, $fields['group_bys']) &&
1719 !array_key_exists($fieldName, $fields['fields'])
1721 $errors['fields'] = "Please make sure fields selected in 'Group by Columns' section are also selected in 'Display Columns' section.";
1723 elseif (array_key_exists($fieldName, $fields['group_bys'])) {
1724 foreach ($fields['fields'] as $fld => $val) {
1725 if (!array_key_exists($fld, $fields['group_bys']) &&
1726 !in_array($fld, $ignoreFields)
1728 $errors['fields'] = "Please ensure that fields selected in 'Display Columns' are also selected in 'Group by Columns' section.";
1740 * Get operators to display on form.
1742 * Note: $fieldName param allows inheriting class to build operationPairs specific to a field.
1744 * @param string $type
1745 * @param string $fieldName
1749 public function getOperationPair($type = "string", $fieldName = NULL) {
1750 // FIXME: At some point we should move these key-val pairs
1751 // to option_group and option_value table.
1753 case CRM_Report_Form
::OP_INT
:
1754 case CRM_Report_Form
::OP_FLOAT
:
1757 'lte' => ts('Is less than or equal to'),
1758 'gte' => ts('Is greater than or equal to'),
1759 'bw' => ts('Is between'),
1760 'eq' => ts('Is equal to'),
1761 'lt' => ts('Is less than'),
1762 'gt' => ts('Is greater than'),
1763 'neq' => ts('Is not equal to'),
1764 'nbw' => ts('Is not between'),
1765 'nll' => ts('Is empty (Null)'),
1766 'nnll' => ts('Is not empty (Null)'),
1770 case CRM_Report_Form
::OP_SELECT
:
1772 'eq' => ts('Is equal to'),
1776 case CRM_Report_Form
::OP_MONTH
:
1777 case CRM_Report_Form
::OP_MULTISELECT
:
1778 case CRM_Report_Form
::OP_ENTITYREF
:
1781 'in' => ts('Is one of'),
1782 'notin' => ts('Is not one of'),
1783 'nll' => ts('Is empty (Null)'),
1784 'nnll' => ts('Is not empty (Null)'),
1788 case CRM_Report_Form
::OP_DATE
:
1791 'nll' => ts('Is empty (Null)'),
1792 'nnll' => ts('Is not empty (Null)'),
1796 case CRM_Report_Form
::OP_MULTISELECT_SEPARATOR
:
1797 // use this operator for the values, concatenated with separator. For e.g if
1798 // multiple options for a column is stored as ^A{val1}^A{val2}^A
1800 'mhas' => ts('Is one of'),
1801 'mnot' => ts('Is not one of'),
1808 'has' => ts('Contains'),
1809 'sw' => ts('Starts with'),
1810 'ew' => ts('Ends with'),
1811 'nhas' => ts('Does not contain'),
1812 'eq' => ts('Is equal to'),
1813 'neq' => ts('Is not equal to'),
1814 'nll' => ts('Is empty (Null)'),
1815 'nnll' => ts('Is not empty (Null)'),
1822 * Build the tag filter field to display on the filters tab.
1824 public function buildTagFilter() {
1825 $contactTags = CRM_Core_BAO_Tag
::getTags($this->_tagFilterTable
);
1826 if (!empty($contactTags)) {
1827 $this->_columns
['civicrm_tag'] = [
1828 'dao' => 'CRM_Core_DAO_Tag',
1832 'title' => ts('Tag'),
1833 'type' => CRM_Utils_Type
::T_INT
,
1835 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
1836 'options' => $contactTags,
1844 * Adds group filters to _columns (called from _Construct).
1846 public function buildGroupFilter() {
1847 $this->_columns
['civicrm_group']['filters'] = [
1849 'name' => 'group_id',
1850 'title' => ts('Group'),
1851 'type' => CRM_Utils_Type
::T_INT
,
1852 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
1854 'options' => CRM_Core_PseudoConstant
::nestedGroup(),
1857 if (empty($this->_columns
['civicrm_group']['dao'])) {
1858 $this->_columns
['civicrm_group']['dao'] = 'CRM_Contact_DAO_GroupContact';
1860 if (empty($this->_columns
['civicrm_group']['alias'])) {
1861 $this->_columns
['civicrm_group']['alias'] = 'cgroup';
1866 * Get SQL operator from form text version.
1868 * @param string $operator
1872 public function getSQLOperator($operator = "like") {
1873 switch ($operator) {
1906 return 'IS NOT NULL';
1915 * Generate where clause.
1917 * This can be overridden in reports for special treatment of a field
1919 * @param array $field Field specifications
1920 * @param string $op Query operator (not an exact match to sql)
1921 * @param mixed $value
1925 * @return null|string
1927 public function whereClause(&$field, $op, $value, $min, $max) {
1929 $type = CRM_Utils_Type
::typeToString(CRM_Utils_Array
::value('type', $field));
1931 // CRM-18010: Ensure type of each report filters
1933 trigger_error('Type is not defined for field ' . $field['name'], E_USER_WARNING
);
1940 if (($min !== NULL && strlen($min) > 0) ||
1941 ($max !== NULL && strlen($max) > 0)
1945 $min = CRM_Utils_Type
::escape($min, $type);
1947 $clauses[] = "( {$field['dbAlias']} >= $min )";
1950 $clauses[] = "( {$field['dbAlias']} < $min OR {$field['dbAlias']} IS NULL )";
1954 $max = CRM_Utils_Type
::escape($max, $type);
1956 $clauses[] = "( {$field['dbAlias']} <= $max )";
1959 $clauses[] = "( {$field['dbAlias']} > $max )";
1963 if (!empty($clauses)) {
1965 $clause = implode(' AND ', $clauses);
1968 $clause = '(' . implode('OR', $clauses) . ')';
1976 if ($value !== NULL && strlen($value) > 0) {
1977 $value = CRM_Utils_Type
::escape($value, $type);
1978 if (strpos($value, '%') === FALSE) {
1979 $value = "'%{$value}%'";
1982 $value = "'{$value}'";
1984 $sqlOP = $this->getSQLOperator($op);
1985 $clause = "( {$field['dbAlias']} $sqlOP $value )";
1991 if ((is_string($value) ||
is_numeric($value)) && strlen($value)) {
1992 $value = explode(',', $value);
1994 if ($value !== NULL && is_array($value) && count($value) > 0) {
1995 $sqlOP = $this->getSQLOperator($op);
1996 if (CRM_Utils_Array
::value('type', $field) ==
1997 CRM_Utils_Type
::T_STRING
1999 //cycle through selections and escape values
2000 foreach ($value as $key => $selection) {
2001 $value[$key] = CRM_Utils_Type
::escape($selection, $type);
2004 = "( {$field['dbAlias']} $sqlOP ( '" . implode("' , '", $value) .
2008 // for numerical values
2009 $clause = "{$field['dbAlias']} $sqlOP (" . implode(', ', $value) .
2012 if ($op == 'notin') {
2013 $clause = "( " . $clause . " OR {$field['dbAlias']} IS NULL )";
2016 $clause = "( " . $clause . " )";
2023 // multiple has or multiple not
2024 if ($value !== NULL && count($value) > 0) {
2025 $value = CRM_Utils_Type
::escapeAll($value, $type);
2026 $operator = $op == 'mnot' ?
'NOT' : '';
2027 $regexp = "([[:cntrl:]]|^)" . implode('([[:cntrl:]]|$)|([[:cntrl:]]|^)', (array) $value) . "([[:cntrl:]]|$)";
2028 $clause = "{$field['dbAlias']} {$operator} REGEXP '{$regexp}'";
2034 if ($value !== NULL && strlen($value) > 0) {
2035 $value = CRM_Utils_Type
::escape($value, $type);
2036 if (strpos($value, '%') === FALSE) {
2038 $value = "'{$value}%'";
2041 $value = "'%{$value}'";
2045 $value = "'{$value}'";
2047 $sqlOP = $this->getSQLOperator($op);
2048 $clause = "( {$field['dbAlias']} $sqlOP $value )";
2054 $sqlOP = $this->getSQLOperator($op);
2055 $clause = "( {$field['dbAlias']} $sqlOP )";
2061 //CRM-18457: some custom field passes value in array format against binary operator
2062 if (is_array($value) && count($value)) {
2067 if ($value !== NULL && $value !== '') {
2068 if (isset($field['clause'])) {
2069 // FIXME: we not doing escape here. Better solution is to use two
2070 // different types - data-type and filter-type
2071 $clause = $field['clause'];
2073 elseif (!is_array($value)) {
2074 $value = CRM_Utils_Type
::escape($value, $type);
2075 $sqlOP = $this->getSQLOperator($op);
2076 if ($field['type'] == CRM_Utils_Type
::T_STRING
) {
2077 $value = "'{$value}'";
2079 $clause = "( {$field['dbAlias']} $sqlOP $value )";
2085 //dev/core/544 Add report support for multiple contact subTypes
2086 if ($field['name'] == 'contact_sub_type' && $clause) {
2087 $clause = $this->whereSubtypeClause($field, $value, $op);
2089 if (!empty($field['group']) && $clause) {
2090 $clause = $this->whereGroupClause($field, $value, $op);
2092 elseif (!empty($field['tag']) && $clause) {
2093 // not using left join in query because if any contact
2094 // belongs to more than one tag, results duplicate
2096 $clause = $this->whereTagClause($field, $value, $op);
2098 elseif (!empty($field['membership_org']) && $clause) {
2099 $clause = $this->whereMembershipOrgClause($value, $op);
2101 elseif (!empty($field['membership_type']) && $clause) {
2102 $clause = $this->whereMembershipTypeClause($value, $op);
2108 * Get SQL where clause for contact subtypes
2109 * @param string $field
2110 * @param mixed $value
2111 * @param string $op SQL Operator
2115 public function whereSubtypeClause($field, $value, $op) {
2116 // Get the correct SQL operator.
2121 $clauseSeparator = ' AND ';
2127 $clauseSeparator = ' OR ';
2130 $sqlOp = $this->getSQLOperator($op);
2131 if ($sqlOp == 'IS NULL' ||
$sqlOp == 'IS NOT NULL') {
2132 $clause = "{$field['dbAlias']} $sqlOp";
2136 foreach ($value as $item) {
2137 $subclauses[] = "( {$field['dbAlias']} $sqlOp '%" . CRM_Core_DAO
::VALUE_SEPARATOR
. $item . CRM_Core_DAO
::VALUE_SEPARATOR
. "%' )";
2139 $clause = implode($clauseSeparator, $subclauses);
2141 $clause = "( $clause )";
2143 $clause = "( ( {$field['dbAlias']} IS NULL ) OR $clause )";
2149 * Get SQL where clause for a date field.
2151 * @param string $fieldName
2152 * @param string $relative
2153 * @param string $from
2155 * @param string $type
2156 * @param string $fromTime
2157 * @param string $toTime
2159 * @return null|string
2161 public function dateClause(
2163 $relative, $from, $to, $type = NULL, $fromTime = NULL, $toTime = NULL
2166 if (in_array($relative, array_keys($this->getOperationPair(CRM_Report_Form
::OP_DATE
)))) {
2167 $sqlOP = $this->getSQLOperator($relative);
2168 return "( {$fieldName} {$sqlOP} )";
2171 list($from, $to) = $this->getFromTo($relative, $from, $to, $fromTime, $toTime);
2174 $clauses[] = "( {$fieldName} >= $from )";
2178 $clauses[] = "( {$fieldName} <= {$to} )";
2181 if (!empty($clauses)) {
2182 return implode(' AND ', $clauses);
2189 * Get values for from and to for date ranges.
2193 * @param bool $relative
2194 * @param string $from
2196 * @param string $fromTime
2197 * @param string $toTime
2201 public function getFromTo($relative, $from, $to, $fromTime = NULL, $toTime = NULL) {
2202 if (empty($toTime)) {
2203 // odd legacy behaviour to treat NULL as 'end of the day'
2204 // recommend updating reports to call CRM_Utils_Date::getFromTo
2205 //directly (default on the function is the actual default there).
2208 return CRM_Utils_Date
::getFromTo($relative, $from, $to, $fromTime, $toTime);
2212 * Alter display of rows.
2214 * Iterate through the rows retrieved via SQL and make changes for display purposes,
2215 * such as rendering contacts as links.
2217 * @param array $rows
2218 * Rows generated by SQL, with an array for each row.
2220 public function alterDisplay(&$rows) {
2224 * Alter the way in which custom data fields are displayed.
2226 * @param array $rows
2228 public function alterCustomDataDisplay(&$rows) {
2229 // custom code to alter rows having custom values
2230 if (empty($this->_customGroupExtends
)) {
2235 $customFieldIds = [];
2236 foreach ($this->_params
['fields'] as $fieldAlias => $value) {
2237 if ($fieldId = CRM_Core_BAO_CustomField
::getKeyID($fieldAlias)) {
2238 $customFieldIds[$fieldAlias] = $fieldId;
2241 if (empty($customFieldIds)) {
2245 // skip for type date and ContactReference since date format is already handled
2247 SELECT cg.table_name, cf.id
2248 FROM civicrm_custom_field cf
2249 INNER JOIN civicrm_custom_group cg ON cg.id = cf.custom_group_id
2250 WHERE cg.extends IN ('" . implode("','", $this->_customGroupExtends
) . "') AND
2251 cg.is_active = 1 AND
2252 cf.is_active = 1 AND
2253 cf.is_searchable = 1 AND
2254 cf.data_type NOT IN ('ContactReference', 'Date') AND
2255 cf.id IN (" . implode(",", $customFieldIds) . ")";
2257 $dao = CRM_Core_DAO
::executeQuery($query);
2258 while ($dao->fetch()) {
2259 $customFields[$dao->table_name
. '_custom_' . $dao->id
] = $dao->id
;
2262 $entryFound = FALSE;
2263 foreach ($rows as $rowNum => $row) {
2264 foreach ($row as $tableCol => $val) {
2265 if (array_key_exists($tableCol, $customFields)) {
2266 $rows[$rowNum][$tableCol] = CRM_Core_BAO_CustomField
::displayValue($val, $customFields[$tableCol]);
2271 // skip looking further in rows, if first row itself doesn't
2272 // have the column we need
2280 * Remove duplicate rows.
2282 * @param array $rows
2284 public function removeDuplicates(&$rows) {
2285 if (empty($this->_noRepeats
)) {
2290 foreach ($rows as $key => $list) {
2291 foreach ($list as $colName => $colVal) {
2292 if (array_key_exists($colName, $checkList) &&
2293 $checkList[$colName] == $colVal
2295 $rows[$key][$colName] = "";
2297 if (in_array($colName, $this->_noRepeats
)) {
2298 $checkList[$colName] = $colVal;
2305 * Fix subtotal display.
2308 * @param array $fields
2309 * @param bool $subtotal
2311 public function fixSubTotalDisplay(&$row, $fields, $subtotal = TRUE) {
2312 foreach ($row as $colName => $colVal) {
2313 if (in_array($colName, $fields)) {
2315 elseif (isset($this->_columnHeaders
[$colName])) {
2317 $row[$colName] = 'Subtotal';
2321 unset($row[$colName]);
2328 * Calculate grant total.
2330 * @param array $rows
2334 public function grandTotal(&$rows) {
2335 if (!$this->_rollup ||
count($rows) == 1) {
2339 $this->moveSummaryColumnsToTheRightHandSide();
2341 if ($this->_limit
&& count($rows) >= self
::ROW_COUNT_LIMIT
) {
2345 $this->rollupRow
= array_pop($rows);
2347 foreach ($this->_columnHeaders
as $fld => $val) {
2348 if (!in_array($fld, $this->_statFields
)) {
2349 if (!$this->_grandFlag
) {
2350 $this->rollupRow
[$fld] = ts('Grand Total');
2351 $this->_grandFlag
= TRUE;
2354 $this->rollupRow
[$fld] = "";
2359 $this->assign('grandStat', $this->rollupRow
);
2364 * Format display output.
2366 * @param array $rows
2367 * @param bool $pager
2369 public function formatDisplay(&$rows, $pager = TRUE) {
2370 // set pager based on if any limit was applied in the query.
2375 // allow building charts if any
2376 if (!empty($this->_params
['charts']) && !empty($rows)) {
2377 $this->buildChart($rows);
2378 $this->assign('chartEnabled', TRUE);
2379 $this->_chartId
= "{$this->_params['charts']}_" .
2380 ($this->_id ?
$this->_id
: substr(get_class($this), 16)) . '_' .
2382 $this->assign('chartId', $this->_chartId
);
2385 // unset columns not to be displayed.
2386 foreach ($this->_columnHeaders
as $key => $value) {
2387 if (!empty($value['no_display'])) {
2388 unset($this->_columnHeaders
[$key]);
2392 // unset columns not to be displayed.
2393 if (!empty($rows)) {
2394 foreach ($this->_noDisplay
as $noDisplayField) {
2395 foreach ($rows as $rowNum => $row) {
2396 unset($this->_columnHeaders
[$noDisplayField]);
2401 // Find alter display functions.
2402 $firstRow = reset($rows);
2404 $selectedFields = array_keys($firstRow);
2405 $alterFunctions = $alterMap = $alterSpecs = [];
2406 foreach ($this->_columns
as $tableName => $table) {
2407 if (array_key_exists('metadata', $table)) {
2408 foreach ($table['metadata'] as $field => $specs) {
2409 if (in_array($tableName . '_' . $field, $selectedFields)) {
2410 if (array_key_exists('alter_display', $specs)) {
2411 $alterFunctions[$tableName . '_' . $field] = $specs['alter_display'];
2412 $alterMap[$tableName . '_' . $field] = $field;
2413 $alterSpecs[$tableName . '_' . $field] = NULL;
2415 // Add any alters that can be intuited from the field specs.
2416 // So far only boolean but a lot more could be.
2417 if (empty($alterSpecs[$tableName . '_' . $field]) && isset($specs['type']) && $specs['type'] == CRM_Utils_Type
::T_BOOLEAN
) {
2418 $alterFunctions[$tableName . '_' . $field] = 'alterBoolean';
2419 $alterMap[$tableName . '_' . $field] = $field;
2420 $alterSpecs[$tableName . '_' . $field] = NULL;
2427 // Run the alter display functions
2428 foreach ($rows as $index => & $row) {
2429 foreach ($row as $selectedField => $value) {
2430 if (array_key_exists($selectedField, $alterFunctions) && isset($value)) {
2431 $rows[$index][$selectedField] = $this->{$alterFunctions[$selectedField]}($value, $row, $selectedField, $alterMap[$selectedField], $alterSpecs[$selectedField]);
2437 // use this method for formatting rows for display purpose.
2438 $this->alterDisplay($rows);
2439 CRM_Utils_Hook
::alterReportVar('rows', $rows, $this);
2441 // build array of section totals
2442 $this->sectionTotals();
2444 // process grand-total row
2445 $this->grandTotal($rows);
2447 // use this method for formatting custom rows for display purpose.
2448 $this->alterCustomDataDisplay($rows);
2454 * @param $selectedfield
2455 * @param $criteriaFieldName
2459 protected function alterStateProvinceID($value, &$row, $selectedfield, $criteriaFieldName) {
2460 $url = CRM_Utils_System
::url(CRM_Utils_System
::currentPath(), "reset=1&force=1&{$criteriaFieldName}_op=in&{$criteriaFieldName}_value={$value}", $this->_absoluteUrl
);
2461 $row[$selectedfield . '_link'] = $url;
2462 $row[$selectedfield . '_hover'] = ts("%1 for this state.", [
2466 $states = CRM_Core_PseudoConstant
::stateProvince($value, FALSE);
2467 if (!is_array($states)) {
2475 * @param $selectedField
2476 * @param $criteriaFieldName
2480 protected function alterCountryID($value, &$row, $selectedField, $criteriaFieldName) {
2481 $url = CRM_Utils_System
::url(CRM_Utils_System
::currentPath(), "reset=1&force=1&{$criteriaFieldName}_op=in&{$criteriaFieldName}_value={$value}", $this->_absoluteUrl
);
2482 $row[$selectedField . '_link'] = $url;
2483 $row[$selectedField . '_hover'] = ts("%1 for this country.", [
2486 $countries = CRM_Core_PseudoConstant
::country($value, FALSE);
2487 if (!is_array($countries)) {
2495 * @param $selectedfield
2496 * @param $criteriaFieldName
2500 protected function alterCountyID($value, &$row, $selectedfield, $criteriaFieldName) {
2501 $url = CRM_Utils_System
::url(CRM_Utils_System
::currentPath(), "reset=1&force=1&{$criteriaFieldName}_op=in&{$criteriaFieldName}_value={$value}", $this->_absoluteUrl
);
2502 $row[$selectedfield . '_link'] = $url;
2503 $row[$selectedfield . '_hover'] = ts("%1 for this county.", [
2506 $counties = CRM_Core_PseudoConstant
::county($value, FALSE);
2507 if (!is_array($counties)) {
2515 * @param $selectedfield
2516 * @param $criteriaFieldName
2520 protected function alterLocationTypeID($value, &$row, $selectedfield, $criteriaFieldName) {
2521 return CRM_Core_PseudoConstant
::getLabel('CRM_Core_DAO_Address', 'location_type_id', $value);
2531 protected function alterContactID($value, &$row, $fieldname) {
2532 $nameField = substr($fieldname, 0, -2) . 'name';
2533 static $first = TRUE;
2534 static $viewContactList = FALSE;
2536 $viewContactList = CRM_Core_Permission
::check('access CiviCRM');
2539 if (!$viewContactList) {
2542 if (array_key_exists($nameField, $row)) {
2543 $row[$nameField . '_link'] = CRM_Utils_System
::url("civicrm/contact/view", 'reset=1&cid=' . $value, $this->_absoluteUrl
);
2546 $row[$fieldname . '_link'] = CRM_Utils_System
::url("civicrm/contact/view", 'reset=1&cid=' . $value, $this->_absoluteUrl
);
2556 protected function alterBoolean($value) {
2557 $options = [0 => '', 1 => ts('Yes')];
2558 if (isset($options[$value])) {
2559 return $options[$value];
2567 * @param array $rows
2569 public function buildChart(&$rows) {
2570 // override this method for building charts.
2573 // select() method below has been added recently (v3.3), and many of the report templates might
2574 // still be having their own select() method. We should fix them as and when encountered and move
2575 // towards generalizing the select() method below.
2578 * Generate the SELECT clause and set class variable $_select.
2580 public function select() {
2581 $select = $this->_selectAliases
= [];
2582 $this->storeGroupByArray();
2584 foreach ($this->_columns
as $tableName => $table) {
2585 if (array_key_exists('fields', $table)) {
2586 foreach ($table['fields'] as $fieldName => $field) {
2587 if ($tableName == 'civicrm_address') {
2588 // deprecated, use $this->isTableSelected.
2589 $this->_addressField
= TRUE;
2591 if ($tableName == 'civicrm_email') {
2592 $this->_emailField
= TRUE;
2594 if ($tableName == 'civicrm_phone') {
2595 $this->_phoneField
= TRUE;
2598 if (!empty($field['required']) ||
2599 !empty($this->_params
['fields'][$fieldName])
2602 // 1. In many cases we want select clause to be built in slightly different way
2603 // for a particular field of a particular type.
2604 // 2. This method when used should receive params by reference and modify $this->_columnHeaders
2606 $selectClause = $this->selectClause($tableName, 'fields', $fieldName, $field);
2607 if ($selectClause) {
2608 $select[] = $selectClause;
2612 // include statistics columns only if set
2613 if (!empty($field['statistics']) && !empty($this->_groupByArray
)) {
2614 $select = $this->addStatisticsToSelect($field, $tableName, $fieldName, $select);
2618 $selectClause = $this->getSelectClauseWithGroupConcatIfNotGroupedBy($tableName, $fieldName, $field);
2619 if ($selectClause) {
2620 $select[] = $selectClause;
2623 $select = $this->addBasicFieldToSelect($tableName, $fieldName, $field, $select);
2630 // select for group bys
2631 if (array_key_exists('group_bys', $table)) {
2632 foreach ($table['group_bys'] as $fieldName => $field) {
2634 if ($tableName == 'civicrm_address') {
2635 $this->_addressField
= TRUE;
2637 if ($tableName == 'civicrm_email') {
2638 $this->_emailField
= TRUE;
2640 if ($tableName == 'civicrm_phone') {
2641 $this->_phoneField
= TRUE;
2643 // 1. In many cases we want select clause to be built in slightly different way
2644 // for a particular field of a particular type.
2645 // 2. This method when used should receive params by reference and modify $this->_columnHeaders
2647 $selectClause = $this->selectClause($tableName, 'group_bys', $fieldName, $field);
2648 if ($selectClause) {
2649 $select[] = $selectClause;
2653 if (!empty($this->_params
['group_bys']) &&
2654 !empty($this->_params
['group_bys'][$fieldName]) &&
2655 !empty($this->_params
['group_bys_freq'])
2657 switch (CRM_Utils_Array
::value($fieldName, $this->_params
['group_bys_freq'])) {
2659 $select[] = "DATE_SUB({$field['dbAlias']}, INTERVAL WEEKDAY({$field['dbAlias']}) DAY) AS {$tableName}_{$fieldName}_start";
2660 $select[] = "YEARWEEK({$field['dbAlias']}) AS {$tableName}_{$fieldName}_subtotal";
2661 $select[] = "WEEKOFYEAR({$field['dbAlias']}) AS {$tableName}_{$fieldName}_interval";
2662 $field['title'] = 'Week';
2666 $select[] = "MAKEDATE(YEAR({$field['dbAlias']}), 1) AS {$tableName}_{$fieldName}_start";
2667 $select[] = "YEAR({$field['dbAlias']}) AS {$tableName}_{$fieldName}_subtotal";
2668 $select[] = "YEAR({$field['dbAlias']}) AS {$tableName}_{$fieldName}_interval";
2669 $field['title'] = 'Year';
2673 $select[] = "DATE_SUB({$field['dbAlias']}, INTERVAL (DAYOFMONTH({$field['dbAlias']})-1) DAY) as {$tableName}_{$fieldName}_start";
2674 $select[] = "MONTH({$field['dbAlias']}) AS {$tableName}_{$fieldName}_subtotal";
2675 $select[] = "MONTHNAME({$field['dbAlias']}) AS {$tableName}_{$fieldName}_interval";
2676 $field['title'] = 'Month';
2680 $select[] = "STR_TO_DATE(CONCAT( 3 * QUARTER( {$field['dbAlias']} ) -2 , '/', '1', '/', YEAR( {$field['dbAlias']} ) ), '%m/%d/%Y') AS {$tableName}_{$fieldName}_start";
2681 $select[] = "QUARTER({$field['dbAlias']}) AS {$tableName}_{$fieldName}_subtotal";
2682 $select[] = "QUARTER({$field['dbAlias']}) AS {$tableName}_{$fieldName}_interval";
2683 $field['title'] = 'Quarter';
2686 // for graphs and charts -
2687 if (!empty($this->_params
['group_bys_freq'][$fieldName])) {
2688 $this->_interval
= $field['title'];
2689 $this->_columnHeaders
["{$tableName}_{$fieldName}_start"]['title']
2690 = $field['title'] . ' Beginning';
2691 $this->_columnHeaders
["{$tableName}_{$fieldName}_start"]['type'] = $field['type'];
2692 $this->_columnHeaders
["{$tableName}_{$fieldName}_start"]['group_by'] = $this->_params
['group_bys_freq'][$fieldName];
2694 // just to make sure these values are transferred to rows.
2695 // since we 'll need them for calculation purpose,
2696 // e.g making subtotals look nicer or graphs
2697 $this->_columnHeaders
["{$tableName}_{$fieldName}_interval"] = ['no_display' => TRUE];
2698 $this->_columnHeaders
["{$tableName}_{$fieldName}_subtotal"] = ['no_display' => TRUE];
2705 if (empty($select)) {
2706 // CRM-21412 Do not give fatal error on report when no fields selected
2710 $this->_selectClauses
= $select;
2711 $this->_select
= "SELECT " . implode(', ', $select) . " ";
2715 * Build select clause for a single field.
2717 * @param string $tableName
2718 * @param string $tableKey
2719 * @param string $fieldName
2720 * @param string $field
2724 public function selectClause(&$tableName, $tableKey, &$fieldName, &$field) {
2725 if (!empty($field['pseudofield'])) {
2726 $alias = "{$tableName}_{$fieldName}";
2727 $this->_columnHeaders
["{$tableName}_{$fieldName}"]['title'] = CRM_Utils_Array
::value('title', $field);
2728 $this->_columnHeaders
["{$tableName}_{$fieldName}"]['type'] = CRM_Utils_Array
::value('type', $field);
2729 $this->_columnHeaders
["{$tableName}_{$fieldName}"]['dbAlias'] = CRM_Utils_Array
::value('dbAlias', $field);
2730 $this->_selectAliases
[] = $alias;
2731 return ' 1 as ' . $alias;
2737 * Build where clause.
2739 public function where() {
2740 $this->storeWhereHavingClauseArray();
2742 if (empty($this->_whereClauses
)) {
2743 $this->_where
= "WHERE ( 1 ) ";
2744 $this->_having
= "";
2747 $this->_where
= "WHERE " . implode(' AND ', $this->_whereClauses
);
2750 if ($this->_aclWhere
) {
2751 $this->_where
.= " AND {$this->_aclWhere} ";
2754 if (!empty($this->_havingClauses
)) {
2755 // use this clause to construct group by clause.
2756 $this->_having
= "HAVING " . implode(' AND ', $this->_havingClauses
);
2761 * Store Where clauses into an array.
2763 * Breaking out this step makes over-riding more flexible as the clauses can be used in constructing a
2764 * temp table that may not be part of the final where clause or added
2765 * in other functions
2767 public function storeWhereHavingClauseArray() {
2768 foreach ($this->_columns
as $tableName => $table) {
2769 if (array_key_exists('filters', $table)) {
2770 foreach ($table['filters'] as $fieldName => $field) {
2771 // respect pseudofield to filter spec so fields can be marked as
2772 // not to be handled here
2773 if (!empty($field['pseudofield'])) {
2776 $clause = $this->generateFilterClause($field, $fieldName);
2778 if (!empty($clause)) {
2779 if (!empty($field['having'])) {
2780 $this->_havingClauses
[] = $clause;
2783 $this->_whereClauses
[] = $clause;
2795 public function processReportMode() {
2796 $this->setOutputMode();
2799 = CRM_Utils_Request
::retrieve(
2802 CRM_Core_DAO
::$_nullObject
2805 $this->_absoluteUrl
= FALSE;
2807 $this->assign('printOnly', FALSE);
2809 if ($this->_outputMode
== 'print' ||
2810 ($this->_sendmail
&& !$this->_outputMode
)
2812 $this->assign('printOnly', TRUE);
2814 $this->addPaging
= FALSE;
2815 $this->assign('outputMode', 'print');
2816 $this->_outputMode
= 'print';
2817 if ($this->_sendmail
) {
2818 $this->_absoluteUrl
= TRUE;
2821 elseif ($this->_outputMode
== 'pdf') {
2823 $this->addPaging
= FALSE;
2824 $this->_absoluteUrl
= TRUE;
2826 elseif ($this->_outputMode
== 'csv') {
2828 $this->_absoluteUrl
= TRUE;
2829 $this->addPaging
= FALSE;
2831 elseif ($this->_outputMode
== 'group') {
2832 $this->assign('outputMode', 'group');
2834 elseif ($this->_outputMode
== 'create_report' && $this->_criteriaForm
) {
2835 $this->assign('outputMode', 'create_report');
2837 elseif ($this->_outputMode
== 'copy' && $this->_criteriaForm
) {
2838 $this->_createNew
= TRUE;
2841 $this->assign('outputMode', $this->_outputMode
);
2842 $this->assign('printOnly', $printOnly);
2843 // Get today's date to include in printed reports
2845 $reportDate = CRM_Utils_Date
::customFormat(date('Y-m-d H:i'));
2846 $this->assign('reportDate', $reportDate);
2851 * Post Processing function for Form.
2853 * postProcessCommon should be used to set other variables from input as the api accesses that function.
2854 * This function is not accessed when the api calls the report.
2856 public function beginPostProcess() {
2857 $this->setParams($this->controller
->exportValues($this->_name
));
2858 if (empty($this->_params
) &&
2861 $this->setParams($this->_formValues
);
2864 // hack to fix params when submitted from dashboard, CRM-8532
2865 // fields array is missing because form building etc is skipped
2866 // in dashboard mode for report
2867 //@todo - this could be done in the dashboard no we have a setter
2868 if (empty($this->_params
['fields']) && !$this->_noFields
) {
2869 $this->setParams($this->_formValues
);
2872 $this->processReportMode();
2874 if ($this->_outputMode
== 'save' ||
$this->_outputMode
== 'copy') {
2875 $this->_createNew
= ($this->_outputMode
== 'copy');
2876 CRM_Report_Form_Instance
::postProcess($this);
2878 if ($this->_outputMode
== 'delete') {
2879 CRM_Report_BAO_ReportInstance
::doFormDelete($this->_id
, 'civicrm/report/list?reset=1', 'civicrm/report/list?reset=1');
2882 $this->_formValues
= $this->_params
;
2884 $this->beginPostProcessCommon();
2888 * BeginPostProcess function run in both report mode and non-report mode (api).
2890 public function beginPostProcessCommon() {
2894 * Build the report query.
2896 * @param bool $applyLimit
2900 public function buildQuery($applyLimit = TRUE) {
2901 $this->buildGroupTempTable();
2904 $this->customDataFrom();
2905 $this->buildPermissionClause();
2910 foreach ($this->unselectedOrderByColumns() as $alias => $field) {
2911 $clause = $this->getSelectClauseWithGroupConcatIfNotGroupedBy($field['table_name'], $field['name'], $field);
2913 $clause = "{$field['dbAlias']} as {$alias}";
2915 $this->_select
.= ", $clause ";
2918 if ($applyLimit && empty($this->_params
['charts'])) {
2921 CRM_Utils_Hook
::alterReportVar('sql', $this, $this);
2923 $sql = "{$this->_select} {$this->_from} {$this->_where} {$this->_groupBy} {$this->_having} {$this->_orderBy} {$this->_limit}";
2924 $this->addToDeveloperTab($sql);
2929 * Build group by clause.
2931 public function groupBy() {
2932 $this->storeGroupByArray();
2934 if (!empty($this->_groupByArray
)) {
2935 if ($this->optimisedForOnlyFullGroupBy
) {
2936 // We should probably deprecate this code path. What happens here is that
2937 // the group by is amended to reflect the select columns. This often breaks the
2938 // results. Retrofitting group strict group by onto existing report classes
2940 $this->_groupBy
= CRM_Contact_BAO_Query
::getGroupByFromSelectColumns($this->_selectClauses
, $this->_groupByArray
);
2943 $this->_groupBy
= ' GROUP BY ' . implode($this->_groupByArray
);
2949 * Build order by clause.
2951 public function orderBy() {
2952 $this->_orderBy
= "";
2953 $this->_sections
= [];
2954 $this->storeOrderByArray();
2955 if (!empty($this->_orderByArray
) && !$this->_rollup
== 'WITH ROLLUP') {
2956 $this->_orderBy
= "ORDER BY " . implode(', ', $this->_orderByArray
);
2958 $this->assign('sections', $this->_sections
);
2962 * Extract order by fields and store as an array.
2964 * In some cases other functions want to know which fields are selected for ordering by
2965 * Separating this into a separate function allows it to be called separately from constructing
2966 * the order by clause
2968 public function storeOrderByArray() {
2971 if (!empty($this->_params
['order_bys']) &&
2972 is_array($this->_params
['order_bys']) &&
2973 !empty($this->_params
['order_bys'])
2976 // Process order_bys in user-specified order
2977 foreach ($this->_params
['order_bys'] as $orderBy) {
2979 foreach ($this->_columns
as $tableName => $table) {
2980 if (array_key_exists('order_bys', $table)) {
2981 // For DAO columns defined in $this->_columns
2982 $fields = $table['order_bys'];
2984 elseif (array_key_exists('extends', $table)) {
2985 // For custom fields referenced in $this->_customGroupExtends
2986 $fields = CRM_Utils_Array
::value('fields', $table, []);
2991 if (!empty($fields) && is_array($fields)) {
2992 foreach ($fields as $fieldName => $field) {
2993 if ($fieldName == $orderBy['column']) {
2994 $orderByField = array_merge($field, $orderBy);
2995 $orderByField['tplField'] = "{$tableName}_{$fieldName}";
3002 if (!empty($orderByField)) {
3003 $this->_orderByFields
[$orderByField['tplField']] = $orderByField;
3004 if ($this->groupConcatTested
) {
3005 $orderBys[$orderByField['tplField']] = "{$orderByField['tplField']} {$orderBy['order']}";
3008 // Not sure when this is preferable to using tplField (which has
3009 // definitely been tested to work in cases then this does not.
3010 // in caution not switching unless report has been tested for
3011 // group concat functionality.
3012 $orderBys[$orderByField['tplField']] = "{$orderByField['dbAlias']} {$orderBy['order']}";
3015 // Record any section headers for assignment to the template
3016 if (!empty($orderBy['section'])) {
3017 $orderByField['pageBreak'] = CRM_Utils_Array
::value('pageBreak', $orderBy);
3018 $this->_sections
[$orderByField['tplField']] = $orderByField;
3024 $this->_orderByArray
= $orderBys;
3026 $this->assign('sections', $this->_sections
);
3030 * Determine unselected columns.
3034 public function unselectedOrderByColumns() {
3035 return array_diff_key($this->_orderByFields
, $this->getSelectColumns());
3039 * Determine unselected columns.
3043 public function unselectedSectionColumns() {
3044 if (is_array($this->_sections
)) {
3045 return array_diff_key($this->_sections
, $this->getSelectColumns());
3053 * Build output rows.
3055 * @param string $sql
3056 * @param array $rows
3058 public function buildRows($sql, &$rows) {
3059 if (!$this->optimisedForOnlyFullGroupBy
) {
3060 CRM_Core_DAO
::disableFullGroupByMode();
3062 $dao = CRM_Core_DAO
::executeQuery($sql);
3063 if (stristr($this->_select
, 'SQL_CALC_FOUND_ROWS')) {
3064 $this->_rowsFound
= CRM_Core_DAO
::singleValueQuery('SELECT FOUND_ROWS()');
3066 CRM_Core_DAO
::reenableFullGroupByMode();
3067 if (!is_array($rows)) {
3071 // use this method to modify $this->_columnHeaders
3072 $this->modifyColumnHeaders();
3074 $unselectedSectionColumns = $this->unselectedSectionColumns();
3076 while ($dao->fetch()) {
3078 foreach ($this->_columnHeaders
as $key => $value) {
3079 if (property_exists($dao, $key)) {
3080 $row[$key] = $dao->$key;
3084 // section headers not selected for display need to be added to row
3085 foreach ($unselectedSectionColumns as $key => $values) {
3086 if (property_exists($dao, $key)) {
3087 $row[$key] = $dao->$key;
3096 * Calculate section totals.
3098 * When "order by" fields are marked as sections, this assigns to the template
3099 * an array of total counts for each section. This data is used by the Smarty
3100 * plugin {sectionTotal}.
3102 public function sectionTotals() {
3104 // Reports using order_bys with sections must populate $this->_selectAliases in select() method.
3105 if (empty($this->_selectAliases
)) {
3109 if (!empty($this->_sections
)) {
3110 // build the query with no LIMIT clause
3111 $select = str_ireplace('SELECT SQL_CALC_FOUND_ROWS ', 'SELECT ', $this->_select
);
3112 $sql = "{$select} {$this->_from} {$this->_where} {$this->_groupBy} {$this->_having} {$this->_orderBy}";
3114 // pull section aliases out of $this->_sections
3115 $sectionAliases = array_keys($this->_sections
);
3118 foreach (array_merge($sectionAliases, $this->_selectAliases
) as $alias) {
3119 $ifnulls[] = "ifnull($alias, '') as $alias";
3121 $this->_select
= "SELECT " . implode(", ", $ifnulls);
3122 $this->_select
= CRM_Contact_BAO_Query
::appendAnyValueToSelect($ifnulls, $sectionAliases);
3124 // Group (un-limited) report by all aliases and get counts. This might
3125 // be done more efficiently when the contents of $sql are known, ie. by
3126 // overriding this method in the report class.
3128 $query = $this->_select
.
3129 ", count(*) as ct from ($sql) as subquery group by " .
3130 implode(", ", $sectionAliases);
3132 // initialize array of total counts
3134 $dao = CRM_Core_DAO
::executeQuery($query);
3135 while ($dao->fetch()) {
3137 // let $this->_alterDisplay translate any integer ids to human-readable values.
3138 $rows[0] = $dao->toArray();
3139 $this->alterDisplay($rows);
3142 // add totals for all permutations of section values
3145 $aliasCount = count($sectionAliases);
3146 foreach ($sectionAliases as $alias) {
3147 $values[] = $row[$alias];
3148 $key = implode(CRM_Core_DAO
::VALUE_SEPARATOR
, $values);
3149 if ($i == $aliasCount) {
3150 // the last alias is the lowest-level section header; use count as-is
3151 $totals[$key] = $dao->ct
;
3154 // other aliases are higher level; roll count into their total
3155 $totals[$key] +
= $dao->ct
;
3159 $this->assign('sectionTotals', $totals);
3164 * Modify column headers.
3166 public function modifyColumnHeaders() {
3167 // use this method to modify $this->_columnHeaders
3171 * Move totals columns to the right edge of the table.
3173 * It seems like a more logical layout to have any totals columns on the far right regardless of
3174 * the location of the rest of their table.
3176 public function moveSummaryColumnsToTheRightHandSide() {
3177 $statHeaders = (array_intersect_key($this->_columnHeaders
, array_flip($this->_statFields
)));
3178 $this->_columnHeaders
= array_merge(array_diff_key($this->_columnHeaders
, $statHeaders), $this->_columnHeaders
, $statHeaders);
3182 * Assign rows to the template.
3184 * @param array $rows
3186 public function doTemplateAssignment(&$rows) {
3187 $this->assign_by_ref('columnHeaders', $this->_columnHeaders
);
3188 $this->assign_by_ref('rows', $rows);
3189 $this->assign('statistics', $this->statistics($rows));
3193 * Build report statistics.
3195 * Override this method to build your own statistics.
3197 * @param array $rows
3201 public function statistics(&$rows) {
3204 $count = count($rows);
3205 // Why do we increment the count for rollup seems to artificially inflate the count.
3206 // It seems perhaps intentional to include the summary row in the count of results - although
3207 // this just seems odd.
3208 if ($this->_rollup
&& ($this->_rollup
!= '') && $this->_grandFlag
) {
3212 $this->countStat($statistics, $count);
3214 $this->groupByStat($statistics);
3216 $this->filterStat($statistics);
3222 * Add count statistics.
3224 * @param array $statistics
3227 public function countStat(&$statistics, $count) {
3228 $statistics['counts']['rowCount'] = [
3229 'title' => ts('Row(s) Listed'),
3233 if ($this->_rowsFound
&& ($this->_rowsFound
> $count)) {
3234 $statistics['counts']['rowsFound'] = [
3235 'title' => ts('Total Row(s)'),
3236 'value' => $this->_rowsFound
,
3242 * Add group by statistics.
3244 * @param array $statistics
3246 public function groupByStat(&$statistics) {
3247 if (!empty($this->_params
['group_bys']) &&
3248 is_array($this->_params
['group_bys']) &&
3249 !empty($this->_params
['group_bys'])
3251 foreach ($this->_columns
as $tableName => $table) {
3252 if (array_key_exists('group_bys', $table)) {
3253 foreach ($table['group_bys'] as $fieldName => $field) {
3254 if (!empty($this->_params
['group_bys'][$fieldName])) {
3255 $combinations[] = $field['title'];
3260 $statistics['groups'][] = [
3261 'title' => ts('Grouping(s)'),
3262 'value' => implode(' & ', $combinations),
3268 * Filter statistics.
3270 * @param array $statistics
3272 public function filterStat(&$statistics) {
3273 foreach ($this->_columns
as $tableName => $table) {
3274 if (array_key_exists('filters', $table)) {
3275 foreach ($table['filters'] as $fieldName => $field) {
3276 if ((CRM_Utils_Array
::value('type', $field) & CRM_Utils_Type
::T_DATE ||
3277 CRM_Utils_Array
::value('type', $field) & CRM_Utils_Type
::T_TIME
) &&
3278 CRM_Utils_Array
::value('operatorType', $field) !=
3279 CRM_Report_Form
::OP_MONTH
3283 CRM_Utils_Array
::value("{$fieldName}_relative", $this->_params
),
3284 CRM_Utils_Array
::value("{$fieldName}_from", $this->_params
),
3285 CRM_Utils_Array
::value("{$fieldName}_to", $this->_params
),
3286 CRM_Utils_Array
::value("{$fieldName}_from_time", $this->_params
),
3287 CRM_Utils_Array
::value("{$fieldName}_to_time", $this->_params
)
3289 $from_time_format = !empty($this->_params
["{$fieldName}_from_time"]) ?
'h' : 'd';
3290 $from = CRM_Utils_Date
::customFormat($from, NULL, [$from_time_format]);
3292 $to_time_format = !empty($this->_params
["{$fieldName}_to_time"]) ?
'h' : 'd';
3293 $to = CRM_Utils_Date
::customFormat($to, NULL, [$to_time_format]);
3296 $statistics['filters'][] = [
3297 'title' => $field['title'],
3298 'value' => ts("Between %1 and %2", [1 => $from, 2 => $to]),
3301 elseif (in_array($rel = CRM_Utils_Array
::value("{$fieldName}_relative", $this->_params
),
3302 array_keys($this->getOperationPair(CRM_Report_Form
::OP_DATE
))
3304 $pair = $this->getOperationPair(CRM_Report_Form
::OP_DATE
);
3305 $statistics['filters'][] = [
3306 'title' => $field['title'],
3307 'value' => $pair[$rel],
3312 $op = CRM_Utils_Array
::value("{$fieldName}_op", $this->_params
);
3315 $pair = $this->getOperationPair(
3316 CRM_Utils_Array
::value('operatorType', $field),
3319 $min = CRM_Utils_Array
::value("{$fieldName}_min", $this->_params
);
3320 $max = CRM_Utils_Array
::value("{$fieldName}_max", $this->_params
);
3321 $val = CRM_Utils_Array
::value("{$fieldName}_value", $this->_params
);
3322 if (in_array($op, ['bw', 'nbw']) && ($min ||
$max)) {
3323 $value = "{$pair[$op]} $min " . ts('and') . " $max";
3325 elseif ($val && CRM_Utils_Array
::value('operatorType', $field) & self
::OP_ENTITYREF
) {
3326 $this->setEntityRefDefaults($field, $tableName);
3327 $result = civicrm_api3($field['attributes']['entity'], 'getlist',
3329 CRM_Utils_Array
::value('api', $field['attributes'], []));
3331 foreach ($result['values'] as $v) {
3332 $values[] = $v['label'];
3334 $value = "{$pair[$op]} " . implode(', ', $values);
3336 elseif ($op == 'nll' ||
$op == 'nnll') {
3337 $value = $pair[$op];
3339 elseif (is_array($val) && (!empty($val))) {
3340 $options = CRM_Utils_Array
::value('options', $field, []);
3341 foreach ($val as $key => $valIds) {
3342 if (isset($options[$valIds])) {
3343 $val[$key] = $options[$valIds];
3346 $pair[$op] = (count($val) == 1) ?
(($op == 'notin' ||
$op ==
3347 'mnot') ?
ts('Is Not') : ts('Is')) : CRM_Utils_Array
::value($op, $pair);
3348 $val = implode(', ', $val);
3349 $value = "{$pair[$op]} " . $val;
3351 elseif (!is_array($val) && (!empty($val) ||
$val == '0') &&
3352 isset($field['options']) &&
3353 is_array($field['options']) && !empty($field['options'])
3355 $value = CRM_Utils_Array
::value($op, $pair) . " " .
3356 CRM_Utils_Array
::value($val, $field['options'], $val);
3359 $value = CRM_Utils_Array
::value($op, $pair) . " " . $val;
3362 if ($value && empty($field['no_display'])) {
3363 $statistics['filters'][] = [
3364 'title' => CRM_Utils_Array
::value('title', $field),
3365 'value' => CRM_Utils_String
::htmlToText($value),
3375 * End post processing.
3377 * @param array|null $rows
3379 public function endPostProcess(&$rows = NULL) {
3380 $this->assign('report_class', get_class($this));
3381 if ($this->_storeResultSet
) {
3382 $this->_resultSet
= $rows;
3385 if ($this->_outputMode
== 'print' ||
3386 $this->_outputMode
== 'pdf' ||
3390 $content = $this->compileContent();
3391 $url = CRM_Utils_System
::url("civicrm/report/instance/{$this->_id}",
3395 if ($this->_sendmail
) {
3396 $config = CRM_Core_Config
::singleton();
3399 if ($this->_outputMode
== 'csv') {
3401 = $this->_formValues
['report_header'] . '<p>' . ts('Report URL') .
3402 ": {$url}</p>" . '<p>' .
3403 ts('The report is attached as a CSV file.') . '</p>' .
3404 $this->_formValues
['report_footer'];
3406 $csvFullFilename = $config->templateCompileDir
.
3407 CRM_Utils_File
::makeFileName('CiviReport.csv');
3408 $csvContent = CRM_Report_Utils_Report
::makeCsv($this, $rows);
3409 file_put_contents($csvFullFilename, $csvContent);
3411 'fullPath' => $csvFullFilename,
3412 'mime_type' => 'text/csv',
3413 'cleanName' => 'CiviReport.csv',
3416 if ($this->_outputMode
== 'pdf') {
3417 // generate PDF content
3418 $pdfFullFilename = $config->templateCompileDir
.
3419 CRM_Utils_File
::makeFileName('CiviReport.pdf');
3420 file_put_contents($pdfFullFilename,
3421 CRM_Utils_PDF_Utils
::html2pdf($content, "CiviReport.pdf",
3422 TRUE, ['orientation' => 'landscape']
3425 // generate Email Content
3427 = $this->_formValues
['report_header'] . '<p>' . ts('Report URL') .
3428 ": {$url}</p>" . '<p>' .
3429 ts('The report is attached as a PDF file.') . '</p>' .
3430 $this->_formValues
['report_footer'];
3433 'fullPath' => $pdfFullFilename,
3434 'mime_type' => 'application/pdf',
3435 'cleanName' => 'CiviReport.pdf',
3439 if (CRM_Report_Utils_Report
::mailReport($content, $this->_id
,
3440 $this->_outputMode
, $attachments
3443 CRM_Core_Session
::setStatus(ts("Report mail has been sent."), ts('Sent'), 'success');
3446 CRM_Core_Session
::setStatus(ts("Report mail could not be sent."), ts('Mail Error'), 'error');
3450 elseif ($this->_outputMode
== 'print') {
3454 // Nb. Once upon a time we used a package called Open Flash Charts to
3455 // draw charts, and we had a feature whereby a browser could send the
3456 // server a PNG version of the chart, which could then be included in a
3457 // PDF by including <img> tags in the HTML for the conversion below.
3459 // This feature stopped working when browsers stopped supporting Flash,
3460 // and although we have a different client-side charting library in
3461 // place, we decided not to reimplement the (rather convoluted)
3462 // browser-sending-rendered-chart-to-server process.
3464 // If this feature is required in future we should find a better way to
3465 // render charts on the server side, e.g. server-created SVG.
3466 CRM_Utils_PDF_Utils
::html2pdf($content, "CiviReport.pdf", FALSE, ['orientation' => 'landscape']);
3468 CRM_Utils_System
::civiExit();
3470 elseif ($this->_outputMode
== 'csv') {
3471 CRM_Report_Utils_Report
::export2csv($this, $rows);
3473 elseif ($this->_outputMode
== 'group') {
3474 $group = $this->_params
['groups'];
3475 $this->add2group($group);
3480 * Set store result set indicator to TRUE.
3482 * @todo explain what this does
3484 public function storeResultSet() {
3485 $this->_storeResultSet
= TRUE;
3493 public function getResultSet() {
3494 return $this->_resultSet
;
3498 * Get the sql used to generate the report.
3502 public function getReportSql() {
3503 return $this->sqlArray
;
3507 * Use the form name to create the tpl file name.
3511 public function getTemplateFileName() {
3512 $defaultTpl = parent
::getTemplateFileName();
3513 $template = CRM_Core_Smarty
::singleton();
3514 if (!$template->template_exists($defaultTpl)) {
3515 $defaultTpl = 'CRM/Report/Form.tpl';
3521 * Compile the report content.
3523 * Although this function is super-short it is useful to keep separate so it can be over-ridden by report classes.
3527 public function compileContent() {
3528 $templateFile = $this->getHookedTemplateFileName();
3529 return CRM_Utils_Array
::value('report_header', $this->_formValues
) .
3530 CRM_Core_Form
::$_template->fetch($templateFile) .
3531 CRM_Utils_Array
::value('report_footer', $this->_formValues
);
3535 * Post process function.
3537 public function postProcess() {
3538 // get ready with post process params
3539 $this->beginPostProcess();
3542 $sql = $this->buildQuery();
3544 // build array of result based on column headers. This method also allows
3545 // modifying column headers before using it to build result set i.e $rows.
3547 $this->buildRows($sql, $rows);
3549 // format result set.
3550 $this->formatDisplay($rows);
3552 // assign variables to templates
3553 $this->doTemplateAssignment($rows);
3555 // do print / pdf / instance stuff if needed
3556 $this->endPostProcess($rows);
3562 * @param int $rowCount
3566 public function limit($rowCount = self
::ROW_COUNT_LIMIT
) {
3567 // lets do the pager if in html mode
3568 $this->_limit
= NULL;
3570 // CRM-14115, over-ride row count if rowCount is specified in URL
3571 if ($this->_dashBoardRowCount
) {
3572 $rowCount = $this->_dashBoardRowCount
;
3574 if ($this->addPaging
) {
3575 $this->_select
= preg_replace('/SELECT(\s+SQL_CALC_FOUND_ROWS)?\s+/i', 'SELECT SQL_CALC_FOUND_ROWS ', $this->_select
);
3577 $pageId = CRM_Utils_Request
::retrieve('crmPID', 'Integer');
3579 // @todo all http vars should be extracted in the preProcess
3580 // - not randomly in the class
3581 if (!$pageId && !empty($_POST)) {
3582 if (isset($_POST['PagerBottomButton']) && isset($_POST['crmPID_B'])) {
3583 $pageId = max((int) $_POST['crmPID_B'], 1);
3585 elseif (isset($_POST['PagerTopButton']) && isset($_POST['crmPID'])) {
3586 $pageId = max((int) $_POST['crmPID'], 1);
3588 unset($_POST['crmPID_B'], $_POST['crmPID']);
3591 $pageId = $pageId ?
$pageId : 1;
3592 $this->set(CRM_Utils_Pager
::PAGE_ID
, $pageId);
3593 $offset = ($pageId - 1) * $rowCount;
3595 $offset = CRM_Utils_Type
::escape($offset, 'Int');
3596 $rowCount = CRM_Utils_Type
::escape($rowCount, 'Int');
3598 $this->_limit
= " LIMIT $offset, $rowCount";
3599 return [$offset, $rowCount];
3601 if ($this->_limitValue
) {
3602 if ($this->_offsetValue
) {
3603 $this->_limit
= " LIMIT {$this->_offsetValue}, {$this->_limitValue} ";
3606 $this->_limit
= " LIMIT " . $this->_limitValue
;
3614 * @param int $rowCount
3616 public function setPager($rowCount = self
::ROW_COUNT_LIMIT
) {
3617 // CRM-14115, over-ride row count if rowCount is specified in URL
3618 if ($this->_dashBoardRowCount
) {
3619 $rowCount = $this->_dashBoardRowCount
;
3622 if ($this->_limit
&& ($this->_limit
!= '')) {
3623 if (!$this->_rowsFound
) {
3624 $sql = "SELECT FOUND_ROWS();";
3625 $this->_rowsFound
= CRM_Core_DAO
::singleValueQuery($sql);
3628 'total' => $this->_rowsFound
,
3629 'rowCount' => $rowCount,
3630 'status' => ts('Records') . ' %%StatusMessage%%',
3631 'buttonBottom' => 'PagerBottomButton',
3632 'buttonTop' => 'PagerTopButton',
3634 if (!empty($this->controller
)) {
3635 // This happens when being called from the api Really we want the api to be able to
3636 // pass paging parameters, but at this stage just preventing test crashes.
3637 $params['pageID'] = $this->get(CRM_Utils_Pager
::PAGE_ID
);
3640 $pager = new CRM_Utils_Pager($params);
3641 $this->assign_by_ref('pager', $pager);
3642 $this->ajaxResponse
['totalRows'] = $this->_rowsFound
;
3647 * Build a group filter with contempt for large data sets.
3649 * This function has been retained as it takes time to migrate the reports over
3650 * to the new method which will not crash on large datasets.
3654 * @param string $field
3655 * @param mixed $value
3660 public function legacySlowGroupFilterClause($field, $value, $op) {
3661 $smartGroupQuery = "";
3663 $group = new CRM_Contact_DAO_Group();
3664 $group->is_active
= 1;
3667 while ($group->fetch()) {
3668 if (in_array($group->id
, (array) $this->_params
['gid_value']) &&
3669 $group->saved_search_id
3671 $smartGroups[] = $group->id
;
3675 CRM_Contact_BAO_GroupContactCache
::check($smartGroups);
3677 $smartGroupQuery = '';
3678 if (!empty($smartGroups)) {
3679 $smartGroups = implode(',', $smartGroups);
3680 $smartGroupQuery = " UNION DISTINCT
3681 SELECT DISTINCT smartgroup_contact.contact_id
3682 FROM civicrm_group_contact_cache smartgroup_contact
3683 WHERE smartgroup_contact.group_id IN ({$smartGroups}) ";
3686 $sqlOp = $this->getSQLOperator($op);
3687 if (!is_array($value)) {
3690 //include child groups if any
3691 $value = array_merge($value, CRM_Contact_BAO_Group
::getChildGroupIds($value));
3693 $clause = "{$field['dbAlias']} IN (" . implode(', ', $value) . ")";
3695 $contactAlias = $this->_aliases
['civicrm_contact'];
3696 if (!empty($this->relationType
) && $this->relationType
== 'b_a') {
3697 $contactAlias = $this->_aliases
['civicrm_contact_b'];
3699 return " {$contactAlias}.id {$sqlOp} (
3700 SELECT DISTINCT {$this->_aliases['civicrm_group']}.contact_id
3701 FROM civicrm_group_contact {$this->_aliases['civicrm_group']}
3702 WHERE {$clause} AND {$this->_aliases['civicrm_group']}.status = 'Added'
3703 {$smartGroupQuery} ) ";
3707 * Build where clause for groups.
3709 * @param string $field
3710 * @param mixed $value
3715 public function whereGroupClause($field, $value, $op) {
3716 if ($this->groupFilterNotOptimised
) {
3717 return $this->legacySlowGroupFilterClause($field, $value, $op);
3719 if ($op === 'notin') {
3720 return " group_temp_table.id IS NULL ";
3722 // We will have used an inner join instead.
3727 * Create a table of the contact ids included by the group filter.
3729 * This function is called by both the api (tests) and the UI.
3731 public function buildGroupTempTable() {
3732 if (!empty($this->groupTempTable
) ||
empty($this->_params
['gid_value']) ||
$this->groupFilterNotOptimised
) {
3735 $filteredGroups = (array) $this->_params
['gid_value'];
3737 $groups = civicrm_api3('Group', 'get', [
3739 'id' => ['IN' => $filteredGroups],
3740 'saved_search_id' => ['>' => 0],
3743 $smartGroups = array_keys($groups['values']);
3746 SELECT DISTINCT group_contact.contact_id as id
3747 FROM civicrm_group_contact group_contact
3748 WHERE group_contact.group_id IN (" . implode(', ', $filteredGroups) . ")
3749 AND group_contact.status = 'Added' ";
3751 if (!empty($smartGroups)) {
3752 CRM_Contact_BAO_GroupContactCache
::check($smartGroups);
3753 $smartGroups = implode(',', $smartGroups);
3756 SELECT smartgroup_contact.contact_id as id
3757 FROM civicrm_group_contact_cache smartgroup_contact
3758 WHERE smartgroup_contact.group_id IN ({$smartGroups}) ";
3761 $this->groupTempTable
= $this->createTemporaryTable('rptgrp', $query);
3762 CRM_Core_DAO
::executeQuery("ALTER TABLE $this->groupTempTable ADD INDEX i_id(id)");
3766 * Execute query and add it to the developer tab.
3768 * @param string $query
3769 * @param array $params
3771 * @return \CRM_Core_DAO|object
3773 protected function executeReportQuery($query, $params = []) {
3774 $this->addToDeveloperTab($query);
3775 return CRM_Core_DAO
::executeQuery($query, $params);
3779 * Build where clause for tags.
3781 * @param string $field
3782 * @param mixed $value
3787 public function whereTagClause($field, $value, $op) {
3788 // not using left join in query because if any contact
3789 // belongs to more than one tag, results duplicate
3791 $sqlOp = $this->getSQLOperator($op);
3792 if (!is_array($value)) {
3795 $clause = "{$field['dbAlias']} IN (" . implode(', ', $value) . ")";
3796 $entity_table = $this->_tagFilterTable
;
3797 return " {$this->_aliases[$entity_table]}.id {$sqlOp} (
3798 SELECT DISTINCT {$this->_aliases['civicrm_tag']}.entity_id
3799 FROM civicrm_entity_tag {$this->_aliases['civicrm_tag']}
3800 WHERE entity_table = '$entity_table' AND {$clause} ) ";
3804 * Generate membership organization clause.
3806 * @param mixed $value
3807 * @param string $op SQL Operator
3811 public function whereMembershipOrgClause($value, $op) {
3812 $sqlOp = $this->getSQLOperator($op);
3813 if (!is_array($value)) {
3817 $tmp_membership_org_sql_list = implode(', ', $value);
3818 return " {$this->_aliases['civicrm_contact']}.id {$sqlOp} (
3819 SELECT DISTINCT mem.contact_id
3820 FROM civicrm_membership mem
3821 LEFT JOIN civicrm_membership_status mem_status ON mem.status_id = mem_status.id
3822 LEFT JOIN civicrm_membership_type mt ON mem.membership_type_id = mt.id
3823 WHERE mt.member_of_contact_id IN (" .
3824 $tmp_membership_org_sql_list . ")
3825 AND mt.is_active = '1'
3826 AND mem_status.is_current_member = '1'
3827 AND mem_status.is_active = '1' ) ";
3831 * Generate Membership Type SQL Clause.
3833 * @param mixed $value
3839 public function whereMembershipTypeClause($value, $op) {
3840 $sqlOp = $this->getSQLOperator($op);
3841 if (!is_array($value)) {
3845 $tmp_membership_sql_list = implode(', ', $value);
3846 return " {$this->_aliases['civicrm_contact']}.id {$sqlOp} (
3847 SELECT DISTINCT mem.contact_id
3848 FROM civicrm_membership mem
3849 LEFT JOIN civicrm_membership_status mem_status ON mem.status_id = mem_status.id
3850 LEFT JOIN civicrm_membership_type mt ON mem.membership_type_id = mt.id
3851 WHERE mem.membership_type_id IN (" .
3852 $tmp_membership_sql_list . ")
3853 AND mt.is_active = '1'
3854 AND mem_status.is_current_member = '1'
3855 AND mem_status.is_active = '1' ) ";
3859 * Buld contact acl clause
3860 * @deprecated in favor of buildPermissionClause
3862 * @param string $tableAlias
3864 public function buildACLClause($tableAlias = 'contact_a') {
3865 list($this->_aclFrom
, $this->_aclWhere
) = CRM_Contact_BAO_Contact_Permission
::cacheClause($tableAlias);
3869 * Build the permision clause for all entities in this report
3871 public function buildPermissionClause() {
3873 foreach ($this->selectedTables() as $tableName) {
3874 $baoName = str_replace('_DAO_', '_BAO_', CRM_Core_DAO_AllCoreTables
::getClassForTable($tableName));
3875 if ($baoName && class_exists($baoName) && !empty($this->_columns
[$tableName]['alias'])) {
3876 $tableAlias = $this->_columns
[$tableName]['alias'];
3877 $clauses = array_filter($baoName::getSelectWhereClause($tableAlias));
3878 foreach ($clauses as $field => $clause) {
3879 // Skip contact_id field if redundant
3880 if ($field != 'contact_id' ||
!in_array('civicrm_contact', $this->selectedTables())) {
3881 $ret["$tableName.$field"] = $clause;
3886 // Override output from buildACLClause
3887 $this->_aclFrom
= NULL;
3888 $this->_aclWhere
= implode(' AND ', $ret);
3892 * Add custom data to the columns.
3894 * @param bool $addFields
3895 * @param array $permCustomGroupIds
3897 public function addCustomDataToColumns($addFields = TRUE, $permCustomGroupIds = []) {
3898 if (empty($this->_customGroupExtends
)) {
3901 if (!is_array($this->_customGroupExtends
)) {
3902 $this->_customGroupExtends
= [$this->_customGroupExtends
];
3904 $customGroupWhere = '';
3905 if (!empty($permCustomGroupIds)) {
3906 $customGroupWhere = "cg.id IN (" . implode(',', $permCustomGroupIds) .
3910 SELECT cg.table_name, cg.title, cg.extends, cf.id as cf_id, cf.label,
3911 cf.column_name, cf.data_type, cf.html_type, cf.option_group_id, cf.time_format
3912 FROM civicrm_custom_group cg
3913 INNER JOIN civicrm_custom_field cf ON cg.id = cf.custom_group_id
3914 WHERE cg.extends IN ('" . implode("','", $this->_customGroupExtends
) . "') AND
3916 cg.is_active = 1 AND
3917 cf.is_active = 1 AND
3918 cf.is_searchable = 1
3919 ORDER BY cg.weight, cf.weight";
3920 $customDAO = CRM_Core_DAO
::executeQuery($sql);
3923 while ($customDAO->fetch()) {
3924 if ($customDAO->table_name
!= $curTable) {
3925 $curTable = $customDAO->table_name
;
3926 $curFields = $curFilters = [];
3929 $this->_columns
[$curTable]['dao'] = 'CRM_Contact_DAO_Contact';
3930 $this->_columns
[$curTable]['extends'] = $customDAO->extends;
3931 $this->_columns
[$curTable]['grouping'] = $customDAO->table_name
;
3932 $this->_columns
[$curTable]['group_title'] = $customDAO->title
;
3934 foreach (['fields', 'filters', 'group_bys'] as $colKey) {
3935 if (!array_key_exists($colKey, $this->_columns
[$curTable])) {
3936 $this->_columns
[$curTable][$colKey] = [];
3940 $fieldName = 'custom_' . $customDAO->cf_id
;
3943 // this makes aliasing work in favor
3944 $curFields[$fieldName] = [
3945 'name' => $customDAO->column_name
,
3946 'title' => $customDAO->label
,
3947 'dataType' => $customDAO->data_type
,
3948 'htmlType' => $customDAO->html_type
,
3951 if ($this->_customGroupFilters
) {
3952 // this makes aliasing work in favor
3953 $curFilters[$fieldName] = [
3954 'name' => $customDAO->column_name
,
3955 'title' => $customDAO->label
,
3956 'dataType' => $customDAO->data_type
,
3957 'htmlType' => $customDAO->html_type
,
3961 switch ($customDAO->data_type
) {
3964 $curFilters[$fieldName]['operatorType'] = CRM_Report_Form
::OP_DATE
;
3965 $curFilters[$fieldName]['type'] = CRM_Utils_Type
::T_DATE
;
3966 // CRM-6946, show time part for datetime date fields
3967 if ($customDAO->time_format
) {
3968 $curFields[$fieldName]['type'] = CRM_Utils_Type
::T_TIMESTAMP
;
3973 $curFilters[$fieldName]['operatorType'] = CRM_Report_Form
::OP_SELECT
;
3974 $curFilters[$fieldName]['options'] = ['' => ts('- select -')] + CRM_Core_PseudoConstant
::get('CRM_Core_BAO_CustomField', 'custom_' . $customDAO->cf_id
, [], 'search');
3975 $curFilters[$fieldName]['type'] = CRM_Utils_Type
::T_INT
;
3979 $curFilters[$fieldName]['operatorType'] = CRM_Report_Form
::OP_INT
;
3980 $curFilters[$fieldName]['type'] = CRM_Utils_Type
::T_INT
;
3984 $curFilters[$fieldName]['operatorType'] = CRM_Report_Form
::OP_FLOAT
;
3985 $curFilters[$fieldName]['type'] = CRM_Utils_Type
::T_MONEY
;
3986 $curFields[$fieldName]['type'] = CRM_Utils_Type
::T_MONEY
;
3990 $curFilters[$fieldName]['operatorType'] = CRM_Report_Form
::OP_FLOAT
;
3991 $curFilters[$fieldName]['type'] = CRM_Utils_Type
::T_FLOAT
;
3995 case 'StateProvince':
3997 $curFilters[$fieldName]['type'] = CRM_Utils_Type
::T_STRING
;
3999 $options = CRM_Core_PseudoConstant
::get('CRM_Core_BAO_CustomField', 'custom_' . $customDAO->cf_id
, [], 'search');
4000 if ((is_array($options) && count($options) != 0) ||
(!is_array($options) && $options !== FALSE)) {
4001 $curFilters[$fieldName]['operatorType'] = CRM_Core_BAO_CustomField
::isSerialized($customDAO) ? CRM_Report_Form
::OP_MULTISELECT_SEPARATOR
: CRM_Report_Form
::OP_MULTISELECT
;
4002 $curFilters[$fieldName]['options'] = $options;
4006 case 'ContactReference':
4007 $curFilters[$fieldName]['type'] = CRM_Utils_Type
::T_STRING
;
4008 $curFilters[$fieldName]['name'] = 'display_name';
4009 $curFilters[$fieldName]['alias'] = "contact_{$fieldName}_civireport";
4011 $curFields[$fieldName]['type'] = CRM_Utils_Type
::T_STRING
;
4012 $curFields[$fieldName]['name'] = 'display_name';
4013 $curFields[$fieldName]['alias'] = "contact_{$fieldName}_civireport";
4017 $curFields[$fieldName]['type'] = CRM_Utils_Type
::T_STRING
;
4018 $curFilters[$fieldName]['type'] = CRM_Utils_Type
::T_STRING
;
4022 if ($customDAO->html_type
== 'Select' && !array_key_exists('options', $curFilters[$fieldName])) {
4023 $options = CRM_Core_PseudoConstant
::get('CRM_Core_BAO_CustomField', 'custom_' . $customDAO->cf_id
, [], 'search');
4024 if ($options !== FALSE) {
4025 $curFilters[$fieldName]['operatorType'] = CRM_Core_BAO_CustomField
::isSerialized($customDAO) ? CRM_Report_Form
::OP_MULTISELECT_SEPARATOR
: CRM_Report_Form
::OP_MULTISELECT
;
4026 $curFilters[$fieldName]['options'] = $options;
4030 if (!array_key_exists('type', $curFields[$fieldName])) {
4031 $curFields[$fieldName]['type'] = CRM_Utils_Array
::value('type', $curFilters[$fieldName], []);
4035 $this->_columns
[$curTable]['fields'] = array_merge($this->_columns
[$curTable]['fields'], $curFields);
4037 if ($this->_customGroupFilters
) {
4038 $this->_columns
[$curTable]['filters'] = array_merge($this->_columns
[$curTable]['filters'], $curFilters);
4040 if ($this->_customGroupGroupBy
) {
4041 $this->_columns
[$curTable]['group_bys'] = array_merge($this->_columns
[$curTable]['group_bys'], $curFields);
4047 * Build custom data from clause.
4049 * @param bool $joinsForFiltersOnly
4050 * Only include joins to support filters. This would be used if creating a table of contacts to include first.
4052 public function customDataFrom($joinsForFiltersOnly = FALSE) {
4053 if (empty($this->_customGroupExtends
)) {
4056 $mapper = CRM_Core_BAO_CustomQuery
::$extendsMap;
4057 //CRM-18276 GROUP_CONCAT could be used with singleValueQuery and then exploded,
4058 //but by default that truncates to 1024 characters, which causes errors with installs with lots of custom field sets
4060 $customTablesDAO = CRM_Core_DAO
::executeQuery("SELECT table_name FROM civicrm_custom_group");
4061 while ($customTablesDAO->fetch()) {
4062 $customTables[] = $customTablesDAO->table_name
;
4065 foreach ($this->_columns
as $table => $prop) {
4066 if (in_array($table, $customTables)) {
4067 $extendsTable = $mapper[$prop['extends']];
4068 // Check field is required for rendering the report.
4069 if ((!$this->isFieldSelected($prop)) ||
($joinsForFiltersOnly && !$this->isFieldFiltered($prop))) {
4072 $baseJoin = CRM_Utils_Array
::value($prop['extends'], $this->_customGroupExtendsJoin
, "{$this->_aliases[$extendsTable]}.id");
4074 $customJoin = is_array($this->_customGroupJoin
) ?
$this->_customGroupJoin
[$table] : $this->_customGroupJoin
;
4076 {$customJoin} {$table} {$this->_aliases[$table]} ON {$this->_aliases[$table]}.entity_id = {$baseJoin}";
4077 // handle for ContactReference
4078 if (array_key_exists('fields', $prop)) {
4079 foreach ($prop['fields'] as $fieldName => $field) {
4080 if (CRM_Utils_Array
::value('dataType', $field) ==
4083 $columnName = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_CustomField', CRM_Core_BAO_CustomField
::getKeyID($fieldName), 'column_name');
4085 LEFT JOIN civicrm_contact {$field['alias']} ON {$field['alias']}.id = {$this->_aliases[$table]}.{$columnName} ";
4094 * Check if the field is selected.
4096 * @param string $prop
4100 public function isFieldSelected($prop) {
4105 if (!empty($this->_params
['fields'])) {
4106 foreach (array_keys($prop['fields']) as $fieldAlias) {
4107 $customFieldId = CRM_Core_BAO_CustomField
::getKeyID($fieldAlias);
4108 if ($customFieldId) {
4109 if (array_key_exists($fieldAlias, $this->_params
['fields'])) {
4113 //might be survey response field.
4114 if (!empty($this->_params
['fields']['survey_response']) &&
4115 !empty($prop['fields'][$fieldAlias]['isSurveyResponseField'])
4123 if (!empty($this->_params
['group_bys']) && $this->_customGroupGroupBy
) {
4124 foreach (array_keys($prop['group_bys']) as $fieldAlias) {
4125 if (array_key_exists($fieldAlias, $this->_params
['group_bys']) &&
4126 CRM_Core_BAO_CustomField
::getKeyID($fieldAlias)
4133 if (!empty($this->_params
['order_bys'])) {
4134 foreach (array_keys($prop['fields']) as $fieldAlias) {
4135 foreach ($this->_params
['order_bys'] as $orderBy) {
4136 if ($fieldAlias == $orderBy['column'] &&
4137 CRM_Core_BAO_CustomField
::getKeyID($fieldAlias)
4144 return $this->isFieldFiltered($prop);
4149 * Check if the field is used as a filter.
4151 * @param string $prop
4155 protected function isFieldFiltered($prop) {
4156 if (!empty($prop['filters']) && $this->_customGroupFilters
) {
4157 foreach ($prop['filters'] as $fieldAlias => $val) {
4166 if (isset($this->_params
[$fieldAlias . '_' . $attach]) &&
4167 (!empty($this->_params
[$fieldAlias . '_' . $attach])
4168 ||
($attach != 'relative' &&
4169 $this->_params
[$fieldAlias . '_' . $attach] == '0')
4175 if (!empty($this->_params
[$fieldAlias . '_op']) &&
4176 in_array($this->_params
[$fieldAlias . '_op'], ['nll', 'nnll'])
4187 * Check for empty order_by configurations and remove them.
4189 * Also set template to hide them.
4191 * @param array $formValues
4193 public function preProcessOrderBy(&$formValues) {
4194 // Object to show/hide form elements
4195 $_showHide = new CRM_Core_ShowHideBlocks('', '');
4197 $_showHide->addShow('optionField_1');
4199 // Cycle through order_by options; skip any empty ones, and hide them as well
4202 if (!empty($formValues['order_bys'])) {
4203 foreach ($formValues['order_bys'] as $order_by) {
4204 if ($order_by['column'] && $order_by['column'] != '-') {
4205 $_showHide->addShow('optionField_' . $n);
4206 $orderBys[$n] = $order_by;
4211 for ($i = $n; $i <= 5; $i++
) {
4213 $_showHide->addHide('optionField_' . $i);
4217 // overwrite order_by options with modified values
4218 if (!empty($orderBys)) {
4219 $formValues['order_bys'] = $orderBys;
4222 $formValues['order_bys'] = [1 => ['column' => '-']];
4225 // assign show/hide data to template
4226 $_showHide->addToTemplate();
4230 * Check if table name has columns in SELECT clause.
4232 * @param string $tableName
4233 * Name of table (index of $this->_columns array).
4237 public function isTableSelected($tableName) {
4238 return in_array($tableName, $this->selectedTables());
4242 * Check if table name has columns in WHERE or HAVING clause.
4244 * @param string $tableName
4245 * Name of table (index of $this->_columns array).
4249 public function isTableFiltered($tableName) {
4250 // Cause the array to be generated if not previously done.
4251 if (!$this->_selectedTables
&& !$this->filteredTables
) {
4252 $this->selectedTables();
4254 return in_array($tableName, $this->filteredTables
);
4258 * Fetch array of DAO tables having columns included in SELECT or ORDER BY clause.
4260 * If the array is unset it will be built.
4265 public function selectedTables() {
4266 if (!$this->_selectedTables
) {
4267 $orderByColumns = [];
4268 if (array_key_exists('order_bys', $this->_params
) &&
4269 is_array($this->_params
['order_bys'])
4271 foreach ($this->_params
['order_bys'] as $orderBy) {
4272 $orderByColumns[] = $orderBy['column'];
4276 foreach ($this->_columns
as $tableName => $table) {
4277 if (array_key_exists('fields', $table)) {
4278 foreach ($table['fields'] as $fieldName => $field) {
4279 if (!empty($field['required']) ||
4280 !empty($this->_params
['fields'][$fieldName])
4282 $this->_selectedTables
[] = $tableName;
4287 if (array_key_exists('order_bys', $table)) {
4288 foreach ($table['order_bys'] as $orderByName => $orderBy) {
4289 if (in_array($orderByName, $orderByColumns)) {
4290 $this->_selectedTables
[] = $tableName;
4295 if (array_key_exists('filters', $table)) {
4296 foreach ($table['filters'] as $filterName => $filter) {
4297 if ((isset($this->_params
["{$filterName}_value"])
4298 && !CRM_Utils_System
::isNull($this->_params
["{$filterName}_value"]))
4299 ||
!empty($this->_params
["{$filterName}_relative"])
4300 || CRM_Utils_Array
::value("{$filterName}_op", $this->_params
) ==
4302 || CRM_Utils_Array
::value("{$filterName}_op", $this->_params
) ==
4305 $this->_selectedTables
[] = $tableName;
4306 $this->filteredTables
[] = $tableName;
4313 return $this->_selectedTables
;
4317 * Add campaign fields.
4318 * @param string $entityTable
4319 * @param bool $groupBy
4320 * Add GroupBy? Not appropriate for detail report.
4321 * @param bool $orderBy
4322 * Add OrderBy? Not appropriate for detail report.
4323 * @param bool $filters
4326 public function addCampaignFields($entityTable = 'civicrm_contribution', $groupBy = FALSE, $orderBy = FALSE, $filters = TRUE) {
4327 // Check if CiviCampaign is a) enabled and b) has active campaigns
4328 $config = CRM_Core_Config
::singleton();
4329 $campaignEnabled = in_array('CiviCampaign', $config->enableComponents
);
4330 if ($campaignEnabled) {
4331 $getCampaigns = CRM_Campaign_BAO_Campaign
::getPermissionedCampaigns(NULL, NULL, FALSE, FALSE, TRUE);
4332 // If we have a campaign, build out the relevant elements
4333 if (!empty($getCampaigns['campaigns'])) {
4334 $this->campaigns
= $getCampaigns['campaigns'];
4335 asort($this->campaigns
);
4336 $this->_columns
[$entityTable]['fields']['campaign_id'] = ['title' => ts('Campaign'), 'default' => 'false'];
4338 $this->_columns
[$entityTable]['filters']['campaign_id'] = [
4339 'title' => ts('Campaign'),
4340 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
4341 'options' => $this->campaigns
,
4342 'type' => CRM_Utils_Type
::T_INT
,
4347 $this->_columns
[$entityTable]['group_bys']['campaign_id'] = ['title' => ts('Campaign')];
4351 $this->_columns
[$entityTable]['order_bys']['campaign_id'] = ['title' => ts('Campaign')];
4358 * Add address fields.
4360 * @deprecated - use getAddressColumns which is a more accurate description
4361 * and also accepts an array of options rather than a long list
4363 * adding address fields to construct function in reports
4365 * @param bool $groupBy
4366 * Add GroupBy? Not appropriate for detail report.
4367 * @param bool $orderBy
4368 * Add GroupBy? Not appropriate for detail report.
4369 * @param bool $filters
4370 * @param array $defaults
4373 * address fields for construct clause
4375 public function addAddressFields($groupBy = TRUE, $orderBy = FALSE, $filters = TRUE, $defaults = ['country_id' => TRUE]) {
4376 $defaultAddressFields = [
4377 'street_address' => ts('Street Address'),
4378 'supplemental_address_1' => ts('Supplementary Address Field 1'),
4379 'supplemental_address_2' => ts('Supplementary Address Field 2'),
4380 'supplemental_address_3' => ts('Supplementary Address Field 3'),
4381 'street_number' => ts('Street Number'),
4382 'street_name' => ts('Street Name'),
4383 'street_unit' => ts('Street Unit'),
4384 'city' => ts('City'),
4385 'postal_code' => ts('Postal Code'),
4386 'postal_code_suffix' => ts('Postal Code Suffix'),
4387 'country_id' => ts('Country'),
4388 'state_province_id' => ts('State/Province'),
4389 'county_id' => ts('County'),
4392 'civicrm_address' => [
4393 'dao' => 'CRM_Core_DAO_Address',
4396 'title' => ts('Address Name'),
4397 'default' => CRM_Utils_Array
::value('name', $defaults, FALSE),
4401 'grouping' => 'location-fields',
4404 foreach ($defaultAddressFields as $fieldName => $fieldLabel) {
4405 $addressFields['civicrm_address']['fields'][$fieldName] = [
4406 'title' => $fieldLabel,
4407 'default' => CRM_Utils_Array
::value($fieldName, $defaults, FALSE),
4411 $street_address_filters = $general_address_filters = [];
4413 // Address filter depends on whether street address parsing is enabled.
4415 $addressOptions = CRM_Core_BAO_Setting
::valueOptions(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
4418 if ($addressOptions['street_address_parsing']) {
4419 $street_address_filters = [
4420 'street_number' => [
4421 'title' => ts('Street Number'),
4422 'type' => CRM_Utils_Type
::T_INT
,
4423 'name' => 'street_number',
4426 'title' => ts('Street Name'),
4427 'name' => 'street_name',
4428 'type' => CRM_Utils_Type
::T_STRING
,
4433 $street_address_filters = [
4434 'street_address' => [
4435 'title' => ts('Street Address'),
4436 'type' => CRM_Utils_Type
::T_STRING
,
4437 'name' => 'street_address',
4441 $general_address_filters = [
4443 'title' => ts('Postal Code'),
4444 'type' => CRM_Utils_Type
::T_STRING
,
4445 'name' => 'postal_code',
4448 'title' => ts('City'),
4449 'type' => CRM_Utils_Type
::T_STRING
,
4453 'name' => 'country_id',
4454 'title' => ts('Country'),
4455 'type' => CRM_Utils_Type
::T_INT
,
4456 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
4457 'options' => CRM_Core_PseudoConstant
::country(),
4459 'state_province_id' => [
4460 'name' => 'state_province_id',
4461 'title' => ts('State/Province'),
4462 'type' => CRM_Utils_Type
::T_INT
,
4463 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
4467 'name' => 'county_id',
4468 'title' => ts('County'),
4469 'type' => CRM_Utils_Type
::T_INT
,
4470 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
4475 $addressFields['civicrm_address']['filters'] = array_merge(
4476 $street_address_filters,
4477 $general_address_filters);
4480 $addressFields['civicrm_address']['order_bys'] = [
4481 'street_name' => ['title' => ts('Street Name')],
4482 'street_number' => ['title' => ts('Odd / Even Street Number')],
4483 'street_address' => NULL,
4485 'postal_code' => NULL,
4490 $addressFields['civicrm_address']['group_bys'] = [
4491 'street_address' => NULL,
4493 'postal_code' => NULL,
4494 'state_province_id' => [
4495 'title' => ts('State/Province'),
4498 'title' => ts('Country'),
4501 'title' => ts('County'),
4505 return $addressFields;
4509 * Do AlterDisplay processing on Address Fields.
4510 * If there are multiple address field values then
4511 * on basis of provided separator the code values are translated into respective labels
4514 * @param array $rows
4515 * @param int $rowNum
4516 * @param string $baseUrl
4517 * @param string $linkText
4518 * @param string $separator
4522 public function alterDisplayAddressFields(&$row, &$rows, &$rowNum, $baseUrl, $linkText, $separator = ',') {
4523 $criteriaQueryParams = CRM_Report_Utils_Report
::getPreviewCriteriaQueryParams($this->_defaults
, $this->_params
);
4524 $entryFound = FALSE;
4526 'civicrm_address_country_id' => 'country',
4527 'civicrm_address_county_id' => 'county',
4528 'civicrm_address_state_province_id' => 'stateProvince',
4530 foreach ($columnMap as $fieldName => $fnName) {
4531 if (array_key_exists($fieldName, $row)) {
4532 if ($values = $row[$fieldName]) {
4533 $values = (array) explode($separator, $values);
4534 $rows[$rowNum][$fieldName] = [];
4535 $addressField = $fnName == 'stateProvince' ?
'state' : $fnName;
4536 foreach ($values as $value) {
4537 $rows[$rowNum][$fieldName][] = CRM_Core_PseudoConstant
::$fnName($value);
4539 $rows[$rowNum][$fieldName] = implode($separator, $rows[$rowNum][$fieldName]);
4541 $url = CRM_Report_Utils_Report
::getNextUrl($baseUrl,
4542 sprintf("reset=1&force=1&%s&%s_op=in&%s_value=%s",
4543 $criteriaQueryParams,
4544 str_replace('civicrm_address_', '', $fieldName),
4545 str_replace('civicrm_address_', '', $fieldName),
4546 implode(',', $values)
4547 ), $this->_absoluteUrl
, $this->_id
4549 $rows[$rowNum]["{$fieldName}_link"] = $url;
4550 $rows[$rowNum]["{$fieldName}_hover"] = ts("%1 for this %2.", [1 => $linkText, 2 => $addressField]);
4561 * Do AlterDisplay processing on Address Fields.
4564 * @param array $rows
4565 * @param int $rowNum
4566 * @param string $baseUrl
4567 * @param string $linkText
4571 public function alterDisplayContactFields(&$row, &$rows, &$rowNum, $baseUrl, $linkText) {
4572 $entryFound = FALSE;
4573 // There is no reason not to add links for all fields but it seems a bit odd to be able to click on
4574 // 'Mrs'. Also, we don't have metadata about the title. So, add selectively to addLinks.
4575 $addLinks = ['gender_id' => 'Gender'];
4576 foreach (['prefix_id', 'suffix_id', 'gender_id', 'contact_sub_type', 'preferred_language'] as $fieldName) {
4577 if (array_key_exists('civicrm_contact_' . $fieldName, $row)) {
4578 if (($value = $row['civicrm_contact_' . $fieldName]) != FALSE) {
4579 $rowValues = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $value);
4581 foreach ($rowValues as $rowValue) {
4583 $rowLabels[] = CRM_Core_PseudoConstant
::getLabel('CRM_Contact_BAO_Contact', $fieldName, $rowValue);
4586 $rows[$rowNum]['civicrm_contact_' . $fieldName] = implode(', ', $rowLabels);
4587 if ($baseUrl && ($title = CRM_Utils_Array
::value($fieldName, $addLinks)) != FALSE) {
4588 $this->addLinkToRow($rows[$rowNum], $baseUrl, $linkText, $value, $fieldName, 'civicrm_contact', $title);
4595 'do_not_email', 'is_deceased', 'do_not_phone', 'do_not_sms', 'do_not_mail', 'is_opt_out',
4597 foreach ($yesNoFields as $fieldName) {
4598 if (array_key_exists('civicrm_contact_' . $fieldName, $row)) {
4599 // Since these are essentially 'negative fields' it feels like it
4600 // makes sense to only highlight the exceptions hence no 'No'.
4601 $rows[$rowNum]['civicrm_contact_' . $fieldName] = !empty($rows[$rowNum]['civicrm_contact_' . $fieldName]) ?
ts('Yes') : '';
4606 // Handle employer id
4607 if (array_key_exists('civicrm_contact_employer_id', $row)) {
4608 $employerId = $row['civicrm_contact_employer_id'];
4610 $rows[$rowNum]['civicrm_contact_employer_id'] = CRM_Contact_BAO_Contact
::displayName($employerId);
4611 $rows[$rowNum]['civicrm_contact_employer_id_link'] = CRM_Utils_System
::url('civicrm/contact/view', 'reset=1&cid=' . $employerId, $this->_absoluteUrl
);
4612 $rows[$rowNum]['civicrm_contact_employer_id_hover'] = ts('View Contact Summary for Employer.');
4621 * Adjusts dates passed in to YEAR() for fiscal year.
4623 * @param string $fieldName
4627 public function fiscalYearOffset($fieldName) {
4628 $config = CRM_Core_Config
::singleton();
4629 $fy = $config->fiscalYearStart
;
4630 if (CRM_Utils_Array
::value('yid_op', $this->_params
) == 'calendar' ||
4631 ($fy['d'] == 1 && $fy['M'] == 1)
4633 return "YEAR( $fieldName )";
4635 return "YEAR( $fieldName - INTERVAL " . ($fy['M'] - 1) . " MONTH" .
4636 ($fy['d'] > 1 ?
(" - INTERVAL " . ($fy['d'] - 1) . " DAY") : '') . " )";
4640 * Add Address into From Table if required.
4642 * @deprecated use joinAddressFromContact
4643 * (left here in case extensions use it).
4645 public function addAddressFromClause() {
4646 CRM_Core_Error
::deprecatedFunctionWarning('CRM_Report_Form::joinAddressFromContact');
4647 // include address field if address column is to be included
4648 if ((isset($this->_addressField
) &&
4649 $this->_addressField
4651 $this->isTableSelected('civicrm_address')
4654 LEFT JOIN civicrm_address {$this->_aliases['civicrm_address']}
4655 ON ({$this->_aliases['civicrm_contact']}.id =
4656 {$this->_aliases['civicrm_address']}.contact_id) AND
4657 {$this->_aliases['civicrm_address']}.is_primary = 1\n";
4662 * Add Phone into From Table if required.
4664 * @deprecated use joinPhoneFromContact
4665 * (left here in case extensions use it).
4667 public function addPhoneFromClause() {
4668 CRM_Core_Error
::deprecatedFunctionWarning('CRM_Report_Form::joinPhoneFromContact');
4669 // include address field if address column is to be included
4670 if ($this->isTableSelected('civicrm_phone')) {
4672 LEFT JOIN civicrm_phone {$this->_aliases['civicrm_phone']}
4673 ON ({$this->_aliases['civicrm_contact']}.id =
4674 {$this->_aliases['civicrm_phone']}.contact_id) AND
4675 {$this->_aliases['civicrm_phone']}.is_primary = 1\n";
4680 * Add Address into From Table if required.
4682 * Prefix will be added to both tables as
4683 * it is assumed you are using it to get address of a secondary contact.
4685 * @param string $prefix
4686 * @param array $extra Additional options.
4687 * Not currently used in core but may be used in override extensions.
4689 protected function joinAddressFromContact($prefix = '', $extra = []) {
4690 $defaults = ['primary_only' => TRUE];
4691 $params = array_merge($defaults, $extra);
4692 $addressTables = ['civicrm_address', 'civicrm_country', 'civicrm_worldregion', 'civicrm_state_province'];
4693 $isJoinRequired = $this->_addressField
;
4694 foreach ($addressTables as $addressTable) {
4695 if ($this->isTableSelected($prefix . $addressTable)) {
4696 $isJoinRequired = TRUE;
4699 if ($isJoinRequired) {
4701 LEFT JOIN civicrm_address {$this->_aliases[$prefix . 'civicrm_address']}
4702 ON ({$this->_aliases[$prefix . 'civicrm_contact']}.id =
4703 {$this->_aliases[$prefix . 'civicrm_address']}.contact_id)";
4704 if ($params['primary_only']) {
4706 {$this->_aliases[$prefix . 'civicrm_address']}.is_primary = 1\n";
4708 $this->_from
.= $fromJoin;
4713 * Add Country into From Table if required.
4715 * Prefix will be added to both tables as
4716 * it is assumed you are using it to get address of a secondary contact.
4718 * @param string $prefix
4719 * @param array $extra Additional options.
4720 * Not currently used in core but may be used in override extensions.
4722 protected function joinCountryFromAddress($prefix = '', $extra = []) {
4723 $defaults = ['primary_only' => TRUE];
4724 $params = array_merge($defaults, $extra);
4725 // include country field if country column is to be included
4726 if ($this->isTableSelected($prefix . 'civicrm_country') ||
$this->isTableSelected($prefix . 'civicrm_worldregion')) {
4727 if (empty($this->_aliases
[$prefix . 'civicrm_country'])) {
4728 $this->_aliases
[$prefix . 'civicrm_country'] = $prefix . '_report_country';
4731 LEFT JOIN civicrm_country {$this->_aliases[$prefix . 'civicrm_country']}
4732 ON {$this->_aliases[$prefix . 'civicrm_address']}.country_id = {$this->_aliases[$prefix . 'civicrm_country']}.id";
4733 if ($params['primary_only']) {
4735 {$this->_aliases[$prefix . 'civicrm_address']}.is_primary = 1 ";
4737 $this->_from
.= $fromJoin;
4742 * Add Phone 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 joinPhoneFromContact($prefix = '', $extra = []) {
4752 $defaults = ['primary_only' => TRUE];
4753 $params = array_merge($defaults, $extra);
4754 // include phone field if phone column is to be included
4755 if ($this->isTableSelected($prefix . 'civicrm_phone')) {
4757 LEFT JOIN civicrm_phone {$this->_aliases[$prefix . 'civicrm_phone']}
4758 ON {$this->_aliases[$prefix . 'civicrm_contact']}.id = {$this->_aliases[$prefix . 'civicrm_phone']}.contact_id";
4759 if ($params['primary_only']) {
4761 {$this->_aliases[$prefix . 'civicrm_phone']}.is_primary = 1\n";
4763 $this->_from
.= $fromJoin;
4768 * Add Email into From Table if required.
4770 * Prefix will be added to both tables as
4771 * it is assumed you are using it to get address of a secondary contact.
4773 * @param string $prefix
4774 * @param array $extra Additional options.
4775 * Not currently used in core but may be used in override extensions.
4777 protected function joinEmailFromContact($prefix = '', $extra = []) {
4778 $defaults = ['primary_only' => TRUE];
4779 $params = array_merge($defaults, $extra);
4780 // include email field if email column is to be included
4781 if ($this->isTableSelected($prefix . 'civicrm_email')) {
4783 LEFT JOIN civicrm_email {$this->_aliases[$prefix . 'civicrm_email']}
4784 ON {$this->_aliases[$prefix . 'civicrm_contact']}.id = {$this->_aliases[$prefix . 'civicrm_email']}.contact_id";
4785 if ($params['primary_only']) {
4787 {$this->_aliases[$prefix . 'civicrm_email']}.is_primary = 1 ";
4789 $this->_from
.= $fromJoin;
4794 * Add Financial Transaction into From Table if required.
4796 public function addFinancialTrxnFromClause() {
4797 if ($this->isTableSelected('civicrm_financial_trxn')) {
4799 LEFT JOIN civicrm_entity_financial_trxn eftcc
4800 ON ({$this->_aliases['civicrm_contribution']}.id = eftcc.entity_id AND
4801 eftcc.entity_table = 'civicrm_contribution')
4802 LEFT JOIN civicrm_financial_trxn {$this->_aliases['civicrm_financial_trxn']}
4803 ON {$this->_aliases['civicrm_financial_trxn']}.id = eftcc.financial_trxn_id \n";
4808 * Get phone columns to add to array.
4810 * @param array $options
4811 * - prefix Prefix to add to table (in case of more than one instance of the table)
4812 * - prefix_label Label to give columns from this phone table instance
4815 * phone columns definition
4817 public function getPhoneColumns($options = []) {
4820 'prefix_label' => '',
4823 $options = array_merge($defaultOptions, $options);
4826 $options['prefix'] . 'civicrm_phone' => [
4827 'dao' => 'CRM_Core_DAO_Phone',
4829 $options['prefix'] . 'phone' => [
4830 'title' => $options['prefix_label'] . ts('Phone'),
4840 * Get a standard set of contact fields.
4841 * @deprecated - use getColumns('Contact') instead
4844 public function getBasicContactFields() {
4847 'title' => ts('Contact Name'),
4852 'no_display' => TRUE,
4856 'title' => ts('Contact Prefix'),
4859 'title' => ts('First Name'),
4862 'title' => ts('Nick Name'),
4865 'title' => ts('Middle Name'),
4868 'title' => ts('Last Name'),
4871 'title' => ts('Contact Suffix'),
4873 'postal_greeting_display' => ['title' => ts('Postal Greeting')],
4874 'email_greeting_display' => ['title' => ts('Email Greeting')],
4875 'addressee_display' => ['title' => ts('Addressee')],
4877 'title' => ts('Contact Type'),
4879 'contact_sub_type' => [
4880 'title' => ts('Contact Subtype'),
4883 'title' => ts('Gender'),
4886 'title' => ts('Birth Date'),
4889 'title' => ts('Age'),
4890 'dbAlias' => 'TIMESTAMPDIFF(YEAR, contact_civireport.birth_date, CURDATE())',
4893 'title' => ts('Contact Job title'),
4895 'organization_name' => [
4896 'title' => ts('Organization Name'),
4898 'external_identifier' => [
4899 'title' => ts('Contact identifier from external system'),
4901 'do_not_email' => [],
4902 'do_not_phone' => [],
4903 'do_not_mail' => [],
4906 'is_deceased' => [],
4907 'preferred_language' => [],
4909 'title' => ts('Current Employer'),
4915 * Get a standard set of contact filters.
4917 * @param array $defaults
4921 public function getBasicContactFilters($defaults = []) {
4924 'title' => ts('Contact Name'),
4927 'title' => ts('Contact Source'),
4928 'type' => CRM_Utils_Type
::T_STRING
,
4931 'title' => ts('Contact ID'),
4932 'no_display' => TRUE,
4935 'title' => ts('Gender'),
4936 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
4937 'options' => CRM_Core_PseudoConstant
::get('CRM_Contact_DAO_Contact', 'gender_id'),
4940 'title' => ts('Birth Date'),
4941 'operatorType' => CRM_Report_Form
::OP_DATE
,
4944 'title' => ts('Contact Type'),
4946 'contact_sub_type' => [
4947 'title' => ts('Contact Subtype'),
4949 'modified_date' => [
4950 'title' => ts('Contact Modified'),
4951 'operatorType' => CRM_Report_Form
::OP_DATE
,
4952 'type' => CRM_Utils_Type
::T_DATE
,
4955 'title' => ts('Deceased'),
4956 'type' => CRM_Utils_Type
::T_BOOLEAN
,
4957 'default' => CRM_Utils_Array
::value('deceased', $defaults, 0),
4960 'title' => ts('Do not email'),
4961 'type' => CRM_Utils_Type
::T_BOOLEAN
,
4964 'title' => ts('Do not phone'),
4965 'type' => CRM_Utils_Type
::T_BOOLEAN
,
4968 'title' => ts('Do not mail'),
4969 'type' => CRM_Utils_Type
::T_BOOLEAN
,
4972 'title' => ts('Do not SMS'),
4973 'type' => CRM_Utils_Type
::T_BOOLEAN
,
4976 'title' => ts('Do not bulk email'),
4977 'type' => CRM_Utils_Type
::T_BOOLEAN
,
4979 'preferred_language' => [
4980 'title' => ts('Preferred Language'),
4983 'no_display' => TRUE,
4985 'type' => CRM_Utils_Type
::T_BOOLEAN
,
4991 * Add contact to group.
4993 * @param int $groupID
4995 public function add2group($groupID) {
4996 if (is_numeric($groupID) && isset($this->_aliases
['civicrm_contact'])) {
4997 $select = "SELECT DISTINCT {$this->_aliases['civicrm_contact']}.id AS addtogroup_contact_id, ";
4998 $select = preg_replace('/SELECT(\s+SQL_CALC_FOUND_ROWS)?\s+/i', $select, $this->_select
);
4999 $sql = "{$select} {$this->_from} {$this->_where} {$this->_groupBy} {$this->_having} {$this->_orderBy}";
5000 $sql = str_replace('WITH ROLLUP', '', $sql);
5001 $dao = CRM_Core_DAO
::executeQuery($sql);
5004 // Add resulting contacts to group
5005 while ($dao->fetch()) {
5006 if ($dao->addtogroup_contact_id
) {
5007 $contact_ids[$dao->addtogroup_contact_id
] = $dao->addtogroup_contact_id
;
5011 if (!empty($contact_ids)) {
5012 CRM_Contact_BAO_GroupContact
::addContactsToGroup($contact_ids, $groupID);
5013 CRM_Core_Session
::setStatus(ts("Listed contact(s) have been added to the selected group."), ts('Contacts Added'), 'success');
5016 CRM_Core_Session
::setStatus(ts("The listed records(s) cannot be added to the group."));
5022 * Apply common settings to entityRef fields.
5024 * @param array $field
5025 * @param string $table
5027 public function setEntityRefDefaults(&$field, $table) {
5028 $field['attributes'] = $field['attributes'] ?
$field['attributes'] : [];
5029 $field['attributes'] +
= [
5030 'entity' => CRM_Core_DAO_AllCoreTables
::getBriefName(CRM_Core_DAO_AllCoreTables
::getClassForTable($table)),
5032 'placeholder' => ts('- select -'),
5037 * Add link fields to the row.
5039 * Function adds the _link & _hover fields to the row.
5042 * @param string $baseUrl
5043 * @param string $linkText
5044 * @param string $value
5045 * @param string $fieldName
5046 * @param string $tablePrefix
5047 * @param string $fieldLabel
5051 protected function addLinkToRow(&$row, $baseUrl, $linkText, $value, $fieldName, $tablePrefix, $fieldLabel) {
5052 $criteriaQueryParams = CRM_Report_Utils_Report
::getPreviewCriteriaQueryParams($this->_defaults
, $this->_params
);
5053 $url = CRM_Report_Utils_Report
::getNextUrl($baseUrl,
5054 "reset=1&force=1&{$criteriaQueryParams}&" .
5055 $fieldName . "_op=in&{$fieldName}_value={$value}",
5056 $this->_absoluteUrl
, $this->_id
5058 $row["{$tablePrefix}_{$fieldName}_link"] = $url;
5059 $row["{$tablePrefix}_{$fieldName}_hover"] = ts("%1 for this %2.",
5060 [1 => $linkText, 2 => $fieldLabel]
5065 * Get label for show results buttons.
5069 public function getResultsLabel() {
5070 $showResultsLabel = $this->resultsDisplayed() ?
ts('Refresh results') : ts('View results');
5071 return $showResultsLabel;
5075 * Determine the output mode from the url or input.
5078 * - pdf : Render as pdf
5079 * - csv : Render as csv
5080 * - print : Render in print format
5081 * - save : save the report and display the new report
5082 * - copy : save the report as a new instance and display that.
5083 * - group : go to the add to group screen.
5085 * Potentially chart variations could also be included but the complexity
5086 * is that we might print a bar chart as a pdf.
5088 protected function setOutputMode() {
5089 $this->_outputMode
= str_replace('report_instance.', '', CRM_Utils_Request
::retrieve(
5092 CRM_Core_DAO
::$_nullObject,
5094 CRM_Utils_Array
::value('task', $this->_params
)
5096 // if contacts are added to group
5097 if (!empty($this->_params
['groups']) && empty($this->_outputMode
)) {
5098 $this->_outputMode
= 'group';
5100 if (isset($this->_params
['task'])) {
5101 unset($this->_params
['task']);
5106 * CRM-17793 - Alter DateTime section header to group by date from the datetime field.
5109 * @param $columnName
5111 public function alterSectionHeaderForDateTime($tempTable, $columnName) {
5112 // add new column with date value for the datetime field
5113 $tempQuery = "ALTER TABLE {$tempTable} ADD COLUMN {$columnName}_date VARCHAR(128)";
5114 CRM_Core_DAO
::executeQuery($tempQuery);
5115 $updateQuery = "UPDATE {$tempTable} SET {$columnName}_date = date({$columnName})";
5116 CRM_Core_DAO
::executeQuery($updateQuery);
5117 $this->_selectClauses
[] = "{$columnName}_date";
5118 $this->_select
.= ", {$columnName}_date";
5119 $this->_sections
["{$columnName}_date"] = $this->_sections
["{$columnName}"];
5120 unset($this->_sections
["{$columnName}"]);
5121 $this->assign('sections', $this->_sections
);
5125 * Get an array of the columns that have been selected for display.
5129 public function getSelectColumns() {
5130 $selectColumns = [];
5131 foreach ($this->_columns
as $tableName => $table) {
5132 if (array_key_exists('fields', $table)) {
5133 foreach ($table['fields'] as $fieldName => $field) {
5134 if (!empty($field['required']) ||
5135 !empty($this->_params
['fields'][$fieldName])
5138 $selectColumns["{$tableName}_{$fieldName}"] = 1;
5143 return $selectColumns;
5147 * Add location tables to the query if they are used for filtering.
5149 * This is for when we are running the query separately for filtering and retrieving display fields.
5151 public function selectivelyAddLocationTablesJoinsToFilterQuery() {
5152 if ($this->isTableFiltered('civicrm_email')) {
5154 LEFT JOIN civicrm_email {$this->_aliases['civicrm_email']}
5155 ON {$this->_aliases['civicrm_contact']}.id = {$this->_aliases['civicrm_email']}.contact_id
5156 AND {$this->_aliases['civicrm_email']}.is_primary = 1";
5158 if ($this->isTableFiltered('civicrm_phone')) {
5160 LEFT JOIN civicrm_phone {$this->_aliases['civicrm_phone']}
5161 ON {$this->_aliases['civicrm_contact']}.id = {$this->_aliases['civicrm_phone']}.contact_id
5162 AND {$this->_aliases['civicrm_phone']}.is_primary = 1";
5164 if ($this->isTableFiltered('civicrm_address')) {
5166 LEFT JOIN civicrm_address {$this->_aliases['civicrm_address']}
5167 ON ({$this->_aliases['civicrm_contact']}.id = {$this->_aliases['civicrm_address']}.contact_id)
5168 AND {$this->_aliases['civicrm_address']}.is_primary = 1\n";
5173 * Set the base table for the FROM clause.
5175 * Sets up the from clause, allowing for the possibility it might be a
5176 * temp table pre-filtered by groups if a group filter is in use.
5178 * @param string $baseTable
5179 * @param string $field
5180 * @param null $tableAlias
5182 public function setFromBase($baseTable, $field = 'id', $tableAlias = NULL) {
5184 $tableAlias = $this->_aliases
[$baseTable];
5186 $this->_from
= $this->_from
= " FROM $baseTable $tableAlias ";
5187 $this->joinGroupTempTable($baseTable, $field, $tableAlias);
5188 $this->_from
.= " {$this->_aclFrom} ";
5192 * Join the temp table contacting contacts who are members of the filtered groups.
5194 * If we are using an IN filter we use an inner join, otherwise a left join.
5196 * @param string $baseTable
5197 * @param string $field
5198 * @param string $tableAlias
5200 public function joinGroupTempTable($baseTable, $field, $tableAlias) {
5201 if ($this->groupTempTable
) {
5202 if ($this->_params
['gid_op'] == 'in') {
5203 $this->_from
= " FROM $this->groupTempTable group_temp_table INNER JOIN $baseTable $tableAlias
5204 ON group_temp_table.id = $tableAlias.{$field} ";
5208 LEFT JOIN $this->groupTempTable group_temp_table
5209 ON $tableAlias.{$field} = group_temp_table.id ";
5215 * Get all labels for fields that are used in a group concat.
5217 * @param string $options
5218 * comma separated option values.
5219 * @param string $baoName
5220 * The BAO name for the field.
5221 * @param string $fieldName
5222 * The name of the field for which labels should be retrieved.
5226 public function getLabels($options, $baoName, $fieldName) {
5227 $types = explode(',', $options);
5229 foreach ($types as $value) {
5230 $labels[$value] = CRM_Core_PseudoConstant
::getLabel($baoName, $fieldName, $value);
5232 return implode(', ', array_filter($labels));
5236 * Add statistics columns.
5238 * If a group by is in play then add columns for the statistics fields.
5240 * This would lead to a new field in the $row such as $fieldName_sum and a new, matching
5241 * column header field.
5243 * @param array $field
5244 * @param string $tableName
5245 * @param string $fieldName
5246 * @param array $select
5250 protected function addStatisticsToSelect($field, $tableName, $fieldName, $select) {
5251 foreach ($field['statistics'] as $stat => $label) {
5252 $alias = "{$tableName}_{$fieldName}_{$stat}";
5253 switch (strtolower($stat)) {
5256 $select[] = "$stat({$field['dbAlias']}) as $alias";
5257 $this->_columnHeaders
["{$tableName}_{$fieldName}_{$stat}"]['title'] = $label;
5258 $this->_columnHeaders
["{$tableName}_{$fieldName}_{$stat}"]['type'] = $field['type'];
5259 $this->_statFields
[$label] = $alias;
5260 $this->_selectAliases
[] = $alias;
5264 $select[] = "COUNT({$field['dbAlias']}) as $alias";
5265 $this->_columnHeaders
["{$tableName}_{$fieldName}_{$stat}"]['title'] = $label;
5266 $this->_columnHeaders
["{$tableName}_{$fieldName}_{$stat}"]['type'] = CRM_Utils_Type
::T_INT
;
5267 $this->_statFields
[$label] = $alias;
5268 $this->_selectAliases
[] = $alias;
5271 case 'count_distinct':
5272 $select[] = "COUNT(DISTINCT {$field['dbAlias']}) as $alias";
5273 $this->_columnHeaders
["{$tableName}_{$fieldName}_{$stat}"]['title'] = $label;
5274 $this->_columnHeaders
["{$tableName}_{$fieldName}_{$stat}"]['type'] = CRM_Utils_Type
::T_INT
;
5275 $this->_statFields
[$label] = $alias;
5276 $this->_selectAliases
[] = $alias;
5280 $select[] = "ROUND(AVG({$field['dbAlias']}),2) as $alias";
5281 $this->_columnHeaders
["{$tableName}_{$fieldName}_{$stat}"]['title'] = $label;
5282 $this->_columnHeaders
["{$tableName}_{$fieldName}_{$stat}"]['type'] = $field['type'];
5283 $this->_statFields
[$label] = $alias;
5284 $this->_selectAliases
[] = $alias;
5292 * Add a basic field to the select clause.
5294 * @param string $tableName
5295 * @param string $fieldName
5296 * @param array $field
5297 * @param string $select
5300 protected function addBasicFieldToSelect($tableName, $fieldName, $field, $select) {
5301 $alias = "{$tableName}_{$fieldName}";
5302 $select[] = "{$field['dbAlias']} as $alias";
5303 $this->_columnHeaders
["{$tableName}_{$fieldName}"]['title'] = CRM_Utils_Array
::value('title', $field);
5304 $this->_columnHeaders
["{$tableName}_{$fieldName}"]['type'] = CRM_Utils_Array
::value('type', $field);
5305 $this->_selectAliases
[] = $alias;
5312 * @param array $table
5313 * @param string $tableName
5318 protected function setTableAlias($table, $tableName) {
5319 if (!isset($table['alias'])) {
5320 $this->_columns
[$tableName]['alias'] = substr($tableName, 8) .
5324 $this->_columns
[$tableName]['alias'] = $table['alias'] . '_civireport';
5327 $this->_aliases
[$tableName] = $this->_columns
[$tableName]['alias'];
5328 return $this->_aliases
[$tableName];
5332 * Function to add columns to reports.
5334 * This is ported from extended reports, which also adds join filters to the options.
5336 * @param string $type
5337 * @param array $options
5338 * - prefix - A string to prepend to the table name
5339 * - prefix_label A string to prepend to the fields
5340 * - fields (bool) - should the fields for this table be made available
5341 * - group_by (bool) - should the group bys for this table be made available.
5342 * - order_by (bool) - should the group bys for this table be made available.
5343 * - filters (bool) - should the filters for this table by made available.
5344 * - fields_defaults (array) array of fields that should be displayed by default.
5345 * - filters_defaults (array) array of fields that should be filtered by default.
5346 * - join_filters (array) fields available for filtering joins (requires additional custom code).
5347 * - join_fields (array) fields available from join (requires additional custom code).
5348 * - group_by_defaults (array) array of group bys that should be applied by default.
5349 * - order_by_defaults (array) array of order bys that should be applied by default.
5350 * - custom_fields (array) array of entity types for custom fields (not usually required).
5351 * - contact_type (string) optional restriction on contact type for some tables.
5352 * - fields_excluded (array) fields that are in the generic set for the table but not in the report.
5356 protected function getColumns($type, $options = []) {
5359 'prefix_label' => '',
5361 'group_bys' => FALSE,
5362 'order_bys' => TRUE,
5364 'join_filters' => FALSE,
5365 'fields_defaults' => [],
5366 'filters_defaults' => [],
5367 'group_bys_defaults' => [],
5368 'order_bys_defaults' => [],
5370 $options = array_merge($defaultOptions, $options);
5372 $fn = 'get' . $type . 'Columns';
5373 return $this->$fn($options);
5377 * Get columns for contact table.
5379 * @param array $options
5383 protected function getContactColumns($options = []) {
5385 'custom_fields' => ['Individual', 'Contact', 'Organization'],
5386 'fields_defaults' => ['display_name', 'id'],
5387 'order_bys_defaults' => ['sort_name ASC'],
5388 'contact_type' => NULL,
5391 $options = array_merge($defaultOptions, $options);
5393 $tableAlias = $options['prefix'] . 'contact';
5396 $options['prefix'] . 'display_name' => [
5397 'name' => 'display_name',
5398 'title' => $options['prefix_label'] . ts('Contact Name'),
5399 'is_fields' => TRUE,
5401 $options['prefix'] . 'sort_name' => [
5402 'name' => 'sort_name',
5403 'title' => $options['prefix_label'] . ts('Contact Name (in sort format)'),
5404 'is_fields' => TRUE,
5405 'is_filters' => TRUE,
5406 'is_order_bys' => TRUE,
5408 $options['prefix'] . 'id' => [
5410 'title' => $options['prefix_label'] . ts('Contact ID'),
5411 'alter_display' => 'alterContactID',
5412 'type' => CRM_Utils_Type
::T_INT
,
5413 'is_order_bys' => TRUE,
5414 'is_group_bys' => TRUE,
5415 'is_fields' => TRUE,
5416 'is_filters' => TRUE,
5418 $options['prefix'] . 'external_identifier' => [
5419 'name' => 'external_identifier',
5420 'title' => $options['prefix_label'] . ts('External ID'),
5421 'type' => CRM_Utils_Type
::T_INT
,
5422 'is_fields' => TRUE,
5424 $options['prefix'] . 'contact_type' => [
5425 'title' => $options['prefix_label'] . ts('Contact Type'),
5426 'name' => 'contact_type',
5427 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
5428 'options' => CRM_Contact_BAO_Contact
::buildOptions('contact_type'),
5429 'is_fields' => TRUE,
5430 'is_filters' => TRUE,
5431 'is_group_bys' => TRUE,
5433 $options['prefix'] . 'contact_sub_type' => [
5434 'title' => $options['prefix_label'] . ts('Contact Sub Type'),
5435 'name' => 'contact_sub_type',
5436 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
5437 'options' => CRM_Contact_BAO_Contact
::buildOptions('contact_sub_type'),
5438 'is_fields' => TRUE,
5439 'is_filters' => TRUE,
5440 'is_group_bys' => TRUE,
5442 $options['prefix'] . 'is_deleted' => [
5443 'title' => $options['prefix_label'] . ts('Is deleted'),
5444 'name' => 'is_deleted',
5445 'type' => CRM_Utils_Type
::T_BOOLEAN
,
5446 'is_fields' => FALSE,
5447 'is_filters' => TRUE,
5448 'is_group_bys' => FALSE,
5450 $options['prefix'] . 'external_identifier' => [
5451 'title' => $options['prefix_label'] . ts('Contact identifier from external system'),
5452 'name' => 'external_identifier',
5453 'is_fields' => TRUE,
5454 'is_filters' => FALSE,
5455 'is_group_bys' => FALSE,
5456 'is_order_bys' => TRUE,
5458 $options['prefix'] . 'preferred_language' => [
5459 'title' => $options['prefix_label'] . ts('Preferred Language'),
5460 'name' => 'preferred_language',
5461 'is_fields' => TRUE,
5462 'is_filters' => TRUE,
5463 'is_group_bys' => TRUE,
5464 'is_order_bys' => TRUE,
5468 'postal_greeting_display' => 'Postal Greeting',
5469 'email_greeting_display' => 'Email Greeting',
5470 'addressee_display' => 'Addressee',
5471 ] as $field => $title) {
5472 $spec[$options['prefix'] . $field] = [
5473 'title' => $options['prefix_label'] . ts($title),
5475 'is_fields' => TRUE,
5476 'is_filters' => FALSE,
5477 'is_group_bys' => FALSE,
5480 foreach (['do_not_email', 'do_not_phone', 'do_not_mail', 'do_not_sms', 'is_opt_out'] as $field) {
5481 $spec[$options['prefix'] . $field] = [
5483 'type' => CRM_Utils_Type
::T_BOOLEAN
,
5484 'is_fields' => TRUE,
5485 'is_filters' => TRUE,
5486 'is_group_bys' => FALSE,
5489 $individualFields = [
5490 $options['prefix'] . 'first_name' => [
5491 'name' => 'first_name',
5492 'title' => $options['prefix_label'] . ts('First Name'),
5493 'is_fields' => TRUE,
5494 'is_filters' => TRUE,
5495 'is_order_bys' => TRUE,
5497 $options['prefix'] . 'middle_name' => [
5498 'name' => 'middle_name',
5499 'title' => $options['prefix_label'] . ts('Middle Name'),
5500 'is_fields' => TRUE,
5502 $options['prefix'] . 'last_name' => [
5503 'name' => 'last_name',
5504 'title' => $options['prefix_label'] . ts('Last Name'),
5505 'default_order' => 'ASC',
5506 'is_fields' => TRUE,
5508 $options['prefix'] . 'nick_name' => [
5509 'name' => 'nick_name',
5510 'title' => $options['prefix_label'] . ts('Nick Name'),
5511 'is_fields' => TRUE,
5513 $options['prefix'] . 'prefix_id' => [
5514 'name' => 'prefix_id',
5515 'title' => $options['prefix_label'] . ts('Prefix'),
5516 'options' => CRM_Contact_BAO_Contact
::buildOptions('prefix_id'),
5517 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
5518 'is_fields' => TRUE,
5519 'is_filters' => TRUE,
5521 $options['prefix'] . 'suffix_id' => [
5522 'name' => 'suffix_id',
5523 'title' => $options['prefix_label'] . ts('Suffix'),
5524 'options' => CRM_Contact_BAO_Contact
::buildOptions('suffix_id'),
5525 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
5526 'is_fields' => TRUE,
5527 'is_filters' => TRUE,
5529 $options['prefix'] . 'gender_id' => [
5530 'name' => 'gender_id',
5531 'title' => $options['prefix_label'] . ts('Gender'),
5532 'options' => CRM_Contact_BAO_Contact
::buildOptions('gender_id'),
5533 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
5534 'is_fields' => TRUE,
5535 'is_filters' => TRUE,
5538 'title' => $options['prefix_label'] . ts('Birth Date'),
5539 'operatorType' => CRM_Report_Form
::OP_DATE
,
5540 'type' => CRM_Utils_Type
::T_DATE
,
5541 'is_fields' => TRUE,
5542 'is_filters' => TRUE,
5545 'title' => $options['prefix_label'] . ts('Age'),
5546 'dbAlias' => 'TIMESTAMPDIFF(YEAR, ' . $tableAlias . '_civireport.birth_date, CURDATE())',
5547 'type' => CRM_Utils_Type
::T_INT
,
5548 'is_fields' => TRUE,
5550 $options['prefix'] . 'is_deceased' => [
5551 'title' => $options['prefix_label'] . ts('Is deceased'),
5552 'name' => 'is_deceased',
5553 'type' => CRM_Utils_Type
::T_BOOLEAN
,
5554 'is_fields' => FALSE,
5555 'is_filters' => TRUE,
5556 'is_group_bys' => FALSE,
5558 $options['prefix'] . 'job_title' => [
5559 'name' => 'job_title',
5560 'is_fields' => TRUE,
5561 'is_filters' => FALSE,
5562 'is_group_bys' => FALSE,
5564 $options['prefix'] . 'employer_id' => [
5565 'title' => $options['prefix_label'] . ts('Current Employer'),
5566 'type' => CRM_Utils_Type
::T_INT
,
5567 'name' => 'employer_id',
5568 'is_fields' => TRUE,
5569 'is_filters' => FALSE,
5570 'is_group_bys' => TRUE,
5573 if (!$options['contact_type'] ||
$options['contact_type'] === 'Individual') {
5574 $spec = array_merge($spec, $individualFields);
5577 if (!empty($options['custom_fields'])) {
5578 $this->_customGroupExtended
[$options['prefix'] . 'civicrm_contact'] = [
5579 'extends' => $options['custom_fields'],
5580 'title' => $options['prefix_label'],
5581 'filters' => $options['filters'],
5582 'prefix' => $options['prefix'],
5583 'prefix_label' => $options['prefix_label'],
5587 return $this->buildColumns($spec, $options['prefix'] . 'civicrm_contact', 'CRM_Contact_DAO_Contact', $tableAlias, $this->getDefaultsFromOptions($options), $options);
5591 * Get address columns to add to array.
5593 * @param array $options
5594 * - prefix Prefix to add to table (in case of more than one instance of the table)
5595 * - prefix_label Label to give columns from this address table instance
5596 * - group_bys enable these fields for group by - default false
5597 * - order_bys enable these fields for order by
5598 * - filters enable these fields for filtering
5600 * @return array address columns definition
5602 protected function getAddressColumns($options = []) {
5605 'prefix_label' => '',
5607 'group_bys' => FALSE,
5608 'order_bys' => TRUE,
5610 'join_filters' => FALSE,
5611 'fields_defaults' => [],
5612 'filters_defaults' => [],
5613 'group_bys_defaults' => [],
5614 'order_bys_defaults' => [],
5617 $options = array_merge($defaultOptions, $options);
5618 $defaults = $this->getDefaultsFromOptions($options);
5619 $tableAlias = $options['prefix'] . 'address';
5622 $options['prefix'] . 'name' => [
5623 'title' => $options['prefix_label'] . ts('Address Name'),
5625 'is_fields' => TRUE,
5627 $options['prefix'] . 'street_number' => [
5628 'name' => 'street_number',
5629 'title' => $options['prefix_label'] . ts('Street Number'),
5631 'is_fields' => TRUE,
5633 $options['prefix'] . 'odd_street_number' => [
5634 'title' => ts('Odd / Even Street Number'),
5635 'name' => 'odd_street_number',
5636 'type' => CRM_Utils_Type
::T_INT
,
5637 'no_display' => TRUE,
5639 'dbAlias' => "({$tableAlias}_civireport.street_number % 2)",
5640 'is_fields' => TRUE,
5641 'is_order_bys' => TRUE,
5643 $options['prefix'] . 'street_name' => [
5644 'name' => 'street_name',
5645 'title' => $options['prefix_label'] . ts('Street Name'),
5647 'is_fields' => TRUE,
5648 'is_filters' => TRUE,
5649 'operator' => 'like',
5650 'is_order_bys' => TRUE,
5652 $options['prefix'] . 'street_address' => [
5653 'title' => $options['prefix_label'] . ts('Street Address'),
5654 'name' => 'street_address',
5655 'is_fields' => TRUE,
5656 'is_filters' => TRUE,
5657 'is_group_bys' => TRUE,
5659 $options['prefix'] . 'supplemental_address_1' => [
5660 'title' => $options['prefix_label'] . ts('Supplementary Address Field 1'),
5661 'name' => 'supplemental_address_1',
5662 'is_fields' => TRUE,
5664 $options['prefix'] . 'supplemental_address_2' => [
5665 'title' => $options['prefix_label'] . ts('Supplementary Address Field 2'),
5666 'name' => 'supplemental_address_2',
5667 'is_fields' => TRUE,
5669 $options['prefix'] . 'supplemental_address_3' => [
5670 'title' => $options['prefix_label'] . ts('Supplementary Address Field 3'),
5671 'name' => 'supplemental_address_3',
5672 'is_fields' => TRUE,
5674 $options['prefix'] . 'street_number' => [
5675 'name' => 'street_number',
5676 'title' => $options['prefix_label'] . ts('Street Number'),
5678 'is_order_bys' => TRUE,
5679 'is_filters' => TRUE,
5680 'is_fields' => TRUE,
5682 $options['prefix'] . 'street_unit' => [
5683 'name' => 'street_unit',
5684 'title' => $options['prefix_label'] . ts('Street Unit'),
5686 'is_fields' => TRUE,
5688 $options['prefix'] . 'city' => [
5689 'title' => $options['prefix_label'] . ts('City'),
5691 'operator' => 'like',
5692 'is_fields' => TRUE,
5693 'is_filters' => TRUE,
5694 'is_group_bys' => TRUE,
5695 'is_order_bys' => TRUE,
5697 $options['prefix'] . 'postal_code' => [
5698 'title' => $options['prefix_label'] . ts('Postal Code'),
5699 'name' => 'postal_code',
5701 'is_fields' => TRUE,
5702 'is_filters' => TRUE,
5703 'is_group_bys' => TRUE,
5704 'is_order_bys' => TRUE,
5706 $options['prefix'] . 'postal_code_suffix' => [
5707 'title' => $options['prefix_label'] . ts('Postal Code Suffix'),
5708 'name' => 'postal_code_suffix',
5710 'is_fields' => TRUE,
5711 'is_filters' => TRUE,
5712 'is_group_bys' => TRUE,
5713 'is_order_bys' => TRUE,
5715 $options['prefix'] . 'county_id' => [
5716 'title' => $options['prefix_label'] . ts('County'),
5717 'alter_display' => 'alterCountyID',
5718 'name' => 'county_id',
5719 'type' => CRM_Utils_Type
::T_INT
,
5720 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
5721 'options' => CRM_Core_PseudoConstant
::county(),
5722 'is_fields' => TRUE,
5723 'is_filters' => TRUE,
5724 'is_group_bys' => TRUE,
5726 $options['prefix'] . 'state_province_id' => [
5727 'title' => $options['prefix_label'] . ts('State/Province'),
5728 'alter_display' => 'alterStateProvinceID',
5729 'name' => 'state_province_id',
5730 'type' => CRM_Utils_Type
::T_INT
,
5731 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
5732 'options' => CRM_Core_PseudoConstant
::stateProvince(),
5733 'is_fields' => TRUE,
5734 'is_filters' => TRUE,
5735 'is_group_bys' => TRUE,
5737 $options['prefix'] . 'country_id' => [
5738 'title' => $options['prefix_label'] . ts('Country'),
5739 'alter_display' => 'alterCountryID',
5740 'name' => 'country_id',
5741 'is_fields' => TRUE,
5742 'is_filters' => TRUE,
5743 'is_group_bys' => TRUE,
5744 'type' => CRM_Utils_Type
::T_INT
,
5745 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
5746 'options' => CRM_Core_PseudoConstant
::country(),
5748 $options['prefix'] . 'location_type_id' => [
5749 'name' => 'location_type_id',
5750 'title' => $options['prefix_label'] . ts('Location Type'),
5751 'type' => CRM_Utils_Type
::T_INT
,
5752 'is_fields' => TRUE,
5753 'alter_display' => 'alterLocationTypeID',
5755 $options['prefix'] . 'id' => [
5756 'title' => $options['prefix_label'] . ts('ID'),
5758 'is_fields' => TRUE,
5760 $options['prefix'] . 'is_primary' => [
5761 'name' => 'is_primary',
5762 'title' => $options['prefix_label'] . ts('Primary Address?'),
5763 'type' => CRM_Utils_Type
::T_BOOLEAN
,
5764 'is_fields' => TRUE,
5767 return $this->buildColumns($spec, $options['prefix'] . 'civicrm_address', 'CRM_Core_DAO_Address', $tableAlias, $defaults, $options);
5771 * Build the columns.
5773 * The normal report class needs you to remember to do a few things that are often erratic
5775 * 1) use a unique key for any field that might not be unique (e.g. start date, label)
5776 * - this class will prepend an alias to the key & set the 'name' if you don't set it yourself.
5777 * You can suppress the alias with 'no_field_disambiguation' if transitioning existing reports. This
5778 * means any saved filters / fields on saved report instances. This will mean that matching names from
5779 * different tables may be ambigious, but it will smooth any code transition.
5780 * - note that it assumes the value being passed in is the actual table field name
5782 * 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
5783 * contexts - the code looks up the fields array for data - so it both defines the field spec & the fields you want to show
5785 * 3) this function also sets the 'metadata' array - the extended report class now uses this in place
5786 * of the fields array to reduce the issues caused when metadata is needed but 'fields' are not defined. Code in
5787 * the core classes can start to move towards that.
5789 * @param array $specs
5790 * @param string $tableName
5791 * @param string $daoName
5792 * @param string $tableAlias
5793 * @param array $defaults
5794 * @param array $options
5798 protected function buildColumns($specs, $tableName, $daoName = NULL, $tableAlias = NULL, $defaults = [], $options = []) {
5800 $tableAlias = str_replace('civicrm_', '', $tableName);
5802 $types = ['filters', 'group_bys', 'order_bys', 'join_filters'];
5803 $columns = [$tableName => array_fill_keys($types, [])];
5804 // The code that uses this no longer cares if it is a DAO or BAO so just call it a DAO.
5805 $columns[$tableName]['dao'] = $daoName;
5806 $columns[$tableName]['alias'] = $tableAlias;
5808 foreach ($specs as $specName => $spec) {
5809 if (empty($spec['name'])) {
5810 $spec['name'] = $specName;
5813 $fieldAlias = (empty($options['no_field_disambiguation']) ?
$tableAlias . '_' : '') . $specName;
5814 $columns[$tableName]['metadata'][$fieldAlias] = $spec;
5815 $columns[$tableName]['fields'][$fieldAlias] = $spec;
5816 if (isset($defaults['fields_defaults']) && in_array($spec['name'], $defaults['fields_defaults'])) {
5817 $columns[$tableName]['fields'][$fieldAlias]['default'] = TRUE;
5820 if (!$spec['is_fields'] ||
(isset($options['fields_excluded']) && in_array($specName, $options['fields_excluded']))) {
5821 $columns[$tableName]['fields'][$fieldAlias]['no_display'] = TRUE;
5824 if (isset($options['fields_required']) && in_array($specName, $options['fields_required'])) {
5825 $columns[$tableName]['fields'][$fieldAlias]['required'] = TRUE;
5828 foreach ($types as $type) {
5829 if ($options[$type] && !empty($spec['is_' . $type])) {
5830 $columns[$tableName][$type][$fieldAlias] = $spec;
5831 if (isset($defaults[$type . '_defaults']) && isset($defaults[$type . '_defaults'][$spec['name']])) {
5832 $columns[$tableName][$type][$fieldAlias]['default'] = $defaults[$type . '_defaults'][$spec['name']];
5841 * Store group bys into array - so we can check elsewhere what is grouped.
5843 protected function storeGroupByArray() {
5845 if (!CRM_Utils_Array
::value('group_bys', $this->_params
)
5846 ||
!is_array($this->_params
['group_bys'])) {
5847 $this->_params
['group_bys'] = [];
5850 foreach ($this->_columns
as $tableName => $table) {
5851 $table = $this->_columns
[$tableName];
5852 if (array_key_exists('group_bys', $table)) {
5853 foreach ($table['group_bys'] as $fieldName => $fieldData) {
5854 $field = $this->_columns
[$tableName]['metadata'][$fieldName];
5855 if (!empty($this->_params
['group_bys'][$fieldName]) ||
!empty($fieldData['required'])) {
5856 if (!empty($field['chart'])) {
5857 $this->assign('chartSupported', TRUE);
5860 if (!empty($table['group_bys'][$fieldName]['frequency']) &&
5861 !empty($this->_params
['group_bys_freq'][$fieldName])
5864 switch ($this->_params
['group_bys_freq'][$fieldName]) {
5866 $this->_groupByArray
[$tableName . '_' . $fieldName . '_start'] = self
::fiscalYearOffset($field['dbAlias']);
5869 $this->_groupByArray
[$tableName . '_' . $fieldName . '_start'] = " {$this->_params['group_bys_freq'][$fieldName]}({$field['dbAlias']})";
5872 $this->_groupByArray
[$tableName . '_' . $fieldName . '_start'] = "EXTRACT(YEAR_{$this->_params['group_bys_freq'][$fieldName]} FROM {$field['dbAlias']})";
5877 if (!in_array($field['dbAlias'], $this->_groupByArray
)) {
5878 $this->_groupByArray
[$tableName . '_' . $fieldName] = $field['dbAlias'];
5893 protected function getDefaultsFromOptions($options) {
5895 'fields_defaults' => $options['fields_defaults'],
5896 'filters_defaults' => $options['filters_defaults'],
5897 'group_bys_defaults' => $options['group_bys_defaults'],
5898 'order_bys_defaults' => $options['order_bys_defaults'],
5904 * Get the select clause for a field, wrapping in GROUP_CONCAT if appropriate.
5906 * Full group by mode dictates that a field must either be in the group by function or
5907 * wrapped in a aggregate function. Here we wrap the field in GROUP_CONCAT if it is not in the
5910 * @param string $tableName
5911 * @param string $fieldName
5912 * @param string $field
5915 protected function getSelectClauseWithGroupConcatIfNotGroupedBy($tableName, &$fieldName, &$field) {
5916 if ($this->groupConcatTested
&& (!empty($this->_groupByArray
) ||
$this->isForceGroupBy
)) {
5917 if ((empty($field['statistics']) ||
in_array('GROUP_CONCAT', $field['statistics']))) {
5918 $label = CRM_Utils_Array
::value('title', $field);
5919 $alias = $field['tplField'] ??
"{$tableName}_{$fieldName}";
5920 $this->_columnHeaders
["{$tableName}_{$fieldName}"]['title'] = $label;
5921 $this->_selectAliases
[] = $alias;
5922 if (empty($this->_groupByArray
[$tableName . '_' . $fieldName])) {
5923 return "GROUP_CONCAT(DISTINCT {$field['dbAlias']}) as $alias";
5925 return "({$field['dbAlias']}) as $alias";
5931 * Generate clause for the selected filter.
5933 * @param array $field
5934 * Field specification
5935 * @param string $fieldName
5939 * Relevant where clause.
5941 protected function generateFilterClause($field, $fieldName) {
5942 if (CRM_Utils_Array
::value('type', $field) & CRM_Utils_Type
::T_DATE
) {
5943 if (CRM_Utils_Array
::value('operatorType', $field) ==
5944 CRM_Report_Form
::OP_MONTH
5946 $op = CRM_Utils_Array
::value("{$fieldName}_op", $this->_params
);
5947 $value = CRM_Utils_Array
::value("{$fieldName}_value", $this->_params
);
5948 if (is_array($value) && !empty($value)) {
5949 return "(month({$field['dbAlias']}) $op (" . implode(', ', $value) .
5954 $relative = CRM_Utils_Array
::value("{$fieldName}_relative", $this->_params
);
5955 $from = CRM_Utils_Array
::value("{$fieldName}_from", $this->_params
);
5956 $to = CRM_Utils_Array
::value("{$fieldName}_to", $this->_params
);
5957 $fromTime = CRM_Utils_Array
::value("{$fieldName}_from_time", $this->_params
);
5958 $toTime = CRM_Utils_Array
::value("{$fieldName}_to_time", $this->_params
);
5959 return $this->dateClause($field['dbAlias'], $relative, $from, $to, $field['type'], $fromTime, $toTime);
5963 $op = CRM_Utils_Array
::value("{$fieldName}_op", $this->_params
);
5965 return $this->whereClause($field,
5967 CRM_Utils_Array
::value("{$fieldName}_value", $this->_params
),
5968 CRM_Utils_Array
::value("{$fieldName}_min", $this->_params
),
5969 CRM_Utils_Array
::value("{$fieldName}_max", $this->_params
)