3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
29 * Class CRM_Report_Form
31 class CRM_Report_Form
extends CRM_Core_Form
{
32 const ROW_COUNT_LIMIT
= 50;
35 * Operator types - used for displaying filter elements
45 OP_MULTISELECT_SEPARATOR
= 66,
50 * The id of the report instance
57 * The id of the report template
61 protected $_templateID;
69 protected $_noFields = FALSE;
72 * The set of all columns in the report. An associative array
73 * with column name as the key and attributes as the value
77 protected $_columns = array();
80 * The set of filters in the report
84 protected $_filters = array();
87 * The set of optional columns in the report
91 public $_options = array();
94 * By default most reports hide contact id.
95 * Setting this to true makes it available
97 protected $_exposeContactID = TRUE;
100 * Set of statistic fields
104 protected $_statFields = array();
107 * Set of statistics data
111 protected $_statistics = array();
114 * List of fields not to be repeated during display
118 protected $_noRepeats = array();
121 * List of fields not to be displayed
125 protected $_noDisplay = array();
128 * Object type that a custom group extends
132 protected $_customGroupExtends = NULL;
133 protected $_customGroupExtendsJoin = array();
134 protected $_customGroupFilters = TRUE;
135 protected $_customGroupGroupBy = FALSE;
136 protected $_customGroupJoin = 'LEFT JOIN';
141 protected $_tagFilter = FALSE;
144 * specify entity table for tags filter
146 protected $_tagFilterTable = 'civicrm_contact';
149 * Build groups filter.
153 protected $_groupFilter = FALSE;
156 * Has the report been optimised for group filtering.
158 * The functionality for group filtering has been improved but not
159 * all reports have been adjusted to take care of it.
161 * This property exists to highlight the reports which are still using the
162 * slow method & allow group filtering to still work for them until they
165 * In order to protect extensions we have to default to TRUE - but I have
166 * separately marked every class with a groupFilter in the hope that will trigger
167 * people to fix them as they touch them.
173 protected $groupFilterNotOptimised = TRUE;
180 public $_navigation = array();
182 public $_drilldownReport = array();
185 * Array of tabs to display on report.
187 * E.g we define the tab title, the tpl and the tab-specific part of the css or html link.
189 * $this->tabs['OrderBy'] = array(
190 * 'title' => ts('Sorting'),
191 * 'tpl' => 'OrderBy',
192 * 'div_label' => 'order-by',
197 protected $tabs = array();
200 * Should we add paging.
204 protected $addPaging = TRUE;
206 protected $isForceGroupBy = FALSE;
208 protected $groupConcatTested = FALSE;
211 * An attribute for checkbox/radio form field layout
215 protected $_fourColumnAttribute = array(
216 '</td><td width="25%">',
217 '</td><td width="25%">',
218 '</td><td width="25%">',
222 protected $_force = 1;
224 protected $_params = NULL;
225 protected $_formValues = NULL;
226 protected $_instanceValues = NULL;
228 protected $_instanceForm = FALSE;
229 protected $_criteriaForm = FALSE;
231 protected $_instanceButtonName = NULL;
232 protected $_createNewButtonName = NULL;
233 protected $_printButtonName = NULL;
234 protected $_pdfButtonName = NULL;
235 protected $_csvButtonName = NULL;
236 protected $_groupButtonName = NULL;
237 protected $_chartButtonName = NULL;
238 protected $_csvSupported = TRUE;
239 protected $_add2groupSupported = TRUE;
240 protected $_groups = NULL;
241 protected $_grandFlag = FALSE;
242 protected $_rowsFound = NULL;
243 protected $_selectAliases = array();
244 protected $_rollup = NULL;
247 * Table containing list of contact IDs within the group filter.
251 protected $groupTempTable = '';
256 protected $_aliases = array();
272 protected $_limit = NULL;
275 * This can be set to specify a limit to the number of rows
276 * Since it is currently envisaged as part of the api usage it is only being applied
277 * when $_output mode is not 'html' or 'group' so as not to have to interpret / mess with that part
278 * of the code (see limit() fn.
282 protected $_limitValue = NULL;
285 * This can be set to specify row offset
286 * See notes on _limitValue
289 protected $_offsetValue = NULL;
293 protected $_sections = NULL;
294 protected $_autoIncludeIndexedFieldsAsOrderBys = 0;
295 protected $_absoluteUrl = FALSE;
298 * Flag to indicate if result-set is to be stored in a class variable which could be retrieved using getResultSet() method.
302 protected $_storeResultSet = FALSE;
305 * When _storeResultSet Flag is set use this var to store result set in form of array
309 protected $_resultSet = array();
312 * To what frequency group-by a date column
316 protected $_groupByDateFreq = array(
318 'YEARWEEK' => 'Week',
319 'QUARTER' => 'Quarter',
324 * Variables to hold the acl inner join and where clause
326 protected $_aclFrom = NULL;
327 protected $_aclWhere = NULL;
330 * Array of DAO tables having columns included in SELECT or ORDER BY clause.
332 * Where has also been added to this although perhaps the 'includes both' array should have a different name.
336 protected $_selectedTables = array();
339 * Array of DAO tables having columns included in WHERE or HAVING clause
343 protected $filteredTables;
346 * Output mode e.g 'print', 'csv', 'pdf'.
350 protected $_outputMode;
353 * Format of any chart in use.
355 * (it's unclear if this could be merged with outputMode at this stage)
361 public $_having = NULL;
362 public $_select = NULL;
363 public $_selectClauses = array();
364 public $_columnHeaders = array();
365 public $_orderBy = NULL;
366 public $_orderByFields = array();
367 public $_orderByArray = array();
369 * Array of clauses to group by.
373 protected $_groupByArray = array();
374 public $_groupBy = NULL;
375 public $_whereClauses = array();
376 public $_havingClauses = array();
379 * DashBoardRowCount Dashboard row count
382 public $_dashBoardRowCount;
385 * Is this being called without a form controller (ie. the report is being render outside the normal form
386 * - e.g the api is retrieving the rows
389 public $noController = FALSE;
392 * Variable to hold the currency alias
394 protected $_currencyColumn = NULL;
399 protected $_interval;
404 protected $_sendmail;
417 * @var string Report description.
419 public $_description;
422 * @var bool Is an address field selected.
423 * This was intended to determine if the address table should be joined in
424 * The isTableSelected function is now preferred for this purpose
426 protected $_addressField;
429 * @var bool Is an email field selected.
430 * This was intended to determine if the email table should be joined in
431 * The isTableSelected function is now preferred for this purpose
433 protected $_emailField;
436 * @var bool Is a phone field selected.
437 * This was intended to determine if the phone table should be joined in
438 * The isTableSelected function is now preferred for this purpose
440 protected $_phoneField;
443 * @var bool Create new report instance? (or update existing) on save.
445 protected $_createNew;
448 * When a grand total row has calculated the status we pop it off to here.
450 * This allows us to access it from the stats function and avoid recalculating.
452 protected $rollupRow = array();
455 * @var string Database attributes - character set and collation
457 protected $_databaseAttributes = ' DEFAULT CHARACTER SET utf8 COLLATE utf8_unicode_ci';
460 * SQL being run in this report.
462 * The sql in the report is stored in this variable in order to be displayed on the developer tab.
470 * An instruction not to add a Group By.
472 * This is relevant where the group by might be otherwise added after the code that determines the group by array.
474 * e.g. where stat fields are being added but other settings cause it to not be desirable to add a group by
475 * such as in pivot charts when no row header is set
479 protected $noGroupBy = FALSE;
482 * SQL being run in this report as an array.
484 * The sql in the report is stored in this variable in order to be returned to api & test calls.
492 * Tables created for the report that need removal afterwards.
494 * ['civicrm_temp_report_x' => ['temporary' => TRUE, 'name' => 'civicrm_temp_report_x']
497 protected $temporaryTables = [];
500 * Can this report use the sql mode ONLY_FULL_GROUP_BY.
503 public $optimisedForOnlyFullGroupBy = TRUE;
507 public function __construct() {
508 parent
::__construct();
510 $this->addClass('crm-report-form');
512 if ($this->_tagFilter
) {
513 $this->buildTagFilter();
515 if ($this->_exposeContactID
) {
516 if (array_key_exists('civicrm_contact', $this->_columns
)) {
517 $this->_columns
['civicrm_contact']['fields']['exposed_id'] = array(
519 'title' => ts('Contact ID'),
525 if ($this->_groupFilter
) {
526 $this->buildGroupFilter();
529 // Get all custom groups
530 $allGroups = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_CustomField', 'custom_group_id');
532 // Get the custom groupIds for which the user has VIEW permission
533 // If the user has 'access all custom data' permission, we'll leave $permCustomGroupIds empty
534 // and addCustomDataToColumns() will allow access to all custom groups.
535 $permCustomGroupIds = array();
536 if (!CRM_Core_Permission
::check('access all custom data')) {
537 $permCustomGroupIds = CRM_ACL_API
::group(CRM_Core_Permission
::VIEW
, NULL, 'civicrm_custom_group', $allGroups, NULL);
538 // do not allow custom data for reports if user doesn't have
539 // permission to access custom data.
540 if (!empty($this->_customGroupExtends
) && empty($permCustomGroupIds)) {
541 $this->_customGroupExtends
= array();
545 // merge custom data columns to _columns list, if any
546 $this->addCustomDataToColumns(TRUE, $permCustomGroupIds);
548 // add / modify display columns, filters ..etc
549 CRM_Utils_Hook
::alterReportVar('columns', $this->_columns
, $this);
551 //assign currencyColumn variable to tpl
552 $this->assign('currencyColumn', $this->_currencyColumn
);
556 * Shared pre-process function.
558 * If overriding preProcess function this should still be called.
562 public function preProcessCommon() {
563 $this->_force
= CRM_Utils_Request
::retrieve('force', 'Boolean');
565 $this->_dashBoardRowCount
= CRM_Utils_Request
::retrieve('rowCount', 'Integer');
567 $this->_section
= CRM_Utils_Request
::retrieve('section', 'Integer');
569 $this->assign('section', $this->_section
);
570 CRM_Core_Region
::instance('page-header')->add(array(
571 'markup' => sprintf('<!-- Report class: [%s] -->', htmlentities(get_class($this))),
573 if (!$this->noController
) {
574 $this->setID($this->get('instanceId'));
577 $this->setID(CRM_Report_Utils_Report
::getInstanceID());
579 $this->setID(CRM_Report_Utils_Report
::getInstanceIDForPath());
583 // set qfkey so that pager picks it up and use it in the "Next > Last >>" links.
584 // FIXME: Note setting it in $_GET doesn't work, since pager generates link based on QUERY_STRING
585 $_SERVER['QUERY_STRING'] .= "&qfKey={$this->controller->_key}";
589 $this->assign('instanceId', $this->_id
);
590 $params = array('id' => $this->_id
);
591 $this->_instanceValues
= array();
592 CRM_Core_DAO
::commonRetrieve('CRM_Report_DAO_ReportInstance',
594 $this->_instanceValues
596 if (empty($this->_instanceValues
)) {
597 CRM_Core_Error
::fatal("Report could not be loaded.");
599 $this->_title
= $this->_instanceValues
['title'];
600 if (!empty($this->_instanceValues
['permission']) &&
601 (!(CRM_Core_Permission
::check($this->_instanceValues
['permission']) ||
602 CRM_Core_Permission
::check('administer Reports')
605 CRM_Utils_System
::permissionDenied();
606 CRM_Utils_System
::civiExit();
609 $formValues = CRM_Utils_Array
::value('form_values', $this->_instanceValues
);
611 $this->_formValues
= unserialize($formValues);
614 $this->_formValues
= NULL;
617 $this->setOutputMode();
619 if ($this->_outputMode
== 'copy') {
620 $this->_createNew
= TRUE;
621 $this->_params
= $this->_formValues
;
622 $this->_params
['view_mode'] = 'criteria';
623 $this->_params
['title'] = $this->getTitle() . ts(' (copy created by %1 on %2)', array(
624 CRM_Core_Session
::singleton()->getLoggedInContactDisplayName(),
625 CRM_Utils_Date
::customFormat(date('Y-m-d H:i')),
627 // Do not pass go. Do not collect another chance to re-run the same query.
628 CRM_Report_Form_Instance
::postProcess($this);
631 // lets always do a force if reset is found in the url.
632 // Hey why not? see CRM-17225 for more about this. The use of reset to be force is historical for reasons stated
633 // in the comment line above these 2.
634 if (!empty($_REQUEST['reset'])
635 && !in_array(CRM_Utils_Request
::retrieve('output', 'String'), array('save', 'criteria'))) {
640 $this->assign('mode', 'instance');
642 elseif (!$this->noController
) {
643 list($optionValueID, $optionValue) = CRM_Report_Utils_Report
::getValueIDFromUrl();
644 $instanceCount = CRM_Report_Utils_Report
::getInstanceCount($optionValue);
645 if (($instanceCount > 0) && $optionValueID) {
646 $this->assign('instanceUrl',
647 CRM_Utils_System
::url('civicrm/report/list',
648 "reset=1&ovid=$optionValueID"
652 if ($optionValueID) {
653 $this->_description
= CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionValue', $optionValueID, 'description');
657 $this->assign('mode', 'template');
660 // lets display the Report Settings section
661 $this->_instanceForm
= $this->_force ||
$this->_id ||
(!empty($_POST));
663 // Do not display Report Settings section if administer Reports permission is absent OR
664 // if report instance is reserved and administer reserved reports absent
665 if (!CRM_Core_Permission
::check('administer Reports') ||
666 ($this->_instanceValues
['is_reserved'] &&
667 !CRM_Core_Permission
::check('administer reserved reports'))
669 $this->_instanceForm
= FALSE;
672 $this->assign('criteriaForm', FALSE);
673 // Display Report Criteria section if user has access Report Criteria OR administer Reports AND report instance is not reserved
674 if (CRM_Core_Permission
::check('administer Reports') ||
675 CRM_Core_Permission
::check('access Report Criteria')
677 if (!$this->_instanceValues
['is_reserved'] ||
678 CRM_Core_Permission
::check('administer reserved reports')
680 $this->assign('criteriaForm', TRUE);
681 $this->_criteriaForm
= TRUE;
685 // Special permissions check for private instance if it's not the current contact instance
687 (CRM_Report_BAO_ReportInstance
::reportIsPrivate($this->_id
) &&
688 !CRM_Report_BAO_ReportInstance
::contactIsOwner($this->_id
))) {
689 if (!CRM_Core_Permission
::check('access all private reports')) {
690 $this->_instanceForm
= FALSE;
691 $this->assign('criteriaForm', FALSE);
695 $this->_instanceButtonName
= $this->getButtonName('submit', 'save');
696 $this->_createNewButtonName
= $this->getButtonName('submit', 'next');
697 $this->_groupButtonName
= $this->getButtonName('submit', 'group');
698 $this->_chartButtonName
= $this->getButtonName('submit', 'chart');
704 public function addBreadCrumb() {
708 'title' => ts('Report Templates'),
709 'url' => CRM_Utils_System
::url('civicrm/admin/report/template/list', 'reset=1'),
713 CRM_Utils_System
::appendBreadCrumb($breadCrumbs);
717 * Pre process function.
719 * Called prior to build form.
721 public function preProcess() {
722 $this->preProcessCommon();
725 $this->addBreadCrumb();
728 foreach ($this->_columns
as $tableName => $table) {
729 $this->setTableAlias($table, $tableName);
731 $expFields = array();
732 // higher preference to bao object
733 $daoOrBaoName = CRM_Utils_Array
::value('bao', $table, CRM_Utils_Array
::value('dao', $table));
736 if (method_exists($daoOrBaoName, 'exportableFields')) {
737 $expFields = $daoOrBaoName::exportableFields();
740 $expFields = $daoOrBaoName::export();
744 $doNotCopy = array('required', 'default');
746 $fieldGroups = array('fields', 'filters', 'group_bys', 'order_bys');
747 foreach ($fieldGroups as $fieldGrp) {
748 if (!empty($table[$fieldGrp]) && is_array($table[$fieldGrp])) {
749 foreach ($table[$fieldGrp] as $fieldName => $field) {
750 // $name is the field name used to reference the BAO/DAO export fields array
751 $name = isset($field['name']) ?
$field['name'] : $fieldName;
753 // Sometimes the field name key in the BAO/DAO export fields array is
754 // different from the actual database field name.
755 // Unset $field['name'] so that actual database field name can be obtained
756 // from the BAO/DAO export fields array.
757 unset($field['name']);
759 if (array_key_exists($name, $expFields)) {
760 foreach ($doNotCopy as $dnc) {
761 // unset the values we don't want to be copied.
762 unset($expFields[$name][$dnc]);
765 $this->_columns
[$tableName][$fieldGrp][$fieldName] = $expFields[$name];
768 foreach ($expFields[$name] as $property => $val) {
769 if (!array_key_exists($property, $field)) {
770 $this->_columns
[$tableName][$fieldGrp][$fieldName][$property] = $val;
777 if (!empty($field['no_repeat'])) {
778 $this->_noRepeats
[] = "{$tableName}_{$fieldName}";
780 if (!empty($field['no_display'])) {
781 $this->_noDisplay
[] = "{$tableName}_{$fieldName}";
784 // set alias = table-name, unless already set
785 $alias = isset($field['alias']) ?
$field['alias'] : (
786 isset($this->_columns
[$tableName]['alias']) ?
$this->_columns
[$tableName]['alias'] : $tableName
788 $this->_columns
[$tableName][$fieldGrp][$fieldName]['alias'] = $alias;
790 // set name = fieldName, unless already set
791 if (!isset($this->_columns
[$tableName][$fieldGrp][$fieldName]['name'])) {
792 $this->_columns
[$tableName][$fieldGrp][$fieldName]['name'] = $name;
795 if (!isset($this->_columns
[$tableName][$fieldGrp][$fieldName]['table_name'])) {
796 $this->_columns
[$tableName][$fieldGrp][$fieldName]['table_name'] = $tableName;
799 // set dbAlias = alias.name, unless already set
800 if (!isset($this->_columns
[$tableName][$fieldGrp][$fieldName]['dbAlias'])) {
801 $this->_columns
[$tableName][$fieldGrp][$fieldName]['dbAlias']
803 $this->_columns
[$tableName][$fieldGrp][$fieldName]['name'];
806 // a few auto fills for filters
807 if ($fieldGrp == 'filters') {
808 // fill operator types
809 if (!array_key_exists('operatorType', $this->_columns
[$tableName][$fieldGrp][$fieldName])) {
810 switch (CRM_Utils_Array
::value('type', $this->_columns
[$tableName][$fieldGrp][$fieldName])) {
811 case CRM_Utils_Type
::T_MONEY
:
812 case CRM_Utils_Type
::T_FLOAT
:
813 $this->_columns
[$tableName][$fieldGrp][$fieldName]['operatorType'] = CRM_Report_Form
::OP_FLOAT
;
816 case CRM_Utils_Type
::T_INT
:
817 $this->_columns
[$tableName][$fieldGrp][$fieldName]['operatorType'] = CRM_Report_Form
::OP_INT
;
820 case CRM_Utils_Type
::T_DATE
:
821 $this->_columns
[$tableName][$fieldGrp][$fieldName]['operatorType'] = CRM_Report_Form
::OP_DATE
;
824 case CRM_Utils_Type
::T_BOOLEAN
:
825 $this->_columns
[$tableName][$fieldGrp][$fieldName]['operatorType'] = CRM_Report_Form
::OP_SELECT
;
826 if (!array_key_exists('options', $this->_columns
[$tableName][$fieldGrp][$fieldName])) {
827 $this->_columns
[$tableName][$fieldGrp][$fieldName]['options']
838 array_key_exists('pseudoconstant', $this->_columns
[$tableName][$fieldGrp][$fieldName])
840 // with multiple options operator-type is generally multi-select
841 $this->_columns
[$tableName][$fieldGrp][$fieldName]['operatorType'] = CRM_Report_Form
::OP_MULTISELECT
;
842 if (!array_key_exists('options', $this->_columns
[$tableName][$fieldGrp][$fieldName])) {
844 $this->_columns
[$tableName][$fieldGrp][$fieldName]['options'] = CRM_Core_PseudoConstant
::get($daoOrBaoName, $fieldName);
851 if (!isset($this->_columns
[$tableName]['metadata'][$fieldName])) {
852 $this->_columns
[$tableName]['metadata'][$fieldName] = $this->_columns
[$tableName][$fieldGrp][$fieldName];
855 $this->_columns
[$tableName]['metadata'][$fieldName] = array_merge($this->_columns
[$tableName][$fieldGrp][$fieldName], $this->_columns
[$tableName]['metadata'][$fieldName]);
861 // copy filters to a separate handy variable
862 if (array_key_exists('filters', $table)) {
863 $this->_filters
[$tableName] = $this->_columns
[$tableName]['filters'];
866 if (array_key_exists('group_bys', $table)) {
867 $groupBys[$tableName] = $this->_columns
[$tableName]['group_bys'];
870 if (array_key_exists('fields', $table)) {
871 $reportFields[$tableName] = $this->_columns
[$tableName]['fields'];
876 $this->setDefaultValues(FALSE);
879 CRM_Report_Utils_Get
::processFilter($this->_filters
, $this->_defaults
);
880 CRM_Report_Utils_Get
::processGroupBy($groupBys, $this->_defaults
);
881 CRM_Report_Utils_Get
::processFields($reportFields, $this->_defaults
);
882 CRM_Report_Utils_Get
::processChart($this->_defaults
);
885 $this->_formValues
= $this->_defaults
;
886 $this->postProcess();
891 * Set default values.
893 * @param bool $freeze
897 public function setDefaultValues($freeze = TRUE) {
898 $freezeGroup = array();
900 // FIXME: generalizing form field naming conventions would reduce
901 // Lots of lines below.
902 foreach ($this->_columns
as $tableName => $table) {
903 if (array_key_exists('fields', $table)) {
904 foreach ($table['fields'] as $fieldName => $field) {
905 if (empty($field['no_display'])) {
906 if (!empty($field['required'])) {
908 $this->_defaults
['fields'][$fieldName] = 1;
911 // find element object, so that we could use quickform's freeze method
912 // for required elements
913 $obj = $this->getElementFromGroup("fields", $fieldName);
915 $freezeGroup[] = $obj;
919 elseif (isset($field['default'])) {
920 $this->_defaults
['fields'][$fieldName] = $field['default'];
926 if (array_key_exists('group_bys', $table)) {
927 foreach ($table['group_bys'] as $fieldName => $field) {
928 if (isset($field['default'])) {
929 if (!empty($field['frequency'])) {
930 $this->_defaults
['group_bys_freq'][$fieldName] = 'MONTH';
932 $this->_defaults
['group_bys'][$fieldName] = $field['default'];
936 if (array_key_exists('filters', $table)) {
937 foreach ($table['filters'] as $fieldName => $field) {
938 if (isset($field['default'])) {
939 if (CRM_Utils_Array
::value('type', $field) & CRM_Utils_Type
::T_DATE
941 if (is_array($field['default'])) {
942 $this->_defaults
["{$fieldName}_from"] = CRM_Utils_Array
::value('from', $field['default']);
943 $this->_defaults
["{$fieldName}_to"] = CRM_Utils_Array
::value('to', $field['default']);
944 $this->_defaults
["{$fieldName}_relative"] = 0;
947 $this->_defaults
["{$fieldName}_relative"] = $field['default'];
951 if ((CRM_Utils_Array
::value('type', $field) & CRM_Utils_Type
::T_INT
) && is_array($field['default'])) {
952 $this->_defaults
["{$fieldName}_min"] = CRM_Utils_Array
::value('min', $field['default']);
953 $this->_defaults
["{$fieldName}_max"] = CRM_Utils_Array
::value('max', $field['default']);
955 $this->_defaults
["{$fieldName}_value"] = $field['default'];
958 //assign default value as "in" for multiselect
959 //operator, To freeze the select element
960 if (CRM_Utils_Array
::value('operatorType', $field) ==
961 CRM_Report_Form
::OP_MULTISELECT
963 $this->_defaults
["{$fieldName}_op"] = 'in';
965 if (CRM_Utils_Array
::value('operatorType', $field) ==
966 CRM_Report_Form
::OP_ENTITYREF
968 $this->_defaults
["{$fieldName}_op"] = 'in';
970 elseif (CRM_Utils_Array
::value('operatorType', $field) ==
971 CRM_Report_Form
::OP_MULTISELECT_SEPARATOR
973 $this->_defaults
["{$fieldName}_op"] = 'mhas';
975 elseif ($op = CRM_Utils_Array
::value('default_op', $field)) {
976 $this->_defaults
["{$fieldName}_op"] = $op;
982 empty($this->_formValues
['order_bys']) &&
983 (array_key_exists('order_bys', $table) &&
984 is_array($table['order_bys']))
986 if (!array_key_exists('order_bys', $this->_defaults
)) {
987 $this->_defaults
['order_bys'] = array();
989 foreach ($table['order_bys'] as $fieldName => $field) {
990 if (!empty($field['default']) ||
!empty($field['default_order']) ||
991 CRM_Utils_Array
::value('default_is_section', $field) ||
992 !empty($field['default_weight'])
995 'column' => $fieldName,
996 'order' => CRM_Utils_Array
::value('default_order', $field, 'ASC'),
997 'section' => CRM_Utils_Array
::value('default_is_section', $field, 0),
1000 if (!empty($field['default_weight'])) {
1001 $this->_defaults
['order_bys'][(int) $field['default_weight']] = $order_by;
1004 array_unshift($this->_defaults
['order_bys'], $order_by);
1010 foreach ($this->_options
as $fieldName => $field) {
1011 if (isset($field['default'])) {
1012 $this->_defaults
['options'][$fieldName] = $field['default'];
1017 if (!empty($this->_submitValues
)) {
1018 $this->preProcessOrderBy($this->_submitValues
);
1021 $this->preProcessOrderBy($this->_defaults
);
1024 // lets finish freezing task here itself
1025 if (!empty($freezeGroup)) {
1026 foreach ($freezeGroup as $elem) {
1031 if ($this->_formValues
) {
1032 $this->_defaults
= array_merge($this->_defaults
, $this->_formValues
);
1035 if ($this->_instanceValues
) {
1036 $this->_defaults
= array_merge($this->_defaults
, $this->_instanceValues
);
1039 CRM_Report_Form_Instance
::setDefaultValues($this, $this->_defaults
);
1041 return $this->_defaults
;
1045 * Get element from group.
1047 * @param string $group
1048 * @param string $grpFieldName
1052 public function getElementFromGroup($group, $grpFieldName) {
1053 $eleObj = $this->getElement($group);
1054 foreach ($eleObj->_elements
as $index => $obj) {
1055 if ($grpFieldName == $obj->_attributes
['name']) {
1063 * Setter for $_params.
1065 * @param array $params
1067 public function setParams($params) {
1068 $this->_params
= $params;
1072 * Getter for $_params.
1074 * @return void|array $params
1076 public function getParams() {
1077 return $this->_params
;
1083 * @param int $instanceID
1085 public function setID($instanceID) {
1086 $this->_id
= $instanceID;
1090 * Setter for $_force.
1092 * @param bool $isForce
1094 public function setForce($isForce) {
1095 $this->_force
= $isForce;
1099 * Setter for $_limitValue.
1101 * @param int $_limitValue
1103 public function setLimitValue($_limitValue) {
1104 $this->_limitValue
= $_limitValue;
1108 * Setter for $_offsetValue.
1110 * @param int $_offsetValue
1112 public function setOffsetValue($_offsetValue) {
1113 $this->_offsetValue
= $_offsetValue;
1117 * Setter for $addPaging.
1119 * @param bool $value
1121 public function setAddPaging($value) {
1122 $this->addPaging
= $value;
1126 * Getter for $_defaultValues.
1130 public function getDefaultValues() {
1131 return $this->_defaults
;
1135 * Remove any temporary tables.
1137 public function cleanUpTemporaryTables() {
1138 foreach ($this->temporaryTables
as $temporaryTable) {
1139 CRM_Core_DAO
::executeQuery('DROP ' . ($temporaryTable['temporary'] ?
'TEMPORARY' : '') . ' TABLE IF EXISTS ' . $temporaryTable['name']);
1144 * Create a temporary table.
1146 * This function creates a table AND adds the details to the developer tab & $this->>temporary tables.
1148 * @param string $identifier
1149 * This is the key that will be used for the table in the temporaryTables property.
1150 * @param string $sql
1151 * Sql select statement or column description (the latter requires the columns flag)
1152 * @param bool $isColumns
1153 * Is the sql describing columns to create (rather than using a select query).
1154 * @param bool $isMemory
1155 * Create a memory table rather than a normal INNODB table.
1159 public function createTemporaryTable($identifier, $sql, $isColumns = FALSE, $isMemory = FALSE) {
1160 $tempTable = CRM_Utils_SQL_TempTable
::build()->setUtf8();
1162 $tempTable->setMemory();
1165 $tempTable->createWithColumns($sql);
1168 $tempTable->createWithQuery($sql);
1170 $name = $tempTable->getName();
1171 // Developers may force tables to be durable to assist in debugging so lets check.
1172 $isNotTrueTemporary = $tempTable->isDurable();
1173 $this->addToDeveloperTab($tempTable->getCreateSql());
1174 $this->temporaryTables
[$identifier] = ['temporary' => !$isNotTrueTemporary, 'name' => $name];
1179 * Add columns to report.
1181 public function addColumns() {
1184 foreach ($this->_columns
as $tableName => $table) {
1185 if (array_key_exists('fields', $table)) {
1186 foreach ($table['fields'] as $fieldName => $field) {
1188 if (empty($field['no_display'])) {
1189 foreach (array('table', 'field') as $var) {
1190 if (!empty($
{$var}['grouping'])) {
1191 if (!is_array($
{$var}['grouping'])) {
1192 $tableName = $
{$var}['grouping'];
1195 $tableName = array_keys($
{$var}['grouping']);
1196 $tableName = $tableName[0];
1197 $groupTitle = array_values($
{$var}['grouping']);
1198 $groupTitle = $groupTitle[0];
1203 if (!$groupTitle && isset($table['group_title'])) {
1204 $groupTitle = $table['group_title'];
1205 // Having a group_title is secret code for being a custom group
1206 // which cryptically translates to needing an accordion.
1207 // here we make that explicit.
1208 $colGroups[$tableName]['use_accordian_for_field_selection'] = TRUE;
1211 $colGroups[$tableName]['fields'][$fieldName] = CRM_Utils_Array
::value('title', $field);
1212 if ($groupTitle && empty($colGroups[$tableName]['group_title'])) {
1213 $colGroups[$tableName]['group_title'] = $groupTitle;
1215 $options[$fieldName] = CRM_Utils_Array
::value('title', $field);
1221 $this->addCheckBox("fields", ts('Select Columns'), $options, NULL,
1222 NULL, NULL, NULL, $this->_fourColumnAttribute
, TRUE
1224 if (!empty($colGroups)) {
1225 $this->tabs
['FieldSelection'] = array(
1226 'title' => ts('Columns'),
1227 'tpl' => 'FieldSelection',
1228 'div_label' => 'col-groups',
1231 // Note this assignment is only really required in buildForm. It is being 'over-called'
1232 // to reduce risk of being missed due to overridden functions.
1233 $this->assign('tabs', $this->tabs
);
1236 $this->assign('colGroups', $colGroups);
1240 * Add filters to report.
1242 public function addFilters() {
1243 $filters = $filterGroups = array();
1246 foreach ($this->_filters
as $table => $attributes) {
1247 if (isset($this->_columns
[$table]['group_title'])) {
1248 // The presence of 'group_title' is secret code for 'is_a_custom_table'
1249 // which magically means to 'display in an accordian'
1250 // here we make this explicit.
1251 $filterGroups[$table] = array(
1252 'group_title' => $this->_columns
[$table]['group_title'],
1253 'use_accordian_for_field_selection' => TRUE,
1257 foreach ($attributes as $fieldName => $field) {
1258 // get ready with option value pair
1259 // @ 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
1261 $operations = $this->getOperationPair(
1262 CRM_Utils_Array
::value('operatorType', $field),
1265 $filters[$table][$fieldName] = $field;
1267 switch (CRM_Utils_Array
::value('operatorType', $field)) {
1268 case CRM_Report_Form
::OP_MONTH
:
1269 if (!array_key_exists('options', $field) ||
1270 !is_array($field['options']) ||
empty($field['options'])
1272 // If there's no option list for this filter, define one.
1273 $field['options'] = array(
1275 2 => ts('February'),
1282 9 => ts('September'),
1283 10 => ts('October'),
1284 11 => ts('November'),
1285 12 => ts('December'),
1287 // Add this option list to this column _columns. This is
1288 // required so that filter statistics show properly.
1289 $this->_columns
[$table]['filters'][$fieldName]['options'] = $field['options'];
1291 case CRM_Report_Form
::OP_MULTISELECT
:
1292 case CRM_Report_Form
::OP_MULTISELECT_SEPARATOR
:
1293 // assume a multi-select field
1294 if (!empty($field['options']) ||
1295 $fieldName == 'state_province_id' ||
$fieldName == 'county_id'
1297 $element = $this->addElement('select', "{$fieldName}_op", ts('Operator:'), $operations);
1298 if (count($operations) <= 1) {
1301 if ($fieldName == 'state_province_id' ||
1302 $fieldName == 'county_id'
1304 $this->addChainSelect($fieldName . '_value', array(
1311 $this->addElement('select', "{$fieldName}_value", NULL, $field['options'], array(
1312 'style' => 'min-width:250px',
1313 'class' => 'crm-select2 huge',
1315 'placeholder' => ts('- select -'),
1321 case CRM_Report_Form
::OP_SELECT
:
1322 // assume a select field
1323 $this->addElement('select', "{$fieldName}_op", ts('Operator:'), $operations);
1324 if (!empty($field['options'])) {
1325 $this->addElement('select', "{$fieldName}_value", NULL, $field['options']);
1329 case CRM_Report_Form
::OP_ENTITYREF
:
1330 $this->addElement('select', "{$fieldName}_op", ts('Operator:'), $operations);
1331 $this->setEntityRefDefaults($field, $table);
1332 $this->addEntityRef("{$fieldName}_value", NULL, $field['attributes']);
1335 case CRM_Report_Form
::OP_DATE
:
1336 // build datetime fields
1337 CRM_Core_Form_Date
::buildDateRange($this, $fieldName, $count, '_from', '_to', ts('From:'), FALSE, $operations);
1341 case CRM_Report_Form
::OP_DATETIME
:
1342 // build datetime fields
1343 CRM_Core_Form_Date
::buildDateRange($this, $fieldName, $count, '_from', '_to', ts('From:'), FALSE, $operations, 'searchDate', TRUE);
1347 case CRM_Report_Form
::OP_INT
:
1348 case CRM_Report_Form
::OP_FLOAT
:
1349 // and a min value input box
1350 $this->add('text', "{$fieldName}_min", ts('Min'));
1351 // and a max value input box
1352 $this->add('text', "{$fieldName}_max", ts('Max'));
1354 // default type is string
1355 $this->addElement('select', "{$fieldName}_op", ts('Operator:'), $operations,
1356 array('onchange' => "return showHideMaxMinVal( '$fieldName', this.value );")
1358 // we need text box for value input
1359 $this->add('text', "{$fieldName}_value", NULL, array('class' => 'huge'));
1364 if (!empty($filters)) {
1365 $this->tabs
['Filters'] = array(
1366 'title' => ts('Filters'),
1368 'div_label' => 'set-filters',
1371 $this->assign('filters', $filters);
1372 $this->assign('filterGroups', $filterGroups);
1376 * Function to assign the tabs to the template in the correct order.
1378 * We want the tabs to wind up in this order (if not overridden).
1386 protected function assignTabs() {
1394 $order = array_intersect_key(array_fill_keys($order, 1), $this->tabs
);
1395 $order = array_merge($order, $this->tabs
);
1396 $this->assign('tabs', $order);
1400 * The intent is to add a tab for developers to view the sql.
1402 * Currently using dpm.
1404 * @param string $sql
1406 public function addToDeveloperTab($sql) {
1407 if (!CRM_Core_Permission
::check('view report sql')) {
1410 $ignored_output_modes = array('pdf', 'csv', 'print');
1411 if (in_array($this->_outputMode
, $ignored_output_modes)) {
1414 $this->tabs
['Developer'] = array(
1415 'title' => ts('Developer'),
1416 'tpl' => 'Developer',
1417 'div_label' => 'set-developer',
1420 $this->assignTabs();
1421 $this->sqlArray
[] = $sql;
1422 foreach ($this->sqlArray
as $sql) {
1423 foreach (array('LEFT JOIN') as $term) {
1424 $sql = str_replace($term, '<br> ' . $term, $sql);
1426 foreach (array('FROM', 'WHERE', 'GROUP BY', 'ORDER BY', 'LIMIT', ';') as $term) {
1427 $sql = str_replace($term, '<br><br>' . $term, $sql);
1429 $this->sqlFormattedArray
[] = $sql;
1430 $this->assign('sql', implode(';<br><br><br><br>', $this->sqlFormattedArray
));
1432 $this->assign('sqlModes', $sqlModes = CRM_Utils_SQL
::getSqlModes());
1437 * Add options defined in $this->_options to the report.
1439 public function addOptions() {
1440 if (!empty($this->_options
)) {
1441 // FIXME: For now lets build all elements as checkboxes.
1442 // Once we clear with the format we can build elements based on type
1444 foreach ($this->_options
as $fieldName => $field) {
1447 if ($field['type'] == 'select') {
1448 $this->addElement('select', "{$fieldName}", $field['title'], $field['options']);
1450 elseif ($field['type'] == 'checkbox') {
1451 $options[$field['title']] = $fieldName;
1452 $this->addCheckBox($fieldName, NULL,
1454 NULL, NULL, NULL, $this->_fourColumnAttribute
1459 if (!empty($this->_options
) &&
1461 ||
($this->_id
&& CRM_Report_BAO_ReportInstance
::contactCanAdministerReport($this->_id
)))
1463 $this->tabs
['ReportOptions'] = array(
1464 'title' => ts('Display Options'),
1465 'tpl' => 'ReportOptions',
1466 'div_label' => 'other-options',
1469 $this->assign('otherOptions', $this->_options
);
1473 * Add chart options to the report.
1475 public function addChartOptions() {
1476 if (!empty($this->_charts
)) {
1477 $this->addElement('select', "charts", ts('Chart'), $this->_charts
);
1478 $this->assign('charts', $this->_charts
);
1479 $this->addElement('submit', $this->_chartButtonName
, ts('View'));
1484 * Add group by options to the report.
1486 public function addGroupBys() {
1487 $options = $freqElements = array();
1489 foreach ($this->_columns
as $tableName => $table) {
1490 if (array_key_exists('group_bys', $table)) {
1491 foreach ($table['group_bys'] as $fieldName => $field) {
1492 if (!empty($field) && empty($field['no_display'])) {
1493 $options[$field['title']] = $fieldName;
1494 if (!empty($field['frequency'])) {
1495 $freqElements[$field['title']] = $fieldName;
1501 $this->addCheckBox("group_bys", ts('Group by columns'), $options, NULL,
1502 NULL, NULL, NULL, $this->_fourColumnAttribute
1504 $this->assign('groupByElements', $options);
1505 if (!empty($options)) {
1506 $this->tabs
['GroupBy'] = array(
1507 'title' => ts('Grouping'),
1509 'div_label' => 'group-by-elements',
1513 foreach ($freqElements as $name) {
1514 $this->addElement('select', "group_bys_freq[$name]",
1515 ts('Frequency'), $this->_groupByDateFreq
1521 * Add data for order by tab.
1523 public function addOrderBys() {
1525 foreach ($this->_columns
as $tableName => $table) {
1527 // Report developer may define any column to order by; include these as order-by options.
1528 if (array_key_exists('order_bys', $table)) {
1529 foreach ($table['order_bys'] as $fieldName => $field) {
1530 if (!empty($field)) {
1531 $options[$fieldName] = $field['title'];
1536 // Add searchable custom fields as order-by options, if so requested
1537 // (These are already indexed, so allowing to order on them is cheap.)
1539 if ($this->_autoIncludeIndexedFieldsAsOrderBys
&&
1540 array_key_exists('extends', $table) && !empty($table['extends'])
1542 foreach ($table['fields'] as $fieldName => $field) {
1543 if (empty($field['no_display'])) {
1544 $options[$fieldName] = $field['title'];
1552 $this->assign('orderByOptions', $options);
1553 if (!empty($options)) {
1554 $this->tabs
['OrderBy'] = array(
1555 'title' => ts('Sorting'),
1557 'div_label' => 'order-by-elements',
1561 if (!empty($options)) {
1563 '-' => ' - none - ',
1565 for ($i = 1; $i <= 5; $i++
) {
1566 $this->addElement('select', "order_bys[{$i}][column]", ts('Order by Column'), $options);
1567 $this->addElement('select', "order_bys[{$i}][order]", ts('Order by Order'), array(
1568 'ASC' => ts('Ascending'),
1569 'DESC' => ts('Descending'),
1571 $this->addElement('checkbox', "order_bys[{$i}][section]", ts('Order by Section'), FALSE, array('id' => "order_by_section_$i"));
1572 $this->addElement('checkbox', "order_bys[{$i}][pageBreak]", ts('Page Break'), FALSE, array('id' => "order_by_pagebreak_$i"));
1578 * This adds the tab referred to as Title and Format, rendered through Instance.tpl.
1580 * @todo call this tab into the report template in the same way as OrderBy etc, ie
1581 * by adding a description of the tab to $this->tabs, causing the tab to be added in
1584 public function buildInstanceAndButtons() {
1585 CRM_Report_Form_Instance
::buildForm($this);
1586 $this->_actionButtonName
= $this->getButtonName('submit');
1587 $this->addTaskMenu($this->getActions($this->_id
));
1589 $this->assign('instanceForm', $this->_instanceForm
);
1591 // CRM-16274 Determine if user has 'edit all contacts' or equivalent
1592 $permission = CRM_Core_Permission
::getPermission();
1593 if ($this->_instanceForm
&& $permission == CRM_Core_Permission
::EDIT
&&
1594 $this->_add2groupSupported
1596 $this->addElement('select', 'groups', ts('Group'),
1597 array('' => ts('Add Contacts to Group')) +
1598 CRM_Core_PseudoConstant
::nestedGroup(),
1599 array('class' => 'crm-select2 crm-action-menu fa-plus huge')
1601 $this->assign('group', TRUE);
1604 $this->addElement('submit', $this->_groupButtonName
, '', array('style' => 'display: none;'));
1606 $this->addChartOptions();
1607 $showResultsLabel = $this->getResultsLabel();
1608 $this->addButtons(array(
1611 'name' => $showResultsLabel,
1612 'isDefault' => TRUE,
1619 * Has this form been submitted already?
1623 public function resultsDisplayed() {
1624 $buttonName = $this->controller
->getButtonName();
1625 return ($buttonName ||
$this->_outputMode
);
1629 * Get the actions for this report instance.
1631 * @param int $instanceId
1635 protected function getActions($instanceId) {
1636 $actions = CRM_Report_BAO_ReportInstance
::getActionMetadata();
1637 if (empty($instanceId)) {
1638 $actions['report_instance.save'] = array(
1639 'title' => ts('Create Report'),
1641 'is_confirm' => TRUE,
1642 'confirm_title' => ts('Create Report'),
1643 'confirm_refresh_fields' => json_encode(array(
1644 'title' => array('selector' => '.crm-report-instanceForm-form-block-title', 'prepend' => ''),
1645 'description' => array('selector' => '.crm-report-instanceForm-form-block-description', 'prepend' => ''),
1649 unset($actions['report_instance.delete']);
1652 if (!$this->_csvSupported
) {
1653 unset($actions['report_instance.csv']);
1660 * Main build form function.
1662 public function buildQuickForm() {
1663 $this->addColumns();
1665 $this->addFilters();
1667 $this->addOptions();
1669 $this->addGroupBys();
1671 $this->addOrderBys();
1673 $this->buildInstanceAndButtons();
1675 // Add form rule for report.
1676 if (is_callable(array(
1680 $this->addFormRule(array(get_class($this), 'formRule'), $this);
1682 $this->assignTabs();
1686 * A form rule function for custom data.
1688 * The rule ensures that fields selected in group_by if any) should only be the ones
1689 * present in display/select fields criteria;
1690 * note: works if and only if any custom field selected in group_by.
1692 * @param array $fields
1693 * @param array $ignoreFields
1697 public function customDataFormRule($fields, $ignoreFields = array()) {
1699 if (!empty($this->_customGroupExtends
) && $this->_customGroupGroupBy
&&
1700 !empty($fields['group_bys'])
1702 foreach ($this->_columns
as $tableName => $table) {
1703 if ((substr($tableName, 0, 13) == 'civicrm_value' ||
1704 substr($tableName, 0, 12) == 'custom_value') &&
1705 !empty($this->_columns
[$tableName]['fields'])
1707 foreach ($this->_columns
[$tableName]['fields'] as $fieldName => $field) {
1708 if (array_key_exists($fieldName, $fields['group_bys']) &&
1709 !array_key_exists($fieldName, $fields['fields'])
1711 $errors['fields'] = "Please make sure fields selected in 'Group by Columns' section are also selected in 'Display Columns' section.";
1713 elseif (array_key_exists($fieldName, $fields['group_bys'])) {
1714 foreach ($fields['fields'] as $fld => $val) {
1715 if (!array_key_exists($fld, $fields['group_bys']) &&
1716 !in_array($fld, $ignoreFields)
1718 $errors['fields'] = "Please ensure that fields selected in 'Display Columns' are also selected in 'Group by Columns' section.";
1730 * Get operators to display on form.
1732 * Note: $fieldName param allows inheriting class to build operationPairs specific to a field.
1734 * @param string $type
1735 * @param string $fieldName
1739 public function getOperationPair($type = "string", $fieldName = NULL) {
1740 // FIXME: At some point we should move these key-val pairs
1741 // to option_group and option_value table.
1743 case CRM_Report_Form
::OP_INT
:
1744 case CRM_Report_Form
::OP_FLOAT
:
1747 'lte' => ts('Is less than or equal to'),
1748 'gte' => ts('Is greater than or equal to'),
1749 'bw' => ts('Is between'),
1750 'eq' => ts('Is equal to'),
1751 'lt' => ts('Is less than'),
1752 'gt' => ts('Is greater than'),
1753 'neq' => ts('Is not equal to'),
1754 'nbw' => ts('Is not between'),
1755 'nll' => ts('Is empty (Null)'),
1756 'nnll' => ts('Is not empty (Null)'),
1760 case CRM_Report_Form
::OP_SELECT
:
1762 'eq' => ts('Is equal to'),
1766 case CRM_Report_Form
::OP_MONTH
:
1767 case CRM_Report_Form
::OP_MULTISELECT
:
1768 case CRM_Report_Form
::OP_ENTITYREF
:
1771 'in' => ts('Is one of'),
1772 'notin' => ts('Is not one of'),
1776 case CRM_Report_Form
::OP_DATE
:
1779 'nll' => ts('Is empty (Null)'),
1780 'nnll' => ts('Is not empty (Null)'),
1784 case CRM_Report_Form
::OP_MULTISELECT_SEPARATOR
:
1785 // use this operator for the values, concatenated with separator. For e.g if
1786 // multiple options for a column is stored as ^A{val1}^A{val2}^A
1788 'mhas' => ts('Is one of'),
1789 'mnot' => ts('Is not one of'),
1796 'has' => ts('Contains'),
1797 'sw' => ts('Starts with'),
1798 'ew' => ts('Ends with'),
1799 'nhas' => ts('Does not contain'),
1800 'eq' => ts('Is equal to'),
1801 'neq' => ts('Is not equal to'),
1802 'nll' => ts('Is empty (Null)'),
1803 'nnll' => ts('Is not empty (Null)'),
1810 * Build the tag filter field to display on the filters tab.
1812 public function buildTagFilter() {
1813 $contactTags = CRM_Core_BAO_Tag
::getTags($this->_tagFilterTable
);
1814 if (!empty($contactTags)) {
1815 $this->_columns
['civicrm_tag'] = array(
1816 'dao' => 'CRM_Core_DAO_Tag',
1820 'title' => ts('Tag'),
1821 'type' => CRM_Utils_Type
::T_INT
,
1823 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
1824 'options' => $contactTags,
1832 * Adds group filters to _columns (called from _Construct).
1834 public function buildGroupFilter() {
1835 $this->_columns
['civicrm_group']['filters'] = array(
1837 'name' => 'group_id',
1838 'title' => ts('Group'),
1839 'type' => CRM_Utils_Type
::T_INT
,
1840 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
1842 'options' => CRM_Core_PseudoConstant
::nestedGroup(),
1845 if (empty($this->_columns
['civicrm_group']['dao'])) {
1846 $this->_columns
['civicrm_group']['dao'] = 'CRM_Contact_DAO_GroupContact';
1848 if (empty($this->_columns
['civicrm_group']['alias'])) {
1849 $this->_columns
['civicrm_group']['alias'] = 'cgroup';
1854 * Get SQL operator from form text version.
1856 * @param string $operator
1860 public function getSQLOperator($operator = "like") {
1861 switch ($operator) {
1894 return 'IS NOT NULL';
1903 * Generate where clause.
1905 * This can be overridden in reports for special treatment of a field
1907 * @param array $field Field specifications
1908 * @param string $op Query operator (not an exact match to sql)
1909 * @param mixed $value
1913 * @return null|string
1915 public function whereClause(&$field, $op, $value, $min, $max) {
1917 $type = CRM_Utils_Type
::typeToString(CRM_Utils_Array
::value('type', $field));
1919 // CRM-18010: Ensure type of each report filters
1921 trigger_error('Type is not defined for field ' . $field['name'], E_USER_WARNING
);
1928 if (($min !== NULL && strlen($min) > 0) ||
1929 ($max !== NULL && strlen($max) > 0)
1933 $min = CRM_Utils_Type
::escape($min, $type);
1935 $clauses[] = "( {$field['dbAlias']} >= $min )";
1938 $clauses[] = "( {$field['dbAlias']} < $min OR {$field['dbAlias']} IS NULL )";
1942 $max = CRM_Utils_Type
::escape($max, $type);
1944 $clauses[] = "( {$field['dbAlias']} <= $max )";
1947 $clauses[] = "( {$field['dbAlias']} > $max )";
1951 if (!empty($clauses)) {
1953 $clause = implode(' AND ', $clauses);
1956 $clause = '(' . implode('OR', $clauses) . ')';
1964 if ($value !== NULL && strlen($value) > 0) {
1965 $value = CRM_Utils_Type
::escape($value, $type);
1966 if (strpos($value, '%') === FALSE) {
1967 $value = "'%{$value}%'";
1970 $value = "'{$value}'";
1972 $sqlOP = $this->getSQLOperator($op);
1973 $clause = "( {$field['dbAlias']} $sqlOP $value )";
1979 if ((is_string($value) ||
is_numeric($value)) && strlen($value)) {
1980 $value = explode(',', $value);
1982 if ($value !== NULL && is_array($value) && count($value) > 0) {
1983 $sqlOP = $this->getSQLOperator($op);
1984 if (CRM_Utils_Array
::value('type', $field) ==
1985 CRM_Utils_Type
::T_STRING
1987 //cycle through selections and escape values
1988 foreach ($value as $key => $selection) {
1989 $value[$key] = CRM_Utils_Type
::escape($selection, $type);
1992 = "( {$field['dbAlias']} $sqlOP ( '" . implode("' , '", $value) .
1996 // for numerical values
1997 $clause = "{$field['dbAlias']} $sqlOP (" . implode(', ', $value) .
2000 if ($op == 'notin') {
2001 $clause = "( " . $clause . " OR {$field['dbAlias']} IS NULL )";
2004 $clause = "( " . $clause . " )";
2011 // multiple has or multiple not
2012 if ($value !== NULL && count($value) > 0) {
2013 $value = CRM_Utils_Type
::escapeAll($value, $type);
2014 $operator = $op == 'mnot' ?
'NOT' : '';
2015 $regexp = "([[:cntrl:]]|^)" . implode('([[:cntrl:]]|$)|([[:cntrl:]]|^)', (array) $value) . "([[:cntrl:]]|$)";
2016 $clause = "{$field['dbAlias']} {$operator} REGEXP '{$regexp}'";
2022 if ($value !== NULL && strlen($value) > 0) {
2023 $value = CRM_Utils_Type
::escape($value, $type);
2024 if (strpos($value, '%') === FALSE) {
2026 $value = "'{$value}%'";
2029 $value = "'%{$value}'";
2033 $value = "'{$value}'";
2035 $sqlOP = $this->getSQLOperator($op);
2036 $clause = "( {$field['dbAlias']} $sqlOP $value )";
2042 $sqlOP = $this->getSQLOperator($op);
2043 $clause = "( {$field['dbAlias']} $sqlOP )";
2049 //CRM-18457: some custom field passes value in array format against binary operator
2050 if (is_array($value) && count($value)) {
2055 if ($value !== NULL && $value !== '') {
2056 if (isset($field['clause'])) {
2057 // FIXME: we not doing escape here. Better solution is to use two
2058 // different types - data-type and filter-type
2059 $clause = $field['clause'];
2061 elseif (!is_array($value)) {
2062 $value = CRM_Utils_Type
::escape($value, $type);
2063 $sqlOP = $this->getSQLOperator($op);
2064 if ($field['type'] == CRM_Utils_Type
::T_STRING
) {
2065 $value = "'{$value}'";
2067 $clause = "( {$field['dbAlias']} $sqlOP $value )";
2073 //dev/core/544 Add report support for multiple contact subTypes
2074 if ($field['name'] == 'contact_sub_type' && $clause) {
2075 $clause = $this->whereSubtypeClause($field, $value, $op);
2077 if (!empty($field['group']) && $clause) {
2078 $clause = $this->whereGroupClause($field, $value, $op);
2080 elseif (!empty($field['tag']) && $clause) {
2081 // not using left join in query because if any contact
2082 // belongs to more than one tag, results duplicate
2084 $clause = $this->whereTagClause($field, $value, $op);
2086 elseif (!empty($field['membership_org']) && $clause) {
2087 $clause = $this->whereMembershipOrgClause($value, $op);
2089 elseif (!empty($field['membership_type']) && $clause) {
2090 $clause = $this->whereMembershipTypeClause($value, $op);
2096 * Get SQL where clause for contact subtypes
2097 * @param string $field
2098 * @param mixed $value
2099 * @param string $op SQL Operator
2103 public function whereSubtypeClause($field, $value, $op) {
2105 $subtypeFilters = count($value);
2106 for ($i = 0; $i < $subtypeFilters; $i++
) {
2107 $clause .= "{$field['dbAlias']} LIKE '%$value[$i]%'";
2108 if ($i !== ($subtypeFilters - 1)) {
2117 * Get SQL where clause for a date field.
2119 * @param string $fieldName
2120 * @param string $relative
2121 * @param string $from
2123 * @param string $type
2124 * @param string $fromTime
2125 * @param string $toTime
2127 * @return null|string
2129 public function dateClause(
2131 $relative, $from, $to, $type = NULL, $fromTime = NULL, $toTime = NULL
2134 if (in_array($relative, array_keys($this->getOperationPair(CRM_Report_Form
::OP_DATE
)))) {
2135 $sqlOP = $this->getSQLOperator($relative);
2136 return "( {$fieldName} {$sqlOP} )";
2139 list($from, $to) = $this->getFromTo($relative, $from, $to, $fromTime, $toTime);
2142 $clauses[] = "( {$fieldName} >= $from )";
2146 $clauses[] = "( {$fieldName} <= {$to} )";
2149 if (!empty($clauses)) {
2150 return implode(' AND ', $clauses);
2157 * Get values for from and to for date ranges.
2161 * @param bool $relative
2162 * @param string $from
2164 * @param string $fromTime
2165 * @param string $toTime
2169 public function getFromTo($relative, $from, $to, $fromTime = NULL, $toTime = NULL) {
2170 if (empty($toTime)) {
2171 // odd legacy behaviour to treat NULL as 'end of the day'
2172 // recommend updating reports to call CRM_Utils_Date::getFromTo
2173 //directly (default on the function is the actual default there).
2176 return CRM_Utils_Date
::getFromTo($relative, $from, $to, $fromTime, $toTime);
2180 * Alter display of rows.
2182 * Iterate through the rows retrieved via SQL and make changes for display purposes,
2183 * such as rendering contacts as links.
2185 * @param array $rows
2186 * Rows generated by SQL, with an array for each row.
2188 public function alterDisplay(&$rows) {
2192 * Alter the way in which custom data fields are displayed.
2194 * @param array $rows
2196 public function alterCustomDataDisplay(&$rows) {
2197 // custom code to alter rows having custom values
2198 if (empty($this->_customGroupExtends
)) {
2202 $customFields = array();
2203 $customFieldIds = array();
2204 foreach ($this->_params
['fields'] as $fieldAlias => $value) {
2205 if ($fieldId = CRM_Core_BAO_CustomField
::getKeyID($fieldAlias)) {
2206 $customFieldIds[$fieldAlias] = $fieldId;
2209 if (empty($customFieldIds)) {
2213 // skip for type date and ContactReference since date format is already handled
2215 SELECT cg.table_name, cf.id
2216 FROM civicrm_custom_field cf
2217 INNER JOIN civicrm_custom_group cg ON cg.id = cf.custom_group_id
2218 WHERE cg.extends IN ('" . implode("','", $this->_customGroupExtends
) . "') AND
2219 cg.is_active = 1 AND
2220 cf.is_active = 1 AND
2221 cf.is_searchable = 1 AND
2222 cf.data_type NOT IN ('ContactReference', 'Date') AND
2223 cf.id IN (" . implode(",", $customFieldIds) . ")";
2225 $dao = CRM_Core_DAO
::executeQuery($query);
2226 while ($dao->fetch()) {
2227 $customFields[$dao->table_name
. '_custom_' . $dao->id
] = $dao->id
;
2231 $entryFound = FALSE;
2232 foreach ($rows as $rowNum => $row) {
2233 foreach ($row as $tableCol => $val) {
2234 if (array_key_exists($tableCol, $customFields)) {
2235 $rows[$rowNum][$tableCol] = CRM_Core_BAO_CustomField
::displayValue($val, $customFields[$tableCol]);
2240 // skip looking further in rows, if first row itself doesn't
2241 // have the column we need
2249 * Remove duplicate rows.
2251 * @param array $rows
2253 public function removeDuplicates(&$rows) {
2254 if (empty($this->_noRepeats
)) {
2257 $checkList = array();
2259 foreach ($rows as $key => $list) {
2260 foreach ($list as $colName => $colVal) {
2261 if (array_key_exists($colName, $checkList) &&
2262 $checkList[$colName] == $colVal
2264 $rows[$key][$colName] = "";
2266 if (in_array($colName, $this->_noRepeats
)) {
2267 $checkList[$colName] = $colVal;
2274 * Fix subtotal display.
2277 * @param array $fields
2278 * @param bool $subtotal
2280 public function fixSubTotalDisplay(&$row, $fields, $subtotal = TRUE) {
2281 foreach ($row as $colName => $colVal) {
2282 if (in_array($colName, $fields)) {
2284 elseif (isset($this->_columnHeaders
[$colName])) {
2286 $row[$colName] = 'Subtotal';
2290 unset($row[$colName]);
2297 * Calculate grant total.
2299 * @param array $rows
2303 public function grandTotal(&$rows) {
2304 if (!$this->_rollup ||
count($rows) == 1) {
2308 $this->moveSummaryColumnsToTheRightHandSide();
2310 if ($this->_limit
&& count($rows) >= self
::ROW_COUNT_LIMIT
) {
2314 $this->rollupRow
= array_pop($rows);
2316 foreach ($this->_columnHeaders
as $fld => $val) {
2317 if (!in_array($fld, $this->_statFields
)) {
2318 if (!$this->_grandFlag
) {
2319 $this->rollupRow
[$fld] = ts('Grand Total');
2320 $this->_grandFlag
= TRUE;
2323 $this->rollupRow
[$fld] = "";
2328 $this->assign('grandStat', $this->rollupRow
);
2333 * Format display output.
2335 * @param array $rows
2336 * @param bool $pager
2338 public function formatDisplay(&$rows, $pager = TRUE) {
2339 // set pager based on if any limit was applied in the query.
2344 // allow building charts if any
2345 if (!empty($this->_params
['charts']) && !empty($rows)) {
2346 $this->buildChart($rows);
2347 $this->assign('chartEnabled', TRUE);
2348 $this->_chartId
= "{$this->_params['charts']}_" .
2349 ($this->_id ?
$this->_id
: substr(get_class($this), 16)) . '_' .
2351 $this->assign('chartId', $this->_chartId
);
2354 // unset columns not to be displayed.
2355 foreach ($this->_columnHeaders
as $key => $value) {
2356 if (!empty($value['no_display'])) {
2357 unset($this->_columnHeaders
[$key]);
2361 // unset columns not to be displayed.
2362 if (!empty($rows)) {
2363 foreach ($this->_noDisplay
as $noDisplayField) {
2364 foreach ($rows as $rowNum => $row) {
2365 unset($this->_columnHeaders
[$noDisplayField]);
2370 // build array of section totals
2371 $this->sectionTotals();
2373 // process grand-total row
2374 $this->grandTotal($rows);
2376 // Find alter display functions.
2377 $firstRow = reset($rows);
2379 $selectedFields = array_keys($firstRow);
2380 $alterFunctions = $alterMap = $alterSpecs = array();
2381 foreach ($this->_columns
as $tableName => $table) {
2382 if (array_key_exists('metadata', $table)) {
2383 foreach ($table['metadata'] as $field => $specs) {
2384 if (in_array($tableName . '_' . $field, $selectedFields)) {
2385 if (array_key_exists('alter_display', $specs)) {
2386 $alterFunctions[$tableName . '_' . $field] = $specs['alter_display'];
2387 $alterMap[$tableName . '_' . $field] = $field;
2388 $alterSpecs[$tableName . '_' . $field] = NULL;
2390 // Add any alters that can be intuited from the field specs.
2391 // So far only boolean but a lot more could be.
2392 if (empty($alterSpecs[$tableName . '_' . $field]) && isset($specs['type']) && $specs['type'] == CRM_Utils_Type
::T_BOOLEAN
) {
2393 $alterFunctions[$tableName . '_' . $field] = 'alterBoolean';
2394 $alterMap[$tableName . '_' . $field] = $field;
2395 $alterSpecs[$tableName . '_' . $field] = NULL;
2402 // Run the alter display functions
2403 foreach ($rows as $index => & $row) {
2404 foreach ($row as $selectedField => $value) {
2405 if (array_key_exists($selectedField, $alterFunctions)) {
2406 $rows[$index][$selectedField] = $this->{$alterFunctions[$selectedField]}($value, $row, $selectedField, $alterMap[$selectedField], $alterSpecs[$selectedField]);
2412 // use this method for formatting rows for display purpose.
2413 $this->alterDisplay($rows);
2414 CRM_Utils_Hook
::alterReportVar('rows', $rows, $this);
2416 // use this method for formatting custom rows for display purpose.
2417 $this->alterCustomDataDisplay($rows);
2423 * @param $selectedfield
2424 * @param $criteriaFieldName
2428 protected function alterStateProvinceID($value, &$row, $selectedfield, $criteriaFieldName) {
2429 $url = CRM_Utils_System
::url(CRM_Utils_System
::currentPath(), "reset=1&force=1&{$criteriaFieldName}_op=in&{$criteriaFieldName}_value={$value}", $this->_absoluteUrl
);
2430 $row[$selectedfield . '_link'] = $url;
2431 $row[$selectedfield . '_hover'] = ts("%1 for this state.", array(
2435 $states = CRM_Core_PseudoConstant
::stateProvince($value, FALSE);
2436 if (!is_array($states)) {
2444 * @param $selectedField
2445 * @param $criteriaFieldName
2449 protected function alterCountryID($value, &$row, $selectedField, $criteriaFieldName) {
2450 $url = CRM_Utils_System
::url(CRM_Utils_System
::currentPath(), "reset=1&force=1&{$criteriaFieldName}_op=in&{$criteriaFieldName}_value={$value}", $this->_absoluteUrl
);
2451 $row[$selectedField . '_link'] = $url;
2452 $row[$selectedField . '_hover'] = ts("%1 for this country.", array(
2455 $countries = CRM_Core_PseudoConstant
::country($value, FALSE);
2456 if (!is_array($countries)) {
2464 * @param $selectedfield
2465 * @param $criteriaFieldName
2469 protected function alterCountyID($value, &$row, $selectedfield, $criteriaFieldName) {
2470 $url = CRM_Utils_System
::url(CRM_Utils_System
::currentPath(), "reset=1&force=1&{$criteriaFieldName}_op=in&{$criteriaFieldName}_value={$value}", $this->_absoluteUrl
);
2471 $row[$selectedfield . '_link'] = $url;
2472 $row[$selectedfield . '_hover'] = ts("%1 for this county.", array(
2475 $counties = CRM_Core_PseudoConstant
::county($value, FALSE);
2476 if (!is_array($counties)) {
2484 * @param $selectedfield
2485 * @param $criteriaFieldName
2489 protected function alterLocationTypeID($value, &$row, $selectedfield, $criteriaFieldName) {
2490 return CRM_Core_PseudoConstant
::getLabel('CRM_Core_DAO_Address', 'location_type_id', $value);
2500 protected function alterContactID($value, &$row, $fieldname) {
2501 $nameField = substr($fieldname, 0, -2) . 'name';
2502 static $first = TRUE;
2503 static $viewContactList = FALSE;
2505 $viewContactList = CRM_Core_Permission
::check('access CiviCRM');
2508 if (!$viewContactList) {
2511 if (array_key_exists($nameField, $row)) {
2512 $row[$nameField . '_link'] = CRM_Utils_System
::url("civicrm/contact/view", 'reset=1&cid=' . $value, $this->_absoluteUrl
);
2515 $row[$fieldname . '_link'] = CRM_Utils_System
::url("civicrm/contact/view", 'reset=1&cid=' . $value, $this->_absoluteUrl
);
2525 protected function alterBoolean($value) {
2526 $options = array(0 => '', 1 => ts('Yes'));
2527 if (isset($options[$value])) {
2528 return $options[$value];
2536 * @param array $rows
2538 public function buildChart(&$rows) {
2539 // override this method for building charts.
2542 // select() method below has been added recently (v3.3), and many of the report templates might
2543 // still be having their own select() method. We should fix them as and when encountered and move
2544 // towards generalizing the select() method below.
2547 * Generate the SELECT clause and set class variable $_select.
2549 public function select() {
2550 $select = $this->_selectAliases
= array();
2551 $this->storeGroupByArray();
2553 foreach ($this->_columns
as $tableName => $table) {
2554 if (array_key_exists('fields', $table)) {
2555 foreach ($table['fields'] as $fieldName => $field) {
2556 if ($tableName == 'civicrm_address') {
2557 // deprecated, use $this->isTableSelected.
2558 $this->_addressField
= TRUE;
2560 if ($tableName == 'civicrm_email') {
2561 $this->_emailField
= TRUE;
2563 if ($tableName == 'civicrm_phone') {
2564 $this->_phoneField
= TRUE;
2567 if (!empty($field['required']) ||
2568 !empty($this->_params
['fields'][$fieldName])
2571 // 1. In many cases we want select clause to be built in slightly different way
2572 // for a particular field of a particular type.
2573 // 2. This method when used should receive params by reference and modify $this->_columnHeaders
2575 $selectClause = $this->selectClause($tableName, 'fields', $fieldName, $field);
2576 if ($selectClause) {
2577 $select[] = $selectClause;
2581 // include statistics columns only if set
2582 if (!empty($field['statistics']) && !empty($this->_groupByArray
)) {
2583 $select = $this->addStatisticsToSelect($field, $tableName, $fieldName, $select);
2587 $selectClause = $this->getSelectClauseWithGroupConcatIfNotGroupedBy($tableName, $fieldName, $field);
2588 if ($selectClause) {
2589 $select[] = $selectClause;
2592 $select = $this->addBasicFieldToSelect($tableName, $fieldName, $field, $select);
2599 // select for group bys
2600 if (array_key_exists('group_bys', $table)) {
2601 foreach ($table['group_bys'] as $fieldName => $field) {
2603 if ($tableName == 'civicrm_address') {
2604 $this->_addressField
= TRUE;
2606 if ($tableName == 'civicrm_email') {
2607 $this->_emailField
= TRUE;
2609 if ($tableName == 'civicrm_phone') {
2610 $this->_phoneField
= TRUE;
2612 // 1. In many cases we want select clause to be built in slightly different way
2613 // for a particular field of a particular type.
2614 // 2. This method when used should receive params by reference and modify $this->_columnHeaders
2616 $selectClause = $this->selectClause($tableName, 'group_bys', $fieldName, $field);
2617 if ($selectClause) {
2618 $select[] = $selectClause;
2622 if (!empty($this->_params
['group_bys']) &&
2623 !empty($this->_params
['group_bys'][$fieldName]) &&
2624 !empty($this->_params
['group_bys_freq'])
2626 switch (CRM_Utils_Array
::value($fieldName, $this->_params
['group_bys_freq'])) {
2628 $select[] = "DATE_SUB({$field['dbAlias']}, INTERVAL WEEKDAY({$field['dbAlias']}) DAY) AS {$tableName}_{$fieldName}_start";
2629 $select[] = "YEARWEEK({$field['dbAlias']}) AS {$tableName}_{$fieldName}_subtotal";
2630 $select[] = "WEEKOFYEAR({$field['dbAlias']}) AS {$tableName}_{$fieldName}_interval";
2631 $field['title'] = 'Week';
2635 $select[] = "MAKEDATE(YEAR({$field['dbAlias']}), 1) AS {$tableName}_{$fieldName}_start";
2636 $select[] = "YEAR({$field['dbAlias']}) AS {$tableName}_{$fieldName}_subtotal";
2637 $select[] = "YEAR({$field['dbAlias']}) AS {$tableName}_{$fieldName}_interval";
2638 $field['title'] = 'Year';
2642 $select[] = "DATE_SUB({$field['dbAlias']}, INTERVAL (DAYOFMONTH({$field['dbAlias']})-1) DAY) as {$tableName}_{$fieldName}_start";
2643 $select[] = "MONTH({$field['dbAlias']}) AS {$tableName}_{$fieldName}_subtotal";
2644 $select[] = "MONTHNAME({$field['dbAlias']}) AS {$tableName}_{$fieldName}_interval";
2645 $field['title'] = 'Month';
2649 $select[] = "STR_TO_DATE(CONCAT( 3 * QUARTER( {$field['dbAlias']} ) -2 , '/', '1', '/', YEAR( {$field['dbAlias']} ) ), '%m/%d/%Y') AS {$tableName}_{$fieldName}_start";
2650 $select[] = "QUARTER({$field['dbAlias']}) AS {$tableName}_{$fieldName}_subtotal";
2651 $select[] = "QUARTER({$field['dbAlias']}) AS {$tableName}_{$fieldName}_interval";
2652 $field['title'] = 'Quarter';
2655 // for graphs and charts -
2656 if (!empty($this->_params
['group_bys_freq'][$fieldName])) {
2657 $this->_interval
= $field['title'];
2658 $this->_columnHeaders
["{$tableName}_{$fieldName}_start"]['title']
2659 = $field['title'] . ' Beginning';
2660 $this->_columnHeaders
["{$tableName}_{$fieldName}_start"]['type'] = $field['type'];
2661 $this->_columnHeaders
["{$tableName}_{$fieldName}_start"]['group_by'] = $this->_params
['group_bys_freq'][$fieldName];
2663 // just to make sure these values are transferred to rows.
2664 // since we 'll need them for calculation purpose,
2665 // e.g making subtotals look nicer or graphs
2666 $this->_columnHeaders
["{$tableName}_{$fieldName}_interval"] = array('no_display' => TRUE);
2667 $this->_columnHeaders
["{$tableName}_{$fieldName}_subtotal"] = array('no_display' => TRUE);
2674 if (empty($select)) {
2675 // CRM-21412 Do not give fatal error on report when no fields selected
2679 $this->_selectClauses
= $select;
2680 $this->_select
= "SELECT " . implode(', ', $select) . " ";
2684 * Build select clause for a single field.
2686 * @param string $tableName
2687 * @param string $tableKey
2688 * @param string $fieldName
2689 * @param string $field
2693 public function selectClause(&$tableName, $tableKey, &$fieldName, &$field) {
2694 if (!empty($field['pseudofield'])) {
2695 $alias = "{$tableName}_{$fieldName}";
2696 $this->_columnHeaders
["{$tableName}_{$fieldName}"]['title'] = CRM_Utils_Array
::value('title', $field);
2697 $this->_columnHeaders
["{$tableName}_{$fieldName}"]['type'] = CRM_Utils_Array
::value('type', $field);
2698 $this->_columnHeaders
["{$tableName}_{$fieldName}"]['dbAlias'] = CRM_Utils_Array
::value('dbAlias', $field);
2699 $this->_selectAliases
[] = $alias;
2700 return ' 1 as ' . $alias;
2706 * Build where clause.
2708 public function where() {
2709 $this->storeWhereHavingClauseArray();
2711 if (empty($this->_whereClauses
)) {
2712 $this->_where
= "WHERE ( 1 ) ";
2713 $this->_having
= "";
2716 $this->_where
= "WHERE " . implode(' AND ', $this->_whereClauses
);
2719 if ($this->_aclWhere
) {
2720 $this->_where
.= " AND {$this->_aclWhere} ";
2723 if (!empty($this->_havingClauses
)) {
2724 // use this clause to construct group by clause.
2725 $this->_having
= "HAVING " . implode(' AND ', $this->_havingClauses
);
2730 * Store Where clauses into an array.
2732 * Breaking out this step makes over-riding more flexible as the clauses can be used in constructing a
2733 * temp table that may not be part of the final where clause or added
2734 * in other functions
2736 public function storeWhereHavingClauseArray() {
2737 foreach ($this->_columns
as $tableName => $table) {
2738 if (array_key_exists('filters', $table)) {
2739 foreach ($table['filters'] as $fieldName => $field) {
2740 // respect pseudofield to filter spec so fields can be marked as
2741 // not to be handled here
2742 if (!empty($field['pseudofield'])) {
2745 $clause = $this->generateFilterClause($field, $fieldName);
2747 if (!empty($clause)) {
2748 if (!empty($field['having'])) {
2749 $this->_havingClauses
[] = $clause;
2752 $this->_whereClauses
[] = $clause;
2764 public function processReportMode() {
2765 $this->setOutputMode();
2768 = CRM_Utils_Request
::retrieve(
2771 CRM_Core_DAO
::$_nullObject
2774 $this->_absoluteUrl
= FALSE;
2776 $this->assign('printOnly', FALSE);
2778 if ($this->_outputMode
== 'print' ||
2779 ($this->_sendmail
&& !$this->_outputMode
)
2781 $this->assign('printOnly', TRUE);
2783 $this->addPaging
= FALSE;
2784 $this->assign('outputMode', 'print');
2785 $this->_outputMode
= 'print';
2786 if ($this->_sendmail
) {
2787 $this->_absoluteUrl
= TRUE;
2790 elseif ($this->_outputMode
== 'pdf') {
2792 $this->addPaging
= FALSE;
2793 $this->_absoluteUrl
= TRUE;
2795 elseif ($this->_outputMode
== 'csv') {
2797 $this->_absoluteUrl
= TRUE;
2798 $this->addPaging
= FALSE;
2800 elseif ($this->_outputMode
== 'group') {
2801 $this->assign('outputMode', 'group');
2803 elseif ($this->_outputMode
== 'create_report' && $this->_criteriaForm
) {
2804 $this->assign('outputMode', 'create_report');
2806 elseif ($this->_outputMode
== 'copy' && $this->_criteriaForm
) {
2807 $this->_createNew
= TRUE;
2810 $this->assign('outputMode', $this->_outputMode
);
2811 $this->assign('printOnly', $printOnly);
2812 // Get today's date to include in printed reports
2814 $reportDate = CRM_Utils_Date
::customFormat(date('Y-m-d H:i'));
2815 $this->assign('reportDate', $reportDate);
2820 * Post Processing function for Form.
2822 * postProcessCommon should be used to set other variables from input as the api accesses that function.
2823 * This function is not accessed when the api calls the report.
2825 public function beginPostProcess() {
2826 $this->setParams($this->controller
->exportValues($this->_name
));
2827 if (empty($this->_params
) &&
2830 $this->setParams($this->_formValues
);
2833 // hack to fix params when submitted from dashboard, CRM-8532
2834 // fields array is missing because form building etc is skipped
2835 // in dashboard mode for report
2836 //@todo - this could be done in the dashboard no we have a setter
2837 if (empty($this->_params
['fields']) && !$this->_noFields
) {
2838 $this->setParams($this->_formValues
);
2841 $this->processReportMode();
2843 if ($this->_outputMode
== 'save' ||
$this->_outputMode
== 'copy') {
2844 $this->_createNew
= ($this->_outputMode
== 'copy');
2845 CRM_Report_Form_Instance
::postProcess($this);
2847 if ($this->_outputMode
== 'delete') {
2848 CRM_Report_BAO_ReportInstance
::doFormDelete($this->_id
, 'civicrm/report/list?reset=1', 'civicrm/report/list?reset=1');
2851 $this->_formValues
= $this->_params
;
2853 $this->beginPostProcessCommon();
2857 * BeginPostProcess function run in both report mode and non-report mode (api).
2859 public function beginPostProcessCommon() {
2863 * Build the report query.
2865 * @param bool $applyLimit
2869 public function buildQuery($applyLimit = TRUE) {
2870 $this->buildGroupTempTable();
2873 $this->customDataFrom();
2874 $this->buildPermissionClause();
2879 foreach ($this->unselectedOrderByColumns() as $alias => $field) {
2880 $clause = $this->getSelectClauseWithGroupConcatIfNotGroupedBy($field['table_name'], $field['name'], $field);
2882 $clause = "{$field['dbAlias']} as {$alias}";
2884 $this->_select
.= ", $clause ";
2887 if ($applyLimit && empty($this->_params
['charts'])) {
2890 CRM_Utils_Hook
::alterReportVar('sql', $this, $this);
2892 $sql = "{$this->_select} {$this->_from} {$this->_where} {$this->_groupBy} {$this->_having} {$this->_orderBy} {$this->_limit}";
2893 $this->addToDeveloperTab($sql);
2898 * Build group by clause.
2900 public function groupBy() {
2901 $this->storeGroupByArray();
2903 if (!empty($this->_groupByArray
)) {
2904 if ($this->optimisedForOnlyFullGroupBy
) {
2905 // We should probably deprecate this code path. What happens here is that
2906 // the group by is amended to reflect the select columns. This often breaks the
2907 // results. Retrofitting group strict group by onto existing report classes
2909 $this->_groupBy
= CRM_Contact_BAO_Query
::getGroupByFromSelectColumns($this->_selectClauses
, $this->_groupByArray
);
2912 $this->_groupBy
= ' GROUP BY ' . implode($this->_groupByArray
);
2918 * Build order by clause.
2920 public function orderBy() {
2921 $this->_orderBy
= "";
2922 $this->_sections
= array();
2923 $this->storeOrderByArray();
2924 if (!empty($this->_orderByArray
) && !$this->_rollup
== 'WITH ROLLUP') {
2925 $this->_orderBy
= "ORDER BY " . implode(', ', $this->_orderByArray
);
2927 $this->assign('sections', $this->_sections
);
2931 * Extract order by fields and store as an array.
2933 * In some cases other functions want to know which fields are selected for ordering by
2934 * Separating this into a separate function allows it to be called separately from constructing
2935 * the order by clause
2937 public function storeOrderByArray() {
2938 $orderBys = array();
2940 if (!empty($this->_params
['order_bys']) &&
2941 is_array($this->_params
['order_bys']) &&
2942 !empty($this->_params
['order_bys'])
2945 // Process order_bys in user-specified order
2946 foreach ($this->_params
['order_bys'] as $orderBy) {
2947 $orderByField = array();
2948 foreach ($this->_columns
as $tableName => $table) {
2949 if (array_key_exists('order_bys', $table)) {
2950 // For DAO columns defined in $this->_columns
2951 $fields = $table['order_bys'];
2953 elseif (array_key_exists('extends', $table)) {
2954 // For custom fields referenced in $this->_customGroupExtends
2955 $fields = CRM_Utils_Array
::value('fields', $table, array());
2960 if (!empty($fields) && is_array($fields)) {
2961 foreach ($fields as $fieldName => $field) {
2962 if ($fieldName == $orderBy['column']) {
2963 $orderByField = array_merge($field, $orderBy);
2964 $orderByField['tplField'] = "{$tableName}_{$fieldName}";
2971 if (!empty($orderByField)) {
2972 $this->_orderByFields
[$orderByField['tplField']] = $orderByField;
2973 if ($this->groupConcatTested
) {
2974 $orderBys[$orderByField['tplField']] = "{$orderByField['tplField']} {$orderBy['order']}";
2977 // Not sure when this is preferable to using tplField (which has
2978 // definitely been tested to work in cases then this does not.
2979 // in caution not switching unless report has been tested for
2980 // group concat functionality.
2981 $orderBys[$orderByField['tplField']] = "{$orderByField['dbAlias']} {$orderBy['order']}";
2984 // Record any section headers for assignment to the template
2985 if (!empty($orderBy['section'])) {
2986 $orderByField['pageBreak'] = CRM_Utils_Array
::value('pageBreak', $orderBy);
2987 $this->_sections
[$orderByField['tplField']] = $orderByField;
2993 $this->_orderByArray
= $orderBys;
2995 $this->assign('sections', $this->_sections
);
2999 * Determine unselected columns.
3003 public function unselectedOrderByColumns() {
3004 return array_diff_key($this->_orderByFields
, $this->getSelectColumns());
3008 * Determine unselected columns.
3012 public function unselectedSectionColumns() {
3013 if (is_array($this->_sections
)) {
3014 return array_diff_key($this->_sections
, $this->getSelectColumns());
3022 * Build output rows.
3024 * @param string $sql
3025 * @param array $rows
3027 public function buildRows($sql, &$rows) {
3028 if (!$this->optimisedForOnlyFullGroupBy
) {
3029 CRM_Core_DAO
::disableFullGroupByMode();
3031 $dao = CRM_Core_DAO
::executeQuery($sql);
3032 if (stristr($this->_select
, 'SQL_CALC_FOUND_ROWS')) {
3033 $this->_rowsFound
= CRM_Core_DAO
::singleValueQuery('SELECT FOUND_ROWS()');
3035 CRM_Core_DAO
::reenableFullGroupByMode();
3036 if (!is_array($rows)) {
3040 // use this method to modify $this->_columnHeaders
3041 $this->modifyColumnHeaders();
3043 $unselectedSectionColumns = $this->unselectedSectionColumns();
3045 while ($dao->fetch()) {
3047 foreach ($this->_columnHeaders
as $key => $value) {
3048 if (property_exists($dao, $key)) {
3049 $row[$key] = $dao->$key;
3053 // section headers not selected for display need to be added to row
3054 foreach ($unselectedSectionColumns as $key => $values) {
3055 if (property_exists($dao, $key)) {
3056 $row[$key] = $dao->$key;
3065 * Calculate section totals.
3067 * When "order by" fields are marked as sections, this assigns to the template
3068 * an array of total counts for each section. This data is used by the Smarty
3069 * plugin {sectionTotal}.
3071 public function sectionTotals() {
3073 // Reports using order_bys with sections must populate $this->_selectAliases in select() method.
3074 if (empty($this->_selectAliases
)) {
3078 if (!empty($this->_sections
)) {
3079 // build the query with no LIMIT clause
3080 $select = str_ireplace('SELECT SQL_CALC_FOUND_ROWS ', 'SELECT ', $this->_select
);
3081 $sql = "{$select} {$this->_from} {$this->_where} {$this->_groupBy} {$this->_having} {$this->_orderBy}";
3083 // pull section aliases out of $this->_sections
3084 $sectionAliases = array_keys($this->_sections
);
3087 foreach (array_merge($sectionAliases, $this->_selectAliases
) as $alias) {
3088 $ifnulls[] = "ifnull($alias, '') as $alias";
3090 $this->_select
= "SELECT " . implode(", ", $ifnulls);
3091 $this->_select
= CRM_Contact_BAO_Query
::appendAnyValueToSelect($ifnulls, $sectionAliases);
3093 // Group (un-limited) report by all aliases and get counts. This might
3094 // be done more efficiently when the contents of $sql are known, ie. by
3095 // overriding this method in the report class.
3097 $query = $this->_select
.
3098 ", count(*) as ct from ($sql) as subquery group by " .
3099 implode(", ", $sectionAliases);
3101 // initialize array of total counts
3103 $dao = CRM_Core_DAO
::executeQuery($query);
3104 while ($dao->fetch()) {
3106 // let $this->_alterDisplay translate any integer ids to human-readable values.
3107 $rows[0] = $dao->toArray();
3108 $this->alterDisplay($rows);
3111 // add totals for all permutations of section values
3114 $aliasCount = count($sectionAliases);
3115 foreach ($sectionAliases as $alias) {
3116 $values[] = $row[$alias];
3117 $key = implode(CRM_Core_DAO
::VALUE_SEPARATOR
, $values);
3118 if ($i == $aliasCount) {
3119 // the last alias is the lowest-level section header; use count as-is
3120 $totals[$key] = $dao->ct
;
3123 // other aliases are higher level; roll count into their total
3124 $totals[$key] +
= $dao->ct
;
3128 $this->assign('sectionTotals', $totals);
3133 * Modify column headers.
3135 public function modifyColumnHeaders() {
3136 // use this method to modify $this->_columnHeaders
3140 * Move totals columns to the right edge of the table.
3142 * It seems like a more logical layout to have any totals columns on the far right regardless of
3143 * the location of the rest of their table.
3145 public function moveSummaryColumnsToTheRightHandSide() {
3146 $statHeaders = (array_intersect_key($this->_columnHeaders
, array_flip($this->_statFields
)));
3147 $this->_columnHeaders
= array_merge(array_diff_key($this->_columnHeaders
, $statHeaders), $this->_columnHeaders
, $statHeaders);
3151 * Assign rows to the template.
3153 * @param array $rows
3155 public function doTemplateAssignment(&$rows) {
3156 $this->assign_by_ref('columnHeaders', $this->_columnHeaders
);
3157 $this->assign_by_ref('rows', $rows);
3158 $this->assign('statistics', $this->statistics($rows));
3162 * Build report statistics.
3164 * Override this method to build your own statistics.
3166 * @param array $rows
3170 public function statistics(&$rows) {
3171 $statistics = array();
3173 $count = count($rows);
3174 // Why do we increment the count for rollup seems to artificially inflate the count.
3175 // It seems perhaps intentional to include the summary row in the count of results - although
3176 // this just seems odd.
3177 if ($this->_rollup
&& ($this->_rollup
!= '') && $this->_grandFlag
) {
3181 $this->countStat($statistics, $count);
3183 $this->groupByStat($statistics);
3185 $this->filterStat($statistics);
3191 * Add count statistics.
3193 * @param array $statistics
3196 public function countStat(&$statistics, $count) {
3197 $statistics['counts']['rowCount'] = array(
3198 'title' => ts('Row(s) Listed'),
3202 if ($this->_rowsFound
&& ($this->_rowsFound
> $count)) {
3203 $statistics['counts']['rowsFound'] = array(
3204 'title' => ts('Total Row(s)'),
3205 'value' => $this->_rowsFound
,
3211 * Add group by statistics.
3213 * @param array $statistics
3215 public function groupByStat(&$statistics) {
3216 if (!empty($this->_params
['group_bys']) &&
3217 is_array($this->_params
['group_bys']) &&
3218 !empty($this->_params
['group_bys'])
3220 foreach ($this->_columns
as $tableName => $table) {
3221 if (array_key_exists('group_bys', $table)) {
3222 foreach ($table['group_bys'] as $fieldName => $field) {
3223 if (!empty($this->_params
['group_bys'][$fieldName])) {
3224 $combinations[] = $field['title'];
3229 $statistics['groups'][] = array(
3230 'title' => ts('Grouping(s)'),
3231 'value' => implode(' & ', $combinations),
3237 * Filter statistics.
3239 * @param array $statistics
3241 public function filterStat(&$statistics) {
3242 foreach ($this->_columns
as $tableName => $table) {
3243 if (array_key_exists('filters', $table)) {
3244 foreach ($table['filters'] as $fieldName => $field) {
3245 if ((CRM_Utils_Array
::value('type', $field) & CRM_Utils_Type
::T_DATE ||
3246 CRM_Utils_Array
::value('type', $field) & CRM_Utils_Type
::T_TIME
) &&
3247 CRM_Utils_Array
::value('operatorType', $field) !=
3248 CRM_Report_Form
::OP_MONTH
3252 CRM_Utils_Array
::value("{$fieldName}_relative", $this->_params
),
3253 CRM_Utils_Array
::value("{$fieldName}_from", $this->_params
),
3254 CRM_Utils_Array
::value("{$fieldName}_to", $this->_params
),
3255 CRM_Utils_Array
::value("{$fieldName}_from_time", $this->_params
),
3256 CRM_Utils_Array
::value("{$fieldName}_to_time", $this->_params
)
3258 $from_time_format = !empty($this->_params
["{$fieldName}_from_time"]) ?
'h' : 'd';
3259 $from = CRM_Utils_Date
::customFormat($from, NULL, array($from_time_format));
3261 $to_time_format = !empty($this->_params
["{$fieldName}_to_time"]) ?
'h' : 'd';
3262 $to = CRM_Utils_Date
::customFormat($to, NULL, array($to_time_format));
3265 $statistics['filters'][] = array(
3266 'title' => $field['title'],
3267 'value' => ts("Between %1 and %2", array(1 => $from, 2 => $to)),
3270 elseif (in_array($rel = CRM_Utils_Array
::value("{$fieldName}_relative", $this->_params
),
3271 array_keys($this->getOperationPair(CRM_Report_Form
::OP_DATE
))
3273 $pair = $this->getOperationPair(CRM_Report_Form
::OP_DATE
);
3274 $statistics['filters'][] = array(
3275 'title' => $field['title'],
3276 'value' => $pair[$rel],
3281 $op = CRM_Utils_Array
::value("{$fieldName}_op", $this->_params
);
3284 $pair = $this->getOperationPair(
3285 CRM_Utils_Array
::value('operatorType', $field),
3288 $min = CRM_Utils_Array
::value("{$fieldName}_min", $this->_params
);
3289 $max = CRM_Utils_Array
::value("{$fieldName}_max", $this->_params
);
3290 $val = CRM_Utils_Array
::value("{$fieldName}_value", $this->_params
);
3291 if (in_array($op, array('bw', 'nbw')) && ($min ||
$max)) {
3292 $value = "{$pair[$op]} $min " . ts('and') . " $max";
3294 elseif ($val && CRM_Utils_Array
::value('operatorType', $field) & self
::OP_ENTITYREF
) {
3295 $this->setEntityRefDefaults($field, $tableName);
3296 $result = civicrm_api3($field['attributes']['entity'], 'getlist',
3297 array('id' => $val) +
3298 CRM_Utils_Array
::value('api', $field['attributes'], array()));
3300 foreach ($result['values'] as $v) {
3301 $values[] = $v['label'];
3303 $value = "{$pair[$op]} " . implode(', ', $values);
3305 elseif ($op == 'nll' ||
$op == 'nnll') {
3306 $value = $pair[$op];
3308 elseif (is_array($val) && (!empty($val))) {
3309 $options = CRM_Utils_Array
::value('options', $field, array());
3310 foreach ($val as $key => $valIds) {
3311 if (isset($options[$valIds])) {
3312 $val[$key] = $options[$valIds];
3315 $pair[$op] = (count($val) == 1) ?
(($op == 'notin' ||
$op ==
3316 'mnot') ?
ts('Is Not') : ts('Is')) : CRM_Utils_Array
::value($op, $pair);
3317 $val = implode(', ', $val);
3318 $value = "{$pair[$op]} " . $val;
3320 elseif (!is_array($val) && (!empty($val) ||
$val == '0') &&
3321 isset($field['options']) &&
3322 is_array($field['options']) && !empty($field['options'])
3324 $value = CRM_Utils_Array
::value($op, $pair) . " " .
3325 CRM_Utils_Array
::value($val, $field['options'], $val);
3328 $value = CRM_Utils_Array
::value($op, $pair) . " " . $val;
3331 if ($value && empty($field['no_display'])) {
3332 $statistics['filters'][] = array(
3333 'title' => CRM_Utils_Array
::value('title', $field),
3344 * End post processing.
3346 * @param array|null $rows
3348 public function endPostProcess(&$rows = NULL) {
3349 $this->assign('report_class', get_class($this));
3350 if ($this->_storeResultSet
) {
3351 $this->_resultSet
= $rows;
3354 if ($this->_outputMode
== 'print' ||
3355 $this->_outputMode
== 'pdf' ||
3359 $content = $this->compileContent();
3360 $url = CRM_Utils_System
::url("civicrm/report/instance/{$this->_id}",
3364 if ($this->_sendmail
) {
3365 $config = CRM_Core_Config
::singleton();
3366 $attachments = array();
3368 if ($this->_outputMode
== 'csv') {
3370 = $this->_formValues
['report_header'] . '<p>' . ts('Report URL') .
3371 ": {$url}</p>" . '<p>' .
3372 ts('The report is attached as a CSV file.') . '</p>' .
3373 $this->_formValues
['report_footer'];
3375 $csvFullFilename = $config->templateCompileDir
.
3376 CRM_Utils_File
::makeFileName('CiviReport.csv');
3377 $csvContent = CRM_Report_Utils_Report
::makeCsv($this, $rows);
3378 file_put_contents($csvFullFilename, $csvContent);
3379 $attachments[] = array(
3380 'fullPath' => $csvFullFilename,
3381 'mime_type' => 'text/csv',
3382 'cleanName' => 'CiviReport.csv',
3385 if ($this->_outputMode
== 'pdf') {
3386 // generate PDF content
3387 $pdfFullFilename = $config->templateCompileDir
.
3388 CRM_Utils_File
::makeFileName('CiviReport.pdf');
3389 file_put_contents($pdfFullFilename,
3390 CRM_Utils_PDF_Utils
::html2pdf($content, "CiviReport.pdf",
3391 TRUE, array('orientation' => 'landscape')
3394 // generate Email Content
3396 = $this->_formValues
['report_header'] . '<p>' . ts('Report URL') .
3397 ": {$url}</p>" . '<p>' .
3398 ts('The report is attached as a PDF file.') . '</p>' .
3399 $this->_formValues
['report_footer'];
3401 $attachments[] = array(
3402 'fullPath' => $pdfFullFilename,
3403 'mime_type' => 'application/pdf',
3404 'cleanName' => 'CiviReport.pdf',
3408 if (CRM_Report_Utils_Report
::mailReport($content, $this->_id
,
3409 $this->_outputMode
, $attachments
3412 CRM_Core_Session
::setStatus(ts("Report mail has been sent."), ts('Sent'), 'success');
3415 CRM_Core_Session
::setStatus(ts("Report mail could not be sent."), ts('Mail Error'), 'error');
3419 elseif ($this->_outputMode
== 'print') {
3423 if ($chartType = CRM_Utils_Array
::value('charts', $this->_params
)) {
3424 $config = CRM_Core_Config
::singleton();
3425 //get chart image name
3426 $chartImg = $this->_chartId
. '.png';
3427 //get image url path
3429 = str_replace('/persist/contribute/', '/persist/', $config->imageUploadURL
) .
3431 $uploadUrl .= $chartImg;
3432 //get image doc path to overwrite
3434 = str_replace('/persist/contribute/', '/persist/', $config->imageUploadDir
) .
3435 'openFlashChart/' . $chartImg;
3437 $chart = imagecreatefrompng($uploadUrl);
3438 //convert it into formatted png
3439 CRM_Utils_System
::setHttpHeader('Content-type', 'image/png');
3440 //overwrite with same image
3441 imagepng($chart, $uploadImg);
3443 imagedestroy($chart);
3445 CRM_Utils_PDF_Utils
::html2pdf($content, "CiviReport.pdf", FALSE, array('orientation' => 'landscape'));
3447 CRM_Utils_System
::civiExit();
3449 elseif ($this->_outputMode
== 'csv') {
3450 CRM_Report_Utils_Report
::export2csv($this, $rows);
3452 elseif ($this->_outputMode
== 'group') {
3453 $group = $this->_params
['groups'];
3454 $this->add2group($group);
3459 * Set store result set indicator to TRUE.
3461 * @todo explain what this does
3463 public function storeResultSet() {
3464 $this->_storeResultSet
= TRUE;
3472 public function getResultSet() {
3473 return $this->_resultSet
;
3477 * Get the sql used to generate the report.
3481 public function getReportSql() {
3482 return $this->sqlArray
;
3486 * Use the form name to create the tpl file name.
3490 public function getTemplateFileName() {
3491 $defaultTpl = parent
::getTemplateFileName();
3492 $template = CRM_Core_Smarty
::singleton();
3493 if (!$template->template_exists($defaultTpl)) {
3494 $defaultTpl = 'CRM/Report/Form.tpl';
3500 * Compile the report content.
3502 * Although this function is super-short it is useful to keep separate so it can be over-ridden by report classes.
3506 public function compileContent() {
3507 $templateFile = $this->getHookedTemplateFileName();
3508 return CRM_Utils_Array
::value('report_header', $this->_formValues
) .
3509 CRM_Core_Form
::$_template->fetch($templateFile) .
3510 CRM_Utils_Array
::value('report_footer', $this->_formValues
);
3515 * Post process function.
3517 public function postProcess() {
3518 // get ready with post process params
3519 $this->beginPostProcess();
3522 $sql = $this->buildQuery();
3524 // build array of result based on column headers. This method also allows
3525 // modifying column headers before using it to build result set i.e $rows.
3527 $this->buildRows($sql, $rows);
3529 // format result set.
3530 $this->formatDisplay($rows);
3532 // assign variables to templates
3533 $this->doTemplateAssignment($rows);
3535 // do print / pdf / instance stuff if needed
3536 $this->endPostProcess($rows);
3542 * @param int $rowCount
3546 public function limit($rowCount = self
::ROW_COUNT_LIMIT
) {
3547 // lets do the pager if in html mode
3548 $this->_limit
= NULL;
3550 // CRM-14115, over-ride row count if rowCount is specified in URL
3551 if ($this->_dashBoardRowCount
) {
3552 $rowCount = $this->_dashBoardRowCount
;
3554 if ($this->addPaging
) {
3555 $this->_select
= preg_replace('/SELECT(\s+SQL_CALC_FOUND_ROWS)?\s+/i', 'SELECT SQL_CALC_FOUND_ROWS ', $this->_select
);
3557 $pageId = CRM_Utils_Request
::retrieve('crmPID', 'Integer');
3559 // @todo all http vars should be extracted in the preProcess
3560 // - not randomly in the class
3561 if (!$pageId && !empty($_POST)) {
3562 if (isset($_POST['PagerBottomButton']) && isset($_POST['crmPID_B'])) {
3563 $pageId = max((int) $_POST['crmPID_B'], 1);
3565 elseif (isset($_POST['PagerTopButton']) && isset($_POST['crmPID'])) {
3566 $pageId = max((int) $_POST['crmPID'], 1);
3568 unset($_POST['crmPID_B'], $_POST['crmPID']);
3571 $pageId = $pageId ?
$pageId : 1;
3572 $this->set(CRM_Utils_Pager
::PAGE_ID
, $pageId);
3573 $offset = ($pageId - 1) * $rowCount;
3575 $offset = CRM_Utils_Type
::escape($offset, 'Int');
3576 $rowCount = CRM_Utils_Type
::escape($rowCount, 'Int');
3578 $this->_limit
= " LIMIT $offset, $rowCount";
3579 return array($offset, $rowCount);
3581 if ($this->_limitValue
) {
3582 if ($this->_offsetValue
) {
3583 $this->_limit
= " LIMIT {$this->_offsetValue}, {$this->_limitValue} ";
3586 $this->_limit
= " LIMIT " . $this->_limitValue
;
3594 * @param int $rowCount
3596 public function setPager($rowCount = self
::ROW_COUNT_LIMIT
) {
3597 // CRM-14115, over-ride row count if rowCount is specified in URL
3598 if ($this->_dashBoardRowCount
) {
3599 $rowCount = $this->_dashBoardRowCount
;
3602 if ($this->_limit
&& ($this->_limit
!= '')) {
3603 if (!$this->_rowsFound
) {
3604 $sql = "SELECT FOUND_ROWS();";
3605 $this->_rowsFound
= CRM_Core_DAO
::singleValueQuery($sql);
3608 'total' => $this->_rowsFound
,
3609 'rowCount' => $rowCount,
3610 'status' => ts('Records') . ' %%StatusMessage%%',
3611 'buttonBottom' => 'PagerBottomButton',
3612 'buttonTop' => 'PagerTopButton',
3614 if (!empty($this->controller
)) {
3615 // This happens when being called from the api Really we want the api to be able to
3616 // pass paging parameters, but at this stage just preventing test crashes.
3617 $params['pageID'] = $this->get(CRM_Utils_Pager
::PAGE_ID
);
3620 $pager = new CRM_Utils_Pager($params);
3621 $this->assign_by_ref('pager', $pager);
3622 $this->ajaxResponse
['totalRows'] = $this->_rowsFound
;
3627 * Build a group filter with contempt for large data sets.
3629 * This function has been retained as it takes time to migrate the reports over
3630 * to the new method which will not crash on large datasets.
3634 * @param string $field
3635 * @param mixed $value
3640 public function legacySlowGroupFilterClause($field, $value, $op) {
3641 $smartGroupQuery = "";
3643 $group = new CRM_Contact_DAO_Group();
3644 $group->is_active
= 1;
3646 $smartGroups = array();
3647 while ($group->fetch()) {
3648 if (in_array($group->id
, (array) $this->_params
['gid_value']) &&
3649 $group->saved_search_id
3651 $smartGroups[] = $group->id
;
3655 CRM_Contact_BAO_GroupContactCache
::check($smartGroups);
3657 $smartGroupQuery = '';
3658 if (!empty($smartGroups)) {
3659 $smartGroups = implode(',', $smartGroups);
3660 $smartGroupQuery = " UNION DISTINCT
3661 SELECT DISTINCT smartgroup_contact.contact_id
3662 FROM civicrm_group_contact_cache smartgroup_contact
3663 WHERE smartgroup_contact.group_id IN ({$smartGroups}) ";
3666 $sqlOp = $this->getSQLOperator($op);
3667 if (!is_array($value)) {
3668 $value = array($value);
3670 //include child groups if any
3671 $value = array_merge($value, CRM_Contact_BAO_Group
::getChildGroupIds($value));
3673 $clause = "{$field['dbAlias']} IN (" . implode(', ', $value) . ")";
3675 $contactAlias = $this->_aliases
['civicrm_contact'];
3676 if (!empty($this->relationType
) && $this->relationType
== 'b_a') {
3677 $contactAlias = $this->_aliases
['civicrm_contact_b'];
3679 return " {$contactAlias}.id {$sqlOp} (
3680 SELECT DISTINCT {$this->_aliases['civicrm_group']}.contact_id
3681 FROM civicrm_group_contact {$this->_aliases['civicrm_group']}
3682 WHERE {$clause} AND {$this->_aliases['civicrm_group']}.status = 'Added'
3683 {$smartGroupQuery} ) ";
3687 * Build where clause for groups.
3689 * @param string $field
3690 * @param mixed $value
3695 public function whereGroupClause($field, $value, $op) {
3696 if ($this->groupFilterNotOptimised
) {
3697 return $this->legacySlowGroupFilterClause($field, $value, $op);
3699 if ($op === 'notin') {
3700 return " group_temp_table.id IS NULL ";
3702 // We will have used an inner join instead.
3708 * Create a table of the contact ids included by the group filter.
3710 * This function is called by both the api (tests) and the UI.
3712 public function buildGroupTempTable() {
3713 if (!empty($this->groupTempTable
) ||
empty($this->_params
['gid_value']) ||
$this->groupFilterNotOptimised
) {
3716 $filteredGroups = (array) $this->_params
['gid_value'];
3718 $groups = civicrm_api3('Group', 'get', array(
3720 'id' => array('IN' => $filteredGroups),
3721 'saved_search_id' => array('>' => 0),
3724 $smartGroups = array_keys($groups['values']);
3727 SELECT DISTINCT group_contact.contact_id as id
3728 FROM civicrm_group_contact group_contact
3729 WHERE group_contact.group_id IN (" . implode(', ', $filteredGroups) . ")
3730 AND group_contact.status = 'Added' ";
3732 if (!empty($smartGroups)) {
3733 CRM_Contact_BAO_GroupContactCache
::check($smartGroups);
3734 $smartGroups = implode(',', $smartGroups);
3737 SELECT smartgroup_contact.contact_id as id
3738 FROM civicrm_group_contact_cache smartgroup_contact
3739 WHERE smartgroup_contact.group_id IN ({$smartGroups}) ";
3742 $this->groupTempTable
= $this->createTemporaryTable('rptgrp', $query);
3743 CRM_Core_DAO
::executeQuery("ALTER TABLE $this->groupTempTable ADD INDEX i_id(id)");
3747 * Execute query and add it to the developer tab.
3749 * @param string $query
3750 * @param array $params
3752 * @return \CRM_Core_DAO|object
3754 protected function executeReportQuery($query, $params = array()) {
3755 $this->addToDeveloperTab($query);
3756 return CRM_Core_DAO
::executeQuery($query, $params);
3760 * Build where clause for tags.
3762 * @param string $field
3763 * @param mixed $value
3768 public function whereTagClause($field, $value, $op) {
3769 // not using left join in query because if any contact
3770 // belongs to more than one tag, results duplicate
3772 $sqlOp = $this->getSQLOperator($op);
3773 if (!is_array($value)) {
3774 $value = array($value);
3776 $clause = "{$field['dbAlias']} IN (" . implode(', ', $value) . ")";
3777 $entity_table = $this->_tagFilterTable
;
3778 return " {$this->_aliases[$entity_table]}.id {$sqlOp} (
3779 SELECT DISTINCT {$this->_aliases['civicrm_tag']}.entity_id
3780 FROM civicrm_entity_tag {$this->_aliases['civicrm_tag']}
3781 WHERE entity_table = '$entity_table' AND {$clause} ) ";
3785 * Generate membership organization clause.
3787 * @param mixed $value
3788 * @param string $op SQL Operator
3792 public function whereMembershipOrgClause($value, $op) {
3793 $sqlOp = $this->getSQLOperator($op);
3794 if (!is_array($value)) {
3795 $value = array($value);
3798 $tmp_membership_org_sql_list = implode(', ', $value);
3799 return " {$this->_aliases['civicrm_contact']}.id {$sqlOp} (
3800 SELECT DISTINCT mem.contact_id
3801 FROM civicrm_membership mem
3802 LEFT JOIN civicrm_membership_status mem_status ON mem.status_id = mem_status.id
3803 LEFT JOIN civicrm_membership_type mt ON mem.membership_type_id = mt.id
3804 WHERE mt.member_of_contact_id IN (" .
3805 $tmp_membership_org_sql_list . ")
3806 AND mt.is_active = '1'
3807 AND mem_status.is_current_member = '1'
3808 AND mem_status.is_active = '1' ) ";
3812 * Generate Membership Type SQL Clause.
3814 * @param mixed $value
3820 public function whereMembershipTypeClause($value, $op) {
3821 $sqlOp = $this->getSQLOperator($op);
3822 if (!is_array($value)) {
3823 $value = array($value);
3826 $tmp_membership_sql_list = implode(', ', $value);
3827 return " {$this->_aliases['civicrm_contact']}.id {$sqlOp} (
3828 SELECT DISTINCT mem.contact_id
3829 FROM civicrm_membership mem
3830 LEFT JOIN civicrm_membership_status mem_status ON mem.status_id = mem_status.id
3831 LEFT JOIN civicrm_membership_type mt ON mem.membership_type_id = mt.id
3832 WHERE mem.membership_type_id IN (" .
3833 $tmp_membership_sql_list . ")
3834 AND mt.is_active = '1'
3835 AND mem_status.is_current_member = '1'
3836 AND mem_status.is_active = '1' ) ";
3840 * Buld contact acl clause
3841 * @deprecated in favor of buildPermissionClause
3843 * @param string $tableAlias
3845 public function buildACLClause($tableAlias = 'contact_a') {
3846 list($this->_aclFrom
, $this->_aclWhere
) = CRM_Contact_BAO_Contact_Permission
::cacheClause($tableAlias);
3850 * Build the permision clause for all entities in this report
3852 public function buildPermissionClause() {
3854 foreach ($this->selectedTables() as $tableName) {
3855 $baoName = str_replace('_DAO_', '_BAO_', CRM_Core_DAO_AllCoreTables
::getClassForTable($tableName));
3856 if ($baoName && class_exists($baoName) && !empty($this->_columns
[$tableName]['alias'])) {
3857 $tableAlias = $this->_columns
[$tableName]['alias'];
3858 $clauses = array_filter($baoName::getSelectWhereClause($tableAlias));
3859 foreach ($clauses as $field => $clause) {
3860 // Skip contact_id field if redundant
3861 if ($field != 'contact_id' ||
!in_array('civicrm_contact', $this->selectedTables())) {
3862 $ret["$tableName.$field"] = $clause;
3867 // Override output from buildACLClause
3868 $this->_aclFrom
= NULL;
3869 $this->_aclWhere
= implode(' AND ', $ret);
3873 * Add custom data to the columns.
3875 * @param bool $addFields
3876 * @param array $permCustomGroupIds
3878 public function addCustomDataToColumns($addFields = TRUE, $permCustomGroupIds = array()) {
3879 if (empty($this->_customGroupExtends
)) {
3882 if (!is_array($this->_customGroupExtends
)) {
3883 $this->_customGroupExtends
= array($this->_customGroupExtends
);
3885 $customGroupWhere = '';
3886 if (!empty($permCustomGroupIds)) {
3887 $customGroupWhere = "cg.id IN (" . implode(',', $permCustomGroupIds) .
3891 SELECT cg.table_name, cg.title, cg.extends, cf.id as cf_id, cf.label,
3892 cf.column_name, cf.data_type, cf.html_type, cf.option_group_id, cf.time_format
3893 FROM civicrm_custom_group cg
3894 INNER JOIN civicrm_custom_field cf ON cg.id = cf.custom_group_id
3895 WHERE cg.extends IN ('" . implode("','", $this->_customGroupExtends
) . "') AND
3897 cg.is_active = 1 AND
3898 cf.is_active = 1 AND
3899 cf.is_searchable = 1
3900 ORDER BY cg.weight, cf.weight";
3901 $customDAO = CRM_Core_DAO
::executeQuery($sql);
3904 while ($customDAO->fetch()) {
3905 if ($customDAO->table_name
!= $curTable) {
3906 $curTable = $customDAO->table_name
;
3907 $curFields = $curFilters = array();
3910 $this->_columns
[$curTable]['dao'] = 'CRM_Contact_DAO_Contact';
3911 $this->_columns
[$curTable]['extends'] = $customDAO->extends;
3912 $this->_columns
[$curTable]['grouping'] = $customDAO->table_name
;
3913 $this->_columns
[$curTable]['group_title'] = $customDAO->title
;
3915 foreach (array('fields', 'filters', 'group_bys') as $colKey) {
3916 if (!array_key_exists($colKey, $this->_columns
[$curTable])) {
3917 $this->_columns
[$curTable][$colKey] = array();
3921 $fieldName = 'custom_' . $customDAO->cf_id
;
3924 // this makes aliasing work in favor
3925 $curFields[$fieldName] = array(
3926 'name' => $customDAO->column_name
,
3927 'title' => $customDAO->label
,
3928 'dataType' => $customDAO->data_type
,
3929 'htmlType' => $customDAO->html_type
,
3932 if ($this->_customGroupFilters
) {
3933 // this makes aliasing work in favor
3934 $curFilters[$fieldName] = array(
3935 'name' => $customDAO->column_name
,
3936 'title' => $customDAO->label
,
3937 'dataType' => $customDAO->data_type
,
3938 'htmlType' => $customDAO->html_type
,
3942 switch ($customDAO->data_type
) {
3945 $curFilters[$fieldName]['operatorType'] = CRM_Report_Form
::OP_DATE
;
3946 $curFilters[$fieldName]['type'] = CRM_Utils_Type
::T_DATE
;
3947 // CRM-6946, show time part for datetime date fields
3948 if ($customDAO->time_format
) {
3949 $curFields[$fieldName]['type'] = CRM_Utils_Type
::T_TIMESTAMP
;
3954 $curFilters[$fieldName]['operatorType'] = CRM_Report_Form
::OP_SELECT
;
3955 $curFilters[$fieldName]['options'] = array('' => ts('- select -')) + CRM_Core_PseudoConstant
::get('CRM_Core_BAO_CustomField', 'custom_' . $customDAO->cf_id
, array(), 'search');
3956 $curFilters[$fieldName]['type'] = CRM_Utils_Type
::T_INT
;
3960 $curFilters[$fieldName]['operatorType'] = CRM_Report_Form
::OP_INT
;
3961 $curFilters[$fieldName]['type'] = CRM_Utils_Type
::T_INT
;
3965 $curFilters[$fieldName]['operatorType'] = CRM_Report_Form
::OP_FLOAT
;
3966 $curFilters[$fieldName]['type'] = CRM_Utils_Type
::T_MONEY
;
3967 $curFields[$fieldName]['type'] = CRM_Utils_Type
::T_MONEY
;
3971 $curFilters[$fieldName]['operatorType'] = CRM_Report_Form
::OP_FLOAT
;
3972 $curFilters[$fieldName]['type'] = CRM_Utils_Type
::T_FLOAT
;
3976 case 'StateProvince':
3978 $curFilters[$fieldName]['type'] = CRM_Utils_Type
::T_STRING
;
3980 $options = CRM_Core_PseudoConstant
::get('CRM_Core_BAO_CustomField', 'custom_' . $customDAO->cf_id
, array(), 'search');
3981 if ((is_array($options) && count($options) != 0) ||
(!is_array($options) && $options !== FALSE)) {
3982 $curFilters[$fieldName]['operatorType'] = CRM_Core_BAO_CustomField
::isSerialized($customDAO) ? CRM_Report_Form
::OP_MULTISELECT_SEPARATOR
: CRM_Report_Form
::OP_MULTISELECT
;
3983 $curFilters[$fieldName]['options'] = $options;
3987 case 'ContactReference':
3988 $curFilters[$fieldName]['type'] = CRM_Utils_Type
::T_STRING
;
3989 $curFilters[$fieldName]['name'] = 'display_name';
3990 $curFilters[$fieldName]['alias'] = "contact_{$fieldName}_civireport";
3992 $curFields[$fieldName]['type'] = CRM_Utils_Type
::T_STRING
;
3993 $curFields[$fieldName]['name'] = 'display_name';
3994 $curFields[$fieldName]['alias'] = "contact_{$fieldName}_civireport";
3998 $curFields[$fieldName]['type'] = CRM_Utils_Type
::T_STRING
;
3999 $curFilters[$fieldName]['type'] = CRM_Utils_Type
::T_STRING
;
4003 if ($customDAO->html_type
== 'Select' && !array_key_exists('options', $curFilters[$fieldName])) {
4004 $options = CRM_Core_PseudoConstant
::get('CRM_Core_BAO_CustomField', 'custom_' . $customDAO->cf_id
, array(), 'search');
4005 if ($options !== FALSE) {
4006 $curFilters[$fieldName]['operatorType'] = CRM_Core_BAO_CustomField
::isSerialized($customDAO) ? CRM_Report_Form
::OP_MULTISELECT_SEPARATOR
: CRM_Report_Form
::OP_MULTISELECT
;
4007 $curFilters[$fieldName]['options'] = $options;
4011 if (!array_key_exists('type', $curFields[$fieldName])) {
4012 $curFields[$fieldName]['type'] = CRM_Utils_Array
::value('type', $curFilters[$fieldName], array());
4016 $this->_columns
[$curTable]['fields'] = array_merge($this->_columns
[$curTable]['fields'], $curFields);
4018 if ($this->_customGroupFilters
) {
4019 $this->_columns
[$curTable]['filters'] = array_merge($this->_columns
[$curTable]['filters'], $curFilters);
4021 if ($this->_customGroupGroupBy
) {
4022 $this->_columns
[$curTable]['group_bys'] = array_merge($this->_columns
[$curTable]['group_bys'], $curFields);
4028 * Build custom data from clause.
4030 * @param bool $joinsForFiltersOnly
4031 * Only include joins to support filters. This would be used if creating a table of contacts to include first.
4033 public function customDataFrom($joinsForFiltersOnly = FALSE) {
4034 if (empty($this->_customGroupExtends
)) {
4037 $mapper = CRM_Core_BAO_CustomQuery
::$extendsMap;
4038 //CRM-18276 GROUP_CONCAT could be used with singleValueQuery and then exploded,
4039 //but by default that truncates to 1024 characters, which causes errors with installs with lots of custom field sets
4040 $customTables = array();
4041 $customTablesDAO = CRM_Core_DAO
::executeQuery("SELECT table_name FROM civicrm_custom_group");
4042 while ($customTablesDAO->fetch()) {
4043 $customTables[] = $customTablesDAO->table_name
;
4046 foreach ($this->_columns
as $table => $prop) {
4047 if (in_array($table, $customTables)) {
4048 $extendsTable = $mapper[$prop['extends']];
4049 // Check field is required for rendering the report.
4050 if ((!$this->isFieldSelected($prop)) ||
($joinsForFiltersOnly && !$this->isFieldFiltered($prop))) {
4053 $baseJoin = CRM_Utils_Array
::value($prop['extends'], $this->_customGroupExtendsJoin
, "{$this->_aliases[$extendsTable]}.id");
4055 $customJoin = is_array($this->_customGroupJoin
) ?
$this->_customGroupJoin
[$table] : $this->_customGroupJoin
;
4057 {$customJoin} {$table} {$this->_aliases[$table]} ON {$this->_aliases[$table]}.entity_id = {$baseJoin}";
4058 // handle for ContactReference
4059 if (array_key_exists('fields', $prop)) {
4060 foreach ($prop['fields'] as $fieldName => $field) {
4061 if (CRM_Utils_Array
::value('dataType', $field) ==
4064 $columnName = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_CustomField', CRM_Core_BAO_CustomField
::getKeyID($fieldName), 'column_name');
4066 LEFT JOIN civicrm_contact {$field['alias']} ON {$field['alias']}.id = {$this->_aliases[$table]}.{$columnName} ";
4075 * Check if the field is selected.
4077 * @param string $prop
4081 public function isFieldSelected($prop) {
4086 if (!empty($this->_params
['fields'])) {
4087 foreach (array_keys($prop['fields']) as $fieldAlias) {
4088 $customFieldId = CRM_Core_BAO_CustomField
::getKeyID($fieldAlias);
4089 if ($customFieldId) {
4090 if (array_key_exists($fieldAlias, $this->_params
['fields'])) {
4094 //might be survey response field.
4095 if (!empty($this->_params
['fields']['survey_response']) &&
4096 !empty($prop['fields'][$fieldAlias]['isSurveyResponseField'])
4104 if (!empty($this->_params
['group_bys']) && $this->_customGroupGroupBy
) {
4105 foreach (array_keys($prop['group_bys']) as $fieldAlias) {
4106 if (array_key_exists($fieldAlias, $this->_params
['group_bys']) &&
4107 CRM_Core_BAO_CustomField
::getKeyID($fieldAlias)
4114 if (!empty($this->_params
['order_bys'])) {
4115 foreach (array_keys($prop['fields']) as $fieldAlias) {
4116 foreach ($this->_params
['order_bys'] as $orderBy) {
4117 if ($fieldAlias == $orderBy['column'] &&
4118 CRM_Core_BAO_CustomField
::getKeyID($fieldAlias)
4125 return $this->isFieldFiltered($prop);
4130 * Check if the field is used as a filter.
4132 * @param string $prop
4136 protected function isFieldFiltered($prop) {
4137 if (!empty($prop['filters']) && $this->_customGroupFilters
) {
4138 foreach ($prop['filters'] as $fieldAlias => $val) {
4147 if (isset($this->_params
[$fieldAlias . '_' . $attach]) &&
4148 (!empty($this->_params
[$fieldAlias . '_' . $attach])
4149 ||
($attach != 'relative' &&
4150 $this->_params
[$fieldAlias . '_' . $attach] == '0')
4156 if (!empty($this->_params
[$fieldAlias . '_op']) &&
4157 in_array($this->_params
[$fieldAlias . '_op'], array('nll', 'nnll'))
4168 * Check for empty order_by configurations and remove them.
4170 * Also set template to hide them.
4172 * @param array $formValues
4174 public function preProcessOrderBy(&$formValues) {
4175 // Object to show/hide form elements
4176 $_showHide = new CRM_Core_ShowHideBlocks('', '');
4178 $_showHide->addShow('optionField_1');
4180 // Cycle through order_by options; skip any empty ones, and hide them as well
4183 if (!empty($formValues['order_bys'])) {
4184 foreach ($formValues['order_bys'] as $order_by) {
4185 if ($order_by['column'] && $order_by['column'] != '-') {
4186 $_showHide->addShow('optionField_' . $n);
4187 $orderBys[$n] = $order_by;
4192 for ($i = $n; $i <= 5; $i++
) {
4194 $_showHide->addHide('optionField_' . $i);
4198 // overwrite order_by options with modified values
4199 if (!empty($orderBys)) {
4200 $formValues['order_bys'] = $orderBys;
4203 $formValues['order_bys'] = array(1 => array('column' => '-'));
4206 // assign show/hide data to template
4207 $_showHide->addToTemplate();
4211 * Check if table name has columns in SELECT clause.
4213 * @param string $tableName
4214 * Name of table (index of $this->_columns array).
4218 public function isTableSelected($tableName) {
4219 return in_array($tableName, $this->selectedTables());
4223 * Check if table name has columns in WHERE or HAVING clause.
4225 * @param string $tableName
4226 * Name of table (index of $this->_columns array).
4230 public function isTableFiltered($tableName) {
4231 // Cause the array to be generated if not previously done.
4232 if (!$this->_selectedTables
&& !$this->filteredTables
) {
4233 $this->selectedTables();
4235 return in_array($tableName, $this->filteredTables
);
4239 * Fetch array of DAO tables having columns included in SELECT or ORDER BY clause.
4241 * If the array is unset it will be built.
4246 public function selectedTables() {
4247 if (!$this->_selectedTables
) {
4248 $orderByColumns = array();
4249 if (array_key_exists('order_bys', $this->_params
) &&
4250 is_array($this->_params
['order_bys'])
4252 foreach ($this->_params
['order_bys'] as $orderBy) {
4253 $orderByColumns[] = $orderBy['column'];
4257 foreach ($this->_columns
as $tableName => $table) {
4258 if (array_key_exists('fields', $table)) {
4259 foreach ($table['fields'] as $fieldName => $field) {
4260 if (!empty($field['required']) ||
4261 !empty($this->_params
['fields'][$fieldName])
4263 $this->_selectedTables
[] = $tableName;
4268 if (array_key_exists('order_bys', $table)) {
4269 foreach ($table['order_bys'] as $orderByName => $orderBy) {
4270 if (in_array($orderByName, $orderByColumns)) {
4271 $this->_selectedTables
[] = $tableName;
4276 if (array_key_exists('filters', $table)) {
4277 foreach ($table['filters'] as $filterName => $filter) {
4278 if (!empty($this->_params
["{$filterName}_value"])
4279 ||
!empty($this->_params
["{$filterName}_relative"])
4280 || CRM_Utils_Array
::value("{$filterName}_op", $this->_params
) ==
4282 || CRM_Utils_Array
::value("{$filterName}_op", $this->_params
) ==
4285 $this->_selectedTables
[] = $tableName;
4286 $this->filteredTables
[] = $tableName;
4293 return $this->_selectedTables
;
4297 * Add campaign fields.
4299 * @param bool $groupBy
4300 * Add GroupBy? Not appropriate for detail report.
4301 * @param bool $orderBy
4302 * Add OrderBy? Not appropriate for detail report.
4303 * @param bool $filters
4306 public function addCampaignFields($entityTable = 'civicrm_contribution', $groupBy = FALSE, $orderBy = FALSE, $filters = TRUE) {
4307 // Check if CiviCampaign is a) enabled and b) has active campaigns
4308 $config = CRM_Core_Config
::singleton();
4309 $campaignEnabled = in_array('CiviCampaign', $config->enableComponents
);
4310 if ($campaignEnabled) {
4311 $getCampaigns = CRM_Campaign_BAO_Campaign
::getPermissionedCampaigns(NULL, NULL, FALSE, FALSE, TRUE);
4312 // If we have a campaign, build out the relevant elements
4313 if (!empty($getCampaigns['campaigns'])) {
4314 $this->campaigns
= $getCampaigns['campaigns'];
4315 asort($this->campaigns
);
4316 $this->_columns
[$entityTable]['fields']['campaign_id'] = array('title' => ts('Campaign'), 'default' => 'false');
4318 $this->_columns
[$entityTable]['filters']['campaign_id'] = array(
4319 'title' => ts('Campaign'),
4320 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
4321 'options' => $this->campaigns
,
4322 'type' => CRM_Utils_Type
::T_INT
,
4327 $this->_columns
[$entityTable]['group_bys']['campaign_id'] = array('title' => ts('Campaign'));
4331 $this->_columns
[$entityTable]['order_bys']['campaign_id'] = array('title' => ts('Campaign'));
4338 * Add address fields.
4340 * @deprecated - use getAddressColumns which is a more accurate description
4341 * and also accepts an array of options rather than a long list
4343 * adding address fields to construct function in reports
4345 * @param bool $groupBy
4346 * Add GroupBy? Not appropriate for detail report.
4347 * @param bool $orderBy
4348 * Add GroupBy? Not appropriate for detail report.
4349 * @param bool $filters
4350 * @param array $defaults
4353 * address fields for construct clause
4355 public function addAddressFields($groupBy = TRUE, $orderBy = FALSE, $filters = TRUE, $defaults = array('country_id' => TRUE)) {
4356 $defaultAddressFields = array(
4357 'street_address' => ts('Street Address'),
4358 'supplemental_address_1' => ts('Supplementary Address Field 1'),
4359 'supplemental_address_2' => ts('Supplementary Address Field 2'),
4360 'supplemental_address_3' => ts('Supplementary Address Field 3'),
4361 'street_number' => ts('Street Number'),
4362 'street_name' => ts('Street Name'),
4363 'street_unit' => ts('Street Unit'),
4364 'city' => ts('City'),
4365 'postal_code' => ts('Postal Code'),
4366 'postal_code_suffix' => ts('Postal Code Suffix'),
4367 'country_id' => ts('Country'),
4368 'state_province_id' => ts('State/Province'),
4369 'county_id' => ts('County'),
4371 $addressFields = array(
4372 'civicrm_address' => array(
4373 'dao' => 'CRM_Core_DAO_Address',
4375 'address_name' => array(
4376 'title' => ts('Address Name'),
4377 'default' => CRM_Utils_Array
::value('name', $defaults, FALSE),
4381 'grouping' => 'location-fields',
4384 foreach ($defaultAddressFields as $fieldName => $fieldLabel) {
4385 $addressFields['civicrm_address']['fields'][$fieldName] = array(
4386 'title' => $fieldLabel,
4387 'default' => CRM_Utils_Array
::value($fieldName, $defaults, FALSE),
4391 $street_address_filters = $general_address_filters = array();
4393 // Address filter depends on whether street address parsing is enabled.
4395 $addressOptions = CRM_Core_BAO_Setting
::valueOptions(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
4398 if ($addressOptions['street_address_parsing']) {
4399 $street_address_filters = array(
4400 'street_number' => array(
4401 'title' => ts('Street Number'),
4402 'type' => CRM_Utils_Type
::T_INT
,
4403 'name' => 'street_number',
4405 'street_name' => array(
4406 'title' => ts('Street Name'),
4407 'name' => 'street_name',
4408 'type' => CRM_Utils_Type
::T_STRING
,
4413 $street_address_filters = array(
4414 'street_address' => array(
4415 'title' => ts('Street Address'),
4416 'type' => CRM_Utils_Type
::T_STRING
,
4417 'name' => 'street_address',
4421 $general_address_filters = array(
4422 'postal_code' => array(
4423 'title' => ts('Postal Code'),
4424 'type' => CRM_Utils_Type
::T_STRING
,
4425 'name' => 'postal_code',
4428 'title' => ts('City'),
4429 'type' => CRM_Utils_Type
::T_STRING
,
4432 'country_id' => array(
4433 'name' => 'country_id',
4434 'title' => ts('Country'),
4435 'type' => CRM_Utils_Type
::T_INT
,
4436 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
4437 'options' => CRM_Core_PseudoConstant
::country(),
4439 'state_province_id' => array(
4440 'name' => 'state_province_id',
4441 'title' => ts('State/Province'),
4442 'type' => CRM_Utils_Type
::T_INT
,
4443 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
4444 'options' => array(),
4446 'county_id' => array(
4447 'name' => 'county_id',
4448 'title' => ts('County'),
4449 'type' => CRM_Utils_Type
::T_INT
,
4450 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
4451 'options' => array(),
4455 $addressFields['civicrm_address']['filters'] = array_merge(
4456 $street_address_filters,
4457 $general_address_filters);
4460 $addressFields['civicrm_address']['order_bys'] = array(
4461 'street_name' => array('title' => ts('Street Name')),
4462 'street_number' => array('title' => ts('Odd / Even Street Number')),
4463 'street_address' => NULL,
4465 'postal_code' => NULL,
4470 $addressFields['civicrm_address']['group_bys'] = array(
4471 'street_address' => NULL,
4473 'postal_code' => NULL,
4474 'state_province_id' => array(
4475 'title' => ts('State/Province'),
4477 'country_id' => array(
4478 'title' => ts('Country'),
4480 'county_id' => array(
4481 'title' => ts('County'),
4485 return $addressFields;
4489 * Do AlterDisplay processing on Address Fields.
4490 * If there are multiple address field values then
4491 * on basis of provided separator the code values are translated into respective labels
4494 * @param array $rows
4495 * @param int $rowNum
4496 * @param string $baseUrl
4497 * @param string $linkText
4498 * @param string $separator
4502 public function alterDisplayAddressFields(&$row, &$rows, &$rowNum, $baseUrl, $linkText, $separator = ',') {
4503 $criteriaQueryParams = CRM_Report_Utils_Report
::getPreviewCriteriaQueryParams($this->_defaults
, $this->_params
);
4504 $entryFound = FALSE;
4506 'civicrm_address_country_id' => 'country',
4507 'civicrm_address_county_id' => 'county',
4508 'civicrm_address_state_province_id' => 'stateProvince',
4510 foreach ($columnMap as $fieldName => $fnName) {
4511 if (array_key_exists($fieldName, $row)) {
4512 if ($values = $row[$fieldName]) {
4513 $values = (array) explode($separator, $values);
4514 $rows[$rowNum][$fieldName] = [];
4515 $addressField = $fnName == 'stateProvince' ?
'state' : $fnName;
4516 foreach ($values as $value) {
4517 $rows[$rowNum][$fieldName][] = CRM_Core_PseudoConstant
::$fnName($value);
4519 $rows[$rowNum][$fieldName] = implode($separator, $rows[$rowNum][$fieldName]);
4521 $url = CRM_Report_Utils_Report
::getNextUrl($baseUrl,
4522 sprintf("reset=1&force=1&%s&%s_op=in&%s_value=%s",
4523 $criteriaQueryParams,
4524 str_replace('civicrm_address_', '', $fieldName),
4525 str_replace('civicrm_address_', '', $fieldName),
4526 implode(',', $values)
4527 ), $this->_absoluteUrl
, $this->_id
4529 $rows[$rowNum]["{$fieldName}_link"] = $url;
4530 $rows[$rowNum]["{$fieldName}_hover"] = ts("%1 for this %2.", array(1 => $linkText, 2 => $addressField));
4541 * Do AlterDisplay processing on Address Fields.
4544 * @param array $rows
4545 * @param int $rowNum
4546 * @param string $baseUrl
4547 * @param string $linkText
4551 public function alterDisplayContactFields(&$row, &$rows, &$rowNum, $baseUrl, $linkText) {
4552 $entryFound = FALSE;
4553 // There is no reason not to add links for all fields but it seems a bit odd to be able to click on
4554 // 'Mrs'. Also, we don't have metadata about the title. So, add selectively to addLinks.
4555 $addLinks = array('gender_id' => 'Gender');
4556 foreach (array('prefix_id', 'suffix_id', 'gender_id', 'contact_sub_type', 'preferred_language') as $fieldName) {
4557 if (array_key_exists('civicrm_contact_' . $fieldName, $row)) {
4558 if (($value = $row['civicrm_contact_' . $fieldName]) != FALSE) {
4559 $rowValues = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $value);
4560 $rowLabels = array();
4561 foreach ($rowValues as $rowValue) {
4563 $rowLabels[] = CRM_Core_PseudoConstant
::getLabel('CRM_Contact_BAO_Contact', $fieldName, $rowValue);
4566 $rows[$rowNum]['civicrm_contact_' . $fieldName] = implode(', ', $rowLabels);
4567 if ($baseUrl && ($title = CRM_Utils_Array
::value($fieldName, $addLinks)) != FALSE) {
4568 $this->addLinkToRow($rows[$rowNum], $baseUrl, $linkText, $value, $fieldName, 'civicrm_contact', $title);
4574 $yesNoFields = array(
4575 'do_not_email', 'is_deceased', 'do_not_phone', 'do_not_sms', 'do_not_mail', 'is_opt_out',
4577 foreach ($yesNoFields as $fieldName) {
4578 if (array_key_exists('civicrm_contact_' . $fieldName, $row)) {
4579 // Since these are essentially 'negative fields' it feels like it
4580 // makes sense to only highlight the exceptions hence no 'No'.
4581 $rows[$rowNum]['civicrm_contact_' . $fieldName] = !empty($rows[$rowNum]['civicrm_contact_' . $fieldName]) ?
ts('Yes') : '';
4586 // Handle employer id
4587 if (array_key_exists('civicrm_contact_employer_id', $row)) {
4588 $employerId = $row['civicrm_contact_employer_id'];
4590 $rows[$rowNum]['civicrm_contact_employer_id'] = CRM_Contact_BAO_Contact
::displayName($employerId);
4591 $rows[$rowNum]['civicrm_contact_employer_id_link'] = CRM_Utils_System
::url('civicrm/contact/view', 'reset=1&cid=' . $employerId, $this->_absoluteUrl
);
4592 $rows[$rowNum]['civicrm_contact_employer_id_hover'] = ts('View Contact Summary for Employer.');
4601 * Adjusts dates passed in to YEAR() for fiscal year.
4603 * @param string $fieldName
4607 public function fiscalYearOffset($fieldName) {
4608 $config = CRM_Core_Config
::singleton();
4609 $fy = $config->fiscalYearStart
;
4610 if (CRM_Utils_Array
::value('yid_op', $this->_params
) == 'calendar' ||
4611 ($fy['d'] == 1 && $fy['M'] == 1)
4613 return "YEAR( $fieldName )";
4615 return "YEAR( $fieldName - INTERVAL " . ($fy['M'] - 1) . " MONTH" .
4616 ($fy['d'] > 1 ?
(" - INTERVAL " . ($fy['d'] - 1) . " DAY") : '') . " )";
4620 * Add Address into From Table if required.
4622 * @deprecated use joinAddressFromContact
4623 * (left here in case extensions use it).
4625 public function addAddressFromClause() {
4626 CRM_Core_Error
::deprecatedFunctionWarning('CRM_Report_Form::joinAddressFromContact');
4627 // include address field if address column is to be included
4628 if ((isset($this->_addressField
) &&
4629 $this->_addressField
4631 $this->isTableSelected('civicrm_address')
4634 LEFT JOIN civicrm_address {$this->_aliases['civicrm_address']}
4635 ON ({$this->_aliases['civicrm_contact']}.id =
4636 {$this->_aliases['civicrm_address']}.contact_id) AND
4637 {$this->_aliases['civicrm_address']}.is_primary = 1\n";
4642 * Add Phone into From Table if required.
4644 * @deprecated use joinPhoneFromContact
4645 * (left here in case extensions use it).
4647 public function addPhoneFromClause() {
4648 CRM_Core_Error
::deprecatedFunctionWarning('CRM_Report_Form::joinPhoneFromContact');
4649 // include address field if address column is to be included
4650 if ($this->isTableSelected('civicrm_phone')) {
4652 LEFT JOIN civicrm_phone {$this->_aliases['civicrm_phone']}
4653 ON ({$this->_aliases['civicrm_contact']}.id =
4654 {$this->_aliases['civicrm_phone']}.contact_id) AND
4655 {$this->_aliases['civicrm_phone']}.is_primary = 1\n";
4660 * Add Address into From Table if required.
4662 * Prefix will be added to both tables as
4663 * it is assumed you are using it to get address of a secondary contact.
4665 * @param string $prefix
4666 * @param array $extra Additional options.
4667 * Not currently used in core but may be used in override extensions.
4669 protected function joinAddressFromContact($prefix = '', $extra = array()) {
4670 $addressTables = ['civicrm_address', 'civicrm_country', 'civicrm_worldregion', 'civicrm_state_province'];
4671 $isJoinRequired = $this->_addressField
;
4672 foreach ($addressTables as $addressTable) {
4673 if ($this->isTableSelected($prefix . $addressTable)) {
4674 $isJoinRequired = TRUE;
4677 if ($isJoinRequired) {
4679 LEFT JOIN civicrm_address {$this->_aliases[$prefix . 'civicrm_address']}
4680 ON ({$this->_aliases[$prefix . 'civicrm_contact']}.id =
4681 {$this->_aliases[$prefix . 'civicrm_address']}.contact_id) AND
4682 {$this->_aliases[$prefix . 'civicrm_address']}.is_primary = 1\n";
4687 * Add Country into From Table if required.
4689 * Prefix will be added to both tables as
4690 * it is assumed you are using it to get address of a secondary contact.
4692 * @param string $prefix
4693 * @param array $extra Additional options.
4694 * Not currently used in core but may be used in override extensions.
4696 protected function joinCountryFromAddress($prefix = '', $extra = array()) {
4697 // include country field if country column is to be included
4698 if ($this->isTableSelected($prefix . 'civicrm_country') ||
$this->isTableSelected($prefix . 'civicrm_worldregion')) {
4699 if (empty($this->_aliases
[$prefix . 'civicrm_country'])) {
4700 $this->_aliases
[$prefix . 'civicrm_country'] = $prefix . '_report_country';
4703 LEFT JOIN civicrm_country {$this->_aliases[$prefix . 'civicrm_country']}
4704 ON {$this->_aliases[$prefix . 'civicrm_address']}.country_id = {$this->_aliases[$prefix . 'civicrm_country']}.id AND
4705 {$this->_aliases[$prefix . 'civicrm_address']}.is_primary = 1 ";
4710 * Add Phone into From Table if required.
4712 * Prefix will be added to both tables as
4713 * it is assumed you are using it to get address of a secondary contact.
4715 * @param string $prefix
4716 * @param array $extra Additional options.
4717 * Not currently used in core but may be used in override extensions.
4719 protected function joinPhoneFromContact($prefix = '', $extra = array()) {
4720 // include phone field if phone column is to be included
4721 if ($this->isTableSelected($prefix . 'civicrm_phone')) {
4723 LEFT JOIN civicrm_phone {$this->_aliases[$prefix . 'civicrm_phone']}
4724 ON {$this->_aliases[$prefix . 'civicrm_contact']}.id = {$this->_aliases[$prefix . 'civicrm_phone']}.contact_id AND
4725 {$this->_aliases[$prefix . 'civicrm_phone']}.is_primary = 1\n";
4730 * Add Email into From Table if required.
4732 * Prefix will be added to both tables as
4733 * it is assumed you are using it to get address of a secondary contact.
4735 * @param string $prefix
4736 * @param array $extra Additional options.
4737 * Not currently used in core but may be used in override extensions.
4739 protected function joinEmailFromContact($prefix = '', $extra = array()) {
4740 // include email field if email column is to be included
4741 if ($this->isTableSelected($prefix . 'civicrm_email')) {
4743 LEFT JOIN civicrm_email {$this->_aliases[$prefix . 'civicrm_email']}
4744 ON ({$this->_aliases[$prefix . 'civicrm_contact']}.id = {$this->_aliases[$prefix . 'civicrm_email']}.contact_id AND
4745 {$this->_aliases[$prefix . 'civicrm_email']}.is_primary = 1) ";
4750 * Add Financial Transaction into From Table if required.
4752 public function addFinancialTrxnFromClause() {
4753 if ($this->isTableSelected('civicrm_financial_trxn')) {
4755 LEFT JOIN civicrm_entity_financial_trxn eftcc
4756 ON ({$this->_aliases['civicrm_contribution']}.id = eftcc.entity_id AND
4757 eftcc.entity_table = 'civicrm_contribution')
4758 LEFT JOIN civicrm_financial_trxn {$this->_aliases['civicrm_financial_trxn']}
4759 ON {$this->_aliases['civicrm_financial_trxn']}.id = eftcc.financial_trxn_id \n";
4764 * Get phone columns to add to array.
4766 * @param array $options
4767 * - prefix Prefix to add to table (in case of more than one instance of the table)
4768 * - prefix_label Label to give columns from this phone table instance
4771 * phone columns definition
4773 public function getPhoneColumns($options = array()) {
4774 $defaultOptions = array(
4776 'prefix_label' => '',
4779 $options = array_merge($defaultOptions, $options);
4782 $options['prefix'] . 'civicrm_phone' => array(
4783 'dao' => 'CRM_Core_DAO_Phone',
4785 $options['prefix'] . 'phone' => array(
4786 'title' => $options['prefix_label'] . ts('Phone'),
4796 * Get a standard set of contact fields.
4797 * @deprecated - use getColumns('Contact') instead
4800 public function getBasicContactFields() {
4802 'sort_name' => array(
4803 'title' => ts('Contact Name'),
4808 'no_display' => TRUE,
4811 'prefix_id' => array(
4812 'title' => ts('Contact Prefix'),
4814 'first_name' => array(
4815 'title' => ts('First Name'),
4817 'nick_name' => array(
4818 'title' => ts('Nick Name'),
4820 'middle_name' => array(
4821 'title' => ts('Middle Name'),
4823 'last_name' => array(
4824 'title' => ts('Last Name'),
4826 'suffix_id' => array(
4827 'title' => ts('Contact Suffix'),
4829 'postal_greeting_display' => array('title' => ts('Postal Greeting')),
4830 'email_greeting_display' => array('title' => ts('Email Greeting')),
4831 'addressee_display' => array('title' => ts('Addressee')),
4832 'contact_type' => array(
4833 'title' => ts('Contact Type'),
4835 'contact_sub_type' => array(
4836 'title' => ts('Contact Subtype'),
4838 'gender_id' => array(
4839 'title' => ts('Gender'),
4841 'birth_date' => array(
4842 'title' => ts('Birth Date'),
4845 'title' => ts('Age'),
4846 'dbAlias' => 'TIMESTAMPDIFF(YEAR, contact_civireport.birth_date, CURDATE())',
4848 'job_title' => array(
4849 'title' => ts('Contact Job title'),
4851 'organization_name' => array(
4852 'title' => ts('Organization Name'),
4854 'external_identifier' => array(
4855 'title' => ts('Contact identifier from external system'),
4857 'do_not_email' => array(),
4858 'do_not_phone' => array(),
4859 'do_not_mail' => array(),
4860 'do_not_sms' => array(),
4861 'is_opt_out' => array(),
4862 'is_deceased' => array(),
4863 'preferred_language' => array(),
4864 'employer_id' => array(
4865 'title' => ts('Current Employer'),
4871 * Get a standard set of contact filters.
4873 * @param array $defaults
4877 public function getBasicContactFilters($defaults = array()) {
4879 'sort_name' => array(
4880 'title' => ts('Contact Name'),
4883 'title' => ts('Contact Source'),
4884 'type' => CRM_Utils_Type
::T_STRING
,
4887 'title' => ts('Contact ID'),
4888 'no_display' => TRUE,
4890 'gender_id' => array(
4891 'title' => ts('Gender'),
4892 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
4893 'options' => CRM_Core_PseudoConstant
::get('CRM_Contact_DAO_Contact', 'gender_id'),
4895 'birth_date' => array(
4896 'title' => ts('Birth Date'),
4897 'operatorType' => CRM_Report_Form
::OP_DATE
,
4899 'contact_type' => array(
4900 'title' => ts('Contact Type'),
4902 'contact_sub_type' => array(
4903 'title' => ts('Contact Subtype'),
4905 'modified_date' => array(
4906 'title' => ts('Contact Modified'),
4907 'operatorType' => CRM_Report_Form
::OP_DATE
,
4908 'type' => CRM_Utils_Type
::T_DATE
,
4910 'is_deceased' => array(
4911 'title' => ts('Deceased'),
4912 'type' => CRM_Utils_Type
::T_BOOLEAN
,
4913 'default' => CRM_Utils_Array
::value('deceased', $defaults, 0),
4915 'do_not_email' => array(
4916 'title' => ts('Do not email'),
4917 'type' => CRM_Utils_Type
::T_BOOLEAN
,
4919 'do_not_phone' => array(
4920 'title' => ts('Do not phone'),
4921 'type' => CRM_Utils_Type
::T_BOOLEAN
,
4923 'do_not_mail' => array(
4924 'title' => ts('Do not mail'),
4925 'type' => CRM_Utils_Type
::T_BOOLEAN
,
4927 'do_not_sms' => array(
4928 'title' => ts('Do not SMS'),
4929 'type' => CRM_Utils_Type
::T_BOOLEAN
,
4931 'is_opt_out' => array(
4932 'title' => ts('Do not bulk email'),
4933 'type' => CRM_Utils_Type
::T_BOOLEAN
,
4935 'preferred_language' => array(
4936 'title' => ts('Preferred Language'),
4938 'is_deleted' => array(
4939 'no_display' => TRUE,
4941 'type' => CRM_Utils_Type
::T_BOOLEAN
,
4947 * Add contact to group.
4949 * @param int $groupID
4951 public function add2group($groupID) {
4952 if (is_numeric($groupID) && isset($this->_aliases
['civicrm_contact'])) {
4953 $select = "SELECT DISTINCT {$this->_aliases['civicrm_contact']}.id AS addtogroup_contact_id, ";
4954 $select = preg_replace('/SELECT(\s+SQL_CALC_FOUND_ROWS)?\s+/i', $select, $this->_select
);
4955 $sql = "{$select} {$this->_from} {$this->_where} {$this->_groupBy} {$this->_having} {$this->_orderBy}";
4956 $sql = str_replace('WITH ROLLUP', '', $sql);
4957 $dao = CRM_Core_DAO
::executeQuery($sql);
4959 $contact_ids = array();
4960 // Add resulting contacts to group
4961 while ($dao->fetch()) {
4962 if ($dao->addtogroup_contact_id
) {
4963 $contact_ids[$dao->addtogroup_contact_id
] = $dao->addtogroup_contact_id
;
4967 if (!empty($contact_ids)) {
4968 CRM_Contact_BAO_GroupContact
::addContactsToGroup($contact_ids, $groupID);
4969 CRM_Core_Session
::setStatus(ts("Listed contact(s) have been added to the selected group."), ts('Contacts Added'), 'success');
4972 CRM_Core_Session
::setStatus(ts("The listed records(s) cannot be added to the group."));
4978 * Show charts on print screen.
4980 public static function uploadChartImage() {
4981 // upload strictly for '.png' images
4982 $name = trim(basename(CRM_Utils_Request
::retrieve('name', 'String', CRM_Core_DAO
::$_nullObject, FALSE, NULL, 'GET')));
4983 if (preg_match('/\.png$/', $name)) {
4985 // Get the RAW .png from the input.
4986 $httpRawPostData = file_get_contents("php://input");
4988 // prepare the directory
4989 $config = CRM_Core_Config
::singleton();
4991 = str_replace('/persist/contribute/', '/persist/', $config->imageUploadDir
) .
4993 if (!file_exists($defaultPath)) {
4994 mkdir($defaultPath, 0777, TRUE);
4997 // full path to the saved image including filename
4998 $destination = $defaultPath . $name;
5001 $jfh = fopen($destination, 'w') or die("can't open file");
5002 fwrite($jfh, $httpRawPostData);
5004 CRM_Utils_System
::civiExit();
5009 * Apply common settings to entityRef fields.
5011 * @param array $field
5012 * @param string $table
5014 public function setEntityRefDefaults(&$field, $table) {
5015 $field['attributes'] = $field['attributes'] ?
$field['attributes'] : array();
5016 $field['attributes'] +
= array(
5017 'entity' => CRM_Core_DAO_AllCoreTables
::getBriefName(CRM_Core_DAO_AllCoreTables
::getClassForTable($table)),
5019 'placeholder' => ts('- select -'),
5024 * Add link fields to the row.
5026 * Function adds the _link & _hover fields to the row.
5029 * @param string $baseUrl
5030 * @param string $linkText
5031 * @param string $value
5032 * @param string $fieldName
5033 * @param string $tablePrefix
5034 * @param string $fieldLabel
5038 protected function addLinkToRow(&$row, $baseUrl, $linkText, $value, $fieldName, $tablePrefix, $fieldLabel) {
5039 $criteriaQueryParams = CRM_Report_Utils_Report
::getPreviewCriteriaQueryParams($this->_defaults
, $this->_params
);
5040 $url = CRM_Report_Utils_Report
::getNextUrl($baseUrl,
5041 "reset=1&force=1&{$criteriaQueryParams}&" .
5042 $fieldName . "_op=in&{$fieldName}_value={$value}",
5043 $this->_absoluteUrl
, $this->_id
5045 $row["{$tablePrefix}_{$fieldName}_link"] = $url;
5046 $row["{$tablePrefix}_{$fieldName}_hover"] = ts("%1 for this %2.",
5047 array(1 => $linkText, 2 => $fieldLabel)
5052 * Get label for show results buttons.
5056 public function getResultsLabel() {
5057 $showResultsLabel = $this->resultsDisplayed() ?
ts('Refresh results') : ts('View results');
5058 return $showResultsLabel;
5062 * Determine the output mode from the url or input.
5065 * - pdf : Render as pdf
5066 * - csv : Render as csv
5067 * - print : Render in print format
5068 * - save : save the report and display the new report
5069 * - copy : save the report as a new instance and display that.
5070 * - group : go to the add to group screen.
5072 * Potentially chart variations could also be included but the complexity
5073 * is that we might print a bar chart as a pdf.
5075 protected function setOutputMode() {
5076 $this->_outputMode
= str_replace('report_instance.', '', CRM_Utils_Request
::retrieve(
5079 CRM_Core_DAO
::$_nullObject,
5081 CRM_Utils_Array
::value('task', $this->_params
)
5083 // if contacts are added to group
5084 if (!empty($this->_params
['groups']) && empty($this->_outputMode
)) {
5085 $this->_outputMode
= 'group';
5087 if (isset($this->_params
['task'])) {
5088 unset($this->_params
['task']);
5093 * CRM-17793 - Alter DateTime section header to group by date from the datetime field.
5096 * @param $columnName
5098 public function alterSectionHeaderForDateTime($tempTable, $columnName) {
5099 // add new column with date value for the datetime field
5100 $tempQuery = "ALTER TABLE {$tempTable} ADD COLUMN {$columnName}_date VARCHAR(128)";
5101 CRM_Core_DAO
::executeQuery($tempQuery);
5102 $updateQuery = "UPDATE {$tempTable} SET {$columnName}_date = date({$columnName})";
5103 CRM_Core_DAO
::executeQuery($updateQuery);
5104 $this->_selectClauses
[] = "{$columnName}_date";
5105 $this->_select
.= ", {$columnName}_date";
5106 $this->_sections
["{$columnName}_date"] = $this->_sections
["{$columnName}"];
5107 unset($this->_sections
["{$columnName}"]);
5108 $this->assign('sections', $this->_sections
);
5112 * Get an array of the columns that have been selected for display.
5116 public function getSelectColumns() {
5117 $selectColumns = array();
5118 foreach ($this->_columns
as $tableName => $table) {
5119 if (array_key_exists('fields', $table)) {
5120 foreach ($table['fields'] as $fieldName => $field) {
5121 if (!empty($field['required']) ||
5122 !empty($this->_params
['fields'][$fieldName])
5125 $selectColumns["{$tableName}_{$fieldName}"] = 1;
5130 return $selectColumns;
5134 * Add location tables to the query if they are used for filtering.
5136 * This is for when we are running the query separately for filtering and retrieving display fields.
5138 public function selectivelyAddLocationTablesJoinsToFilterQuery() {
5139 if ($this->isTableFiltered('civicrm_email')) {
5141 LEFT JOIN civicrm_email {$this->_aliases['civicrm_email']}
5142 ON {$this->_aliases['civicrm_contact']}.id = {$this->_aliases['civicrm_email']}.contact_id
5143 AND {$this->_aliases['civicrm_email']}.is_primary = 1";
5145 if ($this->isTableFiltered('civicrm_phone')) {
5147 LEFT JOIN civicrm_phone {$this->_aliases['civicrm_phone']}
5148 ON {$this->_aliases['civicrm_contact']}.id = {$this->_aliases['civicrm_phone']}.contact_id
5149 AND {$this->_aliases['civicrm_phone']}.is_primary = 1";
5151 if ($this->isTableFiltered('civicrm_address')) {
5153 LEFT JOIN civicrm_address {$this->_aliases['civicrm_address']}
5154 ON ({$this->_aliases['civicrm_contact']}.id = {$this->_aliases['civicrm_address']}.contact_id)
5155 AND {$this->_aliases['civicrm_address']}.is_primary = 1\n";
5160 * Set the base table for the FROM clause.
5162 * Sets up the from clause, allowing for the possibility it might be a
5163 * temp table pre-filtered by groups if a group filter is in use.
5165 * @param string $baseTable
5166 * @param string $field
5167 * @param null $tableAlias
5169 public function setFromBase($baseTable, $field = 'id', $tableAlias = NULL) {
5171 $tableAlias = $this->_aliases
[$baseTable];
5173 $this->_from
= $this->_from
= " FROM $baseTable $tableAlias ";
5174 $this->joinGroupTempTable($baseTable, $field, $tableAlias);
5175 $this->_from
.= " {$this->_aclFrom} ";
5179 * Join the temp table contacting contacts who are members of the filtered groups.
5181 * If we are using an IN filter we use an inner join, otherwise a left join.
5183 * @param string $baseTable
5184 * @param string $field
5185 * @param string $tableAlias
5187 public function joinGroupTempTable($baseTable, $field, $tableAlias) {
5188 if ($this->groupTempTable
) {
5189 if ($this->_params
['gid_op'] == 'in') {
5190 $this->_from
= " FROM $this->groupTempTable group_temp_table INNER JOIN $baseTable $tableAlias
5191 ON group_temp_table.id = $tableAlias.{$field} ";
5195 LEFT JOIN $this->groupTempTable group_temp_table
5196 ON $tableAlias.{$field} = group_temp_table.id ";
5202 * Get all labels for fields that are used in a group concat.
5204 * @param string $options
5205 * comma separated option values.
5206 * @param string $baoName
5207 * The BAO name for the field.
5208 * @param string $fieldName
5209 * The name of the field for which labels should be retrieved.
5213 public function getLabels($options, $baoName, $fieldName) {
5214 $types = explode(',', $options);
5216 foreach ($types as $value) {
5217 $labels[$value] = CRM_Core_PseudoConstant
::getLabel($baoName, $fieldName, $value);
5219 return implode(', ', array_filter($labels));
5223 * Add statistics columns.
5225 * If a group by is in play then add columns for the statistics fields.
5227 * This would lead to a new field in the $row such as $fieldName_sum and a new, matching
5228 * column header field.
5230 * @param array $field
5231 * @param string $tableName
5232 * @param string $fieldName
5233 * @param array $select
5237 protected function addStatisticsToSelect($field, $tableName, $fieldName, $select) {
5238 foreach ($field['statistics'] as $stat => $label) {
5239 $alias = "{$tableName}_{$fieldName}_{$stat}";
5240 switch (strtolower($stat)) {
5243 $select[] = "$stat({$field['dbAlias']}) as $alias";
5244 $this->_columnHeaders
["{$tableName}_{$fieldName}_{$stat}"]['title'] = $label;
5245 $this->_columnHeaders
["{$tableName}_{$fieldName}_{$stat}"]['type'] = $field['type'];
5246 $this->_statFields
[$label] = $alias;
5247 $this->_selectAliases
[] = $alias;
5251 $select[] = "COUNT({$field['dbAlias']}) as $alias";
5252 $this->_columnHeaders
["{$tableName}_{$fieldName}_{$stat}"]['title'] = $label;
5253 $this->_columnHeaders
["{$tableName}_{$fieldName}_{$stat}"]['type'] = CRM_Utils_Type
::T_INT
;
5254 $this->_statFields
[$label] = $alias;
5255 $this->_selectAliases
[] = $alias;
5258 case 'count_distinct':
5259 $select[] = "COUNT(DISTINCT {$field['dbAlias']}) as $alias";
5260 $this->_columnHeaders
["{$tableName}_{$fieldName}_{$stat}"]['title'] = $label;
5261 $this->_columnHeaders
["{$tableName}_{$fieldName}_{$stat}"]['type'] = CRM_Utils_Type
::T_INT
;
5262 $this->_statFields
[$label] = $alias;
5263 $this->_selectAliases
[] = $alias;
5267 $select[] = "ROUND(AVG({$field['dbAlias']}),2) as $alias";
5268 $this->_columnHeaders
["{$tableName}_{$fieldName}_{$stat}"]['title'] = $label;
5269 $this->_columnHeaders
["{$tableName}_{$fieldName}_{$stat}"]['type'] = $field['type'];
5270 $this->_statFields
[$label] = $alias;
5271 $this->_selectAliases
[] = $alias;
5279 * Add a basic field to the select clause.
5281 * @param string $tableName
5282 * @param string $fieldName
5283 * @param array $field
5284 * @param string $select
5287 protected function addBasicFieldToSelect($tableName, $fieldName, $field, $select) {
5288 $alias = "{$tableName}_{$fieldName}";
5289 $select[] = "{$field['dbAlias']} as $alias";
5290 $this->_columnHeaders
["{$tableName}_{$fieldName}"]['title'] = CRM_Utils_Array
::value('title', $field);
5291 $this->_columnHeaders
["{$tableName}_{$fieldName}"]['type'] = CRM_Utils_Array
::value('type', $field);
5292 $this->_selectAliases
[] = $alias;
5299 * @param array $table
5300 * @param string $tableName
5305 protected function setTableAlias($table, $tableName) {
5306 if (!isset($table['alias'])) {
5307 $this->_columns
[$tableName]['alias'] = substr($tableName, 8) .
5311 $this->_columns
[$tableName]['alias'] = $table['alias'] . '_civireport';
5314 $this->_aliases
[$tableName] = $this->_columns
[$tableName]['alias'];
5315 return $this->_aliases
[$tableName];
5319 * Function to add columns to reports.
5321 * This is ported from extended reports, which also adds join filters to the options.
5323 * @param string $type
5324 * @param array $options
5325 * - prefix - A string to prepend to the table name
5326 * - prefix_label A string to prepend to the fields
5327 * - fields (bool) - should the fields for this table be made available
5328 * - group_by (bool) - should the group bys for this table be made available.
5329 * - order_by (bool) - should the group bys for this table be made available.
5330 * - filters (bool) - should the filters for this table by made available.
5331 * - fields_defaults (array) array of fields that should be displayed by default.
5332 * - filters_defaults (array) array of fields that should be filtered by default.
5333 * - join_filters (array) fields available for filtering joins (requires additional custom code).
5334 * - join_fields (array) fields available from join (requires additional custom code).
5335 * - group_by_defaults (array) array of group bys that should be applied by default.
5336 * - order_by_defaults (array) array of order bys that should be applied by default.
5337 * - custom_fields (array) array of entity types for custom fields (not usually required).
5338 * - contact_type (string) optional restriction on contact type for some tables.
5339 * - fields_excluded (array) fields that are in the generic set for the table but not in the report.
5343 protected function getColumns($type, $options = array()) {
5344 $defaultOptions = array(
5346 'prefix_label' => '',
5348 'group_bys' => FALSE,
5349 'order_bys' => TRUE,
5351 'join_filters' => FALSE,
5352 'fields_defaults' => array(),
5353 'filters_defaults' => array(),
5354 'group_bys_defaults' => array(),
5355 'order_bys_defaults' => array(),
5357 $options = array_merge($defaultOptions, $options);
5359 $fn = 'get' . $type . 'Columns';
5360 return $this->$fn($options);
5364 * Get columns for contact table.
5366 * @param array $options
5370 protected function getContactColumns($options = array()) {
5371 $defaultOptions = array(
5372 'custom_fields' => array('Individual', 'Contact', 'Organization'),
5373 'fields_defaults' => array('display_name', 'id'),
5374 'order_bys_defaults' => array('sort_name ASC'),
5375 'contact_type' => NULL,
5378 $options = array_merge($defaultOptions, $options);
5380 $tableAlias = $options['prefix'] . 'contact';
5383 $options['prefix'] . 'display_name' => array(
5384 'name' => 'display_name',
5385 'title' => $options['prefix_label'] . ts('Contact Name'),
5386 'is_fields' => TRUE,
5388 $options['prefix'] . 'sort_name' => array(
5389 'name' => 'sort_name',
5390 'title' => $options['prefix_label'] . ts('Contact Name (in sort format)'),
5391 'is_fields' => TRUE,
5392 'is_filters' => TRUE,
5393 'is_order_bys' => TRUE,
5395 $options['prefix'] . 'id' => array(
5397 'title' => $options['prefix_label'] . ts('Contact ID'),
5398 'alter_display' => 'alterContactID',
5399 'type' => CRM_Utils_Type
::T_INT
,
5400 'is_order_bys' => TRUE,
5401 'is_group_bys' => TRUE,
5402 'is_fields' => TRUE,
5403 'is_filters' => TRUE,
5405 $options['prefix'] . 'external_identifier' => array(
5406 'name' => 'external_identifier',
5407 'title' => $options['prefix_label'] . ts('External ID'),
5408 'type' => CRM_Utils_Type
::T_INT
,
5409 'is_fields' => TRUE,
5411 $options['prefix'] . 'contact_type' => array(
5412 'title' => $options['prefix_label'] . ts('Contact Type'),
5413 'name' => 'contact_type',
5414 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
5415 'options' => CRM_Contact_BAO_Contact
::buildOptions('contact_type'),
5416 'is_fields' => TRUE,
5417 'is_filters' => TRUE,
5418 'is_group_bys' => TRUE,
5420 $options['prefix'] . 'contact_sub_type' => array(
5421 'title' => $options['prefix_label'] . ts('Contact Sub Type'),
5422 'name' => 'contact_sub_type',
5423 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
5424 'options' => CRM_Contact_BAO_Contact
::buildOptions('contact_sub_type'),
5425 'is_fields' => TRUE,
5426 'is_filters' => TRUE,
5427 'is_group_bys' => TRUE,
5429 $options['prefix'] . 'is_deleted' => array(
5430 'title' => $options['prefix_label'] . ts('Is deleted'),
5431 'name' => 'is_deleted',
5432 'type' => CRM_Utils_Type
::T_BOOLEAN
,
5433 'is_fields' => FALSE,
5434 'is_filters' => TRUE,
5435 'is_group_bys' => FALSE,
5437 $options['prefix'] . 'external_identifier' => array(
5438 'title' => $options['prefix_label'] . ts('Contact identifier from external system'),
5439 'name' => 'external_identifier',
5440 'is_fields' => TRUE,
5441 'is_filters' => FALSE,
5442 'is_group_bys' => FALSE,
5443 'is_order_bys' => TRUE,
5445 $options['prefix'] . 'preferred_language' => array(
5446 'title' => $options['prefix_label'] . ts('Preferred Language'),
5447 'name' => 'preferred_language',
5448 'is_fields' => TRUE,
5449 'is_filters' => TRUE,
5450 'is_group_bys' => TRUE,
5451 'is_order_bys' => TRUE,
5455 'postal_greeting_display' => 'Postal Greeting',
5456 'email_greeting_display' => 'Email Greeting',
5457 'addressee_display' => 'Addressee',
5458 ] as $field => $title) {
5459 $spec[$options['prefix'] . $field] = array(
5460 'title' => $options['prefix_label'] . ts($title),
5462 'is_fields' => TRUE,
5463 'is_filters' => FALSE,
5464 'is_group_bys' => FALSE,
5467 foreach (['do_not_email', 'do_not_phone', 'do_not_mail', 'do_not_sms', 'is_opt_out'] as $field) {
5468 $spec[$options['prefix'] . $field] = [
5470 'type' => CRM_Utils_Type
::T_BOOLEAN
,
5471 'is_fields' => TRUE,
5472 'is_filters' => TRUE,
5473 'is_group_bys' => FALSE,
5476 $individualFields = array(
5477 $options['prefix'] . 'first_name' => array(
5478 'name' => 'first_name',
5479 'title' => $options['prefix_label'] . ts('First Name'),
5480 'is_fields' => TRUE,
5481 'is_filters' => TRUE,
5482 'is_order_bys' => TRUE,
5484 $options['prefix'] . 'middle_name' => array(
5485 'name' => 'middle_name',
5486 'title' => $options['prefix_label'] . ts('Middle Name'),
5487 'is_fields' => TRUE,
5489 $options['prefix'] . 'last_name' => array(
5490 'name' => 'last_name',
5491 'title' => $options['prefix_label'] . ts('Last Name'),
5492 'default_order' => 'ASC',
5493 'is_fields' => TRUE,
5495 $options['prefix'] . 'nick_name' => array(
5496 'name' => 'nick_name',
5497 'title' => $options['prefix_label'] . ts('Nick Name'),
5498 'is_fields' => TRUE,
5500 $options['prefix'] . 'prefix_id' => array(
5501 'name' => 'prefix_id',
5502 'title' => $options['prefix_label'] . ts('Prefix'),
5503 'options' => CRM_Contact_BAO_Contact
::buildOptions('prefix_id'),
5504 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
5505 'is_fields' => TRUE,
5506 'is_filters' => TRUE,
5508 $options['prefix'] . 'suffix_id' => array(
5509 'name' => 'suffix_id',
5510 'title' => $options['prefix_label'] . ts('Suffix'),
5511 'options' => CRM_Contact_BAO_Contact
::buildOptions('suffix_id'),
5512 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
5513 'is_fields' => TRUE,
5514 'is_filters' => TRUE,
5516 $options['prefix'] . 'gender_id' => array(
5517 'name' => 'gender_id',
5518 'title' => $options['prefix_label'] . ts('Gender'),
5519 'options' => CRM_Contact_BAO_Contact
::buildOptions('gender_id'),
5520 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
5521 'is_fields' => TRUE,
5522 'is_filters' => TRUE,
5524 'birth_date' => array(
5525 'title' => $options['prefix_label'] . ts('Birth Date'),
5526 'operatorType' => CRM_Report_Form
::OP_DATE
,
5527 'type' => CRM_Utils_Type
::T_DATE
,
5528 'is_fields' => TRUE,
5529 'is_filters' => TRUE,
5532 'title' => $options['prefix_label'] . ts('Age'),
5533 'dbAlias' => 'TIMESTAMPDIFF(YEAR, ' . $tableAlias . '_civireport.birth_date, CURDATE())',
5534 'type' => CRM_Utils_Type
::T_INT
,
5535 'is_fields' => TRUE,
5537 $options['prefix'] . 'is_deceased' => array(
5538 'title' => $options['prefix_label'] . ts('Is deceased'),
5539 'name' => 'is_deceased',
5540 'type' => CRM_Utils_Type
::T_BOOLEAN
,
5541 'is_fields' => FALSE,
5542 'is_filters' => TRUE,
5543 'is_group_bys' => FALSE,
5545 $options['prefix'] . 'job_title' => array(
5546 'name' => 'job_title',
5547 'is_fields' => TRUE,
5548 'is_filters' => FALSE,
5549 'is_group_bys' => FALSE,
5551 $options['prefix'] . 'employer_id' => array(
5552 'title' => $options['prefix_label'] . ts('Current Employer'),
5553 'type' => CRM_Utils_Type
::T_INT
,
5554 'name' => 'employer_id',
5555 'is_fields' => TRUE,
5556 'is_filters' => FALSE,
5557 'is_group_bys' => TRUE,
5560 if (!$options['contact_type'] ||
$options['contact_type'] === 'Individual') {
5561 $spec = array_merge($spec, $individualFields);
5564 if (!empty($options['custom_fields'])) {
5565 $this->_customGroupExtended
[$options['prefix'] . 'civicrm_contact'] = array(
5566 'extends' => $options['custom_fields'],
5567 'title' => $options['prefix_label'],
5568 'filters' => $options['filters'],
5569 'prefix' => $options['prefix'],
5570 'prefix_label' => $options['prefix_label'],
5574 return $this->buildColumns($spec, $options['prefix'] . 'civicrm_contact', 'CRM_Contact_DAO_Contact', $tableAlias, $this->getDefaultsFromOptions($options), $options);
5578 * Get address columns to add to array.
5580 * @param array $options
5581 * - prefix Prefix to add to table (in case of more than one instance of the table)
5582 * - prefix_label Label to give columns from this address table instance
5583 * - group_bys enable these fields for group by - default false
5584 * - order_bys enable these fields for order by
5585 * - filters enable these fields for filtering
5587 * @return array address columns definition
5589 protected function getAddressColumns($options = array()) {
5590 $defaultOptions = array(
5592 'prefix_label' => '',
5594 'group_bys' => FALSE,
5595 'order_bys' => TRUE,
5597 'join_filters' => FALSE,
5598 'fields_defaults' => array(),
5599 'filters_defaults' => array(),
5600 'group_bys_defaults' => array(),
5601 'order_bys_defaults' => array(),
5604 $options = array_merge($defaultOptions, $options);
5605 $defaults = $this->getDefaultsFromOptions($options);
5606 $tableAlias = $options['prefix'] . 'address';
5609 $options['prefix'] . 'name' => array(
5610 'title' => ts($options['prefix_label'] . 'Address Name'),
5612 'is_fields' => TRUE,
5614 $options['prefix'] . 'street_number' => array(
5615 'name' => 'street_number',
5616 'title' => ts($options['prefix_label'] . 'Street Number'),
5618 'is_fields' => TRUE,
5620 $options['prefix'] . 'odd_street_number' => array(
5621 'title' => ts('Odd / Even Street Number'),
5622 'name' => 'odd_street_number',
5623 'type' => CRM_Utils_Type
::T_INT
,
5624 'no_display' => TRUE,
5626 'dbAlias' => '(address_civireport.street_number % 2)',
5627 'is_fields' => TRUE,
5628 'is_order_bys' => TRUE,
5630 $options['prefix'] . 'street_name' => array(
5631 'name' => 'street_name',
5632 'title' => ts($options['prefix_label'] . 'Street Name'),
5634 'is_fields' => TRUE,
5635 'is_filters' => TRUE,
5636 'operator' => 'like',
5637 'is_order_bys' => TRUE,
5639 $options['prefix'] . 'street_address' => array(
5640 'title' => ts($options['prefix_label'] . 'Street Address'),
5641 'name' => 'street_address',
5642 'is_fields' => TRUE,
5643 'is_filters' => TRUE,
5644 'is_group_bys' => TRUE,
5646 $options['prefix'] . 'supplemental_address_1' => array(
5647 'title' => ts($options['prefix_label'] . 'Supplementary Address Field 1'),
5648 'name' => 'supplemental_address_1',
5649 'is_fields' => TRUE,
5651 $options['prefix'] . 'supplemental_address_2' => array(
5652 'title' => ts($options['prefix_label'] . 'Supplementary Address Field 2'),
5653 'name' => 'supplemental_address_2',
5654 'is_fields' => TRUE,
5656 $options['prefix'] . 'supplemental_address_3' => array(
5657 'title' => ts($options['prefix_label'] . 'Supplementary Address Field 3'),
5658 'name' => 'supplemental_address_3',
5659 'is_fields' => TRUE,
5661 $options['prefix'] . 'street_number' => array(
5662 'name' => 'street_number',
5663 'title' => ts($options['prefix_label'] . 'Street Number'),
5665 'is_order_bys' => TRUE,
5666 'is_filters' => TRUE,
5667 'is_fields' => TRUE,
5669 $options['prefix'] . 'street_unit' => array(
5670 'name' => 'street_unit',
5671 'title' => ts($options['prefix_label'] . 'Street Unit'),
5673 'is_fields' => TRUE,
5675 $options['prefix'] . 'city' => array(
5676 'title' => ts($options['prefix_label'] . 'City'),
5678 'operator' => 'like',
5679 'is_fields' => TRUE,
5680 'is_filters' => TRUE,
5681 'is_group_bys' => TRUE,
5682 'is_order_bys' => TRUE,
5684 $options['prefix'] . 'postal_code' => array(
5685 'title' => ts($options['prefix_label'] . 'Postal Code'),
5686 'name' => 'postal_code',
5688 'is_fields' => TRUE,
5689 'is_filters' => TRUE,
5690 'is_group_bys' => TRUE,
5691 'is_order_bys' => TRUE,
5693 $options['prefix'] . 'postal_code_suffix' => array(
5694 'title' => ts($options['prefix_label'] . 'Postal Code Suffix'),
5695 'name' => 'postal_code',
5697 'is_fields' => TRUE,
5698 'is_filters' => TRUE,
5699 'is_group_bys' => TRUE,
5700 'is_order_bys' => TRUE,
5702 $options['prefix'] . 'county_id' => array(
5703 'title' => ts($options['prefix_label'] . 'County'),
5704 'alter_display' => 'alterCountyID',
5705 'name' => 'county_id',
5706 'type' => CRM_Utils_Type
::T_INT
,
5707 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
5708 'options' => CRM_Core_PseudoConstant
::county(),
5709 'is_fields' => TRUE,
5710 'is_filters' => TRUE,
5711 'is_group_bys' => TRUE,
5713 $options['prefix'] . 'state_province_id' => array(
5714 'title' => ts($options['prefix_label'] . 'State/Province'),
5715 'alter_display' => 'alterStateProvinceID',
5716 'name' => 'state_province_id',
5717 'type' => CRM_Utils_Type
::T_INT
,
5718 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
5719 'options' => CRM_Core_PseudoConstant
::stateProvince(),
5720 'is_fields' => TRUE,
5721 'is_filters' => TRUE,
5722 'is_group_bys' => TRUE,
5724 $options['prefix'] . 'country_id' => array(
5725 'title' => ts($options['prefix_label'] . 'Country'),
5726 'alter_display' => 'alterCountryID',
5727 'name' => 'country_id',
5728 'is_fields' => TRUE,
5729 'is_filters' => TRUE,
5730 'is_group_bys' => TRUE,
5731 'type' => CRM_Utils_Type
::T_INT
,
5732 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
5733 'options' => CRM_Core_PseudoConstant
::country(),
5735 $options['prefix'] . 'location_type_id' => array(
5736 'name' => 'is_primary',
5737 'title' => ts($options['prefix_label'] . 'Location Type'),
5738 'type' => CRM_Utils_Type
::T_INT
,
5739 'is_fields' => TRUE,
5740 'alter_display' => 'alterLocationTypeID',
5742 $options['prefix'] . 'id' => array(
5743 'title' => ts($options['prefix_label'] . 'ID'),
5745 'is_fields' => TRUE,
5747 $options['prefix'] . 'is_primary' => array(
5748 'name' => 'is_primary',
5749 'title' => ts($options['prefix_label'] . 'Primary Address?'),
5750 'type' => CRM_Utils_Type
::T_BOOLEAN
,
5751 'is_fields' => TRUE,
5754 return $this->buildColumns($spec, $options['prefix'] . 'civicrm_address', 'CRM_Core_DAO_Address', $tableAlias, $defaults, $options);
5758 * Build the columns.
5760 * The normal report class needs you to remember to do a few things that are often erratic
5762 * 1) use a unique key for any field that might not be unique (e.g. start date, label)
5763 * - this class will prepend an alias to the key & set the 'name' if you don't set it yourself.
5764 * You can suppress the alias with 'no_field_disambiguation' if transitioning existing reports. This
5765 * means any saved filters / fields on saved report instances. This will mean that matching names from
5766 * different tables may be ambigious, but it will smooth any code transition.
5767 * - note that it assumes the value being passed in is the actual table field name
5769 * 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
5770 * contexts - the code looks up the fields array for data - so it both defines the field spec & the fields you want to show
5772 * 3) this function also sets the 'metadata' array - the extended report class now uses this in place
5773 * of the fields array to reduce the issues caused when metadata is needed but 'fields' are not defined. Code in
5774 * the core classes can start to move towards that.
5776 * @param array $specs
5777 * @param string $tableName
5778 * @param string $daoName
5779 * @param string $tableAlias
5780 * @param array $defaults
5781 * @param array $options
5785 protected function buildColumns($specs, $tableName, $daoName = NULL, $tableAlias = NULL, $defaults = array(), $options = array()) {
5787 $tableAlias = str_replace('civicrm_', '', $tableName);
5789 $types = array('filters', 'group_bys', 'order_bys', 'join_filters');
5790 $columns = array($tableName => array_fill_keys($types, array()));
5791 // The code that uses this no longer cares if it is a DAO or BAO so just call it a DAO.
5792 $columns[$tableName]['dao'] = $daoName;
5793 $columns[$tableName]['alias'] = $tableAlias;
5795 foreach ($specs as $specName => $spec) {
5796 if (empty($spec['name'])) {
5797 $spec['name'] = $specName;
5800 $fieldAlias = (empty($options['no_field_disambiguation']) ?
$tableAlias . '_' : '') . $specName;
5801 $columns[$tableName]['metadata'][$fieldAlias] = $spec;
5802 $columns[$tableName]['fields'][$fieldAlias] = $spec;
5803 if (isset($defaults['fields_defaults']) && in_array($spec['name'], $defaults['fields_defaults'])) {
5804 $columns[$tableName]['fields'][$fieldAlias]['default'] = TRUE;
5807 if (!$spec['is_fields'] ||
(isset($options['fields_excluded']) && in_array($specName, $options['fields_excluded']))) {
5808 $columns[$tableName]['fields'][$fieldAlias]['no_display'] = TRUE;
5811 if (isset($options['fields_required']) && in_array($specName, $options['fields_required'])) {
5812 $columns[$tableName]['fields'][$fieldAlias]['required'] = TRUE;
5815 foreach ($types as $type) {
5816 if ($options[$type] && !empty($spec['is_' . $type])) {
5817 $columns[$tableName][$type][$fieldAlias] = $spec;
5818 if (isset($defaults[$type . '_defaults']) && isset($defaults[$type . '_defaults'][$spec['name']])) {
5819 $columns[$tableName][$type][$fieldAlias]['default'] = $defaults[$type . '_defaults'][$spec['name']];
5828 * Store group bys into array - so we can check elsewhere what is grouped.
5830 protected function storeGroupByArray() {
5832 if (!CRM_Utils_Array
::value('group_bys', $this->_params
)
5833 ||
!is_array($this->_params
['group_bys'])) {
5834 $this->_params
['group_bys'] = [];
5837 foreach ($this->_columns
as $tableName => $table) {
5838 $table = $this->_columns
[$tableName];
5839 if (array_key_exists('group_bys', $table)) {
5840 foreach ($table['group_bys'] as $fieldName => $fieldData) {
5841 $field = $this->_columns
[$tableName]['metadata'][$fieldName];
5842 if (!empty($this->_params
['group_bys'][$fieldName]) ||
!empty($fieldData['required'])) {
5843 if (!empty($field['chart'])) {
5844 $this->assign('chartSupported', TRUE);
5847 if (!empty($table['group_bys'][$fieldName]['frequency']) &&
5848 !empty($this->_params
['group_bys_freq'][$fieldName])
5851 switch ($this->_params
['group_bys_freq'][$fieldName]) {
5853 $this->_groupByArray
[$tableName . '_' . $fieldName . '_start'] = self
::fiscalYearOffset($field['dbAlias']);
5856 $this->_groupByArray
[$tableName . '_' . $fieldName . '_start'] = " {$this->_params['group_bys_freq'][$fieldName]}({$field['dbAlias']})";
5859 $this->_groupByArray
[$tableName . '_' . $fieldName . '_start'] = "EXTRACT(YEAR_{$this->_params['group_bys_freq'][$fieldName]} FROM {$field['dbAlias']})";
5864 if (!in_array($field['dbAlias'], $this->_groupByArray
)) {
5865 $this->_groupByArray
[$tableName . '_' . $fieldName] = $field['dbAlias'];
5880 protected function getDefaultsFromOptions($options) {
5882 'fields_defaults' => $options['fields_defaults'],
5883 'filters_defaults' => $options['filters_defaults'],
5884 'group_bys_defaults' => $options['group_bys_defaults'],
5885 'order_bys_defaults' => $options['order_bys_defaults'],
5891 * Get the select clause for a field, wrapping in GROUP_CONCAT if appropriate.
5893 * Full group by mode dictates that a field must either be in the group by function or
5894 * wrapped in a aggregate function. Here we wrap the field in GROUP_CONCAT if it is not in the
5897 * @param string $tableName
5898 * @param string $fieldName
5899 * @param string $field
5902 protected function getSelectClauseWithGroupConcatIfNotGroupedBy($tableName, &$fieldName, &$field) {
5903 if ($this->groupConcatTested
&& (!empty($this->_groupByArray
) ||
$this->isForceGroupBy
)) {
5904 if ((empty($field['statistics']) ||
in_array('GROUP_CONCAT', $field['statistics']))) {
5905 $label = CRM_Utils_Array
::value('title', $field);
5906 $alias = "{$tableName}_{$fieldName}";
5907 $this->_columnHeaders
["{$tableName}_{$fieldName}"]['title'] = $label;
5908 $this->_selectAliases
[] = $alias;
5909 if (empty($this->_groupByArray
[$tableName . '_' . $fieldName])) {
5910 return "GROUP_CONCAT(DISTINCT {$field['dbAlias']}) as $alias";
5912 return "({$field['dbAlias']}) as $alias";
5918 * Generate clause for the selected filter.
5920 * @param array $field
5921 * Field specification
5922 * @param string $fieldName
5926 * Relevant where clause.
5928 protected function generateFilterClause($field, $fieldName) {
5929 if (CRM_Utils_Array
::value('type', $field) & CRM_Utils_Type
::T_DATE
) {
5930 if (CRM_Utils_Array
::value('operatorType', $field) ==
5931 CRM_Report_Form
::OP_MONTH
5933 $op = CRM_Utils_Array
::value("{$fieldName}_op", $this->_params
);
5934 $value = CRM_Utils_Array
::value("{$fieldName}_value", $this->_params
);
5935 if (is_array($value) && !empty($value)) {
5936 return "(month({$field['dbAlias']}) $op (" . implode(', ', $value) .
5941 $relative = CRM_Utils_Array
::value("{$fieldName}_relative", $this->_params
);
5942 $from = CRM_Utils_Array
::value("{$fieldName}_from", $this->_params
);
5943 $to = CRM_Utils_Array
::value("{$fieldName}_to", $this->_params
);
5944 $fromTime = CRM_Utils_Array
::value("{$fieldName}_from_time", $this->_params
);
5945 $toTime = CRM_Utils_Array
::value("{$fieldName}_to_time", $this->_params
);
5946 return $this->dateClause($field['dbAlias'], $relative, $from, $to, $field['type'], $fromTime, $toTime);
5950 $op = CRM_Utils_Array
::value("{$fieldName}_op", $this->_params
);
5952 return $this->whereClause($field,
5954 CRM_Utils_Array
::value("{$fieldName}_value", $this->_params
),
5955 CRM_Utils_Array
::value("{$fieldName}_min", $this->_params
),
5956 CRM_Utils_Array
::value("{$fieldName}_max", $this->_params
)