<?php
-// $Id$
-
/*
+--------------------------------------------------------------------+
| CiviCRM version 4.3 |
protected $_customGroupExtends = NULL;
protected $_customGroupFilters = TRUE;
protected $_customGroupGroupBy = FALSE;
+ protected $_customGroupJoin = 'LEFT JOIN';
/**
* build tags filter
protected $_autoIncludeIndexedFieldsAsOrderBys = 0;
protected $_absoluteUrl = FALSE;
+ /**
+ * Flag to indicate if result-set is to be stored in a class variable which could be retrieved using getResultSet() method.
+ *
+ * @var boolean
+ */
+ protected $_storeResultSet = FALSE;
+
+ /**
+ * When _storeResultSet Flag is set use this var to store result set in form of array
+ *
+ * @var boolean
+ */
+ protected $_resultSet = array();
+
/**
* To what frequency group-by a date column
*
public $_columnHeaders = array();
public $_orderBy = NULL;
public $_groupBy = NULL;
+ public $_whereClauses = array();
+ public $_havingClauses = array();
/**
* Variable to hold the currency alias
}
// Get all custom groups
- $allGroups = CRM_Core_PseudoConstant::customGroup();
+ $allGroups = CRM_Core_PseudoConstant::get('CRM_Core_DAO_CustomField', 'custom_group_id');
// Get the custom groupIds for which the user have VIEW permission
require_once 'CRM/ACL/API.php';
$this->assign('instanceId', $this->_id);
$params = array('id' => $this->_id);
$this->_instanceValues = array();
- CRM_Core_DAO::commonRetrieve('CRM_Report_DAO_Instance',
+ CRM_Core_DAO::commonRetrieve('CRM_Report_DAO_ReportInstance',
$params,
$this->_instanceValues
);
// higher preference to bao object
if (array_key_exists('bao', $table)) {
- require_once str_replace('_', DIRECTORY_SEPARATOR, $table['bao'] . '.php');
- eval("\$expFields = {$table['bao']}::exportableFields( );");
+ $baoName = $table['bao'];
+ $expFields = $baoName::exportableFields( );
}
- else {
- require_once str_replace('_', DIRECTORY_SEPARATOR, $table['dao'] . '.php');
- eval("\$expFields = {$table['dao']}::export( );");
+ elseif (array_key_exists('dao', $table)){
+ $daoName = $table['dao'];
+ $expFields = $daoName::export( );
+ }
+ else{
+ $expFields = array();
}
$doNotCopy = array('required');
foreach ($table['filters'] as $fieldName => $field) {
if (isset($field['default'])) {
if (CRM_Utils_Array::value('type', $field) & CRM_Utils_Type::T_DATE) {
- $this->_defaults["{$fieldName}_relative"] = $field['default'];
+ if(is_array($field['default'])){
+ $this->_defaults["{$fieldName}_from"] = CRM_Utils_Array::value('from', $field['default']);
+ $this->_defaults["{$fieldName}_to"] = CRM_Utils_Array::value('to', $field['default']);
+ $this->_defaults["{$fieldName}_relative"] = 0;
+ }
+ else{
+ $this->_defaults["{$fieldName}_relative"] = $field['default'];
+ }
}
else {
$this->_defaults["{$fieldName}_value"] = $field['default'];
foreach ($this->_columns as $tableName => $table) {
if (array_key_exists('fields', $table)) {
foreach ($table['fields'] as $fieldName => $field) {
+ $groupTitle = '';
if (!array_key_exists('no_display', $field)) {
- if (isset($field['grouping'])) {
- $tableName = $field['grouping'];
+ foreach ( array('table', 'field') as $var) {
+ if (!empty(${$var}['grouping'])) {
+ if (!is_array(${$var}['grouping'])) {
+ $tableName = ${$var}['grouping'];
+ } else {
+ $tableName = array_keys(${$var}['grouping']);
+ $tableName = $tableName[0];
+ $groupTitle = array_values(${$var}['grouping']);
+ $groupTitle = $groupTitle[0];
+ }
+ }
}
- elseif (isset($table['grouping'])) {
- $tableName = $table['grouping'];
+
+ if (!$groupTitle && isset($table['group_title'])) {
+ $groupTitle = $table['group_title'];
}
- $colGroups[$tableName]['fields'][$fieldName] = CRM_Utils_Array::value('title', $field);
- if (isset($table['group_title'])) {
- $colGroups[$tableName]['group_title'] = $table['group_title'];
+ $colGroups[$tableName]['fields'][$fieldName] = CRM_Utils_Array::value('title', $field);
+ if ($groupTitle && !CRM_Utils_Array::value('group_title', $colGroups[$tableName])) {
+ $colGroups[$tableName]['group_title'] = $groupTitle;
}
$options[$fieldName] = CRM_Utils_Array::value('title', $field);
case CRM_Report_FORM::OP_SELECT:
// assume a select field
$this->addElement('select', "{$fieldName}_op", ts('Operator:'), $operations);
- $this->addElement('select', "{$fieldName}_value", NULL, $field['options']);
+ if (!empty($field['options']))
+ $this->addElement('select', "{$fieldName}_value", NULL, $field['options']);
break;
case CRM_Report_FORM::OP_DATE:
// build datetime fields
- CRM_Core_Form_Date::buildDateRange($this, $fieldName, $count);
+ CRM_Core_Form_Date::buildDateRange($this, $fieldName, $count, '_from','_to', 'From:', FALSE, $operations);
$count++;
break;
case CRM_Report_FORM::OP_DATETIME:
// build datetime fields
- CRM_Core_Form_Date::buildDateRange($this, $fieldName, $count, '_from', '_to', 'From:', FALSE, TRUE, 'searchDate', true);
+ CRM_Core_Form_Date::buildDateRange($this, $fieldName, $count, '_from', '_to', 'From:', FALSE, $operations, 'searchDate', true);
$count++;
break;
function getOperationPair($type = "string", $fieldName = NULL) {
// FIXME: At some point we should move these key-val pairs
// to option_group and option_value table.
-
switch ($type) {
case CRM_Report_FORM::OP_INT:
case CRM_Report_FORM::OP_FLOAT:
- return array('lte' => ts('Is less than or equal to'),
+ return array(
+ 'lte' => ts('Is less than or equal to'),
'gte' => ts('Is greater than or equal to'),
'bw' => ts('Is between'),
'eq' => ts('Is equal to'),
break;
case CRM_Report_FORM::OP_SELECT:
- return array('eq' => ts('Is equal to'));
+ return array(
+ 'eq' => ts('Is equal to'),
+ );
case CRM_Report_FORM::OP_MONTH:
case CRM_Report_FORM::OP_MULTISELECT:
- return array('in' => ts('Is one of'),
+ return array(
+ 'in' => ts('Is one of'),
'notin' => ts('Is not one of'),
);
break;
case CRM_Report_FORM::OP_DATE:
- return array('nll' => ts('Is empty (Null)'),
+ return array(
+ 'nll' => ts('Is empty (Null)'),
'nnll' => ts('Is not empty (Null)'),
);
break;
case CRM_Report_FORM::OP_MULTISELECT_SEPARATOR:
// use this operator for the values, concatenated with separator. For e.g if
// multiple options for a column is stored as ^A{val1}^A{val2}^A
- return array('mhas' => ts('Is one of'));
+ return array(
+ 'mhas' => ts('Is one of'),
+ );
default:
// type is string
- return array('has' => ts('Contains'),
+ return array(
+ 'has' => ts('Contains'),
'sw' => ts('Starts with'),
'ew' => ts('Ends with'),
'nhas' => ts('Does not contain'),
if (isset($field['clause'])) {
// FIXME: we not doing escape here. Better solution is to use two
// different types - data-type and filter-type
- eval("\$clause = \"{$field['clause']}\";");
+ $clause = $field['clause'];
}
else {
$value = CRM_Utils_Type::escape($value, $type);
}
$lastRow = array_pop($rows);
- $this->_grandFlag = FALSE;
foreach ($this->_columnHeaders as $fld => $val) {
if (!in_array($fld, $this->_statFields)) {
if (!$this->_grandFlag) {
$select[] = "$stat({$field['dbAlias']}) as $alias";
$this->_columnHeaders["{$tableName}_{$fieldName}_{$stat}"]['title'] = $label;
$this->_columnHeaders["{$tableName}_{$fieldName}_{$stat}"]['type'] = $field['type'];
- $this->_statFields[] = $alias;
+ $this->_statFields[$label] = $alias;
$this->_selectAliases[] = $alias;
break;
$select[] = "COUNT({$field['dbAlias']}) as $alias";
$this->_columnHeaders["{$tableName}_{$fieldName}_{$stat}"]['title'] = $label;
$this->_columnHeaders["{$tableName}_{$fieldName}_{$stat}"]['type'] = CRM_Utils_Type::T_INT;
- $this->_statFields[] = $alias;
+ $this->_statFields[$label] = $alias;
+ $this->_selectAliases[] = $alias;
+ break;
+
+ case 'count_distinct':
+ $select[] = "COUNT(DISTINCT {$field['dbAlias']}) as $alias";
+ $this->_columnHeaders["{$tableName}_{$fieldName}_{$stat}"]['title'] = $label;
+ $this->_columnHeaders["{$tableName}_{$fieldName}_{$stat}"]['type'] = CRM_Utils_Type::T_INT;
+ $this->_statFields[$label] = $alias;
$this->_selectAliases[] = $alias;
break;
$select[] = "ROUND(AVG({$field['dbAlias']}),2) as $alias";
$this->_columnHeaders["{$tableName}_{$fieldName}_{$stat}"]['title'] = $label;
$this->_columnHeaders["{$tableName}_{$fieldName}_{$stat}"]['type'] = $field['type'];
- $this->_statFields[] = $alias;
+ $this->_statFields[$label] = $alias;
$this->_selectAliases[] = $alias;
break;
}
}
function where() {
- $whereClauses = $havingClauses = array();
+ $this->storeWhereHavingClauseArray();
+
+ if (empty($this->_whereClauses)) {
+ $this->_where = "WHERE ( 1 ) ";
+ $this->_having = "";
+ }
+ else {
+ $this->_where = "WHERE " . implode(' AND ', $this->_whereClauses);
+ }
+
+ if ($this->_aclWhere) {
+ $this->_where .= " AND {$this->_aclWhere} ";
+ }
+
+ if (!empty($this->_havingClauses)) {
+ // use this clause to construct group by clause.
+ $this->_having = "HAVING " . implode(' AND ', $this->_havingClauses);
+ }
+ }
+
+ /**
+ * Store Where clauses into an array - breaking out this step makes
+ * over-riding more flexible as the clauses can be used in constructing a
+ * temp table that may not be part of the final where clause or added
+ * in other functions
+ */
+ function storeWhereHavingClauseArray(){
foreach ($this->_columns as $tableName => $table) {
if (array_key_exists('filters', $table)) {
foreach ($table['filters'] as $fieldName => $field) {
+ // respect pseudofield to filter spec so fields can be marked as
+ // not to be handled here
+ if(!empty($field['pseudofield'])){
+ continue;
+ }
$clause = NULL;
if (CRM_Utils_Array::value('type', $field) & CRM_Utils_Type::T_DATE) {
if (CRM_Utils_Array::value('operatorType', $field) == CRM_Report_Form::OP_MONTH) {
$op = CRM_Utils_Array::value("{$fieldName}_op", $this->_params);
if ($op) {
$clause = $this->whereClause($field,
- $op,
- CRM_Utils_Array::value("{$fieldName}_value", $this->_params),
- CRM_Utils_Array::value("{$fieldName}_min", $this->_params),
- CRM_Utils_Array::value("{$fieldName}_max", $this->_params)
+ $op,
+ CRM_Utils_Array::value("{$fieldName}_value", $this->_params),
+ CRM_Utils_Array::value("{$fieldName}_min", $this->_params),
+ CRM_Utils_Array::value("{$fieldName}_max", $this->_params)
);
}
}
if (!empty($clause)) {
if (CRM_Utils_Array::value('having', $field)) {
- $havingClauses[] = $clause;
+ $this->_havingClauses[] = $clause;
}
else {
- $whereClauses[] = $clause;
+ $this->_whereClauses[] = $clause;
}
}
}
}
}
- if (empty($whereClauses)) {
- $this->_where = "WHERE ( 1 ) ";
- $this->_having = "";
- }
- else {
- $this->_where = "WHERE " . implode(' AND ', $whereClauses);
- }
-
- if ($this->_aclWhere) {
- $this->_where .= " AND {$this->_aclWhere} ";
- }
-
- if (!empty($havingClauses)) {
- // use this clause to construct group by clause.
- $this->_having = "HAVING " . implode(' AND ', $havingClauses);
- }
}
-
function processReportMode() {
$buttonName = $this->controller->getButtonName();
}
function endPostProcess(&$rows = NULL) {
+ if ( $this->_storeResultSet ) {
+ $this->_resultSet = $rows;
+ }
+
if ($this->_outputMode == 'print' ||
$this->_outputMode == 'pdf' ||
$this->_sendmail
}
}
+ function storeResultSet() {
+ $this->_storeResultSet = TRUE;
+ }
+
+ function getResultSet() {
+ return $this->_resultSet;
+ }
+
/*
* Get Template file name - use default form template if a specific one has not been set up for this report
*
}
if (!array_key_exists('type', $curFields[$fieldName])) {
- $curFields[$fieldName]['type'] = $curFilters[$fieldName]['type'];
+ $curFields[$fieldName]['type'] = CRM_Utils_Array::value('type', $curFilters[$fieldName], array());
}
if ($addFields) {
continue;
}
+ $customJoin = is_array($this->_customGroupJoin) ? $this->_customGroupJoin[$table] : $this->_customGroupJoin;
$this->_from .= "
-LEFT JOIN $table {$this->_aliases[$table]} ON {$this->_aliases[$table]}.entity_id = {$this->_aliases[$extendsTable]}.id";
+{$customJoin} {$table} {$this->_aliases[$table]} ON {$this->_aliases[$table]}.entity_id = {$this->_aliases[$extendsTable]}.id";
// handle for ContactReference
if (array_key_exists('fields', $prop)) {
foreach ($prop['fields'] as $fieldName => $field) {
foreach (array(
'value', 'min', 'max', 'relative', 'from', 'to') as $attach) {
if (isset($this->_params[$fieldAlias . '_' . $attach]) &&
- (!empty($this->_params[$fieldAlias . '_' . $attach]) || $this->_params[$fieldAlias . '_' . $attach] == '0')
- ) {
+ (!empty($this->_params[$fieldAlias . '_' . $attach])
+ || ($attach != 'relative' && $this->_params[$fieldAlias . '_' . $attach] == '0')
+ )
+ ){
return TRUE;
}
}
*/
function preProcessOrderBy(&$formValues) {
// Object to show/hide form elements
- $_showHide = &new CRM_Core_ShowHideBlocks('', '');
+ $_showHide = new CRM_Core_ShowHideBlocks('', '');
$_showHide->addShow('optionField_1');
function selectedTables() {
if (!$this->_selectedTables) {
$orderByColumns = array();
- if (is_array($this->_params['order_bys'])) {
+ if (array_key_exists('order_bys', $this->_params) && is_array($this->_params['order_bys'])) {
foreach ($this->_params['order_bys'] as $orderBy) {
$orderByColumns[] = $orderBy['column'];
}
return $this->_selectedTables;
}
- /*
+ /**
+ * @deprecated - use getAddressColumns which is a more accurate description
+ * and also accepts an array of options rather than a long list
+ *
* function for adding address fields to construct function in reports
* @param bool $groupBy Add GroupBy? Not appropriate for detail report
* @param bool $orderBy Add GroupBy? Not appropriate for detail report
}
}
+ /**
+ * Add Phone into From Table if required
+ */
+ function addPhoneFromClause() {
+ // include address field if address column is to be included
+ if ($this->isTableSelected('civicrm_phone')
+ ) {
+ $this->_from .= "
+ LEFT JOIN civicrm_phone {$this->_aliases['civicrm_phone']}
+ ON ({$this->_aliases['civicrm_contact']}.id =
+ {$this->_aliases['civicrm_phone']}.contact_id) AND
+ {$this->_aliases['civicrm_phone']}.is_primary = 1\n";
+ }
+ }
+
+ /**
+ * Get phone columns to add to array
+ * @param array $options
+ * - prefix Prefix to add to table (in case of more than one instance of the table)
+ * - prefix_label Label to give columns from this phone table instance
+ * @return array phone columns definition
+ */
+ function getPhoneColumns($options = array()){
+ $defaultOptions = array(
+ 'prefix' => '',
+ 'prefix_label' => '',
+ );
+
+ $options = array_merge($defaultOptions,$options);
+
+ $fields = array(
+ $options['prefix'] . 'civicrm_phone' => array(
+ 'dao' => 'CRM_Core_DAO_Phone',
+ 'fields' => array(
+ $options['prefix'] . 'phone' => array(
+ 'title' => ts($options['prefix_label'] . 'Phone'),
+ 'name' => 'phone'
+ ),
+ ),
+ ),
+ );
+ return $fields;
+ }
+
+ /**
+ * Get address columns to add to array
+ * @param array $options
+ * - prefix Prefix to add to table (in case of more than one instance of the table)
+ * - prefix_label Label to give columns from this address table instance
+ * @return array address columns definition
+ */
+ function getAddressColumns($options = array()){
+ $defaultOptions = array(
+ 'prefix' => '',
+ 'prefix_label' => '',
+ 'group_by' => TRUE,
+ 'order_by' => TRUE,
+ 'filters' => TRUE,
+ 'defaults' => array(
+ ),
+ );
+ $options = array_merge($defaultOptions,$options);
+ return $this->addAddressFields(
+ $options['group_by'],
+ $options['order_by'],
+ $options['filters'],
+ $options['defaults']
+ );
+
+ }
+
function add2group($groupID) {
if (is_numeric($groupID) && isset($this->_aliases['civicrm_contact'])) {
$select = "SELECT DISTINCT {$this->_aliases['civicrm_contact']}.id AS addtogroup_contact_id, ";
projects / civicrm-core.git / blobdiff