Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
6a488035 | 2 | /* |
36241b02 | 3 | +--------------------------------------------------------------------+ |
39de6fd5 | 4 | | CiviCRM version 4.6 | |
db4cd986 | 5 | +--------------------------------------------------------------------+ |
e7112fa7 | 6 | | Copyright CiviCRM LLC (c) 2004-2015 | |
db4cd986 | 7 | +--------------------------------------------------------------------+ |
6a488035 TO |
8 | | This file is a part of CiviCRM. | |
9 | | | | |
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. | | |
13 | | | | |
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. | | |
18 | | | | |
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 | | |
36241b02 | 25 | +--------------------------------------------------------------------+ |
e70a7fc0 | 26 | */ |
6a488035 TO |
27 | |
28 | /** | |
7d7c50f9 | 29 | * Class CRM_Report_Form |
6a488035 TO |
30 | */ |
31 | class CRM_Report_Form extends CRM_Core_Form { | |
7da04cde | 32 | const ROW_COUNT_LIMIT = 50; |
6a488035 TO |
33 | |
34 | /** | |
35 | * Operator types - used for displaying filter elements | |
36 | */ | |
7da04cde | 37 | const |
9d72cede | 38 | OP_INT = 1, |
6a488035 | 39 | OP_STRING = 2, |
9d72cede | 40 | OP_DATE = 4, |
6a488035 | 41 | OP_DATETIME = 5, |
9d72cede | 42 | OP_FLOAT = 8, |
6a488035 TO |
43 | OP_SELECT = 64, |
44 | OP_MULTISELECT = 65, | |
45 | OP_MULTISELECT_SEPARATOR = 66, | |
2107cde9 CW |
46 | OP_MONTH = 128, |
47 | OP_ENTITYREF = 256; | |
6a488035 TO |
48 | |
49 | /** | |
50 | * The id of the report instance | |
51 | * | |
52 | * @var integer | |
53 | */ | |
54 | protected $_id; | |
55 | ||
56 | /** | |
57 | * The id of the report template | |
58 | * | |
59 | * @var integer; | |
60 | */ | |
61 | protected $_templateID; | |
62 | ||
63 | /** | |
64 | * The report title | |
65 | * | |
66 | * @var string | |
67 | */ | |
68 | protected $_title; | |
69 | protected $_noFields = FALSE; | |
70 | ||
71 | /** | |
72 | * The set of all columns in the report. An associative array | |
537c70b8 | 73 | * with column name as the key and attributes as the value |
6a488035 TO |
74 | * |
75 | * @var array | |
76 | */ | |
77 | protected $_columns = array(); | |
78 | ||
79 | /** | |
80 | * The set of filters in the report | |
81 | * | |
82 | * @var array | |
83 | */ | |
84 | protected $_filters = array(); | |
85 | ||
86 | /** | |
87 | * The set of optional columns in the report | |
88 | * | |
89 | * @var array | |
90 | */ | |
91 | protected $_options = array(); | |
92 | ||
93 | protected $_defaults = array(); | |
94 | ||
688d37c6 | 95 | /** |
6a488035 TO |
96 | * By default most reports hide contact id. |
97 | * Setting this to true makes it available | |
98 | */ | |
99 | protected $_exposeContactID = TRUE; | |
100 | ||
101 | /** | |
102 | * Set of statistic fields | |
103 | * | |
104 | * @var array | |
105 | */ | |
106 | protected $_statFields = array(); | |
107 | ||
108 | /** | |
109 | * Set of statistics data | |
110 | * | |
111 | * @var array | |
112 | */ | |
113 | protected $_statistics = array(); | |
114 | ||
115 | /** | |
116 | * List of fields not to be repeated during display | |
117 | * | |
118 | * @var array | |
119 | */ | |
120 | protected $_noRepeats = array(); | |
121 | ||
122 | /** | |
123 | * List of fields not to be displayed | |
124 | * | |
125 | * @var array | |
126 | */ | |
127 | protected $_noDisplay = array(); | |
128 | ||
129 | /** | |
130 | * Object type that a custom group extends | |
131 | * | |
132 | * @var null | |
133 | */ | |
134 | protected $_customGroupExtends = NULL; | |
aa1aa08e | 135 | protected $_customGroupExtendsJoin = array(); |
6a488035 TO |
136 | protected $_customGroupFilters = TRUE; |
137 | protected $_customGroupGroupBy = FALSE; | |
9d72cede | 138 | protected $_customGroupJoin = 'LEFT JOIN'; |
6a488035 TO |
139 | |
140 | /** | |
100fef9d | 141 | * Build tags filter |
6a488035 TO |
142 | */ |
143 | protected $_tagFilter = FALSE; | |
144 | ||
145 | /** | |
ed795723 | 146 | * specify entity table for tags filter |
ed795723 JM |
147 | */ |
148 | protected $_tagFilterTable = 'civicrm_contact'; | |
149 | ||
6a488035 | 150 | /** |
0b62c1ab | 151 | * Build groups filter. |
6a488035 | 152 | * |
f587aa17 | 153 | * @var bool |
6a488035 TO |
154 | */ |
155 | protected $_groupFilter = FALSE; | |
156 | ||
157 | /** | |
158 | * Navigation fields | |
159 | * | |
160 | * @var array | |
161 | */ | |
162 | public $_navigation = array(); | |
163 | ||
164 | public $_drilldownReport = array(); | |
165 | ||
50951061 | 166 | /** |
0b62c1ab EM |
167 | * Array of tabs to display on report. |
168 | * | |
169 | * E.g we define the tab title, the tpl and the tab-specific part of the css or html link. | |
170 | * | |
171 | * $this->tabs['OrderBy'] = array( | |
172 | * 'title' => ts('Sorting'), | |
173 | * 'tpl' => 'OrderBy', | |
174 | * 'div_label' => 'order-by', | |
175 | * ); | |
50951061 EM |
176 | * |
177 | * @var array | |
178 | */ | |
179 | protected $tabs = array(); | |
180 | ||
6a488035 TO |
181 | /** |
182 | * An attribute for checkbox/radio form field layout | |
183 | * | |
184 | * @var array | |
185 | */ | |
186 | protected $_fourColumnAttribute = array( | |
9d72cede EM |
187 | '</td><td width="25%">', |
188 | '</td><td width="25%">', | |
189 | '</td><td width="25%">', | |
190 | '</tr><tr><td>', | |
6a488035 TO |
191 | ); |
192 | ||
193 | protected $_force = 1; | |
194 | ||
195 | protected $_params = NULL; | |
196 | protected $_formValues = NULL; | |
197 | protected $_instanceValues = NULL; | |
198 | ||
199 | protected $_instanceForm = FALSE; | |
200 | protected $_criteriaForm = FALSE; | |
201 | ||
202 | protected $_instanceButtonName = NULL; | |
203 | protected $_createNewButtonName = NULL; | |
204 | protected $_printButtonName = NULL; | |
205 | protected $_pdfButtonName = NULL; | |
206 | protected $_csvButtonName = NULL; | |
207 | protected $_groupButtonName = NULL; | |
208 | protected $_chartButtonName = NULL; | |
209 | protected $_csvSupported = TRUE; | |
210 | protected $_add2groupSupported = TRUE; | |
211 | protected $_groups = NULL; | |
9b0380d9 | 212 | protected $_grandFlag = FALSE; |
6a488035 TO |
213 | protected $_rowsFound = NULL; |
214 | protected $_selectAliases = array(); | |
215 | protected $_rollup = NULL; | |
6f900755 | 216 | |
f587aa17 EM |
217 | /** |
218 | * @var array | |
219 | */ | |
220 | protected $_aliases = array(); | |
221 | ||
222 | /** | |
223 | * @var string | |
224 | */ | |
225 | protected $_where; | |
226 | ||
227 | /** | |
228 | * @var string | |
229 | */ | |
230 | protected $_from; | |
231 | ||
6f900755 E |
232 | /** |
233 | * SQL Limit clause | |
234 | * @var string | |
235 | */ | |
6a488035 | 236 | protected $_limit = NULL; |
6f900755 E |
237 | |
238 | /** | |
239 | * This can be set to specify a limit to the number of rows | |
240 | * Since it is currently envisaged as part of the api usage it is only being applied | |
241 | * when $_output mode is not 'html' or 'group' so as not to have to interpret / mess with that part | |
242 | * of the code (see limit() fn | |
243 | * @var integer | |
244 | */ | |
245 | protected $_limitValue = NULL; | |
246 | ||
247 | /** | |
248 | * This can be set to specify row offset | |
249 | * See notes on _limitValue | |
250 | * @var integer | |
251 | */ | |
252 | protected $_offsetValue = NULL; | |
cdb44cba EM |
253 | /** |
254 | * @var null | |
255 | */ | |
44d59d04 | 256 | protected $_sections = NULL; |
6a488035 TO |
257 | protected $_autoIncludeIndexedFieldsAsOrderBys = 0; |
258 | protected $_absoluteUrl = FALSE; | |
259 | ||
ae555e90 DS |
260 | /** |
261 | * Flag to indicate if result-set is to be stored in a class variable which could be retrieved using getResultSet() method. | |
262 | * | |
263 | * @var boolean | |
264 | */ | |
265 | protected $_storeResultSet = FALSE; | |
266 | ||
267 | /** | |
268 | * When _storeResultSet Flag is set use this var to store result set in form of array | |
269 | * | |
270 | * @var boolean | |
271 | */ | |
272 | protected $_resultSet = array(); | |
273 | ||
6a488035 TO |
274 | /** |
275 | * To what frequency group-by a date column | |
276 | * | |
277 | * @var array | |
278 | */ | |
279 | protected $_groupByDateFreq = array( | |
280 | 'MONTH' => 'Month', | |
281 | 'YEARWEEK' => 'Week', | |
282 | 'QUARTER' => 'Quarter', | |
283 | 'YEAR' => 'Year', | |
284 | ); | |
285 | ||
286 | /** | |
287 | * Variables to hold the acl inner join and where clause | |
288 | */ | |
289 | protected $_aclFrom = NULL; | |
290 | protected $_aclWhere = NULL; | |
291 | ||
292 | /** | |
293 | * Array of DAO tables having columns included in SELECT or ORDER BY clause | |
294 | * | |
295 | * @var array | |
296 | */ | |
297 | protected $_selectedTables; | |
298 | ||
c58f66e0 | 299 | /** |
537c70b8 | 300 | * Output mode e.g 'print', 'csv', 'pdf' |
c58f66e0 E |
301 | * @var string |
302 | */ | |
f63fae91 | 303 | protected $_outputMode; |
c58f66e0 | 304 | |
6a488035 TO |
305 | public $_having = NULL; |
306 | public $_select = NULL; | |
1f220d30 | 307 | public $_selectClauses = array(); |
6a488035 TO |
308 | public $_columnHeaders = array(); |
309 | public $_orderBy = NULL; | |
f2947aea | 310 | public $_orderByFields = array(); |
9d72cede | 311 | public $_orderByArray = array(); |
6a488035 | 312 | public $_groupBy = NULL; |
adfe2750 | 313 | public $_whereClauses = array(); |
314 | public $_havingClauses = array(); | |
1c4d8c3e | 315 | |
dbb4a0f9 | 316 | /** |
100fef9d | 317 | * DashBoardRowCount Dashboard row count |
dbb4a0f9 PN |
318 | * @var Integer |
319 | */ | |
320 | public $_dashBoardRowCount; | |
321 | ||
c58f66e0 E |
322 | /** |
323 | * Is this being called without a form controller (ie. the report is being render outside the normal form | |
324 | * - e.g the api is retrieving the rows | |
325 | * @var boolean | |
326 | */ | |
327 | public $noController = FALSE; | |
328 | ||
7a961f19 | 329 | /** |
330 | * Variable to hold the currency alias | |
331 | */ | |
332 | protected $_currencyColumn = NULL; | |
6a488035 | 333 | |
2fe3c48d EM |
334 | /** |
335 | * @var string | |
336 | */ | |
337 | protected $_interval; | |
338 | ||
339 | /** | |
340 | * @var bool | |
341 | */ | |
342 | protected $_sendmail; | |
343 | ||
344 | /** | |
345 | * @var int | |
346 | */ | |
347 | protected $_chartId; | |
348 | ||
9907633b EM |
349 | /** |
350 | * @var int | |
351 | */ | |
44d59d04 | 352 | public $_section; |
9907633b EM |
353 | |
354 | /** | |
355 | * @var string Report description. | |
356 | */ | |
15ba35a3 | 357 | public $_description; |
9907633b EM |
358 | |
359 | /** | |
360 | * @var bool Is an address field selected. | |
361 | * This was intended to determine if the address table should be joined in | |
362 | * The isTableSelected function is now preferred for this purpose | |
363 | */ | |
364 | protected $_addressField; | |
365 | ||
366 | /** | |
367 | * @var bool Is an email field selected. | |
368 | * This was intended to determine if the email table should be joined in | |
369 | * The isTableSelected function is now preferred for this purpose | |
370 | */ | |
371 | protected $_emailField; | |
372 | ||
373 | /** | |
374 | * @var bool Is a phone field selected. | |
375 | * This was intended to determine if the phone table should be joined in | |
376 | * The isTableSelected function is now preferred for this purpose | |
377 | */ | |
378 | protected $_phoneField; | |
379 | ||
380 | /** | |
381 | * @var bool Create new report instance? (or update existing) on save. | |
382 | */ | |
383 | protected $_createNew; | |
384 | ||
6a488035 | 385 | /** |
7d7c50f9 | 386 | * Class constructor. |
6a488035 | 387 | */ |
00be9182 | 388 | public function __construct() { |
6a488035 TO |
389 | parent::__construct(); |
390 | ||
22b67281 CW |
391 | $this->addClass('crm-report-form'); |
392 | ||
6a488035 TO |
393 | if ($this->_tagFilter) { |
394 | $this->buildTagFilter(); | |
395 | } | |
396 | if ($this->_exposeContactID) { | |
397 | if (array_key_exists('civicrm_contact', $this->_columns)) { | |
398 | $this->_columns['civicrm_contact']['fields']['exposed_id'] = array( | |
399 | 'name' => 'id', | |
400 | 'title' => 'Contact ID', | |
401 | 'no_repeat' => TRUE, | |
402 | ); | |
403 | } | |
404 | } | |
405 | ||
406 | if ($this->_groupFilter) { | |
407 | $this->buildGroupFilter(); | |
408 | } | |
409 | ||
410 | // Get all custom groups | |
cd43c5e3 | 411 | $allGroups = CRM_Core_PseudoConstant::get('CRM_Core_DAO_CustomField', 'custom_group_id'); |
6a488035 | 412 | |
4f8ec8be DS |
413 | // Get the custom groupIds for which the user has VIEW permission |
414 | // If the user has 'access all custom data' permission, we'll leave $permCustomGroupIds empty | |
415 | // and addCustomDataToColumns() will allow access to all custom groups. | |
416 | $permCustomGroupIds = array(); | |
417 | if (!CRM_Core_Permission::check('access all custom data')) { | |
418 | $permCustomGroupIds = CRM_ACL_API::group(CRM_Core_Permission::VIEW, NULL, 'civicrm_custom_group', $allGroups, NULL); | |
419 | // do not allow custom data for reports if user doesn't have | |
420 | // permission to access custom data. | |
421 | if (!empty($this->_customGroupExtends) && empty($permCustomGroupIds)) { | |
422 | $this->_customGroupExtends = array(); | |
423 | } | |
6a488035 TO |
424 | } |
425 | ||
426 | // merge custom data columns to _columns list, if any | |
427 | $this->addCustomDataToColumns(TRUE, $permCustomGroupIds); | |
428 | ||
429 | // add / modify display columns, filters ..etc | |
430 | CRM_Utils_Hook::alterReportVar('columns', $this->_columns, $this); | |
7a961f19 | 431 | |
432 | //assign currencyColumn variable to tpl | |
433 | $this->assign('currencyColumn', $this->_currencyColumn); | |
6a488035 TO |
434 | } |
435 | ||
0b62c1ab EM |
436 | /** |
437 | * Shared pre-process function. | |
438 | * | |
439 | * If overriding preProcess function this should still be called. | |
440 | * | |
441 | * @throws \Exception | |
442 | */ | |
00be9182 | 443 | public function preProcessCommon() { |
971d41b1 CW |
444 | $this->_force |
445 | = CRM_Utils_Request::retrieve( | |
446 | 'force', | |
447 | 'Boolean', | |
448 | CRM_Core_DAO::$_nullObject | |
e70a7fc0 | 449 | ); |
77b97be7 | 450 | |
971d41b1 CW |
451 | $this->_dashBoardRowCount |
452 | = CRM_Utils_Request::retrieve( | |
453 | 'rowCount', | |
454 | 'Integer', | |
455 | CRM_Core_DAO::$_nullObject | |
e70a7fc0 | 456 | ); |
6a488035 TO |
457 | |
458 | $this->_section = CRM_Utils_Request::retrieve('section', 'Integer', CRM_Core_DAO::$_nullObject); | |
459 | ||
460 | $this->assign('section', $this->_section); | |
461 | CRM_Core_Region::instance('page-header')->add(array( | |
462 | 'markup' => sprintf('<!-- Report class: [%s] -->', htmlentities(get_class($this))), | |
463 | )); | |
9d72cede | 464 | if (!$this->noController) { |
c58f66e0 | 465 | $this->setID($this->get('instanceId')); |
6a488035 | 466 | |
6a488035 | 467 | if (!$this->_id) { |
c58f66e0 E |
468 | $this->setID(CRM_Report_Utils_Report::getInstanceID()); |
469 | if (!$this->_id) { | |
9d72cede | 470 | $this->setID(CRM_Report_Utils_Report::getInstanceIDForPath()); |
c58f66e0 | 471 | } |
6a488035 | 472 | } |
6a488035 | 473 | |
c58f66e0 E |
474 | // set qfkey so that pager picks it up and use it in the "Next > Last >>" links. |
475 | // FIXME: Note setting it in $_GET doesn't work, since pager generates link based on QUERY_STRING | |
476 | $_SERVER['QUERY_STRING'] .= "&qfKey={$this->controller->_key}"; | |
477 | } | |
6a488035 TO |
478 | |
479 | if ($this->_id) { | |
480 | $this->assign('instanceId', $this->_id); | |
481 | $params = array('id' => $this->_id); | |
482 | $this->_instanceValues = array(); | |
0b25329b | 483 | CRM_Core_DAO::commonRetrieve('CRM_Report_DAO_ReportInstance', |
6a488035 TO |
484 | $params, |
485 | $this->_instanceValues | |
486 | ); | |
487 | if (empty($this->_instanceValues)) { | |
488 | CRM_Core_Error::fatal("Report could not be loaded."); | |
489 | } | |
7cab1323 | 490 | $this->_title = $this->_instanceValues['title']; |
6a488035 TO |
491 | if (!empty($this->_instanceValues['permission']) && |
492 | (!(CRM_Core_Permission::check($this->_instanceValues['permission']) || | |
493 | CRM_Core_Permission::check('administer Reports') | |
494 | )) | |
495 | ) { | |
496 | CRM_Utils_System::permissionDenied(); | |
497 | CRM_Utils_System::civiExit(); | |
498 | } | |
499 | ||
500 | $formValues = CRM_Utils_Array::value('form_values', $this->_instanceValues); | |
501 | if ($formValues) { | |
502 | $this->_formValues = unserialize($formValues); | |
503 | } | |
504 | else { | |
505 | $this->_formValues = NULL; | |
506 | } | |
507 | ||
508 | // lets always do a force if reset is found in the url. | |
a7488080 | 509 | if (!empty($_REQUEST['reset'])) { |
6a488035 TO |
510 | $this->_force = 1; |
511 | } | |
512 | ||
513 | // set the mode | |
514 | $this->assign('mode', 'instance'); | |
515 | } | |
c58f66e0 | 516 | elseif (!$this->noController) { |
6a488035 TO |
517 | list($optionValueID, $optionValue) = CRM_Report_Utils_Report::getValueIDFromUrl(); |
518 | $instanceCount = CRM_Report_Utils_Report::getInstanceCount($optionValue); | |
519 | if (($instanceCount > 0) && $optionValueID) { | |
520 | $this->assign('instanceUrl', | |
521 | CRM_Utils_System::url('civicrm/report/list', | |
522 | "reset=1&ovid=$optionValueID" | |
523 | ) | |
524 | ); | |
525 | } | |
526 | if ($optionValueID) { | |
527 | $this->_description = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionValue', $optionValueID, 'description'); | |
528 | } | |
529 | ||
530 | // set the mode | |
531 | $this->assign('mode', 'template'); | |
532 | } | |
533 | ||
534 | // lets display the Report Settings section | |
535 | $this->_instanceForm = $this->_force || $this->_id || (!empty($_POST)); | |
536 | ||
537 | // Do not display Report Settings section if administer Reports permission is absent OR | |
538 | // if report instance is reserved and administer reserved reports absent | |
539 | if (!CRM_Core_Permission::check('administer Reports') || | |
9d72cede EM |
540 | ($this->_instanceValues['is_reserved'] && |
541 | !CRM_Core_Permission::check('administer reserved reports')) | |
542 | ) { | |
6a488035 TO |
543 | $this->_instanceForm = FALSE; |
544 | } | |
545 | ||
546 | $this->assign('criteriaForm', FALSE); | |
547 | // Display Report Criteria section if user has access Report Criteria OR administer Reports AND report instance is not reserved | |
9d72cede EM |
548 | if (CRM_Core_Permission::check('administer Reports') || |
549 | CRM_Core_Permission::check('access Report Criteria') | |
550 | ) { | |
551 | if (!$this->_instanceValues['is_reserved'] || | |
552 | CRM_Core_Permission::check('administer reserved reports') | |
553 | ) { | |
6a488035 TO |
554 | $this->assign('criteriaForm', TRUE); |
555 | $this->_criteriaForm = TRUE; | |
556 | } | |
557 | } | |
558 | ||
559 | $this->_instanceButtonName = $this->getButtonName('submit', 'save'); | |
560 | $this->_createNewButtonName = $this->getButtonName('submit', 'next'); | |
561 | $this->_printButtonName = $this->getButtonName('submit', 'print'); | |
562 | $this->_pdfButtonName = $this->getButtonName('submit', 'pdf'); | |
563 | $this->_csvButtonName = $this->getButtonName('submit', 'csv'); | |
564 | $this->_groupButtonName = $this->getButtonName('submit', 'group'); | |
565 | $this->_chartButtonName = $this->getButtonName('submit', 'chart'); | |
566 | } | |
567 | ||
0b62c1ab EM |
568 | /** |
569 | * Add bread crumb. | |
570 | */ | |
00be9182 | 571 | public function addBreadCrumb() { |
971d41b1 CW |
572 | $breadCrumbs |
573 | = array( | |
8f1445ea DL |
574 | array( |
575 | 'title' => ts('Report Templates'), | |
576 | 'url' => CRM_Utils_System::url('civicrm/admin/report/template/list', 'reset=1'), | |
21dfd5f5 | 577 | ), |
8f1445ea | 578 | ); |
6a488035 TO |
579 | |
580 | CRM_Utils_System::appendBreadCrumb($breadCrumbs); | |
581 | } | |
582 | ||
0b62c1ab EM |
583 | /** |
584 | * Pre process function. | |
585 | * | |
586 | * Called prior to build form. | |
587 | */ | |
00be9182 | 588 | public function preProcess() { |
8f1445ea | 589 | $this->preProcessCommon(); |
6a488035 | 590 | |
6a488035 | 591 | if (!$this->_id) { |
29fc2b79 | 592 | $this->addBreadCrumb(); |
6a488035 TO |
593 | } |
594 | ||
595 | foreach ($this->_columns as $tableName => $table) { | |
596 | // set alias | |
597 | if (!isset($table['alias'])) { | |
9d72cede EM |
598 | $this->_columns[$tableName]['alias'] = substr($tableName, 8) . |
599 | '_civireport'; | |
6a488035 TO |
600 | } |
601 | else { | |
602 | $this->_columns[$tableName]['alias'] = $table['alias'] . '_civireport'; | |
603 | } | |
604 | ||
605 | $this->_aliases[$tableName] = $this->_columns[$tableName]['alias']; | |
606 | ||
c75e90fa | 607 | $daoOrBaoName = NULL; |
6a488035 TO |
608 | // higher preference to bao object |
609 | if (array_key_exists('bao', $table)) { | |
c75e90fa | 610 | $daoOrBaoName = $table['bao']; |
9d72cede | 611 | $expFields = $daoOrBaoName::exportableFields(); |
6a488035 | 612 | } |
9d72cede | 613 | elseif (array_key_exists('dao', $table)) { |
c75e90fa | 614 | $daoOrBaoName = $table['dao']; |
9d72cede | 615 | $expFields = $daoOrBaoName::export(); |
6a488035 | 616 | } |
9d72cede | 617 | else { |
8edb9849 | 618 | $expFields = array(); |
619 | } | |
6a488035 TO |
620 | |
621 | $doNotCopy = array('required'); | |
622 | ||
623 | $fieldGroups = array('fields', 'filters', 'group_bys', 'order_bys'); | |
624 | foreach ($fieldGroups as $fieldGrp) { | |
a7488080 | 625 | if (!empty($table[$fieldGrp]) && is_array($table[$fieldGrp])) { |
6a488035 TO |
626 | foreach ($table[$fieldGrp] as $fieldName => $field) { |
627 | // $name is the field name used to reference the BAO/DAO export fields array | |
628 | $name = isset($field['name']) ? $field['name'] : $fieldName; | |
629 | ||
630 | // Sometimes the field name key in the BAO/DAO export fields array is | |
631 | // different from the actual database field name. | |
632 | // Unset $field['name'] so that actual database field name can be obtained | |
633 | // from the BAO/DAO export fields array. | |
634 | unset($field['name']); | |
635 | ||
636 | if (array_key_exists($name, $expFields)) { | |
637 | foreach ($doNotCopy as $dnc) { | |
638 | // unset the values we don't want to be copied. | |
639 | unset($expFields[$name][$dnc]); | |
640 | } | |
641 | if (empty($field)) { | |
642 | $this->_columns[$tableName][$fieldGrp][$fieldName] = $expFields[$name]; | |
643 | } | |
644 | else { | |
645 | foreach ($expFields[$name] as $property => $val) { | |
646 | if (!array_key_exists($property, $field)) { | |
647 | $this->_columns[$tableName][$fieldGrp][$fieldName][$property] = $val; | |
648 | } | |
649 | } | |
650 | } | |
651 | } | |
652 | ||
653 | // fill other vars | |
a7488080 | 654 | if (!empty($field['no_repeat'])) { |
6a488035 TO |
655 | $this->_noRepeats[] = "{$tableName}_{$fieldName}"; |
656 | } | |
a7488080 | 657 | if (!empty($field['no_display'])) { |
6a488035 TO |
658 | $this->_noDisplay[] = "{$tableName}_{$fieldName}"; |
659 | } | |
660 | ||
661 | // set alias = table-name, unless already set | |
971d41b1 CW |
662 | $alias = isset($field['alias']) ? $field['alias'] : ( |
663 | isset($this->_columns[$tableName]['alias']) ? $this->_columns[$tableName]['alias'] : $tableName | |
6a488035 TO |
664 | ); |
665 | $this->_columns[$tableName][$fieldGrp][$fieldName]['alias'] = $alias; | |
666 | ||
667 | // set name = fieldName, unless already set | |
668 | if (!isset($this->_columns[$tableName][$fieldGrp][$fieldName]['name'])) { | |
669 | $this->_columns[$tableName][$fieldGrp][$fieldName]['name'] = $name; | |
670 | } | |
671 | ||
672 | // set dbAlias = alias.name, unless already set | |
673 | if (!isset($this->_columns[$tableName][$fieldGrp][$fieldName]['dbAlias'])) { | |
971d41b1 CW |
674 | $this->_columns[$tableName][$fieldGrp][$fieldName]['dbAlias'] |
675 | = $alias . '.' . | |
9d72cede | 676 | $this->_columns[$tableName][$fieldGrp][$fieldName]['name']; |
6a488035 TO |
677 | } |
678 | ||
c75e90fa | 679 | // a few auto fills for filters |
c93f6d83 | 680 | if ($fieldGrp == 'filters') { |
c75e90fa DS |
681 | // fill operator types |
682 | if (!array_key_exists('operatorType', $this->_columns[$tableName][$fieldGrp][$fieldName])) { | |
683 | switch (CRM_Utils_Array::value('type', $this->_columns[$tableName][$fieldGrp][$fieldName])) { | |
684 | case CRM_Utils_Type::T_MONEY: | |
685 | case CRM_Utils_Type::T_FLOAT: | |
686 | $this->_columns[$tableName][$fieldGrp][$fieldName]['operatorType'] = CRM_Report_Form::OP_FLOAT; | |
687 | break; | |
ea100cb5 | 688 | |
c75e90fa DS |
689 | case CRM_Utils_Type::T_INT: |
690 | $this->_columns[$tableName][$fieldGrp][$fieldName]['operatorType'] = CRM_Report_Form::OP_INT; | |
691 | break; | |
ea100cb5 | 692 | |
c75e90fa | 693 | case CRM_Utils_Type::T_DATE: |
c93f6d83 | 694 | $this->_columns[$tableName][$fieldGrp][$fieldName]['operatorType'] = CRM_Report_Form::OP_DATE; |
c75e90fa | 695 | break; |
ea100cb5 | 696 | |
c75e90fa DS |
697 | case CRM_Utils_Type::T_BOOLEAN: |
698 | $this->_columns[$tableName][$fieldGrp][$fieldName]['operatorType'] = CRM_Report_Form::OP_SELECT; | |
699 | if (!array_key_exists('options', $this->_columns[$tableName][$fieldGrp][$fieldName])) { | |
971d41b1 CW |
700 | $this->_columns[$tableName][$fieldGrp][$fieldName]['options'] |
701 | = array( | |
9d72cede EM |
702 | '' => ts('Any'), |
703 | '0' => ts('No'), | |
21dfd5f5 | 704 | '1' => ts('Yes'), |
9d72cede | 705 | ); |
c75e90fa DS |
706 | } |
707 | break; | |
ea100cb5 | 708 | |
c75e90fa | 709 | default: |
c93f6d83 | 710 | if ($daoOrBaoName && |
9d72cede EM |
711 | array_key_exists('pseudoconstant', $this->_columns[$tableName][$fieldGrp][$fieldName]) |
712 | ) { | |
c75e90fa DS |
713 | // with multiple options operator-type is generally multi-select |
714 | $this->_columns[$tableName][$fieldGrp][$fieldName]['operatorType'] = CRM_Report_Form::OP_MULTISELECT; | |
715 | if (!array_key_exists('options', $this->_columns[$tableName][$fieldGrp][$fieldName])) { | |
716 | // fill options | |
717 | $this->_columns[$tableName][$fieldGrp][$fieldName]['options'] = CRM_Core_PseudoConstant::get($daoOrBaoName, $fieldName); | |
718 | } | |
719 | } | |
720 | break; | |
721 | } | |
6a488035 TO |
722 | } |
723 | } | |
724 | } | |
725 | } | |
726 | } | |
727 | ||
728 | // copy filters to a separate handy variable | |
729 | if (array_key_exists('filters', $table)) { | |
730 | $this->_filters[$tableName] = $this->_columns[$tableName]['filters']; | |
731 | } | |
732 | ||
733 | if (array_key_exists('group_bys', $table)) { | |
734 | $groupBys[$tableName] = $this->_columns[$tableName]['group_bys']; | |
735 | } | |
736 | ||
737 | if (array_key_exists('fields', $table)) { | |
738 | $reportFields[$tableName] = $this->_columns[$tableName]['fields']; | |
739 | } | |
740 | } | |
741 | ||
742 | if ($this->_force) { | |
743 | $this->setDefaultValues(FALSE); | |
744 | } | |
745 | ||
8f1445ea DL |
746 | CRM_Report_Utils_Get::processFilter($this->_filters, $this->_defaults); |
747 | CRM_Report_Utils_Get::processGroupBy($groupBys, $this->_defaults); | |
748 | CRM_Report_Utils_Get::processFields($reportFields, $this->_defaults); | |
6a488035 TO |
749 | CRM_Report_Utils_Get::processChart($this->_defaults); |
750 | ||
751 | if ($this->_force) { | |
752 | $this->_formValues = $this->_defaults; | |
753 | $this->postProcess(); | |
754 | } | |
755 | } | |
756 | ||
74cf4551 | 757 | /** |
7d7c50f9 EM |
758 | * Set default values. |
759 | * | |
74cf4551 EM |
760 | * @param bool $freeze |
761 | * | |
762 | * @return array | |
763 | */ | |
00be9182 | 764 | public function setDefaultValues($freeze = TRUE) { |
6a488035 TO |
765 | $freezeGroup = array(); |
766 | ||
767 | // FIXME: generalizing form field naming conventions would reduce | |
7d7c50f9 | 768 | // Lots of lines below. |
6a488035 TO |
769 | foreach ($this->_columns as $tableName => $table) { |
770 | if (array_key_exists('fields', $table)) { | |
771 | foreach ($table['fields'] as $fieldName => $field) { | |
a7488080 | 772 | if (empty($field['no_display'])) { |
6a488035 TO |
773 | if (isset($field['required'])) { |
774 | // set default | |
775 | $this->_defaults['fields'][$fieldName] = 1; | |
776 | ||
777 | if ($freeze) { | |
778 | // find element object, so that we could use quickform's freeze method | |
779 | // for required elements | |
8f1445ea | 780 | $obj = $this->getElementFromGroup("fields", $fieldName); |
6a488035 TO |
781 | if ($obj) { |
782 | $freezeGroup[] = $obj; | |
783 | } | |
784 | } | |
785 | } | |
786 | elseif (isset($field['default'])) { | |
787 | $this->_defaults['fields'][$fieldName] = $field['default']; | |
788 | } | |
789 | } | |
790 | } | |
791 | } | |
792 | ||
793 | if (array_key_exists('group_bys', $table)) { | |
794 | foreach ($table['group_bys'] as $fieldName => $field) { | |
795 | if (isset($field['default'])) { | |
a7488080 | 796 | if (!empty($field['frequency'])) { |
6a488035 TO |
797 | $this->_defaults['group_bys_freq'][$fieldName] = 'MONTH'; |
798 | } | |
799 | $this->_defaults['group_bys'][$fieldName] = $field['default']; | |
800 | } | |
801 | } | |
802 | } | |
803 | if (array_key_exists('filters', $table)) { | |
804 | foreach ($table['filters'] as $fieldName => $field) { | |
805 | if (isset($field['default'])) { | |
9d72cede EM |
806 | if (CRM_Utils_Array::value('type', $field) & CRM_Utils_Type::T_DATE |
807 | ) { | |
808 | if (is_array($field['default'])) { | |
b0e34e7c | 809 | $this->_defaults["{$fieldName}_from"] = CRM_Utils_Array::value('from', $field['default']); |
810 | $this->_defaults["{$fieldName}_to"] = CRM_Utils_Array::value('to', $field['default']); | |
811 | $this->_defaults["{$fieldName}_relative"] = 0; | |
812 | } | |
9d72cede | 813 | else { |
b0e34e7c | 814 | $this->_defaults["{$fieldName}_relative"] = $field['default']; |
815 | } | |
6a488035 TO |
816 | } |
817 | else { | |
818 | $this->_defaults["{$fieldName}_value"] = $field['default']; | |
819 | } | |
820 | } | |
821 | //assign default value as "in" for multiselect | |
822 | //operator, To freeze the select element | |
9d72cede EM |
823 | if (CRM_Utils_Array::value('operatorType', $field) == |
824 | CRM_Report_Form::OP_MULTISELECT | |
825 | ) { | |
6a488035 TO |
826 | $this->_defaults["{$fieldName}_op"] = 'in'; |
827 | } | |
9d72cede EM |
828 | if (CRM_Utils_Array::value('operatorType', $field) == |
829 | CRM_Report_Form::OP_ENTITYREF | |
830 | ) { | |
2107cde9 CW |
831 | $this->_defaults["{$fieldName}_op"] = 'in'; |
832 | } | |
9d72cede EM |
833 | elseif (CRM_Utils_Array::value('operatorType', $field) == |
834 | CRM_Report_Form::OP_MULTISELECT_SEPARATOR | |
835 | ) { | |
6a488035 TO |
836 | $this->_defaults["{$fieldName}_op"] = 'mhas'; |
837 | } | |
838 | elseif ($op = CRM_Utils_Array::value('default_op', $field)) { | |
839 | $this->_defaults["{$fieldName}_op"] = $op; | |
840 | } | |
841 | } | |
842 | } | |
843 | ||
8f1445ea | 844 | if ( |
e76ce93e | 845 | empty($this->_formValues['order_bys']) && |
846 | (array_key_exists('order_bys', $table) && | |
847 | is_array($table['order_bys'])) | |
6a488035 | 848 | ) { |
6a488035 | 849 | if (!array_key_exists('order_bys', $this->_defaults)) { |
6a488035 TO |
850 | $this->_defaults['order_bys'] = array(); |
851 | } | |
852 | foreach ($table['order_bys'] as $fieldName => $field) { | |
8cc574cf | 853 | if (!empty($field['default']) || !empty($field['default_order']) || |
9d72cede EM |
854 | CRM_Utils_Array::value('default_is_section', $field) || |
855 | !empty($field['default_weight']) | |
856 | ) { | |
6a488035 TO |
857 | $order_by = array( |
858 | 'column' => $fieldName, | |
859 | 'order' => CRM_Utils_Array::value('default_order', $field, 'ASC'), | |
860 | 'section' => CRM_Utils_Array::value('default_is_section', $field, 0), | |
861 | ); | |
862 | ||
a7488080 | 863 | if (!empty($field['default_weight'])) { |
6a488035 TO |
864 | $this->_defaults['order_bys'][(int) $field['default_weight']] = $order_by; |
865 | } | |
866 | else { | |
867 | array_unshift($this->_defaults['order_bys'], $order_by); | |
868 | } | |
869 | } | |
870 | } | |
871 | } | |
872 | ||
873 | foreach ($this->_options as $fieldName => $field) { | |
874 | if (isset($field['default'])) { | |
875 | $this->_defaults['options'][$fieldName] = $field['default']; | |
876 | } | |
877 | } | |
878 | } | |
879 | ||
880 | if (!empty($this->_submitValues)) { | |
881 | $this->preProcessOrderBy($this->_submitValues); | |
882 | } | |
883 | else { | |
884 | $this->preProcessOrderBy($this->_defaults); | |
885 | } | |
886 | ||
887 | // lets finish freezing task here itself | |
888 | if (!empty($freezeGroup)) { | |
889 | foreach ($freezeGroup as $elem) { | |
890 | $elem->freeze(); | |
891 | } | |
892 | } | |
893 | ||
894 | if ($this->_formValues) { | |
895 | $this->_defaults = array_merge($this->_defaults, $this->_formValues); | |
896 | } | |
897 | ||
898 | if ($this->_instanceValues) { | |
899 | $this->_defaults = array_merge($this->_defaults, $this->_instanceValues); | |
900 | } | |
901 | ||
902 | CRM_Report_Form_Instance::setDefaultValues($this, $this->_defaults); | |
903 | ||
904 | return $this->_defaults; | |
905 | } | |
906 | ||
74cf4551 | 907 | /** |
7d7c50f9 EM |
908 | * Get element from group. |
909 | * | |
8a925f33 | 910 | * @param string $group |
100fef9d | 911 | * @param string $grpFieldName |
74cf4551 EM |
912 | * |
913 | * @return bool | |
914 | */ | |
00be9182 | 915 | public function getElementFromGroup($group, $grpFieldName) { |
6a488035 TO |
916 | $eleObj = $this->getElement($group); |
917 | foreach ($eleObj->_elements as $index => $obj) { | |
918 | if ($grpFieldName == $obj->_attributes['name']) { | |
919 | return $obj; | |
920 | } | |
921 | } | |
922 | return FALSE; | |
923 | } | |
924 | ||
c58f66e0 | 925 | /** |
7d7c50f9 | 926 | * Setter for $_params. |
9d72cede | 927 | * |
c58f66e0 E |
928 | * @param array $params |
929 | */ | |
00be9182 | 930 | public function setParams($params) { |
c58f66e0 E |
931 | $this->_params = $params; |
932 | } | |
933 | ||
934 | /** | |
0b62c1ab | 935 | * Setter for $_id. |
2a6da8d7 | 936 | * |
537c70b8 | 937 | * @param int $instanceID |
c58f66e0 | 938 | */ |
537c70b8 EM |
939 | public function setID($instanceID) { |
940 | $this->_id = $instanceID; | |
c58f66e0 E |
941 | } |
942 | ||
943 | /** | |
07f44165 | 944 | * Setter for $_force. |
9d72cede | 945 | * |
317a8023 | 946 | * @param bool $isForce |
9d72cede | 947 | */ |
00be9182 | 948 | public function setForce($isForce) { |
c58f66e0 E |
949 | $this->_force = $isForce; |
950 | } | |
6f900755 E |
951 | |
952 | /** | |
7d7c50f9 | 953 | * Setter for $_limitValue. |
9d72cede | 954 | * |
d3e86119 | 955 | * @param int $_limitValue |
6f900755 | 956 | */ |
00be9182 | 957 | public function setLimitValue($_limitValue) { |
6f900755 E |
958 | $this->_limitValue = $_limitValue; |
959 | } | |
960 | ||
961 | /** | |
7d7c50f9 | 962 | * Setter for $_offsetValue. |
9d72cede | 963 | * |
d3e86119 | 964 | * @param int $_offsetValue |
6f900755 | 965 | */ |
00be9182 | 966 | public function setOffsetValue($_offsetValue) { |
6f900755 E |
967 | $this->_offsetValue = $_offsetValue; |
968 | } | |
969 | ||
c58f66e0 | 970 | /** |
7d7c50f9 EM |
971 | * Getter for $_defaultValues. |
972 | * | |
a6c01b45 | 973 | * @return array |
c58f66e0 | 974 | */ |
00be9182 | 975 | public function getDefaultValues() { |
c58f66e0 E |
976 | return $this->_defaults; |
977 | } | |
978 | ||
7d7c50f9 EM |
979 | /** |
980 | * Add columns to report. | |
981 | */ | |
00be9182 | 982 | public function addColumns() { |
6a488035 TO |
983 | $options = array(); |
984 | $colGroups = NULL; | |
985 | foreach ($this->_columns as $tableName => $table) { | |
986 | if (array_key_exists('fields', $table)) { | |
987 | foreach ($table['fields'] as $fieldName => $field) { | |
8bdc861c | 988 | $groupTitle = ''; |
a7488080 | 989 | if (empty($field['no_display'])) { |
9d72cede | 990 | foreach (array('table', 'field') as $var) { |
8bdc861c DS |
991 | if (!empty(${$var}['grouping'])) { |
992 | if (!is_array(${$var}['grouping'])) { | |
993 | $tableName = ${$var}['grouping']; | |
9d72cede EM |
994 | } |
995 | else { | |
b80138e0 DS |
996 | $tableName = array_keys(${$var}['grouping']); |
997 | $tableName = $tableName[0]; | |
998 | $groupTitle = array_values(${$var}['grouping']); | |
999 | $groupTitle = $groupTitle[0]; | |
8bdc861c DS |
1000 | } |
1001 | } | |
6a488035 | 1002 | } |
8bdc861c DS |
1003 | |
1004 | if (!$groupTitle && isset($table['group_title'])) { | |
1005 | $groupTitle = $table['group_title']; | |
6df2d404 EM |
1006 | // Having a group_title is secret code for being a custom group |
1007 | // which cryptically translates to needing an accordian. | |
1008 | // here we make that explicit. | |
1009 | $colGroups[$tableName]['use_accordian_for_field_selection'] = TRUE; | |
6a488035 | 1010 | } |
6a488035 | 1011 | |
8bdc861c | 1012 | $colGroups[$tableName]['fields'][$fieldName] = CRM_Utils_Array::value('title', $field); |
8cc574cf | 1013 | if ($groupTitle && empty($colGroups[$tableName]['group_title'])) { |
8bdc861c | 1014 | $colGroups[$tableName]['group_title'] = $groupTitle; |
6a488035 | 1015 | } |
6a488035 TO |
1016 | $options[$fieldName] = CRM_Utils_Array::value('title', $field); |
1017 | } | |
1018 | } | |
1019 | } | |
1020 | } | |
1021 | ||
1022 | $this->addCheckBox("fields", ts('Select Columns'), $options, NULL, | |
1023 | NULL, NULL, NULL, $this->_fourColumnAttribute, TRUE | |
1024 | ); | |
0b62c1ab EM |
1025 | if (!empty($colGroups)) { |
1026 | $this->tabs['FieldSelection'] = array( | |
1027 | 'title' => ts('Columns'), | |
1028 | 'tpl' => 'FieldSelection', | |
1029 | 'div_label' => 'col-groups', | |
1030 | ); | |
1031 | ||
1032 | // Note this assignment is only really required in buildForm. It is being 'over-called' | |
1033 | // to reduce risk of being missed due to overridden functions. | |
1034 | $this->assign('tabs', $this->tabs); | |
1035 | } | |
1036 | ||
6a488035 TO |
1037 | $this->assign('colGroups', $colGroups); |
1038 | } | |
1039 | ||
50951061 EM |
1040 | /** |
1041 | * Add filters to report. | |
1042 | */ | |
00be9182 | 1043 | public function addFilters() { |
7607643a | 1044 | $filters = $filterGroups = array(); |
6a488035 | 1045 | $count = 1; |
69719a15 | 1046 | |
6a488035 | 1047 | foreach ($this->_filters as $table => $attributes) { |
69719a15 EM |
1048 | if (isset($this->_columns[$table]['group_title'])) { |
1049 | // The presence of 'group_title' is secret code for 'is_a_custom_table' | |
1050 | // which magically means to 'display in an accordian' | |
1051 | // here we make this explicit. | |
1052 | $filterGroups[$table] = array( | |
1053 | 'group_title' => $this->_columns[$table]['group_title'], | |
1054 | 'use_accordian_for_field_selection' => TRUE, | |
1055 | ||
1056 | ); | |
1057 | } | |
6a488035 TO |
1058 | foreach ($attributes as $fieldName => $field) { |
1059 | // get ready with option value pair | |
1b36206c | 1060 | // @ 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 |
1061 | // would be useful | |
1062 | $operations = $this->getOperationPair( | |
8f1445ea | 1063 | CRM_Utils_Array::value('operatorType', $field), |
1b36206c | 1064 | $fieldName); |
6a488035 TO |
1065 | |
1066 | $filters[$table][$fieldName] = $field; | |
1067 | ||
1068 | switch (CRM_Utils_Array::value('operatorType', $field)) { | |
1069 | case CRM_Report_Form::OP_MONTH: | |
9d72cede EM |
1070 | if (!array_key_exists('options', $field) || |
1071 | !is_array($field['options']) || empty($field['options']) | |
1072 | ) { | |
6a488035 TO |
1073 | // If there's no option list for this filter, define one. |
1074 | $field['options'] = array( | |
1075 | 1 => ts('January'), | |
1076 | 2 => ts('February'), | |
1077 | 3 => ts('March'), | |
1078 | 4 => ts('April'), | |
1079 | 5 => ts('May'), | |
1080 | 6 => ts('June'), | |
1081 | 7 => ts('July'), | |
1082 | 8 => ts('August'), | |
1083 | 9 => ts('September'), | |
1084 | 10 => ts('October'), | |
1085 | 11 => ts('November'), | |
1086 | 12 => ts('December'), | |
1087 | ); | |
1088 | // Add this option list to this column _columns. This is | |
1089 | // required so that filter statistics show properly. | |
1090 | $this->_columns[$table]['filters'][$fieldName]['options'] = $field['options']; | |
1091 | } | |
160d32e1 E |
1092 | case CRM_Report_Form::OP_MULTISELECT: |
1093 | case CRM_Report_Form::OP_MULTISELECT_SEPARATOR: | |
6a488035 | 1094 | // assume a multi-select field |
9d72cede EM |
1095 | if (!empty($field['options']) || |
1096 | $fieldName == 'state_province_id' || $fieldName == 'county_id' | |
1097 | ) { | |
6a488035 TO |
1098 | $element = $this->addElement('select', "{$fieldName}_op", ts('Operator:'), $operations); |
1099 | if (count($operations) <= 1) { | |
1100 | $element->freeze(); | |
1101 | } | |
9d72cede EM |
1102 | if ($fieldName == 'state_province_id' || |
1103 | $fieldName == 'county_id' | |
1104 | ) { | |
1105 | $this->addChainSelect($fieldName . '_value', array( | |
86bd39be TO |
1106 | 'multiple' => TRUE, |
1107 | 'label' => NULL, | |
21dfd5f5 | 1108 | 'class' => 'huge', |
86bd39be | 1109 | )); |
c927c151 CW |
1110 | } |
1111 | else { | |
1112 | $this->addElement('select', "{$fieldName}_value", NULL, $field['options'], array( | |
1113 | 'style' => 'min-width:250px', | |
2107cde9 | 1114 | 'class' => 'crm-select2 huge', |
c927c151 CW |
1115 | 'multiple' => TRUE, |
1116 | 'placeholder' => ts('- select -'), | |
1117 | )); | |
1118 | } | |
6a488035 TO |
1119 | } |
1120 | break; | |
1121 | ||
160d32e1 | 1122 | case CRM_Report_Form::OP_SELECT: |
6a488035 TO |
1123 | // assume a select field |
1124 | $this->addElement('select', "{$fieldName}_op", ts('Operator:'), $operations); | |
9d72cede | 1125 | if (!empty($field['options'])) { |
5a9a44d9 | 1126 | $this->addElement('select', "{$fieldName}_value", NULL, $field['options']); |
9d72cede | 1127 | } |
6a488035 TO |
1128 | break; |
1129 | ||
2107cde9 CW |
1130 | case CRM_Report_Form::OP_ENTITYREF: |
1131 | $this->addElement('select', "{$fieldName}_op", ts('Operator:'), $operations); | |
1132 | $this->setEntityRefDefaults($field, $table); | |
1133 | $this->addEntityRef("{$fieldName}_value", NULL, $field['attributes']); | |
1134 | break; | |
1135 | ||
160d32e1 | 1136 | case CRM_Report_Form::OP_DATE: |
6a488035 | 1137 | // build datetime fields |
9d72cede | 1138 | CRM_Core_Form_Date::buildDateRange($this, $fieldName, $count, '_from', '_to', 'From:', FALSE, $operations); |
6a488035 TO |
1139 | $count++; |
1140 | break; | |
1141 | ||
160d32e1 | 1142 | case CRM_Report_Form::OP_DATETIME: |
6a488035 | 1143 | // build datetime fields |
9d72cede | 1144 | CRM_Core_Form_Date::buildDateRange($this, $fieldName, $count, '_from', '_to', 'From:', FALSE, $operations, 'searchDate', TRUE); |
6a488035 TO |
1145 | $count++; |
1146 | break; | |
1147 | ||
160d32e1 E |
1148 | case CRM_Report_Form::OP_INT: |
1149 | case CRM_Report_Form::OP_FLOAT: | |
6a488035 TO |
1150 | // and a min value input box |
1151 | $this->add('text', "{$fieldName}_min", ts('Min')); | |
1152 | // and a max value input box | |
1153 | $this->add('text', "{$fieldName}_max", ts('Max')); | |
1154 | default: | |
1155 | // default type is string | |
1156 | $this->addElement('select', "{$fieldName}_op", ts('Operator:'), $operations, | |
1157 | array('onchange' => "return showHideMaxMinVal( '$fieldName', this.value );") | |
1158 | ); | |
1159 | // we need text box for value input | |
2107cde9 | 1160 | $this->add('text', "{$fieldName}_value", NULL, array('class' => 'huge')); |
6a488035 TO |
1161 | break; |
1162 | } | |
1163 | } | |
1164 | } | |
0b62c1ab EM |
1165 | if (!empty($filters)) { |
1166 | $this->tabs['Filters'] = array( | |
1167 | 'title' => ts('Filters'), | |
1168 | 'tpl' => 'Filters', | |
1169 | 'div_label' => 'set-filters', | |
1170 | ); | |
1171 | } | |
6a488035 | 1172 | $this->assign('filters', $filters); |
69719a15 | 1173 | $this->assign('filterGroups', $filterGroups); |
6a488035 TO |
1174 | } |
1175 | ||
0b62c1ab EM |
1176 | /** |
1177 | * Function to assign the tabs to the template in the correct order. | |
1178 | * | |
1179 | * We want the tabs to wind up in this order (if not overridden). | |
1180 | * | |
1181 | * - Field Selection | |
1182 | * - Group Bys | |
1183 | * - Order Bys | |
1184 | * - Other Options | |
1185 | * - Filters | |
1186 | */ | |
1187 | protected function assignTabs() { | |
1188 | $order = array( | |
1189 | 'FieldSelection', | |
1190 | 'GroupBy', | |
1191 | 'OrderBy', | |
1192 | 'ReportOptions', | |
1193 | 'Filters', | |
1194 | ); | |
1195 | $order = array_intersect_key(array_fill_keys($order, 1), $this->tabs); | |
1196 | $order = array_merge($order, $this->tabs); | |
1197 | $this->assign('tabs', $order); | |
1198 | } | |
1199 | ||
1200 | /** | |
50951061 EM |
1201 | * Add options defined in $this->_options to the report. |
1202 | */ | |
00be9182 | 1203 | public function addOptions() { |
6a488035 TO |
1204 | if (!empty($this->_options)) { |
1205 | // FIXME: For now lets build all elements as checkboxes. | |
1206 | // Once we clear with the format we can build elements based on type | |
1207 | ||
6a488035 | 1208 | foreach ($this->_options as $fieldName => $field) { |
52b41f2f FG |
1209 | $options = array(); |
1210 | ||
6a488035 TO |
1211 | if ($field['type'] == 'select') { |
1212 | $this->addElement('select', "{$fieldName}", $field['title'], $field['options']); | |
1213 | } | |
4c9b6178 | 1214 | elseif ($field['type'] == 'checkbox') { |
6a488035 | 1215 | $options[$field['title']] = $fieldName; |
52634dad DS |
1216 | $this->addCheckBox($fieldName, NULL, |
1217 | $options, NULL, | |
1218 | NULL, NULL, NULL, $this->_fourColumnAttribute | |
1219 | ); | |
6a488035 TO |
1220 | } |
1221 | } | |
6a488035 | 1222 | } |
0b62c1ab EM |
1223 | if (!empty($this->_options)) { |
1224 | $this->tabs['ReportOptions'] = array( | |
1225 | 'title' => ts('Display Options'), | |
1226 | 'tpl' => 'ReportOptions', | |
1227 | 'div_label' => 'other-options', | |
1228 | ); | |
1229 | } | |
52634dad | 1230 | $this->assign('otherOptions', $this->_options); |
6a488035 TO |
1231 | } |
1232 | ||
50951061 EM |
1233 | /** |
1234 | * Add chart options to the report. | |
1235 | */ | |
00be9182 | 1236 | public function addChartOptions() { |
6a488035 | 1237 | if (!empty($this->_charts)) { |
22b67281 | 1238 | $this->addElement('select', "charts", ts('Chart'), $this->_charts); |
6a488035 TO |
1239 | $this->assign('charts', $this->_charts); |
1240 | $this->addElement('submit', $this->_chartButtonName, ts('View')); | |
1241 | } | |
1242 | } | |
1243 | ||
50951061 EM |
1244 | /** |
1245 | * Add group by options to the report. | |
1246 | */ | |
00be9182 | 1247 | public function addGroupBys() { |
6a488035 TO |
1248 | $options = $freqElements = array(); |
1249 | ||
1250 | foreach ($this->_columns as $tableName => $table) { | |
1251 | if (array_key_exists('group_bys', $table)) { | |
1252 | foreach ($table['group_bys'] as $fieldName => $field) { | |
1253 | if (!empty($field)) { | |
1254 | $options[$field['title']] = $fieldName; | |
a7488080 | 1255 | if (!empty($field['frequency'])) { |
6a488035 TO |
1256 | $freqElements[$field['title']] = $fieldName; |
1257 | } | |
1258 | } | |
1259 | } | |
1260 | } | |
1261 | } | |
1262 | $this->addCheckBox("group_bys", ts('Group by columns'), $options, NULL, | |
1263 | NULL, NULL, NULL, $this->_fourColumnAttribute | |
1264 | ); | |
1265 | $this->assign('groupByElements', $options); | |
0b62c1ab EM |
1266 | if (!empty($options)) { |
1267 | $this->tabs['GroupBy'] = array( | |
1268 | 'title' => ts('Grouping'), | |
1269 | 'tpl' => 'GroupBy', | |
1270 | 'div_label' => 'group-by-elements', | |
1271 | ); | |
1272 | } | |
6a488035 TO |
1273 | |
1274 | foreach ($freqElements as $name) { | |
1275 | $this->addElement('select', "group_bys_freq[$name]", | |
1276 | ts('Frequency'), $this->_groupByDateFreq | |
1277 | ); | |
1278 | } | |
1279 | } | |
1280 | ||
0b62c1ab EM |
1281 | /** |
1282 | * Add data for order by tab. | |
1283 | */ | |
00be9182 | 1284 | public function addOrderBys() { |
6a488035 TO |
1285 | $options = array(); |
1286 | foreach ($this->_columns as $tableName => $table) { | |
1287 | ||
0b62c1ab | 1288 | // Report developer may define any column to order by; include these as order-by options. |
6a488035 TO |
1289 | if (array_key_exists('order_bys', $table)) { |
1290 | foreach ($table['order_bys'] as $fieldName => $field) { | |
1291 | if (!empty($field)) { | |
1292 | $options[$fieldName] = $field['title']; | |
1293 | } | |
1294 | } | |
1295 | } | |
1296 | ||
971d41b1 CW |
1297 | // Add searchable custom fields as order-by options, if so requested |
1298 | // (These are already indexed, so allowing to order on them is cheap.) | |
6a488035 | 1299 | |
9d72cede EM |
1300 | if ($this->_autoIncludeIndexedFieldsAsOrderBys && |
1301 | array_key_exists('extends', $table) && !empty($table['extends']) | |
1302 | ) { | |
6a488035 | 1303 | foreach ($table['fields'] as $fieldName => $field) { |
a7488080 | 1304 | if (empty($field['no_display'])) { |
6a488035 TO |
1305 | $options[$fieldName] = $field['title']; |
1306 | } | |
1307 | } | |
1308 | } | |
1309 | } | |
1310 | ||
1311 | asort($options); | |
1312 | ||
1313 | $this->assign('orderByOptions', $options); | |
0b62c1ab EM |
1314 | if (!empty($options)) { |
1315 | $this->tabs['OrderBy'] = array( | |
1316 | 'title' => ts('Sorting'), | |
1317 | 'tpl' => 'OrderBy', | |
cd732070 | 1318 | 'div_label' => 'order-by-elements', |
0b62c1ab EM |
1319 | ); |
1320 | } | |
6a488035 TO |
1321 | |
1322 | if (!empty($options)) { | |
1323 | $options = array( | |
971d41b1 CW |
1324 | '-' => ' - none - ', |
1325 | ) + $options; | |
6a488035 TO |
1326 | for ($i = 1; $i <= 5; $i++) { |
1327 | $this->addElement('select', "order_bys[{$i}][column]", ts('Order by Column'), $options); | |
9d72cede | 1328 | $this->addElement('select', "order_bys[{$i}][order]", ts('Order by Order'), array( |
86bd39be | 1329 | 'ASC' => 'Ascending', |
21dfd5f5 | 1330 | 'DESC' => 'Descending', |
86bd39be | 1331 | )); |
6a488035 | 1332 | $this->addElement('checkbox', "order_bys[{$i}][section]", ts('Order by Section'), FALSE, array('id' => "order_by_section_$i")); |
5895cba0 | 1333 | $this->addElement('checkbox', "order_bys[{$i}][pageBreak]", ts('Page Break'), FALSE, array('id' => "order_by_pagebreak_$i")); |
6a488035 TO |
1334 | } |
1335 | } | |
1336 | } | |
1337 | ||
0b62c1ab | 1338 | /** |
07f44165 | 1339 | * This adds the tab referred to as Title and Format, rendered through Instance.tpl. |
0b62c1ab | 1340 | * |
07f44165 EM |
1341 | * @todo call this tab into the report template in the same way as OrderBy etc, ie |
1342 | * by adding a description of the tab to $this->tabs, causing the tab to be added in | |
1343 | * Criteria.tpl. | |
0b62c1ab | 1344 | */ |
00be9182 | 1345 | public function buildInstanceAndButtons() { |
6a488035 TO |
1346 | CRM_Report_Form_Instance::buildForm($this); |
1347 | ||
1348 | $label = $this->_id ? ts('Update Report') : ts('Create Report'); | |
1349 | ||
1350 | $this->addElement('submit', $this->_instanceButtonName, $label); | |
1351 | $this->addElement('submit', $this->_printButtonName, ts('Print Report')); | |
1352 | $this->addElement('submit', $this->_pdfButtonName, ts('PDF')); | |
1353 | ||
1354 | if ($this->_id) { | |
9d72cede EM |
1355 | $this->addElement('submit', $this->_createNewButtonName, |
1356 | ts('Save a Copy') . '...'); | |
6a488035 | 1357 | } |
c9cf6554 | 1358 | $this->assign('instanceForm', $this->_instanceForm); |
6a488035 TO |
1359 | |
1360 | $label = $this->_id ? ts('Print Report') : ts('Print Preview'); | |
1361 | $this->addElement('submit', $this->_printButtonName, $label); | |
1362 | ||
1363 | $label = $this->_id ? ts('PDF') : ts('Preview PDF'); | |
1364 | $this->addElement('submit', $this->_pdfButtonName, $label); | |
1365 | ||
1366 | $label = $this->_id ? ts('Export to CSV') : ts('Preview CSV'); | |
1367 | ||
1368 | if ($this->_csvSupported) { | |
1369 | $this->addElement('submit', $this->_csvButtonName, $label); | |
1370 | } | |
1371 | ||
9d72cede EM |
1372 | if (CRM_Core_Permission::check('administer Reports') && |
1373 | $this->_add2groupSupported | |
1374 | ) { | |
6a488035 | 1375 | $this->addElement('select', 'groups', ts('Group'), |
9d72cede EM |
1376 | array('' => ts('Add Contacts to Group')) + |
1377 | CRM_Core_PseudoConstant::nestedGroup(), | |
24431f7b | 1378 | array('class' => 'crm-select2 crm-action-menu action-icon-plus huge') |
6a488035 TO |
1379 | ); |
1380 | $this->assign('group', TRUE); | |
1381 | } | |
1382 | ||
24431f7b | 1383 | $this->addElement('submit', $this->_groupButtonName, '', array('style' => 'display: none;')); |
6a488035 TO |
1384 | |
1385 | $this->addChartOptions(); | |
1386 | $this->addButtons(array( | |
1387 | array( | |
1388 | 'type' => 'submit', | |
1389 | 'name' => ts('Preview Report'), | |
1390 | 'isDefault' => TRUE, | |
1391 | ), | |
1392 | ) | |
1393 | ); | |
1394 | } | |
1395 | ||
0b62c1ab EM |
1396 | /** |
1397 | * Main build form function. | |
1398 | */ | |
00be9182 | 1399 | public function buildQuickForm() { |
6a488035 TO |
1400 | $this->addColumns(); |
1401 | ||
1402 | $this->addFilters(); | |
1403 | ||
1404 | $this->addOptions(); | |
1405 | ||
1406 | $this->addGroupBys(); | |
1407 | ||
1408 | $this->addOrderBys(); | |
1409 | ||
1410 | $this->buildInstanceAndButtons(); | |
1411 | ||
0b62c1ab | 1412 | // Add form rule for report. |
6a488035 | 1413 | if (is_callable(array( |
9d72cede | 1414 | $this, |
21dfd5f5 | 1415 | 'formRule', |
9d72cede | 1416 | ))) { |
6a488035 TO |
1417 | $this->addFormRule(array(get_class($this), 'formRule'), $this); |
1418 | } | |
0b62c1ab | 1419 | $this->assignTabs(); |
6a488035 TO |
1420 | } |
1421 | ||
74cf4551 | 1422 | /** |
317a8023 | 1423 | * A form rule function for custom data. |
1424 | * | |
1425 | * The rule ensures that fields selected in group_by if any) should only be the ones | |
1426 | * present in display/select fields criteria; | |
4f1f1f2a | 1427 | * note: works if and only if any custom field selected in group_by. |
0b62c1ab | 1428 | * |
537c70b8 | 1429 | * @param array $fields |
74cf4551 EM |
1430 | * @param array $ignoreFields |
1431 | * | |
1432 | * @return array | |
1433 | */ | |
00be9182 | 1434 | public function customDataFormRule($fields, $ignoreFields = array()) { |
6a488035 | 1435 | $errors = array(); |
9d72cede EM |
1436 | if (!empty($this->_customGroupExtends) && $this->_customGroupGroupBy && |
1437 | !empty($fields['group_bys']) | |
1438 | ) { | |
6a488035 | 1439 | foreach ($this->_columns as $tableName => $table) { |
9d72cede EM |
1440 | if ((substr($tableName, 0, 13) == 'civicrm_value' || |
1441 | substr($tableName, 0, 12) == 'custom_value') && | |
1442 | !empty($this->_columns[$tableName]['fields']) | |
1443 | ) { | |
6a488035 TO |
1444 | foreach ($this->_columns[$tableName]['fields'] as $fieldName => $field) { |
1445 | if (array_key_exists($fieldName, $fields['group_bys']) && | |
1446 | !array_key_exists($fieldName, $fields['fields']) | |
1447 | ) { | |
1448 | $errors['fields'] = "Please make sure fields selected in 'Group by Columns' section are also selected in 'Display Columns' section."; | |
1449 | } | |
1450 | elseif (array_key_exists($fieldName, $fields['group_bys'])) { | |
1451 | foreach ($fields['fields'] as $fld => $val) { | |
9d72cede EM |
1452 | if (!array_key_exists($fld, $fields['group_bys']) && |
1453 | !in_array($fld, $ignoreFields) | |
1454 | ) { | |
6a488035 TO |
1455 | $errors['fields'] = "Please ensure that fields selected in 'Display Columns' are also selected in 'Group by Columns' section."; |
1456 | } | |
1457 | } | |
1458 | } | |
1459 | } | |
1460 | } | |
1461 | } | |
1462 | } | |
1463 | return $errors; | |
1464 | } | |
1465 | ||
74cf4551 | 1466 | /** |
0b62c1ab EM |
1467 | * Get operators to display on form. |
1468 | * | |
1469 | * Note: $fieldName param allows inheriting class to build operationPairs specific to a field. | |
1470 | * | |
74cf4551 | 1471 | * @param string $type |
8a925f33 | 1472 | * @param string $fieldName |
74cf4551 EM |
1473 | * |
1474 | * @return array | |
1475 | */ | |
00be9182 | 1476 | public function getOperationPair($type = "string", $fieldName = NULL) { |
6a488035 TO |
1477 | // FIXME: At some point we should move these key-val pairs |
1478 | // to option_group and option_value table. | |
6a488035 | 1479 | switch ($type) { |
160d32e1 E |
1480 | case CRM_Report_Form::OP_INT: |
1481 | case CRM_Report_Form::OP_FLOAT: | |
bed98343 | 1482 | |
6c552737 | 1483 | $result = array( |
bc3f7f04 | 1484 | 'lte' => ts('Is less than or equal to'), |
6a488035 TO |
1485 | 'gte' => ts('Is greater than or equal to'), |
1486 | 'bw' => ts('Is between'), | |
1487 | 'eq' => ts('Is equal to'), | |
1488 | 'lt' => ts('Is less than'), | |
1489 | 'gt' => ts('Is greater than'), | |
1490 | 'neq' => ts('Is not equal to'), | |
1491 | 'nbw' => ts('Is not between'), | |
1492 | 'nll' => ts('Is empty (Null)'), | |
1493 | 'nnll' => ts('Is not empty (Null)'), | |
1494 | ); | |
6c552737 | 1495 | return $result; |
6a488035 | 1496 | |
160d32e1 | 1497 | case CRM_Report_Form::OP_SELECT: |
6c552737 | 1498 | $result = array( |
bc3f7f04 | 1499 | 'eq' => ts('Is equal to'), |
1500 | ); | |
6c552737 | 1501 | return $result; |
6a488035 | 1502 | |
160d32e1 E |
1503 | case CRM_Report_Form::OP_MONTH: |
1504 | case CRM_Report_Form::OP_MULTISELECT: | |
2107cde9 | 1505 | case CRM_Report_Form::OP_ENTITYREF: |
bed98343 | 1506 | |
6c552737 | 1507 | $result = array( |
bc3f7f04 | 1508 | 'in' => ts('Is one of'), |
6a488035 TO |
1509 | 'notin' => ts('Is not one of'), |
1510 | ); | |
6c552737 | 1511 | return $result; |
6a488035 | 1512 | |
160d32e1 | 1513 | case CRM_Report_Form::OP_DATE: |
bed98343 | 1514 | |
6c552737 | 1515 | $result = array( |
bc3f7f04 | 1516 | 'nll' => ts('Is empty (Null)'), |
6a488035 TO |
1517 | 'nnll' => ts('Is not empty (Null)'), |
1518 | ); | |
6c552737 | 1519 | return $result; |
6a488035 | 1520 | |
160d32e1 | 1521 | case CRM_Report_Form::OP_MULTISELECT_SEPARATOR: |
6a488035 TO |
1522 | // use this operator for the values, concatenated with separator. For e.g if |
1523 | // multiple options for a column is stored as ^A{val1}^A{val2}^A | |
6c552737 | 1524 | $result = array( |
bc3f7f04 | 1525 | 'mhas' => ts('Is one of'), |
67788963 | 1526 | 'mnot' => ts('Is not one of'), |
bc3f7f04 | 1527 | ); |
6c552737 | 1528 | return $result; |
6a488035 TO |
1529 | |
1530 | default: | |
1531 | // type is string | |
6c552737 | 1532 | $result = array( |
bc3f7f04 | 1533 | 'has' => ts('Contains'), |
6a488035 TO |
1534 | 'sw' => ts('Starts with'), |
1535 | 'ew' => ts('Ends with'), | |
1536 | 'nhas' => ts('Does not contain'), | |
1537 | 'eq' => ts('Is equal to'), | |
1538 | 'neq' => ts('Is not equal to'), | |
1539 | 'nll' => ts('Is empty (Null)'), | |
1540 | 'nnll' => ts('Is not empty (Null)'), | |
1541 | ); | |
6c552737 | 1542 | return $result; |
6a488035 TO |
1543 | } |
1544 | } | |
1545 | ||
07f44165 EM |
1546 | /** |
1547 | * Build the tag filter field to display on the filters tab. | |
1548 | */ | |
00be9182 | 1549 | public function buildTagFilter() { |
ed795723 | 1550 | $contactTags = CRM_Core_BAO_Tag::getTags($this->_tagFilterTable); |
6a488035 TO |
1551 | if (!empty($contactTags)) { |
1552 | $this->_columns['civicrm_tag'] = array( | |
1553 | 'dao' => 'CRM_Core_DAO_Tag', | |
9d72cede EM |
1554 | 'filters' => array( |
1555 | 'tagid' => array( | |
6a488035 TO |
1556 | 'name' => 'tag_id', |
1557 | 'title' => ts('Tag'), | |
1558 | 'tag' => TRUE, | |
1559 | 'operatorType' => CRM_Report_Form::OP_MULTISELECT, | |
1560 | 'options' => $contactTags, | |
1561 | ), | |
1562 | ), | |
1563 | ); | |
1564 | } | |
1565 | } | |
1566 | ||
688d37c6 | 1567 | /** |
0b62c1ab | 1568 | * Adds group filters to _columns (called from _Construct). |
6a488035 | 1569 | */ |
00be9182 | 1570 | public function buildGroupFilter() { |
6a488035 | 1571 | $this->_columns['civicrm_group']['filters'] = array( |
9d72cede | 1572 | 'gid' => array( |
6a488035 TO |
1573 | 'name' => 'group_id', |
1574 | 'title' => ts('Group'), | |
1575 | 'operatorType' => CRM_Report_Form::OP_MULTISELECT, | |
1576 | 'group' => TRUE, | |
16e2e80c | 1577 | 'options' => CRM_Core_PseudoConstant::nestedGroup(), |
6a488035 TO |
1578 | ), |
1579 | ); | |
1580 | if (empty($this->_columns['civicrm_group']['dao'])) { | |
1581 | $this->_columns['civicrm_group']['dao'] = 'CRM_Contact_DAO_GroupContact'; | |
1582 | } | |
1583 | if (empty($this->_columns['civicrm_group']['alias'])) { | |
1584 | $this->_columns['civicrm_group']['alias'] = 'cgroup'; | |
1585 | } | |
1586 | } | |
1587 | ||
74cf4551 | 1588 | /** |
07f44165 EM |
1589 | * Get SQL operator from form text version. |
1590 | * | |
74cf4551 EM |
1591 | * @param string $operator |
1592 | * | |
1593 | * @return string | |
1594 | */ | |
00be9182 | 1595 | public function getSQLOperator($operator = "like") { |
6a488035 TO |
1596 | switch ($operator) { |
1597 | case 'eq': | |
1598 | return '='; | |
1599 | ||
1600 | case 'lt': | |
1601 | return '<'; | |
1602 | ||
1603 | case 'lte': | |
1604 | return '<='; | |
1605 | ||
1606 | case 'gt': | |
1607 | return '>'; | |
1608 | ||
1609 | case 'gte': | |
1610 | return '>='; | |
1611 | ||
1612 | case 'ne': | |
1613 | case 'neq': | |
1614 | return '!='; | |
1615 | ||
1616 | case 'nhas': | |
1617 | return 'NOT LIKE'; | |
1618 | ||
1619 | case 'in': | |
1620 | return 'IN'; | |
1621 | ||
1622 | case 'notin': | |
1623 | return 'NOT IN'; | |
1624 | ||
1625 | case 'nll': | |
1626 | return 'IS NULL'; | |
1627 | ||
1628 | case 'nnll': | |
1629 | return 'IS NOT NULL'; | |
1630 | ||
1631 | default: | |
1632 | // type is string | |
1633 | return 'LIKE'; | |
1634 | } | |
1635 | } | |
1636 | ||
74cf4551 | 1637 | /** |
f587aa17 | 1638 | * Generate where clause. |
07f44165 | 1639 | * |
8a925f33 | 1640 | * This can be overridden in reports for special treatment of a field |
f587aa17 | 1641 | * |
537c70b8 | 1642 | * @param array $field Field specifications |
8a925f33 | 1643 | * @param string $op Query operator (not an exact match to sql) |
f587aa17 EM |
1644 | * @param mixed $value |
1645 | * @param float $min | |
1646 | * @param float $max | |
74cf4551 EM |
1647 | * |
1648 | * @return null|string | |
1649 | */ | |
8a925f33 | 1650 | public function whereClause(&$field, $op, $value, $min, $max) { |
6a488035 TO |
1651 | |
1652 | $type = CRM_Utils_Type::typeToString(CRM_Utils_Array::value('type', $field)); | |
1653 | $clause = NULL; | |
1654 | ||
1655 | switch ($op) { | |
1656 | case 'bw': | |
1657 | case 'nbw': | |
1658 | if (($min !== NULL && strlen($min) > 0) || | |
1659 | ($max !== NULL && strlen($max) > 0) | |
1660 | ) { | |
9d72cede EM |
1661 | $min = CRM_Utils_Type::escape($min, $type); |
1662 | $max = CRM_Utils_Type::escape($max, $type); | |
6a488035 TO |
1663 | $clauses = array(); |
1664 | if ($min) { | |
1665 | if ($op == 'bw') { | |
1666 | $clauses[] = "( {$field['dbAlias']} >= $min )"; | |
1667 | } | |
1668 | else { | |
1669 | $clauses[] = "( {$field['dbAlias']} < $min )"; | |
1670 | } | |
1671 | } | |
1672 | if ($max) { | |
1673 | if ($op == 'bw') { | |
1674 | $clauses[] = "( {$field['dbAlias']} <= $max )"; | |
1675 | } | |
1676 | else { | |
1677 | $clauses[] = "( {$field['dbAlias']} > $max )"; | |
1678 | } | |
1679 | } | |
1680 | ||
1681 | if (!empty($clauses)) { | |
1682 | if ($op == 'bw') { | |
1683 | $clause = implode(' AND ', $clauses); | |
1684 | } | |
1685 | else { | |
1686 | $clause = implode(' OR ', $clauses); | |
1687 | } | |
1688 | } | |
1689 | } | |
1690 | break; | |
1691 | ||
1692 | case 'has': | |
1693 | case 'nhas': | |
1694 | if ($value !== NULL && strlen($value) > 0) { | |
1695 | $value = CRM_Utils_Type::escape($value, $type); | |
1696 | if (strpos($value, '%') === FALSE) { | |
1697 | $value = "'%{$value}%'"; | |
1698 | } | |
1699 | else { | |
1700 | $value = "'{$value}'"; | |
1701 | } | |
29fc2b79 | 1702 | $sqlOP = $this->getSQLOperator($op); |
6a488035 TO |
1703 | $clause = "( {$field['dbAlias']} $sqlOP $value )"; |
1704 | } | |
1705 | break; | |
1706 | ||
1707 | case 'in': | |
1708 | case 'notin': | |
2107cde9 CW |
1709 | if (is_string($value) && strlen($value)) { |
1710 | $value = explode(',', $value); | |
1711 | } | |
6a488035 | 1712 | if ($value !== NULL && is_array($value) && count($value) > 0) { |
29fc2b79 | 1713 | $sqlOP = $this->getSQLOperator($op); |
9d72cede EM |
1714 | if (CRM_Utils_Array::value('type', $field) == |
1715 | CRM_Utils_Type::T_STRING | |
1716 | ) { | |
f587aa17 | 1717 | //cycle through selections and escape values |
6a488035 TO |
1718 | foreach ($value as $key => $selection) { |
1719 | $value[$key] = CRM_Utils_Type::escape($selection, $type); | |
1720 | } | |
971d41b1 CW |
1721 | $clause |
1722 | = "( {$field['dbAlias']} $sqlOP ( '" . implode("' , '", $value) . | |
9d72cede | 1723 | "') )"; |
6a488035 TO |
1724 | } |
1725 | else { | |
1726 | // for numerical values | |
9d72cede EM |
1727 | $clause = "{$field['dbAlias']} $sqlOP (" . implode(', ', $value) . |
1728 | ")"; | |
6a488035 TO |
1729 | } |
1730 | if ($op == 'notin') { | |
1731 | $clause = "( " . $clause . " OR {$field['dbAlias']} IS NULL )"; | |
1732 | } | |
1733 | else { | |
1734 | $clause = "( " . $clause . " )"; | |
1735 | } | |
1736 | } | |
1737 | break; | |
1738 | ||
1739 | case 'mhas': | |
1740 | // mhas == multiple has | |
1741 | if ($value !== NULL && count($value) > 0) { | |
29fc2b79 | 1742 | $sqlOP = $this->getSQLOperator($op); |
971d41b1 | 1743 | $clause |
24f717cb | 1744 | = "{$field['dbAlias']} REGEXP '[[:cntrl:]]" . implode('|', $value) . |
1745 | "[[:cntrl:]]'"; | |
6a488035 TO |
1746 | } |
1747 | break; | |
77b97be7 | 1748 | |
67788963 J |
1749 | case 'mnot': |
1750 | // mnot == multiple is not one of | |
1751 | if ($value !== NULL && count($value) > 0) { | |
1752 | $sqlOP = $this->getSQLOperator($op); | |
971d41b1 | 1753 | $clause |
24f717cb | 1754 | = "( {$field['dbAlias']} NOT REGEXP '[[:cntrl:]]" . implode('|', $value) . |
1755 | "[[:cntrl:]]' OR {$field['dbAlias']} IS NULL )"; | |
67788963 J |
1756 | } |
1757 | break; | |
6a488035 TO |
1758 | |
1759 | case 'sw': | |
1760 | case 'ew': | |
1761 | if ($value !== NULL && strlen($value) > 0) { | |
1762 | $value = CRM_Utils_Type::escape($value, $type); | |
1763 | if (strpos($value, '%') === FALSE) { | |
1764 | if ($op == 'sw') { | |
1765 | $value = "'{$value}%'"; | |
1766 | } | |
1767 | else { | |
1768 | $value = "'%{$value}'"; | |
1769 | } | |
1770 | } | |
1771 | else { | |
1772 | $value = "'{$value}'"; | |
1773 | } | |
29fc2b79 | 1774 | $sqlOP = $this->getSQLOperator($op); |
6a488035 TO |
1775 | $clause = "( {$field['dbAlias']} $sqlOP $value )"; |
1776 | } | |
1777 | break; | |
1778 | ||
1779 | case 'nll': | |
1780 | case 'nnll': | |
29fc2b79 | 1781 | $sqlOP = $this->getSQLOperator($op); |
6a488035 TO |
1782 | $clause = "( {$field['dbAlias']} $sqlOP )"; |
1783 | break; | |
1784 | ||
1785 | default: | |
1786 | if ($value !== NULL && strlen($value) > 0) { | |
1787 | if (isset($field['clause'])) { | |
1788 | // FIXME: we not doing escape here. Better solution is to use two | |
1789 | // different types - data-type and filter-type | |
0e6e8724 | 1790 | $clause = $field['clause']; |
6a488035 TO |
1791 | } |
1792 | else { | |
1793 | $value = CRM_Utils_Type::escape($value, $type); | |
29fc2b79 | 1794 | $sqlOP = $this->getSQLOperator($op); |
6a488035 TO |
1795 | if ($field['type'] == CRM_Utils_Type::T_STRING) { |
1796 | $value = "'{$value}'"; | |
1797 | } | |
1798 | $clause = "( {$field['dbAlias']} $sqlOP $value )"; | |
1799 | } | |
1800 | } | |
1801 | break; | |
1802 | } | |
1803 | ||
a7488080 | 1804 | if (!empty($field['group']) && $clause) { |
6a488035 TO |
1805 | $clause = $this->whereGroupClause($field, $value, $op); |
1806 | } | |
a7488080 | 1807 | elseif (!empty($field['tag']) && $clause) { |
6a488035 TO |
1808 | // not using left join in query because if any contact |
1809 | // belongs to more than one tag, results duplicate | |
1810 | // entries. | |
1811 | $clause = $this->whereTagClause($field, $value, $op); | |
1812 | } | |
114a2c85 | 1813 | elseif (!empty($field['membership_org']) && $clause) { |
f587aa17 | 1814 | $clause = $this->whereMembershipOrgClause($value, $op); |
114a2c85 DG |
1815 | } |
1816 | elseif (!empty($field['membership_type']) && $clause) { | |
f587aa17 | 1817 | $clause = $this->whereMembershipTypeClause($value, $op); |
114a2c85 | 1818 | } |
6a488035 TO |
1819 | return $clause; |
1820 | } | |
1821 | ||
74cf4551 | 1822 | /** |
07f44165 EM |
1823 | * Get SQL where clause for a date field. |
1824 | * | |
100fef9d | 1825 | * @param string $fieldName |
317a8023 | 1826 | * @param string $relative |
f587aa17 EM |
1827 | * @param string $from |
1828 | * @param string $to | |
07f44165 EM |
1829 | * @param string $type |
1830 | * @param string $fromTime | |
1831 | * @param string $toTime | |
74cf4551 EM |
1832 | * |
1833 | * @return null|string | |
1834 | */ | |
971d41b1 | 1835 | public function dateClause( |
7d8c1168 TO |
1836 | $fieldName, |
1837 | $relative, $from, $to, $type = NULL, $fromTime = NULL, $toTime = NULL | |
6a488035 TO |
1838 | ) { |
1839 | $clauses = array(); | |
160d32e1 | 1840 | if (in_array($relative, array_keys($this->getOperationPair(CRM_Report_Form::OP_DATE)))) { |
29fc2b79 | 1841 | $sqlOP = $this->getSQLOperator($relative); |
6a488035 TO |
1842 | return "( {$fieldName} {$sqlOP} )"; |
1843 | } | |
1844 | ||
29fc2b79 | 1845 | list($from, $to) = $this->getFromTo($relative, $from, $to, $fromTime, $toTime); |
6a488035 TO |
1846 | |
1847 | if ($from) { | |
1848 | $from = ($type == CRM_Utils_Type::T_DATE) ? substr($from, 0, 8) : $from; | |
1849 | $clauses[] = "( {$fieldName} >= $from )"; | |
1850 | } | |
1851 | ||
1852 | if ($to) { | |
1853 | $to = ($type == CRM_Utils_Type::T_DATE) ? substr($to, 0, 8) : $to; | |
1854 | $clauses[] = "( {$fieldName} <= {$to} )"; | |
1855 | } | |
1856 | ||
1857 | if (!empty($clauses)) { | |
1858 | return implode(' AND ', $clauses); | |
1859 | } | |
1860 | ||
1861 | return NULL; | |
1862 | } | |
9d72cede EM |
1863 | |
1864 | /** | |
42b5c549 EM |
1865 | * Possibly unused function. |
1866 | * | |
9d72cede EM |
1867 | * @todo - could not find any instances where this is called |
1868 | * | |
537c70b8 | 1869 | * @param bool $relative |
7e06c9f5 | 1870 | * @param string $from |
7d7c50f9 | 1871 | * @param string $to |
9d72cede EM |
1872 | * |
1873 | * @return string|NULL | |
1874 | */ | |
00be9182 | 1875 | public function dateDisplay($relative, $from, $to) { |
29fc2b79 | 1876 | list($from, $to) = $this->getFromTo($relative, $from, $to); |
6a488035 TO |
1877 | |
1878 | if ($from) { | |
1879 | $clauses[] = CRM_Utils_Date::customFormat($from, NULL, array('m', 'M')); | |
1880 | } | |
1881 | else { | |
1882 | $clauses[] = 'Past'; | |
1883 | } | |
1884 | ||
1885 | if ($to) { | |
1886 | $clauses[] = CRM_Utils_Date::customFormat($to, NULL, array('m', 'M')); | |
1887 | } | |
1888 | else { | |
1889 | $clauses[] = 'Today'; | |
1890 | } | |
1891 | ||
1892 | if (!empty($clauses)) { | |
1893 | return implode(' - ', $clauses); | |
1894 | } | |
1895 | ||
1896 | return NULL; | |
1897 | } | |
1898 | ||
74cf4551 | 1899 | /** |
42b5c549 EM |
1900 | * Get values for from and to for date ranges. |
1901 | * | |
f587aa17 EM |
1902 | * @param bool $relative |
1903 | * @param string $from | |
1904 | * @param string $to | |
9907633b EM |
1905 | * @param string $fromTime |
1906 | * @param string $toTime | |
74cf4551 EM |
1907 | * |
1908 | * @return array | |
1909 | */ | |
9907633b EM |
1910 | public function getFromTo($relative, $from, $to, $fromTime = NULL, $toTime = NULL) { |
1911 | if (empty($toTime)) { | |
1912 | $toTime = '235959'; | |
6a488035 TO |
1913 | } |
1914 | //FIX ME not working for relative | |
1915 | if ($relative) { | |
1916 | list($term, $unit) = CRM_Utils_System::explode('.', $relative, 2); | |
1917 | $dateRange = CRM_Utils_Date::relativeToAbsolute($term, $unit); | |
1918 | $from = substr($dateRange['from'], 0, 8); | |
1919 | //Take only Date Part, Sometime Time part is also present in 'to' | |
1920 | $to = substr($dateRange['to'], 0, 8); | |
1921 | } | |
9907633b EM |
1922 | $from = CRM_Utils_Date::processDate($from, $fromTime); |
1923 | $to = CRM_Utils_Date::processDate($to, $toTime); | |
6a488035 TO |
1924 | return array($from, $to); |
1925 | } | |
1926 | ||
74cf4551 | 1927 | /** |
4b62bc4f EM |
1928 | * Alter display of rows. |
1929 | * | |
1930 | * Iterate through the rows retrieved via SQL and make changes for display purposes, | |
1931 | * such as rendering contacts as links. | |
1932 | * | |
1933 | * @param array $rows | |
1934 | * Rows generated by SQL, with an array for each row. | |
74cf4551 | 1935 | */ |
00be9182 | 1936 | public function alterDisplay(&$rows) { |
6a488035 TO |
1937 | } |
1938 | ||
74cf4551 | 1939 | /** |
42b5c549 EM |
1940 | * Alter the way in which custom data fields are displayed. |
1941 | * | |
1942 | * @param array $rows | |
74cf4551 | 1943 | */ |
00be9182 | 1944 | public function alterCustomDataDisplay(&$rows) { |
6a488035 TO |
1945 | // custom code to alter rows having custom values |
1946 | if (empty($this->_customGroupExtends)) { | |
1947 | return; | |
1948 | } | |
1949 | ||
1950 | $customFieldIds = array(); | |
1951 | foreach ($this->_params['fields'] as $fieldAlias => $value) { | |
1952 | if ($fieldId = CRM_Core_BAO_CustomField::getKeyID($fieldAlias)) { | |
1953 | $customFieldIds[$fieldAlias] = $fieldId; | |
1954 | } | |
1955 | } | |
1956 | if (empty($customFieldIds)) { | |
1957 | return; | |
1958 | } | |
1959 | ||
1960 | $customFields = $fieldValueMap = array(); | |
9d72cede EM |
1961 | $customFieldCols = array( |
1962 | 'column_name', | |
1963 | 'data_type', | |
1964 | 'html_type', | |
1965 | 'option_group_id', | |
21dfd5f5 | 1966 | 'id', |
9d72cede | 1967 | ); |
6a488035 TO |
1968 | |
1969 | // skip for type date and ContactReference since date format is already handled | |
1970 | $query = " | |
1971 | SELECT cg.table_name, cf." . implode(", cf.", $customFieldCols) . ", ov.value, ov.label | |
1972 | FROM civicrm_custom_field cf | |
1973 | INNER JOIN civicrm_custom_group cg ON cg.id = cf.custom_group_id | |
1974 | LEFT JOIN civicrm_option_value ov ON cf.option_group_id = ov.option_group_id | |
1975 | WHERE cg.extends IN ('" . implode("','", $this->_customGroupExtends) . "') AND | |
1976 | cg.is_active = 1 AND | |
1977 | cf.is_active = 1 AND | |
1978 | cf.is_searchable = 1 AND | |
1979 | cf.data_type NOT IN ('ContactReference', 'Date') AND | |
1980 | cf.id IN (" . implode(",", $customFieldIds) . ")"; | |
1981 | ||
1982 | $dao = CRM_Core_DAO::executeQuery($query); | |
1983 | while ($dao->fetch()) { | |
1984 | foreach ($customFieldCols as $key) { | |
9d72cede EM |
1985 | $customFields[$dao->table_name . '_custom_' . |
1986 | $dao->id][$key] = $dao->$key; | |
6a488035 TO |
1987 | } |
1988 | if ($dao->option_group_id) { | |
1989 | $fieldValueMap[$dao->option_group_id][$dao->value] = $dao->label; | |
1990 | } | |
1991 | } | |
1992 | $dao->free(); | |
1993 | ||
1994 | $entryFound = FALSE; | |
1995 | foreach ($rows as $rowNum => $row) { | |
1996 | foreach ($row as $tableCol => $val) { | |
1997 | if (array_key_exists($tableCol, $customFields)) { | |
1998 | $rows[$rowNum][$tableCol] = $this->formatCustomValues($val, $customFields[$tableCol], $fieldValueMap); | |
1999 | $entryFound = TRUE; | |
2000 | } | |
2001 | } | |
2002 | ||
2003 | // skip looking further in rows, if first row itself doesn't | |
2004 | // have the column we need | |
2005 | if (!$entryFound) { | |
2006 | break; | |
2007 | } | |
2008 | } | |
2009 | } | |
2010 | ||
74cf4551 | 2011 | /** |
317a8023 | 2012 | * Format custom values. |
2013 | * | |
2014 | * @param mixed $value | |
2015 | * @param array $customField | |
2016 | * @param array $fieldValueMap | |
74cf4551 | 2017 | * |
971d41b1 | 2018 | * @return float|string|void |
74cf4551 | 2019 | */ |
00be9182 | 2020 | public function formatCustomValues($value, $customField, $fieldValueMap) { |
6a488035 | 2021 | if (CRM_Utils_System::isNull($value)) { |
bed98343 | 2022 | return NULL; |
6a488035 TO |
2023 | } |
2024 | ||
2025 | $htmlType = $customField['html_type']; | |
2026 | ||
2027 | switch ($customField['data_type']) { | |
2028 | case 'Boolean': | |
2029 | if ($value == '1') { | |
2030 | $retValue = ts('Yes'); | |
2031 | } | |
2032 | else { | |
2033 | $retValue = ts('No'); | |
2034 | } | |
2035 | break; | |
2036 | ||
2037 | case 'Link': | |
2038 | $retValue = CRM_Utils_System::formatWikiURL($value); | |
2039 | break; | |
2040 | ||
2041 | case 'File': | |
2042 | $retValue = $value; | |
2043 | break; | |
2044 | ||
2045 | case 'Memo': | |
2046 | $retValue = $value; | |
2047 | break; | |
2048 | ||
2049 | case 'Float': | |
2050 | if ($htmlType == 'Text') { | |
9d72cede | 2051 | $retValue = (float) $value; |
6a488035 TO |
2052 | break; |
2053 | } | |
2054 | case 'Money': | |
2055 | if ($htmlType == 'Text') { | |
6a488035 TO |
2056 | $retValue = CRM_Utils_Money::format($value, NULL, '%a'); |
2057 | break; | |
2058 | } | |
2059 | case 'String': | |
2060 | case 'Int': | |
2061 | if (in_array($htmlType, array( | |
9d72cede | 2062 | 'Text', |
21dfd5f5 | 2063 | 'TextArea', |
9d72cede | 2064 | ))) { |
6a488035 TO |
2065 | $retValue = $value; |
2066 | break; | |
2067 | } | |
2068 | case 'StateProvince': | |
2069 | case 'Country': | |
2070 | ||
2071 | switch ($htmlType) { | |
2072 | case 'Multi-Select Country': | |
2073 | $value = explode(CRM_Core_DAO::VALUE_SEPARATOR, $value); | |
2074 | $customData = array(); | |
2075 | foreach ($value as $val) { | |
2076 | if ($val) { | |
2077 | $customData[] = CRM_Core_PseudoConstant::country($val, FALSE); | |
2078 | } | |
2079 | } | |
2080 | $retValue = implode(', ', $customData); | |
2081 | break; | |
2082 | ||
2083 | case 'Select Country': | |
2084 | $retValue = CRM_Core_PseudoConstant::country($value, FALSE); | |
2085 | break; | |
2086 | ||
2087 | case 'Select State/Province': | |
2088 | $retValue = CRM_Core_PseudoConstant::stateProvince($value, FALSE); | |
2089 | break; | |
2090 | ||
2091 | case 'Multi-Select State/Province': | |
2092 | $value = explode(CRM_Core_DAO::VALUE_SEPARATOR, $value); | |
2093 | $customData = array(); | |
2094 | foreach ($value as $val) { | |
2095 | if ($val) { | |
2096 | $customData[] = CRM_Core_PseudoConstant::stateProvince($val, FALSE); | |
2097 | } | |
2098 | } | |
2099 | $retValue = implode(', ', $customData); | |
2100 | break; | |
2101 | ||
2102 | case 'Select': | |
2103 | case 'Radio': | |
2104 | case 'Autocomplete-Select': | |
2105 | $retValue = $fieldValueMap[$customField['option_group_id']][$value]; | |
2106 | break; | |
2107 | ||
2108 | case 'CheckBox': | |
2109 | case 'AdvMulti-Select': | |
2110 | case 'Multi-Select': | |
2111 | $value = explode(CRM_Core_DAO::VALUE_SEPARATOR, $value); | |
2112 | $customData = array(); | |
2113 | foreach ($value as $val) { | |
2114 | if ($val) { | |
2115 | $customData[] = $fieldValueMap[$customField['option_group_id']][$val]; | |
2116 | } | |
2117 | } | |
2118 | $retValue = implode(', ', $customData); | |
2119 | break; | |
2120 | ||
2121 | default: | |
2122 | $retValue = $value; | |
2123 | } | |
2124 | break; | |
2125 | ||
2126 | default: | |
2127 | $retValue = $value; | |
2128 | } | |
2129 | ||
2130 | return $retValue; | |
2131 | } | |
2132 | ||
74cf4551 | 2133 | /** |
317a8023 | 2134 | * Remove duplicate rows. |
2135 | * | |
2136 | * @param array $rows | |
74cf4551 | 2137 | */ |
00be9182 | 2138 | public function removeDuplicates(&$rows) { |
6a488035 TO |
2139 | if (empty($this->_noRepeats)) { |
2140 | return; | |
2141 | } | |
2142 | $checkList = array(); | |
2143 | ||
2144 | foreach ($rows as $key => $list) { | |
2145 | foreach ($list as $colName => $colVal) { | |
8f1445ea | 2146 | if (array_key_exists($colName, $checkList) && |
9d72cede EM |
2147 | $checkList[$colName] == $colVal |
2148 | ) { | |
6a488035 TO |
2149 | $rows[$key][$colName] = ""; |
2150 | } | |
2151 | if (in_array($colName, $this->_noRepeats)) { | |
2152 | $checkList[$colName] = $colVal; | |
2153 | } | |
2154 | } | |
2155 | } | |
2156 | } | |
2157 | ||
74cf4551 | 2158 | /** |
317a8023 | 2159 | * Fix subtotal display. |
2160 | * | |
2161 | * @param array $row | |
2162 | * @param array $fields | |
74cf4551 EM |
2163 | * @param bool $subtotal |
2164 | */ | |
00be9182 | 2165 | public function fixSubTotalDisplay(&$row, $fields, $subtotal = TRUE) { |
6a488035 TO |
2166 | foreach ($row as $colName => $colVal) { |
2167 | if (in_array($colName, $fields)) { | |
6a488035 TO |
2168 | } |
2169 | elseif (isset($this->_columnHeaders[$colName])) { | |
2170 | if ($subtotal) { | |
2171 | $row[$colName] = "Subtotal"; | |
2172 | $subtotal = FALSE; | |
2173 | } | |
2174 | else { | |
2175 | unset($row[$colName]); | |
2176 | } | |
2177 | } | |
2178 | } | |
2179 | } | |
2180 | ||
74cf4551 | 2181 | /** |
317a8023 | 2182 | * Calculate grant total. |
2183 | * | |
2184 | * @param array $rows | |
74cf4551 EM |
2185 | * |
2186 | * @return bool | |
2187 | */ | |
00be9182 | 2188 | public function grandTotal(&$rows) { |
6a488035 TO |
2189 | if (!$this->_rollup || ($this->_rollup == '') || |
2190 | ($this->_limit && count($rows) >= self::ROW_COUNT_LIMIT) | |
2191 | ) { | |
2192 | return FALSE; | |
2193 | } | |
2194 | $lastRow = array_pop($rows); | |
2195 | ||
6a488035 TO |
2196 | foreach ($this->_columnHeaders as $fld => $val) { |
2197 | if (!in_array($fld, $this->_statFields)) { | |
2198 | if (!$this->_grandFlag) { | |
2199 | $lastRow[$fld] = "Grand Total"; | |
2200 | $this->_grandFlag = TRUE; | |
2201 | } | |
2202 | else { | |
2203 | $lastRow[$fld] = ""; | |
2204 | } | |
2205 | } | |
2206 | } | |
2207 | ||
2208 | $this->assign('grandStat', $lastRow); | |
2209 | return TRUE; | |
2210 | } | |
2211 | ||
74cf4551 | 2212 | /** |
317a8023 | 2213 | * Format display output. |
2214 | * | |
2215 | * @param array $rows | |
74cf4551 EM |
2216 | * @param bool $pager |
2217 | */ | |
00be9182 | 2218 | public function formatDisplay(&$rows, $pager = TRUE) { |
6a488035 TO |
2219 | // set pager based on if any limit was applied in the query. |
2220 | if ($pager) { | |
2221 | $this->setPager(); | |
2222 | } | |
2223 | ||
2224 | // allow building charts if any | |
2225 | if (!empty($this->_params['charts']) && !empty($rows)) { | |
2226 | $this->buildChart($rows); | |
2227 | $this->assign('chartEnabled', TRUE); | |
9d72cede EM |
2228 | $this->_chartId = "{$this->_params['charts']}_" . |
2229 | ($this->_id ? $this->_id : substr(get_class($this), 16)) . '_' . | |
2230 | session_id(); | |
6a488035 TO |
2231 | $this->assign('chartId', $this->_chartId); |
2232 | } | |
2233 | ||
2234 | // unset columns not to be displayed. | |
2235 | foreach ($this->_columnHeaders as $key => $value) { | |
a7488080 | 2236 | if (!empty($value['no_display'])) { |
6a488035 TO |
2237 | unset($this->_columnHeaders[$key]); |
2238 | } | |
2239 | } | |
2240 | ||
2241 | // unset columns not to be displayed. | |
2242 | if (!empty($rows)) { | |
2243 | foreach ($this->_noDisplay as $noDisplayField) { | |
2244 | foreach ($rows as $rowNum => $row) { | |
2245 | unset($this->_columnHeaders[$noDisplayField]); | |
2246 | } | |
2247 | } | |
2248 | } | |
2249 | ||
2250 | // build array of section totals | |
2251 | $this->sectionTotals(); | |
2252 | ||
2253 | // process grand-total row | |
2254 | $this->grandTotal($rows); | |
2255 | ||
2256 | // use this method for formatting rows for display purpose. | |
2257 | $this->alterDisplay($rows); | |
2258 | CRM_Utils_Hook::alterReportVar('rows', $rows, $this); | |
2259 | ||
2260 | // use this method for formatting custom rows for display purpose. | |
2261 | $this->alterCustomDataDisplay($rows); | |
2262 | } | |
2263 | ||
74cf4551 | 2264 | /** |
317a8023 | 2265 | * Build chart. |
2266 | * | |
2267 | * @param array $rows | |
74cf4551 | 2268 | */ |
00be9182 | 2269 | public function buildChart(&$rows) { |
6a488035 TO |
2270 | // override this method for building charts. |
2271 | } | |
2272 | ||
2273 | // select() method below has been added recently (v3.3), and many of the report templates might | |
2274 | // still be having their own select() method. We should fix them as and when encountered and move | |
2275 | // towards generalizing the select() method below. | |
971d41b1 CW |
2276 | |
2277 | /** | |
317a8023 | 2278 | * Generate the SELECT clause and set class variable $_select. |
971d41b1 | 2279 | */ |
00be9182 | 2280 | public function select() { |
1f220d30 | 2281 | $select = $this->_selectAliases = array(); |
6a488035 TO |
2282 | |
2283 | foreach ($this->_columns as $tableName => $table) { | |
2284 | if (array_key_exists('fields', $table)) { | |
2285 | foreach ($table['fields'] as $fieldName => $field) { | |
2286 | if ($tableName == 'civicrm_address') { | |
2287 | $this->_addressField = TRUE; | |
2288 | } | |
2289 | if ($tableName == 'civicrm_email') { | |
2290 | $this->_emailField = TRUE; | |
2291 | } | |
2292 | if ($tableName == 'civicrm_phone') { | |
2293 | $this->_phoneField = TRUE; | |
2294 | } | |
2295 | ||
9d72cede EM |
2296 | if (!empty($field['required']) || |
2297 | !empty($this->_params['fields'][$fieldName]) | |
2298 | ) { | |
6a488035 TO |
2299 | |
2300 | // 1. In many cases we want select clause to be built in slightly different way | |
317a8023 | 2301 | // for a particular field of a particular type. |
6a488035 | 2302 | // 2. This method when used should receive params by reference and modify $this->_columnHeaders |
317a8023 | 2303 | // as needed. |
6a488035 TO |
2304 | $selectClause = $this->selectClause($tableName, 'fields', $fieldName, $field); |
2305 | if ($selectClause) { | |
2306 | $select[] = $selectClause; | |
2307 | continue; | |
2308 | } | |
2309 | ||
2310 | // include statistics columns only if set | |
a7488080 | 2311 | if (!empty($field['statistics'])) { |
6a488035 TO |
2312 | foreach ($field['statistics'] as $stat => $label) { |
2313 | $alias = "{$tableName}_{$fieldName}_{$stat}"; | |
2314 | switch (strtolower($stat)) { | |
2315 | case 'max': | |
2316 | case 'sum': | |
2317 | $select[] = "$stat({$field['dbAlias']}) as $alias"; | |
2318 | $this->_columnHeaders["{$tableName}_{$fieldName}_{$stat}"]['title'] = $label; | |
2319 | $this->_columnHeaders["{$tableName}_{$fieldName}_{$stat}"]['type'] = $field['type']; | |
9e6d7767 | 2320 | $this->_statFields[$label] = $alias; |
6a488035 TO |
2321 | $this->_selectAliases[] = $alias; |
2322 | break; | |
2323 | ||
2324 | case 'count': | |
2325 | $select[] = "COUNT({$field['dbAlias']}) as $alias"; | |
2326 | $this->_columnHeaders["{$tableName}_{$fieldName}_{$stat}"]['title'] = $label; | |
2327 | $this->_columnHeaders["{$tableName}_{$fieldName}_{$stat}"]['type'] = CRM_Utils_Type::T_INT; | |
9e6d7767 | 2328 | $this->_statFields[$label] = $alias; |
6a488035 TO |
2329 | $this->_selectAliases[] = $alias; |
2330 | break; | |
2331 | ||
1bfaf6a6 DS |
2332 | case 'count_distinct': |
2333 | $select[] = "COUNT(DISTINCT {$field['dbAlias']}) as $alias"; | |
2334 | $this->_columnHeaders["{$tableName}_{$fieldName}_{$stat}"]['title'] = $label; | |
2335 | $this->_columnHeaders["{$tableName}_{$fieldName}_{$stat}"]['type'] = CRM_Utils_Type::T_INT; | |
2336 | $this->_statFields[$label] = $alias; | |
2337 | $this->_selectAliases[] = $alias; | |
2338 | break; | |
2339 | ||
6a488035 TO |
2340 | case 'avg': |
2341 | $select[] = "ROUND(AVG({$field['dbAlias']}),2) as $alias"; | |
2342 | $this->_columnHeaders["{$tableName}_{$fieldName}_{$stat}"]['title'] = $label; | |
2343 | $this->_columnHeaders["{$tableName}_{$fieldName}_{$stat}"]['type'] = $field['type']; | |
9e6d7767 | 2344 | $this->_statFields[$label] = $alias; |
6a488035 TO |
2345 | $this->_selectAliases[] = $alias; |
2346 | break; | |
2347 | } | |
2348 | } | |
2349 | } | |
2350 | else { | |
2351 | $alias = "{$tableName}_{$fieldName}"; | |
2352 | $select[] = "{$field['dbAlias']} as $alias"; | |
2353 | $this->_columnHeaders["{$tableName}_{$fieldName}"]['title'] = CRM_Utils_Array::value('title', $field); | |
2354 | $this->_columnHeaders["{$tableName}_{$fieldName}"]['type'] = CRM_Utils_Array::value('type', $field); | |
2355 | $this->_selectAliases[] = $alias; | |
2356 | } | |
2357 | } | |
2358 | } | |
2359 | } | |
2360 | ||
2361 | // select for group bys | |
2362 | if (array_key_exists('group_bys', $table)) { | |
2363 | foreach ($table['group_bys'] as $fieldName => $field) { | |
2364 | ||
2365 | if ($tableName == 'civicrm_address') { | |
2366 | $this->_addressField = TRUE; | |
2367 | } | |
2368 | if ($tableName == 'civicrm_email') { | |
2369 | $this->_emailField = TRUE; | |
2370 | } | |
2371 | if ($tableName == 'civicrm_phone') { | |
2372 | $this->_phoneField = TRUE; | |
2373 | } | |
2374 | // 1. In many cases we want select clause to be built in slightly different way | |
317a8023 | 2375 | // for a particular field of a particular type. |
6a488035 | 2376 | // 2. This method when used should receive params by reference and modify $this->_columnHeaders |
317a8023 | 2377 | // as needed. |
6a488035 TO |
2378 | $selectClause = $this->selectClause($tableName, 'group_bys', $fieldName, $field); |
2379 | if ($selectClause) { | |
2380 | $select[] = $selectClause; | |
2381 | continue; | |
2382 | } | |
2383 | ||
9d72cede EM |
2384 | if (!empty($this->_params['group_bys']) && |
2385 | !empty($this->_params['group_bys'][$fieldName]) && | |
2386 | !empty($this->_params['group_bys_freq']) | |
2387 | ) { | |
6a488035 TO |
2388 | switch (CRM_Utils_Array::value($fieldName, $this->_params['group_bys_freq'])) { |
2389 | case 'YEARWEEK': | |
9d72cede EM |
2390 | $select[] = "DATE_SUB({$field['dbAlias']}, INTERVAL WEEKDAY({$field['dbAlias']}) DAY) AS {$tableName}_{$fieldName}_start"; |
2391 | $select[] = "YEARWEEK({$field['dbAlias']}) AS {$tableName}_{$fieldName}_subtotal"; | |
2392 | $select[] = "WEEKOFYEAR({$field['dbAlias']}) AS {$tableName}_{$fieldName}_interval"; | |
6a488035 TO |
2393 | $field['title'] = 'Week'; |
2394 | break; | |
2395 | ||
2396 | case 'YEAR': | |
9d72cede EM |
2397 | $select[] = "MAKEDATE(YEAR({$field['dbAlias']}), 1) AS {$tableName}_{$fieldName}_start"; |
2398 | $select[] = "YEAR({$field['dbAlias']}) AS {$tableName}_{$fieldName}_subtotal"; | |
2399 | $select[] = "YEAR({$field['dbAlias']}) AS {$tableName}_{$fieldName}_interval"; | |
6a488035 TO |
2400 | $field['title'] = 'Year'; |
2401 | break; | |
2402 | ||
2403 | case 'MONTH': | |
9d72cede EM |
2404 | $select[] = "DATE_SUB({$field['dbAlias']}, INTERVAL (DAYOFMONTH({$field['dbAlias']})-1) DAY) as {$tableName}_{$fieldName}_start"; |
2405 | $select[] = "MONTH({$field['dbAlias']}) AS {$tableName}_{$fieldName}_subtotal"; | |
2406 | $select[] = "MONTHNAME({$field['dbAlias']}) AS {$tableName}_{$fieldName}_interval"; | |
6a488035 TO |
2407 | $field['title'] = 'Month'; |
2408 | break; | |
2409 | ||
2410 | case 'QUARTER': | |
9d72cede EM |
2411 | $select[] = "STR_TO_DATE(CONCAT( 3 * QUARTER( {$field['dbAlias']} ) -2 , '/', '1', '/', YEAR( {$field['dbAlias']} ) ), '%m/%d/%Y') AS {$tableName}_{$fieldName}_start"; |
2412 | $select[] = "QUARTER({$field['dbAlias']}) AS {$tableName}_{$fieldName}_subtotal"; | |
2413 | $select[] = "QUARTER({$field['dbAlias']}) AS {$tableName}_{$fieldName}_interval"; | |
6a488035 TO |
2414 | $field['title'] = 'Quarter'; |
2415 | break; | |
2416 | } | |
2417 | // for graphs and charts - | |
a7488080 | 2418 | if (!empty($this->_params['group_bys_freq'][$fieldName])) { |
6a488035 | 2419 | $this->_interval = $field['title']; |
971d41b1 CW |
2420 | $this->_columnHeaders["{$tableName}_{$fieldName}_start"]['title'] |
2421 | = $field['title'] . ' Beginning'; | |
6a488035 TO |
2422 | $this->_columnHeaders["{$tableName}_{$fieldName}_start"]['type'] = $field['type']; |
2423 | $this->_columnHeaders["{$tableName}_{$fieldName}_start"]['group_by'] = $this->_params['group_bys_freq'][$fieldName]; | |
2424 | ||
7d7c50f9 | 2425 | // just to make sure these values are transferred to rows. |
6a488035 TO |
2426 | // since we 'll need them for calculation purpose, |
2427 | // e.g making subtotals look nicer or graphs | |
2428 | $this->_columnHeaders["{$tableName}_{$fieldName}_interval"] = array('no_display' => TRUE); | |
2429 | $this->_columnHeaders["{$tableName}_{$fieldName}_subtotal"] = array('no_display' => TRUE); | |
2430 | } | |
2431 | } | |
2432 | } | |
2433 | } | |
2434 | } | |
2435 | ||
1f220d30 | 2436 | $this->_selectClauses = $select; |
6a488035 TO |
2437 | $this->_select = "SELECT " . implode(', ', $select) . " "; |
2438 | } | |
2439 | ||
74cf4551 | 2440 | /** |
317a8023 | 2441 | * Build select clause for a single field. |
2442 | * | |
100fef9d | 2443 | * @param string $tableName |
317a8023 | 2444 | * @param string $tableKey |
100fef9d | 2445 | * @param string $fieldName |
317a8023 | 2446 | * @param string $field |
74cf4551 EM |
2447 | * |
2448 | * @return bool | |
2449 | */ | |
00be9182 | 2450 | public function selectClause(&$tableName, $tableKey, &$fieldName, &$field) { |
6a488035 TO |
2451 | return FALSE; |
2452 | } | |
2453 | ||
317a8023 | 2454 | /** |
2455 | * Build where clause. | |
2456 | */ | |
00be9182 | 2457 | public function where() { |
adfe2750 | 2458 | $this->storeWhereHavingClauseArray(); |
2459 | ||
2460 | if (empty($this->_whereClauses)) { | |
2461 | $this->_where = "WHERE ( 1 ) "; | |
2462 | $this->_having = ""; | |
2463 | } | |
2464 | else { | |
2465 | $this->_where = "WHERE " . implode(' AND ', $this->_whereClauses); | |
2466 | } | |
2467 | ||
2468 | if ($this->_aclWhere) { | |
2469 | $this->_where .= " AND {$this->_aclWhere} "; | |
2470 | } | |
2471 | ||
2472 | if (!empty($this->_havingClauses)) { | |
2473 | // use this clause to construct group by clause. | |
2474 | $this->_having = "HAVING " . implode(' AND ', $this->_havingClauses); | |
2475 | } | |
2476 | } | |
2477 | ||
2478 | /** | |
317a8023 | 2479 | * Store Where clauses into an array. |
2480 | * | |
2481 | * Breaking out this step makes over-riding more flexible as the clauses can be used in constructing a | |
adfe2750 | 2482 | * temp table that may not be part of the final where clause or added |
2483 | * in other functions | |
2484 | */ | |
00be9182 | 2485 | public function storeWhereHavingClauseArray() { |
6a488035 TO |
2486 | foreach ($this->_columns as $tableName => $table) { |
2487 | if (array_key_exists('filters', $table)) { | |
2488 | foreach ($table['filters'] as $fieldName => $field) { | |
d12de91c | 2489 | // respect pseudofield to filter spec so fields can be marked as |
2490 | // not to be handled here | |
9d72cede | 2491 | if (!empty($field['pseudofield'])) { |
d12de91c | 2492 | continue; |
2493 | } | |
6a488035 TO |
2494 | $clause = NULL; |
2495 | if (CRM_Utils_Array::value('type', $field) & CRM_Utils_Type::T_DATE) { | |
9d72cede EM |
2496 | if (CRM_Utils_Array::value('operatorType', $field) == |
2497 | CRM_Report_Form::OP_MONTH | |
2498 | ) { | |
6a488035 TO |
2499 | $op = CRM_Utils_Array::value("{$fieldName}_op", $this->_params); |
2500 | $value = CRM_Utils_Array::value("{$fieldName}_value", $this->_params); | |
2501 | if (is_array($value) && !empty($value)) { | |
971d41b1 CW |
2502 | $clause |
2503 | = "(month({$field['dbAlias']}) $op (" . implode(', ', $value) . | |
9d72cede | 2504 | '))'; |
6a488035 TO |
2505 | } |
2506 | } | |
2507 | else { | |
2508 | $relative = CRM_Utils_Array::value("{$fieldName}_relative", $this->_params); | |
9d72cede EM |
2509 | $from = CRM_Utils_Array::value("{$fieldName}_from", $this->_params); |
2510 | $to = CRM_Utils_Array::value("{$fieldName}_to", $this->_params); | |
6a488035 | 2511 | $fromTime = CRM_Utils_Array::value("{$fieldName}_from_time", $this->_params); |
9d72cede EM |
2512 | $toTime = CRM_Utils_Array::value("{$fieldName}_to_time", $this->_params); |
2513 | $clause = $this->dateClause($field['dbAlias'], $relative, $from, $to, $field['type'], $fromTime, $toTime); | |
6a488035 TO |
2514 | } |
2515 | } | |
2516 | else { | |
2517 | $op = CRM_Utils_Array::value("{$fieldName}_op", $this->_params); | |
2518 | if ($op) { | |
2519 | $clause = $this->whereClause($field, | |
adfe2750 | 2520 | $op, |
2521 | CRM_Utils_Array::value("{$fieldName}_value", $this->_params), | |
2522 | CRM_Utils_Array::value("{$fieldName}_min", $this->_params), | |
2523 | CRM_Utils_Array::value("{$fieldName}_max", $this->_params) | |
6a488035 TO |
2524 | ); |
2525 | } | |
2526 | } | |
2527 | ||
2528 | if (!empty($clause)) { | |
a7488080 | 2529 | if (!empty($field['having'])) { |
adfe2750 | 2530 | $this->_havingClauses[] = $clause; |
6a488035 TO |
2531 | } |
2532 | else { | |
adfe2750 | 2533 | $this->_whereClauses[] = $clause; |
6a488035 TO |
2534 | } |
2535 | } | |
2536 | } | |
2537 | } | |
2538 | } | |
2539 | ||
6a488035 | 2540 | } |
9d72cede | 2541 | |
317a8023 | 2542 | /** |
2543 | * Set output mode. | |
2544 | */ | |
00be9182 | 2545 | public function processReportMode() { |
6a488035 TO |
2546 | $buttonName = $this->controller->getButtonName(); |
2547 | ||
884605ca DL |
2548 | $output = CRM_Utils_Request::retrieve( |
2549 | 'output', | |
2550 | 'String', | |
2551 | CRM_Core_DAO::$_nullObject | |
6a488035 TO |
2552 | ); |
2553 | ||
971d41b1 CW |
2554 | $this->_sendmail |
2555 | = CRM_Utils_Request::retrieve( | |
884605ca DL |
2556 | 'sendmail', |
2557 | 'Boolean', | |
2558 | CRM_Core_DAO::$_nullObject | |
2559 | ); | |
6a488035 TO |
2560 | |
2561 | $this->_absoluteUrl = FALSE; | |
2562 | $printOnly = FALSE; | |
2563 | $this->assign('printOnly', FALSE); | |
2564 | ||
9d72cede EM |
2565 | if ($this->_printButtonName == $buttonName || $output == 'print' || |
2566 | ($this->_sendmail && !$output) | |
2567 | ) { | |
6a488035 TO |
2568 | $this->assign('printOnly', TRUE); |
2569 | $printOnly = TRUE; | |
2570 | $this->assign('outputMode', 'print'); | |
2571 | $this->_outputMode = 'print'; | |
2572 | if ($this->_sendmail) { | |
2573 | $this->_absoluteUrl = TRUE; | |
9d72cede | 2574 | } |
6a488035 TO |
2575 | } |
2576 | elseif ($this->_pdfButtonName == $buttonName || $output == 'pdf') { | |
2577 | $this->assign('printOnly', TRUE); | |
2578 | $printOnly = TRUE; | |
2579 | $this->assign('outputMode', 'pdf'); | |
2580 | $this->_outputMode = 'pdf'; | |
2581 | $this->_absoluteUrl = TRUE; | |
2582 | } | |
2583 | elseif ($this->_csvButtonName == $buttonName || $output == 'csv') { | |
2584 | $this->assign('printOnly', TRUE); | |
2585 | $printOnly = TRUE; | |
2586 | $this->assign('outputMode', 'csv'); | |
2587 | $this->_outputMode = 'csv'; | |
2588 | $this->_absoluteUrl = TRUE; | |
2589 | } | |
2590 | elseif ($this->_groupButtonName == $buttonName || $output == 'group') { | |
2591 | $this->assign('outputMode', 'group'); | |
2592 | $this->_outputMode = 'group'; | |
2593 | } | |
2594 | elseif ($output == 'create_report' && $this->_criteriaForm) { | |
2595 | $this->assign('outputMode', 'create_report'); | |
2596 | $this->_outputMode = 'create_report'; | |
2597 | } | |
2598 | else { | |
2599 | $this->assign('outputMode', 'html'); | |
2600 | $this->_outputMode = 'html'; | |
2601 | } | |
2602 | ||
2603 | // Get today's date to include in printed reports | |
2604 | if ($printOnly) { | |
2605 | $reportDate = CRM_Utils_Date::customFormat(date('Y-m-d H:i')); | |
2606 | $this->assign('reportDate', $reportDate); | |
2607 | } | |
2608 | } | |
2609 | ||
9657ccf2 | 2610 | /** |
317a8023 | 2611 | * Post Processing function for Form. |
2612 | * | |
2613 | * postProcessCommon should be used to set other variables from input as the api accesses that function. | |
9657ccf2 | 2614 | */ |
00be9182 | 2615 | public function beginPostProcess() { |
c58f66e0 | 2616 | $this->setParams($this->controller->exportValues($this->_name)); |
6a488035 TO |
2617 | |
2618 | if (empty($this->_params) && | |
2619 | $this->_force | |
2620 | ) { | |
c58f66e0 | 2621 | $this->setParams($this->_formValues); |
6a488035 TO |
2622 | } |
2623 | ||
2624 | // hack to fix params when submitted from dashboard, CRM-8532 | |
2625 | // fields array is missing because form building etc is skipped | |
2626 | // in dashboard mode for report | |
c58f66e0 | 2627 | //@todo - this could be done in the dashboard no we have a setter |
a7488080 | 2628 | if (empty($this->_params['fields']) && !$this->_noFields) { |
c58f66e0 | 2629 | $this->setParams($this->_formValues); |
6a488035 TO |
2630 | } |
2631 | ||
2632 | $this->_formValues = $this->_params; | |
2633 | if (CRM_Core_Permission::check('administer Reports') && | |
2634 | isset($this->_id) && | |
9d72cede EM |
2635 | ($this->_instanceButtonName == |
2636 | $this->controller->getButtonName() . '_save' || | |
6a488035 TO |
2637 | $this->_chartButtonName == $this->controller->getButtonName() |
2638 | ) | |
2639 | ) { | |
2640 | $this->assign('updateReportButton', TRUE); | |
2641 | } | |
2642 | $this->processReportMode(); | |
c58f66e0 E |
2643 | $this->beginPostProcessCommon(); |
2644 | } | |
2645 | ||
2646 | /** | |
317a8023 | 2647 | * BeginPostProcess function run in both report mode and non-report mode (api). |
c58f66e0 | 2648 | */ |
317a8023 | 2649 | public function beginPostProcessCommon() {} |
6a488035 | 2650 | |
74cf4551 | 2651 | /** |
317a8023 | 2652 | * Build the report query. |
2653 | * | |
74cf4551 EM |
2654 | * @param bool $applyLimit |
2655 | * | |
2656 | * @return string | |
2657 | */ | |
00be9182 | 2658 | public function buildQuery($applyLimit = TRUE) { |
6a488035 TO |
2659 | $this->select(); |
2660 | $this->from(); | |
2661 | $this->customDataFrom(); | |
2662 | $this->where(); | |
2663 | $this->groupBy(); | |
2664 | $this->orderBy(); | |
2665 | ||
2666 | // order_by columns not selected for display need to be included in SELECT | |
2667 | $unselectedSectionColumns = $this->unselectedSectionColumns(); | |
2668 | foreach ($unselectedSectionColumns as $alias => $section) { | |
2669 | $this->_select .= ", {$section['dbAlias']} as {$alias}"; | |
2670 | } | |
2671 | ||
8cc574cf | 2672 | if ($applyLimit && empty($this->_params['charts'])) { |
6a488035 TO |
2673 | $this->limit(); |
2674 | } | |
2675 | CRM_Utils_Hook::alterReportVar('sql', $this, $this); | |
2676 | ||
2677 | $sql = "{$this->_select} {$this->_from} {$this->_where} {$this->_groupBy} {$this->_having} {$this->_orderBy} {$this->_limit}"; | |
2678 | return $sql; | |
2679 | } | |
2680 | ||
317a8023 | 2681 | /** |
2682 | * Build group by clause. | |
2683 | */ | |
00be9182 | 2684 | public function groupBy() { |
6a488035 | 2685 | $groupBys = array(); |
c8ce0d6a | 2686 | if (is_array($this->_params['group_bys']) && |
6a488035 TO |
2687 | !empty($this->_params['group_bys']) |
2688 | ) { | |
2689 | foreach ($this->_columns as $tableName => $table) { | |
2690 | if (array_key_exists('group_bys', $table)) { | |
2691 | foreach ($table['group_bys'] as $fieldName => $field) { | |
a7488080 | 2692 | if (!empty($this->_params['group_bys'][$fieldName])) { |
6a488035 TO |
2693 | $groupBys[] = $field['dbAlias']; |
2694 | } | |
2695 | } | |
2696 | } | |
2697 | } | |
2698 | } | |
2699 | ||
2700 | if (!empty($groupBys)) { | |
2701 | $this->_groupBy = "GROUP BY " . implode(', ', $groupBys); | |
2702 | } | |
2703 | } | |
2704 | ||
317a8023 | 2705 | /** |
2706 | * Build order by clause. | |
2707 | */ | |
00be9182 | 2708 | public function orderBy() { |
9d72cede | 2709 | $this->_orderBy = ""; |
6a488035 TO |
2710 | $this->_sections = array(); |
2711 | $this->storeOrderByArray(); | |
9d72cede | 2712 | if (!empty($this->_orderByArray) && !$this->_rollup == 'WITH ROLLUP') { |
6a488035 TO |
2713 | $this->_orderBy = "ORDER BY " . implode(', ', $this->_orderByArray); |
2714 | } | |
2715 | $this->assign('sections', $this->_sections); | |
2716 | } | |
f2947aea | 2717 | |
688d37c6 | 2718 | /** |
317a8023 | 2719 | * Extract order by fields and store as an array. |
2720 | * | |
6a488035 TO |
2721 | * In some cases other functions want to know which fields are selected for ordering by |
2722 | * Separating this into a separate function allows it to be called separately from constructing | |
2723 | * the order by clause | |
2724 | */ | |
00be9182 | 2725 | public function storeOrderByArray() { |
9d72cede | 2726 | $orderBys = array(); |
6a488035 | 2727 | |
a7488080 | 2728 | if (!empty($this->_params['order_bys']) && |
6a488035 TO |
2729 | is_array($this->_params['order_bys']) && |
2730 | !empty($this->_params['order_bys']) | |
2731 | ) { | |
2732 | ||
9907633b | 2733 | // Process order_bys in user-specified order |
6a488035 TO |
2734 | foreach ($this->_params['order_bys'] as $orderBy) { |
2735 | $orderByField = array(); | |
2736 | foreach ($this->_columns as $tableName => $table) { | |
2737 | if (array_key_exists('order_bys', $table)) { | |
2738 | // For DAO columns defined in $this->_columns | |
2739 | $fields = $table['order_bys']; | |
2740 | } | |
2741 | elseif (array_key_exists('extends', $table)) { | |
2742 | // For custom fields referenced in $this->_customGroupExtends | |
1efec7ff | 2743 | $fields = CRM_Utils_Array::value('fields', $table, array()); |
6a488035 | 2744 | } |
6f993086 AH |
2745 | else { |
2746 | continue; | |
2747 | } | |
6a488035 TO |
2748 | if (!empty($fields) && is_array($fields)) { |
2749 | foreach ($fields as $fieldName => $field) { | |
2750 | if ($fieldName == $orderBy['column']) { | |
f2947aea | 2751 | $orderByField = array_merge($field, $orderBy); |
6a488035 TO |
2752 | $orderByField['tplField'] = "{$tableName}_{$fieldName}"; |
2753 | break 2; | |
2754 | } | |
2755 | } | |
2756 | } | |
2757 | } | |
2758 | ||
2759 | if (!empty($orderByField)) { | |
f2947aea | 2760 | $this->_orderByFields[] = $orderByField; |
6a488035 TO |
2761 | $orderBys[] = "{$orderByField['dbAlias']} {$orderBy['order']}"; |
2762 | ||
2763 | // Record any section headers for assignment to the template | |
a7488080 | 2764 | if (!empty($orderBy['section'])) { |
b5801e1d | 2765 | $orderByField['pageBreak'] = CRM_Utils_Array::value('pageBreak', $orderBy); |
6a488035 TO |
2766 | $this->_sections[$orderByField['tplField']] = $orderByField; |
2767 | } | |
2768 | } | |
2769 | } | |
2770 | } | |
2771 | ||
2772 | $this->_orderByArray = $orderBys; | |
2773 | ||
2774 | $this->assign('sections', $this->_sections); | |
2775 | } | |
2776 | ||
74cf4551 | 2777 | /** |
317a8023 | 2778 | * Determine unselected columns. |
2779 | * | |
74cf4551 EM |
2780 | * @return array |
2781 | */ | |
00be9182 | 2782 | public function unselectedSectionColumns() { |
6a488035 TO |
2783 | $selectColumns = array(); |
2784 | foreach ($this->_columns as $tableName => $table) { | |
2785 | if (array_key_exists('fields', $table)) { | |
2786 | foreach ($table['fields'] as $fieldName => $field) { | |
9d72cede EM |
2787 | if (!empty($field['required']) || |
2788 | !empty($this->_params['fields'][$fieldName]) | |
2789 | ) { | |
6a488035 TO |
2790 | |
2791 | $selectColumns["{$tableName}_{$fieldName}"] = 1; | |
2792 | } | |
2793 | } | |
2794 | } | |
2795 | } | |
f2947aea | 2796 | |
6a488035 TO |
2797 | if (is_array($this->_sections)) { |
2798 | return array_diff_key($this->_sections, $selectColumns); | |
2799 | } | |
2800 | else { | |
2801 | return array(); | |
2802 | } | |
2803 | } | |
2804 | ||
74cf4551 | 2805 | /** |
317a8023 | 2806 | * Build output rows. |
2807 | * | |
2808 | * @param string $sql | |
2809 | * @param array $rows | |
74cf4551 | 2810 | */ |
00be9182 | 2811 | public function buildRows($sql, &$rows) { |
6a488035 TO |
2812 | $dao = CRM_Core_DAO::executeQuery($sql); |
2813 | if (!is_array($rows)) { | |
2814 | $rows = array(); | |
2815 | } | |
2816 | ||
2817 | // use this method to modify $this->_columnHeaders | |
2818 | $this->modifyColumnHeaders(); | |
2819 | ||
2820 | $unselectedSectionColumns = $this->unselectedSectionColumns(); | |
2821 | ||
2822 | while ($dao->fetch()) { | |
2823 | $row = array(); | |
2824 | foreach ($this->_columnHeaders as $key => $value) { | |
2825 | if (property_exists($dao, $key)) { | |
2826 | $row[$key] = $dao->$key; | |
2827 | } | |
2828 | } | |
2829 | ||
2830 | // section headers not selected for display need to be added to row | |
2831 | foreach ($unselectedSectionColumns as $key => $values) { | |
2832 | if (property_exists($dao, $key)) { | |
2833 | $row[$key] = $dao->$key; | |
2834 | } | |
2835 | } | |
2836 | ||
2837 | $rows[] = $row; | |
2838 | } | |
2839 | } | |
2840 | ||
2841 | /** | |
317a8023 | 2842 | * Calculate section totals. |
2843 | * | |
6a488035 TO |
2844 | * When "order by" fields are marked as sections, this assigns to the template |
2845 | * an array of total counts for each section. This data is used by the Smarty | |
317a8023 | 2846 | * plugin {sectionTotal}. |
6a488035 | 2847 | */ |
00be9182 | 2848 | public function sectionTotals() { |
6a488035 TO |
2849 | |
2850 | // Reports using order_bys with sections must populate $this->_selectAliases in select() method. | |
2851 | if (empty($this->_selectAliases)) { | |
2852 | return; | |
2853 | } | |
2854 | ||
2855 | if (!empty($this->_sections)) { | |
2856 | // build the query with no LIMIT clause | |
2857 | $select = str_ireplace('SELECT SQL_CALC_FOUND_ROWS ', 'SELECT ', $this->_select); | |
2858 | $sql = "{$select} {$this->_from} {$this->_where} {$this->_groupBy} {$this->_having} {$this->_orderBy}"; | |
2859 | ||
2860 | // pull section aliases out of $this->_sections | |
2861 | $sectionAliases = array_keys($this->_sections); | |
2862 | ||
2863 | $ifnulls = array(); | |
2864 | foreach (array_merge($sectionAliases, $this->_selectAliases) as $alias) { | |
2865 | $ifnulls[] = "ifnull($alias, '') as $alias"; | |
2866 | } | |
2867 | ||
971d41b1 CW |
2868 | // Group (un-limited) report by all aliases and get counts. This might |
2869 | // be done more efficiently when the contents of $sql are known, ie. by | |
2870 | // overriding this method in the report class. | |
6a488035 | 2871 | |
9d72cede EM |
2872 | $query = "select " . implode(", ", $ifnulls) . |
2873 | ", count(*) as ct from ($sql) as subquery group by " . | |
2874 | implode(", ", $sectionAliases); | |
6a488035 TO |
2875 | |
2876 | // initialize array of total counts | |
2877 | $totals = array(); | |
2878 | $dao = CRM_Core_DAO::executeQuery($query); | |
2879 | while ($dao->fetch()) { | |
2880 | ||
2881 | // let $this->_alterDisplay translate any integer ids to human-readable values. | |
2882 | $rows[0] = $dao->toArray(); | |
2883 | $this->alterDisplay($rows); | |
2884 | $row = $rows[0]; | |
2885 | ||
2886 | // add totals for all permutations of section values | |
9d72cede EM |
2887 | $values = array(); |
2888 | $i = 1; | |
6a488035 TO |
2889 | $aliasCount = count($sectionAliases); |
2890 | foreach ($sectionAliases as $alias) { | |
2891 | $values[] = $row[$alias]; | |
2892 | $key = implode(CRM_Core_DAO::VALUE_SEPARATOR, $values); | |
2893 | if ($i == $aliasCount) { | |
2894 | // the last alias is the lowest-level section header; use count as-is | |
2895 | $totals[$key] = $dao->ct; | |
2896 | } | |
2897 | else { | |
2898 | // other aliases are higher level; roll count into their total | |
2899 | $totals[$key] += $dao->ct; | |
2900 | } | |
2901 | } | |
2902 | } | |
2903 | $this->assign('sectionTotals', $totals); | |
2904 | } | |
2905 | } | |
2906 | ||
317a8023 | 2907 | /** |
2908 | * Modify column headers. | |
2909 | */ | |
00be9182 | 2910 | public function modifyColumnHeaders() { |
6a488035 TO |
2911 | // use this method to modify $this->_columnHeaders |
2912 | } | |
2913 | ||
74cf4551 | 2914 | /** |
317a8023 | 2915 | * Assign rows to the template. |
2916 | * | |
2917 | * @param array $rows | |
74cf4551 | 2918 | */ |
00be9182 | 2919 | public function doTemplateAssignment(&$rows) { |
6a488035 TO |
2920 | $this->assign_by_ref('columnHeaders', $this->_columnHeaders); |
2921 | $this->assign_by_ref('rows', $rows); | |
2922 | $this->assign('statistics', $this->statistics($rows)); | |
2923 | } | |
2924 | ||
74cf4551 | 2925 | /** |
317a8023 | 2926 | * Build report statistics. |
2927 | * | |
2928 | * Override this method to build your own statistics. | |
2929 | * | |
2930 | * @param array $rows | |
74cf4551 EM |
2931 | * |
2932 | * @return array | |
2933 | */ | |
00be9182 | 2934 | public function statistics(&$rows) { |
6a488035 TO |
2935 | $statistics = array(); |
2936 | ||
2937 | $count = count($rows); | |
2938 | ||
2939 | if ($this->_rollup && ($this->_rollup != '') && $this->_grandFlag) { | |
2940 | $count++; | |
2941 | } | |
2942 | ||
2943 | $this->countStat($statistics, $count); | |
2944 | ||
2945 | $this->groupByStat($statistics); | |
2946 | ||
2947 | $this->filterStat($statistics); | |
2948 | ||
2949 | return $statistics; | |
2950 | } | |
2951 | ||
74cf4551 | 2952 | /** |
317a8023 | 2953 | * Add count statistics. |
2954 | * | |
2955 | * @param array $statistics | |
2956 | * @param int $count | |
74cf4551 | 2957 | */ |
00be9182 | 2958 | public function countStat(&$statistics, $count) { |
9d72cede EM |
2959 | $statistics['counts']['rowCount'] = array( |
2960 | 'title' => ts('Row(s) Listed'), | |
2961 | 'value' => $count, | |
6a488035 TO |
2962 | ); |
2963 | ||
2964 | if ($this->_rowsFound && ($this->_rowsFound > $count)) { | |
9d72cede EM |
2965 | $statistics['counts']['rowsFound'] = array( |
2966 | 'title' => ts('Total Row(s)'), | |
2967 | 'value' => $this->_rowsFound, | |
6a488035 TO |
2968 | ); |
2969 | } | |
2970 | } | |
2971 | ||
74cf4551 | 2972 | /** |
317a8023 | 2973 | * Add group by statistics. |
2974 | * | |
2975 | * @param array $statistics | |
74cf4551 | 2976 | */ |
00be9182 | 2977 | public function groupByStat(&$statistics) { |
a7488080 | 2978 | if (!empty($this->_params['group_bys']) && |
6a488035 TO |
2979 | is_array($this->_params['group_bys']) && |
2980 | !empty($this->_params['group_bys']) | |
2981 | ) { | |
2982 | foreach ($this->_columns as $tableName => $table) { | |
2983 | if (array_key_exists('group_bys', $table)) { | |
2984 | foreach ($table['group_bys'] as $fieldName => $field) { | |
a7488080 | 2985 | if (!empty($this->_params['group_bys'][$fieldName])) { |
6a488035 TO |
2986 | $combinations[] = $field['title']; |
2987 | } | |
2988 | } | |
2989 | } | |
2990 | } | |
9d72cede EM |
2991 | $statistics['groups'][] = array( |
2992 | 'title' => ts('Grouping(s)'), | |
2993 | 'value' => implode(' & ', $combinations), | |
6a488035 TO |
2994 | ); |
2995 | } | |
2996 | } | |
2997 | ||
74cf4551 | 2998 | /** |
317a8023 | 2999 | * Filter statistics. |
3000 | * | |
3001 | * @param array $statistics | |
74cf4551 | 3002 | */ |
00be9182 | 3003 | public function filterStat(&$statistics) { |
6a488035 TO |
3004 | foreach ($this->_columns as $tableName => $table) { |
3005 | if (array_key_exists('filters', $table)) { | |
3006 | foreach ($table['filters'] as $fieldName => $field) { | |
9d72cede EM |
3007 | if (CRM_Utils_Array::value('type', $field) & CRM_Utils_Type::T_DATE && |
3008 | CRM_Utils_Array::value('operatorType', $field) != | |
3009 | CRM_Report_Form::OP_MONTH | |
3010 | ) { | |
971d41b1 CW |
3011 | list($from, $to) |
3012 | = $this->getFromTo( | |
8f1445ea DL |
3013 | CRM_Utils_Array::value("{$fieldName}_relative", $this->_params), |
3014 | CRM_Utils_Array::value("{$fieldName}_from", $this->_params), | |
3015 | CRM_Utils_Array::value("{$fieldName}_to", $this->_params), | |
3016 | CRM_Utils_Array::value("{$fieldName}_from_time", $this->_params), | |
3017 | CRM_Utils_Array::value("{$fieldName}_to_time", $this->_params) | |
3018 | ); | |
0d8afee2 | 3019 | $from_time_format = !empty($this->_params["{$fieldName}_from_time"]) ? 'h' : 'd'; |
9d72cede | 3020 | $from = CRM_Utils_Date::customFormat($from, NULL, array($from_time_format)); |
6a488035 | 3021 | |
0d8afee2 | 3022 | $to_time_format = !empty($this->_params["{$fieldName}_to_time"]) ? 'h' : 'd'; |
9d72cede | 3023 | $to = CRM_Utils_Date::customFormat($to, NULL, array($to_time_format)); |
6a488035 TO |
3024 | |
3025 | if ($from || $to) { | |
3026 | $statistics['filters'][] = array( | |
3027 | 'title' => $field['title'], | |
10a5be27 | 3028 | 'value' => ts("Between %1 and %2", array(1 => $from, 2 => $to)), |
6a488035 TO |
3029 | ); |
3030 | } | |
3031 | elseif (in_array($rel = CRM_Utils_Array::value("{$fieldName}_relative", $this->_params), | |
9d72cede EM |
3032 | array_keys($this->getOperationPair(CRM_Report_Form::OP_DATE)) |
3033 | )) { | |
160d32e1 | 3034 | $pair = $this->getOperationPair(CRM_Report_Form::OP_DATE); |
6a488035 TO |
3035 | $statistics['filters'][] = array( |
3036 | 'title' => $field['title'], | |
3037 | 'value' => $pair[$rel], | |
3038 | ); | |
3039 | } | |
3040 | } | |
3041 | else { | |
3042 | $op = CRM_Utils_Array::value("{$fieldName}_op", $this->_params); | |
3043 | $value = NULL; | |
3044 | if ($op) { | |
1b36206c | 3045 | $pair = $this->getOperationPair( |
8f1445ea DL |
3046 | CRM_Utils_Array::value('operatorType', $field), |
3047 | $fieldName | |
6a488035 TO |
3048 | ); |
3049 | $min = CRM_Utils_Array::value("{$fieldName}_min", $this->_params); | |
3050 | $max = CRM_Utils_Array::value("{$fieldName}_max", $this->_params); | |
3051 | $val = CRM_Utils_Array::value("{$fieldName}_value", $this->_params); | |
2107cde9 CW |
3052 | if (in_array($op, array('bw', 'nbw')) && ($min || $max)) { |
3053 | $value = "{$pair[$op]} $min " . ts('and') . " $max"; | |
3054 | } | |
d3e86119 | 3055 | elseif ($val && CRM_Utils_Array::value('operatorType', $field) & self::OP_ENTITYREF) { |
2107cde9 | 3056 | $this->setEntityRefDefaults($field, $tableName); |
9d72cede EM |
3057 | $result = civicrm_api3($field['attributes']['entity'], 'getlist', |
3058 | array('id' => $val) + | |
3059 | CRM_Utils_Array::value('api', $field['attributes'], array())); | |
2107cde9 CW |
3060 | $values = array(); |
3061 | foreach ($result['values'] as $v) { | |
3062 | $values[] = $v['label']; | |
3063 | } | |
3064 | $value = "{$pair[$op]} " . implode(', ', $values); | |
6a488035 TO |
3065 | } |
3066 | elseif ($op == 'nll' || $op == 'nnll') { | |
3067 | $value = $pair[$op]; | |
3068 | } | |
3069 | elseif (is_array($val) && (!empty($val))) { | |
f974e915 | 3070 | $options = CRM_Utils_Array::value('options', $field, array()); |
6a488035 TO |
3071 | foreach ($val as $key => $valIds) { |
3072 | if (isset($options[$valIds])) { | |
3073 | $val[$key] = $options[$valIds]; | |
3074 | } | |
3075 | } | |
9d72cede EM |
3076 | $pair[$op] = (count($val) == 1) ? (($op == 'notin' || $op == |
3077 | 'mnot') ? ts('Is Not') : ts('Is')) : CRM_Utils_Array::value($op, $pair); | |
3078 | $val = implode(', ', $val); | |
3079 | $value = "{$pair[$op]} " . $val; | |
6a488035 | 3080 | } |
9d72cede EM |
3081 | elseif (!is_array($val) && (!empty($val) || $val == '0') && |
3082 | isset($field['options']) && | |
6a488035 TO |
3083 | is_array($field['options']) && !empty($field['options']) |
3084 | ) { | |
9d72cede EM |
3085 | $value = CRM_Utils_Array::value($op, $pair) . " " . |
3086 | CRM_Utils_Array::value($val, $field['options'], $val); | |
6a488035 TO |
3087 | } |
3088 | elseif ($val) { | |
3089 | $value = CRM_Utils_Array::value($op, $pair) . " " . $val; | |
3090 | } | |
3091 | } | |
3092 | if ($value) { | |
9d72cede EM |
3093 | $statistics['filters'][] = array( |
3094 | 'title' => CRM_Utils_Array::value('title', $field), | |
3095 | 'value' => $value, | |
6a488035 TO |
3096 | ); |
3097 | } | |
3098 | } | |
3099 | } | |
3100 | } | |
3101 | } | |
3102 | } | |
3103 | ||
74cf4551 | 3104 | /** |
7d7c50f9 EM |
3105 | * End post processing. |
3106 | * | |
3107 | * @param array|null $rows | |
74cf4551 | 3108 | */ |
00be9182 | 3109 | public function endPostProcess(&$rows = NULL) { |
9d72cede | 3110 | if ($this->_storeResultSet) { |
ae555e90 DS |
3111 | $this->_resultSet = $rows; |
3112 | } | |
3113 | ||
6a488035 TO |
3114 | if ($this->_outputMode == 'print' || |
3115 | $this->_outputMode == 'pdf' || | |
3116 | $this->_sendmail | |
3117 | ) { | |
3118 | ||
3119 | $content = $this->compileContent(); | |
3120 | $url = CRM_Utils_System::url("civicrm/report/instance/{$this->_id}", | |
9d72cede | 3121 | "reset=1", TRUE |
6a488035 TO |
3122 | ); |
3123 | ||
3124 | if ($this->_sendmail) { | |
3125 | $config = CRM_Core_Config::singleton(); | |
3126 | $attachments = array(); | |
3127 | ||
3128 | if ($this->_outputMode == 'csv') { | |
971d41b1 CW |
3129 | $content |
3130 | = $this->_formValues['report_header'] . '<p>' . ts('Report URL') . | |
9d72cede EM |
3131 | ": {$url}</p>" . '<p>' . |
3132 | ts('The report is attached as a CSV file.') . '</p>' . | |
3133 | $this->_formValues['report_footer']; | |
3134 | ||
3135 | $csvFullFilename = $config->templateCompileDir . | |
3136 | CRM_Utils_File::makeFileName('CiviReport.csv'); | |
6a488035 TO |
3137 | $csvContent = CRM_Report_Utils_Report::makeCsv($this, $rows); |
3138 | file_put_contents($csvFullFilename, $csvContent); | |
3139 | $attachments[] = array( | |
3140 | 'fullPath' => $csvFullFilename, | |
3141 | 'mime_type' => 'text/csv', | |
3142 | 'cleanName' => 'CiviReport.csv', | |
3143 | ); | |
3144 | } | |
3145 | if ($this->_outputMode == 'pdf') { | |
3146 | // generate PDF content | |
9d72cede EM |
3147 | $pdfFullFilename = $config->templateCompileDir . |
3148 | CRM_Utils_File::makeFileName('CiviReport.pdf'); | |
6a488035 TO |
3149 | file_put_contents($pdfFullFilename, |
3150 | CRM_Utils_PDF_Utils::html2pdf($content, "CiviReport.pdf", | |
3151 | TRUE, array('orientation' => 'landscape') | |
3152 | ) | |
3153 | ); | |
3154 | // generate Email Content | |
971d41b1 CW |
3155 | $content |
3156 | = $this->_formValues['report_header'] . '<p>' . ts('Report URL') . | |
9d72cede EM |
3157 | ": {$url}</p>" . '<p>' . |
3158 | ts('The report is attached as a PDF file.') . '</p>' . | |
3159 | $this->_formValues['report_footer']; | |
6a488035 TO |
3160 | |
3161 | $attachments[] = array( | |
3162 | 'fullPath' => $pdfFullFilename, | |
3163 | 'mime_type' => 'application/pdf', | |
3164 | 'cleanName' => 'CiviReport.pdf', | |
3165 | ); | |
3166 | } | |
3167 | ||
3168 | if (CRM_Report_Utils_Report::mailReport($content, $this->_id, | |
9d72cede EM |
3169 | $this->_outputMode, $attachments |
3170 | ) | |
3171 | ) { | |
6a488035 TO |
3172 | CRM_Core_Session::setStatus(ts("Report mail has been sent."), ts('Sent'), 'success'); |
3173 | } | |
3174 | else { | |
3175 | CRM_Core_Session::setStatus(ts("Report mail could not be sent."), ts('Mail Error'), 'error'); | |
3176 | } | |
824aede6 | 3177 | return TRUE; |
6a488035 TO |
3178 | } |
3179 | elseif ($this->_outputMode == 'print') { | |
3180 | echo $content; | |
3181 | } | |
3182 | else { | |
3183 | if ($chartType = CRM_Utils_Array::value('charts', $this->_params)) { | |
3184 | $config = CRM_Core_Config::singleton(); | |
3185 | //get chart image name | |
3186 | $chartImg = $this->_chartId . '.png'; | |
3187 | //get image url path | |
971d41b1 CW |
3188 | $uploadUrl |
3189 | = str_replace('/persist/contribute/', '/persist/', $config->imageUploadURL) . | |
9d72cede | 3190 | 'openFlashChart/'; |
6a488035 TO |
3191 | $uploadUrl .= $chartImg; |
3192 | //get image doc path to overwrite | |
971d41b1 CW |
3193 | $uploadImg |
3194 | = str_replace('/persist/contribute/', '/persist/', $config->imageUploadDir) . | |
9d72cede | 3195 | 'openFlashChart/' . $chartImg; |
6a488035 TO |
3196 | //Load the image |
3197 | $chart = imagecreatefrompng($uploadUrl); | |
2fe3c48d | 3198 | //convert it into formatted png |
6a488035 TO |
3199 | header('Content-type: image/png'); |
3200 | //overwrite with same image | |
3201 | imagepng($chart, $uploadImg); | |
3202 | //delete the object | |
3203 | imagedestroy($chart); | |
3204 | } | |
3205 | CRM_Utils_PDF_Utils::html2pdf($content, "CiviReport.pdf", FALSE, array('orientation' => 'landscape')); | |
3206 | } | |
3207 | CRM_Utils_System::civiExit(); | |
3208 | } | |
3209 | elseif ($this->_outputMode == 'csv') { | |
3210 | CRM_Report_Utils_Report::export2csv($this, $rows); | |
3211 | } | |
3212 | elseif ($this->_outputMode == 'group') { | |
3213 | $group = $this->_params['groups']; | |
3214 | $this->add2group($group); | |
3215 | } | |
3216 | elseif ($this->_instanceButtonName == $this->controller->getButtonName()) { | |
3217 | CRM_Report_Form_Instance::postProcess($this); | |
3218 | } | |
3219 | elseif ($this->_createNewButtonName == $this->controller->getButtonName() || | |
9d72cede EM |
3220 | $this->_outputMode == 'create_report' |
3221 | ) { | |
6a488035 TO |
3222 | $this->_createNew = TRUE; |
3223 | CRM_Report_Form_Instance::postProcess($this); | |
3224 | } | |
3225 | } | |
8f1445ea | 3226 | |
8a925f33 | 3227 | /** |
7d7c50f9 EM |
3228 | * Set store result set indicator to TRUE. |
3229 | * | |
8a925f33 EM |
3230 | * @todo explain what this does |
3231 | */ | |
00be9182 | 3232 | public function storeResultSet() { |
ae555e90 DS |
3233 | $this->_storeResultSet = TRUE; |
3234 | } | |
3235 | ||
74cf4551 | 3236 | /** |
7d7c50f9 EM |
3237 | * Get result set. |
3238 | * | |
74cf4551 EM |
3239 | * @return bool |
3240 | */ | |
00be9182 | 3241 | public function getResultSet() { |
ae555e90 DS |
3242 | return $this->_resultSet; |
3243 | } | |
3244 | ||
74cf4551 | 3245 | /** |
fe482240 | 3246 | * Use the form name to create the tpl file name. |
74cf4551 EM |
3247 | * |
3248 | * @return string | |
74cf4551 | 3249 | */ |
00be9182 | 3250 | public function getTemplateFileName() { |
6a488035 | 3251 | $defaultTpl = parent::getTemplateFileName(); |
9d72cede | 3252 | $template = CRM_Core_Smarty::singleton(); |
6a488035 TO |
3253 | if (!$template->template_exists($defaultTpl)) { |
3254 | $defaultTpl = 'CRM/Report/Form.tpl'; | |
3255 | } | |
3256 | return $defaultTpl; | |
3257 | } | |
3258 | ||
688d37c6 | 3259 | /** |
fe482240 | 3260 | * Compile the report content. |
317a8023 | 3261 | * |
688d37c6 | 3262 | * Although this function is super-short it is useful to keep separate so it can be over-ridden by report classes. |
6a488035 | 3263 | * |
74cf4551 EM |
3264 | * @return string |
3265 | */ | |
00be9182 | 3266 | public function compileContent() { |
8aac22c8 | 3267 | $templateFile = $this->getHookedTemplateFileName(); |
9d72cede EM |
3268 | return $this->_formValues['report_header'] . |
3269 | CRM_Core_Form::$_template->fetch($templateFile) . | |
3270 | $this->_formValues['report_footer']; | |
6a488035 TO |
3271 | } |
3272 | ||
3273 | ||
317a8023 | 3274 | /** |
3275 | * Post process function. | |
3276 | */ | |
00be9182 | 3277 | public function postProcess() { |
6a488035 TO |
3278 | // get ready with post process params |
3279 | $this->beginPostProcess(); | |
3280 | ||
3281 | // build query | |
3282 | $sql = $this->buildQuery(); | |
3283 | ||
3284 | // build array of result based on column headers. This method also allows | |
3285 | // modifying column headers before using it to build result set i.e $rows. | |
3286 | $rows = array(); | |
3287 | $this->buildRows($sql, $rows); | |
3288 | ||
3289 | // format result set. | |
3290 | $this->formatDisplay($rows); | |
3291 | ||
3292 | // assign variables to templates | |
3293 | $this->doTemplateAssignment($rows); | |
3294 | ||
3295 | // do print / pdf / instance stuff if needed | |
3296 | $this->endPostProcess($rows); | |
3297 | } | |
3298 | ||
74cf4551 | 3299 | /** |
317a8023 | 3300 | * Set limit. |
3301 | * | |
74cf4551 | 3302 | * @param int $rowCount |
317a8023 | 3303 | * |
688d37c6 | 3304 | * @return array |
74cf4551 | 3305 | */ |
00be9182 | 3306 | public function limit($rowCount = self::ROW_COUNT_LIMIT) { |
6a488035 TO |
3307 | // lets do the pager if in html mode |
3308 | $this->_limit = NULL; | |
77b97be7 | 3309 | |
dbb4a0f9 PN |
3310 | // CRM-14115, over-ride row count if rowCount is specified in URL |
3311 | if ($this->_dashBoardRowCount) { | |
3312 | $rowCount = $this->_dashBoardRowCount; | |
3313 | } | |
6a488035 TO |
3314 | if ($this->_outputMode == 'html' || $this->_outputMode == 'group') { |
3315 | $this->_select = str_ireplace('SELECT ', 'SELECT SQL_CALC_FOUND_ROWS ', $this->_select); | |
3316 | ||
3317 | $pageId = CRM_Utils_Request::retrieve('crmPID', 'Integer', CRM_Core_DAO::$_nullObject); | |
3318 | ||
8a925f33 EM |
3319 | // @todo all http vars should be extracted in the preProcess |
3320 | // - not randomly in the class | |
6a488035 TO |
3321 | if (!$pageId && !empty($_POST)) { |
3322 | if (isset($_POST['PagerBottomButton']) && isset($_POST['crmPID_B'])) { | |
8a925f33 | 3323 | $pageId = max((int) $_POST['crmPID_B'], 1); |
6a488035 TO |
3324 | } |
3325 | elseif (isset($_POST['PagerTopButton']) && isset($_POST['crmPID'])) { | |
8a925f33 | 3326 | $pageId = max((int) $_POST['crmPID'], 1); |
6a488035 TO |
3327 | } |
3328 | unset($_POST['crmPID_B'], $_POST['crmPID']); | |
3329 | } | |
3330 | ||
3331 | $pageId = $pageId ? $pageId : 1; | |
3332 | $this->set(CRM_Utils_Pager::PAGE_ID, $pageId); | |
3333 | $offset = ($pageId - 1) * $rowCount; | |
3334 | ||
bf00d1b6 DL |
3335 | $offset = CRM_Utils_Type::escape($offset, 'Int'); |
3336 | $rowCount = CRM_Utils_Type::escape($rowCount, 'Int'); | |
3337 | ||
dd3a4117 | 3338 | $this->_limit = " LIMIT $offset, $rowCount"; |
6a488035 TO |
3339 | return array($offset, $rowCount); |
3340 | } | |
9d72cede EM |
3341 | if ($this->_limitValue) { |
3342 | if ($this->_offsetValue) { | |
6f900755 E |
3343 | $this->_limit = " LIMIT {$this->_offsetValue}, {$this->_limitValue} "; |
3344 | } | |
3345 | else { | |
3346 | $this->_limit = " LIMIT " . $this->_limitValue; | |
3347 | } | |
3348 | } | |
6a488035 TO |
3349 | } |
3350 | ||
74cf4551 | 3351 | /** |
317a8023 | 3352 | * Set pager. |
3353 | * | |
74cf4551 EM |
3354 | * @param int $rowCount |
3355 | */ | |
00be9182 | 3356 | public function setPager($rowCount = self::ROW_COUNT_LIMIT) { |
dbb4a0f9 PN |
3357 | |
3358 | // CRM-14115, over-ride row count if rowCount is specified in URL | |
3359 | if ($this->_dashBoardRowCount) { | |
3360 | $rowCount = $this->_dashBoardRowCount; | |
3361 | } | |
3362 | ||
6a488035 | 3363 | if ($this->_limit && ($this->_limit != '')) { |
9d72cede | 3364 | $sql = "SELECT FOUND_ROWS();"; |
6a488035 | 3365 | $this->_rowsFound = CRM_Core_DAO::singleValueQuery($sql); |
9d72cede | 3366 | $params = array( |
6a488035 TO |
3367 | 'total' => $this->_rowsFound, |
3368 | 'rowCount' => $rowCount, | |
3369 | 'status' => ts('Records') . ' %%StatusMessage%%', | |
3370 | 'buttonBottom' => 'PagerBottomButton', | |
3371 | 'buttonTop' => 'PagerTopButton', | |
3372 | 'pageID' => $this->get(CRM_Utils_Pager::PAGE_ID), | |
3373 | ); | |
3374 | ||
3375 | $pager = new CRM_Utils_Pager($params); | |
3376 | $this->assign_by_ref('pager', $pager); | |
ecc20f0e | 3377 | $this->ajaxResponse['totalRows'] = $this->_rowsFound; |
6a488035 TO |
3378 | } |
3379 | } | |
3380 | ||
74cf4551 | 3381 | /** |
317a8023 | 3382 | * Build where clause for groups. |
3383 | * | |
3384 | * @param string $field | |
3385 | * @param mixed $value | |
3386 | * @param string $op | |
74cf4551 EM |
3387 | * |
3388 | * @return string | |
3389 | */ | |
00be9182 | 3390 | public function whereGroupClause($field, $value, $op) { |
6a488035 TO |
3391 | |
3392 | $smartGroupQuery = ""; | |
3393 | ||
3394 | $group = new CRM_Contact_DAO_Group(); | |
3395 | $group->is_active = 1; | |
3396 | $group->find(); | |
3397 | $smartGroups = array(); | |
3398 | while ($group->fetch()) { | |
9d72cede EM |
3399 | if (in_array($group->id, $this->_params['gid_value']) && |
3400 | $group->saved_search_id | |
3401 | ) { | |
6a488035 TO |
3402 | $smartGroups[] = $group->id; |
3403 | } | |
3404 | } | |
3405 | ||
3406 | CRM_Contact_BAO_GroupContactCache::check($smartGroups); | |
3407 | ||
3408 | $smartGroupQuery = ''; | |
3409 | if (!empty($smartGroups)) { | |
3410 | $smartGroups = implode(',', $smartGroups); | |
3411 | $smartGroupQuery = " UNION DISTINCT | |
3412 | SELECT DISTINCT smartgroup_contact.contact_id | |
3413 | FROM civicrm_group_contact_cache smartgroup_contact | |
3414 | WHERE smartgroup_contact.group_id IN ({$smartGroups}) "; | |
3415 | } | |
3416 | ||
29fc2b79 | 3417 | $sqlOp = $this->getSQLOperator($op); |
6a488035 TO |
3418 | if (!is_array($value)) { |
3419 | $value = array($value); | |
3420 | } | |
3421 | $clause = "{$field['dbAlias']} IN (" . implode(', ', $value) . ")"; | |
3422 | ||
3423 | return " {$this->_aliases['civicrm_contact']}.id {$sqlOp} ( | |
3424 | SELECT DISTINCT {$this->_aliases['civicrm_group']}.contact_id | |
3425 | FROM civicrm_group_contact {$this->_aliases['civicrm_group']} | |
3426 | WHERE {$clause} AND {$this->_aliases['civicrm_group']}.status = 'Added' | |
3427 | {$smartGroupQuery} ) "; | |
3428 | } | |
3429 | ||
74cf4551 | 3430 | /** |
317a8023 | 3431 | * Build where clause for tags. |
3432 | * | |
3433 | * @param string $field | |
3434 | * @param mixed $value | |
3435 | * @param string $op | |
74cf4551 EM |
3436 | * |
3437 | * @return string | |
3438 | */ | |
00be9182 | 3439 | public function whereTagClause($field, $value, $op) { |
6a488035 TO |
3440 | // not using left join in query because if any contact |
3441 | // belongs to more than one tag, results duplicate | |
3442 | // entries. | |
29fc2b79 | 3443 | $sqlOp = $this->getSQLOperator($op); |
6a488035 TO |
3444 | if (!is_array($value)) { |
3445 | $value = array($value); | |
3446 | } | |
3447 | $clause = "{$field['dbAlias']} IN (" . implode(', ', $value) . ")"; | |
ed795723 JM |
3448 | $entity_table = $this->_tagFilterTable; |
3449 | return " {$this->_aliases[$entity_table]}.id {$sqlOp} ( | |
6a488035 TO |
3450 | SELECT DISTINCT {$this->_aliases['civicrm_tag']}.entity_id |
3451 | FROM civicrm_entity_tag {$this->_aliases['civicrm_tag']} | |
ed795723 | 3452 | WHERE entity_table = '$entity_table' AND {$clause} ) "; |
6a488035 TO |
3453 | } |
3454 | ||
f587aa17 EM |
3455 | /** |
3456 | * Generate membership organization clause. | |
3457 | * | |
3458 | * @param mixed $value | |
3459 | * @param string $op SQL Operator | |
3460 | * | |
3461 | * @return string | |
3462 | */ | |
3463 | public function whereMembershipOrgClause($value, $op) { | |
114a2c85 DG |
3464 | $sqlOp = $this->getSQLOperator($op); |
3465 | if (!is_array($value)) { | |
3466 | $value = array($value); | |
3467 | } | |
258e2add | 3468 | |
114a2c85 DG |
3469 | $tmp_membership_org_sql_list = implode(', ', $value); |
3470 | return " {$this->_aliases['civicrm_contact']}.id {$sqlOp} ( | |
97709b72 | 3471 | SELECT DISTINCT mem.contact_id |
258e2add | 3472 | FROM civicrm_membership mem |
97709b72 | 3473 | LEFT JOIN civicrm_membership_status mem_status ON mem.status_id = mem_status.id |
258e2add | 3474 | LEFT JOIN civicrm_membership_type mt ON mem.membership_type_id = mt.id |
9d72cede EM |
3475 | WHERE mt.member_of_contact_id IN (" . |
3476 | $tmp_membership_org_sql_list . ") | |
97709b72 DG |
3477 | AND mt.is_active = '1' |
3478 | AND mem_status.is_current_member = '1' | |
3479 | AND mem_status.is_active = '1' ) "; | |
9d72cede | 3480 | } |
114a2c85 | 3481 | |
f587aa17 | 3482 | /** |
fe482240 | 3483 | * Generate Membership Type SQL Clause. |
317a8023 | 3484 | * |
f587aa17 EM |
3485 | * @param mixed $value |
3486 | * @param string $op | |
3487 | * | |
3488 | * @return string | |
3489 | * SQL query string | |
3490 | */ | |
3491 | public function whereMembershipTypeClause($value, $op) { | |
114a2c85 DG |
3492 | $sqlOp = $this->getSQLOperator($op); |
3493 | if (!is_array($value)) { | |
3494 | $value = array($value); | |
3495 | } | |
258e2add | 3496 | |
9d72cede | 3497 | $tmp_membership_sql_list = implode(', ', $value); |
114a2c85 | 3498 | return " {$this->_aliases['civicrm_contact']}.id {$sqlOp} ( |
97709b72 | 3499 | SELECT DISTINCT mem.contact_id |
258e2add | 3500 | FROM civicrm_membership mem |
3501 | LEFT JOIN civicrm_membership_status mem_status ON mem.status_id = mem_status.id | |
3502 | LEFT JOIN civicrm_membership_type mt ON mem.membership_type_id = mt.id | |
9d72cede EM |
3503 | WHERE mem.membership_type_id IN (" . |
3504 | $tmp_membership_sql_list . ") | |
97709b72 DG |
3505 | AND mt.is_active = '1' |
3506 | AND mem_status.is_current_member = '1' | |
3507 | AND mem_status.is_active = '1' ) "; | |
114a2c85 | 3508 | } |
258e2add | 3509 | |
74cf4551 | 3510 | /** |
317a8023 | 3511 | * Build acl clauses. |
3512 | * | |
74cf4551 EM |
3513 | * @param string $tableAlias |
3514 | */ | |
00be9182 | 3515 | public function buildACLClause($tableAlias = 'contact_a') { |
6a488035 TO |
3516 | list($this->_aclFrom, $this->_aclWhere) = CRM_Contact_BAO_Contact_Permission::cacheClause($tableAlias); |
3517 | } | |
3518 | ||
74cf4551 | 3519 | /** |
317a8023 | 3520 | * Add custom data to the columns. |
3521 | * | |
74cf4551 EM |
3522 | * @param bool $addFields |
3523 | * @param array $permCustomGroupIds | |
3524 | */ | |
00be9182 | 3525 | public function addCustomDataToColumns($addFields = TRUE, $permCustomGroupIds = array()) { |
6a488035 TO |
3526 | if (empty($this->_customGroupExtends)) { |
3527 | return; | |
3528 | } | |
3529 | if (!is_array($this->_customGroupExtends)) { | |
3530 | $this->_customGroupExtends = array($this->_customGroupExtends); | |
3531 | } | |
3532 | $customGroupWhere = ''; | |
3533 | if (!empty($permCustomGroupIds)) { | |
9d72cede EM |
3534 | $customGroupWhere = "cg.id IN (" . implode(',', $permCustomGroupIds) . |
3535 | ") AND"; | |
6a488035 TO |
3536 | } |
3537 | $sql = " | |
3538 | SELECT cg.table_name, cg.title, cg.extends, cf.id as cf_id, cf.label, | |
3539 | cf.column_name, cf.data_type, cf.html_type, cf.option_group_id, cf.time_format | |
3540 | FROM civicrm_custom_group cg | |
3541 | INNER JOIN civicrm_custom_field cf ON cg.id = cf.custom_group_id | |
3542 | WHERE cg.extends IN ('" . implode("','", $this->_customGroupExtends) . "') AND | |
3543 | {$customGroupWhere} | |
3544 | cg.is_active = 1 AND | |
3545 | cf.is_active = 1 AND | |
3546 | cf.is_searchable = 1 | |
3547 | ORDER BY cg.weight, cf.weight"; | |
3548 | $customDAO = CRM_Core_DAO::executeQuery($sql); | |
3549 | ||
3550 | $curTable = NULL; | |
3551 | while ($customDAO->fetch()) { | |
3552 | if ($customDAO->table_name != $curTable) { | |
3553 | $curTable = $customDAO->table_name; | |
3554 | $curFields = $curFilters = array(); | |
3555 | ||
3556 | // dummy dao object | |
3557 | $this->_columns[$curTable]['dao'] = 'CRM_Contact_DAO_Contact'; | |
3558 | $this->_columns[$curTable]['extends'] = $customDAO->extends; | |
3559 | $this->_columns[$curTable]['grouping'] = $customDAO->table_name; | |
3560 | $this->_columns[$curTable]['group_title'] = $customDAO->title; | |
3561 | ||
3562 | foreach (array( | |
9d72cede EM |
3563 | 'fields', |
3564 | 'filters', | |
21dfd5f5 | 3565 | 'group_bys', |
9d72cede | 3566 | ) as $colKey) { |
6a488035 TO |
3567 | if (!array_key_exists($colKey, $this->_columns[$curTable])) { |
3568 | $this->_columns[$curTable][$colKey] = array(); | |
3569 | } | |
3570 | } | |
3571 | } | |
3572 | $fieldName = 'custom_' . $customDAO->cf_id; | |
3573 | ||
3574 | if ($addFields) { | |
3575 | // this makes aliasing work in favor | |
3576 | $curFields[$fieldName] = array( | |
3577 | 'name' => $customDAO->column_name, | |
3578 | 'title' => $customDAO->label, | |
3579 | 'dataType' => $customDAO->data_type, | |
3580 | 'htmlType' => $customDAO->html_type, | |
3581 | ); | |
3582 | } | |
3583 | if ($this->_customGroupFilters) { | |
3584 | // this makes aliasing work in favor | |
3585 | $curFilters[$fieldName] = array( | |
3586 | 'name' => $customDAO->column_name, | |
3587 | 'title' => $customDAO->label, | |
3588 | 'dataType' => $customDAO->data_type, | |
3589 | 'htmlType' => $customDAO->html_type, | |
3590 | ); | |
3591 | } | |
3592 | ||
3593 | switch ($customDAO->data_type) { | |
3594 | case 'Date': | |
3595 | // filters | |
3596 | $curFilters[$fieldName]['operatorType'] = CRM_Report_Form::OP_DATE; | |
3597 | $curFilters[$fieldName]['type'] = CRM_Utils_Type::T_DATE; | |
3598 | // CRM-6946, show time part for datetime date fields | |
3599 | if ($customDAO->time_format) { | |
3600 | $curFields[$fieldName]['type'] = CRM_Utils_Type::T_TIMESTAMP; | |
3601 | } | |
3602 | break; | |
3603 | ||
3604 | case 'Boolean': | |
3605 | $curFilters[$fieldName]['operatorType'] = CRM_Report_Form::OP_SELECT; | |
9d72cede EM |
3606 | $curFilters[$fieldName]['options'] = array( |
3607 | '' => ts('- select -'), | |
3608 | 1 => ts('Yes'), | |
3609 | 0 => ts('No'), | |
6a488035 TO |
3610 | ); |
3611 | $curFilters[$fieldName]['type'] = CRM_Utils_Type::T_INT; | |
3612 | break; | |
3613 | ||
3614 | case 'Int': | |
3615 | $curFilters[$fieldName]['operatorType'] = CRM_Report_Form::OP_INT; | |
3616 | $curFilters[$fieldName]['type'] = CRM_Utils_Type::T_INT; | |
3617 | break; | |
3618 | ||
3619 | case 'Money': | |
3620 | $curFilters[$fieldName]['operatorType'] = CRM_Report_Form::OP_FLOAT; | |
3621 | $curFilters[$fieldName]['type'] = CRM_Utils_Type::T_MONEY; | |
3622 | break; | |
3623 | ||
3624 | case 'Float': | |
3625 | $curFilters[$fieldName]['operatorType'] = CRM_Report_Form::OP_FLOAT; | |
3626 | $curFilters[$fieldName]['type'] = CRM_Utils_Type::T_FLOAT; | |
3627 | break; | |
3628 | ||
3629 | case 'String': | |
3630 | $curFilters[$fieldName]['type'] = CRM_Utils_Type::T_STRING; | |
3631 | ||
3632 | if (!empty($customDAO->option_group_id)) { | |
3633 | if (in_array($customDAO->html_type, array( | |
9d72cede EM |
3634 | 'Multi-Select', |
3635 | 'AdvMulti-Select', | |
21dfd5f5 | 3636 | 'CheckBox', |
9d72cede | 3637 | ))) { |
6a488035 TO |
3638 | $curFilters[$fieldName]['operatorType'] = CRM_Report_Form::OP_MULTISELECT_SEPARATOR; |
3639 | } | |
3640 | else { | |
3641 | $curFilters[$fieldName]['operatorType'] = CRM_Report_Form::OP_MULTISELECT; | |
3642 | } | |
3643 | if ($this->_customGroupFilters) { | |
3644 | $curFilters[$fieldName]['options'] = array(); | |
9d72cede | 3645 | $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( |
86bd39be TO |
3646 | 1 => array( |
3647 | $customDAO->option_group_id, | |
21dfd5f5 TO |
3648 | 'Integer', |
3649 | ), | |
86bd39be | 3650 | )); |
6a488035 TO |
3651 | while ($ogDAO->fetch()) { |
3652 | $curFilters[$fieldName]['options'][$ogDAO->value] = $ogDAO->label; | |
3653 | } | |
6e57f5ca | 3654 | CRM_Utils_Hook::customFieldOptions($customDAO->cf_id, $curFilters[$fieldName]['options'], FALSE); |
6a488035 TO |
3655 | } |
3656 | } | |
3657 | break; | |
3658 | ||
3659 | case 'StateProvince': | |
3660 | if (in_array($customDAO->html_type, array( | |
21dfd5f5 | 3661 | 'Multi-Select State/Province', |
9d72cede | 3662 | ))) { |
6a488035 TO |
3663 | $curFilters[$fieldName]['operatorType'] = CRM_Report_Form::OP_MULTISELECT_SEPARATOR; |
3664 | } | |
3665 | else { | |
3666 | $curFilters[$fieldName]['operatorType'] = CRM_Report_Form::OP_MULTISELECT; | |
3667 | } | |
3668 | $curFilters[$fieldName]['options'] = CRM_Core_PseudoConstant::stateProvince(); | |
3669 | break; | |
3670 | ||
3671 | case 'Country': | |
3672 | if (in_array($customDAO->html_type, array( | |
21dfd5f5 | 3673 | 'Multi-Select Country', |
9d72cede | 3674 | ))) { |
6a488035 TO |
3675 | $curFilters[$fieldName]['operatorType'] = CRM_Report_Form::OP_MULTISELECT_SEPARATOR; |
3676 | } | |
3677 | else { | |
3678 | $curFilters[$fieldName]['operatorType'] = CRM_Report_Form::OP_MULTISELECT; | |
3679 | } | |
3680 | $curFilters[$fieldName]['options'] = CRM_Core_PseudoConstant::country(); | |
3681 | break; | |
3682 | ||
3683 | case 'ContactReference': | |
3684 | $curFilters[$fieldName]['type'] = CRM_Utils_Type::T_STRING; | |
3685 | $curFilters[$fieldName]['name'] = 'display_name'; | |
3686 | $curFilters[$fieldName]['alias'] = "contact_{$fieldName}_civireport"; | |
3687 | ||
3688 | $curFields[$fieldName]['type'] = CRM_Utils_Type::T_STRING; | |
3689 | $curFields[$fieldName]['name'] = 'display_name'; | |
3690 | $curFields[$fieldName]['alias'] = "contact_{$fieldName}_civireport"; | |
3691 | break; | |
3692 | ||
3693 | default: | |
3694 | $curFields[$fieldName]['type'] = CRM_Utils_Type::T_STRING; | |
3695 | $curFilters[$fieldName]['type'] = CRM_Utils_Type::T_STRING; | |
3696 | } | |
3697 | ||
3698 | if (!array_key_exists('type', $curFields[$fieldName])) { | |
fc161185 | 3699 | $curFields[$fieldName]['type'] = CRM_Utils_Array::value('type', $curFilters[$fieldName], array()); |
6a488035 TO |
3700 | } |
3701 | ||
3702 | if ($addFields) { | |
3703 | $this->_columns[$curTable]['fields'] = array_merge($this->_columns[$curTable]['fields'], $curFields); | |
3704 | } | |
3705 | if ($this->_customGroupFilters) { | |
3706 | $this->_columns[$curTable]['filters'] = array_merge($this->_columns[$curTable]['filters'], $curFilters); | |
3707 | } | |
3708 | if ($this->_customGroupGroupBy) { | |
3709 | $this->_columns[$curTable]['group_bys'] = array_merge($this->_columns[$curTable]['group_bys'], $curFields); | |
3710 | } | |
3711 | } | |
3712 | } | |
3713 | ||
317a8023 | 3714 | /** |
3715 | * Build custom data from clause. | |
3716 | */ | |
00be9182 | 3717 | public function customDataFrom() { |
6a488035 TO |
3718 | if (empty($this->_customGroupExtends)) { |
3719 | return; | |
3720 | } | |
3721 | $mapper = CRM_Core_BAO_CustomQuery::$extendsMap; | |
3722 | ||
3723 | foreach ($this->_columns as $table => $prop) { | |
9d72cede EM |
3724 | if (substr($table, 0, 13) == 'civicrm_value' || |
3725 | substr($table, 0, 12) == 'custom_value' | |
3726 | ) { | |
6a488035 TO |
3727 | $extendsTable = $mapper[$prop['extends']]; |
3728 | ||
3729 | // check field is in params | |
3730 | if (!$this->isFieldSelected($prop)) { | |
3731 | continue; | |
3732 | } | |
4c9d78ea | 3733 | $baseJoin = CRM_Utils_Array::value($prop['extends'], $this->_customGroupExtendsJoin, "{$this->_aliases[$extendsTable]}.id"); |
6a488035 | 3734 | |
9d72cede | 3735 | $customJoin = is_array($this->_customGroupJoin) ? $this->_customGroupJoin[$table] : $this->_customGroupJoin; |
6a488035 | 3736 | $this->_from .= " |
aa1aa08e | 3737 | {$customJoin} {$table} {$this->_aliases[$table]} ON {$this->_aliases[$table]}.entity_id = {$baseJoin}"; |
6a488035 TO |
3738 | // handle for ContactReference |
3739 | if (array_key_exists('fields', $prop)) { | |
3740 | foreach ($prop['fields'] as $fieldName => $field) { | |
9d72cede EM |
3741 | if (CRM_Utils_Array::value('dataType', $field) == |
3742 | 'ContactReference' | |
3743 | ) { | |
6a488035 TO |
3744 | $columnName = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_CustomField', CRM_Core_BAO_CustomField::getKeyID($fieldName), 'column_name'); |
3745 | $this->_from .= " | |
3746 | LEFT JOIN civicrm_contact {$field['alias']} ON {$field['alias']}.id = {$this->_aliases[$table]}.{$columnName} "; | |
3747 | } | |
3748 | } | |
3749 | } | |
3750 | } | |
3751 | } | |
3752 | } | |
3753 | ||
74cf4551 | 3754 | /** |
317a8023 | 3755 | * Check if the field is selected. |
3756 | * | |
3757 | * @param string $prop | |
74cf4551 EM |
3758 | * |
3759 | * @return bool | |
3760 | */ | |
00be9182 | 3761 | public function isFieldSelected($prop) { |
6a488035 TO |
3762 | if (empty($prop)) { |
3763 | return FALSE; | |
3764 | } | |
3765 | ||
3766 | if (!empty($this->_params['fields'])) { | |
3767 | foreach (array_keys($prop['fields']) as $fieldAlias) { | |
3768 | $customFieldId = CRM_Core_BAO_CustomField::getKeyID($fieldAlias); | |
3769 | if ($customFieldId) { | |
3770 | if (array_key_exists($fieldAlias, $this->_params['fields'])) { | |
3771 | return TRUE; | |
3772 | } | |
3773 | ||
3774 | //might be survey response field. | |
9d72cede EM |
3775 | if (!empty($this->_params['fields']['survey_response']) && |
3776 | !empty($prop['fields'][$fieldAlias]['isSurveyResponseField']) | |
3777 | ) { | |
6a488035 TO |
3778 | return TRUE; |
3779 | } | |
3780 | } | |
3781 | } | |
3782 | } | |
3783 | ||
3784 | if (!empty($this->_params['group_bys']) && $this->_customGroupGroupBy) { | |
3785 | foreach (array_keys($prop['group_bys']) as $fieldAlias) { | |
9d72cede EM |
3786 | if (array_key_exists($fieldAlias, $this->_params['group_bys']) && |
3787 | CRM_Core_BAO_CustomField::getKeyID($fieldAlias) | |
3788 | ) { | |
6a488035 TO |
3789 | return TRUE; |
3790 | } | |
3791 | } | |
3792 | } | |
3793 | ||
3794 | if (!empty($this->_params['order_bys'])) { | |
3795 | foreach (array_keys($prop['fields']) as $fieldAlias) { | |
3796 | foreach ($this->_params['order_bys'] as $orderBy) { | |
9d72cede EM |
3797 | if ($fieldAlias == $orderBy['column'] && |
3798 | CRM_Core_BAO_CustomField::getKeyID($fieldAlias) | |
3799 | ) { | |
6a488035 TO |
3800 | return TRUE; |
3801 | } | |
3802 | } | |
3803 | } | |
3804 | } | |
3805 | ||
3806 | if (!empty($prop['filters']) && $this->_customGroupFilters) { | |
3807 | foreach ($prop['filters'] as $fieldAlias => $val) { | |
3808 | foreach (array( | |
9d72cede EM |
3809 | 'value', |
3810 | 'min', | |
3811 | 'max', | |
3812 | 'relative', | |
3813 | 'from', | |
21dfd5f5 | 3814 | 'to', |
9d72cede | 3815 | ) as $attach) { |
6a488035 | 3816 | if (isset($this->_params[$fieldAlias . '_' . $attach]) && |
dfe4b2f5 | 3817 | (!empty($this->_params[$fieldAlias . '_' . $attach]) |
9d72cede EM |
3818 | || ($attach != 'relative' && |
3819 | $this->_params[$fieldAlias . '_' . $attach] == '0') | |
dfe4b2f5 | 3820 | ) |
9d72cede | 3821 | ) { |
6a488035 TO |
3822 | return TRUE; |
3823 | } | |
3824 | } | |
a7488080 | 3825 | if (!empty($this->_params[$fieldAlias . '_op']) && |
6a488035 TO |
3826 | in_array($this->_params[$fieldAlias . '_op'], array('nll', 'nnll')) |
3827 | ) { | |
3828 | return TRUE; | |
3829 | } | |
3830 | } | |
3831 | } | |
3832 | ||
3833 | return FALSE; | |
3834 | } | |
3835 | ||
3836 | /** | |
31a8b5f0 | 3837 | * Check for empty order_by configurations and remove them. |
3838 | * | |
3839 | * Also set template to hide them. | |
537c70b8 EM |
3840 | * |
3841 | * @param array $formValues | |
6a488035 | 3842 | */ |
00be9182 | 3843 | public function preProcessOrderBy(&$formValues) { |
6a488035 | 3844 | // Object to show/hide form elements |
ae555e90 | 3845 | $_showHide = new CRM_Core_ShowHideBlocks('', ''); |
6a488035 TO |
3846 | |
3847 | $_showHide->addShow('optionField_1'); | |
3848 | ||
3849 | // Cycle through order_by options; skip any empty ones, and hide them as well | |
3850 | $n = 1; | |
3851 | ||
3852 | if (!empty($formValues['order_bys'])) { | |
3853 | foreach ($formValues['order_bys'] as $order_by) { | |
3854 | if ($order_by['column'] && $order_by['column'] != '-') { | |
3855 | $_showHide->addShow('optionField_' . $n); | |
3856 | $orderBys[$n] = $order_by; | |
3857 | $n++; | |
3858 | } | |
3859 | } | |
3860 | } | |
3861 | for ($i = $n; $i <= 5; $i++) { | |
3862 | if ($i > 1) { | |
3863 | $_showHide->addHide('optionField_' . $i); | |
3864 | } | |
3865 | } | |
3866 | ||
3867 | // overwrite order_by options with modified values | |
3868 | if (!empty($orderBys)) { | |
3869 | $formValues['order_bys'] = $orderBys; | |
3870 | } | |
3871 | else { | |
3872 | $formValues['order_bys'] = array(1 => array('column' => '-')); | |
3873 | } | |
3874 | ||
3875 | // assign show/hide data to template | |
3876 | $_showHide->addToTemplate(); | |
3877 | } | |
3878 | ||
3879 | /** | |
317a8023 | 3880 | * Check if table name has columns in SELECT clause. |
6a488035 | 3881 | * |
7e06c9f5 TO |
3882 | * @param string $tableName |
3883 | * Name of table (index of $this->_columns array). | |
6a488035 TO |
3884 | * |
3885 | * @return bool | |
3886 | */ | |
00be9182 | 3887 | public function isTableSelected($tableName) { |
6a488035 TO |
3888 | return in_array($tableName, $this->selectedTables()); |
3889 | } | |
3890 | ||
3891 | /** | |
fe482240 | 3892 | * Fetch array of DAO tables having columns included in SELECT or ORDER BY clause. |
317a8023 | 3893 | * |
3894 | * If the array is unset it will be built. | |
6a488035 | 3895 | * |
971d41b1 CW |
3896 | * @return array |
3897 | * selectedTables | |
6a488035 | 3898 | */ |
00be9182 | 3899 | public function selectedTables() { |
6a488035 TO |
3900 | if (!$this->_selectedTables) { |
3901 | $orderByColumns = array(); | |
9d72cede EM |
3902 | if (array_key_exists('order_bys', $this->_params) && |
3903 | is_array($this->_params['order_bys']) | |
3904 | ) { | |
6a488035 TO |
3905 | foreach ($this->_params['order_bys'] as $orderBy) { |
3906 | $orderByColumns[] = $orderBy['column']; | |
3907 | } | |
3908 | } | |
3909 | ||
3910 | foreach ($this->_columns as $tableName => $table) { | |
3911 | if (array_key_exists('fields', $table)) { | |
3912 | foreach ($table['fields'] as $fieldName => $field) { | |
9d72cede EM |
3913 | if (!empty($field['required']) || |
3914 | !empty($this->_params['fields'][$fieldName]) | |
3915 | ) { | |
6a488035 TO |
3916 | $this->_selectedTables[] = $tableName; |
3917 | break; | |
3918 | } | |
3919 | } | |
3920 | } | |
3921 | if (array_key_exists('order_bys', $table)) { | |
3922 | foreach ($table['order_bys'] as $orderByName => $orderBy) { | |
3923 | if (in_array($orderByName, $orderByColumns)) { | |
3924 | $this->_selectedTables[] = $tableName; | |
3925 | break; | |
3926 | } | |
3927 | } | |
3928 | } | |
3929 | if (array_key_exists('filters', $table)) { | |
3930 | foreach ($table['filters'] as $filterName => $filter) { | |
a7488080 | 3931 | if (!empty($this->_params["{$filterName}_value"]) || |
9d72cede EM |
3932 | CRM_Utils_Array::value("{$filterName}_op", $this->_params) == |
3933 | 'nll' || | |
3934 | CRM_Utils_Array::value("{$filterName}_op", $this->_params) == | |
3935 | 'nnll' | |
6a488035 TO |
3936 | ) { |
3937 | $this->_selectedTables[] = $tableName; | |
3938 | break; | |
3939 | } | |
3940 | } | |
3941 | } | |
3942 | } | |
3943 | } | |
3944 | return $this->_selectedTables; | |
3945 | } | |
3946 | ||
850e4640 | 3947 | /** |
317a8023 | 3948 | * Add address fields. |
3949 | * | |
850e4640 E |
3950 | * @deprecated - use getAddressColumns which is a more accurate description |
3951 | * and also accepts an array of options rather than a long list | |
3952 | * | |
c490a46a | 3953 | * adding address fields to construct function in reports |
77b97be7 | 3954 | * |
7e06c9f5 TO |
3955 | * @param bool $groupBy |
3956 | * Add GroupBy? Not appropriate for detail report. | |
3957 | * @param bool $orderBy | |
3958 | * Add GroupBy? Not appropriate for detail report. | |
77b97be7 EM |
3959 | * @param bool $filters |
3960 | * @param array $defaults | |
3961 | * | |
a6c01b45 CW |
3962 | * @return array |
3963 | * address fields for construct clause | |
6a488035 | 3964 | */ |
00be9182 | 3965 | public function addAddressFields($groupBy = TRUE, $orderBy = FALSE, $filters = TRUE, $defaults = array('country_id' => TRUE)) { |
6a488035 | 3966 | $addressFields = array( |
9d72cede | 3967 | 'civicrm_address' => array( |
6a488035 | 3968 | 'dao' => 'CRM_Core_DAO_Address', |
9d72cede | 3969 | 'fields' => array( |
e5575773 | 3970 | 'address_name' => array( |
9d72cede | 3971 | 'title' => ts('Address Name'), |
6a488035 | 3972 | 'default' => CRM_Utils_Array::value('name', $defaults, FALSE), |
e5575773 | 3973 | 'name' => 'name', |
6a488035 | 3974 | ), |
9d72cede EM |
3975 | 'street_address' => array( |
3976 | 'title' => ts('Street Address'), | |
6a488035 TO |
3977 | 'default' => CRM_Utils_Array::value('street_address', $defaults, FALSE), |
3978 | ), | |
9d72cede EM |
3979 | 'supplemental_address_1' => array( |
3980 | 'title' => ts('Supplementary Address Field 1'), | |
6a488035 TO |
3981 | 'default' => CRM_Utils_Array::value('supplemental_address_1', $defaults, FALSE), |
3982 | ), | |
9d72cede EM |
3983 | 'supplemental_address_2' => array( |
3984 | 'title' => ts('Supplementary Address Field 2'), | |
6a488035 TO |
3985 | 'default' => CRM_Utils_Array::value('supplemental_address_2', $defaults, FALSE), |
3986 | ), | |
9d72cede | 3987 | 'street_number' => array( |
6a488035 TO |
3988 | 'name' => 'street_number', |
3989 | 'title' => ts('Street Number'), | |
3990 | 'type' => 1, | |
3991 | 'default' => CRM_Utils_Array::value('street_number', $defaults, FALSE), | |
3992 | ), | |
9d72cede | 3993 | 'street_name' => array( |
6a488035 TO |
3994 | 'name' => 'street_name', |
3995 | 'title' => ts('Street Name'), | |
3996 | 'type' => 1, | |
3997 | 'default' => CRM_Utils_Array::value('street_name', $defaults, FALSE), | |
3998 | ), | |
9d72cede | 3999 | 'street_unit' => array( |
6a488035 TO |
4000 | 'name' => 'street_unit', |
4001 | 'title' => ts('Street Unit'), | |
4002 | 'type' => 1, | |
4003 | 'default' => CRM_Utils_Array::value('street_unit', $defaults, FALSE), | |
4004 | ), | |
9d72cede EM |
4005 | 'city' => array( |
4006 | 'title' => ts('City'), | |
6a488035 TO |
4007 | 'default' => CRM_Utils_Array::value('city', $defaults, FALSE), |
4008 | ), | |
9d72cede EM |
4009 | 'postal_code' => array( |
4010 | 'title' => ts('Postal Code'), | |
6a488035 | 4011 | 'default' => CRM_Utils_Array::value('postal_code', $defaults, FALSE), |
4cbdd2b1 | 4012 | ), |
9d72cede EM |
4013 | 'postal_code_suffix' => array( |
4014 | 'title' => ts('Postal Code Suffix'), | |
4cbdd2b1 | 4015 | 'default' => CRM_Utils_Array::value('postal_code_suffix', $defaults, FALSE), |
6a488035 | 4016 | ), |
9d72cede EM |
4017 | 'country_id' => array( |
4018 | 'title' => ts('Country'), | |
4019 | 'default' => CRM_Utils_Array::value('country_id', $defaults, FALSE), | |
4020 | ), | |
4021 | 'state_province_id' => array( | |
4022 | 'title' => ts('State/Province'), | |
6a488035 TO |
4023 | 'default' => CRM_Utils_Array::value('state_province_id', $defaults, FALSE), |
4024 | ), | |
9d72cede EM |
4025 | 'county_id' => array( |
4026 | 'title' => ts('County'), | |
4027 | 'default' => CRM_Utils_Array::value('county_id', $defaults, FALSE), | |
4028 | ), | |
6a488035 TO |
4029 | ), |
4030 | 'grouping' => 'location-fields', | |
4031 | ), | |
4032 | ); | |
4033 | ||
4034 | if ($filters) { | |
4035 | $addressFields['civicrm_address']['filters'] = array( | |
9d72cede EM |
4036 | 'street_number' => array( |
4037 | 'title' => ts('Street Number'), | |
4038 | 'type' => 1, | |
4039 | 'name' => 'street_number', | |
6a488035 | 4040 | ), |
9d72cede EM |
4041 | 'street_name' => array( |
4042 | 'title' => ts('Street Name'), | |
4043 | 'name' => 'street_name', | |
4044 | 'operator' => 'like', | |
6a488035 | 4045 | ), |
9d72cede EM |
4046 | 'postal_code' => array( |
4047 | 'title' => ts('Postal Code'), | |
4048 | 'type' => 1, | |
4049 | 'name' => 'postal_code', | |
6a488035 | 4050 | ), |
9d72cede EM |
4051 | 'city' => array( |
4052 | 'title' => ts('City'), | |
4053 | 'operator' => 'like', | |
4054 | 'name' => 'city', | |
6a488035 | 4055 | ), |
863581d1 CW |
4056 | 'country_id' => array( |
4057 | 'name' => 'country_id', | |
4058 | 'title' => ts('Country'), | |
6a488035 | 4059 | 'type' => CRM_Utils_Type::T_INT, |
9d72cede | 4060 | 'operatorType' => CRM_Report_Form::OP_MULTISELECT, |
c927c151 | 4061 | 'options' => CRM_Core_PseudoConstant::country(), |
6a488035 TO |
4062 | ), |
4063 | 'state_province_id' => array( | |
4064 | 'name' => 'state_province_id', | |
4065 | 'title' => ts('State/Province'), | |
4066 | 'type' => CRM_Utils_Type::T_INT, | |
c927c151 CW |
4067 | 'operatorType' => CRM_Report_Form::OP_MULTISELECT, |
4068 | 'options' => array(), | |
6a488035 | 4069 | ), |
863581d1 CW |
4070 | 'county_id' => array( |
4071 | 'name' => 'county_id', | |
4072 | 'title' => ts('County'), | |
6a488035 | 4073 | 'type' => CRM_Utils_Type::T_INT, |
c927c151 CW |
4074 | 'operatorType' => CRM_Report_Form::OP_MULTISELECT, |
4075 | 'options' => array(), | |
6a488035 TO |
4076 | ), |
4077 | ); | |
4078 | } | |
4079 | ||
4080 | if ($orderBy) { | |
9d72cede EM |
4081 | $addressFields['civicrm_address']['order_bys'] = array( |
4082 | 'street_name' => array('title' => ts('Street Name')), | |
4083 | 'street_number' => array('title' => 'Odd / Even Street Number'), | |
4084 | 'street_address' => NULL, | |
4085 | 'city' => NULL, | |
4086 | 'postal_code' => NULL, | |
6a488035 TO |
4087 | ); |
4088 | } | |
4089 | ||
4090 | if ($groupBy) { | |
4091 | $addressFields['civicrm_address']['group_bys'] = array( | |
4092 | 'street_address' => NULL, | |
4093 | 'city' => NULL, | |
4094 | 'postal_code' => NULL, | |
9d72cede EM |
4095 | 'state_province_id' => array( |
4096 | 'title' => ts('State/Province'), | |
6a488035 | 4097 | ), |
9d72cede EM |
4098 | 'country_id' => array( |
4099 | 'title' => ts('Country'), | |
6a488035 | 4100 | ), |
9d72cede EM |
4101 | 'county_id' => array( |
4102 | 'title' => ts('County'), | |
6a488035 TO |
4103 | ), |
4104 | ); | |
4105 | } | |
4106 | return $addressFields; | |
4107 | } | |
4108 | ||
74cf4551 | 4109 | /** |
fe482240 | 4110 | * Do AlterDisplay processing on Address Fields. |
688d37c6 | 4111 | * |
317a8023 | 4112 | * @param array $row |
4113 | * @param array $rows | |
4114 | * @param int $rowNum | |
4115 | * @param string $baseUrl | |
e4e2ff09 | 4116 | * @param string $linkText |
74cf4551 EM |
4117 | * |
4118 | * @return bool | |
4119 | */ | |
e4e2ff09 | 4120 | public function alterDisplayAddressFields(&$row, &$rows, &$rowNum, $baseUrl, $linkText) { |
6a488035 TO |
4121 | $criteriaQueryParams = CRM_Report_Utils_Report::getPreviewCriteriaQueryParams($this->_defaults, $this->_params); |
4122 | $entryFound = FALSE; | |
4123 | // handle country | |
4124 | if (array_key_exists('civicrm_address_country_id', $row)) { | |
4125 | if ($value = $row['civicrm_address_country_id']) { | |
4126 | $rows[$rowNum]['civicrm_address_country_id'] = CRM_Core_PseudoConstant::country($value, FALSE); | |
4127 | $url = CRM_Report_Utils_Report::getNextUrl($baseUrl, | |
9d72cede EM |
4128 | "reset=1&force=1&{$criteriaQueryParams}&" . |
4129 | "country_id_op=in&country_id_value={$value}", | |
4130 | $this->_absoluteUrl, $this->_id | |
6a488035 TO |
4131 | ); |
4132 | $rows[$rowNum]['civicrm_address_country_id_link'] = $url; | |
4133 | $rows[$rowNum]['civicrm_address_country_id_hover'] = ts("%1 for this country.", | |
e4e2ff09 | 4134 | array(1 => $linkText) |
6a488035 TO |
4135 | ); |
4136 | } | |
4137 | ||
4138 | $entryFound = TRUE; | |
4139 | } | |
4140 | if (array_key_exists('civicrm_address_county_id', $row)) { | |
4141 | if ($value = $row['civicrm_address_county_id']) { | |
4142 | $rows[$rowNum]['civicrm_address_county_id'] = CRM_Core_PseudoConstant::county($value, FALSE); | |
4143 | $url = CRM_Report_Utils_Report::getNextUrl($baseUrl, | |
9d72cede EM |
4144 | "reset=1&force=1&{$criteriaQueryParams}&" . |
4145 | "county_id_op=in&county_id_value={$value}", | |
4146 | $this->_absoluteUrl, $this->_id | |
6a488035 TO |
4147 | ); |
4148 | $rows[$rowNum]['civicrm_address_county_id_link'] = $url; | |
4149 | $rows[$rowNum]['civicrm_address_county_id_hover'] = ts("%1 for this county.", | |
e4e2ff09 | 4150 | array(1 => $linkText) |
6a488035 TO |
4151 | ); |
4152 | } | |
4153 | $entryFound = TRUE; | |
4154 | } | |
4155 | // handle state province | |
4156 | if (array_key_exists('civicrm_address_state_province_id', $row)) { | |
4157 | if ($value = $row['civicrm_address_state_province_id']) { | |
4158 | $rows[$rowNum]['civicrm_address_state_province_id'] = CRM_Core_PseudoConstant::stateProvince($value, FALSE); | |
4159 | ||
4160 | $url = CRM_Report_Utils_Report::getNextUrl($baseUrl, | |
9d72cede EM |
4161 | "reset=1&force=1&{$criteriaQueryParams}&state_province_id_op=in&state_province_id_value={$value}", |
4162 | $this->_absoluteUrl, $this->_id | |
6a488035 TO |
4163 | ); |
4164 | $rows[$rowNum]['civicrm_address_state_province_id_link'] = $url; | |
4165 | $rows[$rowNum]['civicrm_address_state_province_id_hover'] = ts("%1 for this state.", | |
e4e2ff09 | 4166 | array(1 => $linkText) |
6a488035 TO |
4167 | ); |
4168 | } | |
4169 | $entryFound = TRUE; | |
4170 | } | |
4171 | ||
4172 | return $entryFound; | |
4173 | } | |
4174 | ||
e5575773 | 4175 | /** |
4176 | * Do AlterDisplay processing on Address Fields. | |
4177 | * | |
4178 | * @param array $row | |
4179 | * @param array $rows | |
4180 | * @param int $rowNum | |
e4e2ff09 | 4181 | * @param string $baseUrl |
4182 | * @param string $linkText | |
e5575773 | 4183 | * |
4184 | * @return bool | |
4185 | */ | |
e4e2ff09 | 4186 | public function alterDisplayContactFields(&$row, &$rows, &$rowNum, $baseUrl, $linkText) { |
e5575773 | 4187 | $entryFound = FALSE; |
d9bf3c53 | 4188 | // There is no reason not to add links for all fields but it seems a bit odd to be able to click on |
4189 | // 'Mrs'. Also, we don't have metadata about the title. So, add selectively to addLinks. | |
4190 | $addLinks = array('gender_id' => 'Gender'); | |
50172d25 | 4191 | foreach (array('prefix_id', 'suffix_id', 'gender_id') as $fieldName) { |
4192 | if (array_key_exists('civicrm_contact_' . $fieldName, $row)) { | |
4193 | if (($value = $row['civicrm_contact_' . $fieldName]) != FALSE) { | |
4194 | $rows[$rowNum]['civicrm_contact_' . $fieldName] = CRM_Core_Pseudoconstant::getLabel('CRM_Contact_BAO_Contact', $fieldName, $value); | |
d9bf3c53 | 4195 | if (($title = CRM_Utils_Array::value($fieldName, $addLinks)) != FALSE) { |
4196 | $this->addLinkToRow($rows[$rowNum], $baseUrl, $linkText, $value, $fieldName, 'civicrm_contact', $title); | |
4197 | } | |
50172d25 | 4198 | } |
4199 | $entryFound = TRUE; | |
e5575773 | 4200 | } |
e5575773 | 4201 | } |
4202 | return $entryFound; | |
4203 | } | |
4204 | ||
74cf4551 | 4205 | /** |
688d37c6 CW |
4206 | * Adjusts dates passed in to YEAR() for fiscal year. |
4207 | * | |
100fef9d | 4208 | * @param string $fieldName |
74cf4551 EM |
4209 | * |
4210 | * @return string | |
4211 | */ | |
00be9182 | 4212 | public function fiscalYearOffset($fieldName) { |
6a488035 TO |
4213 | $config = CRM_Core_Config::singleton(); |
4214 | $fy = $config->fiscalYearStart; | |
9d72cede EM |
4215 | if (CRM_Utils_Array::value('yid_op', $this->_params) == 'calendar' || |
4216 | ($fy['d'] == 1 && $fy['M'] == 1) | |
4217 | ) { | |
6a488035 TO |
4218 | return "YEAR( $fieldName )"; |
4219 | } | |
9d72cede EM |
4220 | return "YEAR( $fieldName - INTERVAL " . ($fy['M'] - 1) . " MONTH" . |
4221 | ($fy['d'] > 1 ? (" - INTERVAL " . ($fy['d'] - 1) . " DAY") : '') . " )"; | |
6a488035 TO |
4222 | } |
4223 | ||
688d37c6 | 4224 | /** |
fe482240 | 4225 | * Add Address into From Table if required. |
6a488035 | 4226 | */ |
00be9182 | 4227 | public function addAddressFromClause() { |
6a488035 TO |
4228 | // include address field if address column is to be included |
4229 | if ((isset($this->_addressField) && | |
4230 | $this->_addressField | |
4231 | ) || | |
4232 | $this->isTableSelected('civicrm_address') | |
4233 | ) { | |
4234 | $this->_from .= " | |
4235 | LEFT JOIN civicrm_address {$this->_aliases['civicrm_address']} | |
4236 | ON ({$this->_aliases['civicrm_contact']}.id = | |
4237 | {$this->_aliases['civicrm_address']}.contact_id) AND | |
4238 | {$this->_aliases['civicrm_address']}.is_primary = 1\n"; | |
4239 | } | |
4240 | } | |
4241 | ||
850e4640 | 4242 | /** |
fe482240 | 4243 | * Add Phone into From Table if required. |
850e4640 | 4244 | */ |
00be9182 | 4245 | public function addPhoneFromClause() { |
850e4640 E |
4246 | // include address field if address column is to be included |
4247 | if ($this->isTableSelected('civicrm_phone') | |
4248 | ) { | |
4249 | $this->_from .= " | |
4250 | LEFT JOIN civicrm_phone {$this->_aliases['civicrm_phone']} | |
4251 | ON ({$this->_aliases['civicrm_contact']}.id = | |
4252 | {$this->_aliases['civicrm_phone']}.contact_id) AND | |
4253 | {$this->_aliases['civicrm_phone']}.is_primary = 1\n"; | |
4254 | } | |
4255 | } | |
4256 | ||
4257 | /** | |
fe482240 | 4258 | * Get phone columns to add to array. |
9d72cede | 4259 | * |
850e4640 | 4260 | * @param array $options |
16b10e64 CW |
4261 | * - prefix Prefix to add to table (in case of more than one instance of the table) |
4262 | * - prefix_label Label to give columns from this phone table instance | |
9d72cede | 4263 | * |
a6c01b45 CW |
4264 | * @return array |
4265 | * phone columns definition | |
850e4640 | 4266 | */ |
00be9182 | 4267 | public function getPhoneColumns($options = array()) { |
850e4640 E |
4268 | $defaultOptions = array( |
4269 | 'prefix' => '', | |
4270 | 'prefix_label' => '', | |
4271 | ); | |
4272 | ||
9d72cede | 4273 | $options = array_merge($defaultOptions, $options); |
850e4640 E |
4274 | |
4275 | $fields = array( | |
4276 | $options['prefix'] . 'civicrm_phone' => array( | |
9d72cede | 4277 | 'dao' => 'CRM_Core_DAO_Phone', |
850e4640 E |
4278 | 'fields' => array( |
4279 | $options['prefix'] . 'phone' => array( | |
4280 | 'title' => ts($options['prefix_label'] . 'Phone'), | |
21dfd5f5 | 4281 | 'name' => 'phone', |
850e4640 E |
4282 | ), |
4283 | ), | |
4284 | ), | |
4285 | ); | |
4286 | return $fields; | |
4287 | } | |
4288 | ||
4289 | /** | |
fe482240 | 4290 | * Get address columns to add to array. |
9d72cede | 4291 | * |
850e4640 | 4292 | * @param array $options |
16b10e64 CW |
4293 | * - prefix Prefix to add to table (in case of more than one instance of the table) |
4294 | * - prefix_label Label to give columns from this address table instance | |
9d72cede | 4295 | * |
a6c01b45 CW |
4296 | * @return array |
4297 | * address columns definition | |
850e4640 | 4298 | */ |
00be9182 | 4299 | public function getAddressColumns($options = array()) { |
c927c151 | 4300 | $options += array( |
850e4640 E |
4301 | 'prefix' => '', |
4302 | 'prefix_label' => '', | |
4303 | 'group_by' => TRUE, | |
4304 | 'order_by' => TRUE, | |
4305 | 'filters' => TRUE, | |
c927c151 | 4306 | 'defaults' => array(), |
850e4640 | 4307 | ); |
850e4640 E |
4308 | return $this->addAddressFields( |
4309 | $options['group_by'], | |
4310 | $options['order_by'], | |
4311 | $options['filters'], | |
4312 | $options['defaults'] | |
4313 | ); | |
850e4640 E |
4314 | } |
4315 | ||
e5575773 | 4316 | /** |
4317 | * Get a standard set of contact fields. | |
4318 | * | |
4319 | * @return array | |
4320 | */ | |
4321 | public function getBasicContactFields() { | |
4322 | return array( | |
4323 | 'sort_name' => array( | |
4324 | 'title' => ts('Contact Name'), | |
4325 | 'required' => TRUE, | |
4326 | 'default' => TRUE, | |
4327 | ), | |
4328 | 'id' => array( | |
4329 | 'no_display' => TRUE, | |
4330 | 'required' => TRUE, | |
4331 | ), | |
4332 | 'prefix_id' => array( | |
4333 | 'title' => ts('Contact Prefix'), | |
4334 | ), | |
4335 | 'first_name' => array( | |
4336 | 'title' => ts('First Name'), | |
4337 | ), | |
4120c775 | 4338 | 'nick_name' => array( |
4339 | 'title' => ts('Nick Name'), | |
4340 | ), | |
e5575773 | 4341 | 'middle_name' => array( |
4342 | 'title' => ts('Middle Name'), | |
4343 | ), | |
4344 | 'last_name' => array( | |
4345 | 'title' => ts('Last Name'), | |
4346 | ), | |
4347 | 'suffix_id' => array( | |
4348 | 'title' => ts('Contact Suffix'), | |
4349 | ), | |
4350 | 'postal_greeting_display' => array('title' => ts('Postal Greeting')), | |
4351 | 'email_greeting_display' => array('title' => ts('Email Greeting')), | |
f0a98c82 | 4352 | 'addressee_display' => array('title' => ts('Address Greeting')), |
e5575773 | 4353 | 'contact_type' => array( |
4354 | 'title' => ts('Contact Type'), | |
4355 | ), | |
4356 | 'contact_sub_type' => array( | |
4357 | 'title' => ts('Contact Subtype'), | |
4358 | ), | |
4359 | 'gender_id' => array( | |
4360 | 'title' => ts('Gender'), | |
4361 | ), | |
4362 | 'birth_date' => array( | |
4363 | 'title' => ts('Birth Date'), | |
4364 | ), | |
4365 | 'age' => array( | |
4366 | 'title' => ts('Age'), | |
4367 | 'dbAlias' => 'TIMESTAMPDIFF(YEAR, contact_civireport.birth_date, CURDATE())', | |
4368 | ), | |
4369 | 'job_title' => array( | |
4370 | 'title' => ts('Contact Job title'), | |
4371 | ), | |
4372 | 'organization_name' => array( | |
4373 | 'title' => ts('Organization Name'), | |
4374 | ), | |
b4d1eebe | 4375 | 'external_identifier' => array( |
4376 | 'title' => ts('Contact identifier from external system'), | |
4377 | ), | |
e5575773 | 4378 | ); |
4379 | } | |
4380 | ||
74cf4551 | 4381 | /** |
317a8023 | 4382 | * Add contact to group. |
4383 | * | |
100fef9d | 4384 | * @param int $groupID |
74cf4551 | 4385 | */ |
00be9182 | 4386 | public function add2group($groupID) { |
6a488035 TO |
4387 | if (is_numeric($groupID) && isset($this->_aliases['civicrm_contact'])) { |
4388 | $select = "SELECT DISTINCT {$this->_aliases['civicrm_contact']}.id AS addtogroup_contact_id, "; | |
4389 | $select = str_ireplace('SELECT SQL_CALC_FOUND_ROWS ', $select, $this->_select); | |
4390 | ||
4391 | $sql = "{$select} {$this->_from} {$this->_where} {$this->_groupBy} {$this->_having} {$this->_orderBy}"; | |
e05e0dba | 4392 | $sql = str_replace('WITH ROLLUP', '', $sql); |
6a488035 TO |
4393 | $dao = CRM_Core_DAO::executeQuery($sql); |
4394 | ||
4395 | $contact_ids = array(); | |
4396 | // Add resulting contacts to group | |
4397 | while ($dao->fetch()) { | |
4398 | if ($dao->addtogroup_contact_id) { | |
4399 | $contact_ids[$dao->addtogroup_contact_id] = $dao->addtogroup_contact_id; | |
4400 | } | |
4401 | } | |
4402 | ||
9d72cede | 4403 | if (!empty($contact_ids)) { |
6a488035 TO |
4404 | CRM_Contact_BAO_GroupContact::addContactsToGroup($contact_ids, $groupID); |
4405 | CRM_Core_Session::setStatus(ts("Listed contact(s) have been added to the selected group."), ts('Contacts Added'), 'success'); | |
4406 | } | |
4407 | else { | |
4408 | CRM_Core_Session::setStatus(ts("The listed records(s) cannot be added to the group.")); | |
4409 | } | |
4410 | } | |
4411 | } | |
46065582 | 4412 | |
688d37c6 | 4413 | /** |
317a8023 | 4414 | * Show charts on print screen. |
688d37c6 | 4415 | */ |
00be9182 | 4416 | public static function uploadChartImage() { |
46065582 | 4417 | // upload strictly for '.png' images |
d04d4eef PJ |
4418 | $name = trim(basename(CRM_Utils_Request::retrieve('name', 'String', CRM_Core_DAO::$_nullObject, FALSE, NULL, 'GET'))); |
4419 | if (preg_match('/\.png$/', $name)) { | |
46065582 PJ |
4420 | // |
4421 | // POST data is usually string data, but we are passing a RAW .png | |
4422 | // so PHP is a bit confused and $_POST is empty. But it has saved | |
4423 | // the raw bits into $HTTP_RAW_POST_DATA | |
4424 | // | |
4425 | $httpRawPostData = $GLOBALS['HTTP_RAW_POST_DATA']; | |
4426 | ||
4427 | // prepare the directory | |
4428 | $config = CRM_Core_Config::singleton(); | |
971d41b1 CW |
4429 | $defaultPath |
4430 | = str_replace('/persist/contribute/', '/persist/', $config->imageUploadDir) . | |
9d72cede | 4431 | '/openFlashChart/'; |
46065582 PJ |
4432 | if (!file_exists($defaultPath)) { |
4433 | mkdir($defaultPath, 0777, TRUE); | |
4434 | } | |
4435 | ||
4436 | // full path to the saved image including filename | |
d04d4eef | 4437 | $destination = $defaultPath . $name; |
46065582 PJ |
4438 | |
4439 | //write and save | |
4440 | $jfh = fopen($destination, 'w') or die("can't open file"); | |
4441 | fwrite($jfh, $httpRawPostData); | |
4442 | fclose($jfh); | |
4443 | CRM_Utils_System::civiExit(); | |
4444 | } | |
4445 | } | |
2107cde9 CW |
4446 | |
4447 | /** | |
fe482240 | 4448 | * Apply common settings to entityRef fields. |
9d72cede | 4449 | * |
2107cde9 CW |
4450 | * @param array $field |
4451 | * @param string $table | |
4452 | */ | |
4453 | private function setEntityRefDefaults(&$field, $table) { | |
4454 | $field['attributes'] = $field['attributes'] ? $field['attributes'] : array(); | |
4455 | $field['attributes'] += array( | |
4456 | 'entity' => CRM_Core_DAO_AllCoreTables::getBriefName(CRM_Core_DAO_AllCoreTables::getClassForTable($table)), | |
4457 | 'multiple' => TRUE, | |
4458 | 'placeholder' => ts('- select -'), | |
4459 | ); | |
4460 | } | |
96025800 | 4461 | |
e4e2ff09 | 4462 | /** |
4463 | * Add link fields to the row. | |
4464 | * | |
4465 | * Function adds the _link & _hover fields to the row. | |
4466 | * | |
4467 | * @param array $row | |
4468 | * @param string $baseUrl | |
4469 | * @param string $linkText | |
4470 | * @param string $value | |
4471 | * @param string $fieldName | |
4472 | * @param string $tablePrefix | |
4473 | * @param string $fieldLabel | |
4474 | * | |
4475 | * @return mixed | |
4476 | */ | |
4477 | protected function addLinkToRow(&$row, $baseUrl, $linkText, $value, $fieldName, $tablePrefix, $fieldLabel) { | |
4478 | $criteriaQueryParams = CRM_Report_Utils_Report::getPreviewCriteriaQueryParams($this->_defaults, $this->_params); | |
4479 | $url = CRM_Report_Utils_Report::getNextUrl($baseUrl, | |
4480 | "reset=1&force=1&{$criteriaQueryParams}&" . | |
4481 | $fieldName . "_op=in&{$fieldName}_value={$value}", | |
4482 | $this->_absoluteUrl, $this->_id | |
4483 | ); | |
4484 | $row["{$tablePrefix}_{$fieldName}_link"] = $url; | |
4485 | $row["{$tablePrefix}_{$fieldName}_hover"] = ts("%1 for this %2.", | |
4486 | array(1 => $linkText, 2 => $fieldLabel) | |
4487 | ); | |
4488 | } | |
4489 | ||
232624b1 | 4490 | } |