3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.4 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2013 |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2013
35 class CRM_Report_Form
extends CRM_Core_Form
{
36 CONST ROW_COUNT_LIMIT
= 50;
39 * Operator types - used for displaying filter elements
49 OP_MULTISELECT_SEPARATOR
= 66,
53 * The id of the report instance
60 * The id of the report template
64 protected $_templateID;
72 protected $_noFields = FALSE;
75 * The set of all columns in the report. An associative array
76 * with column name as the key and attribues as the value
80 protected $_columns = array();
83 * The set of filters in the report
87 protected $_filters = array();
90 * The set of optional columns in the report
94 protected $_options = array();
96 protected $_defaults = array();
99 * By default most reports hide contact id.
100 * Setting this to true makes it available
102 protected $_exposeContactID = TRUE;
105 * Set of statistic fields
109 protected $_statFields = array();
112 * Set of statistics data
116 protected $_statistics = array();
119 * List of fields not to be repeated during display
123 protected $_noRepeats = array();
126 * List of fields not to be displayed
130 protected $_noDisplay = array();
133 * Object type that a custom group extends
137 protected $_customGroupExtends = NULL;
138 protected $_customGroupExtendsJoin = array();
139 protected $_customGroupFilters = TRUE;
140 protected $_customGroupGroupBy = FALSE;
141 protected $_customGroupJoin = 'LEFT JOIN';
147 protected $_tagFilter = FALSE;
150 * build groups filter
153 protected $_groupFilter = FALSE;
160 public $_navigation = array();
162 public $_drilldownReport = array();
165 * An attribute for checkbox/radio form field layout
169 protected $_fourColumnAttribute = array(
170 '</td><td width="25%">', '</td><td width="25%">',
171 '</td><td width="25%">', '</tr><tr><td>',
174 protected $_force = 1;
176 protected $_params = NULL;
177 protected $_formValues = NULL;
178 protected $_instanceValues = NULL;
180 protected $_instanceForm = FALSE;
181 protected $_criteriaForm = FALSE;
183 protected $_instanceButtonName = NULL;
184 protected $_createNewButtonName = NULL;
185 protected $_printButtonName = NULL;
186 protected $_pdfButtonName = NULL;
187 protected $_csvButtonName = NULL;
188 protected $_groupButtonName = NULL;
189 protected $_chartButtonName = NULL;
190 protected $_csvSupported = TRUE;
191 protected $_add2groupSupported = TRUE;
192 protected $_groups = NULL;
193 protected $_grandFlag = FALSE;
194 protected $_rowsFound = NULL;
195 protected $_selectAliases = array();
196 protected $_rollup = NULL;
202 protected $_limit = NULL;
205 * This can be set to specify a limit to the number of rows
206 * Since it is currently envisaged as part of the api usage it is only being applied
207 * when $_output mode is not 'html' or 'group' so as not to have to interpret / mess with that part
208 * of the code (see limit() fn
211 protected $_limitValue = NULL;
214 * This can be set to specify row offset
215 * See notes on _limitValue
218 protected $_offsetValue = NULL;
219 protected $_sections = NULL;
220 protected $_autoIncludeIndexedFieldsAsOrderBys = 0;
221 protected $_absoluteUrl = FALSE;
224 * Flag to indicate if result-set is to be stored in a class variable which could be retrieved using getResultSet() method.
228 protected $_storeResultSet = FALSE;
231 * When _storeResultSet Flag is set use this var to store result set in form of array
235 protected $_resultSet = array();
238 * To what frequency group-by a date column
242 protected $_groupByDateFreq = array(
244 'YEARWEEK' => 'Week',
245 'QUARTER' => 'Quarter',
250 * Variables to hold the acl inner join and where clause
252 protected $_aclFrom = NULL;
253 protected $_aclWhere = NULL;
256 * Array of DAO tables having columns included in SELECT or ORDER BY clause
260 protected $_selectedTables;
263 * outputmode e.g 'print', 'csv', 'pdf'
266 protected $_outputMode;
268 public $_having = NULL;
269 public $_select = NULL;
270 public $_selectClauses = array();
271 public $_columnHeaders = array();
272 public $_orderBy = NULL;
273 public $_orderByFields = array();
274 public $_orderByArray = array();
275 public $_groupBy = NULL;
276 public $_whereClauses = array();
277 public $_havingClauses = array();
280 * Is this being called without a form controller (ie. the report is being render outside the normal form
281 * - e.g the api is retrieving the rows
284 public $noController = FALSE;
287 * Variable to hold the currency alias
289 protected $_currencyColumn = NULL;
294 function __construct() {
295 parent
::__construct();
298 if ($this->_tagFilter
) {
299 $this->buildTagFilter();
301 if ($this->_exposeContactID
) {
302 if (array_key_exists('civicrm_contact', $this->_columns
)) {
303 $this->_columns
['civicrm_contact']['fields']['exposed_id'] = array(
305 'title' => 'Contact ID',
311 if ($this->_groupFilter
) {
312 $this->buildGroupFilter();
315 // Get all custom groups
316 $allGroups = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_CustomField', 'custom_group_id');
318 // Get the custom groupIds for which the user has VIEW permission
319 // If the user has 'access all custom data' permission, we'll leave $permCustomGroupIds empty
320 // and addCustomDataToColumns() will allow access to all custom groups.
321 $permCustomGroupIds = array();
322 if (!CRM_Core_Permission
::check('access all custom data')) {
323 $permCustomGroupIds = CRM_ACL_API
::group(CRM_Core_Permission
::VIEW
, NULL, 'civicrm_custom_group', $allGroups, NULL);
324 // do not allow custom data for reports if user doesn't have
325 // permission to access custom data.
326 if (!empty($this->_customGroupExtends
) && empty($permCustomGroupIds)) {
327 $this->_customGroupExtends
= array();
331 // merge custom data columns to _columns list, if any
332 $this->addCustomDataToColumns(TRUE, $permCustomGroupIds);
334 // add / modify display columns, filters ..etc
335 CRM_Utils_Hook
::alterReportVar('columns', $this->_columns
, $this);
337 //assign currencyColumn variable to tpl
338 $this->assign('currencyColumn', $this->_currencyColumn
);
341 function preProcessCommon() {
343 CRM_Utils_Request
::retrieve(
346 CRM_Core_DAO
::$_nullObject
349 $this->_section
= CRM_Utils_Request
::retrieve('section', 'Integer', CRM_Core_DAO
::$_nullObject);
351 $this->assign('section', $this->_section
);
352 CRM_Core_Region
::instance('page-header')->add(array(
353 'markup' => sprintf('<!-- Report class: [%s] -->', htmlentities(get_class($this))),
355 if(!$this->noController
) {
356 $this->setID($this->get('instanceId'));
359 $this->setID(CRM_Report_Utils_Report
::getInstanceID());
361 $this->setID( CRM_Report_Utils_Report
::getInstanceIDForPath());
365 // set qfkey so that pager picks it up and use it in the "Next > Last >>" links.
366 // FIXME: Note setting it in $_GET doesn't work, since pager generates link based on QUERY_STRING
367 $_SERVER['QUERY_STRING'] .= "&qfKey={$this->controller->_key}";
371 $this->assign('instanceId', $this->_id
);
372 $params = array('id' => $this->_id
);
373 $this->_instanceValues
= array();
374 CRM_Core_DAO
::commonRetrieve('CRM_Report_DAO_ReportInstance',
376 $this->_instanceValues
378 if (empty($this->_instanceValues
)) {
379 CRM_Core_Error
::fatal("Report could not be loaded.");
381 $this->_title
= $this->_instanceValues
['title'];
382 if (!empty($this->_instanceValues
['permission']) &&
383 (!(CRM_Core_Permission
::check($this->_instanceValues
['permission']) ||
384 CRM_Core_Permission
::check('administer Reports')
387 CRM_Utils_System
::permissionDenied();
388 CRM_Utils_System
::civiExit();
391 $formValues = CRM_Utils_Array
::value('form_values', $this->_instanceValues
);
393 $this->_formValues
= unserialize($formValues);
396 $this->_formValues
= NULL;
399 // lets always do a force if reset is found in the url.
400 if (!empty($_REQUEST['reset'])) {
405 $this->assign('mode', 'instance');
407 elseif (!$this->noController
) {
408 list($optionValueID, $optionValue) = CRM_Report_Utils_Report
::getValueIDFromUrl();
409 $instanceCount = CRM_Report_Utils_Report
::getInstanceCount($optionValue);
410 if (($instanceCount > 0) && $optionValueID) {
411 $this->assign('instanceUrl',
412 CRM_Utils_System
::url('civicrm/report/list',
413 "reset=1&ovid=$optionValueID"
417 if ($optionValueID) {
418 $this->_description
= CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionValue', $optionValueID, 'description');
422 $this->assign('mode', 'template');
425 // lets display the Report Settings section
426 $this->_instanceForm
= $this->_force ||
$this->_id ||
(!empty($_POST));
428 // Do not display Report Settings section if administer Reports permission is absent OR
429 // if report instance is reserved and administer reserved reports absent
430 if (!CRM_Core_Permission
::check('administer Reports') ||
431 ($this->_instanceValues
['is_reserved'] && !CRM_Core_Permission
::check('administer reserved reports'))) {
432 $this->_instanceForm
= FALSE;
435 $this->assign('criteriaForm', FALSE);
436 // Display Report Criteria section if user has access Report Criteria OR administer Reports AND report instance is not reserved
437 if (CRM_Core_Permission
::check('administer Reports') || CRM_Core_Permission
::check('access Report Criteria')) {
438 if (!$this->_instanceValues
['is_reserved'] || CRM_Core_Permission
::check('administer reserved reports')) {
439 $this->assign('criteriaForm', TRUE);
440 $this->_criteriaForm
= TRUE;
444 $this->_instanceButtonName
= $this->getButtonName('submit', 'save');
445 $this->_createNewButtonName
= $this->getButtonName('submit', 'next');
446 $this->_printButtonName
= $this->getButtonName('submit', 'print');
447 $this->_pdfButtonName
= $this->getButtonName('submit', 'pdf');
448 $this->_csvButtonName
= $this->getButtonName('submit', 'csv');
449 $this->_groupButtonName
= $this->getButtonName('submit', 'group');
450 $this->_chartButtonName
= $this->getButtonName('submit', 'chart');
453 function addBreadCrumb() {
457 'title' => ts('Report Templates'),
458 'url' => CRM_Utils_System
::url('civicrm/admin/report/template/list', 'reset=1'),
462 CRM_Utils_System
::appendBreadCrumb($breadCrumbs);
465 function preProcess() {
466 $this->preProcessCommon();
469 $this->addBreadCrumb();
472 foreach ($this->_columns
as $tableName => $table) {
474 if (!isset($table['alias'])) {
475 $this->_columns
[$tableName]['alias'] = substr($tableName, 8) . '_civireport';
478 $this->_columns
[$tableName]['alias'] = $table['alias'] . '_civireport';
481 $this->_aliases
[$tableName] = $this->_columns
[$tableName]['alias'];
483 $daoOrBaoName = NULL;
484 // higher preference to bao object
485 if (array_key_exists('bao', $table)) {
486 $daoOrBaoName = $table['bao'];
487 $expFields = $daoOrBaoName::exportableFields( );
489 elseif (array_key_exists('dao', $table)){
490 $daoOrBaoName = $table['dao'];
491 $expFields = $daoOrBaoName::export( );
494 $expFields = array();
497 $doNotCopy = array('required');
499 $fieldGroups = array('fields', 'filters', 'group_bys', 'order_bys');
500 foreach ($fieldGroups as $fieldGrp) {
501 if (!empty($table[$fieldGrp]) && is_array($table[$fieldGrp])) {
502 foreach ($table[$fieldGrp] as $fieldName => $field) {
503 // $name is the field name used to reference the BAO/DAO export fields array
504 $name = isset($field['name']) ?
$field['name'] : $fieldName;
506 // Sometimes the field name key in the BAO/DAO export fields array is
507 // different from the actual database field name.
508 // Unset $field['name'] so that actual database field name can be obtained
509 // from the BAO/DAO export fields array.
510 unset($field['name']);
512 if (array_key_exists($name, $expFields)) {
513 foreach ($doNotCopy as $dnc) {
514 // unset the values we don't want to be copied.
515 unset($expFields[$name][$dnc]);
518 $this->_columns
[$tableName][$fieldGrp][$fieldName] = $expFields[$name];
521 foreach ($expFields[$name] as $property => $val) {
522 if (!array_key_exists($property, $field)) {
523 $this->_columns
[$tableName][$fieldGrp][$fieldName][$property] = $val;
530 if (!empty($field['no_repeat'])) {
531 $this->_noRepeats
[] = "{$tableName}_{$fieldName}";
533 if (!empty($field['no_display'])) {
534 $this->_noDisplay
[] = "{$tableName}_{$fieldName}";
537 // set alias = table-name, unless already set
538 $alias = isset($field['alias']) ?
$field['alias'] : (isset($this->_columns
[$tableName]['alias']) ?
539 $this->_columns
[$tableName]['alias'] : $tableName
541 $this->_columns
[$tableName][$fieldGrp][$fieldName]['alias'] = $alias;
543 // set name = fieldName, unless already set
544 if (!isset($this->_columns
[$tableName][$fieldGrp][$fieldName]['name'])) {
545 $this->_columns
[$tableName][$fieldGrp][$fieldName]['name'] = $name;
548 // set dbAlias = alias.name, unless already set
549 if (!isset($this->_columns
[$tableName][$fieldGrp][$fieldName]['dbAlias'])) {
550 $this->_columns
[$tableName][$fieldGrp][$fieldName]['dbAlias'] = $alias . '.' . $this->_columns
[$tableName][$fieldGrp][$fieldName]['name'];
553 // a few auto fills for filters
554 if ($fieldGrp == 'filters') {
555 // fill operator types
556 if (!array_key_exists('operatorType', $this->_columns
[$tableName][$fieldGrp][$fieldName])) {
557 switch (CRM_Utils_Array
::value('type', $this->_columns
[$tableName][$fieldGrp][$fieldName])) {
558 case CRM_Utils_Type
::T_MONEY
:
559 case CRM_Utils_Type
::T_FLOAT
:
560 $this->_columns
[$tableName][$fieldGrp][$fieldName]['operatorType'] = CRM_Report_Form
::OP_FLOAT
;
562 case CRM_Utils_Type
::T_INT
:
563 $this->_columns
[$tableName][$fieldGrp][$fieldName]['operatorType'] = CRM_Report_Form
::OP_INT
;
565 case CRM_Utils_Type
::T_DATE
:
566 $this->_columns
[$tableName][$fieldGrp][$fieldName]['operatorType'] = CRM_Report_Form
::OP_DATE
;
568 case CRM_Utils_Type
::T_BOOLEAN
:
569 $this->_columns
[$tableName][$fieldGrp][$fieldName]['operatorType'] = CRM_Report_Form
::OP_SELECT
;
570 if (!array_key_exists('options', $this->_columns
[$tableName][$fieldGrp][$fieldName])) {
571 $this->_columns
[$tableName][$fieldGrp][$fieldName]['options'] =
572 array('' => ts('Any'), '0' => ts('No'), '1' => ts('Yes'));
577 array_key_exists('pseudoconstant', $this->_columns
[$tableName][$fieldGrp][$fieldName])) {
578 // with multiple options operator-type is generally multi-select
579 $this->_columns
[$tableName][$fieldGrp][$fieldName]['operatorType'] = CRM_Report_Form
::OP_MULTISELECT
;
580 if (!array_key_exists('options', $this->_columns
[$tableName][$fieldGrp][$fieldName])) {
582 $this->_columns
[$tableName][$fieldGrp][$fieldName]['options'] = CRM_Core_PseudoConstant
::get($daoOrBaoName, $fieldName);
593 // copy filters to a separate handy variable
594 if (array_key_exists('filters', $table)) {
595 $this->_filters
[$tableName] = $this->_columns
[$tableName]['filters'];
598 if (array_key_exists('group_bys', $table)) {
599 $groupBys[$tableName] = $this->_columns
[$tableName]['group_bys'];
602 if (array_key_exists('fields', $table)) {
603 $reportFields[$tableName] = $this->_columns
[$tableName]['fields'];
608 $this->setDefaultValues(FALSE);
611 CRM_Report_Utils_Get
::processFilter($this->_filters
, $this->_defaults
);
612 CRM_Report_Utils_Get
::processGroupBy($groupBys, $this->_defaults
);
613 CRM_Report_Utils_Get
::processFields($reportFields, $this->_defaults
);
614 CRM_Report_Utils_Get
::processChart($this->_defaults
);
617 $this->_formValues
= $this->_defaults
;
618 $this->postProcess();
622 function setDefaultValues($freeze = TRUE) {
623 $freezeGroup = array();
625 // FIXME: generalizing form field naming conventions would reduce
626 // lots of lines below.
627 foreach ($this->_columns
as $tableName => $table) {
628 if (array_key_exists('fields', $table)) {
629 foreach ($table['fields'] as $fieldName => $field) {
630 if (empty($field['no_display'])) {
631 if (isset($field['required'])) {
633 $this->_defaults
['fields'][$fieldName] = 1;
636 // find element object, so that we could use quickform's freeze method
637 // for required elements
638 $obj = $this->getElementFromGroup("fields", $fieldName);
640 $freezeGroup[] = $obj;
644 elseif (isset($field['default'])) {
645 $this->_defaults
['fields'][$fieldName] = $field['default'];
651 if (array_key_exists('group_bys', $table)) {
652 foreach ($table['group_bys'] as $fieldName => $field) {
653 if (isset($field['default'])) {
654 if (!empty($field['frequency'])) {
655 $this->_defaults
['group_bys_freq'][$fieldName] = 'MONTH';
657 $this->_defaults
['group_bys'][$fieldName] = $field['default'];
661 if (array_key_exists('filters', $table)) {
662 foreach ($table['filters'] as $fieldName => $field) {
663 if (isset($field['default'])) {
664 if (CRM_Utils_Array
::value('type', $field) & CRM_Utils_Type
::T_DATE
) {
665 if(is_array($field['default'])){
666 $this->_defaults
["{$fieldName}_from"] = CRM_Utils_Array
::value('from', $field['default']);
667 $this->_defaults
["{$fieldName}_to"] = CRM_Utils_Array
::value('to', $field['default']);
668 $this->_defaults
["{$fieldName}_relative"] = 0;
671 $this->_defaults
["{$fieldName}_relative"] = $field['default'];
675 $this->_defaults
["{$fieldName}_value"] = $field['default'];
678 //assign default value as "in" for multiselect
679 //operator, To freeze the select element
680 if (CRM_Utils_Array
::value('operatorType', $field) == CRM_Report_Form
::OP_MULTISELECT
) {
681 $this->_defaults
["{$fieldName}_op"] = 'in';
683 elseif (CRM_Utils_Array
::value('operatorType', $field) == CRM_Report_Form
::OP_MULTISELECT_SEPARATOR
) {
684 $this->_defaults
["{$fieldName}_op"] = 'mhas';
686 elseif ($op = CRM_Utils_Array
::value('default_op', $field)) {
687 $this->_defaults
["{$fieldName}_op"] = $op;
693 array_key_exists('order_bys', $table) &&
694 is_array($table['order_bys'])
696 if (!array_key_exists('order_bys', $this->_defaults
)) {
697 $this->_defaults
['order_bys'] = array();
699 foreach ($table['order_bys'] as $fieldName => $field) {
700 if (!empty($field['default']) ||
!empty($field['default_order']) ||
701 CRM_Utils_Array
::value('default_is_section', $field) ||
!empty($field['default_weight'])) {
703 'column' => $fieldName,
704 'order' => CRM_Utils_Array
::value('default_order', $field, 'ASC'),
705 'section' => CRM_Utils_Array
::value('default_is_section', $field, 0),
708 if (!empty($field['default_weight'])) {
709 $this->_defaults
['order_bys'][(int) $field['default_weight']] = $order_by;
712 array_unshift($this->_defaults
['order_bys'], $order_by);
718 foreach ($this->_options
as $fieldName => $field) {
719 if (isset($field['default'])) {
720 $this->_defaults
['options'][$fieldName] = $field['default'];
725 if (!empty($this->_submitValues
)) {
726 $this->preProcessOrderBy($this->_submitValues
);
729 $this->preProcessOrderBy($this->_defaults
);
732 // lets finish freezing task here itself
733 if (!empty($freezeGroup)) {
734 foreach ($freezeGroup as $elem) {
739 if ($this->_formValues
) {
740 $this->_defaults
= array_merge($this->_defaults
, $this->_formValues
);
743 if ($this->_instanceValues
) {
744 $this->_defaults
= array_merge($this->_defaults
, $this->_instanceValues
);
747 CRM_Report_Form_Instance
::setDefaultValues($this, $this->_defaults
);
749 return $this->_defaults
;
752 function getElementFromGroup($group, $grpFieldName) {
753 $eleObj = $this->getElement($group);
754 foreach ($eleObj->_elements
as $index => $obj) {
755 if ($grpFieldName == $obj->_attributes
['name']) {
763 * Setter for $_params
764 * @param array $params
766 function setParams($params) {
767 $this->_params
= $params;
774 function setID($instanceid) {
775 $this->_id
= $instanceid;
780 * @param boolean $force
782 function setForce($isForce) {
783 $this->_force
= $isForce;
787 * Setter for $_limitValue
788 * @param number $_limitValue
790 function setLimitValue($_limitValue) {
791 $this->_limitValue
= $_limitValue;
795 * Setter for $_offsetValue
796 * @param number $_offsetValue
798 function setOffsetValue($_offsetValue) {
799 $this->_offsetValue
= $_offsetValue;
803 * Getter for $_defaultValues
804 * @return array $_defaultValues
806 function getDefaultValues() {
807 return $this->_defaults
;
810 function addColumns() {
813 foreach ($this->_columns
as $tableName => $table) {
814 if (array_key_exists('fields', $table)) {
815 foreach ($table['fields'] as $fieldName => $field) {
817 if (empty($field['no_display'])) {
818 foreach ( array('table', 'field') as $var) {
819 if (!empty($
{$var}['grouping'])) {
820 if (!is_array($
{$var}['grouping'])) {
821 $tableName = $
{$var}['grouping'];
823 $tableName = array_keys($
{$var}['grouping']);
824 $tableName = $tableName[0];
825 $groupTitle = array_values($
{$var}['grouping']);
826 $groupTitle = $groupTitle[0];
831 if (!$groupTitle && isset($table['group_title'])) {
832 $groupTitle = $table['group_title'];
835 $colGroups[$tableName]['fields'][$fieldName] = CRM_Utils_Array
::value('title', $field);
836 if ($groupTitle && empty($colGroups[$tableName]['group_title'])) {
837 $colGroups[$tableName]['group_title'] = $groupTitle;
840 $options[$fieldName] = CRM_Utils_Array
::value('title', $field);
846 $this->addCheckBox("fields", ts('Select Columns'), $options, NULL,
847 NULL, NULL, NULL, $this->_fourColumnAttribute
, TRUE
849 $this->assign('colGroups', $colGroups);
852 function addFilters() {
853 $options = $filters = array();
855 foreach ($this->_filters
as $table => $attributes) {
856 foreach ($attributes as $fieldName => $field) {
857 // get ready with option value pair
858 // @ 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
860 $operations = $this->getOperationPair(
861 CRM_Utils_Array
::value('operatorType', $field),
864 $filters[$table][$fieldName] = $field;
866 switch (CRM_Utils_Array
::value('operatorType', $field)) {
867 case CRM_Report_Form
::OP_MONTH
:
868 if (!array_key_exists('options', $field) ||
!is_array($field['options']) ||
empty($field['options'])) {
869 // If there's no option list for this filter, define one.
870 $field['options'] = array(
879 9 => ts('September'),
881 11 => ts('November'),
882 12 => ts('December'),
884 // Add this option list to this column _columns. This is
885 // required so that filter statistics show properly.
886 $this->_columns
[$table]['filters'][$fieldName]['options'] = $field['options'];
888 case CRM_Report_Form
::OP_MULTISELECT
:
889 case CRM_Report_Form
::OP_MULTISELECT_SEPARATOR
:
890 // assume a multi-select field
891 if (!empty($field['options'])) {
892 $element = $this->addElement('select', "{$fieldName}_op", ts('Operator:'), $operations);
893 if (count($operations) <= 1) {
896 $select = $this->addElement('select', "{$fieldName}_value", NULL,
897 $field['options'], array(
899 'style' => 'min-width:250px',
902 $select->setMultiple(TRUE);
906 case CRM_Report_Form
::OP_SELECT
:
907 // assume a select field
908 $this->addElement('select', "{$fieldName}_op", ts('Operator:'), $operations);
909 if (!empty($field['options']))
910 $this->addElement('select', "{$fieldName}_value", NULL, $field['options']);
913 case CRM_Report_Form
::OP_DATE
:
914 // build datetime fields
915 CRM_Core_Form_Date
::buildDateRange($this, $fieldName, $count, '_from','_to', 'From:', FALSE, $operations);
919 case CRM_Report_Form
::OP_DATETIME
:
920 // build datetime fields
921 CRM_Core_Form_Date
::buildDateRange($this, $fieldName, $count, '_from', '_to', 'From:', FALSE, $operations, 'searchDate', true);
925 case CRM_Report_Form
::OP_INT
:
926 case CRM_Report_Form
::OP_FLOAT
:
927 // and a min value input box
928 $this->add('text', "{$fieldName}_min", ts('Min'));
929 // and a max value input box
930 $this->add('text', "{$fieldName}_max", ts('Max'));
932 // default type is string
933 $this->addElement('select', "{$fieldName}_op", ts('Operator:'), $operations,
934 array('onchange' => "return showHideMaxMinVal( '$fieldName', this.value );")
936 // we need text box for value input
937 $this->add('text', "{$fieldName}_value", NULL);
942 $this->assign('filters', $filters);
945 function addOptions() {
946 if (!empty($this->_options
)) {
947 // FIXME: For now lets build all elements as checkboxes.
948 // Once we clear with the format we can build elements based on type
951 foreach ($this->_options
as $fieldName => $field) {
952 if ($field['type'] == 'select') {
953 $this->addElement('select', "{$fieldName}", $field['title'], $field['options']);
955 else if ($field['type'] == 'checkbox') {
956 $options[$field['title']] = $fieldName;
957 $this->addCheckBox($fieldName, NULL,
959 NULL, NULL, NULL, $this->_fourColumnAttribute
964 $this->assign('otherOptions', $this->_options
);
967 function addChartOptions() {
968 if (!empty($this->_charts
)) {
969 $this->addElement('select', "charts", ts('Chart'), $this->_charts
, array('onchange' => 'disablePrintPDFButtons(this.value);'));
970 $this->assign('charts', $this->_charts
);
971 $this->addElement('submit', $this->_chartButtonName
, ts('View'));
975 function addGroupBys() {
976 $options = $freqElements = array();
978 foreach ($this->_columns
as $tableName => $table) {
979 if (array_key_exists('group_bys', $table)) {
980 foreach ($table['group_bys'] as $fieldName => $field) {
981 if (!empty($field)) {
982 $options[$field['title']] = $fieldName;
983 if (!empty($field['frequency'])) {
984 $freqElements[$field['title']] = $fieldName;
990 $this->addCheckBox("group_bys", ts('Group by columns'), $options, NULL,
991 NULL, NULL, NULL, $this->_fourColumnAttribute
993 $this->assign('groupByElements', $options);
995 foreach ($freqElements as $name) {
996 $this->addElement('select', "group_bys_freq[$name]",
997 ts('Frequency'), $this->_groupByDateFreq
1002 function addOrderBys() {
1004 foreach ($this->_columns
as $tableName => $table) {
1006 // Report developer may define any column to order by; include these as order-by options
1007 if (array_key_exists('order_bys', $table)) {
1008 foreach ($table['order_bys'] as $fieldName => $field) {
1009 if (!empty($field)) {
1010 $options[$fieldName] = $field['title'];
1015 /* Add searchable custom fields as order-by options, if so requested
1016 * (These are already indexed, so allowing to order on them is cheap.)
1020 if ($this->_autoIncludeIndexedFieldsAsOrderBys
&& array_key_exists('extends', $table) && !empty($table['extends'])) {
1021 foreach ($table['fields'] as $fieldName => $field) {
1022 if (empty($field['no_display'])) {
1023 $options[$fieldName] = $field['title'];
1031 $this->assign('orderByOptions', $options);
1033 if (!empty($options)) {
1035 '-' => ' - none - ') +
$options;
1036 for ($i = 1; $i <= 5; $i++
) {
1037 $this->addElement('select', "order_bys[{$i}][column]", ts('Order by Column'), $options);
1038 $this->addElement('select', "order_bys[{$i}][order]", ts('Order by Order'), array('ASC' => 'Ascending', 'DESC' => 'Descending'));
1039 $this->addElement('checkbox', "order_bys[{$i}][section]", ts('Order by Section'), FALSE, array('id' => "order_by_section_$i"));
1040 $this->addElement('checkbox', "order_bys[{$i}][pageBreak]", ts('Page Break'), FALSE, array('id' => "order_by_pagebreak_$i"));
1045 function buildInstanceAndButtons() {
1046 CRM_Report_Form_Instance
::buildForm($this);
1048 $label = $this->_id ?
ts('Update Report') : ts('Create Report');
1050 $this->addElement('submit', $this->_instanceButtonName
, $label);
1051 $this->addElement('submit', $this->_printButtonName
, ts('Print Report'));
1052 $this->addElement('submit', $this->_pdfButtonName
, ts('PDF'));
1055 $this->addElement('submit', $this->_createNewButtonName
, ts('Save a Copy') . '...');
1057 if ($this->_instanceForm
) {
1058 $this->assign('instanceForm', TRUE);
1061 $label = $this->_id ?
ts('Print Report') : ts('Print Preview');
1062 $this->addElement('submit', $this->_printButtonName
, $label);
1064 $label = $this->_id ?
ts('PDF') : ts('Preview PDF');
1065 $this->addElement('submit', $this->_pdfButtonName
, $label);
1067 $label = $this->_id ?
ts('Export to CSV') : ts('Preview CSV');
1069 if ($this->_csvSupported
) {
1070 $this->addElement('submit', $this->_csvButtonName
, $label);
1073 if (CRM_Core_Permission
::check('administer Reports') && $this->_add2groupSupported
) {
1074 $this->addElement('select', 'groups', ts('Group'),
1075 array('' => ts('- select group -')) + CRM_Core_PseudoConstant
::staticGroup()
1077 $this->assign('group', TRUE);
1080 $label = ts('Add These Contacts to Group');
1081 $this->addElement('submit', $this->_groupButtonName
, $label, array('onclick' => 'return checkGroup();'));
1083 $this->addChartOptions();
1084 $this->addButtons(array(
1087 'name' => ts('Preview Report'),
1088 'isDefault' => TRUE,
1094 function buildQuickForm() {
1095 $this->addColumns();
1097 $this->addFilters();
1099 $this->addOptions();
1101 $this->addGroupBys();
1103 $this->addOrderBys();
1105 $this->buildInstanceAndButtons();
1107 //add form rule for report
1108 if (is_callable(array(
1109 $this, 'formRule'))) {
1110 $this->addFormRule(array(get_class($this), 'formRule'), $this);
1114 // a formrule function to ensure that fields selected in group_by
1115 // (if any) should only be the ones present in display/select fields criteria;
1116 // note: works if and only if any custom field selected in group_by.
1117 function customDataFormRule($fields, $ignoreFields = array( )) {
1119 if (!empty($this->_customGroupExtends
) && $this->_customGroupGroupBy
&& !empty($fields['group_bys'])) {
1120 foreach ($this->_columns
as $tableName => $table) {
1121 if ((substr($tableName, 0, 13) == 'civicrm_value' ||
substr($tableName, 0, 12) == 'custom_value') && !empty($this->_columns
[$tableName]['fields'])) {
1122 foreach ($this->_columns
[$tableName]['fields'] as $fieldName => $field) {
1123 if (array_key_exists($fieldName, $fields['group_bys']) &&
1124 !array_key_exists($fieldName, $fields['fields'])
1126 $errors['fields'] = "Please make sure fields selected in 'Group by Columns' section are also selected in 'Display Columns' section.";
1128 elseif (array_key_exists($fieldName, $fields['group_bys'])) {
1129 foreach ($fields['fields'] as $fld => $val) {
1130 if (!array_key_exists($fld, $fields['group_bys']) && !in_array($fld, $ignoreFields)) {
1131 $errors['fields'] = "Please ensure that fields selected in 'Display Columns' are also selected in 'Group by Columns' section.";
1142 // Note: $fieldName param allows inheriting class to build operationPairs
1143 // specific to a field.
1144 function getOperationPair($type = "string", $fieldName = NULL) {
1145 // FIXME: At some point we should move these key-val pairs
1146 // to option_group and option_value table.
1148 case CRM_Report_Form
::OP_INT
:
1149 case CRM_Report_Form
::OP_FLOAT
:
1151 'lte' => ts('Is less than or equal to'),
1152 'gte' => ts('Is greater than or equal to'),
1153 'bw' => ts('Is between'),
1154 'eq' => ts('Is equal to'),
1155 'lt' => ts('Is less than'),
1156 'gt' => ts('Is greater than'),
1157 'neq' => ts('Is not equal to'),
1158 'nbw' => ts('Is not between'),
1159 'nll' => ts('Is empty (Null)'),
1160 'nnll' => ts('Is not empty (Null)'),
1164 case CRM_Report_Form
::OP_SELECT
:
1166 'eq' => ts('Is equal to'),
1169 case CRM_Report_Form
::OP_MONTH
:
1170 case CRM_Report_Form
::OP_MULTISELECT
:
1172 'in' => ts('Is one of'),
1173 'notin' => ts('Is not one of'),
1177 case CRM_Report_Form
::OP_DATE
:
1179 'nll' => ts('Is empty (Null)'),
1180 'nnll' => ts('Is not empty (Null)'),
1184 case CRM_Report_Form
::OP_MULTISELECT_SEPARATOR
:
1185 // use this operator for the values, concatenated with separator. For e.g if
1186 // multiple options for a column is stored as ^A{val1}^A{val2}^A
1188 'mhas' => ts('Is one of'),
1194 'has' => ts('Contains'),
1195 'sw' => ts('Starts with'),
1196 'ew' => ts('Ends with'),
1197 'nhas' => ts('Does not contain'),
1198 'eq' => ts('Is equal to'),
1199 'neq' => ts('Is not equal to'),
1200 'nll' => ts('Is empty (Null)'),
1201 'nnll' => ts('Is not empty (Null)'),
1206 function buildTagFilter() {
1207 $contactTags = CRM_Core_BAO_Tag
::getTags();
1208 if (!empty($contactTags)) {
1209 $this->_columns
['civicrm_tag'] = array(
1210 'dao' => 'CRM_Core_DAO_Tag',
1216 'title' => ts('Tag'),
1218 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
1219 'options' => $contactTags,
1227 * Adds group filters to _columns (called from _Constuct
1229 function buildGroupFilter() {
1230 $this->_columns
['civicrm_group']['filters'] = array(
1233 'name' => 'group_id',
1234 'title' => ts('Group'),
1235 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
1237 'options' => CRM_Core_PseudoConstant
::group(),
1240 if (empty($this->_columns
['civicrm_group']['dao'])) {
1241 $this->_columns
['civicrm_group']['dao'] = 'CRM_Contact_DAO_GroupContact';
1243 if (empty($this->_columns
['civicrm_group']['alias'])) {
1244 $this->_columns
['civicrm_group']['alias'] = 'cgroup';
1248 function getSQLOperator($operator = "like") {
1249 switch ($operator) {
1282 return 'IS NOT NULL';
1290 function whereClause(&$field, $op,
1294 $type = CRM_Utils_Type
::typeToString(CRM_Utils_Array
::value('type', $field));
1300 if (($min !== NULL && strlen($min) > 0) ||
1301 ($max !== NULL && strlen($max) > 0)
1303 $min = CRM_Utils_Type
::escape($min, $type);
1304 $max = CRM_Utils_Type
::escape($max, $type);
1308 $clauses[] = "( {$field['dbAlias']} >= $min )";
1311 $clauses[] = "( {$field['dbAlias']} < $min )";
1316 $clauses[] = "( {$field['dbAlias']} <= $max )";
1319 $clauses[] = "( {$field['dbAlias']} > $max )";
1323 if (!empty($clauses)) {
1325 $clause = implode(' AND ', $clauses);
1328 $clause = implode(' OR ', $clauses);
1336 if ($value !== NULL && strlen($value) > 0) {
1337 $value = CRM_Utils_Type
::escape($value, $type);
1338 if (strpos($value, '%') === FALSE) {
1339 $value = "'%{$value}%'";
1342 $value = "'{$value}'";
1344 $sqlOP = $this->getSQLOperator($op);
1345 $clause = "( {$field['dbAlias']} $sqlOP $value )";
1351 if ($value !== NULL && is_array($value) && count($value) > 0) {
1352 $sqlOP = $this->getSQLOperator($op);
1353 if (CRM_Utils_Array
::value('type', $field) == CRM_Utils_Type
::T_STRING
) {
1354 //cycle through selections and esacape values
1355 foreach ($value as $key => $selection) {
1356 $value[$key] = CRM_Utils_Type
::escape($selection, $type);
1358 $clause = "( {$field['dbAlias']} $sqlOP ( '" . implode("' , '", $value) . "') )";
1361 // for numerical values
1362 $clause = "{$field['dbAlias']} $sqlOP (" . implode(', ', $value) . ")";
1364 if ($op == 'notin') {
1365 $clause = "( " . $clause . " OR {$field['dbAlias']} IS NULL )";
1368 $clause = "( " . $clause . " )";
1374 // mhas == multiple has
1375 if ($value !== NULL && count($value) > 0) {
1376 $sqlOP = $this->getSQLOperator($op);
1377 $clause = "{$field['dbAlias']} REGEXP '[[:<:]]" . implode('|', $value) . "[[:>:]]'";
1383 if ($value !== NULL && strlen($value) > 0) {
1384 $value = CRM_Utils_Type
::escape($value, $type);
1385 if (strpos($value, '%') === FALSE) {
1387 $value = "'{$value}%'";
1390 $value = "'%{$value}'";
1394 $value = "'{$value}'";
1396 $sqlOP = $this->getSQLOperator($op);
1397 $clause = "( {$field['dbAlias']} $sqlOP $value )";
1403 $sqlOP = $this->getSQLOperator($op);
1404 $clause = "( {$field['dbAlias']} $sqlOP )";
1408 if ($value !== NULL && strlen($value) > 0) {
1409 if (isset($field['clause'])) {
1410 // FIXME: we not doing escape here. Better solution is to use two
1411 // different types - data-type and filter-type
1412 $clause = $field['clause'];
1415 $value = CRM_Utils_Type
::escape($value, $type);
1416 $sqlOP = $this->getSQLOperator($op);
1417 if ($field['type'] == CRM_Utils_Type
::T_STRING
) {
1418 $value = "'{$value}'";
1420 $clause = "( {$field['dbAlias']} $sqlOP $value )";
1426 if (!empty($field['group']) && $clause) {
1427 $clause = $this->whereGroupClause($field, $value, $op);
1429 elseif (!empty($field['tag']) && $clause) {
1430 // not using left join in query because if any contact
1431 // belongs to more than one tag, results duplicate
1433 $clause = $this->whereTagClause($field, $value, $op);
1439 function dateClause($fieldName,
1440 $relative, $from, $to, $type = NULL, $fromTime = NULL, $toTime = NULL
1443 if (in_array($relative, array_keys($this->getOperationPair(CRM_Report_Form
::OP_DATE
)))) {
1444 $sqlOP = $this->getSQLOperator($relative);
1445 return "( {$fieldName} {$sqlOP} )";
1448 list($from, $to) = $this->getFromTo($relative, $from, $to, $fromTime, $toTime);
1451 $from = ($type == CRM_Utils_Type
::T_DATE
) ?
substr($from, 0, 8) : $from;
1452 $clauses[] = "( {$fieldName} >= $from )";
1456 $to = ($type == CRM_Utils_Type
::T_DATE
) ?
substr($to, 0, 8) : $to;
1457 $clauses[] = "( {$fieldName} <= {$to} )";
1460 if (!empty($clauses)) {
1461 return implode(' AND ', $clauses);
1467 * @todo - could not find any instances where this is called
1468 * @param unknown_type $relative
1469 * @param String $from
1470 * @param String_type $to
1471 * @return string|NULL
1473 function dateDisplay($relative, $from, $to) {
1474 list($from, $to) = $this->getFromTo($relative, $from, $to);
1477 $clauses[] = CRM_Utils_Date
::customFormat($from, NULL, array('m', 'M'));
1480 $clauses[] = 'Past';
1484 $clauses[] = CRM_Utils_Date
::customFormat($to, NULL, array('m', 'M'));
1487 $clauses[] = 'Today';
1490 if (!empty($clauses)) {
1491 return implode(' - ', $clauses);
1497 function getFromTo($relative, $from, $to, $fromtime = NULL, $totime = NULL) {
1498 if (empty($totime)) {
1501 //FIX ME not working for relative
1503 list($term, $unit) = CRM_Utils_System
::explode('.', $relative, 2);
1504 $dateRange = CRM_Utils_Date
::relativeToAbsolute($term, $unit);
1505 $from = substr($dateRange['from'], 0, 8);
1506 //Take only Date Part, Sometime Time part is also present in 'to'
1507 $to = substr($dateRange['to'], 0, 8);
1509 $from = CRM_Utils_Date
::processDate($from, $fromtime);
1510 $to = CRM_Utils_Date
::processDate($to, $totime);
1511 return array($from, $to);
1514 function alterDisplay(&$rows) {
1515 // custom code to alter rows
1518 function alterCustomDataDisplay(&$rows) {
1519 // custom code to alter rows having custom values
1520 if (empty($this->_customGroupExtends
)) {
1524 $customFieldIds = array();
1525 foreach ($this->_params
['fields'] as $fieldAlias => $value) {
1526 if ($fieldId = CRM_Core_BAO_CustomField
::getKeyID($fieldAlias)) {
1527 $customFieldIds[$fieldAlias] = $fieldId;
1530 if (empty($customFieldIds)) {
1534 $customFields = $fieldValueMap = array();
1535 $customFieldCols = array('column_name', 'data_type', 'html_type', 'option_group_id', 'id');
1537 // skip for type date and ContactReference since date format is already handled
1539 SELECT cg.table_name, cf." . implode(", cf.", $customFieldCols) . ", ov.value, ov.label
1540 FROM civicrm_custom_field cf
1541 INNER JOIN civicrm_custom_group cg ON cg.id = cf.custom_group_id
1542 LEFT JOIN civicrm_option_value ov ON cf.option_group_id = ov.option_group_id
1543 WHERE cg.extends IN ('" . implode("','", $this->_customGroupExtends
) . "') AND
1544 cg.is_active = 1 AND
1545 cf.is_active = 1 AND
1546 cf.is_searchable = 1 AND
1547 cf.data_type NOT IN ('ContactReference', 'Date') AND
1548 cf.id IN (" . implode(",", $customFieldIds) . ")";
1550 $dao = CRM_Core_DAO
::executeQuery($query);
1551 while ($dao->fetch()) {
1552 foreach ($customFieldCols as $key) {
1553 $customFields[$dao->table_name
. '_custom_' . $dao->id
][$key] = $dao->$key;
1555 if ($dao->option_group_id
) {
1556 $fieldValueMap[$dao->option_group_id
][$dao->value
] = $dao->label
;
1561 $entryFound = FALSE;
1562 foreach ($rows as $rowNum => $row) {
1563 foreach ($row as $tableCol => $val) {
1564 if (array_key_exists($tableCol, $customFields)) {
1565 $rows[$rowNum][$tableCol] = $this->formatCustomValues($val, $customFields[$tableCol], $fieldValueMap);
1570 // skip looking further in rows, if first row itself doesn't
1571 // have the column we need
1578 function formatCustomValues($value, $customField, $fieldValueMap) {
1579 if (CRM_Utils_System
::isNull($value)) {
1583 $htmlType = $customField['html_type'];
1585 switch ($customField['data_type']) {
1587 if ($value == '1') {
1588 $retValue = ts('Yes');
1591 $retValue = ts('No');
1596 $retValue = CRM_Utils_System
::formatWikiURL($value);
1608 if ($htmlType == 'Text') {
1609 $retValue = (float)$value;
1613 if ($htmlType == 'Text') {
1623 $retValue = CRM_Utils_Money
::format($value, NULL, '%a');
1628 if (in_array($htmlType, array(
1629 'Text', 'TextArea'))) {
1633 case 'StateProvince':
1636 switch ($htmlType) {
1637 case 'Multi-Select Country':
1638 $value = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $value);
1639 $customData = array();
1640 foreach ($value as $val) {
1642 $customData[] = CRM_Core_PseudoConstant
::country($val, FALSE);
1645 $retValue = implode(', ', $customData);
1648 case 'Select Country':
1649 $retValue = CRM_Core_PseudoConstant
::country($value, FALSE);
1652 case 'Select State/Province':
1653 $retValue = CRM_Core_PseudoConstant
::stateProvince($value, FALSE);
1656 case 'Multi-Select State/Province':
1657 $value = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $value);
1658 $customData = array();
1659 foreach ($value as $val) {
1661 $customData[] = CRM_Core_PseudoConstant
::stateProvince($val, FALSE);
1664 $retValue = implode(', ', $customData);
1669 case 'Autocomplete-Select':
1670 $retValue = $fieldValueMap[$customField['option_group_id']][$value];
1674 case 'AdvMulti-Select':
1675 case 'Multi-Select':
1676 $value = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $value);
1677 $customData = array();
1678 foreach ($value as $val) {
1680 $customData[] = $fieldValueMap[$customField['option_group_id']][$val];
1683 $retValue = implode(', ', $customData);
1698 function removeDuplicates(&$rows) {
1699 if (empty($this->_noRepeats
)) {
1702 $checkList = array();
1704 foreach ($rows as $key => $list) {
1705 foreach ($list as $colName => $colVal) {
1706 if (array_key_exists($colName, $checkList) &&
1707 $checkList[$colName] == $colVal) {
1708 $rows[$key][$colName] = "";
1710 if (in_array($colName, $this->_noRepeats
)) {
1711 $checkList[$colName] = $colVal;
1717 function fixSubTotalDisplay(&$row, $fields, $subtotal = TRUE) {
1718 foreach ($row as $colName => $colVal) {
1719 if (in_array($colName, $fields)) {
1720 $row[$colName] = $row[$colName];
1722 elseif (isset($this->_columnHeaders
[$colName])) {
1724 $row[$colName] = "Subtotal";
1728 unset($row[$colName]);
1734 function grandTotal(&$rows) {
1735 if (!$this->_rollup ||
($this->_rollup
== '') ||
1736 ($this->_limit
&& count($rows) >= self
::ROW_COUNT_LIMIT
)
1740 $lastRow = array_pop($rows);
1742 foreach ($this->_columnHeaders
as $fld => $val) {
1743 if (!in_array($fld, $this->_statFields
)) {
1744 if (!$this->_grandFlag
) {
1745 $lastRow[$fld] = "Grand Total";
1746 $this->_grandFlag
= TRUE;
1749 $lastRow[$fld] = "";
1754 $this->assign('grandStat', $lastRow);
1758 function formatDisplay(&$rows, $pager = TRUE) {
1759 // set pager based on if any limit was applied in the query.
1764 // allow building charts if any
1765 if (!empty($this->_params
['charts']) && !empty($rows)) {
1766 $this->buildChart($rows);
1767 $this->assign('chartEnabled', TRUE);
1768 $this->_chartId
= "{$this->_params['charts']}_" . ($this->_id ?
$this->_id
: substr(get_class($this), 16)) . '_' . session_id();
1769 $this->assign('chartId', $this->_chartId
);
1772 // unset columns not to be displayed.
1773 foreach ($this->_columnHeaders
as $key => $value) {
1774 if (!empty($value['no_display'])) {
1775 unset($this->_columnHeaders
[$key]);
1779 // unset columns not to be displayed.
1780 if (!empty($rows)) {
1781 foreach ($this->_noDisplay
as $noDisplayField) {
1782 foreach ($rows as $rowNum => $row) {
1783 unset($this->_columnHeaders
[$noDisplayField]);
1788 // build array of section totals
1789 $this->sectionTotals();
1791 // process grand-total row
1792 $this->grandTotal($rows);
1794 // use this method for formatting rows for display purpose.
1795 $this->alterDisplay($rows);
1796 CRM_Utils_Hook
::alterReportVar('rows', $rows, $this);
1798 // use this method for formatting custom rows for display purpose.
1799 $this->alterCustomDataDisplay($rows);
1802 function buildChart(&$rows) {
1803 // override this method for building charts.
1806 // select() method below has been added recently (v3.3), and many of the report templates might
1807 // still be having their own select() method. We should fix them as and when encountered and move
1808 // towards generalizing the select() method below.
1810 $select = $this->_selectAliases
= array();
1812 foreach ($this->_columns
as $tableName => $table) {
1813 if (array_key_exists('fields', $table)) {
1814 foreach ($table['fields'] as $fieldName => $field) {
1815 if ($tableName == 'civicrm_address') {
1816 $this->_addressField
= TRUE;
1818 if ($tableName == 'civicrm_email') {
1819 $this->_emailField
= TRUE;
1821 if ($tableName == 'civicrm_phone') {
1822 $this->_phoneField
= TRUE;
1825 if (!empty($field['required']) ||
!empty($this->_params
['fields'][$fieldName])) {
1827 // 1. In many cases we want select clause to be built in slightly different way
1828 // for a particular field of a particular type.
1829 // 2. This method when used should receive params by reference and modify $this->_columnHeaders
1831 $selectClause = $this->selectClause($tableName, 'fields', $fieldName, $field);
1832 if ($selectClause) {
1833 $select[] = $selectClause;
1837 // include statistics columns only if set
1838 if (!empty($field['statistics'])) {
1839 foreach ($field['statistics'] as $stat => $label) {
1840 $alias = "{$tableName}_{$fieldName}_{$stat}";
1841 switch (strtolower($stat)) {
1844 $select[] = "$stat({$field['dbAlias']}) as $alias";
1845 $this->_columnHeaders
["{$tableName}_{$fieldName}_{$stat}"]['title'] = $label;
1846 $this->_columnHeaders
["{$tableName}_{$fieldName}_{$stat}"]['type'] = $field['type'];
1847 $this->_statFields
[$label] = $alias;
1848 $this->_selectAliases
[] = $alias;
1852 $select[] = "COUNT({$field['dbAlias']}) as $alias";
1853 $this->_columnHeaders
["{$tableName}_{$fieldName}_{$stat}"]['title'] = $label;
1854 $this->_columnHeaders
["{$tableName}_{$fieldName}_{$stat}"]['type'] = CRM_Utils_Type
::T_INT
;
1855 $this->_statFields
[$label] = $alias;
1856 $this->_selectAliases
[] = $alias;
1859 case 'count_distinct':
1860 $select[] = "COUNT(DISTINCT {$field['dbAlias']}) as $alias";
1861 $this->_columnHeaders
["{$tableName}_{$fieldName}_{$stat}"]['title'] = $label;
1862 $this->_columnHeaders
["{$tableName}_{$fieldName}_{$stat}"]['type'] = CRM_Utils_Type
::T_INT
;
1863 $this->_statFields
[$label] = $alias;
1864 $this->_selectAliases
[] = $alias;
1868 $select[] = "ROUND(AVG({$field['dbAlias']}),2) as $alias";
1869 $this->_columnHeaders
["{$tableName}_{$fieldName}_{$stat}"]['title'] = $label;
1870 $this->_columnHeaders
["{$tableName}_{$fieldName}_{$stat}"]['type'] = $field['type'];
1871 $this->_statFields
[$label] = $alias;
1872 $this->_selectAliases
[] = $alias;
1878 $alias = "{$tableName}_{$fieldName}";
1879 $select[] = "{$field['dbAlias']} as $alias";
1880 $this->_columnHeaders
["{$tableName}_{$fieldName}"]['title'] = CRM_Utils_Array
::value('title', $field);
1881 $this->_columnHeaders
["{$tableName}_{$fieldName}"]['type'] = CRM_Utils_Array
::value('type', $field);
1882 $this->_selectAliases
[] = $alias;
1888 // select for group bys
1889 if (array_key_exists('group_bys', $table)) {
1890 foreach ($table['group_bys'] as $fieldName => $field) {
1892 if ($tableName == 'civicrm_address') {
1893 $this->_addressField
= TRUE;
1895 if ($tableName == 'civicrm_email') {
1896 $this->_emailField
= TRUE;
1898 if ($tableName == 'civicrm_phone') {
1899 $this->_phoneField
= TRUE;
1901 // 1. In many cases we want select clause to be built in slightly different way
1902 // for a particular field of a particular type.
1903 // 2. This method when used should receive params by reference and modify $this->_columnHeaders
1905 $selectClause = $this->selectClause($tableName, 'group_bys', $fieldName, $field);
1906 if ($selectClause) {
1907 $select[] = $selectClause;
1911 if (!empty($this->_params
['group_bys']) && !empty($this->_params
['group_bys'][$fieldName]) && !empty($this->_params
['group_bys_freq'])) {
1912 switch (CRM_Utils_Array
::value($fieldName, $this->_params
['group_bys_freq'])) {
1914 $select[] = "DATE_SUB({$field['dbAlias']}, INTERVAL WEEKDAY({$field['dbAlias']}) DAY) AS {$tableName}_{$fieldName}_start";
1915 $select[] = "YEARWEEK({$field['dbAlias']}) AS {$tableName}_{$fieldName}_subtotal";
1916 $select[] = "WEEKOFYEAR({$field['dbAlias']}) AS {$tableName}_{$fieldName}_interval";
1917 $field['title'] = 'Week';
1921 $select[] = "MAKEDATE(YEAR({$field['dbAlias']}), 1) AS {$tableName}_{$fieldName}_start";
1922 $select[] = "YEAR({$field['dbAlias']}) AS {$tableName}_{$fieldName}_subtotal";
1923 $select[] = "YEAR({$field['dbAlias']}) AS {$tableName}_{$fieldName}_interval";
1924 $field['title'] = 'Year';
1928 $select[] = "DATE_SUB({$field['dbAlias']}, INTERVAL (DAYOFMONTH({$field['dbAlias']})-1) DAY) as {$tableName}_{$fieldName}_start";
1929 $select[] = "MONTH({$field['dbAlias']}) AS {$tableName}_{$fieldName}_subtotal";
1930 $select[] = "MONTHNAME({$field['dbAlias']}) AS {$tableName}_{$fieldName}_interval";
1931 $field['title'] = 'Month';
1935 $select[] = "STR_TO_DATE(CONCAT( 3 * QUARTER( {$field['dbAlias']} ) -2 , '/', '1', '/', YEAR( {$field['dbAlias']} ) ), '%m/%d/%Y') AS {$tableName}_{$fieldName}_start";
1936 $select[] = "QUARTER({$field['dbAlias']}) AS {$tableName}_{$fieldName}_subtotal";
1937 $select[] = "QUARTER({$field['dbAlias']}) AS {$tableName}_{$fieldName}_interval";
1938 $field['title'] = 'Quarter';
1941 // for graphs and charts -
1942 if (!empty($this->_params
['group_bys_freq'][$fieldName])) {
1943 $this->_interval
= $field['title'];
1944 $this->_columnHeaders
["{$tableName}_{$fieldName}_start"]['title'] = $field['title'] . ' Beginning';
1945 $this->_columnHeaders
["{$tableName}_{$fieldName}_start"]['type'] = $field['type'];
1946 $this->_columnHeaders
["{$tableName}_{$fieldName}_start"]['group_by'] = $this->_params
['group_bys_freq'][$fieldName];
1948 // just to make sure these values are transfered to rows.
1949 // since we 'll need them for calculation purpose,
1950 // e.g making subtotals look nicer or graphs
1951 $this->_columnHeaders
["{$tableName}_{$fieldName}_interval"] = array('no_display' => TRUE);
1952 $this->_columnHeaders
["{$tableName}_{$fieldName}_subtotal"] = array('no_display' => TRUE);
1959 $this->_selectClauses
= $select;
1960 $this->_select
= "SELECT " . implode(', ', $select) . " ";
1963 function selectClause(&$tableName, $tableKey, &$fieldName, &$field) {
1968 $this->storeWhereHavingClauseArray();
1970 if (empty($this->_whereClauses
)) {
1971 $this->_where
= "WHERE ( 1 ) ";
1972 $this->_having
= "";
1975 $this->_where
= "WHERE " . implode(' AND ', $this->_whereClauses
);
1978 if ($this->_aclWhere
) {
1979 $this->_where
.= " AND {$this->_aclWhere} ";
1982 if (!empty($this->_havingClauses
)) {
1983 // use this clause to construct group by clause.
1984 $this->_having
= "HAVING " . implode(' AND ', $this->_havingClauses
);
1989 * Store Where clauses into an array - breaking out this step makes
1990 * over-riding more flexible as the clauses can be used in constructing a
1991 * temp table that may not be part of the final where clause or added
1992 * in other functions
1994 function storeWhereHavingClauseArray(){
1995 foreach ($this->_columns
as $tableName => $table) {
1996 if (array_key_exists('filters', $table)) {
1997 foreach ($table['filters'] as $fieldName => $field) {
1998 // respect pseudofield to filter spec so fields can be marked as
1999 // not to be handled here
2000 if(!empty($field['pseudofield'])){
2004 if (CRM_Utils_Array
::value('type', $field) & CRM_Utils_Type
::T_DATE
) {
2005 if (CRM_Utils_Array
::value('operatorType', $field) == CRM_Report_Form
::OP_MONTH
) {
2006 $op = CRM_Utils_Array
::value("{$fieldName}_op", $this->_params
);
2007 $value = CRM_Utils_Array
::value("{$fieldName}_value", $this->_params
);
2008 if (is_array($value) && !empty($value)) {
2009 $clause = "(month({$field['dbAlias']}) $op (" . implode(', ', $value) . '))';
2013 $relative = CRM_Utils_Array
::value("{$fieldName}_relative", $this->_params
);
2014 $from = CRM_Utils_Array
::value("{$fieldName}_from", $this->_params
);
2015 $to = CRM_Utils_Array
::value("{$fieldName}_to", $this->_params
);
2016 $fromTime = CRM_Utils_Array
::value("{$fieldName}_from_time", $this->_params
);
2017 $toTime = CRM_Utils_Array
::value("{$fieldName}_to_time", $this->_params
);
2018 $clause = $this->dateClause($field['dbAlias'], $relative, $from, $to, $field['type'], $fromTime, $toTime);
2022 $op = CRM_Utils_Array
::value("{$fieldName}_op", $this->_params
);
2024 $clause = $this->whereClause($field,
2026 CRM_Utils_Array
::value("{$fieldName}_value", $this->_params
),
2027 CRM_Utils_Array
::value("{$fieldName}_min", $this->_params
),
2028 CRM_Utils_Array
::value("{$fieldName}_max", $this->_params
)
2033 if (!empty($clause)) {
2034 if (!empty($field['having'])) {
2035 $this->_havingClauses
[] = $clause;
2038 $this->_whereClauses
[] = $clause;
2046 function processReportMode() {
2047 $buttonName = $this->controller
->getButtonName();
2049 $output = CRM_Utils_Request
::retrieve(
2052 CRM_Core_DAO
::$_nullObject
2056 CRM_Utils_Request
::retrieve(
2059 CRM_Core_DAO
::$_nullObject
2062 $this->_absoluteUrl
= FALSE;
2064 $this->assign('printOnly', FALSE);
2066 if ($this->_printButtonName
== $buttonName ||
$output == 'print' ||
($this->_sendmail
&& !$output)) {
2067 $this->assign('printOnly', TRUE);
2069 $this->assign('outputMode', 'print');
2070 $this->_outputMode
= 'print';
2071 if ($this->_sendmail
) {
2072 $this->_absoluteUrl
= TRUE;
2075 elseif ($this->_pdfButtonName
== $buttonName ||
$output == 'pdf') {
2076 $this->assign('printOnly', TRUE);
2078 $this->assign('outputMode', 'pdf');
2079 $this->_outputMode
= 'pdf';
2080 $this->_absoluteUrl
= TRUE;
2082 elseif ($this->_csvButtonName
== $buttonName ||
$output == 'csv') {
2083 $this->assign('printOnly', TRUE);
2085 $this->assign('outputMode', 'csv');
2086 $this->_outputMode
= 'csv';
2087 $this->_absoluteUrl
= TRUE;
2089 elseif ($this->_groupButtonName
== $buttonName ||
$output == 'group') {
2090 $this->assign('outputMode', 'group');
2091 $this->_outputMode
= 'group';
2093 elseif ($output == 'create_report' && $this->_criteriaForm
) {
2094 $this->assign('outputMode', 'create_report');
2095 $this->_outputMode
= 'create_report';
2098 $this->assign('outputMode', 'html');
2099 $this->_outputMode
= 'html';
2102 // Get today's date to include in printed reports
2104 $reportDate = CRM_Utils_Date
::customFormat(date('Y-m-d H:i'));
2105 $this->assign('reportDate', $reportDate);
2109 function beginPostProcess() {
2110 $this->setParams($this->controller
->exportValues($this->_name
));
2112 if (empty($this->_params
) &&
2115 $this->setParams($this->_formValues
);
2118 // hack to fix params when submitted from dashboard, CRM-8532
2119 // fields array is missing because form building etc is skipped
2120 // in dashboard mode for report
2121 //@todo - this could be done in the dashboard no we have a setter
2122 if (empty($this->_params
['fields']) && !$this->_noFields
) {
2123 $this->setParams($this->_formValues
);
2126 $this->_formValues
= $this->_params
;
2127 if (CRM_Core_Permission
::check('administer Reports') &&
2128 isset($this->_id
) &&
2129 ($this->_instanceButtonName
== $this->controller
->getButtonName() . '_save' ||
2130 $this->_chartButtonName
== $this->controller
->getButtonName()
2133 $this->assign('updateReportButton', TRUE);
2135 $this->processReportMode();
2136 $this->beginPostProcessCommon();
2140 * beginPostProcess function run in both report mode and non-report mode (api)
2142 function beginPostProcessCommon() {
2146 function buildQuery($applyLimit = TRUE) {
2149 $this->customDataFrom();
2154 // order_by columns not selected for display need to be included in SELECT
2155 $unselectedSectionColumns = $this->unselectedSectionColumns();
2156 foreach ($unselectedSectionColumns as $alias => $section) {
2157 $this->_select
.= ", {$section['dbAlias']} as {$alias}";
2160 if ($applyLimit && empty($this->_params
['charts'])) {
2163 CRM_Utils_Hook
::alterReportVar('sql', $this, $this);
2165 $sql = "{$this->_select} {$this->_from} {$this->_where} {$this->_groupBy} {$this->_having} {$this->_orderBy} {$this->_limit}";
2169 function groupBy() {
2170 $groupBys = array();
2171 if (!empty($this->_params
['group_bys']) &&
2172 is_array($this->_params
['group_bys']) &&
2173 !empty($this->_params
['group_bys'])
2175 foreach ($this->_columns
as $tableName => $table) {
2176 if (array_key_exists('group_bys', $table)) {
2177 foreach ($table['group_bys'] as $fieldName => $field) {
2178 if (!empty($this->_params
['group_bys'][$fieldName])) {
2179 $groupBys[] = $field['dbAlias'];
2186 if (!empty($groupBys)) {
2187 $this->_groupBy
= "GROUP BY " . implode(', ', $groupBys);
2191 function orderBy() {
2192 $this->_orderBy
= "";
2193 $this->_sections
= array();
2194 $this->storeOrderByArray();
2195 if(!empty($this->_orderByArray
) && !$this->_rollup
== 'WITH ROLLUP'){
2196 $this->_orderBy
= "ORDER BY " . implode(', ', $this->_orderByArray
);
2198 $this->assign('sections', $this->_sections
);
2202 * In some cases other functions want to know which fields are selected for ordering by
2203 * Separating this into a separate function allows it to be called separately from constructing
2204 * the order by clause
2206 function storeOrderByArray() {
2207 $orderBys = array();
2209 if (!empty($this->_params
['order_bys']) &&
2210 is_array($this->_params
['order_bys']) &&
2211 !empty($this->_params
['order_bys'])
2214 // Proces order_bys in user-specified order
2215 foreach ($this->_params
['order_bys'] as $orderBy) {
2216 $orderByField = array();
2217 foreach ($this->_columns
as $tableName => $table) {
2218 if (array_key_exists('order_bys', $table)) {
2219 // For DAO columns defined in $this->_columns
2220 $fields = $table['order_bys'];
2222 elseif (array_key_exists('extends', $table)) {
2223 // For custom fields referenced in $this->_customGroupExtends
2224 $fields = CRM_Utils_Array
::value('fields', $table, array());
2226 if (!empty($fields) && is_array($fields)) {
2227 foreach ($fields as $fieldName => $field) {
2228 if ($fieldName == $orderBy['column']) {
2229 $orderByField = array_merge($field, $orderBy);
2230 $orderByField['tplField'] = "{$tableName}_{$fieldName}";
2237 if (!empty($orderByField)) {
2238 $this->_orderByFields
[] = $orderByField;
2239 $orderBys[] = "{$orderByField['dbAlias']} {$orderBy['order']}";
2241 // Record any section headers for assignment to the template
2242 if (!empty($orderBy['section'])) {
2243 $orderByField['pageBreak'] = CRM_Utils_Array
::value('pageBreak', $orderBy);
2244 $this->_sections
[$orderByField['tplField']] = $orderByField;
2250 $this->_orderByArray
= $orderBys;
2252 $this->assign('sections', $this->_sections
);
2255 function unselectedSectionColumns() {
2256 $selectColumns = array();
2257 foreach ($this->_columns
as $tableName => $table) {
2258 if (array_key_exists('fields', $table)) {
2259 foreach ($table['fields'] as $fieldName => $field) {
2260 if (!empty($field['required']) ||
!empty($this->_params
['fields'][$fieldName])) {
2262 $selectColumns["{$tableName}_{$fieldName}"] = 1;
2268 if (is_array($this->_sections
)) {
2269 return array_diff_key($this->_sections
, $selectColumns);
2276 function buildRows($sql, &$rows) {
2277 $dao = CRM_Core_DAO
::executeQuery($sql);
2278 if (!is_array($rows)) {
2282 // use this method to modify $this->_columnHeaders
2283 $this->modifyColumnHeaders();
2285 $unselectedSectionColumns = $this->unselectedSectionColumns();
2287 while ($dao->fetch()) {
2289 foreach ($this->_columnHeaders
as $key => $value) {
2290 if (property_exists($dao, $key)) {
2291 $row[$key] = $dao->$key;
2295 // section headers not selected for display need to be added to row
2296 foreach ($unselectedSectionColumns as $key => $values) {
2297 if (property_exists($dao, $key)) {
2298 $row[$key] = $dao->$key;
2307 * When "order by" fields are marked as sections, this assigns to the template
2308 * an array of total counts for each section. This data is used by the Smarty
2309 * plugin {sectionTotal}
2311 function sectionTotals() {
2313 // Reports using order_bys with sections must populate $this->_selectAliases in select() method.
2314 if (empty($this->_selectAliases
)) {
2318 if (!empty($this->_sections
)) {
2319 // build the query with no LIMIT clause
2320 $select = str_ireplace('SELECT SQL_CALC_FOUND_ROWS ', 'SELECT ', $this->_select
);
2321 $sql = "{$select} {$this->_from} {$this->_where} {$this->_groupBy} {$this->_having} {$this->_orderBy}";
2323 // pull section aliases out of $this->_sections
2324 $sectionAliases = array_keys($this->_sections
);
2327 foreach (array_merge($sectionAliases, $this->_selectAliases
) as $alias) {
2328 $ifnulls[] = "ifnull($alias, '') as $alias";
2331 /* Group (un-limited) report by all aliases and get counts. This might
2332 * be done more efficiently when the contents of $sql are known, ie. by
2333 * overriding this method in the report class.
2337 $query = "select " . implode(", ", $ifnulls) . ", count(*) as ct from ($sql) as subquery group by " . implode(", ", $sectionAliases);
2339 // initialize array of total counts
2341 $dao = CRM_Core_DAO
::executeQuery($query);
2342 while ($dao->fetch()) {
2344 // let $this->_alterDisplay translate any integer ids to human-readable values.
2345 $rows[0] = $dao->toArray();
2346 $this->alterDisplay($rows);
2349 // add totals for all permutations of section values
2352 $aliasCount = count($sectionAliases);
2353 foreach ($sectionAliases as $alias) {
2354 $values[] = $row[$alias];
2355 $key = implode(CRM_Core_DAO
::VALUE_SEPARATOR
, $values);
2356 if ($i == $aliasCount) {
2357 // the last alias is the lowest-level section header; use count as-is
2358 $totals[$key] = $dao->ct
;
2361 // other aliases are higher level; roll count into their total
2362 $totals[$key] +
= $dao->ct
;
2366 $this->assign('sectionTotals', $totals);
2370 function modifyColumnHeaders() {
2371 // use this method to modify $this->_columnHeaders
2374 function doTemplateAssignment(&$rows) {
2375 $this->assign_by_ref('columnHeaders', $this->_columnHeaders
);
2376 $this->assign_by_ref('rows', $rows);
2377 $this->assign('statistics', $this->statistics($rows));
2380 // override this method to build your own statistics
2381 function statistics(&$rows) {
2382 $statistics = array();
2384 $count = count($rows);
2386 if ($this->_rollup
&& ($this->_rollup
!= '') && $this->_grandFlag
) {
2390 $this->countStat($statistics, $count);
2392 $this->groupByStat($statistics);
2394 $this->filterStat($statistics);
2399 function countStat(&$statistics, $count) {
2400 $statistics['counts']['rowCount'] = array('title' => ts('Row(s) Listed'),
2404 if ($this->_rowsFound
&& ($this->_rowsFound
> $count)) {
2405 $statistics['counts']['rowsFound'] = array('title' => ts('Total Row(s)'),
2406 'value' => $this->_rowsFound
,
2411 function groupByStat(&$statistics) {
2412 if (!empty($this->_params
['group_bys']) &&
2413 is_array($this->_params
['group_bys']) &&
2414 !empty($this->_params
['group_bys'])
2416 foreach ($this->_columns
as $tableName => $table) {
2417 if (array_key_exists('group_bys', $table)) {
2418 foreach ($table['group_bys'] as $fieldName => $field) {
2419 if (!empty($this->_params
['group_bys'][$fieldName])) {
2420 $combinations[] = $field['title'];
2425 $statistics['groups'][] = array('title' => ts('Grouping(s)'),
2426 'value' => implode(' & ', $combinations),
2431 function filterStat(&$statistics) {
2432 foreach ($this->_columns
as $tableName => $table) {
2433 if (array_key_exists('filters', $table)) {
2434 foreach ($table['filters'] as $fieldName => $field) {
2435 if (CRM_Utils_Array
::value('type', $field) & CRM_Utils_Type
::T_DATE
&& CRM_Utils_Array
::value('operatorType', $field) != CRM_Report_Form
::OP_MONTH
) {
2438 CRM_Utils_Array
::value("{$fieldName}_relative", $this->_params
),
2439 CRM_Utils_Array
::value("{$fieldName}_from", $this->_params
),
2440 CRM_Utils_Array
::value("{$fieldName}_to", $this->_params
),
2441 CRM_Utils_Array
::value("{$fieldName}_from_time", $this->_params
),
2442 CRM_Utils_Array
::value("{$fieldName}_to_time", $this->_params
)
2444 $from_time_format = !empty($this->_params
["{$fieldName}_from_time"]) ?
'h' : 'd';
2445 $from = CRM_Utils_Date
::customFormat($from, null, array($from_time_format));
2447 $to_time_format = !empty($this->_params
["{$fieldName}_to_time"]) ?
'h' : 'd';
2448 $to = CRM_Utils_Date
::customFormat($to, null, array($to_time_format));
2451 $statistics['filters'][] = array(
2452 'title' => $field['title'],
2453 'value' => ts("Between %1 and %2", array(1 => $from, 2 => $to)),
2456 elseif (in_array($rel = CRM_Utils_Array
::value("{$fieldName}_relative", $this->_params
),
2457 array_keys($this->getOperationPair(CRM_Report_Form
::OP_DATE
))
2459 $pair = $this->getOperationPair(CRM_Report_Form
::OP_DATE
);
2460 $statistics['filters'][] = array(
2461 'title' => $field['title'],
2462 'value' => $pair[$rel],
2467 $op = CRM_Utils_Array
::value("{$fieldName}_op", $this->_params
);
2470 $pair = $this->getOperationPair(
2471 CRM_Utils_Array
::value('operatorType', $field),
2474 $min = CRM_Utils_Array
::value("{$fieldName}_min", $this->_params
);
2475 $max = CRM_Utils_Array
::value("{$fieldName}_max", $this->_params
);
2476 $val = CRM_Utils_Array
::value("{$fieldName}_value", $this->_params
);
2477 if (in_array($op, array(
2478 'bw', 'nbw')) && ($min ||
$max)) {
2479 $value = "{$pair[$op]} " . $min . ' and ' . $max;
2481 elseif ($op == 'nll' ||
$op == 'nnll') {
2482 $value = $pair[$op];
2484 elseif (is_array($val) && (!empty($val))) {
2485 $options = CRM_Utils_Array
::value('options', $field, array());
2486 foreach ($val as $key => $valIds) {
2487 if (isset($options[$valIds])) {
2488 $val[$key] = $options[$valIds];
2491 $pair[$op] = (count($val) == 1) ?
(($op == 'notin') ?
ts('Is Not') : ts('Is')) : CRM_Utils_Array
::value($op, $pair);
2492 $val = implode(', ', $val);
2493 $value = "{$pair[$op]} " . $val;
2495 elseif (!is_array($val) && (!empty($val) ||
$val == '0') && isset($field['options']) &&
2496 is_array($field['options']) && !empty($field['options'])
2498 $value = CRM_Utils_Array
::value($op, $pair) . " " . CRM_Utils_Array
::value($val, $field['options'], $val);
2501 $value = CRM_Utils_Array
::value($op, $pair) . " " . $val;
2505 $statistics['filters'][] = array('title' => CRM_Utils_Array
::value('title', $field),
2515 function endPostProcess(&$rows = NULL) {
2516 if ( $this->_storeResultSet
) {
2517 $this->_resultSet
= $rows;
2520 if ($this->_outputMode
== 'print' ||
2521 $this->_outputMode
== 'pdf' ||
2525 $content = $this->compileContent();
2526 $url = CRM_Utils_System
::url("civicrm/report/instance/{$this->_id}",
2530 if ($this->_sendmail
) {
2531 $config = CRM_Core_Config
::singleton();
2532 $attachments = array();
2534 if ($this->_outputMode
== 'csv') {
2535 $content = $this->_formValues
['report_header'] . '<p>' . ts('Report URL') . ": {$url}</p>" . '<p>' . ts('The report is attached as a CSV file.') . '</p>' . $this->_formValues
['report_footer'];
2537 $csvFullFilename = $config->templateCompileDir
. CRM_Utils_File
::makeFileName('CiviReport.csv');
2538 $csvContent = CRM_Report_Utils_Report
::makeCsv($this, $rows);
2539 file_put_contents($csvFullFilename, $csvContent);
2540 $attachments[] = array(
2541 'fullPath' => $csvFullFilename,
2542 'mime_type' => 'text/csv',
2543 'cleanName' => 'CiviReport.csv',
2546 if ($this->_outputMode
== 'pdf') {
2547 // generate PDF content
2548 $pdfFullFilename = $config->templateCompileDir
. CRM_Utils_File
::makeFileName('CiviReport.pdf');
2549 file_put_contents($pdfFullFilename,
2550 CRM_Utils_PDF_Utils
::html2pdf($content, "CiviReport.pdf",
2551 TRUE, array('orientation' => 'landscape')
2554 // generate Email Content
2555 $content = $this->_formValues
['report_header'] . '<p>' . ts('Report URL') . ": {$url}</p>" . '<p>' . ts('The report is attached as a PDF file.') . '</p>' . $this->_formValues
['report_footer'];
2557 $attachments[] = array(
2558 'fullPath' => $pdfFullFilename,
2559 'mime_type' => 'application/pdf',
2560 'cleanName' => 'CiviReport.pdf',
2564 if (CRM_Report_Utils_Report
::mailReport($content, $this->_id
,
2565 $this->_outputMode
, $attachments
2567 CRM_Core_Session
::setStatus(ts("Report mail has been sent."), ts('Sent'), 'success');
2570 CRM_Core_Session
::setStatus(ts("Report mail could not be sent."), ts('Mail Error'), 'error');
2573 CRM_Utils_System
::redirect(CRM_Utils_System
::url(CRM_Utils_System
::currentPath(), 'reset=1'));
2575 elseif ($this->_outputMode
== 'print') {
2579 if ($chartType = CRM_Utils_Array
::value('charts', $this->_params
)) {
2580 $config = CRM_Core_Config
::singleton();
2581 //get chart image name
2582 $chartImg = $this->_chartId
. '.png';
2583 //get image url path
2584 $uploadUrl = str_replace('/persist/contribute/', '/persist/', $config->imageUploadURL
) . 'openFlashChart/';
2585 $uploadUrl .= $chartImg;
2586 //get image doc path to overwrite
2587 $uploadImg = str_replace('/persist/contribute/', '/persist/', $config->imageUploadDir
) . 'openFlashChart/' . $chartImg;
2589 $chart = imagecreatefrompng($uploadUrl);
2590 //convert it into formattd png
2591 header('Content-type: image/png');
2592 //overwrite with same image
2593 imagepng($chart, $uploadImg);
2595 imagedestroy($chart);
2597 CRM_Utils_PDF_Utils
::html2pdf($content, "CiviReport.pdf", FALSE, array('orientation' => 'landscape'));
2599 CRM_Utils_System
::civiExit();
2601 elseif ($this->_outputMode
== 'csv') {
2602 CRM_Report_Utils_Report
::export2csv($this, $rows);
2604 elseif ($this->_outputMode
== 'group') {
2605 $group = $this->_params
['groups'];
2606 $this->add2group($group);
2608 elseif ($this->_instanceButtonName
== $this->controller
->getButtonName()) {
2609 CRM_Report_Form_Instance
::postProcess($this);
2611 elseif ($this->_createNewButtonName
== $this->controller
->getButtonName() ||
2612 $this->_outputMode
== 'create_report' ) {
2613 $this->_createNew
= TRUE;
2614 CRM_Report_Form_Instance
::postProcess($this);
2618 function storeResultSet() {
2619 $this->_storeResultSet
= TRUE;
2622 function getResultSet() {
2623 return $this->_resultSet
;
2627 * Get Template file name - use default form template if a specific one has not been set up for this report
2630 function getTemplateFileName(){
2631 $defaultTpl = parent
::getTemplateFileName();
2632 $template = CRM_Core_Smarty
::singleton();
2633 if (!$template->template_exists($defaultTpl)) {
2634 $defaultTpl = 'CRM/Report/Form.tpl';
2640 * Compile the report content
2642 * Although this function is super-short it is useful to keep separate so it can be over-ridden by report classes.
2644 function compileContent(){
2645 $templateFile = $this->getHookedTemplateFileName();
2646 return $this->_formValues
['report_header'] . CRM_Core_Form
::$_template->fetch($templateFile) . $this->_formValues
['report_footer'];
2650 function postProcess() {
2651 // get ready with post process params
2652 $this->beginPostProcess();
2655 $sql = $this->buildQuery();
2657 // build array of result based on column headers. This method also allows
2658 // modifying column headers before using it to build result set i.e $rows.
2660 $this->buildRows($sql, $rows);
2662 // format result set.
2663 $this->formatDisplay($rows);
2665 // assign variables to templates
2666 $this->doTemplateAssignment($rows);
2668 // do print / pdf / instance stuff if needed
2669 $this->endPostProcess($rows);
2672 function limit($rowCount = self
::ROW_COUNT_LIMIT
) {
2673 // lets do the pager if in html mode
2674 $this->_limit
= NULL;
2675 if ($this->_outputMode
== 'html' ||
$this->_outputMode
== 'group') {
2676 $this->_select
= str_ireplace('SELECT ', 'SELECT SQL_CALC_FOUND_ROWS ', $this->_select
);
2678 $pageId = CRM_Utils_Request
::retrieve('crmPID', 'Integer', CRM_Core_DAO
::$_nullObject);
2680 if (!$pageId && !empty($_POST)) {
2681 if (isset($_POST['PagerBottomButton']) && isset($_POST['crmPID_B'])) {
2682 $pageId = max((int)@$_POST['crmPID_B'], 1);
2684 elseif (isset($_POST['PagerTopButton']) && isset($_POST['crmPID'])) {
2685 $pageId = max((int)@$_POST['crmPID'], 1);
2687 unset($_POST['crmPID_B'], $_POST['crmPID']);
2690 $pageId = $pageId ?
$pageId : 1;
2691 $this->set(CRM_Utils_Pager
::PAGE_ID
, $pageId);
2692 $offset = ($pageId - 1) * $rowCount;
2694 $offset = CRM_Utils_Type
::escape($offset, 'Int');
2695 $rowCount = CRM_Utils_Type
::escape($rowCount, 'Int');
2697 $this->_limit
= " LIMIT $offset, $rowCount";
2698 return array($offset, $rowCount);
2700 if($this->_limitValue
) {
2701 if($this->_offsetValue
) {
2702 $this->_limit
= " LIMIT {$this->_offsetValue}, {$this->_limitValue} ";
2705 $this->_limit
= " LIMIT " . $this->_limitValue
;
2710 function setPager($rowCount = self
::ROW_COUNT_LIMIT
) {
2711 if ($this->_limit
&& ($this->_limit
!= '')) {
2712 $sql = "SELECT FOUND_ROWS();";
2713 $this->_rowsFound
= CRM_Core_DAO
::singleValueQuery($sql);
2715 'total' => $this->_rowsFound
,
2716 'rowCount' => $rowCount,
2717 'status' => ts('Records') . ' %%StatusMessage%%',
2718 'buttonBottom' => 'PagerBottomButton',
2719 'buttonTop' => 'PagerTopButton',
2720 'pageID' => $this->get(CRM_Utils_Pager
::PAGE_ID
),
2723 $pager = new CRM_Utils_Pager($params);
2724 $this->assign_by_ref('pager', $pager);
2725 $this->ajaxResponse
['totalRows'] = $this->_rowsFound
;
2729 function whereGroupClause($field, $value, $op) {
2731 $smartGroupQuery = "";
2733 $group = new CRM_Contact_DAO_Group();
2734 $group->is_active
= 1;
2736 $smartGroups = array();
2737 while ($group->fetch()) {
2738 if (in_array($group->id
, $this->_params
['gid_value']) && $group->saved_search_id
) {
2739 $smartGroups[] = $group->id
;
2743 CRM_Contact_BAO_GroupContactCache
::check($smartGroups);
2745 $smartGroupQuery = '';
2746 if (!empty($smartGroups)) {
2747 $smartGroups = implode(',', $smartGroups);
2748 $smartGroupQuery = " UNION DISTINCT
2749 SELECT DISTINCT smartgroup_contact.contact_id
2750 FROM civicrm_group_contact_cache smartgroup_contact
2751 WHERE smartgroup_contact.group_id IN ({$smartGroups}) ";
2754 $sqlOp = $this->getSQLOperator($op);
2755 if (!is_array($value)) {
2756 $value = array($value);
2758 $clause = "{$field['dbAlias']} IN (" . implode(', ', $value) . ")";
2760 return " {$this->_aliases['civicrm_contact']}.id {$sqlOp} (
2761 SELECT DISTINCT {$this->_aliases['civicrm_group']}.contact_id
2762 FROM civicrm_group_contact {$this->_aliases['civicrm_group']}
2763 WHERE {$clause} AND {$this->_aliases['civicrm_group']}.status = 'Added'
2764 {$smartGroupQuery} ) ";
2767 function whereTagClause($field, $value, $op) {
2768 // not using left join in query because if any contact
2769 // belongs to more than one tag, results duplicate
2771 $sqlOp = $this->getSQLOperator($op);
2772 if (!is_array($value)) {
2773 $value = array($value);
2775 $clause = "{$field['dbAlias']} IN (" . implode(', ', $value) . ")";
2777 return " {$this->_aliases['civicrm_contact']}.id {$sqlOp} (
2778 SELECT DISTINCT {$this->_aliases['civicrm_tag']}.entity_id
2779 FROM civicrm_entity_tag {$this->_aliases['civicrm_tag']}
2780 WHERE entity_table = 'civicrm_contact' AND {$clause} ) ";
2783 function buildACLClause($tableAlias = 'contact_a') {
2784 list($this->_aclFrom
, $this->_aclWhere
) = CRM_Contact_BAO_Contact_Permission
::cacheClause($tableAlias);
2787 function addCustomDataToColumns($addFields = TRUE, $permCustomGroupIds = array()) {
2788 if (empty($this->_customGroupExtends
)) {
2791 if (!is_array($this->_customGroupExtends
)) {
2792 $this->_customGroupExtends
= array($this->_customGroupExtends
);
2794 $customGroupWhere = '';
2795 if (!empty($permCustomGroupIds)) {
2796 $customGroupWhere = "cg.id IN (".implode(',' , $permCustomGroupIds).") AND";
2799 SELECT cg.table_name, cg.title, cg.extends, cf.id as cf_id, cf.label,
2800 cf.column_name, cf.data_type, cf.html_type, cf.option_group_id, cf.time_format
2801 FROM civicrm_custom_group cg
2802 INNER JOIN civicrm_custom_field cf ON cg.id = cf.custom_group_id
2803 WHERE cg.extends IN ('" . implode("','", $this->_customGroupExtends
) . "') AND
2805 cg.is_active = 1 AND
2806 cf.is_active = 1 AND
2807 cf.is_searchable = 1
2808 ORDER BY cg.weight, cf.weight";
2809 $customDAO = CRM_Core_DAO
::executeQuery($sql);
2812 while ($customDAO->fetch()) {
2813 if ($customDAO->table_name
!= $curTable) {
2814 $curTable = $customDAO->table_name
;
2815 $curFields = $curFilters = array();
2818 $this->_columns
[$curTable]['dao'] = 'CRM_Contact_DAO_Contact';
2819 $this->_columns
[$curTable]['extends'] = $customDAO->extends;
2820 $this->_columns
[$curTable]['grouping'] = $customDAO->table_name
;
2821 $this->_columns
[$curTable]['group_title'] = $customDAO->title
;
2824 'fields', 'filters', 'group_bys') as $colKey) {
2825 if (!array_key_exists($colKey, $this->_columns
[$curTable])) {
2826 $this->_columns
[$curTable][$colKey] = array();
2830 $fieldName = 'custom_' . $customDAO->cf_id
;
2833 // this makes aliasing work in favor
2834 $curFields[$fieldName] = array(
2835 'name' => $customDAO->column_name
,
2836 'title' => $customDAO->label
,
2837 'dataType' => $customDAO->data_type
,
2838 'htmlType' => $customDAO->html_type
,
2841 if ($this->_customGroupFilters
) {
2842 // this makes aliasing work in favor
2843 $curFilters[$fieldName] = array(
2844 'name' => $customDAO->column_name
,
2845 'title' => $customDAO->label
,
2846 'dataType' => $customDAO->data_type
,
2847 'htmlType' => $customDAO->html_type
,
2851 switch ($customDAO->data_type
) {
2854 $curFilters[$fieldName]['operatorType'] = CRM_Report_Form
::OP_DATE
;
2855 $curFilters[$fieldName]['type'] = CRM_Utils_Type
::T_DATE
;
2856 // CRM-6946, show time part for datetime date fields
2857 if ($customDAO->time_format
) {
2858 $curFields[$fieldName]['type'] = CRM_Utils_Type
::T_TIMESTAMP
;
2863 $curFilters[$fieldName]['operatorType'] = CRM_Report_Form
::OP_SELECT
;
2864 $curFilters[$fieldName]['options'] = array('' => ts('- select -'),
2868 $curFilters[$fieldName]['type'] = CRM_Utils_Type
::T_INT
;
2872 $curFilters[$fieldName]['operatorType'] = CRM_Report_Form
::OP_INT
;
2873 $curFilters[$fieldName]['type'] = CRM_Utils_Type
::T_INT
;
2877 $curFilters[$fieldName]['operatorType'] = CRM_Report_Form
::OP_FLOAT
;
2878 $curFilters[$fieldName]['type'] = CRM_Utils_Type
::T_MONEY
;
2882 $curFilters[$fieldName]['operatorType'] = CRM_Report_Form
::OP_FLOAT
;
2883 $curFilters[$fieldName]['type'] = CRM_Utils_Type
::T_FLOAT
;
2887 $curFilters[$fieldName]['type'] = CRM_Utils_Type
::T_STRING
;
2889 if (!empty($customDAO->option_group_id
)) {
2890 if (in_array($customDAO->html_type
, array(
2891 'Multi-Select', 'AdvMulti-Select', 'CheckBox'))) {
2892 $curFilters[$fieldName]['operatorType'] = CRM_Report_Form
::OP_MULTISELECT_SEPARATOR
;
2895 $curFilters[$fieldName]['operatorType'] = CRM_Report_Form
::OP_MULTISELECT
;
2897 if ($this->_customGroupFilters
) {
2898 $curFilters[$fieldName]['options'] = array();
2899 $ogDAO = CRM_Core_DAO
::executeQuery("SELECT ov.value, ov.label FROM civicrm_option_value ov WHERE ov.option_group_id = %1 ORDER BY ov.weight", array(1 => array($customDAO->option_group_id
, 'Integer')));
2900 while ($ogDAO->fetch()) {
2901 $curFilters[$fieldName]['options'][$ogDAO->value
] = $ogDAO->label
;
2907 case 'StateProvince':
2908 if (in_array($customDAO->html_type
, array(
2909 'Multi-Select State/Province'))) {
2910 $curFilters[$fieldName]['operatorType'] = CRM_Report_Form
::OP_MULTISELECT_SEPARATOR
;
2913 $curFilters[$fieldName]['operatorType'] = CRM_Report_Form
::OP_MULTISELECT
;
2915 $curFilters[$fieldName]['options'] = CRM_Core_PseudoConstant
::stateProvince();
2919 if (in_array($customDAO->html_type
, array(
2920 'Multi-Select Country'))) {
2921 $curFilters[$fieldName]['operatorType'] = CRM_Report_Form
::OP_MULTISELECT_SEPARATOR
;
2924 $curFilters[$fieldName]['operatorType'] = CRM_Report_Form
::OP_MULTISELECT
;
2926 $curFilters[$fieldName]['options'] = CRM_Core_PseudoConstant
::country();
2929 case 'ContactReference':
2930 $curFilters[$fieldName]['type'] = CRM_Utils_Type
::T_STRING
;
2931 $curFilters[$fieldName]['name'] = 'display_name';
2932 $curFilters[$fieldName]['alias'] = "contact_{$fieldName}_civireport";
2934 $curFields[$fieldName]['type'] = CRM_Utils_Type
::T_STRING
;
2935 $curFields[$fieldName]['name'] = 'display_name';
2936 $curFields[$fieldName]['alias'] = "contact_{$fieldName}_civireport";
2940 $curFields[$fieldName]['type'] = CRM_Utils_Type
::T_STRING
;
2941 $curFilters[$fieldName]['type'] = CRM_Utils_Type
::T_STRING
;
2944 if (!array_key_exists('type', $curFields[$fieldName])) {
2945 $curFields[$fieldName]['type'] = CRM_Utils_Array
::value('type', $curFilters[$fieldName], array());
2949 $this->_columns
[$curTable]['fields'] = array_merge($this->_columns
[$curTable]['fields'], $curFields);
2951 if ($this->_customGroupFilters
) {
2952 $this->_columns
[$curTable]['filters'] = array_merge($this->_columns
[$curTable]['filters'], $curFilters);
2954 if ($this->_customGroupGroupBy
) {
2955 $this->_columns
[$curTable]['group_bys'] = array_merge($this->_columns
[$curTable]['group_bys'], $curFields);
2960 function customDataFrom() {
2961 if (empty($this->_customGroupExtends
)) {
2964 $mapper = CRM_Core_BAO_CustomQuery
::$extendsMap;
2966 foreach ($this->_columns
as $table => $prop) {
2967 if (substr($table, 0, 13) == 'civicrm_value' ||
substr($table, 0, 12) == 'custom_value') {
2968 $extendsTable = $mapper[$prop['extends']];
2970 // check field is in params
2971 if (!$this->isFieldSelected($prop)) {
2974 $baseJoin = CRM_Utils_Array
::value($prop['extends'], $this->_customGroupExtendsJoin
, "{$this->_aliases[$extendsTable]}.id");
2976 $customJoin = is_array($this->_customGroupJoin
) ?
$this->_customGroupJoin
[$table] : $this->_customGroupJoin
;
2978 {$customJoin} {$table} {$this->_aliases[$table]} ON {$this->_aliases[$table]}.entity_id = {$baseJoin}";
2979 // handle for ContactReference
2980 if (array_key_exists('fields', $prop)) {
2981 foreach ($prop['fields'] as $fieldName => $field) {
2982 if (CRM_Utils_Array
::value('dataType', $field) == 'ContactReference') {
2983 $columnName = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_CustomField', CRM_Core_BAO_CustomField
::getKeyID($fieldName), 'column_name');
2985 LEFT JOIN civicrm_contact {$field['alias']} ON {$field['alias']}.id = {$this->_aliases[$table]}.{$columnName} ";
2993 function isFieldSelected($prop) {
2998 if (!empty($this->_params
['fields'])) {
2999 foreach (array_keys($prop['fields']) as $fieldAlias) {
3000 $customFieldId = CRM_Core_BAO_CustomField
::getKeyID($fieldAlias);
3001 if ($customFieldId) {
3002 if (array_key_exists($fieldAlias, $this->_params
['fields'])) {
3006 //might be survey response field.
3007 if (!empty($this->_params
['fields']['survey_response']) && !empty($prop['fields'][$fieldAlias]['isSurveyResponseField'])) {
3014 if (!empty($this->_params
['group_bys']) && $this->_customGroupGroupBy
) {
3015 foreach (array_keys($prop['group_bys']) as $fieldAlias) {
3016 if (array_key_exists($fieldAlias, $this->_params
['group_bys']) && CRM_Core_BAO_CustomField
::getKeyID($fieldAlias)) {
3022 if (!empty($this->_params
['order_bys'])) {
3023 foreach (array_keys($prop['fields']) as $fieldAlias) {
3024 foreach ($this->_params
['order_bys'] as $orderBy) {
3025 if ($fieldAlias == $orderBy['column'] && CRM_Core_BAO_CustomField
::getKeyID($fieldAlias)) {
3032 if (!empty($prop['filters']) && $this->_customGroupFilters
) {
3033 foreach ($prop['filters'] as $fieldAlias => $val) {
3035 'value', 'min', 'max', 'relative', 'from', 'to') as $attach) {
3036 if (isset($this->_params
[$fieldAlias . '_' . $attach]) &&
3037 (!empty($this->_params
[$fieldAlias . '_' . $attach])
3038 ||
($attach != 'relative' && $this->_params
[$fieldAlias . '_' . $attach] == '0')
3044 if (!empty($this->_params
[$fieldAlias . '_op']) &&
3045 in_array($this->_params
[$fieldAlias . '_op'], array('nll', 'nnll'))
3056 * Check for empty order_by configurations and remove them; also set
3057 * template to hide them.
3059 function preProcessOrderBy(&$formValues) {
3060 // Object to show/hide form elements
3061 $_showHide = new CRM_Core_ShowHideBlocks('', '');
3063 $_showHide->addShow('optionField_1');
3065 // Cycle through order_by options; skip any empty ones, and hide them as well
3068 if (!empty($formValues['order_bys'])) {
3069 foreach ($formValues['order_bys'] as $order_by) {
3070 if ($order_by['column'] && $order_by['column'] != '-') {
3071 $_showHide->addShow('optionField_' . $n);
3072 $orderBys[$n] = $order_by;
3077 for ($i = $n; $i <= 5; $i++
) {
3079 $_showHide->addHide('optionField_' . $i);
3083 // overwrite order_by options with modified values
3084 if (!empty($orderBys)) {
3085 $formValues['order_bys'] = $orderBys;
3088 $formValues['order_bys'] = array(1 => array('column' => '-'));
3091 // assign show/hide data to template
3092 $_showHide->addToTemplate();
3096 * Does table name have columns in SELECT clause?
3098 * @param string $tableName Name of table (index of $this->_columns array)
3102 function isTableSelected($tableName) {
3103 return in_array($tableName, $this->selectedTables());
3107 * Fetch array of DAO tables having columns included in SELECT or ORDER BY clause
3108 * (building the array if it's unset)
3110 * @return Array $this->_selectedTables
3112 function selectedTables() {
3113 if (!$this->_selectedTables
) {
3114 $orderByColumns = array();
3115 if (array_key_exists('order_bys', $this->_params
) && is_array($this->_params
['order_bys'])) {
3116 foreach ($this->_params
['order_bys'] as $orderBy) {
3117 $orderByColumns[] = $orderBy['column'];
3121 foreach ($this->_columns
as $tableName => $table) {
3122 if (array_key_exists('fields', $table)) {
3123 foreach ($table['fields'] as $fieldName => $field) {
3124 if (!empty($field['required']) ||
!empty($this->_params
['fields'][$fieldName])) {
3125 $this->_selectedTables
[] = $tableName;
3130 if (array_key_exists('order_bys', $table)) {
3131 foreach ($table['order_bys'] as $orderByName => $orderBy) {
3132 if (in_array($orderByName, $orderByColumns)) {
3133 $this->_selectedTables
[] = $tableName;
3138 if (array_key_exists('filters', $table)) {
3139 foreach ($table['filters'] as $filterName => $filter) {
3140 if (!empty($this->_params
["{$filterName}_value"]) ||
3141 CRM_Utils_Array
::value("{$filterName}_op", $this->_params
) == 'nll' ||
3142 CRM_Utils_Array
::value("{$filterName}_op", $this->_params
) == 'nnll'
3144 $this->_selectedTables
[] = $tableName;
3151 return $this->_selectedTables
;
3155 * @deprecated - use getAddressColumns which is a more accurate description
3156 * and also accepts an array of options rather than a long list
3158 * function for adding address fields to construct function in reports
3159 * @param bool $groupBy Add GroupBy? Not appropriate for detail report
3160 * @param bool $orderBy Add GroupBy? Not appropriate for detail report
3161 * @return array address fields for construct clause
3163 function addAddressFields($groupBy = TRUE, $orderBy = FALSE, $filters = TRUE, $defaults = array(
3164 'country_id' => TRUE)) {
3165 $addressFields = array(
3166 'civicrm_address' =>
3168 'dao' => 'CRM_Core_DAO_Address',
3172 array('title' => ts('Address Name'),
3173 'default' => CRM_Utils_Array
::value('name', $defaults, FALSE),
3176 array('title' => ts('Street Address'),
3177 'default' => CRM_Utils_Array
::value('street_address', $defaults, FALSE),
3179 'supplemental_address_1' =>
3180 array('title' => ts('Supplementary Address Field 1'),
3181 'default' => CRM_Utils_Array
::value('supplemental_address_1', $defaults, FALSE),
3183 'supplemental_address_2' =>
3184 array('title' => ts('Supplementary Address Field 2'),
3185 'default' => CRM_Utils_Array
::value('supplemental_address_2', $defaults, FALSE),
3189 'name' => 'street_number',
3190 'title' => ts('Street Number'),
3192 'default' => CRM_Utils_Array
::value('street_number', $defaults, FALSE),
3196 'name' => 'street_name',
3197 'title' => ts('Street Name'),
3199 'default' => CRM_Utils_Array
::value('street_name', $defaults, FALSE),
3203 'name' => 'street_unit',
3204 'title' => ts('Street Unit'),
3206 'default' => CRM_Utils_Array
::value('street_unit', $defaults, FALSE),
3209 array('title' => ts('City'),
3210 'default' => CRM_Utils_Array
::value('city', $defaults, FALSE),
3213 array('title' => ts('Postal Code'),
3214 'default' => CRM_Utils_Array
::value('postal_code', $defaults, FALSE),
3216 'postal_code_suffix' =>
3217 array('title' => ts('Postal Code Suffix'),
3218 'default' => CRM_Utils_Array
::value('postal_code_suffix', $defaults, FALSE),
3221 array('title' => ts('County'),
3222 'default' => CRM_Utils_Array
::value('county_id', $defaults, FALSE),
3224 'state_province_id' =>
3225 array('title' => ts('State/Province'),
3226 'default' => CRM_Utils_Array
::value('state_province_id', $defaults, FALSE),
3229 array('title' => ts('Country'),
3230 'default' => CRM_Utils_Array
::value('country_id', $defaults, FALSE),
3233 'grouping' => 'location-fields',
3238 $addressFields['civicrm_address']['filters'] = array(
3239 'street_number' => array('title' => ts('Street Number'),
3241 'name' => 'street_number',
3243 'street_name' => array('title' => ts('Street Name'),
3244 'name' => 'street_name',
3245 'operator' => 'like',
3247 'postal_code' => array('title' => ts('Postal Code'),
3249 'name' => 'postal_code',
3251 'city' => array('title' => ts('City'),
3252 'operator' => 'like',
3255 'county_id' => array(
3256 'name' => 'county_id',
3257 'title' => ts('County'),
3258 'type' => CRM_Utils_Type
::T_INT
,
3260 CRM_Report_Form
::OP_MULTISELECT
,
3262 CRM_Core_PseudoConstant
::county(),
3264 'state_province_id' => array(
3265 'name' => 'state_province_id',
3266 'title' => ts('State/Province'),
3267 'type' => CRM_Utils_Type
::T_INT
,
3269 CRM_Report_Form
::OP_MULTISELECT
,
3271 CRM_Core_PseudoConstant
::stateProvince(),
3273 'country_id' => array(
3274 'name' => 'country_id',
3275 'title' => ts('Country'),
3276 'type' => CRM_Utils_Type
::T_INT
,
3278 CRM_Report_Form
::OP_MULTISELECT
,
3280 CRM_Core_PseudoConstant
::country(),
3286 $addressFields['civicrm_address']['order_bys'] = array('street_name' => array('title' => ts('Street Name')),
3287 'street_number' => array('title' => 'Odd / Even Street Number'),
3288 'street_address' => NULL,
3290 'postal_code' => NULL,
3295 $addressFields['civicrm_address']['group_bys'] = array(
3296 'street_address' => NULL,
3298 'postal_code' => NULL,
3299 'state_province_id' =>
3300 array('title' => ts('State/Province'),
3303 array('title' => ts('Country'),
3306 array('title' => ts('County'),
3310 return $addressFields;
3314 * Do AlterDisplay processing on Address Fields
3316 function alterDisplayAddressFields(&$row, &$rows, &$rowNum, $baseUrl, $urltxt) {
3317 $criteriaQueryParams = CRM_Report_Utils_Report
::getPreviewCriteriaQueryParams($this->_defaults
, $this->_params
);
3318 $entryFound = FALSE;
3320 if (array_key_exists('civicrm_address_country_id', $row)) {
3321 if ($value = $row['civicrm_address_country_id']) {
3322 $rows[$rowNum]['civicrm_address_country_id'] = CRM_Core_PseudoConstant
::country($value, FALSE);
3323 $url = CRM_Report_Utils_Report
::getNextUrl($baseUrl,
3324 "reset=1&force=1&{$criteriaQueryParams}&" .
3325 "country_id_op=in&country_id_value={$value}",
3326 $this->_absoluteUrl
, $this->_id
3328 $rows[$rowNum]['civicrm_address_country_id_link'] = $url;
3329 $rows[$rowNum]['civicrm_address_country_id_hover'] = ts("%1 for this country.",
3336 if (array_key_exists('civicrm_address_county_id', $row)) {
3337 if ($value = $row['civicrm_address_county_id']) {
3338 $rows[$rowNum]['civicrm_address_county_id'] = CRM_Core_PseudoConstant
::county($value, FALSE);
3339 $url = CRM_Report_Utils_Report
::getNextUrl($baseUrl,
3340 "reset=1&force=1&{$criteriaQueryParams}&" .
3341 "county_id_op=in&county_id_value={$value}",
3342 $this->_absoluteUrl
, $this->_id
3344 $rows[$rowNum]['civicrm_address_county_id_link'] = $url;
3345 $rows[$rowNum]['civicrm_address_county_id_hover'] = ts("%1 for this county.",
3351 // handle state province
3352 if (array_key_exists('civicrm_address_state_province_id', $row)) {
3353 if ($value = $row['civicrm_address_state_province_id']) {
3354 $rows[$rowNum]['civicrm_address_state_province_id'] = CRM_Core_PseudoConstant
::stateProvince($value, FALSE);
3356 $url = CRM_Report_Utils_Report
::getNextUrl($baseUrl,
3357 "reset=1&force=1&{$criteriaQueryParams}&state_province_id_op=in&state_province_id_value={$value}",
3358 $this->_absoluteUrl
, $this->_id
3360 $rows[$rowNum]['civicrm_address_state_province_id_link'] = $url;
3361 $rows[$rowNum]['civicrm_address_state_province_id_hover'] = ts("%1 for this state.",
3372 * Adjusts dates passed in to YEAR() for fiscal year.
3374 function fiscalYearOffset($fieldName) {
3375 $config = CRM_Core_Config
::singleton();
3376 $fy = $config->fiscalYearStart
;
3377 if (CRM_Utils_Array
::value('yid_op', $this->_params
) == 'calendar' ||
($fy['d'] == 1 && $fy['M'] == 1)) {
3378 return "YEAR( $fieldName )";
3380 return "YEAR( $fieldName - INTERVAL " . ($fy['M'] - 1) . " MONTH" . ($fy['d'] > 1 ?
(" - INTERVAL " . ($fy['d'] - 1) . " DAY") : '') . " )";
3384 * Add Address into From Table if required
3386 function addAddressFromClause() {
3387 // include address field if address column is to be included
3388 if ((isset($this->_addressField
) &&
3389 $this->_addressField
3391 $this->isTableSelected('civicrm_address')
3394 LEFT JOIN civicrm_address {$this->_aliases['civicrm_address']}
3395 ON ({$this->_aliases['civicrm_contact']}.id =
3396 {$this->_aliases['civicrm_address']}.contact_id) AND
3397 {$this->_aliases['civicrm_address']}.is_primary = 1\n";
3402 * Add Phone into From Table if required
3404 function addPhoneFromClause() {
3405 // include address field if address column is to be included
3406 if ($this->isTableSelected('civicrm_phone')
3409 LEFT JOIN civicrm_phone {$this->_aliases['civicrm_phone']}
3410 ON ({$this->_aliases['civicrm_contact']}.id =
3411 {$this->_aliases['civicrm_phone']}.contact_id) AND
3412 {$this->_aliases['civicrm_phone']}.is_primary = 1\n";
3417 * Get phone columns to add to array
3418 * @param array $options
3419 * - prefix Prefix to add to table (in case of more than one instance of the table)
3420 * - prefix_label Label to give columns from this phone table instance
3421 * @return array phone columns definition
3423 function getPhoneColumns($options = array()){
3424 $defaultOptions = array(
3426 'prefix_label' => '',
3429 $options = array_merge($defaultOptions,$options);
3432 $options['prefix'] . 'civicrm_phone' => array(
3433 'dao' => 'CRM_Core_DAO_Phone',
3435 $options['prefix'] . 'phone' => array(
3436 'title' => ts($options['prefix_label'] . 'Phone'),
3446 * Get address columns to add to array
3447 * @param array $options
3448 * - prefix Prefix to add to table (in case of more than one instance of the table)
3449 * - prefix_label Label to give columns from this address table instance
3450 * @return array address columns definition
3452 function getAddressColumns($options = array()){
3453 $defaultOptions = array(
3455 'prefix_label' => '',
3459 'defaults' => array(
3462 $options = array_merge($defaultOptions,$options);
3463 return $this->addAddressFields(
3464 $options['group_by'],
3465 $options['order_by'],
3466 $options['filters'],
3467 $options['defaults']
3472 function add2group($groupID) {
3473 if (is_numeric($groupID) && isset($this->_aliases
['civicrm_contact'])) {
3474 $select = "SELECT DISTINCT {$this->_aliases['civicrm_contact']}.id AS addtogroup_contact_id, ";
3475 $select = str_ireplace('SELECT SQL_CALC_FOUND_ROWS ', $select, $this->_select
);
3477 $sql = "{$select} {$this->_from} {$this->_where} {$this->_groupBy} {$this->_having} {$this->_orderBy}";
3478 $dao = CRM_Core_DAO
::executeQuery($sql);
3480 $contact_ids = array();
3481 // Add resulting contacts to group
3482 while ($dao->fetch()) {
3483 if ($dao->addtogroup_contact_id
) {
3484 $contact_ids[$dao->addtogroup_contact_id
] = $dao->addtogroup_contact_id
;
3488 if ( !empty($contact_ids) ) {
3489 CRM_Contact_BAO_GroupContact
::addContactsToGroup($contact_ids, $groupID);
3490 CRM_Core_Session
::setStatus(ts("Listed contact(s) have been added to the selected group."), ts('Contacts Added'), 'success');
3493 CRM_Core_Session
::setStatus(ts("The listed records(s) cannot be added to the group."));
3498 /* function used for showing charts on print screen */
3499 static function uploadChartImage() {
3500 // upload strictly for '.png' images
3501 $name = trim(basename(CRM_Utils_Request
::retrieve('name', 'String', CRM_Core_DAO
::$_nullObject, FALSE, NULL, 'GET')));
3502 if (preg_match('/\.png$/', $name)) {
3504 // POST data is usually string data, but we are passing a RAW .png
3505 // so PHP is a bit confused and $_POST is empty. But it has saved
3506 // the raw bits into $HTTP_RAW_POST_DATA
3508 $httpRawPostData = $GLOBALS['HTTP_RAW_POST_DATA'];
3510 // prepare the directory
3511 $config = CRM_Core_Config
::singleton();
3512 $defaultPath = str_replace('/persist/contribute/' , '/persist/', $config->imageUploadDir
) . '/openFlashChart/';
3513 if (!file_exists($defaultPath)) {
3514 mkdir($defaultPath, 0777, TRUE);
3517 // full path to the saved image including filename
3518 $destination = $defaultPath . $name;
3521 $jfh = fopen($destination, 'w') or die("can't open file");
3522 fwrite($jfh, $httpRawPostData);
3524 CRM_Utils_System
::civiExit();