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
1153 public function createTemporaryTable($identifier, $sql) {
1154 $tempTable = CRM_Utils_SQL_TempTable
::build()->setUtf8(TRUE)->createWithQuery($sql);
1155 $name = $tempTable->getName();
1156 // Developers may force tables to be durable to assist in debugging so lets check.
1157 $isNotTrueTemporary = $tempTable->isDurable();
1158 // The TempTable build routine adds the next line - we output it to help developers see what has happened.
1159 $sql = 'CREATE ' . ($isNotTrueTemporary ?
'' : 'TEMPORARY ') . "TABLE $name DEFAULT CHARACTER SET utf8 COLLATE utf8_unicode_ci " . $sql;
1160 $this->addToDeveloperTab($sql);
1161 $this->temporaryTables
[$identifier] = ['temporary' => !$isNotTrueTemporary, 'name' => $name];
1166 * Add columns to report.
1168 public function addColumns() {
1171 foreach ($this->_columns
as $tableName => $table) {
1172 if (array_key_exists('fields', $table)) {
1173 foreach ($table['fields'] as $fieldName => $field) {
1175 if (empty($field['no_display'])) {
1176 foreach (array('table', 'field') as $var) {
1177 if (!empty($
{$var}['grouping'])) {
1178 if (!is_array($
{$var}['grouping'])) {
1179 $tableName = $
{$var}['grouping'];
1182 $tableName = array_keys($
{$var}['grouping']);
1183 $tableName = $tableName[0];
1184 $groupTitle = array_values($
{$var}['grouping']);
1185 $groupTitle = $groupTitle[0];
1190 if (!$groupTitle && isset($table['group_title'])) {
1191 $groupTitle = $table['group_title'];
1192 // Having a group_title is secret code for being a custom group
1193 // which cryptically translates to needing an accordion.
1194 // here we make that explicit.
1195 $colGroups[$tableName]['use_accordian_for_field_selection'] = TRUE;
1198 $colGroups[$tableName]['fields'][$fieldName] = CRM_Utils_Array
::value('title', $field);
1199 if ($groupTitle && empty($colGroups[$tableName]['group_title'])) {
1200 $colGroups[$tableName]['group_title'] = $groupTitle;
1202 $options[$fieldName] = CRM_Utils_Array
::value('title', $field);
1208 $this->addCheckBox("fields", ts('Select Columns'), $options, NULL,
1209 NULL, NULL, NULL, $this->_fourColumnAttribute
, TRUE
1211 if (!empty($colGroups)) {
1212 $this->tabs
['FieldSelection'] = array(
1213 'title' => ts('Columns'),
1214 'tpl' => 'FieldSelection',
1215 'div_label' => 'col-groups',
1218 // Note this assignment is only really required in buildForm. It is being 'over-called'
1219 // to reduce risk of being missed due to overridden functions.
1220 $this->assign('tabs', $this->tabs
);
1223 $this->assign('colGroups', $colGroups);
1227 * Add filters to report.
1229 public function addFilters() {
1230 $filters = $filterGroups = array();
1233 foreach ($this->_filters
as $table => $attributes) {
1234 if (isset($this->_columns
[$table]['group_title'])) {
1235 // The presence of 'group_title' is secret code for 'is_a_custom_table'
1236 // which magically means to 'display in an accordian'
1237 // here we make this explicit.
1238 $filterGroups[$table] = array(
1239 'group_title' => $this->_columns
[$table]['group_title'],
1240 'use_accordian_for_field_selection' => TRUE,
1244 foreach ($attributes as $fieldName => $field) {
1245 // get ready with option value pair
1246 // @ 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
1248 $operations = $this->getOperationPair(
1249 CRM_Utils_Array
::value('operatorType', $field),
1252 $filters[$table][$fieldName] = $field;
1254 switch (CRM_Utils_Array
::value('operatorType', $field)) {
1255 case CRM_Report_Form
::OP_MONTH
:
1256 if (!array_key_exists('options', $field) ||
1257 !is_array($field['options']) ||
empty($field['options'])
1259 // If there's no option list for this filter, define one.
1260 $field['options'] = array(
1262 2 => ts('February'),
1269 9 => ts('September'),
1270 10 => ts('October'),
1271 11 => ts('November'),
1272 12 => ts('December'),
1274 // Add this option list to this column _columns. This is
1275 // required so that filter statistics show properly.
1276 $this->_columns
[$table]['filters'][$fieldName]['options'] = $field['options'];
1278 case CRM_Report_Form
::OP_MULTISELECT
:
1279 case CRM_Report_Form
::OP_MULTISELECT_SEPARATOR
:
1280 // assume a multi-select field
1281 if (!empty($field['options']) ||
1282 $fieldName == 'state_province_id' ||
$fieldName == 'county_id'
1284 $element = $this->addElement('select', "{$fieldName}_op", ts('Operator:'), $operations);
1285 if (count($operations) <= 1) {
1288 if ($fieldName == 'state_province_id' ||
1289 $fieldName == 'county_id'
1291 $this->addChainSelect($fieldName . '_value', array(
1298 $this->addElement('select', "{$fieldName}_value", NULL, $field['options'], array(
1299 'style' => 'min-width:250px',
1300 'class' => 'crm-select2 huge',
1302 'placeholder' => ts('- select -'),
1308 case CRM_Report_Form
::OP_SELECT
:
1309 // assume a select field
1310 $this->addElement('select', "{$fieldName}_op", ts('Operator:'), $operations);
1311 if (!empty($field['options'])) {
1312 $this->addElement('select', "{$fieldName}_value", NULL, $field['options']);
1316 case CRM_Report_Form
::OP_ENTITYREF
:
1317 $this->addElement('select', "{$fieldName}_op", ts('Operator:'), $operations);
1318 $this->setEntityRefDefaults($field, $table);
1319 $this->addEntityRef("{$fieldName}_value", NULL, $field['attributes']);
1322 case CRM_Report_Form
::OP_DATE
:
1323 // build datetime fields
1324 CRM_Core_Form_Date
::buildDateRange($this, $fieldName, $count, '_from', '_to', ts('From:'), FALSE, $operations);
1328 case CRM_Report_Form
::OP_DATETIME
:
1329 // build datetime fields
1330 CRM_Core_Form_Date
::buildDateRange($this, $fieldName, $count, '_from', '_to', ts('From:'), FALSE, $operations, 'searchDate', TRUE);
1334 case CRM_Report_Form
::OP_INT
:
1335 case CRM_Report_Form
::OP_FLOAT
:
1336 // and a min value input box
1337 $this->add('text', "{$fieldName}_min", ts('Min'));
1338 // and a max value input box
1339 $this->add('text', "{$fieldName}_max", ts('Max'));
1341 // default type is string
1342 $this->addElement('select', "{$fieldName}_op", ts('Operator:'), $operations,
1343 array('onchange' => "return showHideMaxMinVal( '$fieldName', this.value );")
1345 // we need text box for value input
1346 $this->add('text', "{$fieldName}_value", NULL, array('class' => 'huge'));
1351 if (!empty($filters)) {
1352 $this->tabs
['Filters'] = array(
1353 'title' => ts('Filters'),
1355 'div_label' => 'set-filters',
1358 $this->assign('filters', $filters);
1359 $this->assign('filterGroups', $filterGroups);
1363 * Function to assign the tabs to the template in the correct order.
1365 * We want the tabs to wind up in this order (if not overridden).
1373 protected function assignTabs() {
1381 $order = array_intersect_key(array_fill_keys($order, 1), $this->tabs
);
1382 $order = array_merge($order, $this->tabs
);
1383 $this->assign('tabs', $order);
1387 * The intent is to add a tab for developers to view the sql.
1389 * Currently using dpm.
1391 * @param string $sql
1393 public function addToDeveloperTab($sql) {
1394 if (!CRM_Core_Permission
::check('view report sql')) {
1397 $ignored_output_modes = array('pdf', 'csv', 'print');
1398 if (in_array($this->_outputMode
, $ignored_output_modes)) {
1401 $this->tabs
['Developer'] = array(
1402 'title' => ts('Developer'),
1403 'tpl' => 'Developer',
1404 'div_label' => 'set-developer',
1407 $this->assignTabs();
1408 $this->sqlArray
[] = $sql;
1409 foreach ($this->sqlArray
as $sql) {
1410 foreach (array('LEFT JOIN') as $term) {
1411 $sql = str_replace($term, '<br> ' . $term, $sql);
1413 foreach (array('FROM', 'WHERE', 'GROUP BY', 'ORDER BY', 'LIMIT', ';') as $term) {
1414 $sql = str_replace($term, '<br><br>' . $term, $sql);
1416 $this->sqlFormattedArray
[] = $sql;
1417 $this->assign('sql', implode(';<br><br><br><br>', $this->sqlFormattedArray
));
1419 $this->assign('sqlModes', $sqlModes = CRM_Utils_SQL
::getSqlModes());
1424 * Add options defined in $this->_options to the report.
1426 public function addOptions() {
1427 if (!empty($this->_options
)) {
1428 // FIXME: For now lets build all elements as checkboxes.
1429 // Once we clear with the format we can build elements based on type
1431 foreach ($this->_options
as $fieldName => $field) {
1434 if ($field['type'] == 'select') {
1435 $this->addElement('select', "{$fieldName}", $field['title'], $field['options']);
1437 elseif ($field['type'] == 'checkbox') {
1438 $options[$field['title']] = $fieldName;
1439 $this->addCheckBox($fieldName, NULL,
1441 NULL, NULL, NULL, $this->_fourColumnAttribute
1446 if (!empty($this->_options
) &&
1448 ||
($this->_id
&& CRM_Report_BAO_ReportInstance
::contactCanAdministerReport($this->_id
)))
1450 $this->tabs
['ReportOptions'] = array(
1451 'title' => ts('Display Options'),
1452 'tpl' => 'ReportOptions',
1453 'div_label' => 'other-options',
1456 $this->assign('otherOptions', $this->_options
);
1460 * Add chart options to the report.
1462 public function addChartOptions() {
1463 if (!empty($this->_charts
)) {
1464 $this->addElement('select', "charts", ts('Chart'), $this->_charts
);
1465 $this->assign('charts', $this->_charts
);
1466 $this->addElement('submit', $this->_chartButtonName
, ts('View'));
1471 * Add group by options to the report.
1473 public function addGroupBys() {
1474 $options = $freqElements = array();
1476 foreach ($this->_columns
as $tableName => $table) {
1477 if (array_key_exists('group_bys', $table)) {
1478 foreach ($table['group_bys'] as $fieldName => $field) {
1479 if (!empty($field) && empty($field['no_display'])) {
1480 $options[$field['title']] = $fieldName;
1481 if (!empty($field['frequency'])) {
1482 $freqElements[$field['title']] = $fieldName;
1488 $this->addCheckBox("group_bys", ts('Group by columns'), $options, NULL,
1489 NULL, NULL, NULL, $this->_fourColumnAttribute
1491 $this->assign('groupByElements', $options);
1492 if (!empty($options)) {
1493 $this->tabs
['GroupBy'] = array(
1494 'title' => ts('Grouping'),
1496 'div_label' => 'group-by-elements',
1500 foreach ($freqElements as $name) {
1501 $this->addElement('select', "group_bys_freq[$name]",
1502 ts('Frequency'), $this->_groupByDateFreq
1508 * Add data for order by tab.
1510 public function addOrderBys() {
1512 foreach ($this->_columns
as $tableName => $table) {
1514 // Report developer may define any column to order by; include these as order-by options.
1515 if (array_key_exists('order_bys', $table)) {
1516 foreach ($table['order_bys'] as $fieldName => $field) {
1517 if (!empty($field)) {
1518 $options[$fieldName] = $field['title'];
1523 // Add searchable custom fields as order-by options, if so requested
1524 // (These are already indexed, so allowing to order on them is cheap.)
1526 if ($this->_autoIncludeIndexedFieldsAsOrderBys
&&
1527 array_key_exists('extends', $table) && !empty($table['extends'])
1529 foreach ($table['fields'] as $fieldName => $field) {
1530 if (empty($field['no_display'])) {
1531 $options[$fieldName] = $field['title'];
1539 $this->assign('orderByOptions', $options);
1540 if (!empty($options)) {
1541 $this->tabs
['OrderBy'] = array(
1542 'title' => ts('Sorting'),
1544 'div_label' => 'order-by-elements',
1548 if (!empty($options)) {
1550 '-' => ' - none - ',
1552 for ($i = 1; $i <= 5; $i++
) {
1553 $this->addElement('select', "order_bys[{$i}][column]", ts('Order by Column'), $options);
1554 $this->addElement('select', "order_bys[{$i}][order]", ts('Order by Order'), array(
1555 'ASC' => ts('Ascending'),
1556 'DESC' => ts('Descending'),
1558 $this->addElement('checkbox', "order_bys[{$i}][section]", ts('Order by Section'), FALSE, array('id' => "order_by_section_$i"));
1559 $this->addElement('checkbox', "order_bys[{$i}][pageBreak]", ts('Page Break'), FALSE, array('id' => "order_by_pagebreak_$i"));
1565 * This adds the tab referred to as Title and Format, rendered through Instance.tpl.
1567 * @todo call this tab into the report template in the same way as OrderBy etc, ie
1568 * by adding a description of the tab to $this->tabs, causing the tab to be added in
1571 public function buildInstanceAndButtons() {
1572 CRM_Report_Form_Instance
::buildForm($this);
1573 $this->_actionButtonName
= $this->getButtonName('submit');
1574 $this->addTaskMenu($this->getActions($this->_id
));
1576 $this->assign('instanceForm', $this->_instanceForm
);
1578 // CRM-16274 Determine if user has 'edit all contacts' or equivalent
1579 $permission = CRM_Core_Permission
::getPermission();
1580 if ($permission == CRM_Core_Permission
::EDIT
&&
1581 $this->_add2groupSupported
1583 $this->addElement('select', 'groups', ts('Group'),
1584 array('' => ts('Add Contacts to Group')) +
1585 CRM_Core_PseudoConstant
::nestedGroup(),
1586 array('class' => 'crm-select2 crm-action-menu fa-plus huge')
1588 $this->assign('group', TRUE);
1591 $this->addElement('submit', $this->_groupButtonName
, '', array('style' => 'display: none;'));
1593 $this->addChartOptions();
1594 $showResultsLabel = $this->getResultsLabel();
1595 $this->addButtons(array(
1598 'name' => $showResultsLabel,
1599 'isDefault' => TRUE,
1606 * Has this form been submitted already?
1610 public function resultsDisplayed() {
1611 $buttonName = $this->controller
->getButtonName();
1612 return ($buttonName ||
$this->_outputMode
);
1616 * Get the actions for this report instance.
1618 * @param int $instanceId
1622 protected function getActions($instanceId) {
1623 $actions = CRM_Report_BAO_ReportInstance
::getActionMetadata();
1624 if (empty($instanceId)) {
1625 $actions['report_instance.save'] = array(
1626 'title' => ts('Create Report'),
1628 'is_confirm' => TRUE,
1629 'confirm_title' => ts('Create Report'),
1630 'confirm_refresh_fields' => json_encode(array(
1631 'title' => array('selector' => '.crm-report-instanceForm-form-block-title', 'prepend' => ''),
1632 'description' => array('selector' => '.crm-report-instanceForm-form-block-description', 'prepend' => ''),
1636 unset($actions['report_instance.delete']);
1639 if (!$this->_csvSupported
) {
1640 unset($actions['report_instance.csv']);
1647 * Main build form function.
1649 public function buildQuickForm() {
1650 $this->addColumns();
1652 $this->addFilters();
1654 $this->addOptions();
1656 $this->addGroupBys();
1658 $this->addOrderBys();
1660 $this->buildInstanceAndButtons();
1662 // Add form rule for report.
1663 if (is_callable(array(
1667 $this->addFormRule(array(get_class($this), 'formRule'), $this);
1669 $this->assignTabs();
1673 * A form rule function for custom data.
1675 * The rule ensures that fields selected in group_by if any) should only be the ones
1676 * present in display/select fields criteria;
1677 * note: works if and only if any custom field selected in group_by.
1679 * @param array $fields
1680 * @param array $ignoreFields
1684 public function customDataFormRule($fields, $ignoreFields = array()) {
1686 if (!empty($this->_customGroupExtends
) && $this->_customGroupGroupBy
&&
1687 !empty($fields['group_bys'])
1689 foreach ($this->_columns
as $tableName => $table) {
1690 if ((substr($tableName, 0, 13) == 'civicrm_value' ||
1691 substr($tableName, 0, 12) == 'custom_value') &&
1692 !empty($this->_columns
[$tableName]['fields'])
1694 foreach ($this->_columns
[$tableName]['fields'] as $fieldName => $field) {
1695 if (array_key_exists($fieldName, $fields['group_bys']) &&
1696 !array_key_exists($fieldName, $fields['fields'])
1698 $errors['fields'] = "Please make sure fields selected in 'Group by Columns' section are also selected in 'Display Columns' section.";
1700 elseif (array_key_exists($fieldName, $fields['group_bys'])) {
1701 foreach ($fields['fields'] as $fld => $val) {
1702 if (!array_key_exists($fld, $fields['group_bys']) &&
1703 !in_array($fld, $ignoreFields)
1705 $errors['fields'] = "Please ensure that fields selected in 'Display Columns' are also selected in 'Group by Columns' section.";
1717 * Get operators to display on form.
1719 * Note: $fieldName param allows inheriting class to build operationPairs specific to a field.
1721 * @param string $type
1722 * @param string $fieldName
1726 public function getOperationPair($type = "string", $fieldName = NULL) {
1727 // FIXME: At some point we should move these key-val pairs
1728 // to option_group and option_value table.
1730 case CRM_Report_Form
::OP_INT
:
1731 case CRM_Report_Form
::OP_FLOAT
:
1734 'lte' => ts('Is less than or equal to'),
1735 'gte' => ts('Is greater than or equal to'),
1736 'bw' => ts('Is between'),
1737 'eq' => ts('Is equal to'),
1738 'lt' => ts('Is less than'),
1739 'gt' => ts('Is greater than'),
1740 'neq' => ts('Is not equal to'),
1741 'nbw' => ts('Is not between'),
1742 'nll' => ts('Is empty (Null)'),
1743 'nnll' => ts('Is not empty (Null)'),
1747 case CRM_Report_Form
::OP_SELECT
:
1749 'eq' => ts('Is equal to'),
1753 case CRM_Report_Form
::OP_MONTH
:
1754 case CRM_Report_Form
::OP_MULTISELECT
:
1755 case CRM_Report_Form
::OP_ENTITYREF
:
1758 'in' => ts('Is one of'),
1759 'notin' => ts('Is not one of'),
1763 case CRM_Report_Form
::OP_DATE
:
1766 'nll' => ts('Is empty (Null)'),
1767 'nnll' => ts('Is not empty (Null)'),
1771 case CRM_Report_Form
::OP_MULTISELECT_SEPARATOR
:
1772 // use this operator for the values, concatenated with separator. For e.g if
1773 // multiple options for a column is stored as ^A{val1}^A{val2}^A
1775 'mhas' => ts('Is one of'),
1776 'mnot' => ts('Is not one of'),
1783 'has' => ts('Contains'),
1784 'sw' => ts('Starts with'),
1785 'ew' => ts('Ends with'),
1786 'nhas' => ts('Does not contain'),
1787 'eq' => ts('Is equal to'),
1788 'neq' => ts('Is not equal to'),
1789 'nll' => ts('Is empty (Null)'),
1790 'nnll' => ts('Is not empty (Null)'),
1797 * Build the tag filter field to display on the filters tab.
1799 public function buildTagFilter() {
1800 $contactTags = CRM_Core_BAO_Tag
::getTags($this->_tagFilterTable
);
1801 if (!empty($contactTags)) {
1802 $this->_columns
['civicrm_tag'] = array(
1803 'dao' => 'CRM_Core_DAO_Tag',
1807 'title' => ts('Tag'),
1808 'type' => CRM_Utils_Type
::T_INT
,
1810 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
1811 'options' => $contactTags,
1819 * Adds group filters to _columns (called from _Construct).
1821 public function buildGroupFilter() {
1822 $this->_columns
['civicrm_group']['filters'] = array(
1824 'name' => 'group_id',
1825 'title' => ts('Group'),
1826 'type' => CRM_Utils_Type
::T_INT
,
1827 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
1829 'options' => CRM_Core_PseudoConstant
::nestedGroup(),
1832 if (empty($this->_columns
['civicrm_group']['dao'])) {
1833 $this->_columns
['civicrm_group']['dao'] = 'CRM_Contact_DAO_GroupContact';
1835 if (empty($this->_columns
['civicrm_group']['alias'])) {
1836 $this->_columns
['civicrm_group']['alias'] = 'cgroup';
1841 * Get SQL operator from form text version.
1843 * @param string $operator
1847 public function getSQLOperator($operator = "like") {
1848 switch ($operator) {
1881 return 'IS NOT NULL';
1890 * Generate where clause.
1892 * This can be overridden in reports for special treatment of a field
1894 * @param array $field Field specifications
1895 * @param string $op Query operator (not an exact match to sql)
1896 * @param mixed $value
1900 * @return null|string
1902 public function whereClause(&$field, $op, $value, $min, $max) {
1904 $type = CRM_Utils_Type
::typeToString(CRM_Utils_Array
::value('type', $field));
1906 // CRM-18010: Ensure type of each report filters
1908 trigger_error('Type is not defined for field ' . $field['name'], E_USER_WARNING
);
1915 if (($min !== NULL && strlen($min) > 0) ||
1916 ($max !== NULL && strlen($max) > 0)
1920 $min = CRM_Utils_Type
::escape($min, $type);
1922 $clauses[] = "( {$field['dbAlias']} >= $min )";
1925 $clauses[] = "( {$field['dbAlias']} < $min OR {$field['dbAlias']} IS NULL )";
1929 $max = CRM_Utils_Type
::escape($max, $type);
1931 $clauses[] = "( {$field['dbAlias']} <= $max )";
1934 $clauses[] = "( {$field['dbAlias']} > $max )";
1938 if (!empty($clauses)) {
1940 $clause = implode(' AND ', $clauses);
1943 $clause = '(' . implode('OR', $clauses) . ')';
1951 if ($value !== NULL && strlen($value) > 0) {
1952 $value = CRM_Utils_Type
::escape($value, $type);
1953 if (strpos($value, '%') === FALSE) {
1954 $value = "'%{$value}%'";
1957 $value = "'{$value}'";
1959 $sqlOP = $this->getSQLOperator($op);
1960 $clause = "( {$field['dbAlias']} $sqlOP $value )";
1966 if ((is_string($value) ||
is_numeric($value)) && strlen($value)) {
1967 $value = explode(',', $value);
1969 if ($value !== NULL && is_array($value) && count($value) > 0) {
1970 $sqlOP = $this->getSQLOperator($op);
1971 if (CRM_Utils_Array
::value('type', $field) ==
1972 CRM_Utils_Type
::T_STRING
1974 //cycle through selections and escape values
1975 foreach ($value as $key => $selection) {
1976 $value[$key] = CRM_Utils_Type
::escape($selection, $type);
1979 = "( {$field['dbAlias']} $sqlOP ( '" . implode("' , '", $value) .
1983 // for numerical values
1984 $clause = "{$field['dbAlias']} $sqlOP (" . implode(', ', $value) .
1987 if ($op == 'notin') {
1988 $clause = "( " . $clause . " OR {$field['dbAlias']} IS NULL )";
1991 $clause = "( " . $clause . " )";
1998 // multiple has or multiple not
1999 if ($value !== NULL && count($value) > 0) {
2000 $value = CRM_Utils_Type
::escapeAll($value, $type);
2001 $operator = $op == 'mnot' ?
'NOT' : '';
2002 $regexp = "([[:cntrl:]]|^)" . implode('([[:cntrl:]]|$)|([[:cntrl:]]|^)', (array) $value) . "([[:cntrl:]]|$)";
2003 $clause = "{$field['dbAlias']} {$operator} REGEXP '{$regexp}'";
2009 if ($value !== NULL && strlen($value) > 0) {
2010 $value = CRM_Utils_Type
::escape($value, $type);
2011 if (strpos($value, '%') === FALSE) {
2013 $value = "'{$value}%'";
2016 $value = "'%{$value}'";
2020 $value = "'{$value}'";
2022 $sqlOP = $this->getSQLOperator($op);
2023 $clause = "( {$field['dbAlias']} $sqlOP $value )";
2029 $sqlOP = $this->getSQLOperator($op);
2030 $clause = "( {$field['dbAlias']} $sqlOP )";
2036 //CRM-18457: some custom field passes value in array format against binary operator
2037 if (is_array($value) && count($value)) {
2042 if ($value !== NULL && $value !== '') {
2043 if (isset($field['clause'])) {
2044 // FIXME: we not doing escape here. Better solution is to use two
2045 // different types - data-type and filter-type
2046 $clause = $field['clause'];
2048 elseif (!is_array($value)) {
2049 $value = CRM_Utils_Type
::escape($value, $type);
2050 $sqlOP = $this->getSQLOperator($op);
2051 if ($field['type'] == CRM_Utils_Type
::T_STRING
) {
2052 $value = "'{$value}'";
2054 $clause = "( {$field['dbAlias']} $sqlOP $value )";
2060 if (!empty($field['group']) && $clause) {
2061 $clause = $this->whereGroupClause($field, $value, $op);
2063 elseif (!empty($field['tag']) && $clause) {
2064 // not using left join in query because if any contact
2065 // belongs to more than one tag, results duplicate
2067 $clause = $this->whereTagClause($field, $value, $op);
2069 elseif (!empty($field['membership_org']) && $clause) {
2070 $clause = $this->whereMembershipOrgClause($value, $op);
2072 elseif (!empty($field['membership_type']) && $clause) {
2073 $clause = $this->whereMembershipTypeClause($value, $op);
2079 * Get SQL where clause for a date field.
2081 * @param string $fieldName
2082 * @param string $relative
2083 * @param string $from
2085 * @param string $type
2086 * @param string $fromTime
2087 * @param string $toTime
2089 * @return null|string
2091 public function dateClause(
2093 $relative, $from, $to, $type = NULL, $fromTime = NULL, $toTime = NULL
2096 if (in_array($relative, array_keys($this->getOperationPair(CRM_Report_Form
::OP_DATE
)))) {
2097 $sqlOP = $this->getSQLOperator($relative);
2098 return "( {$fieldName} {$sqlOP} )";
2101 list($from, $to) = $this->getFromTo($relative, $from, $to, $fromTime, $toTime);
2104 $from = ($type == CRM_Utils_Type
::T_DATE
) ?
substr($from, 0, 8) : $from;
2105 $clauses[] = "( {$fieldName} >= $from )";
2109 $to = ($type == CRM_Utils_Type
::T_DATE
) ?
substr($to, 0, 8) : $to;
2110 $clauses[] = "( {$fieldName} <= {$to} )";
2113 if (!empty($clauses)) {
2114 return implode(' AND ', $clauses);
2121 * Get values for from and to for date ranges.
2125 * @param bool $relative
2126 * @param string $from
2128 * @param string $fromTime
2129 * @param string $toTime
2133 public function getFromTo($relative, $from, $to, $fromTime = NULL, $toTime = NULL) {
2134 if (empty($toTime)) {
2135 // odd legacy behaviour to treat NULL as 'end of the day'
2136 // recommend updating reports to call CRM_Utils_Date::getFromTo
2137 //directly (default on the function is the actual default there).
2140 return CRM_Utils_Date
::getFromTo($relative, $from, $to, $fromTime, $toTime);
2144 * Alter display of rows.
2146 * Iterate through the rows retrieved via SQL and make changes for display purposes,
2147 * such as rendering contacts as links.
2149 * @param array $rows
2150 * Rows generated by SQL, with an array for each row.
2152 public function alterDisplay(&$rows) {
2156 * Alter the way in which custom data fields are displayed.
2158 * @param array $rows
2160 public function alterCustomDataDisplay(&$rows) {
2161 // custom code to alter rows having custom values
2162 if (empty($this->_customGroupExtends
)) {
2166 $customFields = array();
2167 $customFieldIds = array();
2168 foreach ($this->_params
['fields'] as $fieldAlias => $value) {
2169 if ($fieldId = CRM_Core_BAO_CustomField
::getKeyID($fieldAlias)) {
2170 $customFieldIds[$fieldAlias] = $fieldId;
2173 if (empty($customFieldIds)) {
2177 // skip for type date and ContactReference since date format is already handled
2179 SELECT cg.table_name, cf.id
2180 FROM civicrm_custom_field cf
2181 INNER JOIN civicrm_custom_group cg ON cg.id = cf.custom_group_id
2182 WHERE cg.extends IN ('" . implode("','", $this->_customGroupExtends
) . "') AND
2183 cg.is_active = 1 AND
2184 cf.is_active = 1 AND
2185 cf.is_searchable = 1 AND
2186 cf.data_type NOT IN ('ContactReference', 'Date') AND
2187 cf.id IN (" . implode(",", $customFieldIds) . ")";
2189 $dao = CRM_Core_DAO
::executeQuery($query);
2190 while ($dao->fetch()) {
2191 $customFields[$dao->table_name
. '_custom_' . $dao->id
] = $dao->id
;
2195 $entryFound = FALSE;
2196 foreach ($rows as $rowNum => $row) {
2197 foreach ($row as $tableCol => $val) {
2198 if (array_key_exists($tableCol, $customFields)) {
2199 $rows[$rowNum][$tableCol] = CRM_Core_BAO_CustomField
::displayValue($val, $customFields[$tableCol]);
2204 // skip looking further in rows, if first row itself doesn't
2205 // have the column we need
2213 * Remove duplicate rows.
2215 * @param array $rows
2217 public function removeDuplicates(&$rows) {
2218 if (empty($this->_noRepeats
)) {
2221 $checkList = array();
2223 foreach ($rows as $key => $list) {
2224 foreach ($list as $colName => $colVal) {
2225 if (array_key_exists($colName, $checkList) &&
2226 $checkList[$colName] == $colVal
2228 $rows[$key][$colName] = "";
2230 if (in_array($colName, $this->_noRepeats
)) {
2231 $checkList[$colName] = $colVal;
2238 * Fix subtotal display.
2241 * @param array $fields
2242 * @param bool $subtotal
2244 public function fixSubTotalDisplay(&$row, $fields, $subtotal = TRUE) {
2245 foreach ($row as $colName => $colVal) {
2246 if (in_array($colName, $fields)) {
2248 elseif (isset($this->_columnHeaders
[$colName])) {
2250 $row[$colName] = 'Subtotal';
2254 unset($row[$colName]);
2261 * Calculate grant total.
2263 * @param array $rows
2267 public function grandTotal(&$rows) {
2268 if (!$this->_rollup ||
count($rows) == 1) {
2272 $this->moveSummaryColumnsToTheRightHandSide();
2274 if ($this->_limit
&& count($rows) >= self
::ROW_COUNT_LIMIT
) {
2278 $this->rollupRow
= array_pop($rows);
2280 foreach ($this->_columnHeaders
as $fld => $val) {
2281 if (!in_array($fld, $this->_statFields
)) {
2282 if (!$this->_grandFlag
) {
2283 $this->rollupRow
[$fld] = ts('Grand Total');
2284 $this->_grandFlag
= TRUE;
2287 $this->rollupRow
[$fld] = "";
2292 $this->assign('grandStat', $this->rollupRow
);
2297 * Format display output.
2299 * @param array $rows
2300 * @param bool $pager
2302 public function formatDisplay(&$rows, $pager = TRUE) {
2303 // set pager based on if any limit was applied in the query.
2308 // allow building charts if any
2309 if (!empty($this->_params
['charts']) && !empty($rows)) {
2310 $this->buildChart($rows);
2311 $this->assign('chartEnabled', TRUE);
2312 $this->_chartId
= "{$this->_params['charts']}_" .
2313 ($this->_id ?
$this->_id
: substr(get_class($this), 16)) . '_' .
2315 $this->assign('chartId', $this->_chartId
);
2318 // unset columns not to be displayed.
2319 foreach ($this->_columnHeaders
as $key => $value) {
2320 if (!empty($value['no_display'])) {
2321 unset($this->_columnHeaders
[$key]);
2325 // unset columns not to be displayed.
2326 if (!empty($rows)) {
2327 foreach ($this->_noDisplay
as $noDisplayField) {
2328 foreach ($rows as $rowNum => $row) {
2329 unset($this->_columnHeaders
[$noDisplayField]);
2334 // build array of section totals
2335 $this->sectionTotals();
2337 // process grand-total row
2338 $this->grandTotal($rows);
2340 // Find alter display functions.
2341 $firstRow = reset($rows);
2343 $selectedFields = array_keys($firstRow);
2344 $alterFunctions = $alterMap = $alterSpecs = array();
2345 foreach ($this->_columns
as $tableName => $table) {
2346 if (array_key_exists('metadata', $table)) {
2347 foreach ($table['metadata'] as $field => $specs) {
2348 if (in_array($tableName . '_' . $field, $selectedFields)) {
2349 if (array_key_exists('alter_display', $specs)) {
2350 $alterFunctions[$tableName . '_' . $field] = $specs['alter_display'];
2351 $alterMap[$tableName . '_' . $field] = $field;
2352 $alterSpecs[$tableName . '_' . $field] = NULL;
2354 // Add any alters that can be intuited from the field specs.
2355 // So far only boolean but a lot more could be.
2356 if (empty($alterSpecs[$tableName . '_' . $field]) && isset($specs['type']) && $specs['type'] == CRM_Utils_Type
::T_BOOLEAN
) {
2357 $alterFunctions[$tableName . '_' . $field] = 'alterBoolean';
2358 $alterMap[$tableName . '_' . $field] = $field;
2359 $alterSpecs[$tableName . '_' . $field] = NULL;
2366 // Run the alter display functions
2367 foreach ($rows as $index => & $row) {
2368 foreach ($row as $selectedField => $value) {
2369 if (array_key_exists($selectedField, $alterFunctions)) {
2370 $rows[$index][$selectedField] = $this->{$alterFunctions[$selectedField]}($value, $row, $selectedField, $alterMap[$selectedField], $alterSpecs[$selectedField]);
2376 // use this method for formatting rows for display purpose.
2377 $this->alterDisplay($rows);
2378 CRM_Utils_Hook
::alterReportVar('rows', $rows, $this);
2380 // use this method for formatting custom rows for display purpose.
2381 $this->alterCustomDataDisplay($rows);
2387 * @param $selectedfield
2388 * @param $criteriaFieldName
2392 protected function alterStateProvinceID($value, &$row, $selectedfield, $criteriaFieldName) {
2393 $url = CRM_Utils_System
::url(CRM_Utils_System
::currentPath(), "reset=1&force=1&{$criteriaFieldName}_op=in&{$criteriaFieldName}_value={$value}", $this->_absoluteUrl
);
2394 $row[$selectedfield . '_link'] = $url;
2395 $row[$selectedfield . '_hover'] = ts("%1 for this state.", array(
2399 $states = CRM_Core_PseudoConstant
::stateProvince($value, FALSE);
2400 if (!is_array($states)) {
2408 * @param $selectedField
2409 * @param $criteriaFieldName
2413 protected function alterCountryID($value, &$row, $selectedField, $criteriaFieldName) {
2414 $url = CRM_Utils_System
::url(CRM_Utils_System
::currentPath(), "reset=1&force=1&{$criteriaFieldName}_op=in&{$criteriaFieldName}_value={$value}", $this->_absoluteUrl
);
2415 $row[$selectedField . '_link'] = $url;
2416 $row[$selectedField . '_hover'] = ts("%1 for this country.", array(
2419 $countries = CRM_Core_PseudoConstant
::country($value, FALSE);
2420 if (!is_array($countries)) {
2428 * @param $selectedfield
2429 * @param $criteriaFieldName
2433 protected function alterCountyID($value, &$row, $selectedfield, $criteriaFieldName) {
2434 $url = CRM_Utils_System
::url(CRM_Utils_System
::currentPath(), "reset=1&force=1&{$criteriaFieldName}_op=in&{$criteriaFieldName}_value={$value}", $this->_absoluteUrl
);
2435 $row[$selectedfield . '_link'] = $url;
2436 $row[$selectedfield . '_hover'] = ts("%1 for this county.", array(
2439 $counties = CRM_Core_PseudoConstant
::county($value, FALSE);
2440 if (!is_array($counties)) {
2448 * @param $selectedfield
2449 * @param $criteriaFieldName
2453 protected function alterLocationTypeID($value, &$row, $selectedfield, $criteriaFieldName) {
2454 return CRM_Core_PseudoConstant
::getLabel('CRM_Core_DAO_Address', 'location_type_id', $value);
2464 protected function alterContactID($value, &$row, $fieldname) {
2465 $nameField = substr($fieldname, 0, -2) . 'name';
2466 static $first = TRUE;
2467 static $viewContactList = FALSE;
2469 $viewContactList = CRM_Core_Permission
::check('access CiviCRM');
2472 if (!$viewContactList) {
2475 if (array_key_exists($nameField, $row)) {
2476 $row[$nameField . '_link'] = CRM_Utils_System
::url("civicrm/contact/view", 'reset=1&cid=' . $value, $this->_absoluteUrl
);
2479 $row[$fieldname . '_link'] = CRM_Utils_System
::url("civicrm/contact/view", 'reset=1&cid=' . $value, $this->_absoluteUrl
);
2489 protected function alterBoolean($value) {
2490 $options = array(0 => '', 1 => ts('Yes'));
2491 if (isset($options[$value])) {
2492 return $options[$value];
2500 * @param array $rows
2502 public function buildChart(&$rows) {
2503 // override this method for building charts.
2506 // select() method below has been added recently (v3.3), and many of the report templates might
2507 // still be having their own select() method. We should fix them as and when encountered and move
2508 // towards generalizing the select() method below.
2511 * Generate the SELECT clause and set class variable $_select.
2513 public function select() {
2514 $select = $this->_selectAliases
= array();
2515 $this->storeGroupByArray();
2517 foreach ($this->_columns
as $tableName => $table) {
2518 if (array_key_exists('fields', $table)) {
2519 foreach ($table['fields'] as $fieldName => $field) {
2520 if ($tableName == 'civicrm_address') {
2521 // deprecated, use $this->isTableSelected.
2522 $this->_addressField
= TRUE;
2524 if ($tableName == 'civicrm_email') {
2525 $this->_emailField
= TRUE;
2527 if ($tableName == 'civicrm_phone') {
2528 $this->_phoneField
= TRUE;
2531 if (!empty($field['required']) ||
2532 !empty($this->_params
['fields'][$fieldName])
2535 // 1. In many cases we want select clause to be built in slightly different way
2536 // for a particular field of a particular type.
2537 // 2. This method when used should receive params by reference and modify $this->_columnHeaders
2539 $selectClause = $this->selectClause($tableName, 'fields', $fieldName, $field);
2540 if ($selectClause) {
2541 $select[] = $selectClause;
2545 // include statistics columns only if set
2546 if (!empty($field['statistics']) && !empty($this->_groupByArray
)) {
2547 $select = $this->addStatisticsToSelect($field, $tableName, $fieldName, $select);
2551 $selectClause = $this->getSelectClauseWithGroupConcatIfNotGroupedBy($tableName, $fieldName, $field);
2552 if ($selectClause) {
2553 $select[] = $selectClause;
2556 $select = $this->addBasicFieldToSelect($tableName, $fieldName, $field, $select);
2563 // select for group bys
2564 if (array_key_exists('group_bys', $table)) {
2565 foreach ($table['group_bys'] as $fieldName => $field) {
2567 if ($tableName == 'civicrm_address') {
2568 $this->_addressField
= TRUE;
2570 if ($tableName == 'civicrm_email') {
2571 $this->_emailField
= TRUE;
2573 if ($tableName == 'civicrm_phone') {
2574 $this->_phoneField
= TRUE;
2576 // 1. In many cases we want select clause to be built in slightly different way
2577 // for a particular field of a particular type.
2578 // 2. This method when used should receive params by reference and modify $this->_columnHeaders
2580 $selectClause = $this->selectClause($tableName, 'group_bys', $fieldName, $field);
2581 if ($selectClause) {
2582 $select[] = $selectClause;
2586 if (!empty($this->_params
['group_bys']) &&
2587 !empty($this->_params
['group_bys'][$fieldName]) &&
2588 !empty($this->_params
['group_bys_freq'])
2590 switch (CRM_Utils_Array
::value($fieldName, $this->_params
['group_bys_freq'])) {
2592 $select[] = "DATE_SUB({$field['dbAlias']}, INTERVAL WEEKDAY({$field['dbAlias']}) DAY) AS {$tableName}_{$fieldName}_start";
2593 $select[] = "YEARWEEK({$field['dbAlias']}) AS {$tableName}_{$fieldName}_subtotal";
2594 $select[] = "WEEKOFYEAR({$field['dbAlias']}) AS {$tableName}_{$fieldName}_interval";
2595 $field['title'] = 'Week';
2599 $select[] = "MAKEDATE(YEAR({$field['dbAlias']}), 1) AS {$tableName}_{$fieldName}_start";
2600 $select[] = "YEAR({$field['dbAlias']}) AS {$tableName}_{$fieldName}_subtotal";
2601 $select[] = "YEAR({$field['dbAlias']}) AS {$tableName}_{$fieldName}_interval";
2602 $field['title'] = 'Year';
2606 $select[] = "DATE_SUB({$field['dbAlias']}, INTERVAL (DAYOFMONTH({$field['dbAlias']})-1) DAY) as {$tableName}_{$fieldName}_start";
2607 $select[] = "MONTH({$field['dbAlias']}) AS {$tableName}_{$fieldName}_subtotal";
2608 $select[] = "MONTHNAME({$field['dbAlias']}) AS {$tableName}_{$fieldName}_interval";
2609 $field['title'] = 'Month';
2613 $select[] = "STR_TO_DATE(CONCAT( 3 * QUARTER( {$field['dbAlias']} ) -2 , '/', '1', '/', YEAR( {$field['dbAlias']} ) ), '%m/%d/%Y') AS {$tableName}_{$fieldName}_start";
2614 $select[] = "QUARTER({$field['dbAlias']}) AS {$tableName}_{$fieldName}_subtotal";
2615 $select[] = "QUARTER({$field['dbAlias']}) AS {$tableName}_{$fieldName}_interval";
2616 $field['title'] = 'Quarter';
2619 // for graphs and charts -
2620 if (!empty($this->_params
['group_bys_freq'][$fieldName])) {
2621 $this->_interval
= $field['title'];
2622 $this->_columnHeaders
["{$tableName}_{$fieldName}_start"]['title']
2623 = $field['title'] . ' Beginning';
2624 $this->_columnHeaders
["{$tableName}_{$fieldName}_start"]['type'] = $field['type'];
2625 $this->_columnHeaders
["{$tableName}_{$fieldName}_start"]['group_by'] = $this->_params
['group_bys_freq'][$fieldName];
2627 // just to make sure these values are transferred to rows.
2628 // since we 'll need them for calculation purpose,
2629 // e.g making subtotals look nicer or graphs
2630 $this->_columnHeaders
["{$tableName}_{$fieldName}_interval"] = array('no_display' => TRUE);
2631 $this->_columnHeaders
["{$tableName}_{$fieldName}_subtotal"] = array('no_display' => TRUE);
2638 if (empty($select)) {
2639 // CRM-21412 Do not give fatal error on report when no fields selected
2643 $this->_selectClauses
= $select;
2644 $this->_select
= "SELECT " . implode(', ', $select) . " ";
2648 * Build select clause for a single field.
2650 * @param string $tableName
2651 * @param string $tableKey
2652 * @param string $fieldName
2653 * @param string $field
2657 public function selectClause(&$tableName, $tableKey, &$fieldName, &$field) {
2658 if (!empty($field['pseudofield'])) {
2659 $alias = "{$tableName}_{$fieldName}";
2660 $this->_columnHeaders
["{$tableName}_{$fieldName}"]['title'] = CRM_Utils_Array
::value('title', $field);
2661 $this->_columnHeaders
["{$tableName}_{$fieldName}"]['type'] = CRM_Utils_Array
::value('type', $field);
2662 $this->_columnHeaders
["{$tableName}_{$fieldName}"]['dbAlias'] = CRM_Utils_Array
::value('dbAlias', $field);
2663 $this->_selectAliases
[] = $alias;
2664 return ' 1 as ' . $alias;
2670 * Build where clause.
2672 public function where() {
2673 $this->storeWhereHavingClauseArray();
2675 if (empty($this->_whereClauses
)) {
2676 $this->_where
= "WHERE ( 1 ) ";
2677 $this->_having
= "";
2680 $this->_where
= "WHERE " . implode(' AND ', $this->_whereClauses
);
2683 if ($this->_aclWhere
) {
2684 $this->_where
.= " AND {$this->_aclWhere} ";
2687 if (!empty($this->_havingClauses
)) {
2688 // use this clause to construct group by clause.
2689 $this->_having
= "HAVING " . implode(' AND ', $this->_havingClauses
);
2694 * Store Where clauses into an array.
2696 * Breaking out this step makes over-riding more flexible as the clauses can be used in constructing a
2697 * temp table that may not be part of the final where clause or added
2698 * in other functions
2700 public function storeWhereHavingClauseArray() {
2701 foreach ($this->_columns
as $tableName => $table) {
2702 if (array_key_exists('filters', $table)) {
2703 foreach ($table['filters'] as $fieldName => $field) {
2704 // respect pseudofield to filter spec so fields can be marked as
2705 // not to be handled here
2706 if (!empty($field['pseudofield'])) {
2709 $clause = $this->generateFilterClause($field, $fieldName);
2711 if (!empty($clause)) {
2712 if (!empty($field['having'])) {
2713 $this->_havingClauses
[] = $clause;
2716 $this->_whereClauses
[] = $clause;
2728 public function processReportMode() {
2729 $this->setOutputMode();
2732 = CRM_Utils_Request
::retrieve(
2735 CRM_Core_DAO
::$_nullObject
2738 $this->_absoluteUrl
= FALSE;
2740 $this->assign('printOnly', FALSE);
2742 if ($this->_outputMode
== 'print' ||
2743 ($this->_sendmail
&& !$this->_outputMode
)
2745 $this->assign('printOnly', TRUE);
2747 $this->addPaging
= FALSE;
2748 $this->assign('outputMode', 'print');
2749 $this->_outputMode
= 'print';
2750 if ($this->_sendmail
) {
2751 $this->_absoluteUrl
= TRUE;
2754 elseif ($this->_outputMode
== 'pdf') {
2756 $this->addPaging
= FALSE;
2757 $this->_absoluteUrl
= TRUE;
2759 elseif ($this->_outputMode
== 'csv') {
2761 $this->_absoluteUrl
= TRUE;
2762 $this->addPaging
= FALSE;
2764 elseif ($this->_outputMode
== 'group') {
2765 $this->assign('outputMode', 'group');
2767 elseif ($this->_outputMode
== 'create_report' && $this->_criteriaForm
) {
2768 $this->assign('outputMode', 'create_report');
2770 elseif ($this->_outputMode
== 'copy' && $this->_criteriaForm
) {
2771 $this->_createNew
= TRUE;
2774 $this->assign('outputMode', $this->_outputMode
);
2775 $this->assign('printOnly', $printOnly);
2776 // Get today's date to include in printed reports
2778 $reportDate = CRM_Utils_Date
::customFormat(date('Y-m-d H:i'));
2779 $this->assign('reportDate', $reportDate);
2784 * Post Processing function for Form.
2786 * postProcessCommon should be used to set other variables from input as the api accesses that function.
2787 * This function is not accessed when the api calls the report.
2789 public function beginPostProcess() {
2790 $this->setParams($this->controller
->exportValues($this->_name
));
2791 if (empty($this->_params
) &&
2794 $this->setParams($this->_formValues
);
2797 // hack to fix params when submitted from dashboard, CRM-8532
2798 // fields array is missing because form building etc is skipped
2799 // in dashboard mode for report
2800 //@todo - this could be done in the dashboard no we have a setter
2801 if (empty($this->_params
['fields']) && !$this->_noFields
) {
2802 $this->setParams($this->_formValues
);
2805 $this->processReportMode();
2807 if ($this->_outputMode
== 'save' ||
$this->_outputMode
== 'copy') {
2808 $this->_createNew
= ($this->_outputMode
== 'copy');
2809 CRM_Report_Form_Instance
::postProcess($this);
2811 if ($this->_outputMode
== 'delete') {
2812 CRM_Report_BAO_ReportInstance
::doFormDelete($this->_id
, 'civicrm/report/list?reset=1', 'civicrm/report/list?reset=1');
2815 $this->_formValues
= $this->_params
;
2817 $this->beginPostProcessCommon();
2821 * BeginPostProcess function run in both report mode and non-report mode (api).
2823 public function beginPostProcessCommon() {
2827 * Build the report query.
2829 * @param bool $applyLimit
2833 public function buildQuery($applyLimit = TRUE) {
2834 $this->buildGroupTempTable();
2837 $this->customDataFrom();
2838 $this->buildPermissionClause();
2843 foreach ($this->unselectedOrderByColumns() as $alias => $field) {
2844 $clause = $this->getSelectClauseWithGroupConcatIfNotGroupedBy($field['table_name'], $field['name'], $field);
2846 $clause = "{$field['dbAlias']} as {$alias}";
2848 $this->_select
.= ", $clause ";
2851 if ($applyLimit && empty($this->_params
['charts'])) {
2854 CRM_Utils_Hook
::alterReportVar('sql', $this, $this);
2856 $sql = "{$this->_select} {$this->_from} {$this->_where} {$this->_groupBy} {$this->_having} {$this->_orderBy} {$this->_limit}";
2857 $this->addToDeveloperTab($sql);
2862 * Build group by clause.
2864 public function groupBy() {
2865 $this->storeGroupByArray();
2867 if (!empty($this->_groupByArray
)) {
2868 if ($this->optimisedForOnlyFullGroupBy
) {
2869 // We should probably deprecate this code path. What happens here is that
2870 // the group by is amended to reflect the select columns. This often breaks the
2871 // results. Retrofitting group strict group by onto existing report classes
2873 $this->_groupBy
= CRM_Contact_BAO_Query
::getGroupByFromSelectColumns($this->_selectClauses
, $this->_groupByArray
);
2876 $this->_groupBy
= ' GROUP BY ' . implode($this->_groupByArray
);
2882 * Build order by clause.
2884 public function orderBy() {
2885 $this->_orderBy
= "";
2886 $this->_sections
= array();
2887 $this->storeOrderByArray();
2888 if (!empty($this->_orderByArray
) && !$this->_rollup
== 'WITH ROLLUP') {
2889 $this->_orderBy
= "ORDER BY " . implode(', ', $this->_orderByArray
);
2891 $this->assign('sections', $this->_sections
);
2895 * Extract order by fields and store as an array.
2897 * In some cases other functions want to know which fields are selected for ordering by
2898 * Separating this into a separate function allows it to be called separately from constructing
2899 * the order by clause
2901 public function storeOrderByArray() {
2902 $orderBys = array();
2904 if (!empty($this->_params
['order_bys']) &&
2905 is_array($this->_params
['order_bys']) &&
2906 !empty($this->_params
['order_bys'])
2909 // Process order_bys in user-specified order
2910 foreach ($this->_params
['order_bys'] as $orderBy) {
2911 $orderByField = array();
2912 foreach ($this->_columns
as $tableName => $table) {
2913 if (array_key_exists('order_bys', $table)) {
2914 // For DAO columns defined in $this->_columns
2915 $fields = $table['order_bys'];
2917 elseif (array_key_exists('extends', $table)) {
2918 // For custom fields referenced in $this->_customGroupExtends
2919 $fields = CRM_Utils_Array
::value('fields', $table, array());
2924 if (!empty($fields) && is_array($fields)) {
2925 foreach ($fields as $fieldName => $field) {
2926 if ($fieldName == $orderBy['column']) {
2927 $orderByField = array_merge($field, $orderBy);
2928 $orderByField['tplField'] = "{$tableName}_{$fieldName}";
2935 if (!empty($orderByField)) {
2936 $this->_orderByFields
[$orderByField['tplField']] = $orderByField;
2937 if ($this->groupConcatTested
) {
2938 $orderBys[$orderByField['tplField']] = "{$orderByField['tplField']} {$orderBy['order']}";
2941 // Not sure when this is preferable to using tplField (which has
2942 // definitely been tested to work in cases then this does not.
2943 // in caution not switching unless report has been tested for
2944 // group concat functionality.
2945 $orderBys[$orderByField['tplField']] = "{$orderByField['dbAlias']} {$orderBy['order']}";
2948 // Record any section headers for assignment to the template
2949 if (!empty($orderBy['section'])) {
2950 $orderByField['pageBreak'] = CRM_Utils_Array
::value('pageBreak', $orderBy);
2951 $this->_sections
[$orderByField['tplField']] = $orderByField;
2957 $this->_orderByArray
= $orderBys;
2959 $this->assign('sections', $this->_sections
);
2963 * Determine unselected columns.
2967 public function unselectedOrderByColumns() {
2968 return array_diff_key($this->_orderByFields
, $this->getSelectColumns());
2972 * Determine unselected columns.
2976 public function unselectedSectionColumns() {
2977 if (is_array($this->_sections
)) {
2978 return array_diff_key($this->_sections
, $this->getSelectColumns());
2986 * Build output rows.
2988 * @param string $sql
2989 * @param array $rows
2991 public function buildRows($sql, &$rows) {
2992 if (!$this->optimisedForOnlyFullGroupBy
) {
2993 CRM_Core_DAO
::disableFullGroupByMode();
2995 $dao = CRM_Core_DAO
::executeQuery($sql);
2996 if (stristr($this->_select
, 'SQL_CALC_FOUND_ROWS')) {
2997 $this->_rowsFound
= CRM_Core_DAO
::singleValueQuery('SELECT FOUND_ROWS()');
2999 CRM_Core_DAO
::reenableFullGroupByMode();
3000 if (!is_array($rows)) {
3004 // use this method to modify $this->_columnHeaders
3005 $this->modifyColumnHeaders();
3007 $unselectedSectionColumns = $this->unselectedSectionColumns();
3009 while ($dao->fetch()) {
3011 foreach ($this->_columnHeaders
as $key => $value) {
3012 if (property_exists($dao, $key)) {
3013 $row[$key] = $dao->$key;
3017 // section headers not selected for display need to be added to row
3018 foreach ($unselectedSectionColumns as $key => $values) {
3019 if (property_exists($dao, $key)) {
3020 $row[$key] = $dao->$key;
3029 * Calculate section totals.
3031 * When "order by" fields are marked as sections, this assigns to the template
3032 * an array of total counts for each section. This data is used by the Smarty
3033 * plugin {sectionTotal}.
3035 public function sectionTotals() {
3037 // Reports using order_bys with sections must populate $this->_selectAliases in select() method.
3038 if (empty($this->_selectAliases
)) {
3042 if (!empty($this->_sections
)) {
3043 // build the query with no LIMIT clause
3044 $select = str_ireplace('SELECT SQL_CALC_FOUND_ROWS ', 'SELECT ', $this->_select
);
3045 $sql = "{$select} {$this->_from} {$this->_where} {$this->_groupBy} {$this->_having} {$this->_orderBy}";
3047 // pull section aliases out of $this->_sections
3048 $sectionAliases = array_keys($this->_sections
);
3051 foreach (array_merge($sectionAliases, $this->_selectAliases
) as $alias) {
3052 $ifnulls[] = "ifnull($alias, '') as $alias";
3054 $this->_select
= "SELECT " . implode(", ", $ifnulls);
3055 $this->_select
= CRM_Contact_BAO_Query
::appendAnyValueToSelect($ifnulls, $sectionAliases);
3057 // Group (un-limited) report by all aliases and get counts. This might
3058 // be done more efficiently when the contents of $sql are known, ie. by
3059 // overriding this method in the report class.
3061 $query = $this->_select
.
3062 ", count(*) as ct from ($sql) as subquery group by " .
3063 implode(", ", $sectionAliases);
3065 // initialize array of total counts
3067 $dao = CRM_Core_DAO
::executeQuery($query);
3068 while ($dao->fetch()) {
3070 // let $this->_alterDisplay translate any integer ids to human-readable values.
3071 $rows[0] = $dao->toArray();
3072 $this->alterDisplay($rows);
3075 // add totals for all permutations of section values
3078 $aliasCount = count($sectionAliases);
3079 foreach ($sectionAliases as $alias) {
3080 $values[] = $row[$alias];
3081 $key = implode(CRM_Core_DAO
::VALUE_SEPARATOR
, $values);
3082 if ($i == $aliasCount) {
3083 // the last alias is the lowest-level section header; use count as-is
3084 $totals[$key] = $dao->ct
;
3087 // other aliases are higher level; roll count into their total
3088 $totals[$key] +
= $dao->ct
;
3092 $this->assign('sectionTotals', $totals);
3097 * Modify column headers.
3099 public function modifyColumnHeaders() {
3100 // use this method to modify $this->_columnHeaders
3104 * Move totals columns to the right edge of the table.
3106 * It seems like a more logical layout to have any totals columns on the far right regardless of
3107 * the location of the rest of their table.
3109 public function moveSummaryColumnsToTheRightHandSide() {
3110 $statHeaders = (array_intersect_key($this->_columnHeaders
, array_flip($this->_statFields
)));
3111 $this->_columnHeaders
= array_merge(array_diff_key($this->_columnHeaders
, $statHeaders), $this->_columnHeaders
, $statHeaders);
3115 * Assign rows to the template.
3117 * @param array $rows
3119 public function doTemplateAssignment(&$rows) {
3120 $this->assign_by_ref('columnHeaders', $this->_columnHeaders
);
3121 $this->assign_by_ref('rows', $rows);
3122 $this->assign('statistics', $this->statistics($rows));
3126 * Build report statistics.
3128 * Override this method to build your own statistics.
3130 * @param array $rows
3134 public function statistics(&$rows) {
3135 $statistics = array();
3137 $count = count($rows);
3138 // Why do we increment the count for rollup seems to artificially inflate the count.
3139 // It seems perhaps intentional to include the summary row in the count of results - although
3140 // this just seems odd.
3141 if ($this->_rollup
&& ($this->_rollup
!= '') && $this->_grandFlag
) {
3145 $this->countStat($statistics, $count);
3147 $this->groupByStat($statistics);
3149 $this->filterStat($statistics);
3155 * Add count statistics.
3157 * @param array $statistics
3160 public function countStat(&$statistics, $count) {
3161 $statistics['counts']['rowCount'] = array(
3162 'title' => ts('Row(s) Listed'),
3166 if ($this->_rowsFound
&& ($this->_rowsFound
> $count)) {
3167 $statistics['counts']['rowsFound'] = array(
3168 'title' => ts('Total Row(s)'),
3169 'value' => $this->_rowsFound
,
3175 * Add group by statistics.
3177 * @param array $statistics
3179 public function groupByStat(&$statistics) {
3180 if (!empty($this->_params
['group_bys']) &&
3181 is_array($this->_params
['group_bys']) &&
3182 !empty($this->_params
['group_bys'])
3184 foreach ($this->_columns
as $tableName => $table) {
3185 if (array_key_exists('group_bys', $table)) {
3186 foreach ($table['group_bys'] as $fieldName => $field) {
3187 if (!empty($this->_params
['group_bys'][$fieldName])) {
3188 $combinations[] = $field['title'];
3193 $statistics['groups'][] = array(
3194 'title' => ts('Grouping(s)'),
3195 'value' => implode(' & ', $combinations),
3201 * Filter statistics.
3203 * @param array $statistics
3205 public function filterStat(&$statistics) {
3206 foreach ($this->_columns
as $tableName => $table) {
3207 if (array_key_exists('filters', $table)) {
3208 foreach ($table['filters'] as $fieldName => $field) {
3209 if ((CRM_Utils_Array
::value('type', $field) & CRM_Utils_Type
::T_DATE ||
3210 CRM_Utils_Array
::value('type', $field) & CRM_Utils_Type
::T_TIME
) &&
3211 CRM_Utils_Array
::value('operatorType', $field) !=
3212 CRM_Report_Form
::OP_MONTH
3216 CRM_Utils_Array
::value("{$fieldName}_relative", $this->_params
),
3217 CRM_Utils_Array
::value("{$fieldName}_from", $this->_params
),
3218 CRM_Utils_Array
::value("{$fieldName}_to", $this->_params
),
3219 CRM_Utils_Array
::value("{$fieldName}_from_time", $this->_params
),
3220 CRM_Utils_Array
::value("{$fieldName}_to_time", $this->_params
)
3222 $from_time_format = !empty($this->_params
["{$fieldName}_from_time"]) ?
'h' : 'd';
3223 $from = CRM_Utils_Date
::customFormat($from, NULL, array($from_time_format));
3225 $to_time_format = !empty($this->_params
["{$fieldName}_to_time"]) ?
'h' : 'd';
3226 $to = CRM_Utils_Date
::customFormat($to, NULL, array($to_time_format));
3229 $statistics['filters'][] = array(
3230 'title' => $field['title'],
3231 'value' => ts("Between %1 and %2", array(1 => $from, 2 => $to)),
3234 elseif (in_array($rel = CRM_Utils_Array
::value("{$fieldName}_relative", $this->_params
),
3235 array_keys($this->getOperationPair(CRM_Report_Form
::OP_DATE
))
3237 $pair = $this->getOperationPair(CRM_Report_Form
::OP_DATE
);
3238 $statistics['filters'][] = array(
3239 'title' => $field['title'],
3240 'value' => $pair[$rel],
3245 $op = CRM_Utils_Array
::value("{$fieldName}_op", $this->_params
);
3248 $pair = $this->getOperationPair(
3249 CRM_Utils_Array
::value('operatorType', $field),
3252 $min = CRM_Utils_Array
::value("{$fieldName}_min", $this->_params
);
3253 $max = CRM_Utils_Array
::value("{$fieldName}_max", $this->_params
);
3254 $val = CRM_Utils_Array
::value("{$fieldName}_value", $this->_params
);
3255 if (in_array($op, array('bw', 'nbw')) && ($min ||
$max)) {
3256 $value = "{$pair[$op]} $min " . ts('and') . " $max";
3258 elseif ($val && CRM_Utils_Array
::value('operatorType', $field) & self
::OP_ENTITYREF
) {
3259 $this->setEntityRefDefaults($field, $tableName);
3260 $result = civicrm_api3($field['attributes']['entity'], 'getlist',
3261 array('id' => $val) +
3262 CRM_Utils_Array
::value('api', $field['attributes'], array()));
3264 foreach ($result['values'] as $v) {
3265 $values[] = $v['label'];
3267 $value = "{$pair[$op]} " . implode(', ', $values);
3269 elseif ($op == 'nll' ||
$op == 'nnll') {
3270 $value = $pair[$op];
3272 elseif (is_array($val) && (!empty($val))) {
3273 $options = CRM_Utils_Array
::value('options', $field, array());
3274 foreach ($val as $key => $valIds) {
3275 if (isset($options[$valIds])) {
3276 $val[$key] = $options[$valIds];
3279 $pair[$op] = (count($val) == 1) ?
(($op == 'notin' ||
$op ==
3280 'mnot') ?
ts('Is Not') : ts('Is')) : CRM_Utils_Array
::value($op, $pair);
3281 $val = implode(', ', $val);
3282 $value = "{$pair[$op]} " . $val;
3284 elseif (!is_array($val) && (!empty($val) ||
$val == '0') &&
3285 isset($field['options']) &&
3286 is_array($field['options']) && !empty($field['options'])
3288 $value = CRM_Utils_Array
::value($op, $pair) . " " .
3289 CRM_Utils_Array
::value($val, $field['options'], $val);
3292 $value = CRM_Utils_Array
::value($op, $pair) . " " . $val;
3295 if ($value && empty($field['no_display'])) {
3296 $statistics['filters'][] = array(
3297 'title' => CRM_Utils_Array
::value('title', $field),
3308 * End post processing.
3310 * @param array|null $rows
3312 public function endPostProcess(&$rows = NULL) {
3313 $this->assign('report_class', get_class($this));
3314 if ($this->_storeResultSet
) {
3315 $this->_resultSet
= $rows;
3318 if ($this->_outputMode
== 'print' ||
3319 $this->_outputMode
== 'pdf' ||
3323 $content = $this->compileContent();
3324 $url = CRM_Utils_System
::url("civicrm/report/instance/{$this->_id}",
3328 if ($this->_sendmail
) {
3329 $config = CRM_Core_Config
::singleton();
3330 $attachments = array();
3332 if ($this->_outputMode
== 'csv') {
3334 = $this->_formValues
['report_header'] . '<p>' . ts('Report URL') .
3335 ": {$url}</p>" . '<p>' .
3336 ts('The report is attached as a CSV file.') . '</p>' .
3337 $this->_formValues
['report_footer'];
3339 $csvFullFilename = $config->templateCompileDir
.
3340 CRM_Utils_File
::makeFileName('CiviReport.csv');
3341 $csvContent = CRM_Report_Utils_Report
::makeCsv($this, $rows);
3342 file_put_contents($csvFullFilename, $csvContent);
3343 $attachments[] = array(
3344 'fullPath' => $csvFullFilename,
3345 'mime_type' => 'text/csv',
3346 'cleanName' => 'CiviReport.csv',
3349 if ($this->_outputMode
== 'pdf') {
3350 // generate PDF content
3351 $pdfFullFilename = $config->templateCompileDir
.
3352 CRM_Utils_File
::makeFileName('CiviReport.pdf');
3353 file_put_contents($pdfFullFilename,
3354 CRM_Utils_PDF_Utils
::html2pdf($content, "CiviReport.pdf",
3355 TRUE, array('orientation' => 'landscape')
3358 // generate Email Content
3360 = $this->_formValues
['report_header'] . '<p>' . ts('Report URL') .
3361 ": {$url}</p>" . '<p>' .
3362 ts('The report is attached as a PDF file.') . '</p>' .
3363 $this->_formValues
['report_footer'];
3365 $attachments[] = array(
3366 'fullPath' => $pdfFullFilename,
3367 'mime_type' => 'application/pdf',
3368 'cleanName' => 'CiviReport.pdf',
3372 if (CRM_Report_Utils_Report
::mailReport($content, $this->_id
,
3373 $this->_outputMode
, $attachments
3376 CRM_Core_Session
::setStatus(ts("Report mail has been sent."), ts('Sent'), 'success');
3379 CRM_Core_Session
::setStatus(ts("Report mail could not be sent."), ts('Mail Error'), 'error');
3383 elseif ($this->_outputMode
== 'print') {
3387 if ($chartType = CRM_Utils_Array
::value('charts', $this->_params
)) {
3388 $config = CRM_Core_Config
::singleton();
3389 //get chart image name
3390 $chartImg = $this->_chartId
. '.png';
3391 //get image url path
3393 = str_replace('/persist/contribute/', '/persist/', $config->imageUploadURL
) .
3395 $uploadUrl .= $chartImg;
3396 //get image doc path to overwrite
3398 = str_replace('/persist/contribute/', '/persist/', $config->imageUploadDir
) .
3399 'openFlashChart/' . $chartImg;
3401 $chart = imagecreatefrompng($uploadUrl);
3402 //convert it into formatted png
3403 CRM_Utils_System
::setHttpHeader('Content-type', 'image/png');
3404 //overwrite with same image
3405 imagepng($chart, $uploadImg);
3407 imagedestroy($chart);
3409 CRM_Utils_PDF_Utils
::html2pdf($content, "CiviReport.pdf", FALSE, array('orientation' => 'landscape'));
3411 CRM_Utils_System
::civiExit();
3413 elseif ($this->_outputMode
== 'csv') {
3414 CRM_Report_Utils_Report
::export2csv($this, $rows);
3416 elseif ($this->_outputMode
== 'group') {
3417 $group = $this->_params
['groups'];
3418 $this->add2group($group);
3423 * Set store result set indicator to TRUE.
3425 * @todo explain what this does
3427 public function storeResultSet() {
3428 $this->_storeResultSet
= TRUE;
3436 public function getResultSet() {
3437 return $this->_resultSet
;
3441 * Get the sql used to generate the report.
3445 public function getReportSql() {
3446 return $this->sqlArray
;
3450 * Use the form name to create the tpl file name.
3454 public function getTemplateFileName() {
3455 $defaultTpl = parent
::getTemplateFileName();
3456 $template = CRM_Core_Smarty
::singleton();
3457 if (!$template->template_exists($defaultTpl)) {
3458 $defaultTpl = 'CRM/Report/Form.tpl';
3464 * Compile the report content.
3466 * Although this function is super-short it is useful to keep separate so it can be over-ridden by report classes.
3470 public function compileContent() {
3471 $templateFile = $this->getHookedTemplateFileName();
3472 return CRM_Utils_Array
::value('report_header', $this->_formValues
) .
3473 CRM_Core_Form
::$_template->fetch($templateFile) .
3474 CRM_Utils_Array
::value('report_footer', $this->_formValues
);
3479 * Post process function.
3481 public function postProcess() {
3482 // get ready with post process params
3483 $this->beginPostProcess();
3486 $sql = $this->buildQuery();
3488 // build array of result based on column headers. This method also allows
3489 // modifying column headers before using it to build result set i.e $rows.
3491 $this->buildRows($sql, $rows);
3493 // format result set.
3494 $this->formatDisplay($rows);
3496 // assign variables to templates
3497 $this->doTemplateAssignment($rows);
3499 // do print / pdf / instance stuff if needed
3500 $this->endPostProcess($rows);
3506 * @param int $rowCount
3510 public function limit($rowCount = self
::ROW_COUNT_LIMIT
) {
3511 // lets do the pager if in html mode
3512 $this->_limit
= NULL;
3514 // CRM-14115, over-ride row count if rowCount is specified in URL
3515 if ($this->_dashBoardRowCount
) {
3516 $rowCount = $this->_dashBoardRowCount
;
3518 if ($this->addPaging
) {
3519 $this->_select
= preg_replace('/SELECT(\s+SQL_CALC_FOUND_ROWS)?\s+/i', 'SELECT SQL_CALC_FOUND_ROWS ', $this->_select
);
3521 $pageId = CRM_Utils_Request
::retrieve('crmPID', 'Integer');
3523 // @todo all http vars should be extracted in the preProcess
3524 // - not randomly in the class
3525 if (!$pageId && !empty($_POST)) {
3526 if (isset($_POST['PagerBottomButton']) && isset($_POST['crmPID_B'])) {
3527 $pageId = max((int) $_POST['crmPID_B'], 1);
3529 elseif (isset($_POST['PagerTopButton']) && isset($_POST['crmPID'])) {
3530 $pageId = max((int) $_POST['crmPID'], 1);
3532 unset($_POST['crmPID_B'], $_POST['crmPID']);
3535 $pageId = $pageId ?
$pageId : 1;
3536 $this->set(CRM_Utils_Pager
::PAGE_ID
, $pageId);
3537 $offset = ($pageId - 1) * $rowCount;
3539 $offset = CRM_Utils_Type
::escape($offset, 'Int');
3540 $rowCount = CRM_Utils_Type
::escape($rowCount, 'Int');
3542 $this->_limit
= " LIMIT $offset, $rowCount";
3543 return array($offset, $rowCount);
3545 if ($this->_limitValue
) {
3546 if ($this->_offsetValue
) {
3547 $this->_limit
= " LIMIT {$this->_offsetValue}, {$this->_limitValue} ";
3550 $this->_limit
= " LIMIT " . $this->_limitValue
;
3558 * @param int $rowCount
3560 public function setPager($rowCount = self
::ROW_COUNT_LIMIT
) {
3561 // CRM-14115, over-ride row count if rowCount is specified in URL
3562 if ($this->_dashBoardRowCount
) {
3563 $rowCount = $this->_dashBoardRowCount
;
3566 if ($this->_limit
&& ($this->_limit
!= '')) {
3567 if (!$this->_rowsFound
) {
3568 $sql = "SELECT FOUND_ROWS();";
3569 $this->_rowsFound
= CRM_Core_DAO
::singleValueQuery($sql);
3572 'total' => $this->_rowsFound
,
3573 'rowCount' => $rowCount,
3574 'status' => ts('Records') . ' %%StatusMessage%%',
3575 'buttonBottom' => 'PagerBottomButton',
3576 'buttonTop' => 'PagerTopButton',
3578 if (!empty($this->controller
)) {
3579 // This happens when being called from the api Really we want the api to be able to
3580 // pass paging parameters, but at this stage just preventing test crashes.
3581 $params['pageID'] = $this->get(CRM_Utils_Pager
::PAGE_ID
);
3584 $pager = new CRM_Utils_Pager($params);
3585 $this->assign_by_ref('pager', $pager);
3586 $this->ajaxResponse
['totalRows'] = $this->_rowsFound
;
3591 * Build a group filter with contempt for large data sets.
3593 * This function has been retained as it takes time to migrate the reports over
3594 * to the new method which will not crash on large datasets.
3598 * @param string $field
3599 * @param mixed $value
3604 public function legacySlowGroupFilterClause($field, $value, $op) {
3605 $smartGroupQuery = "";
3607 $group = new CRM_Contact_DAO_Group();
3608 $group->is_active
= 1;
3610 $smartGroups = array();
3611 while ($group->fetch()) {
3612 if (in_array($group->id
, (array) $this->_params
['gid_value']) &&
3613 $group->saved_search_id
3615 $smartGroups[] = $group->id
;
3619 CRM_Contact_BAO_GroupContactCache
::check($smartGroups);
3621 $smartGroupQuery = '';
3622 if (!empty($smartGroups)) {
3623 $smartGroups = implode(',', $smartGroups);
3624 $smartGroupQuery = " UNION DISTINCT
3625 SELECT DISTINCT smartgroup_contact.contact_id
3626 FROM civicrm_group_contact_cache smartgroup_contact
3627 WHERE smartgroup_contact.group_id IN ({$smartGroups}) ";
3630 $sqlOp = $this->getSQLOperator($op);
3631 if (!is_array($value)) {
3632 $value = array($value);
3634 //include child groups if any
3635 $value = array_merge($value, CRM_Contact_BAO_Group
::getChildGroupIds($value));
3637 $clause = "{$field['dbAlias']} IN (" . implode(', ', $value) . ")";
3639 $contactAlias = $this->_aliases
['civicrm_contact'];
3640 if (!empty($this->relationType
) && $this->relationType
== 'b_a') {
3641 $contactAlias = $this->_aliases
['civicrm_contact_b'];
3643 return " {$contactAlias}.id {$sqlOp} (
3644 SELECT DISTINCT {$this->_aliases['civicrm_group']}.contact_id
3645 FROM civicrm_group_contact {$this->_aliases['civicrm_group']}
3646 WHERE {$clause} AND {$this->_aliases['civicrm_group']}.status = 'Added'
3647 {$smartGroupQuery} ) ";
3651 * Build where clause for groups.
3653 * @param string $field
3654 * @param mixed $value
3659 public function whereGroupClause($field, $value, $op) {
3660 if ($this->groupFilterNotOptimised
) {
3661 return $this->legacySlowGroupFilterClause($field, $value, $op);
3663 if ($op === 'notin') {
3664 return " group_temp_table.id IS NULL ";
3666 // We will have used an inner join instead.
3672 * Create a table of the contact ids included by the group filter.
3674 * This function is called by both the api (tests) and the UI.
3676 public function buildGroupTempTable() {
3677 if (!empty($this->groupTempTable
) ||
empty($this->_params
['gid_value']) ||
$this->groupFilterNotOptimised
) {
3680 $filteredGroups = (array) $this->_params
['gid_value'];
3682 $groups = civicrm_api3('Group', 'get', array(
3684 'id' => array('IN' => $filteredGroups),
3685 'saved_search_id' => array('>' => 0),
3688 $smartGroups = array_keys($groups['values']);
3691 SELECT DISTINCT group_contact.contact_id as id
3692 FROM civicrm_group_contact group_contact
3693 WHERE group_contact.group_id IN (" . implode(', ', $filteredGroups) . ")
3694 AND group_contact.status = 'Added' ";
3696 if (!empty($smartGroups)) {
3697 CRM_Contact_BAO_GroupContactCache
::check($smartGroups);
3698 $smartGroups = implode(',', $smartGroups);
3701 SELECT smartgroup_contact.contact_id as id
3702 FROM civicrm_group_contact_cache smartgroup_contact
3703 WHERE smartgroup_contact.group_id IN ({$smartGroups}) ";
3706 $this->groupTempTable
= $this->createTemporaryTable('rptgrp', $query);
3707 CRM_Core_DAO
::executeQuery("ALTER TABLE $this->groupTempTable ADD INDEX i_id(id)");
3711 * Execute query and add it to the developer tab.
3713 * @param string $query
3714 * @param array $params
3716 * @return \CRM_Core_DAO|object
3718 protected function executeReportQuery($query, $params = array()) {
3719 $this->addToDeveloperTab($query);
3720 return CRM_Core_DAO
::executeQuery($query, $params);
3724 * Build where clause for tags.
3726 * @param string $field
3727 * @param mixed $value
3732 public function whereTagClause($field, $value, $op) {
3733 // not using left join in query because if any contact
3734 // belongs to more than one tag, results duplicate
3736 $sqlOp = $this->getSQLOperator($op);
3737 if (!is_array($value)) {
3738 $value = array($value);
3740 $clause = "{$field['dbAlias']} IN (" . implode(', ', $value) . ")";
3741 $entity_table = $this->_tagFilterTable
;
3742 return " {$this->_aliases[$entity_table]}.id {$sqlOp} (
3743 SELECT DISTINCT {$this->_aliases['civicrm_tag']}.entity_id
3744 FROM civicrm_entity_tag {$this->_aliases['civicrm_tag']}
3745 WHERE entity_table = '$entity_table' AND {$clause} ) ";
3749 * Generate membership organization clause.
3751 * @param mixed $value
3752 * @param string $op SQL Operator
3756 public function whereMembershipOrgClause($value, $op) {
3757 $sqlOp = $this->getSQLOperator($op);
3758 if (!is_array($value)) {
3759 $value = array($value);
3762 $tmp_membership_org_sql_list = implode(', ', $value);
3763 return " {$this->_aliases['civicrm_contact']}.id {$sqlOp} (
3764 SELECT DISTINCT mem.contact_id
3765 FROM civicrm_membership mem
3766 LEFT JOIN civicrm_membership_status mem_status ON mem.status_id = mem_status.id
3767 LEFT JOIN civicrm_membership_type mt ON mem.membership_type_id = mt.id
3768 WHERE mt.member_of_contact_id IN (" .
3769 $tmp_membership_org_sql_list . ")
3770 AND mt.is_active = '1'
3771 AND mem_status.is_current_member = '1'
3772 AND mem_status.is_active = '1' ) ";
3776 * Generate Membership Type SQL Clause.
3778 * @param mixed $value
3784 public function whereMembershipTypeClause($value, $op) {
3785 $sqlOp = $this->getSQLOperator($op);
3786 if (!is_array($value)) {
3787 $value = array($value);
3790 $tmp_membership_sql_list = implode(', ', $value);
3791 return " {$this->_aliases['civicrm_contact']}.id {$sqlOp} (
3792 SELECT DISTINCT mem.contact_id
3793 FROM civicrm_membership mem
3794 LEFT JOIN civicrm_membership_status mem_status ON mem.status_id = mem_status.id
3795 LEFT JOIN civicrm_membership_type mt ON mem.membership_type_id = mt.id
3796 WHERE mem.membership_type_id IN (" .
3797 $tmp_membership_sql_list . ")
3798 AND mt.is_active = '1'
3799 AND mem_status.is_current_member = '1'
3800 AND mem_status.is_active = '1' ) ";
3804 * Buld contact acl clause
3805 * @deprecated in favor of buildPermissionClause
3807 * @param string $tableAlias
3809 public function buildACLClause($tableAlias = 'contact_a') {
3810 list($this->_aclFrom
, $this->_aclWhere
) = CRM_Contact_BAO_Contact_Permission
::cacheClause($tableAlias);
3814 * Build the permision clause for all entities in this report
3816 public function buildPermissionClause() {
3818 foreach ($this->selectedTables() as $tableName) {
3819 $baoName = str_replace('_DAO_', '_BAO_', CRM_Core_DAO_AllCoreTables
::getClassForTable($tableName));
3820 if ($baoName && class_exists($baoName) && !empty($this->_columns
[$tableName]['alias'])) {
3821 $tableAlias = $this->_columns
[$tableName]['alias'];
3822 $clauses = array_filter($baoName::getSelectWhereClause($tableAlias));
3823 foreach ($clauses as $field => $clause) {
3824 // Skip contact_id field if redundant
3825 if ($field != 'contact_id' ||
!in_array('civicrm_contact', $this->selectedTables())) {
3826 $ret["$tableName.$field"] = $clause;
3831 // Override output from buildACLClause
3832 $this->_aclFrom
= NULL;
3833 $this->_aclWhere
= implode(' AND ', $ret);
3837 * Add custom data to the columns.
3839 * @param bool $addFields
3840 * @param array $permCustomGroupIds
3842 public function addCustomDataToColumns($addFields = TRUE, $permCustomGroupIds = array()) {
3843 if (empty($this->_customGroupExtends
)) {
3846 if (!is_array($this->_customGroupExtends
)) {
3847 $this->_customGroupExtends
= array($this->_customGroupExtends
);
3849 $customGroupWhere = '';
3850 if (!empty($permCustomGroupIds)) {
3851 $customGroupWhere = "cg.id IN (" . implode(',', $permCustomGroupIds) .
3855 SELECT cg.table_name, cg.title, cg.extends, cf.id as cf_id, cf.label,
3856 cf.column_name, cf.data_type, cf.html_type, cf.option_group_id, cf.time_format
3857 FROM civicrm_custom_group cg
3858 INNER JOIN civicrm_custom_field cf ON cg.id = cf.custom_group_id
3859 WHERE cg.extends IN ('" . implode("','", $this->_customGroupExtends
) . "') AND
3861 cg.is_active = 1 AND
3862 cf.is_active = 1 AND
3863 cf.is_searchable = 1
3864 ORDER BY cg.weight, cf.weight";
3865 $customDAO = CRM_Core_DAO
::executeQuery($sql);
3868 while ($customDAO->fetch()) {
3869 if ($customDAO->table_name
!= $curTable) {
3870 $curTable = $customDAO->table_name
;
3871 $curFields = $curFilters = array();
3874 $this->_columns
[$curTable]['dao'] = 'CRM_Contact_DAO_Contact';
3875 $this->_columns
[$curTable]['extends'] = $customDAO->extends;
3876 $this->_columns
[$curTable]['grouping'] = $customDAO->table_name
;
3877 $this->_columns
[$curTable]['group_title'] = $customDAO->title
;
3879 foreach (array('fields', 'filters', 'group_bys') as $colKey) {
3880 if (!array_key_exists($colKey, $this->_columns
[$curTable])) {
3881 $this->_columns
[$curTable][$colKey] = array();
3885 $fieldName = 'custom_' . $customDAO->cf_id
;
3888 // this makes aliasing work in favor
3889 $curFields[$fieldName] = array(
3890 'name' => $customDAO->column_name
,
3891 'title' => $customDAO->label
,
3892 'dataType' => $customDAO->data_type
,
3893 'htmlType' => $customDAO->html_type
,
3896 if ($this->_customGroupFilters
) {
3897 // this makes aliasing work in favor
3898 $curFilters[$fieldName] = array(
3899 'name' => $customDAO->column_name
,
3900 'title' => $customDAO->label
,
3901 'dataType' => $customDAO->data_type
,
3902 'htmlType' => $customDAO->html_type
,
3906 switch ($customDAO->data_type
) {
3909 $curFilters[$fieldName]['operatorType'] = CRM_Report_Form
::OP_DATE
;
3910 $curFilters[$fieldName]['type'] = CRM_Utils_Type
::T_DATE
;
3911 // CRM-6946, show time part for datetime date fields
3912 if ($customDAO->time_format
) {
3913 $curFields[$fieldName]['type'] = CRM_Utils_Type
::T_TIMESTAMP
;
3918 $curFilters[$fieldName]['operatorType'] = CRM_Report_Form
::OP_SELECT
;
3919 $curFilters[$fieldName]['options'] = array('' => ts('- select -')) + CRM_Core_PseudoConstant
::get('CRM_Core_BAO_CustomField', 'custom_' . $customDAO->cf_id
, array(), 'search');
3920 $curFilters[$fieldName]['type'] = CRM_Utils_Type
::T_INT
;
3924 $curFilters[$fieldName]['operatorType'] = CRM_Report_Form
::OP_INT
;
3925 $curFilters[$fieldName]['type'] = CRM_Utils_Type
::T_INT
;
3929 $curFilters[$fieldName]['operatorType'] = CRM_Report_Form
::OP_FLOAT
;
3930 $curFilters[$fieldName]['type'] = CRM_Utils_Type
::T_MONEY
;
3931 $curFields[$fieldName]['type'] = CRM_Utils_Type
::T_MONEY
;
3935 $curFilters[$fieldName]['operatorType'] = CRM_Report_Form
::OP_FLOAT
;
3936 $curFilters[$fieldName]['type'] = CRM_Utils_Type
::T_FLOAT
;
3940 case 'StateProvince':
3942 $curFilters[$fieldName]['type'] = CRM_Utils_Type
::T_STRING
;
3944 $options = CRM_Core_PseudoConstant
::get('CRM_Core_BAO_CustomField', 'custom_' . $customDAO->cf_id
, array(), 'search');
3945 if ((is_array($options) && count($options) != 0) ||
(!is_array($options) && $options !== FALSE)) {
3946 $curFilters[$fieldName]['operatorType'] = CRM_Core_BAO_CustomField
::isSerialized($customDAO) ? CRM_Report_Form
::OP_MULTISELECT_SEPARATOR
: CRM_Report_Form
::OP_MULTISELECT
;
3947 $curFilters[$fieldName]['options'] = $options;
3951 case 'ContactReference':
3952 $curFilters[$fieldName]['type'] = CRM_Utils_Type
::T_STRING
;
3953 $curFilters[$fieldName]['name'] = 'display_name';
3954 $curFilters[$fieldName]['alias'] = "contact_{$fieldName}_civireport";
3956 $curFields[$fieldName]['type'] = CRM_Utils_Type
::T_STRING
;
3957 $curFields[$fieldName]['name'] = 'display_name';
3958 $curFields[$fieldName]['alias'] = "contact_{$fieldName}_civireport";
3962 $curFields[$fieldName]['type'] = CRM_Utils_Type
::T_STRING
;
3963 $curFilters[$fieldName]['type'] = CRM_Utils_Type
::T_STRING
;
3967 if ($customDAO->html_type
== 'Select' && !array_key_exists('options', $curFilters[$fieldName])) {
3968 $options = CRM_Core_PseudoConstant
::get('CRM_Core_BAO_CustomField', 'custom_' . $customDAO->cf_id
, array(), 'search');
3969 if ($options !== FALSE) {
3970 $curFilters[$fieldName]['operatorType'] = CRM_Core_BAO_CustomField
::isSerialized($customDAO) ? CRM_Report_Form
::OP_MULTISELECT_SEPARATOR
: CRM_Report_Form
::OP_MULTISELECT
;
3971 $curFilters[$fieldName]['options'] = $options;
3975 if (!array_key_exists('type', $curFields[$fieldName])) {
3976 $curFields[$fieldName]['type'] = CRM_Utils_Array
::value('type', $curFilters[$fieldName], array());
3980 $this->_columns
[$curTable]['fields'] = array_merge($this->_columns
[$curTable]['fields'], $curFields);
3982 if ($this->_customGroupFilters
) {
3983 $this->_columns
[$curTable]['filters'] = array_merge($this->_columns
[$curTable]['filters'], $curFilters);
3985 if ($this->_customGroupGroupBy
) {
3986 $this->_columns
[$curTable]['group_bys'] = array_merge($this->_columns
[$curTable]['group_bys'], $curFields);
3992 * Build custom data from clause.
3994 * @param bool $joinsForFiltersOnly
3995 * Only include joins to support filters. This would be used if creating a table of contacts to include first.
3997 public function customDataFrom($joinsForFiltersOnly = FALSE) {
3998 if (empty($this->_customGroupExtends
)) {
4001 $mapper = CRM_Core_BAO_CustomQuery
::$extendsMap;
4002 //CRM-18276 GROUP_CONCAT could be used with singleValueQuery and then exploded,
4003 //but by default that truncates to 1024 characters, which causes errors with installs with lots of custom field sets
4004 $customTables = array();
4005 $customTablesDAO = CRM_Core_DAO
::executeQuery("SELECT table_name FROM civicrm_custom_group");
4006 while ($customTablesDAO->fetch()) {
4007 $customTables[] = $customTablesDAO->table_name
;
4010 foreach ($this->_columns
as $table => $prop) {
4011 if (in_array($table, $customTables)) {
4012 $extendsTable = $mapper[$prop['extends']];
4013 // Check field is required for rendering the report.
4014 if ((!$this->isFieldSelected($prop)) ||
($joinsForFiltersOnly && !$this->isFieldFiltered($prop))) {
4017 $baseJoin = CRM_Utils_Array
::value($prop['extends'], $this->_customGroupExtendsJoin
, "{$this->_aliases[$extendsTable]}.id");
4019 $customJoin = is_array($this->_customGroupJoin
) ?
$this->_customGroupJoin
[$table] : $this->_customGroupJoin
;
4021 {$customJoin} {$table} {$this->_aliases[$table]} ON {$this->_aliases[$table]}.entity_id = {$baseJoin}";
4022 // handle for ContactReference
4023 if (array_key_exists('fields', $prop)) {
4024 foreach ($prop['fields'] as $fieldName => $field) {
4025 if (CRM_Utils_Array
::value('dataType', $field) ==
4028 $columnName = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_CustomField', CRM_Core_BAO_CustomField
::getKeyID($fieldName), 'column_name');
4030 LEFT JOIN civicrm_contact {$field['alias']} ON {$field['alias']}.id = {$this->_aliases[$table]}.{$columnName} ";
4039 * Check if the field is selected.
4041 * @param string $prop
4045 public function isFieldSelected($prop) {
4050 if (!empty($this->_params
['fields'])) {
4051 foreach (array_keys($prop['fields']) as $fieldAlias) {
4052 $customFieldId = CRM_Core_BAO_CustomField
::getKeyID($fieldAlias);
4053 if ($customFieldId) {
4054 if (array_key_exists($fieldAlias, $this->_params
['fields'])) {
4058 //might be survey response field.
4059 if (!empty($this->_params
['fields']['survey_response']) &&
4060 !empty($prop['fields'][$fieldAlias]['isSurveyResponseField'])
4068 if (!empty($this->_params
['group_bys']) && $this->_customGroupGroupBy
) {
4069 foreach (array_keys($prop['group_bys']) as $fieldAlias) {
4070 if (array_key_exists($fieldAlias, $this->_params
['group_bys']) &&
4071 CRM_Core_BAO_CustomField
::getKeyID($fieldAlias)
4078 if (!empty($this->_params
['order_bys'])) {
4079 foreach (array_keys($prop['fields']) as $fieldAlias) {
4080 foreach ($this->_params
['order_bys'] as $orderBy) {
4081 if ($fieldAlias == $orderBy['column'] &&
4082 CRM_Core_BAO_CustomField
::getKeyID($fieldAlias)
4089 return $this->isFieldFiltered($prop);
4094 * Check if the field is used as a filter.
4096 * @param string $prop
4100 protected function isFieldFiltered($prop) {
4101 if (!empty($prop['filters']) && $this->_customGroupFilters
) {
4102 foreach ($prop['filters'] as $fieldAlias => $val) {
4111 if (isset($this->_params
[$fieldAlias . '_' . $attach]) &&
4112 (!empty($this->_params
[$fieldAlias . '_' . $attach])
4113 ||
($attach != 'relative' &&
4114 $this->_params
[$fieldAlias . '_' . $attach] == '0')
4120 if (!empty($this->_params
[$fieldAlias . '_op']) &&
4121 in_array($this->_params
[$fieldAlias . '_op'], array('nll', 'nnll'))
4132 * Check for empty order_by configurations and remove them.
4134 * Also set template to hide them.
4136 * @param array $formValues
4138 public function preProcessOrderBy(&$formValues) {
4139 // Object to show/hide form elements
4140 $_showHide = new CRM_Core_ShowHideBlocks('', '');
4142 $_showHide->addShow('optionField_1');
4144 // Cycle through order_by options; skip any empty ones, and hide them as well
4147 if (!empty($formValues['order_bys'])) {
4148 foreach ($formValues['order_bys'] as $order_by) {
4149 if ($order_by['column'] && $order_by['column'] != '-') {
4150 $_showHide->addShow('optionField_' . $n);
4151 $orderBys[$n] = $order_by;
4156 for ($i = $n; $i <= 5; $i++
) {
4158 $_showHide->addHide('optionField_' . $i);
4162 // overwrite order_by options with modified values
4163 if (!empty($orderBys)) {
4164 $formValues['order_bys'] = $orderBys;
4167 $formValues['order_bys'] = array(1 => array('column' => '-'));
4170 // assign show/hide data to template
4171 $_showHide->addToTemplate();
4175 * Check if table name has columns in SELECT clause.
4177 * @param string $tableName
4178 * Name of table (index of $this->_columns array).
4182 public function isTableSelected($tableName) {
4183 return in_array($tableName, $this->selectedTables());
4187 * Check if table name has columns in WHERE or HAVING clause.
4189 * @param string $tableName
4190 * Name of table (index of $this->_columns array).
4194 public function isTableFiltered($tableName) {
4195 // Cause the array to be generated if not previously done.
4196 if (!$this->_selectedTables
&& !$this->filteredTables
) {
4197 $this->selectedTables();
4199 return in_array($tableName, $this->filteredTables
);
4203 * Fetch array of DAO tables having columns included in SELECT or ORDER BY clause.
4205 * If the array is unset it will be built.
4210 public function selectedTables() {
4211 if (!$this->_selectedTables
) {
4212 $orderByColumns = array();
4213 if (array_key_exists('order_bys', $this->_params
) &&
4214 is_array($this->_params
['order_bys'])
4216 foreach ($this->_params
['order_bys'] as $orderBy) {
4217 $orderByColumns[] = $orderBy['column'];
4221 foreach ($this->_columns
as $tableName => $table) {
4222 if (array_key_exists('fields', $table)) {
4223 foreach ($table['fields'] as $fieldName => $field) {
4224 if (!empty($field['required']) ||
4225 !empty($this->_params
['fields'][$fieldName])
4227 $this->_selectedTables
[] = $tableName;
4232 if (array_key_exists('order_bys', $table)) {
4233 foreach ($table['order_bys'] as $orderByName => $orderBy) {
4234 if (in_array($orderByName, $orderByColumns)) {
4235 $this->_selectedTables
[] = $tableName;
4240 if (array_key_exists('filters', $table)) {
4241 foreach ($table['filters'] as $filterName => $filter) {
4242 if (!empty($this->_params
["{$filterName}_value"])
4243 ||
!empty($this->_params
["{$filterName}_relative"])
4244 || CRM_Utils_Array
::value("{$filterName}_op", $this->_params
) ==
4246 || CRM_Utils_Array
::value("{$filterName}_op", $this->_params
) ==
4249 $this->_selectedTables
[] = $tableName;
4250 $this->filteredTables
[] = $tableName;
4257 return $this->_selectedTables
;
4261 * Add campaign fields.
4263 * @param bool $groupBy
4264 * Add GroupBy? Not appropriate for detail report.
4265 * @param bool $orderBy
4266 * Add OrderBy? Not appropriate for detail report.
4267 * @param bool $filters
4270 public function addCampaignFields($entityTable = 'civicrm_contribution', $groupBy = FALSE, $orderBy = FALSE, $filters = TRUE) {
4271 // Check if CiviCampaign is a) enabled and b) has active campaigns
4272 $config = CRM_Core_Config
::singleton();
4273 $campaignEnabled = in_array('CiviCampaign', $config->enableComponents
);
4274 if ($campaignEnabled) {
4275 $getCampaigns = CRM_Campaign_BAO_Campaign
::getPermissionedCampaigns(NULL, NULL, FALSE, FALSE, TRUE);
4276 // If we have a campaign, build out the relevant elements
4277 if (!empty($getCampaigns['campaigns'])) {
4278 $this->campaigns
= $getCampaigns['campaigns'];
4279 asort($this->campaigns
);
4280 $this->_columns
[$entityTable]['fields']['campaign_id'] = array('title' => ts('Campaign'), 'default' => 'false');
4282 $this->_columns
[$entityTable]['filters']['campaign_id'] = array(
4283 'title' => ts('Campaign'),
4284 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
4285 'options' => $this->campaigns
,
4286 'type' => CRM_Utils_Type
::T_INT
,
4291 $this->_columns
[$entityTable]['group_bys']['campaign_id'] = array('title' => ts('Campaign'));
4295 $this->_columns
[$entityTable]['order_bys']['campaign_id'] = array('title' => ts('Campaign'));
4302 * Add address fields.
4304 * @deprecated - use getAddressColumns which is a more accurate description
4305 * and also accepts an array of options rather than a long list
4307 * adding address fields to construct function in reports
4309 * @param bool $groupBy
4310 * Add GroupBy? Not appropriate for detail report.
4311 * @param bool $orderBy
4312 * Add GroupBy? Not appropriate for detail report.
4313 * @param bool $filters
4314 * @param array $defaults
4317 * address fields for construct clause
4319 public function addAddressFields($groupBy = TRUE, $orderBy = FALSE, $filters = TRUE, $defaults = array('country_id' => TRUE)) {
4320 $defaultAddressFields = array(
4321 'street_address' => ts('Street Address'),
4322 'supplemental_address_1' => ts('Supplementary Address Field 1'),
4323 'supplemental_address_2' => ts('Supplementary Address Field 2'),
4324 'supplemental_address_3' => ts('Supplementary Address Field 3'),
4325 'street_number' => ts('Street Number'),
4326 'street_name' => ts('Street Name'),
4327 'street_unit' => ts('Street Unit'),
4328 'city' => ts('City'),
4329 'postal_code' => ts('Postal Code'),
4330 'postal_code_suffix' => ts('Postal Code Suffix'),
4331 'country_id' => ts('Country'),
4332 'state_province_id' => ts('State/Province'),
4333 'county_id' => ts('County'),
4335 $addressFields = array(
4336 'civicrm_address' => array(
4337 'dao' => 'CRM_Core_DAO_Address',
4339 'address_name' => array(
4340 'title' => ts('Address Name'),
4341 'default' => CRM_Utils_Array
::value('name', $defaults, FALSE),
4345 'grouping' => 'location-fields',
4348 foreach ($defaultAddressFields as $fieldName => $fieldLabel) {
4349 $addressFields['civicrm_address']['fields'][$fieldName] = array(
4350 'title' => $fieldLabel,
4351 'default' => CRM_Utils_Array
::value($fieldName, $defaults, FALSE),
4355 $street_address_filters = $general_address_filters = array();
4357 // Address filter depends on whether street address parsing is enabled.
4359 $addressOptions = CRM_Core_BAO_Setting
::valueOptions(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
4362 if ($addressOptions['street_address_parsing']) {
4363 $street_address_filters = array(
4364 'street_number' => array(
4365 'title' => ts('Street Number'),
4366 'type' => CRM_Utils_Type
::T_INT
,
4367 'name' => 'street_number',
4369 'street_name' => array(
4370 'title' => ts('Street Name'),
4371 'name' => 'street_name',
4372 'type' => CRM_Utils_Type
::T_STRING
,
4377 $street_address_filters = array(
4378 'street_address' => array(
4379 'title' => ts('Street Address'),
4380 'type' => CRM_Utils_Type
::T_STRING
,
4381 'name' => 'street_address',
4385 $general_address_filters = array(
4386 'postal_code' => array(
4387 'title' => ts('Postal Code'),
4388 'type' => CRM_Utils_Type
::T_STRING
,
4389 'name' => 'postal_code',
4392 'title' => ts('City'),
4393 'type' => CRM_Utils_Type
::T_STRING
,
4396 'country_id' => array(
4397 'name' => 'country_id',
4398 'title' => ts('Country'),
4399 'type' => CRM_Utils_Type
::T_INT
,
4400 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
4401 'options' => CRM_Core_PseudoConstant
::country(),
4403 'state_province_id' => array(
4404 'name' => 'state_province_id',
4405 'title' => ts('State/Province'),
4406 'type' => CRM_Utils_Type
::T_INT
,
4407 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
4408 'options' => array(),
4410 'county_id' => array(
4411 'name' => 'county_id',
4412 'title' => ts('County'),
4413 'type' => CRM_Utils_Type
::T_INT
,
4414 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
4415 'options' => array(),
4419 $addressFields['civicrm_address']['filters'] = array_merge(
4420 $street_address_filters,
4421 $general_address_filters);
4424 $addressFields['civicrm_address']['order_bys'] = array(
4425 'street_name' => array('title' => ts('Street Name')),
4426 'street_number' => array('title' => ts('Odd / Even Street Number')),
4427 'street_address' => NULL,
4429 'postal_code' => NULL,
4434 $addressFields['civicrm_address']['group_bys'] = array(
4435 'street_address' => NULL,
4437 'postal_code' => NULL,
4438 'state_province_id' => array(
4439 'title' => ts('State/Province'),
4441 'country_id' => array(
4442 'title' => ts('Country'),
4444 'county_id' => array(
4445 'title' => ts('County'),
4449 return $addressFields;
4453 * Do AlterDisplay processing on Address Fields.
4454 * If there are multiple address field values then
4455 * on basis of provided separator the code values are translated into respective labels
4458 * @param array $rows
4459 * @param int $rowNum
4460 * @param string $baseUrl
4461 * @param string $linkText
4462 * @param string $separator
4466 public function alterDisplayAddressFields(&$row, &$rows, &$rowNum, $baseUrl, $linkText, $separator = ',') {
4467 $criteriaQueryParams = CRM_Report_Utils_Report
::getPreviewCriteriaQueryParams($this->_defaults
, $this->_params
);
4468 $entryFound = FALSE;
4470 'civicrm_address_country_id' => 'country',
4471 'civicrm_address_county_id' => 'county',
4472 'civicrm_address_state_province_id' => 'stateProvince',
4474 foreach ($columnMap as $fieldName => $fnName) {
4475 if (array_key_exists($fieldName, $row)) {
4476 if ($values = $row[$fieldName]) {
4477 $values = (array) explode($separator, $values);
4478 $rows[$rowNum][$fieldName] = [];
4479 $addressField = $fnName == 'stateProvince' ?
'state' : $fnName;
4480 foreach ($values as $value) {
4481 $rows[$rowNum][$fieldName][] = CRM_Core_PseudoConstant
::$fnName($value);
4483 $rows[$rowNum][$fieldName] = implode($separator, $rows[$rowNum][$fieldName]);
4485 $url = CRM_Report_Utils_Report
::getNextUrl($baseUrl,
4486 sprintf("reset=1&force=1&%s&%s_op=in&%s_value=%s",
4487 $criteriaQueryParams,
4488 str_replace('civicrm_address_', '', $fieldName),
4489 str_replace('civicrm_address_', '', $fieldName),
4490 implode(',', $values)
4491 ), $this->_absoluteUrl
, $this->_id
4493 $rows[$rowNum]["{$fieldName}_link"] = $url;
4494 $rows[$rowNum]["{$fieldName}_hover"] = ts("%1 for this %2.", array(1 => $linkText, 2 => $addressField));
4505 * Do AlterDisplay processing on Address Fields.
4508 * @param array $rows
4509 * @param int $rowNum
4510 * @param string $baseUrl
4511 * @param string $linkText
4515 public function alterDisplayContactFields(&$row, &$rows, &$rowNum, $baseUrl, $linkText) {
4516 $entryFound = FALSE;
4517 // There is no reason not to add links for all fields but it seems a bit odd to be able to click on
4518 // 'Mrs'. Also, we don't have metadata about the title. So, add selectively to addLinks.
4519 $addLinks = array('gender_id' => 'Gender');
4520 foreach (array('prefix_id', 'suffix_id', 'gender_id', 'contact_sub_type', 'preferred_language') as $fieldName) {
4521 if (array_key_exists('civicrm_contact_' . $fieldName, $row)) {
4522 if (($value = $row['civicrm_contact_' . $fieldName]) != FALSE) {
4523 $rowValues = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $value);
4524 $rowLabels = array();
4525 foreach ($rowValues as $rowValue) {
4527 $rowLabels[] = CRM_Core_PseudoConstant
::getLabel('CRM_Contact_BAO_Contact', $fieldName, $rowValue);
4530 $rows[$rowNum]['civicrm_contact_' . $fieldName] = implode(', ', $rowLabels);
4531 if ($baseUrl && ($title = CRM_Utils_Array
::value($fieldName, $addLinks)) != FALSE) {
4532 $this->addLinkToRow($rows[$rowNum], $baseUrl, $linkText, $value, $fieldName, 'civicrm_contact', $title);
4538 $yesNoFields = array(
4539 'do_not_email', 'is_deceased', 'do_not_phone', 'do_not_sms', 'do_not_mail', 'is_opt_out',
4541 foreach ($yesNoFields as $fieldName) {
4542 if (array_key_exists('civicrm_contact_' . $fieldName, $row)) {
4543 // Since these are essentially 'negative fields' it feels like it
4544 // makes sense to only highlight the exceptions hence no 'No'.
4545 $rows[$rowNum]['civicrm_contact_' . $fieldName] = !empty($rows[$rowNum]['civicrm_contact_' . $fieldName]) ?
ts('Yes') : '';
4550 // Handle employer id
4551 if (array_key_exists('civicrm_contact_employer_id', $row)) {
4552 $employerId = $row['civicrm_contact_employer_id'];
4554 $rows[$rowNum]['civicrm_contact_employer_id'] = CRM_Contact_BAO_Contact
::displayName($employerId);
4555 $rows[$rowNum]['civicrm_contact_employer_id_link'] = CRM_Utils_System
::url('civicrm/contact/view', 'reset=1&cid=' . $employerId, $this->_absoluteUrl
);
4556 $rows[$rowNum]['civicrm_contact_employer_id_hover'] = ts('View Contact Summary for Employer.');
4565 * Adjusts dates passed in to YEAR() for fiscal year.
4567 * @param string $fieldName
4571 public function fiscalYearOffset($fieldName) {
4572 $config = CRM_Core_Config
::singleton();
4573 $fy = $config->fiscalYearStart
;
4574 if (CRM_Utils_Array
::value('yid_op', $this->_params
) == 'calendar' ||
4575 ($fy['d'] == 1 && $fy['M'] == 1)
4577 return "YEAR( $fieldName )";
4579 return "YEAR( $fieldName - INTERVAL " . ($fy['M'] - 1) . " MONTH" .
4580 ($fy['d'] > 1 ?
(" - INTERVAL " . ($fy['d'] - 1) . " DAY") : '') . " )";
4584 * Add Address into From Table if required.
4586 * @deprecated use joinAddressFromContact
4587 * (left here in case extensions use it).
4589 public function addAddressFromClause() {
4590 CRM_Core_Error
::deprecatedFunctionWarning('CRM_Report_Form::joinAddressFromContact');
4591 // include address field if address column is to be included
4592 if ((isset($this->_addressField
) &&
4593 $this->_addressField
4595 $this->isTableSelected('civicrm_address')
4598 LEFT JOIN civicrm_address {$this->_aliases['civicrm_address']}
4599 ON ({$this->_aliases['civicrm_contact']}.id =
4600 {$this->_aliases['civicrm_address']}.contact_id) AND
4601 {$this->_aliases['civicrm_address']}.is_primary = 1\n";
4606 * Add Phone into From Table if required.
4608 * @deprecated use joinPhoneFromContact
4609 * (left here in case extensions use it).
4611 public function addPhoneFromClause() {
4612 CRM_Core_Error
::deprecatedFunctionWarning('CRM_Report_Form::joinPhoneFromContact');
4613 // include address field if address column is to be included
4614 if ($this->isTableSelected('civicrm_phone')) {
4616 LEFT JOIN civicrm_phone {$this->_aliases['civicrm_phone']}
4617 ON ({$this->_aliases['civicrm_contact']}.id =
4618 {$this->_aliases['civicrm_phone']}.contact_id) AND
4619 {$this->_aliases['civicrm_phone']}.is_primary = 1\n";
4624 * Add Address into From Table if required.
4626 * Prefix will be added to both tables as
4627 * it is assumed you are using it to get address of a secondary contact.
4629 * @param string $prefix
4630 * @param array $extra Additional options.
4631 * Not currently used in core but may be used in override extensions.
4633 protected function joinAddressFromContact($prefix = '', $extra = array()) {
4634 $addressTables = ['civicrm_address', 'civicrm_country', 'civicrm_worldregion', 'civicrm_state_province'];
4635 $isJoinRequired = $this->_addressField
;
4636 foreach ($addressTables as $addressTable) {
4637 if ($this->isTableSelected($prefix . $addressTable)) {
4638 $isJoinRequired = TRUE;
4641 if ($isJoinRequired) {
4643 LEFT JOIN civicrm_address {$this->_aliases[$prefix . 'civicrm_address']}
4644 ON ({$this->_aliases[$prefix . 'civicrm_contact']}.id =
4645 {$this->_aliases[$prefix . 'civicrm_address']}.contact_id) AND
4646 {$this->_aliases[$prefix . 'civicrm_address']}.is_primary = 1\n";
4651 * Add Country into From Table if required.
4653 * Prefix will be added to both tables as
4654 * it is assumed you are using it to get address of a secondary contact.
4656 * @param string $prefix
4657 * @param array $extra Additional options.
4658 * Not currently used in core but may be used in override extensions.
4660 protected function joinCountryFromAddress($prefix = '', $extra = array()) {
4661 // include country field if country column is to be included
4662 if ($this->isTableSelected($prefix . 'civicrm_country') ||
$this->isTableSelected($prefix . 'civicrm_worldregion')) {
4663 if (empty($this->_aliases
[$prefix . 'civicrm_country'])) {
4664 $this->_aliases
[$prefix . 'civicrm_country'] = $prefix . '_report_country';
4667 LEFT JOIN civicrm_country {$this->_aliases[$prefix . 'civicrm_country']}
4668 ON {$this->_aliases[$prefix . 'civicrm_address']}.country_id = {$this->_aliases[$prefix . 'civicrm_country']}.id AND
4669 {$this->_aliases[$prefix . 'civicrm_address']}.is_primary = 1 ";
4674 * Add Phone into From Table if required.
4676 * Prefix will be added to both tables as
4677 * it is assumed you are using it to get address of a secondary contact.
4679 * @param string $prefix
4680 * @param array $extra Additional options.
4681 * Not currently used in core but may be used in override extensions.
4683 protected function joinPhoneFromContact($prefix = '', $extra = array()) {
4684 // include phone field if phone column is to be included
4685 if ($this->isTableSelected($prefix . 'civicrm_phone')) {
4687 LEFT JOIN civicrm_phone {$this->_aliases[$prefix . 'civicrm_phone']}
4688 ON {$this->_aliases[$prefix . 'civicrm_contact']}.id = {$this->_aliases[$prefix . 'civicrm_phone']}.contact_id AND
4689 {$this->_aliases[$prefix . 'civicrm_phone']}.is_primary = 1\n";
4694 * Add Email into From Table if required.
4696 * Prefix will be added to both tables as
4697 * it is assumed you are using it to get address of a secondary contact.
4699 * @param string $prefix
4700 * @param array $extra Additional options.
4701 * Not currently used in core but may be used in override extensions.
4703 protected function joinEmailFromContact($prefix = '', $extra = array()) {
4704 // include email field if email column is to be included
4705 if ($this->isTableSelected($prefix . 'civicrm_email')) {
4707 LEFT JOIN civicrm_email {$this->_aliases[$prefix . 'civicrm_email']}
4708 ON ({$this->_aliases[$prefix . 'civicrm_contact']}.id = {$this->_aliases[$prefix . 'civicrm_email']}.contact_id AND
4709 {$this->_aliases[$prefix . 'civicrm_email']}.is_primary = 1) ";
4714 * Add Financial Transaction into From Table if required.
4716 public function addFinancialTrxnFromClause() {
4717 if ($this->isTableSelected('civicrm_financial_trxn')) {
4719 LEFT JOIN civicrm_entity_financial_trxn eftcc
4720 ON ({$this->_aliases['civicrm_contribution']}.id = eftcc.entity_id AND
4721 eftcc.entity_table = 'civicrm_contribution')
4722 LEFT JOIN civicrm_financial_trxn {$this->_aliases['civicrm_financial_trxn']}
4723 ON {$this->_aliases['civicrm_financial_trxn']}.id = eftcc.financial_trxn_id \n";
4728 * Get phone columns to add to array.
4730 * @param array $options
4731 * - prefix Prefix to add to table (in case of more than one instance of the table)
4732 * - prefix_label Label to give columns from this phone table instance
4735 * phone columns definition
4737 public function getPhoneColumns($options = array()) {
4738 $defaultOptions = array(
4740 'prefix_label' => '',
4743 $options = array_merge($defaultOptions, $options);
4746 $options['prefix'] . 'civicrm_phone' => array(
4747 'dao' => 'CRM_Core_DAO_Phone',
4749 $options['prefix'] . 'phone' => array(
4750 'title' => $options['prefix_label'] . ts('Phone'),
4760 * Get a standard set of contact fields.
4764 public function getBasicContactFields() {
4766 'sort_name' => array(
4767 'title' => ts('Contact Name'),
4772 'no_display' => TRUE,
4775 'prefix_id' => array(
4776 'title' => ts('Contact Prefix'),
4778 'first_name' => array(
4779 'title' => ts('First Name'),
4781 'nick_name' => array(
4782 'title' => ts('Nick Name'),
4784 'middle_name' => array(
4785 'title' => ts('Middle Name'),
4787 'last_name' => array(
4788 'title' => ts('Last Name'),
4790 'suffix_id' => array(
4791 'title' => ts('Contact Suffix'),
4793 'postal_greeting_display' => array('title' => ts('Postal Greeting')),
4794 'email_greeting_display' => array('title' => ts('Email Greeting')),
4795 'addressee_display' => array('title' => ts('Addressee')),
4796 'contact_type' => array(
4797 'title' => ts('Contact Type'),
4799 'contact_sub_type' => array(
4800 'title' => ts('Contact Subtype'),
4802 'gender_id' => array(
4803 'title' => ts('Gender'),
4805 'birth_date' => array(
4806 'title' => ts('Birth Date'),
4809 'title' => ts('Age'),
4810 'dbAlias' => 'TIMESTAMPDIFF(YEAR, contact_civireport.birth_date, CURDATE())',
4812 'job_title' => array(
4813 'title' => ts('Contact Job title'),
4815 'organization_name' => array(
4816 'title' => ts('Organization Name'),
4818 'external_identifier' => array(
4819 'title' => ts('Contact identifier from external system'),
4821 'do_not_email' => array(),
4822 'do_not_phone' => array(),
4823 'do_not_mail' => array(),
4824 'do_not_sms' => array(),
4825 'is_opt_out' => array(),
4826 'is_deceased' => array(),
4827 'preferred_language' => array(),
4828 'employer_id' => array(
4829 'title' => ts('Current Employer'),
4835 * Get a standard set of contact filters.
4837 * @param array $defaults
4841 public function getBasicContactFilters($defaults = array()) {
4843 'sort_name' => array(
4844 'title' => ts('Contact Name'),
4847 'title' => ts('Contact Source'),
4848 'type' => CRM_Utils_Type
::T_STRING
,
4851 'title' => ts('Contact ID'),
4852 'no_display' => TRUE,
4854 'gender_id' => array(
4855 'title' => ts('Gender'),
4856 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
4857 'options' => CRM_Core_PseudoConstant
::get('CRM_Contact_DAO_Contact', 'gender_id'),
4859 'birth_date' => array(
4860 'title' => ts('Birth Date'),
4861 'operatorType' => CRM_Report_Form
::OP_DATE
,
4863 'contact_type' => array(
4864 'title' => ts('Contact Type'),
4866 'contact_sub_type' => array(
4867 'title' => ts('Contact Subtype'),
4869 'modified_date' => array(
4870 'title' => ts('Contact Modified'),
4871 'operatorType' => CRM_Report_Form
::OP_DATE
,
4872 'type' => CRM_Utils_Type
::T_DATE
,
4874 'is_deceased' => array(
4875 'title' => ts('Deceased'),
4876 'type' => CRM_Utils_Type
::T_BOOLEAN
,
4877 'default' => CRM_Utils_Array
::value('deceased', $defaults, 0),
4879 'do_not_email' => array(
4880 'title' => ts('Do not email'),
4881 'type' => CRM_Utils_Type
::T_BOOLEAN
,
4883 'do_not_phone' => array(
4884 'title' => ts('Do not phone'),
4885 'type' => CRM_Utils_Type
::T_BOOLEAN
,
4887 'do_not_mail' => array(
4888 'title' => ts('Do not mail'),
4889 'type' => CRM_Utils_Type
::T_BOOLEAN
,
4891 'do_not_sms' => array(
4892 'title' => ts('Do not SMS'),
4893 'type' => CRM_Utils_Type
::T_BOOLEAN
,
4895 'is_opt_out' => array(
4896 'title' => ts('Do not bulk email'),
4897 'type' => CRM_Utils_Type
::T_BOOLEAN
,
4899 'preferred_language' => array(
4900 'title' => ts('Preferred Language'),
4902 'is_deleted' => array(
4903 'no_display' => TRUE,
4905 'type' => CRM_Utils_Type
::T_BOOLEAN
,
4911 * Add contact to group.
4913 * @param int $groupID
4915 public function add2group($groupID) {
4916 if (is_numeric($groupID) && isset($this->_aliases
['civicrm_contact'])) {
4917 $select = "SELECT DISTINCT {$this->_aliases['civicrm_contact']}.id AS addtogroup_contact_id, ";
4918 $select = preg_replace('/SELECT(\s+SQL_CALC_FOUND_ROWS)?\s+/i', $select, $this->_select
);
4919 $sql = "{$select} {$this->_from} {$this->_where} {$this->_groupBy} {$this->_having} {$this->_orderBy}";
4920 $sql = str_replace('WITH ROLLUP', '', $sql);
4921 $dao = CRM_Core_DAO
::executeQuery($sql);
4923 $contact_ids = array();
4924 // Add resulting contacts to group
4925 while ($dao->fetch()) {
4926 if ($dao->addtogroup_contact_id
) {
4927 $contact_ids[$dao->addtogroup_contact_id
] = $dao->addtogroup_contact_id
;
4931 if (!empty($contact_ids)) {
4932 CRM_Contact_BAO_GroupContact
::addContactsToGroup($contact_ids, $groupID);
4933 CRM_Core_Session
::setStatus(ts("Listed contact(s) have been added to the selected group."), ts('Contacts Added'), 'success');
4936 CRM_Core_Session
::setStatus(ts("The listed records(s) cannot be added to the group."));
4942 * Show charts on print screen.
4944 public static function uploadChartImage() {
4945 // upload strictly for '.png' images
4946 $name = trim(basename(CRM_Utils_Request
::retrieve('name', 'String', CRM_Core_DAO
::$_nullObject, FALSE, NULL, 'GET')));
4947 if (preg_match('/\.png$/', $name)) {
4949 // Get the RAW .png from the input.
4950 $httpRawPostData = file_get_contents("php://input");
4952 // prepare the directory
4953 $config = CRM_Core_Config
::singleton();
4955 = str_replace('/persist/contribute/', '/persist/', $config->imageUploadDir
) .
4957 if (!file_exists($defaultPath)) {
4958 mkdir($defaultPath, 0777, TRUE);
4961 // full path to the saved image including filename
4962 $destination = $defaultPath . $name;
4965 $jfh = fopen($destination, 'w') or die("can't open file");
4966 fwrite($jfh, $httpRawPostData);
4968 CRM_Utils_System
::civiExit();
4973 * Apply common settings to entityRef fields.
4975 * @param array $field
4976 * @param string $table
4978 public function setEntityRefDefaults(&$field, $table) {
4979 $field['attributes'] = $field['attributes'] ?
$field['attributes'] : array();
4980 $field['attributes'] +
= array(
4981 'entity' => CRM_Core_DAO_AllCoreTables
::getBriefName(CRM_Core_DAO_AllCoreTables
::getClassForTable($table)),
4983 'placeholder' => ts('- select -'),
4988 * Add link fields to the row.
4990 * Function adds the _link & _hover fields to the row.
4993 * @param string $baseUrl
4994 * @param string $linkText
4995 * @param string $value
4996 * @param string $fieldName
4997 * @param string $tablePrefix
4998 * @param string $fieldLabel
5002 protected function addLinkToRow(&$row, $baseUrl, $linkText, $value, $fieldName, $tablePrefix, $fieldLabel) {
5003 $criteriaQueryParams = CRM_Report_Utils_Report
::getPreviewCriteriaQueryParams($this->_defaults
, $this->_params
);
5004 $url = CRM_Report_Utils_Report
::getNextUrl($baseUrl,
5005 "reset=1&force=1&{$criteriaQueryParams}&" .
5006 $fieldName . "_op=in&{$fieldName}_value={$value}",
5007 $this->_absoluteUrl
, $this->_id
5009 $row["{$tablePrefix}_{$fieldName}_link"] = $url;
5010 $row["{$tablePrefix}_{$fieldName}_hover"] = ts("%1 for this %2.",
5011 array(1 => $linkText, 2 => $fieldLabel)
5016 * Get label for show results buttons.
5020 public function getResultsLabel() {
5021 $showResultsLabel = $this->resultsDisplayed() ?
ts('Refresh results') : ts('View results');
5022 return $showResultsLabel;
5026 * Determine the output mode from the url or input.
5029 * - pdf : Render as pdf
5030 * - csv : Render as csv
5031 * - print : Render in print format
5032 * - save : save the report and display the new report
5033 * - copy : save the report as a new instance and display that.
5034 * - group : go to the add to group screen.
5036 * Potentially chart variations could also be included but the complexity
5037 * is that we might print a bar chart as a pdf.
5039 protected function setOutputMode() {
5040 $this->_outputMode
= str_replace('report_instance.', '', CRM_Utils_Request
::retrieve(
5043 CRM_Core_DAO
::$_nullObject,
5045 CRM_Utils_Array
::value('task', $this->_params
)
5047 // if contacts are added to group
5048 if (!empty($this->_params
['groups']) && empty($this->_outputMode
)) {
5049 $this->_outputMode
= 'group';
5051 if (isset($this->_params
['task'])) {
5052 unset($this->_params
['task']);
5057 * CRM-17793 - Alter DateTime section header to group by date from the datetime field.
5060 * @param $columnName
5062 public function alterSectionHeaderForDateTime($tempTable, $columnName) {
5063 // add new column with date value for the datetime field
5064 $tempQuery = "ALTER TABLE {$tempTable} ADD COLUMN {$columnName}_date VARCHAR(128)";
5065 CRM_Core_DAO
::executeQuery($tempQuery);
5066 $updateQuery = "UPDATE {$tempTable} SET {$columnName}_date = date({$columnName})";
5067 CRM_Core_DAO
::executeQuery($updateQuery);
5068 $this->_selectClauses
[] = "{$columnName}_date";
5069 $this->_select
.= ", {$columnName}_date";
5070 $this->_sections
["{$columnName}_date"] = $this->_sections
["{$columnName}"];
5071 unset($this->_sections
["{$columnName}"]);
5072 $this->assign('sections', $this->_sections
);
5076 * Get an array of the columns that have been selected for display.
5080 public function getSelectColumns() {
5081 $selectColumns = array();
5082 foreach ($this->_columns
as $tableName => $table) {
5083 if (array_key_exists('fields', $table)) {
5084 foreach ($table['fields'] as $fieldName => $field) {
5085 if (!empty($field['required']) ||
5086 !empty($this->_params
['fields'][$fieldName])
5089 $selectColumns["{$tableName}_{$fieldName}"] = 1;
5094 return $selectColumns;
5098 * Add location tables to the query if they are used for filtering.
5100 * This is for when we are running the query separately for filtering and retrieving display fields.
5102 public function selectivelyAddLocationTablesJoinsToFilterQuery() {
5103 if ($this->isTableFiltered('civicrm_email')) {
5105 LEFT JOIN civicrm_email {$this->_aliases['civicrm_email']}
5106 ON {$this->_aliases['civicrm_contact']}.id = {$this->_aliases['civicrm_email']}.contact_id
5107 AND {$this->_aliases['civicrm_email']}.is_primary = 1";
5109 if ($this->isTableFiltered('civicrm_phone')) {
5111 LEFT JOIN civicrm_phone {$this->_aliases['civicrm_phone']}
5112 ON {$this->_aliases['civicrm_contact']}.id = {$this->_aliases['civicrm_phone']}.contact_id
5113 AND {$this->_aliases['civicrm_phone']}.is_primary = 1";
5115 if ($this->isTableFiltered('civicrm_address')) {
5117 LEFT JOIN civicrm_address {$this->_aliases['civicrm_address']}
5118 ON ({$this->_aliases['civicrm_contact']}.id = {$this->_aliases['civicrm_address']}.contact_id)
5119 AND {$this->_aliases['civicrm_address']}.is_primary = 1\n";
5124 * Set the base table for the FROM clause.
5126 * Sets up the from clause, allowing for the possibility it might be a
5127 * temp table pre-filtered by groups if a group filter is in use.
5129 * @param string $baseTable
5130 * @param string $field
5131 * @param null $tableAlias
5133 public function setFromBase($baseTable, $field = 'id', $tableAlias = NULL) {
5135 $tableAlias = $this->_aliases
[$baseTable];
5137 $this->_from
= $this->_from
= " FROM $baseTable $tableAlias ";
5138 $this->joinGroupTempTable($baseTable, $field, $tableAlias);
5139 $this->_from
.= " {$this->_aclFrom} ";
5143 * Join the temp table contacting contacts who are members of the filtered groups.
5145 * If we are using an IN filter we use an inner join, otherwise a left join.
5147 * @param string $baseTable
5148 * @param string $field
5149 * @param string $tableAlias
5151 public function joinGroupTempTable($baseTable, $field, $tableAlias) {
5152 if ($this->groupTempTable
) {
5153 if ($this->_params
['gid_op'] == 'in') {
5154 $this->_from
= " FROM $this->groupTempTable group_temp_table INNER JOIN $baseTable $tableAlias
5155 ON group_temp_table.id = $tableAlias.{$field} ";
5159 LEFT JOIN $this->groupTempTable group_temp_table
5160 ON $tableAlias.{$field} = group_temp_table.id ";
5166 * Get all labels for fields that are used in a group concat.
5168 * @param string $options
5169 * comma separated option values.
5170 * @param string $baoName
5171 * The BAO name for the field.
5172 * @param string $fieldName
5173 * The name of the field for which labels should be retrieved.
5177 public function getLabels($options, $baoName, $fieldName) {
5178 $types = explode(',', $options);
5180 foreach ($types as $value) {
5181 $labels[$value] = CRM_Core_PseudoConstant
::getLabel($baoName, $fieldName, $value);
5183 return implode(', ', array_filter($labels));
5187 * Add statistics columns.
5189 * If a group by is in play then add columns for the statistics fields.
5191 * This would lead to a new field in the $row such as $fieldName_sum and a new, matching
5192 * column header field.
5194 * @param array $field
5195 * @param string $tableName
5196 * @param string $fieldName
5197 * @param array $select
5201 protected function addStatisticsToSelect($field, $tableName, $fieldName, $select) {
5202 foreach ($field['statistics'] as $stat => $label) {
5203 $alias = "{$tableName}_{$fieldName}_{$stat}";
5204 switch (strtolower($stat)) {
5207 $select[] = "$stat({$field['dbAlias']}) as $alias";
5208 $this->_columnHeaders
["{$tableName}_{$fieldName}_{$stat}"]['title'] = $label;
5209 $this->_columnHeaders
["{$tableName}_{$fieldName}_{$stat}"]['type'] = $field['type'];
5210 $this->_statFields
[$label] = $alias;
5211 $this->_selectAliases
[] = $alias;
5215 $select[] = "COUNT({$field['dbAlias']}) as $alias";
5216 $this->_columnHeaders
["{$tableName}_{$fieldName}_{$stat}"]['title'] = $label;
5217 $this->_columnHeaders
["{$tableName}_{$fieldName}_{$stat}"]['type'] = CRM_Utils_Type
::T_INT
;
5218 $this->_statFields
[$label] = $alias;
5219 $this->_selectAliases
[] = $alias;
5222 case 'count_distinct':
5223 $select[] = "COUNT(DISTINCT {$field['dbAlias']}) as $alias";
5224 $this->_columnHeaders
["{$tableName}_{$fieldName}_{$stat}"]['title'] = $label;
5225 $this->_columnHeaders
["{$tableName}_{$fieldName}_{$stat}"]['type'] = CRM_Utils_Type
::T_INT
;
5226 $this->_statFields
[$label] = $alias;
5227 $this->_selectAliases
[] = $alias;
5231 $select[] = "ROUND(AVG({$field['dbAlias']}),2) as $alias";
5232 $this->_columnHeaders
["{$tableName}_{$fieldName}_{$stat}"]['title'] = $label;
5233 $this->_columnHeaders
["{$tableName}_{$fieldName}_{$stat}"]['type'] = $field['type'];
5234 $this->_statFields
[$label] = $alias;
5235 $this->_selectAliases
[] = $alias;
5243 * Add a basic field to the select clause.
5245 * @param string $tableName
5246 * @param string $fieldName
5247 * @param array $field
5248 * @param string $select
5251 protected function addBasicFieldToSelect($tableName, $fieldName, $field, $select) {
5252 $alias = "{$tableName}_{$fieldName}";
5253 $select[] = "{$field['dbAlias']} as $alias";
5254 $this->_columnHeaders
["{$tableName}_{$fieldName}"]['title'] = CRM_Utils_Array
::value('title', $field);
5255 $this->_columnHeaders
["{$tableName}_{$fieldName}"]['type'] = CRM_Utils_Array
::value('type', $field);
5256 $this->_selectAliases
[] = $alias;
5263 * @param array $table
5264 * @param string $tableName
5269 protected function setTableAlias($table, $tableName) {
5270 if (!isset($table['alias'])) {
5271 $this->_columns
[$tableName]['alias'] = substr($tableName, 8) .
5275 $this->_columns
[$tableName]['alias'] = $table['alias'] . '_civireport';
5278 $this->_aliases
[$tableName] = $this->_columns
[$tableName]['alias'];
5279 return $this->_aliases
[$tableName];
5283 * Function to add columns to reports.
5285 * This is ported from extended reports, which also adds join filters to the options.
5287 * @param string $type
5288 * @param array $options
5289 * - prefix - A string to prepend to the table name
5290 * - prefix_label A string to prepend to the fields
5291 * - fields (bool) - should the fields for this table be made available
5292 * - group_by (bool) - should the group bys for this table be made available.
5293 * - order_by (bool) - should the group bys for this table be made available.
5294 * - filters (bool) - should the filters for this table by made available.
5295 * - fields_defaults (array) array of fields that should be displayed by default.
5296 * - filters_defaults (array) array of fields that should be filtered by default.
5297 * - join_filters (array) fields available for filtering joins (requires additional custom code).
5298 * - join_fields (array) fields available from join (requires additional custom code).
5299 * - group_by_defaults (array) array of group bys that should be applied by default.
5300 * - order_by_defaults (array) array of order bys that should be applied by default.
5301 * - custom_fields (array) array of entity types for custom fields (not usually required).
5302 * - contact_type (string) optional restriction on contact type for some tables.
5303 * - fields_excluded (array) fields that are in the generic set for the table but not in the report.
5307 protected function getColumns($type, $options = array()) {
5308 $defaultOptions = array(
5310 'prefix_label' => '',
5312 'group_bys' => FALSE,
5313 'order_bys' => TRUE,
5315 'join_filters' => FALSE,
5316 'fields_defaults' => array(),
5317 'filters_defaults' => array(),
5318 'group_bys_defaults' => array(),
5319 'order_bys_defaults' => array(),
5321 $options = array_merge($defaultOptions, $options);
5323 $fn = 'get' . $type . 'Columns';
5324 return $this->$fn($options);
5328 * Get columns for contact table.
5330 * @param array $options
5334 protected function getContactColumns($options = array()) {
5335 $defaultOptions = array(
5336 'custom_fields' => array('Individual', 'Contact', 'Organization'),
5337 'fields_defaults' => array('display_name', 'id'),
5338 'order_bys_defaults' => array('sort_name ASC'),
5339 'contact_type' => NULL,
5342 $options = array_merge($defaultOptions, $options);
5344 $tableAlias = $options['prefix'] . 'contact';
5347 $options['prefix'] . 'display_name' => array(
5348 'name' => 'display_name',
5349 'title' => $options['prefix_label'] . ts('Contact Name'),
5350 'is_fields' => TRUE,
5352 $options['prefix'] . 'sort_name' => array(
5353 'name' => 'sort_name',
5354 'title' => $options['prefix_label'] . ts('Contact Name (in sort format)'),
5355 'is_fields' => TRUE,
5356 'is_filters' => TRUE,
5357 'is_order_bys' => TRUE,
5359 $options['prefix'] . 'id' => array(
5361 'title' => $options['prefix_label'] . ts('Contact ID'),
5362 'alter_display' => 'alterContactID',
5363 'type' => CRM_Utils_Type
::T_INT
,
5364 'is_order_bys' => TRUE,
5365 'is_group_bys' => TRUE,
5366 'is_fields' => TRUE,
5367 'is_filters' => TRUE,
5369 $options['prefix'] . 'external_identifier' => array(
5370 'name' => 'external_identifier',
5371 'title' => $options['prefix_label'] . ts('External ID'),
5372 'type' => CRM_Utils_Type
::T_INT
,
5373 'is_fields' => TRUE,
5375 $options['prefix'] . 'contact_type' => array(
5376 'title' => $options['prefix_label'] . ts('Contact Type'),
5377 'name' => 'contact_type',
5378 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
5379 'options' => CRM_Contact_BAO_Contact
::buildOptions('contact_type'),
5380 'is_fields' => TRUE,
5381 'is_filters' => TRUE,
5382 'is_group_bys' => TRUE,
5384 $options['prefix'] . 'contact_sub_type' => array(
5385 'title' => $options['prefix_label'] . ts('Contact Sub Type'),
5386 'name' => 'contact_sub_type',
5387 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
5388 'options' => CRM_Contact_BAO_Contact
::buildOptions('contact_sub_type'),
5389 'is_fields' => TRUE,
5390 'is_filters' => TRUE,
5391 'is_group_bys' => TRUE,
5393 $options['prefix'] . 'is_deleted' => array(
5394 'title' => $options['prefix_label'] . ts('Is deleted'),
5395 'name' => 'is_deleted',
5396 'type' => CRM_Utils_Type
::T_BOOLEAN
,
5397 'is_fields' => FALSE,
5398 'is_filters' => TRUE,
5399 'is_group_bys' => FALSE,
5402 $individualFields = array(
5403 $options['prefix'] . 'first_name' => array(
5404 'name' => 'first_name',
5405 'title' => $options['prefix_label'] . ts('First Name'),
5406 'is_fields' => TRUE,
5407 'is_filters' => TRUE,
5408 'is_order_bys' => TRUE,
5410 $options['prefix'] . 'middle_name' => array(
5411 'name' => 'middle_name',
5412 'title' => $options['prefix_label'] . ts('Middle Name'),
5413 'is_fields' => TRUE,
5415 $options['prefix'] . 'last_name' => array(
5416 'name' => 'last_name',
5417 'title' => $options['prefix_label'] . ts('Last Name'),
5418 'default_order' => 'ASC',
5419 'is_fields' => TRUE,
5421 $options['prefix'] . 'nick_name' => array(
5422 'name' => 'nick_name',
5423 'title' => $options['prefix_label'] . ts('Nick Name'),
5424 'is_fields' => TRUE,
5426 $options['prefix'] . 'prefix_id' => array(
5427 'name' => 'prefix_id',
5428 'title' => $options['prefix_label'] . ts('Prefix'),
5429 'options' => CRM_Contact_BAO_Contact
::buildOptions('prefix_id'),
5430 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
5431 'is_fields' => TRUE,
5432 'is_filters' => TRUE,
5434 $options['prefix'] . 'suffix_id' => array(
5435 'name' => 'suffix_id',
5436 'title' => $options['prefix_label'] . ts('Suffix'),
5437 'options' => CRM_Contact_BAO_Contact
::buildOptions('suffix_id'),
5438 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
5439 'is_fields' => TRUE,
5440 'is_filters' => TRUE,
5442 $options['prefix'] . 'gender_id' => array(
5443 'name' => 'gender_id',
5444 'title' => $options['prefix_label'] . ts('Gender'),
5445 'options' => CRM_Contact_BAO_Contact
::buildOptions('gender_id'),
5446 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
5447 'is_fields' => TRUE,
5448 'is_filters' => TRUE,
5450 'birth_date' => array(
5451 'title' => $options['prefix_label'] . ts('Birth Date'),
5452 'operatorType' => CRM_Report_Form
::OP_DATE
,
5453 'type' => CRM_Utils_Type
::T_DATE
,
5454 'is_fields' => TRUE,
5455 'is_filters' => TRUE,
5458 'title' => $options['prefix_label'] . ts('Age'),
5459 'dbAlias' => 'TIMESTAMPDIFF(YEAR, ' . $tableAlias . '_civireport.birth_date, CURDATE())',
5460 'type' => CRM_Utils_Type
::T_INT
,
5461 'is_fields' => TRUE,
5463 $options['prefix'] . 'is_deceased' => array(
5464 'title' => $options['prefix_label'] . ts('Is deceased'),
5465 'name' => 'is_deceased',
5466 'type' => CRM_Utils_Type
::T_BOOLEAN
,
5467 'is_fields' => FALSE,
5468 'is_filters' => TRUE,
5469 'is_group_bys' => FALSE,
5472 if (!$options['contact_type'] ||
$options['contact_type'] === 'Individual') {
5473 $spec = array_merge($spec, $individualFields);
5476 if (!empty($options['custom_fields'])) {
5477 $this->_customGroupExtended
[$options['prefix'] . 'civicrm_contact'] = array(
5478 'extends' => $options['custom_fields'],
5479 'title' => $options['prefix_label'],
5480 'filters' => $options['filters'],
5481 'prefix' => $options['prefix'],
5482 'prefix_label' => $options['prefix_label'],
5486 return $this->buildColumns($spec, $options['prefix'] . 'civicrm_contact', 'CRM_Contact_DAO_Contact', $tableAlias, $this->getDefaultsFromOptions($options), $options);
5490 * Get address columns to add to array.
5492 * @param array $options
5493 * - prefix Prefix to add to table (in case of more than one instance of the table)
5494 * - prefix_label Label to give columns from this address table instance
5495 * - group_bys enable these fields for group by - default false
5496 * - order_bys enable these fields for order by
5497 * - filters enable these fields for filtering
5499 * @return array address columns definition
5501 protected function getAddressColumns($options = array()) {
5502 $defaultOptions = array(
5504 'prefix_label' => '',
5506 'group_bys' => FALSE,
5507 'order_bys' => TRUE,
5509 'join_filters' => FALSE,
5510 'fields_defaults' => array(),
5511 'filters_defaults' => array(),
5512 'group_bys_defaults' => array(),
5513 'order_bys_defaults' => array(),
5516 $options = array_merge($defaultOptions, $options);
5517 $defaults = $this->getDefaultsFromOptions($options);
5518 $tableAlias = $options['prefix'] . 'address';
5521 $options['prefix'] . 'name' => array(
5522 'title' => ts($options['prefix_label'] . 'Address Name'),
5524 'is_fields' => TRUE,
5526 $options['prefix'] . 'street_number' => array(
5527 'name' => 'street_number',
5528 'title' => ts($options['prefix_label'] . 'Street Number'),
5530 'is_fields' => TRUE,
5532 $options['prefix'] . 'odd_street_number' => array(
5533 'title' => ts('Odd / Even Street Number'),
5534 'name' => 'odd_street_number',
5535 'type' => CRM_Utils_Type
::T_INT
,
5536 'no_display' => TRUE,
5538 'dbAlias' => '(address_civireport.street_number % 2)',
5539 'is_fields' => TRUE,
5540 'is_order_bys' => TRUE,
5542 $options['prefix'] . 'street_name' => array(
5543 'name' => 'street_name',
5544 'title' => ts($options['prefix_label'] . 'Street Name'),
5546 'is_fields' => TRUE,
5547 'is_filters' => TRUE,
5548 'operator' => 'like',
5549 'is_order_bys' => TRUE,
5551 $options['prefix'] . 'street_address' => array(
5552 'title' => ts($options['prefix_label'] . 'Street Address'),
5553 'name' => 'street_address',
5554 'is_fields' => TRUE,
5555 'is_filters' => TRUE,
5556 'is_group_bys' => TRUE,
5558 $options['prefix'] . 'supplemental_address_1' => array(
5559 'title' => ts($options['prefix_label'] . 'Supplementary Address Field 1'),
5560 'name' => 'supplemental_address_1',
5561 'is_fields' => TRUE,
5563 $options['prefix'] . 'supplemental_address_2' => array(
5564 'title' => ts($options['prefix_label'] . 'Supplementary Address Field 2'),
5565 'name' => 'supplemental_address_2',
5566 'is_fields' => TRUE,
5568 $options['prefix'] . 'supplemental_address_3' => array(
5569 'title' => ts($options['prefix_label'] . 'Supplementary Address Field 3'),
5570 'name' => 'supplemental_address_3',
5571 'is_fields' => TRUE,
5573 $options['prefix'] . 'street_number' => array(
5574 'name' => 'street_number',
5575 'title' => ts($options['prefix_label'] . 'Street Number'),
5577 'is_order_bys' => TRUE,
5578 'is_filters' => TRUE,
5579 'is_fields' => TRUE,
5581 $options['prefix'] . 'street_unit' => array(
5582 'name' => 'street_unit',
5583 'title' => ts($options['prefix_label'] . 'Street Unit'),
5585 'is_fields' => TRUE,
5587 $options['prefix'] . 'city' => array(
5588 'title' => ts($options['prefix_label'] . 'City'),
5590 'operator' => 'like',
5591 'is_fields' => TRUE,
5592 'is_filters' => TRUE,
5593 'is_group_bys' => TRUE,
5594 'is_order_bys' => TRUE,
5596 $options['prefix'] . 'postal_code' => array(
5597 'title' => ts($options['prefix_label'] . 'Postal Code'),
5598 'name' => 'postal_code',
5600 'is_fields' => TRUE,
5601 'is_filters' => TRUE,
5602 'is_group_bys' => TRUE,
5603 'is_order_bys' => TRUE,
5605 $options['prefix'] . 'postal_code_suffix' => array(
5606 'title' => ts($options['prefix_label'] . 'Postal Code Suffix'),
5607 'name' => 'postal_code',
5609 'is_fields' => TRUE,
5610 'is_filters' => TRUE,
5611 'is_group_bys' => TRUE,
5612 'is_order_bys' => TRUE,
5614 $options['prefix'] . 'county_id' => array(
5615 'title' => ts($options['prefix_label'] . 'County'),
5616 'alter_display' => 'alterCountyID',
5617 'name' => 'county_id',
5618 'type' => CRM_Utils_Type
::T_INT
,
5619 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
5620 'options' => CRM_Core_PseudoConstant
::county(),
5621 'is_fields' => TRUE,
5622 'is_filters' => TRUE,
5623 'is_group_bys' => TRUE,
5625 $options['prefix'] . 'state_province_id' => array(
5626 'title' => ts($options['prefix_label'] . 'State/Province'),
5627 'alter_display' => 'alterStateProvinceID',
5628 'name' => 'state_province_id',
5629 'type' => CRM_Utils_Type
::T_INT
,
5630 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
5631 'options' => CRM_Core_PseudoConstant
::stateProvince(),
5632 'is_fields' => TRUE,
5633 'is_filters' => TRUE,
5634 'is_group_bys' => TRUE,
5636 $options['prefix'] . 'country_id' => array(
5637 'title' => ts($options['prefix_label'] . 'Country'),
5638 'alter_display' => 'alterCountryID',
5639 'name' => 'country_id',
5640 'is_fields' => TRUE,
5641 'is_filters' => TRUE,
5642 'is_group_bys' => TRUE,
5643 'type' => CRM_Utils_Type
::T_INT
,
5644 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
5645 'options' => CRM_Core_PseudoConstant
::country(),
5647 $options['prefix'] . 'location_type_id' => array(
5648 'name' => 'is_primary',
5649 'title' => ts($options['prefix_label'] . 'Location Type'),
5650 'type' => CRM_Utils_Type
::T_INT
,
5651 'is_fields' => TRUE,
5652 'alter_display' => 'alterLocationTypeID',
5654 $options['prefix'] . 'id' => array(
5655 'title' => ts($options['prefix_label'] . 'ID'),
5657 'is_fields' => TRUE,
5659 $options['prefix'] . 'is_primary' => array(
5660 'name' => 'is_primary',
5661 'title' => ts($options['prefix_label'] . 'Primary Address?'),
5662 'type' => CRM_Utils_Type
::T_BOOLEAN
,
5663 'is_fields' => TRUE,
5666 return $this->buildColumns($spec, $options['prefix'] . 'civicrm_address', 'CRM_Core_DAO_Address', $tableAlias, $defaults, $options);
5670 * Build the columns.
5672 * The normal report class needs you to remember to do a few things that are often erratic
5674 * 1) use a unique key for any field that might not be unique (e.g. start date, label)
5675 * - this class will prepend an alias to the key & set the 'name' if you don't set it yourself.
5676 * You can suppress the alias with 'no_field_disambiguation' if transitioning existing reports. This
5677 * means any saved filters / fields on saved report instances. This will mean that matching names from
5678 * different tables may be ambigious, but it will smooth any code transition.
5679 * - note that it assumes the value being passed in is the actual table field name
5681 * 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
5682 * contexts - the code looks up the fields array for data - so it both defines the field spec & the fields you want to show
5684 * 3) this function also sets the 'metadata' array - the extended report class now uses this in place
5685 * of the fields array to reduce the issues caused when metadata is needed but 'fields' are not defined. Code in
5686 * the core classes can start to move towards that.
5688 * @param array $specs
5689 * @param string $tableName
5690 * @param string $daoName
5691 * @param string $tableAlias
5692 * @param array $defaults
5693 * @param array $options
5697 protected function buildColumns($specs, $tableName, $daoName = NULL, $tableAlias = NULL, $defaults = array(), $options = array()) {
5699 $tableAlias = str_replace('civicrm_', '', $tableName);
5701 $types = array('filters', 'group_bys', 'order_bys', 'join_filters');
5702 $columns = array($tableName => array_fill_keys($types, array()));
5703 // The code that uses this no longer cares if it is a DAO or BAO so just call it a DAO.
5704 $columns[$tableName]['dao'] = $daoName;
5705 $columns[$tableName]['alias'] = $tableAlias;
5707 foreach ($specs as $specName => $spec) {
5708 if (empty($spec['name'])) {
5709 $spec['name'] = $specName;
5712 $fieldAlias = (empty($options['no_field_disambiguation']) ?
$tableAlias . '_' : '') . $specName;
5713 $columns[$tableName]['metadata'][$fieldAlias] = $spec;
5714 $columns[$tableName]['fields'][$fieldAlias] = $spec;
5715 if (isset($defaults['fields_defaults']) && in_array($spec['name'], $defaults['fields_defaults'])) {
5716 $columns[$tableName]['fields'][$fieldAlias]['default'] = TRUE;
5719 if (!$spec['is_fields'] ||
(isset($options['fields_excluded']) && in_array($specName, $options['fields_excluded']))) {
5720 $columns[$tableName]['fields'][$fieldAlias]['no_display'] = TRUE;
5723 if (isset($options['fields_required']) && in_array($specName, $options['fields_required'])) {
5724 $columns[$tableName]['fields'][$fieldAlias]['required'] = TRUE;
5727 foreach ($types as $type) {
5728 if ($options[$type] && !empty($spec['is_' . $type])) {
5729 $columns[$tableName][$type][$fieldAlias] = $spec;
5730 if (isset($defaults[$type . '_defaults']) && isset($defaults[$type . '_defaults'][$spec['name']])) {
5731 $columns[$tableName][$type][$fieldAlias]['default'] = $defaults[$type . '_defaults'][$spec['name']];
5740 * Store group bys into array - so we can check elsewhere what is grouped.
5742 protected function storeGroupByArray() {
5744 if (!CRM_Utils_Array
::value('group_bys', $this->_params
)
5745 ||
!is_array($this->_params
['group_bys'])) {
5746 $this->_params
['group_bys'] = [];
5749 foreach ($this->_columns
as $tableName => $table) {
5750 $table = $this->_columns
[$tableName];
5751 if (array_key_exists('group_bys', $table)) {
5752 foreach ($table['group_bys'] as $fieldName => $fieldData) {
5753 $field = $this->_columns
[$tableName]['metadata'][$fieldName];
5754 if (!empty($this->_params
['group_bys'][$fieldName]) ||
!empty($fieldData['required'])) {
5755 if (!empty($field['chart'])) {
5756 $this->assign('chartSupported', TRUE);
5759 if (!empty($table['group_bys'][$fieldName]['frequency']) &&
5760 !empty($this->_params
['group_bys_freq'][$fieldName])
5763 switch ($this->_params
['group_bys_freq'][$fieldName]) {
5765 $this->_groupByArray
[$tableName . '_' . $fieldName . '_start'] = self
::fiscalYearOffset($field['dbAlias']);
5768 $this->_groupByArray
[$tableName . '_' . $fieldName . '_start'] = " {$this->_params['group_bys_freq'][$fieldName]}({$field['dbAlias']})";
5771 $this->_groupByArray
[$tableName . '_' . $fieldName . '_start'] = "EXTRACT(YEAR_{$this->_params['group_bys_freq'][$fieldName]} FROM {$field['dbAlias']})";
5776 if (!in_array($field['dbAlias'], $this->_groupByArray
)) {
5777 $this->_groupByArray
[$tableName . '_' . $fieldName] = $field['dbAlias'];
5792 protected function getDefaultsFromOptions($options) {
5794 'fields_defaults' => $options['fields_defaults'],
5795 'filters_defaults' => $options['filters_defaults'],
5796 'group_bys_defaults' => $options['group_bys_defaults'],
5797 'order_bys_defaults' => $options['order_bys_defaults'],
5803 * Get the select clause for a field, wrapping in GROUP_CONCAT if appropriate.
5805 * Full group by mode dictates that a field must either be in the group by function or
5806 * wrapped in a aggregate function. Here we wrap the field in GROUP_CONCAT if it is not in the
5809 * @param string $tableName
5810 * @param string $fieldName
5811 * @param string $field
5814 protected function getSelectClauseWithGroupConcatIfNotGroupedBy($tableName, &$fieldName, &$field) {
5815 if ($this->groupConcatTested
&& (!empty($this->_groupByArray
) ||
$this->isForceGroupBy
)) {
5816 if ((empty($field['statistics']) ||
in_array('GROUP_CONCAT', $field['statistics']))) {
5817 $label = CRM_Utils_Array
::value('title', $field);
5818 $alias = "{$tableName}_{$fieldName}";
5819 $this->_columnHeaders
["{$tableName}_{$fieldName}"]['title'] = $label;
5820 $this->_selectAliases
[] = $alias;
5821 if (empty($this->_groupByArray
[$tableName . '_' . $fieldName])) {
5822 return "GROUP_CONCAT(DISTINCT {$field['dbAlias']}) as $alias";
5824 return "({$field['dbAlias']}) as $alias";
5830 * Generate clause for the selected filter.
5832 * @param array $field
5833 * Field specification
5834 * @param string $fieldName
5838 * Relevant where clause.
5840 protected function generateFilterClause($field, $fieldName) {
5841 if (CRM_Utils_Array
::value('type', $field) & CRM_Utils_Type
::T_DATE
) {
5842 if (CRM_Utils_Array
::value('operatorType', $field) ==
5843 CRM_Report_Form
::OP_MONTH
5845 $op = CRM_Utils_Array
::value("{$fieldName}_op", $this->_params
);
5846 $value = CRM_Utils_Array
::value("{$fieldName}_value", $this->_params
);
5847 if (is_array($value) && !empty($value)) {
5848 return "(month({$field['dbAlias']}) $op (" . implode(', ', $value) .
5853 $relative = CRM_Utils_Array
::value("{$fieldName}_relative", $this->_params
);
5854 $from = CRM_Utils_Array
::value("{$fieldName}_from", $this->_params
);
5855 $to = CRM_Utils_Array
::value("{$fieldName}_to", $this->_params
);
5856 $fromTime = CRM_Utils_Array
::value("{$fieldName}_from_time", $this->_params
);
5857 $toTime = CRM_Utils_Array
::value("{$fieldName}_to_time", $this->_params
);
5858 return $this->dateClause($field['dbAlias'], $relative, $from, $to, $field['type'], $fromTime, $toTime);
5862 $op = CRM_Utils_Array
::value("{$fieldName}_op", $this->_params
);
5864 return $this->whereClause($field,
5866 CRM_Utils_Array
::value("{$fieldName}_value", $this->_params
),
5867 CRM_Utils_Array
::value("{$fieldName}_min", $this->_params
),
5868 CRM_Utils_Array
::value("{$fieldName}_max", $this->_params
)