Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
6a488035 | 2 | /* |
36241b02 | 3 | +--------------------------------------------------------------------+ |
fee14197 | 4 | | CiviCRM version 5 | |
db4cd986 | 5 | +--------------------------------------------------------------------+ |
6b83d5bd | 6 | | Copyright CiviCRM LLC (c) 2004-2019 | |
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 | * | |
9f266042 | 52 | * @var int |
6a488035 TO |
53 | */ |
54 | protected $_id; | |
55 | ||
56 | /** | |
57 | * The id of the report template | |
58 | * | |
9f266042 | 59 | * @var int |
6a488035 TO |
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 | */ | |
be2fb01f | 77 | protected $_columns = []; |
6a488035 TO |
78 | |
79 | /** | |
80 | * The set of filters in the report | |
81 | * | |
82 | * @var array | |
83 | */ | |
be2fb01f | 84 | protected $_filters = []; |
6a488035 TO |
85 | |
86 | /** | |
87 | * The set of optional columns in the report | |
88 | * | |
89 | * @var array | |
90 | */ | |
be2fb01f | 91 | public $_options = []; |
6a488035 | 92 | |
688d37c6 | 93 | /** |
6a488035 TO |
94 | * By default most reports hide contact id. |
95 | * Setting this to true makes it available | |
c86d4e7c | 96 | * @var bool |
6a488035 TO |
97 | */ |
98 | protected $_exposeContactID = TRUE; | |
99 | ||
100 | /** | |
101 | * Set of statistic fields | |
102 | * | |
103 | * @var array | |
104 | */ | |
be2fb01f | 105 | protected $_statFields = []; |
6a488035 TO |
106 | |
107 | /** | |
108 | * Set of statistics data | |
109 | * | |
110 | * @var array | |
111 | */ | |
be2fb01f | 112 | protected $_statistics = []; |
6a488035 TO |
113 | |
114 | /** | |
115 | * List of fields not to be repeated during display | |
116 | * | |
117 | * @var array | |
118 | */ | |
be2fb01f | 119 | protected $_noRepeats = []; |
6a488035 TO |
120 | |
121 | /** | |
122 | * List of fields not to be displayed | |
123 | * | |
124 | * @var array | |
125 | */ | |
be2fb01f | 126 | protected $_noDisplay = []; |
6a488035 TO |
127 | |
128 | /** | |
129 | * Object type that a custom group extends | |
130 | * | |
131 | * @var null | |
132 | */ | |
133 | protected $_customGroupExtends = NULL; | |
be2fb01f | 134 | protected $_customGroupExtendsJoin = []; |
6a488035 TO |
135 | protected $_customGroupFilters = TRUE; |
136 | protected $_customGroupGroupBy = FALSE; | |
9d72cede | 137 | protected $_customGroupJoin = 'LEFT JOIN'; |
6a488035 TO |
138 | |
139 | /** | |
100fef9d | 140 | * Build tags filter |
c86d4e7c | 141 | * @var bool |
6a488035 TO |
142 | */ |
143 | protected $_tagFilter = FALSE; | |
144 | ||
145 | /** | |
ed795723 | 146 | * specify entity table for tags filter |
c86d4e7c | 147 | * @var string |
ed795723 JM |
148 | */ |
149 | protected $_tagFilterTable = 'civicrm_contact'; | |
150 | ||
6a488035 | 151 | /** |
0b62c1ab | 152 | * Build groups filter. |
6a488035 | 153 | * |
f587aa17 | 154 | * @var bool |
6a488035 TO |
155 | */ |
156 | protected $_groupFilter = FALSE; | |
157 | ||
43c1fa19 | 158 | /** |
159 | * Has the report been optimised for group filtering. | |
160 | * | |
161 | * The functionality for group filtering has been improved but not | |
162 | * all reports have been adjusted to take care of it. | |
163 | * | |
164 | * This property exists to highlight the reports which are still using the | |
165 | * slow method & allow group filtering to still work for them until they | |
166 | * can be migrated. | |
167 | * | |
168 | * In order to protect extensions we have to default to TRUE - but I have | |
169 | * separately marked every class with a groupFilter in the hope that will trigger | |
170 | * people to fix them as they touch them. | |
171 | * | |
172 | * CRM-19170 | |
173 | * | |
174 | * @var bool | |
175 | */ | |
176 | protected $groupFilterNotOptimised = TRUE; | |
177 | ||
6a488035 TO |
178 | /** |
179 | * Navigation fields | |
180 | * | |
181 | * @var array | |
182 | */ | |
be2fb01f | 183 | public $_navigation = []; |
6a488035 | 184 | |
be2fb01f | 185 | public $_drilldownReport = []; |
6a488035 | 186 | |
50951061 | 187 | /** |
0b62c1ab EM |
188 | * Array of tabs to display on report. |
189 | * | |
190 | * E.g we define the tab title, the tpl and the tab-specific part of the css or html link. | |
191 | * | |
192 | * $this->tabs['OrderBy'] = array( | |
193 | * 'title' => ts('Sorting'), | |
194 | * 'tpl' => 'OrderBy', | |
195 | * 'div_label' => 'order-by', | |
196 | * ); | |
50951061 EM |
197 | * |
198 | * @var array | |
199 | */ | |
be2fb01f | 200 | protected $tabs = []; |
50951061 | 201 | |
182f5081 | 202 | /** |
203 | * Should we add paging. | |
204 | * | |
205 | * @var bool | |
206 | */ | |
207 | protected $addPaging = TRUE; | |
208 | ||
81a22d3d | 209 | protected $isForceGroupBy = FALSE; |
210 | ||
211 | protected $groupConcatTested = FALSE; | |
212 | ||
6a488035 TO |
213 | /** |
214 | * An attribute for checkbox/radio form field layout | |
215 | * | |
216 | * @var array | |
217 | */ | |
be2fb01f | 218 | protected $_fourColumnAttribute = [ |
9d72cede EM |
219 | '</td><td width="25%">', |
220 | '</td><td width="25%">', | |
221 | '</td><td width="25%">', | |
222 | '</tr><tr><td>', | |
be2fb01f | 223 | ]; |
6a488035 TO |
224 | |
225 | protected $_force = 1; | |
226 | ||
227 | protected $_params = NULL; | |
228 | protected $_formValues = NULL; | |
229 | protected $_instanceValues = NULL; | |
230 | ||
231 | protected $_instanceForm = FALSE; | |
232 | protected $_criteriaForm = FALSE; | |
233 | ||
234 | protected $_instanceButtonName = NULL; | |
235 | protected $_createNewButtonName = NULL; | |
236 | protected $_printButtonName = NULL; | |
237 | protected $_pdfButtonName = NULL; | |
238 | protected $_csvButtonName = NULL; | |
239 | protected $_groupButtonName = NULL; | |
240 | protected $_chartButtonName = NULL; | |
241 | protected $_csvSupported = TRUE; | |
242 | protected $_add2groupSupported = TRUE; | |
243 | protected $_groups = NULL; | |
9b0380d9 | 244 | protected $_grandFlag = FALSE; |
6a488035 | 245 | protected $_rowsFound = NULL; |
be2fb01f | 246 | protected $_selectAliases = []; |
6a488035 | 247 | protected $_rollup = NULL; |
6f900755 | 248 | |
43c1fa19 | 249 | /** |
250 | * Table containing list of contact IDs within the group filter. | |
251 | * | |
252 | * @var string | |
253 | */ | |
254 | protected $groupTempTable = ''; | |
255 | ||
f587aa17 EM |
256 | /** |
257 | * @var array | |
258 | */ | |
be2fb01f | 259 | protected $_aliases = []; |
f587aa17 EM |
260 | |
261 | /** | |
262 | * @var string | |
263 | */ | |
264 | protected $_where; | |
265 | ||
266 | /** | |
267 | * @var string | |
268 | */ | |
269 | protected $_from; | |
270 | ||
6f900755 E |
271 | /** |
272 | * SQL Limit clause | |
273 | * @var string | |
274 | */ | |
6a488035 | 275 | protected $_limit = NULL; |
6f900755 E |
276 | |
277 | /** | |
278 | * This can be set to specify a limit to the number of rows | |
279 | * Since it is currently envisaged as part of the api usage it is only being applied | |
280 | * when $_output mode is not 'html' or 'group' so as not to have to interpret / mess with that part | |
182f5081 | 281 | * of the code (see limit() fn. |
282 | * | |
9f266042 | 283 | * @var int |
6f900755 E |
284 | */ |
285 | protected $_limitValue = NULL; | |
286 | ||
287 | /** | |
288 | * This can be set to specify row offset | |
289 | * See notes on _limitValue | |
9f266042 | 290 | * |
291 | * @var int | |
6f900755 E |
292 | */ |
293 | protected $_offsetValue = NULL; | |
cdb44cba EM |
294 | /** |
295 | * @var null | |
296 | */ | |
44d59d04 | 297 | protected $_sections = NULL; |
6a488035 TO |
298 | protected $_autoIncludeIndexedFieldsAsOrderBys = 0; |
299 | protected $_absoluteUrl = FALSE; | |
300 | ||
ae555e90 DS |
301 | /** |
302 | * Flag to indicate if result-set is to be stored in a class variable which could be retrieved using getResultSet() method. | |
303 | * | |
b67daa72 | 304 | * @var bool |
ae555e90 DS |
305 | */ |
306 | protected $_storeResultSet = FALSE; | |
307 | ||
308 | /** | |
309 | * When _storeResultSet Flag is set use this var to store result set in form of array | |
310 | * | |
b67daa72 | 311 | * @var bool |
ae555e90 | 312 | */ |
be2fb01f | 313 | protected $_resultSet = []; |
ae555e90 | 314 | |
6a488035 TO |
315 | /** |
316 | * To what frequency group-by a date column | |
317 | * | |
318 | * @var array | |
319 | */ | |
be2fb01f | 320 | protected $_groupByDateFreq = [ |
6a488035 TO |
321 | 'MONTH' => 'Month', |
322 | 'YEARWEEK' => 'Week', | |
323 | 'QUARTER' => 'Quarter', | |
324 | 'YEAR' => 'Year', | |
be2fb01f | 325 | ]; |
6a488035 TO |
326 | |
327 | /** | |
328 | * Variables to hold the acl inner join and where clause | |
cc101011 | 329 | * @var string|null |
6a488035 TO |
330 | */ |
331 | protected $_aclFrom = NULL; | |
332 | protected $_aclWhere = NULL; | |
333 | ||
334 | /** | |
568a0946 | 335 | * Array of DAO tables having columns included in SELECT or ORDER BY clause. |
336 | * | |
337 | * Where has also been added to this although perhaps the 'includes both' array should have a different name. | |
6a488035 TO |
338 | * |
339 | * @var array | |
340 | */ | |
be2fb01f | 341 | protected $_selectedTables = []; |
6a488035 | 342 | |
568a0946 | 343 | /** |
344 | * Array of DAO tables having columns included in WHERE or HAVING clause | |
345 | * | |
346 | * @var array | |
347 | */ | |
348 | protected $filteredTables; | |
349 | ||
c58f66e0 | 350 | /** |
dc0c71cf | 351 | * Output mode e.g 'print', 'csv', 'pdf'. |
352 | * | |
c58f66e0 E |
353 | * @var string |
354 | */ | |
f63fae91 | 355 | protected $_outputMode; |
c58f66e0 | 356 | |
dc0c71cf | 357 | /** |
358 | * Format of any chart in use. | |
359 | * | |
360 | * (it's unclear if this could be merged with outputMode at this stage) | |
361 | * | |
cc101011 | 362 | * @var string|null |
dc0c71cf | 363 | */ |
364 | protected $_format; | |
365 | ||
6a488035 TO |
366 | public $_having = NULL; |
367 | public $_select = NULL; | |
be2fb01f CW |
368 | public $_selectClauses = []; |
369 | public $_columnHeaders = []; | |
6a488035 | 370 | public $_orderBy = NULL; |
be2fb01f CW |
371 | public $_orderByFields = []; |
372 | public $_orderByArray = []; | |
70e504f2 | 373 | /** |
374 | * Array of clauses to group by. | |
375 | * | |
376 | * @var array | |
377 | */ | |
be2fb01f | 378 | protected $_groupByArray = []; |
6a488035 | 379 | public $_groupBy = NULL; |
be2fb01f CW |
380 | public $_whereClauses = []; |
381 | public $_havingClauses = []; | |
1c4d8c3e | 382 | |
dbb4a0f9 | 383 | /** |
cc101011 | 384 | * DashBoardRowCount Dashboard row count. |
385 | * | |
386 | * @var int | |
dbb4a0f9 PN |
387 | */ |
388 | public $_dashBoardRowCount; | |
389 | ||
c58f66e0 E |
390 | /** |
391 | * Is this being called without a form controller (ie. the report is being render outside the normal form | |
cc101011 | 392 | * - e.g the api is retrieving the rows. |
393 | * | |
b67daa72 | 394 | * @var bool |
c58f66e0 E |
395 | */ |
396 | public $noController = FALSE; | |
397 | ||
7a961f19 | 398 | /** |
cc101011 | 399 | * Variable to hold the currency alias. |
400 | * | |
401 | * @var string|null | |
7a961f19 | 402 | */ |
403 | protected $_currencyColumn = NULL; | |
6a488035 | 404 | |
2fe3c48d EM |
405 | /** |
406 | * @var string | |
407 | */ | |
408 | protected $_interval; | |
409 | ||
410 | /** | |
411 | * @var bool | |
412 | */ | |
413 | protected $_sendmail; | |
414 | ||
415 | /** | |
416 | * @var int | |
417 | */ | |
418 | protected $_chartId; | |
419 | ||
9907633b EM |
420 | /** |
421 | * @var int | |
422 | */ | |
44d59d04 | 423 | public $_section; |
9907633b EM |
424 | |
425 | /** | |
9f266042 | 426 | * Report description. |
427 | * | |
428 | * @var string | |
9907633b | 429 | */ |
15ba35a3 | 430 | public $_description; |
9907633b EM |
431 | |
432 | /** | |
9f266042 | 433 | * Is an address field selected. |
434 | * | |
435 | * @var bool | |
9907633b EM |
436 | * This was intended to determine if the address table should be joined in |
437 | * The isTableSelected function is now preferred for this purpose | |
438 | */ | |
439 | protected $_addressField; | |
440 | ||
441 | /** | |
9f266042 | 442 | * Is an email field selected. |
443 | * | |
444 | * @var bool | |
9907633b EM |
445 | * This was intended to determine if the email table should be joined in |
446 | * The isTableSelected function is now preferred for this purpose | |
447 | */ | |
448 | protected $_emailField; | |
449 | ||
450 | /** | |
9f266042 | 451 | * Is a phone field selected. |
452 | * | |
453 | * @var bool | |
9907633b EM |
454 | * This was intended to determine if the phone table should be joined in |
455 | * The isTableSelected function is now preferred for this purpose | |
456 | */ | |
457 | protected $_phoneField; | |
458 | ||
459 | /** | |
9f266042 | 460 | * Create new report instance? (or update existing) on save. |
461 | * | |
462 | * @var bool | |
9907633b EM |
463 | */ |
464 | protected $_createNew; | |
465 | ||
8a2bee47 | 466 | /** |
467 | * When a grand total row has calculated the status we pop it off to here. | |
468 | * | |
469 | * This allows us to access it from the stats function and avoid recalculating. | |
9f266042 | 470 | * |
c86d4e7c | 471 | * @var array |
8a2bee47 | 472 | */ |
be2fb01f | 473 | protected $rollupRow = []; |
8a2bee47 | 474 | |
9099266e | 475 | /** |
9f266042 | 476 | * Database attributes - character set and collation. |
477 | * | |
478 | * @var string | |
9099266e | 479 | */ |
d09afb3e | 480 | protected $_databaseAttributes = ' DEFAULT CHARACTER SET utf8 COLLATE utf8_unicode_ci'; |
9099266e | 481 | |
02d451ab EM |
482 | /** |
483 | * SQL being run in this report. | |
484 | * | |
485 | * The sql in the report is stored in this variable in order to be displayed on the developer tab. | |
486 | * | |
487 | * @var string | |
488 | */ | |
489 | ||
490 | protected $sql; | |
55f71fa7 | 491 | |
81a22d3d | 492 | /** |
493 | * An instruction not to add a Group By. | |
494 | * | |
495 | * This is relevant where the group by might be otherwise added after the code that determines the group by array. | |
496 | * | |
497 | * e.g. where stat fields are being added but other settings cause it to not be desirable to add a group by | |
498 | * such as in pivot charts when no row header is set | |
499 | * | |
500 | * @var bool | |
501 | */ | |
502 | protected $noGroupBy = FALSE; | |
503 | ||
55f71fa7 | 504 | /** |
505 | * SQL being run in this report as an array. | |
506 | * | |
507 | * The sql in the report is stored in this variable in order to be returned to api & test calls. | |
508 | * | |
509 | * @var string | |
510 | */ | |
511 | ||
512 | protected $sqlArray; | |
66ddb273 | 513 | |
e6bab5ea | 514 | /** |
515 | * Tables created for the report that need removal afterwards. | |
516 | * | |
517 | * ['civicrm_temp_report_x' => ['temporary' => TRUE, 'name' => 'civicrm_temp_report_x'] | |
518 | * @var array | |
519 | */ | |
520 | protected $temporaryTables = []; | |
521 | ||
66ddb273 SL |
522 | /** |
523 | * Can this report use the sql mode ONLY_FULL_GROUP_BY. | |
524 | * @var bool | |
525 | */ | |
526 | public $optimisedForOnlyFullGroupBy = TRUE; | |
c86d4e7c | 527 | |
6a488035 | 528 | /** |
7d7c50f9 | 529 | * Class constructor. |
6a488035 | 530 | */ |
00be9182 | 531 | public function __construct() { |
6a488035 TO |
532 | parent::__construct(); |
533 | ||
22b67281 CW |
534 | $this->addClass('crm-report-form'); |
535 | ||
6a488035 TO |
536 | if ($this->_tagFilter) { |
537 | $this->buildTagFilter(); | |
538 | } | |
539 | if ($this->_exposeContactID) { | |
540 | if (array_key_exists('civicrm_contact', $this->_columns)) { | |
be2fb01f | 541 | $this->_columns['civicrm_contact']['fields']['exposed_id'] = [ |
6a488035 | 542 | 'name' => 'id', |
ccc29f8e | 543 | 'title' => ts('Contact ID'), |
6a488035 | 544 | 'no_repeat' => TRUE, |
be2fb01f | 545 | ]; |
6a488035 TO |
546 | } |
547 | } | |
548 | ||
549 | if ($this->_groupFilter) { | |
550 | $this->buildGroupFilter(); | |
551 | } | |
552 | ||
553 | // Get all custom groups | |
cd43c5e3 | 554 | $allGroups = CRM_Core_PseudoConstant::get('CRM_Core_DAO_CustomField', 'custom_group_id'); |
6a488035 | 555 | |
4f8ec8be DS |
556 | // Get the custom groupIds for which the user has VIEW permission |
557 | // If the user has 'access all custom data' permission, we'll leave $permCustomGroupIds empty | |
558 | // and addCustomDataToColumns() will allow access to all custom groups. | |
be2fb01f | 559 | $permCustomGroupIds = []; |
4f8ec8be DS |
560 | if (!CRM_Core_Permission::check('access all custom data')) { |
561 | $permCustomGroupIds = CRM_ACL_API::group(CRM_Core_Permission::VIEW, NULL, 'civicrm_custom_group', $allGroups, NULL); | |
562 | // do not allow custom data for reports if user doesn't have | |
563 | // permission to access custom data. | |
564 | if (!empty($this->_customGroupExtends) && empty($permCustomGroupIds)) { | |
be2fb01f | 565 | $this->_customGroupExtends = []; |
4f8ec8be | 566 | } |
6a488035 TO |
567 | } |
568 | ||
569 | // merge custom data columns to _columns list, if any | |
570 | $this->addCustomDataToColumns(TRUE, $permCustomGroupIds); | |
571 | ||
572 | // add / modify display columns, filters ..etc | |
573 | CRM_Utils_Hook::alterReportVar('columns', $this->_columns, $this); | |
7a961f19 | 574 | |
575 | //assign currencyColumn variable to tpl | |
576 | $this->assign('currencyColumn', $this->_currencyColumn); | |
6a488035 TO |
577 | } |
578 | ||
0b62c1ab EM |
579 | /** |
580 | * Shared pre-process function. | |
581 | * | |
582 | * If overriding preProcess function this should still be called. | |
583 | * | |
584 | * @throws \Exception | |
585 | */ | |
00be9182 | 586 | public function preProcessCommon() { |
1273d77c | 587 | $this->_force = CRM_Utils_Request::retrieve('force', 'Boolean'); |
77b97be7 | 588 | |
1273d77c | 589 | $this->_dashBoardRowCount = CRM_Utils_Request::retrieve('rowCount', 'Integer'); |
6a488035 | 590 | |
a3d827a7 | 591 | $this->_section = CRM_Utils_Request::retrieve('section', 'Integer'); |
6a488035 TO |
592 | |
593 | $this->assign('section', $this->_section); | |
be2fb01f | 594 | CRM_Core_Region::instance('page-header')->add([ |
6a488035 | 595 | 'markup' => sprintf('<!-- Report class: [%s] -->', htmlentities(get_class($this))), |
be2fb01f | 596 | ]); |
9d72cede | 597 | if (!$this->noController) { |
c58f66e0 | 598 | $this->setID($this->get('instanceId')); |
6a488035 | 599 | |
6a488035 | 600 | if (!$this->_id) { |
c58f66e0 E |
601 | $this->setID(CRM_Report_Utils_Report::getInstanceID()); |
602 | if (!$this->_id) { | |
9d72cede | 603 | $this->setID(CRM_Report_Utils_Report::getInstanceIDForPath()); |
c58f66e0 | 604 | } |
6a488035 | 605 | } |
6a488035 | 606 | |
c58f66e0 E |
607 | // set qfkey so that pager picks it up and use it in the "Next > Last >>" links. |
608 | // FIXME: Note setting it in $_GET doesn't work, since pager generates link based on QUERY_STRING | |
609 | $_SERVER['QUERY_STRING'] .= "&qfKey={$this->controller->_key}"; | |
610 | } | |
6a488035 TO |
611 | |
612 | if ($this->_id) { | |
613 | $this->assign('instanceId', $this->_id); | |
be2fb01f CW |
614 | $params = ['id' => $this->_id]; |
615 | $this->_instanceValues = []; | |
0b25329b | 616 | CRM_Core_DAO::commonRetrieve('CRM_Report_DAO_ReportInstance', |
6a488035 TO |
617 | $params, |
618 | $this->_instanceValues | |
619 | ); | |
620 | if (empty($this->_instanceValues)) { | |
621 | CRM_Core_Error::fatal("Report could not be loaded."); | |
622 | } | |
7cab1323 | 623 | $this->_title = $this->_instanceValues['title']; |
6a488035 TO |
624 | if (!empty($this->_instanceValues['permission']) && |
625 | (!(CRM_Core_Permission::check($this->_instanceValues['permission']) || | |
626 | CRM_Core_Permission::check('administer Reports') | |
627 | )) | |
628 | ) { | |
629 | CRM_Utils_System::permissionDenied(); | |
630 | CRM_Utils_System::civiExit(); | |
631 | } | |
632 | ||
633 | $formValues = CRM_Utils_Array::value('form_values', $this->_instanceValues); | |
634 | if ($formValues) { | |
635 | $this->_formValues = unserialize($formValues); | |
636 | } | |
637 | else { | |
638 | $this->_formValues = NULL; | |
639 | } | |
640 | ||
182f5081 | 641 | $this->setOutputMode(); |
642 | ||
643 | if ($this->_outputMode == 'copy') { | |
14cdc4cb | 644 | $this->_createNew = TRUE; |
182f5081 | 645 | $this->_params = $this->_formValues; |
646 | $this->_params['view_mode'] = 'criteria'; | |
be2fb01f | 647 | $this->_params['title'] = $this->getTitle() . ts(' (copy created by %1 on %2)', [ |
8f864776 | 648 | CRM_Core_Session::singleton()->getLoggedInContactDisplayName(), |
649 | CRM_Utils_Date::customFormat(date('Y-m-d H:i')), | |
be2fb01f | 650 | ]); |
182f5081 | 651 | // Do not pass go. Do not collect another chance to re-run the same query. |
652 | CRM_Report_Form_Instance::postProcess($this); | |
653 | } | |
654 | ||
6a488035 | 655 | // lets always do a force if reset is found in the url. |
e6e7e540 | 656 | // Hey why not? see CRM-17225 for more about this. The use of reset to be force is historical for reasons stated |
657 | // in the comment line above these 2. | |
182f5081 | 658 | if (!empty($_REQUEST['reset']) |
be2fb01f | 659 | && !in_array(CRM_Utils_Request::retrieve('output', 'String'), ['save', 'criteria'])) { |
6a488035 TO |
660 | $this->_force = 1; |
661 | } | |
662 | ||
663 | // set the mode | |
664 | $this->assign('mode', 'instance'); | |
665 | } | |
c58f66e0 | 666 | elseif (!$this->noController) { |
6a488035 TO |
667 | list($optionValueID, $optionValue) = CRM_Report_Utils_Report::getValueIDFromUrl(); |
668 | $instanceCount = CRM_Report_Utils_Report::getInstanceCount($optionValue); | |
669 | if (($instanceCount > 0) && $optionValueID) { | |
670 | $this->assign('instanceUrl', | |
671 | CRM_Utils_System::url('civicrm/report/list', | |
672 | "reset=1&ovid=$optionValueID" | |
673 | ) | |
674 | ); | |
675 | } | |
676 | if ($optionValueID) { | |
677 | $this->_description = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionValue', $optionValueID, 'description'); | |
678 | } | |
679 | ||
680 | // set the mode | |
681 | $this->assign('mode', 'template'); | |
682 | } | |
683 | ||
684 | // lets display the Report Settings section | |
685 | $this->_instanceForm = $this->_force || $this->_id || (!empty($_POST)); | |
686 | ||
687 | // Do not display Report Settings section if administer Reports permission is absent OR | |
688 | // if report instance is reserved and administer reserved reports absent | |
689 | if (!CRM_Core_Permission::check('administer Reports') || | |
9d72cede EM |
690 | ($this->_instanceValues['is_reserved'] && |
691 | !CRM_Core_Permission::check('administer reserved reports')) | |
692 | ) { | |
6a488035 TO |
693 | $this->_instanceForm = FALSE; |
694 | } | |
695 | ||
696 | $this->assign('criteriaForm', FALSE); | |
697 | // Display Report Criteria section if user has access Report Criteria OR administer Reports AND report instance is not reserved | |
9d72cede EM |
698 | if (CRM_Core_Permission::check('administer Reports') || |
699 | CRM_Core_Permission::check('access Report Criteria') | |
700 | ) { | |
701 | if (!$this->_instanceValues['is_reserved'] || | |
702 | CRM_Core_Permission::check('administer reserved reports') | |
703 | ) { | |
6a488035 TO |
704 | $this->assign('criteriaForm', TRUE); |
705 | $this->_criteriaForm = TRUE; | |
706 | } | |
707 | } | |
708 | ||
92991caf | 709 | // Special permissions check for private instance if it's not the current contact instance |
766eb4ba | 710 | if ($this->_id && |
2d9a4a4c | 711 | (CRM_Report_BAO_ReportInstance::reportIsPrivate($this->_id) && |
712 | !CRM_Report_BAO_ReportInstance::contactIsOwner($this->_id))) { | |
92991caf SV |
713 | if (!CRM_Core_Permission::check('access all private reports')) { |
714 | $this->_instanceForm = FALSE; | |
715 | $this->assign('criteriaForm', FALSE); | |
716 | } | |
717 | } | |
718 | ||
6a488035 TO |
719 | $this->_instanceButtonName = $this->getButtonName('submit', 'save'); |
720 | $this->_createNewButtonName = $this->getButtonName('submit', 'next'); | |
6a488035 TO |
721 | $this->_groupButtonName = $this->getButtonName('submit', 'group'); |
722 | $this->_chartButtonName = $this->getButtonName('submit', 'chart'); | |
723 | } | |
724 | ||
0b62c1ab EM |
725 | /** |
726 | * Add bread crumb. | |
727 | */ | |
00be9182 | 728 | public function addBreadCrumb() { |
971d41b1 | 729 | $breadCrumbs |
be2fb01f CW |
730 | = [ |
731 | [ | |
8f1445ea DL |
732 | 'title' => ts('Report Templates'), |
733 | 'url' => CRM_Utils_System::url('civicrm/admin/report/template/list', 'reset=1'), | |
be2fb01f CW |
734 | ], |
735 | ]; | |
6a488035 TO |
736 | |
737 | CRM_Utils_System::appendBreadCrumb($breadCrumbs); | |
738 | } | |
739 | ||
0b62c1ab EM |
740 | /** |
741 | * Pre process function. | |
742 | * | |
743 | * Called prior to build form. | |
744 | */ | |
00be9182 | 745 | public function preProcess() { |
8f1445ea | 746 | $this->preProcessCommon(); |
6a488035 | 747 | |
6a488035 | 748 | if (!$this->_id) { |
29fc2b79 | 749 | $this->addBreadCrumb(); |
6a488035 TO |
750 | } |
751 | ||
752 | foreach ($this->_columns as $tableName => $table) { | |
8bb36676 | 753 | $this->setTableAlias($table, $tableName); |
6a488035 | 754 | |
be2fb01f | 755 | $expFields = []; |
6a488035 | 756 | // higher preference to bao object |
f63c531a | 757 | $daoOrBaoName = CRM_Utils_Array::value('bao', $table, CRM_Utils_Array::value('dao', $table)); |
758 | ||
759 | if ($daoOrBaoName) { | |
760 | if (method_exists($daoOrBaoName, 'exportableFields')) { | |
761 | $expFields = $daoOrBaoName::exportableFields(); | |
762 | } | |
763 | else { | |
764 | $expFields = $daoOrBaoName::export(); | |
765 | } | |
8edb9849 | 766 | } |
6a488035 | 767 | |
be2fb01f | 768 | $doNotCopy = ['required', 'default']; |
6a488035 | 769 | |
be2fb01f | 770 | $fieldGroups = ['fields', 'filters', 'group_bys', 'order_bys']; |
6a488035 | 771 | foreach ($fieldGroups as $fieldGrp) { |
a7488080 | 772 | if (!empty($table[$fieldGrp]) && is_array($table[$fieldGrp])) { |
6a488035 TO |
773 | foreach ($table[$fieldGrp] as $fieldName => $field) { |
774 | // $name is the field name used to reference the BAO/DAO export fields array | |
775 | $name = isset($field['name']) ? $field['name'] : $fieldName; | |
776 | ||
777 | // Sometimes the field name key in the BAO/DAO export fields array is | |
778 | // different from the actual database field name. | |
779 | // Unset $field['name'] so that actual database field name can be obtained | |
780 | // from the BAO/DAO export fields array. | |
781 | unset($field['name']); | |
782 | ||
783 | if (array_key_exists($name, $expFields)) { | |
784 | foreach ($doNotCopy as $dnc) { | |
785 | // unset the values we don't want to be copied. | |
786 | unset($expFields[$name][$dnc]); | |
787 | } | |
788 | if (empty($field)) { | |
789 | $this->_columns[$tableName][$fieldGrp][$fieldName] = $expFields[$name]; | |
790 | } | |
791 | else { | |
792 | foreach ($expFields[$name] as $property => $val) { | |
793 | if (!array_key_exists($property, $field)) { | |
794 | $this->_columns[$tableName][$fieldGrp][$fieldName][$property] = $val; | |
795 | } | |
796 | } | |
797 | } | |
798 | } | |
799 | ||
800 | // fill other vars | |
a7488080 | 801 | if (!empty($field['no_repeat'])) { |
6a488035 TO |
802 | $this->_noRepeats[] = "{$tableName}_{$fieldName}"; |
803 | } | |
a7488080 | 804 | if (!empty($field['no_display'])) { |
6a488035 TO |
805 | $this->_noDisplay[] = "{$tableName}_{$fieldName}"; |
806 | } | |
807 | ||
808 | // set alias = table-name, unless already set | |
971d41b1 CW |
809 | $alias = isset($field['alias']) ? $field['alias'] : ( |
810 | isset($this->_columns[$tableName]['alias']) ? $this->_columns[$tableName]['alias'] : $tableName | |
6a488035 TO |
811 | ); |
812 | $this->_columns[$tableName][$fieldGrp][$fieldName]['alias'] = $alias; | |
813 | ||
814 | // set name = fieldName, unless already set | |
815 | if (!isset($this->_columns[$tableName][$fieldGrp][$fieldName]['name'])) { | |
816 | $this->_columns[$tableName][$fieldGrp][$fieldName]['name'] = $name; | |
817 | } | |
818 | ||
81a22d3d | 819 | if (!isset($this->_columns[$tableName][$fieldGrp][$fieldName]['table_name'])) { |
820 | $this->_columns[$tableName][$fieldGrp][$fieldName]['table_name'] = $tableName; | |
821 | } | |
822 | ||
6a488035 TO |
823 | // set dbAlias = alias.name, unless already set |
824 | if (!isset($this->_columns[$tableName][$fieldGrp][$fieldName]['dbAlias'])) { | |
971d41b1 CW |
825 | $this->_columns[$tableName][$fieldGrp][$fieldName]['dbAlias'] |
826 | = $alias . '.' . | |
9d72cede | 827 | $this->_columns[$tableName][$fieldGrp][$fieldName]['name']; |
6a488035 TO |
828 | } |
829 | ||
c75e90fa | 830 | // a few auto fills for filters |
c93f6d83 | 831 | if ($fieldGrp == 'filters') { |
c75e90fa DS |
832 | // fill operator types |
833 | if (!array_key_exists('operatorType', $this->_columns[$tableName][$fieldGrp][$fieldName])) { | |
834 | switch (CRM_Utils_Array::value('type', $this->_columns[$tableName][$fieldGrp][$fieldName])) { | |
835 | case CRM_Utils_Type::T_MONEY: | |
836 | case CRM_Utils_Type::T_FLOAT: | |
837 | $this->_columns[$tableName][$fieldGrp][$fieldName]['operatorType'] = CRM_Report_Form::OP_FLOAT; | |
838 | break; | |
ea100cb5 | 839 | |
c75e90fa DS |
840 | case CRM_Utils_Type::T_INT: |
841 | $this->_columns[$tableName][$fieldGrp][$fieldName]['operatorType'] = CRM_Report_Form::OP_INT; | |
842 | break; | |
ea100cb5 | 843 | |
c75e90fa | 844 | case CRM_Utils_Type::T_DATE: |
c93f6d83 | 845 | $this->_columns[$tableName][$fieldGrp][$fieldName]['operatorType'] = CRM_Report_Form::OP_DATE; |
c75e90fa | 846 | break; |
ea100cb5 | 847 | |
c75e90fa DS |
848 | case CRM_Utils_Type::T_BOOLEAN: |
849 | $this->_columns[$tableName][$fieldGrp][$fieldName]['operatorType'] = CRM_Report_Form::OP_SELECT; | |
850 | if (!array_key_exists('options', $this->_columns[$tableName][$fieldGrp][$fieldName])) { | |
971d41b1 | 851 | $this->_columns[$tableName][$fieldGrp][$fieldName]['options'] |
be2fb01f | 852 | = [ |
9d72cede EM |
853 | '' => ts('Any'), |
854 | '0' => ts('No'), | |
21dfd5f5 | 855 | '1' => ts('Yes'), |
be2fb01f | 856 | ]; |
c75e90fa DS |
857 | } |
858 | break; | |
ea100cb5 | 859 | |
c75e90fa | 860 | default: |
c93f6d83 | 861 | if ($daoOrBaoName && |
9d72cede EM |
862 | array_key_exists('pseudoconstant', $this->_columns[$tableName][$fieldGrp][$fieldName]) |
863 | ) { | |
c75e90fa DS |
864 | // with multiple options operator-type is generally multi-select |
865 | $this->_columns[$tableName][$fieldGrp][$fieldName]['operatorType'] = CRM_Report_Form::OP_MULTISELECT; | |
866 | if (!array_key_exists('options', $this->_columns[$tableName][$fieldGrp][$fieldName])) { | |
867 | // fill options | |
868 | $this->_columns[$tableName][$fieldGrp][$fieldName]['options'] = CRM_Core_PseudoConstant::get($daoOrBaoName, $fieldName); | |
869 | } | |
870 | } | |
871 | break; | |
872 | } | |
6a488035 TO |
873 | } |
874 | } | |
534c4d20 | 875 | if (!isset($this->_columns[$tableName]['metadata'][$fieldName])) { |
876 | $this->_columns[$tableName]['metadata'][$fieldName] = $this->_columns[$tableName][$fieldGrp][$fieldName]; | |
877 | } | |
59b19369 JJ |
878 | else { |
879 | $this->_columns[$tableName]['metadata'][$fieldName] = array_merge($this->_columns[$tableName][$fieldGrp][$fieldName], $this->_columns[$tableName]['metadata'][$fieldName]); | |
880 | } | |
6a488035 TO |
881 | } |
882 | } | |
883 | } | |
884 | ||
885 | // copy filters to a separate handy variable | |
886 | if (array_key_exists('filters', $table)) { | |
887 | $this->_filters[$tableName] = $this->_columns[$tableName]['filters']; | |
888 | } | |
889 | ||
890 | if (array_key_exists('group_bys', $table)) { | |
891 | $groupBys[$tableName] = $this->_columns[$tableName]['group_bys']; | |
892 | } | |
893 | ||
894 | if (array_key_exists('fields', $table)) { | |
895 | $reportFields[$tableName] = $this->_columns[$tableName]['fields']; | |
896 | } | |
897 | } | |
898 | ||
899 | if ($this->_force) { | |
900 | $this->setDefaultValues(FALSE); | |
901 | } | |
902 | ||
8f1445ea DL |
903 | CRM_Report_Utils_Get::processFilter($this->_filters, $this->_defaults); |
904 | CRM_Report_Utils_Get::processGroupBy($groupBys, $this->_defaults); | |
905 | CRM_Report_Utils_Get::processFields($reportFields, $this->_defaults); | |
6a488035 TO |
906 | CRM_Report_Utils_Get::processChart($this->_defaults); |
907 | ||
908 | if ($this->_force) { | |
909 | $this->_formValues = $this->_defaults; | |
910 | $this->postProcess(); | |
911 | } | |
912 | } | |
913 | ||
74cf4551 | 914 | /** |
7d7c50f9 EM |
915 | * Set default values. |
916 | * | |
74cf4551 EM |
917 | * @param bool $freeze |
918 | * | |
919 | * @return array | |
920 | */ | |
00be9182 | 921 | public function setDefaultValues($freeze = TRUE) { |
be2fb01f | 922 | $freezeGroup = []; |
6a488035 TO |
923 | |
924 | // FIXME: generalizing form field naming conventions would reduce | |
7d7c50f9 | 925 | // Lots of lines below. |
6a488035 TO |
926 | foreach ($this->_columns as $tableName => $table) { |
927 | if (array_key_exists('fields', $table)) { | |
928 | foreach ($table['fields'] as $fieldName => $field) { | |
a7488080 | 929 | if (empty($field['no_display'])) { |
094ab048 | 930 | if (!empty($field['required'])) { |
6a488035 TO |
931 | // set default |
932 | $this->_defaults['fields'][$fieldName] = 1; | |
933 | ||
934 | if ($freeze) { | |
935 | // find element object, so that we could use quickform's freeze method | |
936 | // for required elements | |
8f1445ea | 937 | $obj = $this->getElementFromGroup("fields", $fieldName); |
6a488035 TO |
938 | if ($obj) { |
939 | $freezeGroup[] = $obj; | |
940 | } | |
941 | } | |
942 | } | |
943 | elseif (isset($field['default'])) { | |
944 | $this->_defaults['fields'][$fieldName] = $field['default']; | |
945 | } | |
946 | } | |
947 | } | |
948 | } | |
949 | ||
950 | if (array_key_exists('group_bys', $table)) { | |
951 | foreach ($table['group_bys'] as $fieldName => $field) { | |
952 | if (isset($field['default'])) { | |
a7488080 | 953 | if (!empty($field['frequency'])) { |
6a488035 TO |
954 | $this->_defaults['group_bys_freq'][$fieldName] = 'MONTH'; |
955 | } | |
956 | $this->_defaults['group_bys'][$fieldName] = $field['default']; | |
957 | } | |
958 | } | |
959 | } | |
960 | if (array_key_exists('filters', $table)) { | |
961 | foreach ($table['filters'] as $fieldName => $field) { | |
962 | if (isset($field['default'])) { | |
9d72cede EM |
963 | if (CRM_Utils_Array::value('type', $field) & CRM_Utils_Type::T_DATE |
964 | ) { | |
965 | if (is_array($field['default'])) { | |
b0e34e7c | 966 | $this->_defaults["{$fieldName}_from"] = CRM_Utils_Array::value('from', $field['default']); |
967 | $this->_defaults["{$fieldName}_to"] = CRM_Utils_Array::value('to', $field['default']); | |
968 | $this->_defaults["{$fieldName}_relative"] = 0; | |
969 | } | |
9d72cede | 970 | else { |
b0e34e7c | 971 | $this->_defaults["{$fieldName}_relative"] = $field['default']; |
972 | } | |
6a488035 TO |
973 | } |
974 | else { | |
2edb4e81 | 975 | if ((CRM_Utils_Array::value('type', $field) & CRM_Utils_Type::T_INT) && is_array($field['default'])) { |
976 | $this->_defaults["{$fieldName}_min"] = CRM_Utils_Array::value('min', $field['default']); | |
977 | $this->_defaults["{$fieldName}_max"] = CRM_Utils_Array::value('max', $field['default']); | |
978 | } | |
6a488035 TO |
979 | $this->_defaults["{$fieldName}_value"] = $field['default']; |
980 | } | |
981 | } | |
982 | //assign default value as "in" for multiselect | |
983 | //operator, To freeze the select element | |
9d72cede EM |
984 | if (CRM_Utils_Array::value('operatorType', $field) == |
985 | CRM_Report_Form::OP_MULTISELECT | |
986 | ) { | |
6a488035 TO |
987 | $this->_defaults["{$fieldName}_op"] = 'in'; |
988 | } | |
9d72cede EM |
989 | if (CRM_Utils_Array::value('operatorType', $field) == |
990 | CRM_Report_Form::OP_ENTITYREF | |
991 | ) { | |
2107cde9 CW |
992 | $this->_defaults["{$fieldName}_op"] = 'in'; |
993 | } | |
9d72cede EM |
994 | elseif (CRM_Utils_Array::value('operatorType', $field) == |
995 | CRM_Report_Form::OP_MULTISELECT_SEPARATOR | |
996 | ) { | |
6a488035 TO |
997 | $this->_defaults["{$fieldName}_op"] = 'mhas'; |
998 | } | |
999 | elseif ($op = CRM_Utils_Array::value('default_op', $field)) { | |
1000 | $this->_defaults["{$fieldName}_op"] = $op; | |
1001 | } | |
1002 | } | |
1003 | } | |
1004 | ||
8f1445ea | 1005 | if ( |
e76ce93e | 1006 | empty($this->_formValues['order_bys']) && |
1007 | (array_key_exists('order_bys', $table) && | |
1008 | is_array($table['order_bys'])) | |
6a488035 | 1009 | ) { |
6a488035 | 1010 | if (!array_key_exists('order_bys', $this->_defaults)) { |
be2fb01f | 1011 | $this->_defaults['order_bys'] = []; |
6a488035 TO |
1012 | } |
1013 | foreach ($table['order_bys'] as $fieldName => $field) { | |
8cc574cf | 1014 | if (!empty($field['default']) || !empty($field['default_order']) || |
9d72cede EM |
1015 | CRM_Utils_Array::value('default_is_section', $field) || |
1016 | !empty($field['default_weight']) | |
1017 | ) { | |
be2fb01f | 1018 | $order_by = [ |
6a488035 TO |
1019 | 'column' => $fieldName, |
1020 | 'order' => CRM_Utils_Array::value('default_order', $field, 'ASC'), | |
1021 | 'section' => CRM_Utils_Array::value('default_is_section', $field, 0), | |
be2fb01f | 1022 | ]; |
6a488035 | 1023 | |
a7488080 | 1024 | if (!empty($field['default_weight'])) { |
6a488035 TO |
1025 | $this->_defaults['order_bys'][(int) $field['default_weight']] = $order_by; |
1026 | } | |
1027 | else { | |
1028 | array_unshift($this->_defaults['order_bys'], $order_by); | |
1029 | } | |
1030 | } | |
1031 | } | |
1032 | } | |
1033 | ||
1034 | foreach ($this->_options as $fieldName => $field) { | |
1035 | if (isset($field['default'])) { | |
1036 | $this->_defaults['options'][$fieldName] = $field['default']; | |
1037 | } | |
1038 | } | |
1039 | } | |
1040 | ||
1041 | if (!empty($this->_submitValues)) { | |
1042 | $this->preProcessOrderBy($this->_submitValues); | |
1043 | } | |
1044 | else { | |
1045 | $this->preProcessOrderBy($this->_defaults); | |
1046 | } | |
1047 | ||
1048 | // lets finish freezing task here itself | |
1049 | if (!empty($freezeGroup)) { | |
1050 | foreach ($freezeGroup as $elem) { | |
1051 | $elem->freeze(); | |
1052 | } | |
1053 | } | |
1054 | ||
1055 | if ($this->_formValues) { | |
1056 | $this->_defaults = array_merge($this->_defaults, $this->_formValues); | |
1057 | } | |
1058 | ||
1059 | if ($this->_instanceValues) { | |
1060 | $this->_defaults = array_merge($this->_defaults, $this->_instanceValues); | |
1061 | } | |
1062 | ||
1063 | CRM_Report_Form_Instance::setDefaultValues($this, $this->_defaults); | |
1064 | ||
1065 | return $this->_defaults; | |
1066 | } | |
1067 | ||
74cf4551 | 1068 | /** |
7d7c50f9 EM |
1069 | * Get element from group. |
1070 | * | |
8a925f33 | 1071 | * @param string $group |
100fef9d | 1072 | * @param string $grpFieldName |
74cf4551 EM |
1073 | * |
1074 | * @return bool | |
1075 | */ | |
00be9182 | 1076 | public function getElementFromGroup($group, $grpFieldName) { |
6a488035 TO |
1077 | $eleObj = $this->getElement($group); |
1078 | foreach ($eleObj->_elements as $index => $obj) { | |
1079 | if ($grpFieldName == $obj->_attributes['name']) { | |
1080 | return $obj; | |
1081 | } | |
1082 | } | |
1083 | return FALSE; | |
1084 | } | |
1085 | ||
c58f66e0 | 1086 | /** |
7d7c50f9 | 1087 | * Setter for $_params. |
9d72cede | 1088 | * |
c58f66e0 E |
1089 | * @param array $params |
1090 | */ | |
00be9182 | 1091 | public function setParams($params) { |
c58f66e0 E |
1092 | $this->_params = $params; |
1093 | } | |
1094 | ||
8fc33241 | 1095 | /** |
1096 | * Getter for $_params. | |
1097 | * | |
1098 | * @return void|array $params | |
1099 | */ | |
1100 | public function getParams() { | |
1101 | return $this->_params; | |
1102 | } | |
1103 | ||
c58f66e0 | 1104 | /** |
0b62c1ab | 1105 | * Setter for $_id. |
2a6da8d7 | 1106 | * |
537c70b8 | 1107 | * @param int $instanceID |
c58f66e0 | 1108 | */ |
537c70b8 EM |
1109 | public function setID($instanceID) { |
1110 | $this->_id = $instanceID; | |
c58f66e0 E |
1111 | } |
1112 | ||
1113 | /** | |
07f44165 | 1114 | * Setter for $_force. |
9d72cede | 1115 | * |
317a8023 | 1116 | * @param bool $isForce |
9d72cede | 1117 | */ |
00be9182 | 1118 | public function setForce($isForce) { |
c58f66e0 E |
1119 | $this->_force = $isForce; |
1120 | } | |
6f900755 E |
1121 | |
1122 | /** | |
7d7c50f9 | 1123 | * Setter for $_limitValue. |
9d72cede | 1124 | * |
d3e86119 | 1125 | * @param int $_limitValue |
6f900755 | 1126 | */ |
00be9182 | 1127 | public function setLimitValue($_limitValue) { |
6f900755 E |
1128 | $this->_limitValue = $_limitValue; |
1129 | } | |
1130 | ||
1131 | /** | |
7d7c50f9 | 1132 | * Setter for $_offsetValue. |
9d72cede | 1133 | * |
d3e86119 | 1134 | * @param int $_offsetValue |
6f900755 | 1135 | */ |
00be9182 | 1136 | public function setOffsetValue($_offsetValue) { |
6f900755 E |
1137 | $this->_offsetValue = $_offsetValue; |
1138 | } | |
1139 | ||
182f5081 | 1140 | /** |
1141 | * Setter for $addPaging. | |
1142 | * | |
1143 | * @param bool $value | |
1144 | */ | |
1145 | public function setAddPaging($value) { | |
1146 | $this->addPaging = $value; | |
1147 | } | |
1148 | ||
c58f66e0 | 1149 | /** |
7d7c50f9 EM |
1150 | * Getter for $_defaultValues. |
1151 | * | |
a6c01b45 | 1152 | * @return array |
c58f66e0 | 1153 | */ |
00be9182 | 1154 | public function getDefaultValues() { |
c58f66e0 E |
1155 | return $this->_defaults; |
1156 | } | |
1157 | ||
e6bab5ea | 1158 | /** |
1159 | * Remove any temporary tables. | |
1160 | */ | |
1161 | public function cleanUpTemporaryTables() { | |
1162 | foreach ($this->temporaryTables as $temporaryTable) { | |
1163 | CRM_Core_DAO::executeQuery('DROP ' . ($temporaryTable['temporary'] ? 'TEMPORARY' : '') . ' TABLE IF EXISTS ' . $temporaryTable['name']); | |
1164 | } | |
1165 | } | |
1166 | ||
5a14305b | 1167 | /** |
1168 | * Create a temporary table. | |
1169 | * | |
1170 | * This function creates a table AND adds the details to the developer tab & $this->>temporary tables. | |
1171 | * | |
5a14305b | 1172 | * @param string $identifier |
03843223 | 1173 | * This is the key that will be used for the table in the temporaryTables property. |
1174 | * @param string $sql | |
1175 | * Sql select statement or column description (the latter requires the columns flag) | |
1176 | * @param bool $isColumns | |
1177 | * Is the sql describing columns to create (rather than using a select query). | |
1178 | * @param bool $isMemory | |
1179 | * Create a memory table rather than a normal INNODB table. | |
5a14305b | 1180 | * |
1181 | * @return string | |
1182 | */ | |
03843223 | 1183 | public function createTemporaryTable($identifier, $sql, $isColumns = FALSE, $isMemory = FALSE) { |
0033aaaf | 1184 | $tempTable = CRM_Utils_SQL_TempTable::build(); |
03843223 | 1185 | if ($isMemory) { |
1186 | $tempTable->setMemory(); | |
1187 | } | |
1188 | if ($isColumns) { | |
1189 | $tempTable->createWithColumns($sql); | |
1190 | } | |
1191 | else { | |
1192 | $tempTable->createWithQuery($sql); | |
1193 | } | |
f0197a3d | 1194 | $name = $tempTable->getName(); |
1195 | // Developers may force tables to be durable to assist in debugging so lets check. | |
1196 | $isNotTrueTemporary = $tempTable->isDurable(); | |
03843223 | 1197 | $this->addToDeveloperTab($tempTable->getCreateSql()); |
f0197a3d | 1198 | $this->temporaryTables[$identifier] = ['temporary' => !$isNotTrueTemporary, 'name' => $name]; |
5a14305b | 1199 | return $name; |
1200 | } | |
1201 | ||
7d7c50f9 EM |
1202 | /** |
1203 | * Add columns to report. | |
1204 | */ | |
00be9182 | 1205 | public function addColumns() { |
be2fb01f | 1206 | $options = []; |
6a488035 TO |
1207 | $colGroups = NULL; |
1208 | foreach ($this->_columns as $tableName => $table) { | |
1209 | if (array_key_exists('fields', $table)) { | |
1210 | foreach ($table['fields'] as $fieldName => $field) { | |
8bdc861c | 1211 | $groupTitle = ''; |
a7488080 | 1212 | if (empty($field['no_display'])) { |
be2fb01f | 1213 | foreach (['table', 'field'] as $var) { |
8bdc861c DS |
1214 | if (!empty(${$var}['grouping'])) { |
1215 | if (!is_array(${$var}['grouping'])) { | |
1216 | $tableName = ${$var}['grouping']; | |
9d72cede EM |
1217 | } |
1218 | else { | |
b80138e0 DS |
1219 | $tableName = array_keys(${$var}['grouping']); |
1220 | $tableName = $tableName[0]; | |
1221 | $groupTitle = array_values(${$var}['grouping']); | |
1222 | $groupTitle = $groupTitle[0]; | |
8bdc861c DS |
1223 | } |
1224 | } | |
6a488035 | 1225 | } |
8bdc861c DS |
1226 | |
1227 | if (!$groupTitle && isset($table['group_title'])) { | |
1228 | $groupTitle = $table['group_title']; | |
6df2d404 | 1229 | // Having a group_title is secret code for being a custom group |
b44e3f84 | 1230 | // which cryptically translates to needing an accordion. |
6df2d404 EM |
1231 | // here we make that explicit. |
1232 | $colGroups[$tableName]['use_accordian_for_field_selection'] = TRUE; | |
6a488035 | 1233 | } |
6a488035 | 1234 | |
8bdc861c | 1235 | $colGroups[$tableName]['fields'][$fieldName] = CRM_Utils_Array::value('title', $field); |
8cc574cf | 1236 | if ($groupTitle && empty($colGroups[$tableName]['group_title'])) { |
8bdc861c | 1237 | $colGroups[$tableName]['group_title'] = $groupTitle; |
6a488035 | 1238 | } |
6a488035 TO |
1239 | $options[$fieldName] = CRM_Utils_Array::value('title', $field); |
1240 | } | |
1241 | } | |
1242 | } | |
1243 | } | |
1244 | ||
1245 | $this->addCheckBox("fields", ts('Select Columns'), $options, NULL, | |
1246 | NULL, NULL, NULL, $this->_fourColumnAttribute, TRUE | |
1247 | ); | |
0b62c1ab | 1248 | if (!empty($colGroups)) { |
be2fb01f | 1249 | $this->tabs['FieldSelection'] = [ |
0b62c1ab EM |
1250 | 'title' => ts('Columns'), |
1251 | 'tpl' => 'FieldSelection', | |
1252 | 'div_label' => 'col-groups', | |
be2fb01f | 1253 | ]; |
0b62c1ab EM |
1254 | |
1255 | // Note this assignment is only really required in buildForm. It is being 'over-called' | |
1256 | // to reduce risk of being missed due to overridden functions. | |
1257 | $this->assign('tabs', $this->tabs); | |
1258 | } | |
1259 | ||
6a488035 TO |
1260 | $this->assign('colGroups', $colGroups); |
1261 | } | |
1262 | ||
50951061 EM |
1263 | /** |
1264 | * Add filters to report. | |
1265 | */ | |
00be9182 | 1266 | public function addFilters() { |
be2fb01f | 1267 | $filters = $filterGroups = []; |
6a488035 | 1268 | $count = 1; |
69719a15 | 1269 | |
6a488035 | 1270 | foreach ($this->_filters as $table => $attributes) { |
69719a15 EM |
1271 | if (isset($this->_columns[$table]['group_title'])) { |
1272 | // The presence of 'group_title' is secret code for 'is_a_custom_table' | |
1273 | // which magically means to 'display in an accordian' | |
1274 | // here we make this explicit. | |
be2fb01f | 1275 | $filterGroups[$table] = [ |
69719a15 EM |
1276 | 'group_title' => $this->_columns[$table]['group_title'], |
1277 | 'use_accordian_for_field_selection' => TRUE, | |
1278 | ||
be2fb01f | 1279 | ]; |
69719a15 | 1280 | } |
6a488035 TO |
1281 | foreach ($attributes as $fieldName => $field) { |
1282 | // get ready with option value pair | |
1b36206c | 1283 | // @ 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 |
1284 | // would be useful | |
1285 | $operations = $this->getOperationPair( | |
8f1445ea | 1286 | CRM_Utils_Array::value('operatorType', $field), |
1b36206c | 1287 | $fieldName); |
6a488035 TO |
1288 | |
1289 | $filters[$table][$fieldName] = $field; | |
1290 | ||
1291 | switch (CRM_Utils_Array::value('operatorType', $field)) { | |
1292 | case CRM_Report_Form::OP_MONTH: | |
9d72cede EM |
1293 | if (!array_key_exists('options', $field) || |
1294 | !is_array($field['options']) || empty($field['options']) | |
1295 | ) { | |
6a488035 | 1296 | // If there's no option list for this filter, define one. |
be2fb01f | 1297 | $field['options'] = [ |
6a488035 TO |
1298 | 1 => ts('January'), |
1299 | 2 => ts('February'), | |
1300 | 3 => ts('March'), | |
1301 | 4 => ts('April'), | |
1302 | 5 => ts('May'), | |
1303 | 6 => ts('June'), | |
1304 | 7 => ts('July'), | |
1305 | 8 => ts('August'), | |
1306 | 9 => ts('September'), | |
1307 | 10 => ts('October'), | |
1308 | 11 => ts('November'), | |
1309 | 12 => ts('December'), | |
be2fb01f | 1310 | ]; |
6a488035 TO |
1311 | // Add this option list to this column _columns. This is |
1312 | // required so that filter statistics show properly. | |
1313 | $this->_columns[$table]['filters'][$fieldName]['options'] = $field['options']; | |
1314 | } | |
160d32e1 E |
1315 | case CRM_Report_Form::OP_MULTISELECT: |
1316 | case CRM_Report_Form::OP_MULTISELECT_SEPARATOR: | |
6a488035 | 1317 | // assume a multi-select field |
9d72cede EM |
1318 | if (!empty($field['options']) || |
1319 | $fieldName == 'state_province_id' || $fieldName == 'county_id' | |
1320 | ) { | |
d59b14a6 | 1321 | $element = $this->addElement('select', "{$fieldName}_op", ts('Operator:'), $operations, |
a4818149 | 1322 | array('onchange' => "return showHideMaxMinVal( '$fieldName', this.value );") |
1323 | ); | |
1324 | ||
6a488035 TO |
1325 | if (count($operations) <= 1) { |
1326 | $element->freeze(); | |
1327 | } | |
9d72cede EM |
1328 | if ($fieldName == 'state_province_id' || |
1329 | $fieldName == 'county_id' | |
1330 | ) { | |
be2fb01f | 1331 | $this->addChainSelect($fieldName . '_value', [ |
86bd39be TO |
1332 | 'multiple' => TRUE, |
1333 | 'label' => NULL, | |
21dfd5f5 | 1334 | 'class' => 'huge', |
be2fb01f | 1335 | ]); |
c927c151 CW |
1336 | } |
1337 | else { | |
be2fb01f | 1338 | $this->addElement('select', "{$fieldName}_value", NULL, $field['options'], [ |
c927c151 | 1339 | 'style' => 'min-width:250px', |
2107cde9 | 1340 | 'class' => 'crm-select2 huge', |
c927c151 CW |
1341 | 'multiple' => TRUE, |
1342 | 'placeholder' => ts('- select -'), | |
be2fb01f | 1343 | ]); |
c927c151 | 1344 | } |
6a488035 TO |
1345 | } |
1346 | break; | |
1347 | ||
160d32e1 | 1348 | case CRM_Report_Form::OP_SELECT: |
6a488035 TO |
1349 | // assume a select field |
1350 | $this->addElement('select', "{$fieldName}_op", ts('Operator:'), $operations); | |
9d72cede | 1351 | if (!empty($field['options'])) { |
5a9a44d9 | 1352 | $this->addElement('select', "{$fieldName}_value", NULL, $field['options']); |
9d72cede | 1353 | } |
6a488035 TO |
1354 | break; |
1355 | ||
2107cde9 CW |
1356 | case CRM_Report_Form::OP_ENTITYREF: |
1357 | $this->addElement('select', "{$fieldName}_op", ts('Operator:'), $operations); | |
1358 | $this->setEntityRefDefaults($field, $table); | |
1359 | $this->addEntityRef("{$fieldName}_value", NULL, $field['attributes']); | |
1360 | break; | |
1361 | ||
160d32e1 | 1362 | case CRM_Report_Form::OP_DATE: |
6a488035 | 1363 | // build datetime fields |
ccc29f8e | 1364 | CRM_Core_Form_Date::buildDateRange($this, $fieldName, $count, '_from', '_to', ts('From:'), FALSE, $operations); |
6a488035 TO |
1365 | $count++; |
1366 | break; | |
1367 | ||
160d32e1 | 1368 | case CRM_Report_Form::OP_DATETIME: |
6a488035 | 1369 | // build datetime fields |
ccc29f8e | 1370 | CRM_Core_Form_Date::buildDateRange($this, $fieldName, $count, '_from', '_to', ts('From:'), FALSE, $operations, 'searchDate', TRUE); |
6a488035 TO |
1371 | $count++; |
1372 | break; | |
1373 | ||
160d32e1 E |
1374 | case CRM_Report_Form::OP_INT: |
1375 | case CRM_Report_Form::OP_FLOAT: | |
6a488035 TO |
1376 | // and a min value input box |
1377 | $this->add('text', "{$fieldName}_min", ts('Min')); | |
1378 | // and a max value input box | |
1379 | $this->add('text', "{$fieldName}_max", ts('Max')); | |
1380 | default: | |
1381 | // default type is string | |
1382 | $this->addElement('select', "{$fieldName}_op", ts('Operator:'), $operations, | |
be2fb01f | 1383 | ['onchange' => "return showHideMaxMinVal( '$fieldName', this.value );"] |
6a488035 TO |
1384 | ); |
1385 | // we need text box for value input | |
be2fb01f | 1386 | $this->add('text', "{$fieldName}_value", NULL, ['class' => 'huge']); |
6a488035 TO |
1387 | break; |
1388 | } | |
1389 | } | |
1390 | } | |
0b62c1ab | 1391 | if (!empty($filters)) { |
be2fb01f | 1392 | $this->tabs['Filters'] = [ |
0b62c1ab EM |
1393 | 'title' => ts('Filters'), |
1394 | 'tpl' => 'Filters', | |
1395 | 'div_label' => 'set-filters', | |
be2fb01f | 1396 | ]; |
0b62c1ab | 1397 | } |
6a488035 | 1398 | $this->assign('filters', $filters); |
69719a15 | 1399 | $this->assign('filterGroups', $filterGroups); |
6a488035 TO |
1400 | } |
1401 | ||
0b62c1ab EM |
1402 | /** |
1403 | * Function to assign the tabs to the template in the correct order. | |
1404 | * | |
1405 | * We want the tabs to wind up in this order (if not overridden). | |
1406 | * | |
1407 | * - Field Selection | |
1408 | * - Group Bys | |
1409 | * - Order Bys | |
1410 | * - Other Options | |
1411 | * - Filters | |
1412 | */ | |
1413 | protected function assignTabs() { | |
be2fb01f | 1414 | $order = [ |
0b62c1ab EM |
1415 | 'FieldSelection', |
1416 | 'GroupBy', | |
1417 | 'OrderBy', | |
1418 | 'ReportOptions', | |
1419 | 'Filters', | |
be2fb01f | 1420 | ]; |
0b62c1ab EM |
1421 | $order = array_intersect_key(array_fill_keys($order, 1), $this->tabs); |
1422 | $order = array_merge($order, $this->tabs); | |
1423 | $this->assign('tabs', $order); | |
1424 | } | |
1425 | ||
02d451ab EM |
1426 | /** |
1427 | * The intent is to add a tab for developers to view the sql. | |
1428 | * | |
1429 | * Currently using dpm. | |
1430 | * | |
1431 | * @param string $sql | |
1432 | */ | |
15d9e604 | 1433 | public function addToDeveloperTab($sql) { |
02d451ab EM |
1434 | if (!CRM_Core_Permission::check('view report sql')) { |
1435 | return; | |
1436 | } | |
be2fb01f | 1437 | $ignored_output_modes = ['pdf', 'csv', 'print']; |
e7c9c0ff JM |
1438 | if (in_array($this->_outputMode, $ignored_output_modes)) { |
1439 | return; | |
1440 | } | |
be2fb01f | 1441 | $this->tabs['Developer'] = [ |
02d451ab EM |
1442 | 'title' => ts('Developer'), |
1443 | 'tpl' => 'Developer', | |
1444 | 'div_label' => 'set-developer', | |
be2fb01f | 1445 | ]; |
02d451ab EM |
1446 | |
1447 | $this->assignTabs(); | |
55f71fa7 | 1448 | $this->sqlArray[] = $sql; |
43c1fa19 | 1449 | foreach ($this->sqlArray as $sql) { |
be2fb01f | 1450 | foreach (['LEFT JOIN'] as $term) { |
fe77ced7 | 1451 | $sql = str_replace($term, '<br> ' . $term, $sql); |
43c1fa19 | 1452 | } |
be2fb01f | 1453 | foreach (['FROM', 'WHERE', 'GROUP BY', 'ORDER BY', 'LIMIT', ';'] as $term) { |
43c1fa19 | 1454 | $sql = str_replace($term, '<br><br>' . $term, $sql); |
1455 | } | |
1456 | $this->sqlFormattedArray[] = $sql; | |
1457 | $this->assign('sql', implode(';<br><br><br><br>', $this->sqlFormattedArray)); | |
02d451ab | 1458 | } |
911eb44f | 1459 | $this->assign('sqlModes', $sqlModes = CRM_Utils_SQL::getSqlModes()); |
1460 | ||
02d451ab EM |
1461 | } |
1462 | ||
0b62c1ab | 1463 | /** |
50951061 EM |
1464 | * Add options defined in $this->_options to the report. |
1465 | */ | |
00be9182 | 1466 | public function addOptions() { |
6a488035 TO |
1467 | if (!empty($this->_options)) { |
1468 | // FIXME: For now lets build all elements as checkboxes. | |
1469 | // Once we clear with the format we can build elements based on type | |
1470 | ||
6a488035 | 1471 | foreach ($this->_options as $fieldName => $field) { |
be2fb01f | 1472 | $options = []; |
52b41f2f | 1473 | |
6a488035 TO |
1474 | if ($field['type'] == 'select') { |
1475 | $this->addElement('select', "{$fieldName}", $field['title'], $field['options']); | |
1476 | } | |
4c9b6178 | 1477 | elseif ($field['type'] == 'checkbox') { |
6a488035 | 1478 | $options[$field['title']] = $fieldName; |
52634dad DS |
1479 | $this->addCheckBox($fieldName, NULL, |
1480 | $options, NULL, | |
1481 | NULL, NULL, NULL, $this->_fourColumnAttribute | |
1482 | ); | |
6a488035 TO |
1483 | } |
1484 | } | |
6a488035 | 1485 | } |
0f8c6e58 | 1486 | if (!empty($this->_options) && |
1487 | (!$this->_id | |
1488 | || ($this->_id && CRM_Report_BAO_ReportInstance::contactCanAdministerReport($this->_id))) | |
1489 | ) { | |
be2fb01f | 1490 | $this->tabs['ReportOptions'] = [ |
0b62c1ab EM |
1491 | 'title' => ts('Display Options'), |
1492 | 'tpl' => 'ReportOptions', | |
1493 | 'div_label' => 'other-options', | |
be2fb01f | 1494 | ]; |
0b62c1ab | 1495 | } |
52634dad | 1496 | $this->assign('otherOptions', $this->_options); |
6a488035 TO |
1497 | } |
1498 | ||
50951061 EM |
1499 | /** |
1500 | * Add chart options to the report. | |
1501 | */ | |
00be9182 | 1502 | public function addChartOptions() { |
6a488035 | 1503 | if (!empty($this->_charts)) { |
22b67281 | 1504 | $this->addElement('select', "charts", ts('Chart'), $this->_charts); |
6a488035 TO |
1505 | $this->assign('charts', $this->_charts); |
1506 | $this->addElement('submit', $this->_chartButtonName, ts('View')); | |
1507 | } | |
1508 | } | |
1509 | ||
50951061 EM |
1510 | /** |
1511 | * Add group by options to the report. | |
1512 | */ | |
00be9182 | 1513 | public function addGroupBys() { |
be2fb01f | 1514 | $options = $freqElements = []; |
6a488035 TO |
1515 | |
1516 | foreach ($this->_columns as $tableName => $table) { | |
1517 | if (array_key_exists('group_bys', $table)) { | |
1518 | foreach ($table['group_bys'] as $fieldName => $field) { | |
c3fdd2b7 | 1519 | if (!empty($field) && empty($field['no_display'])) { |
6a488035 | 1520 | $options[$field['title']] = $fieldName; |
a7488080 | 1521 | if (!empty($field['frequency'])) { |
6a488035 TO |
1522 | $freqElements[$field['title']] = $fieldName; |
1523 | } | |
1524 | } | |
1525 | } | |
1526 | } | |
1527 | } | |
1528 | $this->addCheckBox("group_bys", ts('Group by columns'), $options, NULL, | |
1529 | NULL, NULL, NULL, $this->_fourColumnAttribute | |
1530 | ); | |
1531 | $this->assign('groupByElements', $options); | |
0b62c1ab | 1532 | if (!empty($options)) { |
be2fb01f | 1533 | $this->tabs['GroupBy'] = [ |
0b62c1ab EM |
1534 | 'title' => ts('Grouping'), |
1535 | 'tpl' => 'GroupBy', | |
1536 | 'div_label' => 'group-by-elements', | |
be2fb01f | 1537 | ]; |
0b62c1ab | 1538 | } |
6a488035 TO |
1539 | |
1540 | foreach ($freqElements as $name) { | |
1541 | $this->addElement('select', "group_bys_freq[$name]", | |
1542 | ts('Frequency'), $this->_groupByDateFreq | |
1543 | ); | |
1544 | } | |
1545 | } | |
1546 | ||
0b62c1ab EM |
1547 | /** |
1548 | * Add data for order by tab. | |
1549 | */ | |
00be9182 | 1550 | public function addOrderBys() { |
be2fb01f | 1551 | $options = []; |
6a488035 TO |
1552 | foreach ($this->_columns as $tableName => $table) { |
1553 | ||
0b62c1ab | 1554 | // Report developer may define any column to order by; include these as order-by options. |
6a488035 TO |
1555 | if (array_key_exists('order_bys', $table)) { |
1556 | foreach ($table['order_bys'] as $fieldName => $field) { | |
1557 | if (!empty($field)) { | |
1558 | $options[$fieldName] = $field['title']; | |
1559 | } | |
1560 | } | |
1561 | } | |
1562 | ||
971d41b1 CW |
1563 | // Add searchable custom fields as order-by options, if so requested |
1564 | // (These are already indexed, so allowing to order on them is cheap.) | |
6a488035 | 1565 | |
9d72cede EM |
1566 | if ($this->_autoIncludeIndexedFieldsAsOrderBys && |
1567 | array_key_exists('extends', $table) && !empty($table['extends']) | |
1568 | ) { | |
6a488035 | 1569 | foreach ($table['fields'] as $fieldName => $field) { |
a7488080 | 1570 | if (empty($field['no_display'])) { |
6a488035 TO |
1571 | $options[$fieldName] = $field['title']; |
1572 | } | |
1573 | } | |
1574 | } | |
1575 | } | |
1576 | ||
1577 | asort($options); | |
1578 | ||
1579 | $this->assign('orderByOptions', $options); | |
0b62c1ab | 1580 | if (!empty($options)) { |
be2fb01f | 1581 | $this->tabs['OrderBy'] = [ |
0b62c1ab EM |
1582 | 'title' => ts('Sorting'), |
1583 | 'tpl' => 'OrderBy', | |
cd732070 | 1584 | 'div_label' => 'order-by-elements', |
be2fb01f | 1585 | ]; |
0b62c1ab | 1586 | } |
6a488035 TO |
1587 | |
1588 | if (!empty($options)) { | |
be2fb01f | 1589 | $options = [ |
971d41b1 | 1590 | '-' => ' - none - ', |
be2fb01f | 1591 | ] + $options; |
6a488035 TO |
1592 | for ($i = 1; $i <= 5; $i++) { |
1593 | $this->addElement('select', "order_bys[{$i}][column]", ts('Order by Column'), $options); | |
be2fb01f | 1594 | $this->addElement('select', "order_bys[{$i}][order]", ts('Order by Order'), [ |
ccc29f8e | 1595 | 'ASC' => ts('Ascending'), |
1596 | 'DESC' => ts('Descending'), | |
be2fb01f CW |
1597 | ]); |
1598 | $this->addElement('checkbox', "order_bys[{$i}][section]", ts('Order by Section'), FALSE, ['id' => "order_by_section_$i"]); | |
1599 | $this->addElement('checkbox', "order_bys[{$i}][pageBreak]", ts('Page Break'), FALSE, ['id' => "order_by_pagebreak_$i"]); | |
6a488035 TO |
1600 | } |
1601 | } | |
1602 | } | |
1603 | ||
0b62c1ab | 1604 | /** |
07f44165 | 1605 | * This adds the tab referred to as Title and Format, rendered through Instance.tpl. |
0b62c1ab | 1606 | * |
07f44165 EM |
1607 | * @todo call this tab into the report template in the same way as OrderBy etc, ie |
1608 | * by adding a description of the tab to $this->tabs, causing the tab to be added in | |
1609 | * Criteria.tpl. | |
0b62c1ab | 1610 | */ |
00be9182 | 1611 | public function buildInstanceAndButtons() { |
6a488035 | 1612 | CRM_Report_Form_Instance::buildForm($this); |
87ecd5b7 | 1613 | $this->_actionButtonName = $this->getButtonName('submit'); |
1614 | $this->addTaskMenu($this->getActions($this->_id)); | |
6a488035 | 1615 | |
87ecd5b7 | 1616 | $this->assign('instanceForm', $this->_instanceForm); |
6a488035 | 1617 | |
8a5c4609 DG |
1618 | // CRM-16274 Determine if user has 'edit all contacts' or equivalent |
1619 | $permission = CRM_Core_Permission::getPermission(); | |
db1a2573 | 1620 | if ($this->_instanceForm && $permission == CRM_Core_Permission::EDIT && |
9d72cede EM |
1621 | $this->_add2groupSupported |
1622 | ) { | |
6a488035 | 1623 | $this->addElement('select', 'groups', ts('Group'), |
be2fb01f | 1624 | ['' => ts('Add Contacts to Group')] + |
9d72cede | 1625 | CRM_Core_PseudoConstant::nestedGroup(), |
be2fb01f | 1626 | ['class' => 'crm-select2 crm-action-menu fa-plus huge'] |
6a488035 TO |
1627 | ); |
1628 | $this->assign('group', TRUE); | |
1629 | } | |
1630 | ||
be2fb01f | 1631 | $this->addElement('submit', $this->_groupButtonName, '', ['style' => 'display: none;']); |
6a488035 TO |
1632 | |
1633 | $this->addChartOptions(); | |
87ecd5b7 | 1634 | $showResultsLabel = $this->getResultsLabel(); |
be2fb01f CW |
1635 | $this->addButtons([ |
1636 | [ | |
6a488035 | 1637 | 'type' => 'submit', |
87ecd5b7 | 1638 | 'name' => $showResultsLabel, |
6a488035 | 1639 | 'isDefault' => TRUE, |
be2fb01f | 1640 | ], |
c86d4e7c | 1641 | ]); |
6a488035 TO |
1642 | } |
1643 | ||
87ecd5b7 | 1644 | /** |
1645 | * Has this form been submitted already? | |
1646 | * | |
1647 | * @return bool | |
1648 | */ | |
1649 | public function resultsDisplayed() { | |
1650 | $buttonName = $this->controller->getButtonName(); | |
1651 | return ($buttonName || $this->_outputMode); | |
1652 | } | |
1653 | ||
1654 | /** | |
1655 | * Get the actions for this report instance. | |
1656 | * | |
1657 | * @param int $instanceId | |
1658 | * | |
1659 | * @return array | |
1660 | */ | |
1661 | protected function getActions($instanceId) { | |
44543184 | 1662 | $actions = CRM_Report_BAO_ReportInstance::getActionMetadata(); |
87ecd5b7 | 1663 | if (empty($instanceId)) { |
be2fb01f | 1664 | $actions['report_instance.save'] = [ |
d0c1b07a | 1665 | 'title' => ts('Create Report'), |
be2fb01f | 1666 | 'data' => [ |
d0c1b07a | 1667 | 'is_confirm' => TRUE, |
1668 | 'confirm_title' => ts('Create Report'), | |
be2fb01f CW |
1669 | 'confirm_refresh_fields' => json_encode([ |
1670 | 'title' => ['selector' => '.crm-report-instanceForm-form-block-title', 'prepend' => ''], | |
1671 | 'description' => ['selector' => '.crm-report-instanceForm-form-block-description', 'prepend' => ''], | |
1672 | ]), | |
1673 | ], | |
1674 | ]; | |
3f501e5e | 1675 | unset($actions['report_instance.delete']); |
87ecd5b7 | 1676 | } |
1677 | ||
44543184 | 1678 | if (!$this->_csvSupported) { |
1679 | unset($actions['report_instance.csv']); | |
87ecd5b7 | 1680 | } |
1681 | ||
1682 | return $actions; | |
1683 | } | |
1684 | ||
0b62c1ab EM |
1685 | /** |
1686 | * Main build form function. | |
1687 | */ | |
00be9182 | 1688 | public function buildQuickForm() { |
6a488035 TO |
1689 | $this->addColumns(); |
1690 | ||
1691 | $this->addFilters(); | |
1692 | ||
1693 | $this->addOptions(); | |
1694 | ||
1695 | $this->addGroupBys(); | |
1696 | ||
1697 | $this->addOrderBys(); | |
1698 | ||
1699 | $this->buildInstanceAndButtons(); | |
1700 | ||
0b62c1ab | 1701 | // Add form rule for report. |
be2fb01f | 1702 | if (is_callable([ |
9d72cede | 1703 | $this, |
21dfd5f5 | 1704 | 'formRule', |
be2fb01f CW |
1705 | ])) { |
1706 | $this->addFormRule([get_class($this), 'formRule'], $this); | |
6a488035 | 1707 | } |
0b62c1ab | 1708 | $this->assignTabs(); |
6a488035 TO |
1709 | } |
1710 | ||
74cf4551 | 1711 | /** |
317a8023 | 1712 | * A form rule function for custom data. |
1713 | * | |
1714 | * The rule ensures that fields selected in group_by if any) should only be the ones | |
1715 | * present in display/select fields criteria; | |
4f1f1f2a | 1716 | * note: works if and only if any custom field selected in group_by. |
0b62c1ab | 1717 | * |
537c70b8 | 1718 | * @param array $fields |
74cf4551 EM |
1719 | * @param array $ignoreFields |
1720 | * | |
1721 | * @return array | |
1722 | */ | |
be2fb01f CW |
1723 | public function customDataFormRule($fields, $ignoreFields = []) { |
1724 | $errors = []; | |
9d72cede EM |
1725 | if (!empty($this->_customGroupExtends) && $this->_customGroupGroupBy && |
1726 | !empty($fields['group_bys']) | |
1727 | ) { | |
6a488035 | 1728 | foreach ($this->_columns as $tableName => $table) { |
9d72cede EM |
1729 | if ((substr($tableName, 0, 13) == 'civicrm_value' || |
1730 | substr($tableName, 0, 12) == 'custom_value') && | |
1731 | !empty($this->_columns[$tableName]['fields']) | |
1732 | ) { | |
6a488035 TO |
1733 | foreach ($this->_columns[$tableName]['fields'] as $fieldName => $field) { |
1734 | if (array_key_exists($fieldName, $fields['group_bys']) && | |
1735 | !array_key_exists($fieldName, $fields['fields']) | |
1736 | ) { | |
1737 | $errors['fields'] = "Please make sure fields selected in 'Group by Columns' section are also selected in 'Display Columns' section."; | |
1738 | } | |
1739 | elseif (array_key_exists($fieldName, $fields['group_bys'])) { | |
1740 | foreach ($fields['fields'] as $fld => $val) { | |
9d72cede EM |
1741 | if (!array_key_exists($fld, $fields['group_bys']) && |
1742 | !in_array($fld, $ignoreFields) | |
1743 | ) { | |
6a488035 TO |
1744 | $errors['fields'] = "Please ensure that fields selected in 'Display Columns' are also selected in 'Group by Columns' section."; |
1745 | } | |
1746 | } | |
1747 | } | |
1748 | } | |
1749 | } | |
1750 | } | |
1751 | } | |
1752 | return $errors; | |
1753 | } | |
1754 | ||
74cf4551 | 1755 | /** |
0b62c1ab EM |
1756 | * Get operators to display on form. |
1757 | * | |
1758 | * Note: $fieldName param allows inheriting class to build operationPairs specific to a field. | |
1759 | * | |
74cf4551 | 1760 | * @param string $type |
8a925f33 | 1761 | * @param string $fieldName |
74cf4551 EM |
1762 | * |
1763 | * @return array | |
1764 | */ | |
00be9182 | 1765 | public function getOperationPair($type = "string", $fieldName = NULL) { |
6a488035 TO |
1766 | // FIXME: At some point we should move these key-val pairs |
1767 | // to option_group and option_value table. | |
6a488035 | 1768 | switch ($type) { |
160d32e1 E |
1769 | case CRM_Report_Form::OP_INT: |
1770 | case CRM_Report_Form::OP_FLOAT: | |
bed98343 | 1771 | |
be2fb01f | 1772 | $result = [ |
bc3f7f04 | 1773 | 'lte' => ts('Is less than or equal to'), |
6a488035 TO |
1774 | 'gte' => ts('Is greater than or equal to'), |
1775 | 'bw' => ts('Is between'), | |
1776 | 'eq' => ts('Is equal to'), | |
1777 | 'lt' => ts('Is less than'), | |
1778 | 'gt' => ts('Is greater than'), | |
1779 | 'neq' => ts('Is not equal to'), | |
1780 | 'nbw' => ts('Is not between'), | |
1781 | 'nll' => ts('Is empty (Null)'), | |
1782 | 'nnll' => ts('Is not empty (Null)'), | |
be2fb01f | 1783 | ]; |
6c552737 | 1784 | return $result; |
6a488035 | 1785 | |
160d32e1 | 1786 | case CRM_Report_Form::OP_SELECT: |
be2fb01f | 1787 | $result = [ |
bc3f7f04 | 1788 | 'eq' => ts('Is equal to'), |
be2fb01f | 1789 | ]; |
6c552737 | 1790 | return $result; |
6a488035 | 1791 | |
160d32e1 E |
1792 | case CRM_Report_Form::OP_MONTH: |
1793 | case CRM_Report_Form::OP_MULTISELECT: | |
2107cde9 | 1794 | case CRM_Report_Form::OP_ENTITYREF: |
bed98343 | 1795 | |
be2fb01f | 1796 | $result = [ |
bc3f7f04 | 1797 | 'in' => ts('Is one of'), |
6a488035 | 1798 | 'notin' => ts('Is not one of'), |
a4818149 | 1799 | 'nll' => ts('Is empty (Null)'), |
1800 | 'nnll' => ts('Is not empty (Null)'), | |
be2fb01f | 1801 | ]; |
6c552737 | 1802 | return $result; |
6a488035 | 1803 | |
160d32e1 | 1804 | case CRM_Report_Form::OP_DATE: |
bed98343 | 1805 | |
be2fb01f | 1806 | $result = [ |
bc3f7f04 | 1807 | 'nll' => ts('Is empty (Null)'), |
6a488035 | 1808 | 'nnll' => ts('Is not empty (Null)'), |
be2fb01f | 1809 | ]; |
6c552737 | 1810 | return $result; |
6a488035 | 1811 | |
160d32e1 | 1812 | case CRM_Report_Form::OP_MULTISELECT_SEPARATOR: |
6a488035 TO |
1813 | // use this operator for the values, concatenated with separator. For e.g if |
1814 | // multiple options for a column is stored as ^A{val1}^A{val2}^A | |
be2fb01f | 1815 | $result = [ |
bc3f7f04 | 1816 | 'mhas' => ts('Is one of'), |
67788963 | 1817 | 'mnot' => ts('Is not one of'), |
be2fb01f | 1818 | ]; |
6c552737 | 1819 | return $result; |
6a488035 TO |
1820 | |
1821 | default: | |
1822 | // type is string | |
be2fb01f | 1823 | $result = [ |
bc3f7f04 | 1824 | 'has' => ts('Contains'), |
6a488035 TO |
1825 | 'sw' => ts('Starts with'), |
1826 | 'ew' => ts('Ends with'), | |
1827 | 'nhas' => ts('Does not contain'), | |
1828 | 'eq' => ts('Is equal to'), | |
1829 | 'neq' => ts('Is not equal to'), | |
1830 | 'nll' => ts('Is empty (Null)'), | |
1831 | 'nnll' => ts('Is not empty (Null)'), | |
be2fb01f | 1832 | ]; |
6c552737 | 1833 | return $result; |
6a488035 TO |
1834 | } |
1835 | } | |
1836 | ||
07f44165 EM |
1837 | /** |
1838 | * Build the tag filter field to display on the filters tab. | |
1839 | */ | |
00be9182 | 1840 | public function buildTagFilter() { |
ed795723 | 1841 | $contactTags = CRM_Core_BAO_Tag::getTags($this->_tagFilterTable); |
6a488035 | 1842 | if (!empty($contactTags)) { |
be2fb01f | 1843 | $this->_columns['civicrm_tag'] = [ |
6a488035 | 1844 | 'dao' => 'CRM_Core_DAO_Tag', |
be2fb01f CW |
1845 | 'filters' => [ |
1846 | 'tagid' => [ | |
6a488035 TO |
1847 | 'name' => 'tag_id', |
1848 | 'title' => ts('Tag'), | |
8ee006e7 | 1849 | 'type' => CRM_Utils_Type::T_INT, |
6a488035 TO |
1850 | 'tag' => TRUE, |
1851 | 'operatorType' => CRM_Report_Form::OP_MULTISELECT, | |
1852 | 'options' => $contactTags, | |
be2fb01f CW |
1853 | ], |
1854 | ], | |
1855 | ]; | |
6a488035 TO |
1856 | } |
1857 | } | |
1858 | ||
688d37c6 | 1859 | /** |
0b62c1ab | 1860 | * Adds group filters to _columns (called from _Construct). |
6a488035 | 1861 | */ |
00be9182 | 1862 | public function buildGroupFilter() { |
be2fb01f CW |
1863 | $this->_columns['civicrm_group']['filters'] = [ |
1864 | 'gid' => [ | |
6a488035 TO |
1865 | 'name' => 'group_id', |
1866 | 'title' => ts('Group'), | |
8ee006e7 | 1867 | 'type' => CRM_Utils_Type::T_INT, |
6a488035 TO |
1868 | 'operatorType' => CRM_Report_Form::OP_MULTISELECT, |
1869 | 'group' => TRUE, | |
16e2e80c | 1870 | 'options' => CRM_Core_PseudoConstant::nestedGroup(), |
be2fb01f CW |
1871 | ], |
1872 | ]; | |
6a488035 TO |
1873 | if (empty($this->_columns['civicrm_group']['dao'])) { |
1874 | $this->_columns['civicrm_group']['dao'] = 'CRM_Contact_DAO_GroupContact'; | |
1875 | } | |
1876 | if (empty($this->_columns['civicrm_group']['alias'])) { | |
1877 | $this->_columns['civicrm_group']['alias'] = 'cgroup'; | |
1878 | } | |
1879 | } | |
1880 | ||
74cf4551 | 1881 | /** |
07f44165 EM |
1882 | * Get SQL operator from form text version. |
1883 | * | |
74cf4551 EM |
1884 | * @param string $operator |
1885 | * | |
1886 | * @return string | |
1887 | */ | |
00be9182 | 1888 | public function getSQLOperator($operator = "like") { |
6a488035 TO |
1889 | switch ($operator) { |
1890 | case 'eq': | |
1891 | return '='; | |
1892 | ||
1893 | case 'lt': | |
1894 | return '<'; | |
1895 | ||
1896 | case 'lte': | |
1897 | return '<='; | |
1898 | ||
1899 | case 'gt': | |
1900 | return '>'; | |
1901 | ||
1902 | case 'gte': | |
1903 | return '>='; | |
1904 | ||
1905 | case 'ne': | |
1906 | case 'neq': | |
1907 | return '!='; | |
1908 | ||
1909 | case 'nhas': | |
1910 | return 'NOT LIKE'; | |
1911 | ||
1912 | case 'in': | |
1913 | return 'IN'; | |
1914 | ||
1915 | case 'notin': | |
1916 | return 'NOT IN'; | |
1917 | ||
1918 | case 'nll': | |
1919 | return 'IS NULL'; | |
1920 | ||
1921 | case 'nnll': | |
1922 | return 'IS NOT NULL'; | |
1923 | ||
1924 | default: | |
1925 | // type is string | |
1926 | return 'LIKE'; | |
1927 | } | |
1928 | } | |
1929 | ||
74cf4551 | 1930 | /** |
f587aa17 | 1931 | * Generate where clause. |
07f44165 | 1932 | * |
8a925f33 | 1933 | * This can be overridden in reports for special treatment of a field |
f587aa17 | 1934 | * |
537c70b8 | 1935 | * @param array $field Field specifications |
8a925f33 | 1936 | * @param string $op Query operator (not an exact match to sql) |
f587aa17 EM |
1937 | * @param mixed $value |
1938 | * @param float $min | |
1939 | * @param float $max | |
74cf4551 EM |
1940 | * |
1941 | * @return null|string | |
1942 | */ | |
8a925f33 | 1943 | public function whereClause(&$field, $op, $value, $min, $max) { |
6a488035 TO |
1944 | |
1945 | $type = CRM_Utils_Type::typeToString(CRM_Utils_Array::value('type', $field)); | |
8ee006e7 WA |
1946 | |
1947 | // CRM-18010: Ensure type of each report filters | |
1948 | if (!$type) { | |
1949 | trigger_error('Type is not defined for field ' . $field['name'], E_USER_WARNING); | |
1950 | } | |
6a488035 TO |
1951 | $clause = NULL; |
1952 | ||
1953 | switch ($op) { | |
1954 | case 'bw': | |
1955 | case 'nbw': | |
1956 | if (($min !== NULL && strlen($min) > 0) || | |
1957 | ($max !== NULL && strlen($max) > 0) | |
1958 | ) { | |
be2fb01f | 1959 | $clauses = []; |
6a488035 | 1960 | if ($min) { |
6621df60 | 1961 | $min = CRM_Utils_Type::escape($min, $type); |
6a488035 TO |
1962 | if ($op == 'bw') { |
1963 | $clauses[] = "( {$field['dbAlias']} >= $min )"; | |
1964 | } | |
1965 | else { | |
cd87f963 | 1966 | $clauses[] = "( {$field['dbAlias']} < $min OR {$field['dbAlias']} IS NULL )"; |
6a488035 TO |
1967 | } |
1968 | } | |
1969 | if ($max) { | |
6621df60 | 1970 | $max = CRM_Utils_Type::escape($max, $type); |
6a488035 TO |
1971 | if ($op == 'bw') { |
1972 | $clauses[] = "( {$field['dbAlias']} <= $max )"; | |
1973 | } | |
1974 | else { | |
1975 | $clauses[] = "( {$field['dbAlias']} > $max )"; | |
1976 | } | |
1977 | } | |
1978 | ||
1979 | if (!empty($clauses)) { | |
1980 | if ($op == 'bw') { | |
1981 | $clause = implode(' AND ', $clauses); | |
1982 | } | |
1983 | else { | |
cd87f963 | 1984 | $clause = '(' . implode('OR', $clauses) . ')'; |
6a488035 TO |
1985 | } |
1986 | } | |
1987 | } | |
1988 | break; | |
1989 | ||
1990 | case 'has': | |
1991 | case 'nhas': | |
1992 | if ($value !== NULL && strlen($value) > 0) { | |
1993 | $value = CRM_Utils_Type::escape($value, $type); | |
1994 | if (strpos($value, '%') === FALSE) { | |
1995 | $value = "'%{$value}%'"; | |
1996 | } | |
1997 | else { | |
1998 | $value = "'{$value}'"; | |
1999 | } | |
29fc2b79 | 2000 | $sqlOP = $this->getSQLOperator($op); |
6a488035 TO |
2001 | $clause = "( {$field['dbAlias']} $sqlOP $value )"; |
2002 | } | |
2003 | break; | |
2004 | ||
2005 | case 'in': | |
2006 | case 'notin': | |
43c1fa19 | 2007 | if ((is_string($value) || is_numeric($value)) && strlen($value)) { |
2107cde9 CW |
2008 | $value = explode(',', $value); |
2009 | } | |
6a488035 | 2010 | if ($value !== NULL && is_array($value) && count($value) > 0) { |
29fc2b79 | 2011 | $sqlOP = $this->getSQLOperator($op); |
9d72cede EM |
2012 | if (CRM_Utils_Array::value('type', $field) == |
2013 | CRM_Utils_Type::T_STRING | |
2014 | ) { | |
f587aa17 | 2015 | //cycle through selections and escape values |
6a488035 TO |
2016 | foreach ($value as $key => $selection) { |
2017 | $value[$key] = CRM_Utils_Type::escape($selection, $type); | |
2018 | } | |
971d41b1 CW |
2019 | $clause |
2020 | = "( {$field['dbAlias']} $sqlOP ( '" . implode("' , '", $value) . | |
9d72cede | 2021 | "') )"; |
6a488035 TO |
2022 | } |
2023 | else { | |
2024 | // for numerical values | |
9d72cede EM |
2025 | $clause = "{$field['dbAlias']} $sqlOP (" . implode(', ', $value) . |
2026 | ")"; | |
6a488035 TO |
2027 | } |
2028 | if ($op == 'notin') { | |
2029 | $clause = "( " . $clause . " OR {$field['dbAlias']} IS NULL )"; | |
2030 | } | |
2031 | else { | |
2032 | $clause = "( " . $clause . " )"; | |
2033 | } | |
2034 | } | |
2035 | break; | |
2036 | ||
2037 | case 'mhas': | |
67788963 | 2038 | case 'mnot': |
05839ccc | 2039 | // multiple has or multiple not |
67788963 | 2040 | if ($value !== NULL && count($value) > 0) { |
f4fd6082 | 2041 | $value = CRM_Utils_Type::escapeAll($value, $type); |
2042 | $operator = $op == 'mnot' ? 'NOT' : ''; | |
228753d3 | 2043 | $regexp = "([[:cntrl:]]|^)" . implode('([[:cntrl:]]|$)|([[:cntrl:]]|^)', (array) $value) . "([[:cntrl:]]|$)"; |
f4fd6082 | 2044 | $clause = "{$field['dbAlias']} {$operator} REGEXP '{$regexp}'"; |
67788963 J |
2045 | } |
2046 | break; | |
6a488035 TO |
2047 | |
2048 | case 'sw': | |
2049 | case 'ew': | |
2050 | if ($value !== NULL && strlen($value) > 0) { | |
2051 | $value = CRM_Utils_Type::escape($value, $type); | |
2052 | if (strpos($value, '%') === FALSE) { | |
2053 | if ($op == 'sw') { | |
2054 | $value = "'{$value}%'"; | |
2055 | } | |
2056 | else { | |
2057 | $value = "'%{$value}'"; | |
2058 | } | |
2059 | } | |
2060 | else { | |
2061 | $value = "'{$value}'"; | |
2062 | } | |
29fc2b79 | 2063 | $sqlOP = $this->getSQLOperator($op); |
6a488035 TO |
2064 | $clause = "( {$field['dbAlias']} $sqlOP $value )"; |
2065 | } | |
2066 | break; | |
2067 | ||
2068 | case 'nll': | |
2069 | case 'nnll': | |
29fc2b79 | 2070 | $sqlOP = $this->getSQLOperator($op); |
6a488035 TO |
2071 | $clause = "( {$field['dbAlias']} $sqlOP )"; |
2072 | break; | |
2073 | ||
55a5250b | 2074 | case 'eq': |
2075 | case 'neq': | |
2076 | case 'ne': | |
2077 | //CRM-18457: some custom field passes value in array format against binary operator | |
2078 | if (is_array($value) && count($value)) { | |
2079 | $value = $value[0]; | |
2080 | } | |
2081 | ||
6a488035 | 2082 | default: |
55a5250b | 2083 | if ($value !== NULL && $value !== '') { |
6a488035 TO |
2084 | if (isset($field['clause'])) { |
2085 | // FIXME: we not doing escape here. Better solution is to use two | |
2086 | // different types - data-type and filter-type | |
0e6e8724 | 2087 | $clause = $field['clause']; |
6a488035 | 2088 | } |
55a5250b | 2089 | elseif (!is_array($value)) { |
6a488035 | 2090 | $value = CRM_Utils_Type::escape($value, $type); |
29fc2b79 | 2091 | $sqlOP = $this->getSQLOperator($op); |
6a488035 TO |
2092 | if ($field['type'] == CRM_Utils_Type::T_STRING) { |
2093 | $value = "'{$value}'"; | |
2094 | } | |
2095 | $clause = "( {$field['dbAlias']} $sqlOP $value )"; | |
2096 | } | |
2097 | } | |
2098 | break; | |
2099 | } | |
2100 | ||
0816f78c EL |
2101 | //dev/core/544 Add report support for multiple contact subTypes |
2102 | if ($field['name'] == 'contact_sub_type' && $clause) { | |
2103 | $clause = $this->whereSubtypeClause($field, $value, $op); | |
2104 | } | |
a7488080 | 2105 | if (!empty($field['group']) && $clause) { |
6a488035 TO |
2106 | $clause = $this->whereGroupClause($field, $value, $op); |
2107 | } | |
a7488080 | 2108 | elseif (!empty($field['tag']) && $clause) { |
6a488035 TO |
2109 | // not using left join in query because if any contact |
2110 | // belongs to more than one tag, results duplicate | |
2111 | // entries. | |
2112 | $clause = $this->whereTagClause($field, $value, $op); | |
2113 | } | |
114a2c85 | 2114 | elseif (!empty($field['membership_org']) && $clause) { |
f587aa17 | 2115 | $clause = $this->whereMembershipOrgClause($value, $op); |
114a2c85 DG |
2116 | } |
2117 | elseif (!empty($field['membership_type']) && $clause) { | |
f587aa17 | 2118 | $clause = $this->whereMembershipTypeClause($value, $op); |
114a2c85 | 2119 | } |
6a488035 TO |
2120 | return $clause; |
2121 | } | |
2122 | ||
0816f78c EL |
2123 | /** |
2124 | * Get SQL where clause for contact subtypes | |
2125 | * @param string $field | |
2126 | * @param mixed $value | |
2127 | * @param string $op SQL Operator | |
2128 | * | |
2129 | * @return string | |
2130 | */ | |
2131 | public function whereSubtypeClause($field, $value, $op) { | |
2132 | $clause = '( '; | |
2133 | $subtypeFilters = count($value); | |
2134 | for ($i = 0; $i < $subtypeFilters; $i++) { | |
2135 | $clause .= "{$field['dbAlias']} LIKE '%$value[$i]%'"; | |
2136 | if ($i !== ($subtypeFilters - 1)) { | |
2137 | $clause .= " OR "; | |
2138 | } | |
2139 | } | |
2140 | $clause .= ' )'; | |
2141 | return $clause; | |
2142 | } | |
2143 | ||
74cf4551 | 2144 | /** |
07f44165 EM |
2145 | * Get SQL where clause for a date field. |
2146 | * | |
100fef9d | 2147 | * @param string $fieldName |
317a8023 | 2148 | * @param string $relative |
f587aa17 EM |
2149 | * @param string $from |
2150 | * @param string $to | |
07f44165 EM |
2151 | * @param string $type |
2152 | * @param string $fromTime | |
2153 | * @param string $toTime | |
74cf4551 EM |
2154 | * |
2155 | * @return null|string | |
2156 | */ | |
971d41b1 | 2157 | public function dateClause( |
7d8c1168 TO |
2158 | $fieldName, |
2159 | $relative, $from, $to, $type = NULL, $fromTime = NULL, $toTime = NULL | |
6a488035 | 2160 | ) { |
be2fb01f | 2161 | $clauses = []; |
160d32e1 | 2162 | if (in_array($relative, array_keys($this->getOperationPair(CRM_Report_Form::OP_DATE)))) { |
29fc2b79 | 2163 | $sqlOP = $this->getSQLOperator($relative); |
6a488035 TO |
2164 | return "( {$fieldName} {$sqlOP} )"; |
2165 | } | |
2166 | ||
29fc2b79 | 2167 | list($from, $to) = $this->getFromTo($relative, $from, $to, $fromTime, $toTime); |
6a488035 TO |
2168 | |
2169 | if ($from) { | |
6a488035 TO |
2170 | $clauses[] = "( {$fieldName} >= $from )"; |
2171 | } | |
2172 | ||
2173 | if ($to) { | |
6a488035 TO |
2174 | $clauses[] = "( {$fieldName} <= {$to} )"; |
2175 | } | |
2176 | ||
2177 | if (!empty($clauses)) { | |
2178 | return implode(' AND ', $clauses); | |
2179 | } | |
2180 | ||
2181 | return NULL; | |
2182 | } | |
9d72cede | 2183 | |
74cf4551 | 2184 | /** |
42b5c549 EM |
2185 | * Get values for from and to for date ranges. |
2186 | * | |
5e9221b7 | 2187 | * @deprecated |
2188 | * | |
f587aa17 EM |
2189 | * @param bool $relative |
2190 | * @param string $from | |
2191 | * @param string $to | |
9907633b EM |
2192 | * @param string $fromTime |
2193 | * @param string $toTime | |
74cf4551 EM |
2194 | * |
2195 | * @return array | |
2196 | */ | |
5e9221b7 | 2197 | public function getFromTo($relative, $from, $to, $fromTime = NULL, $toTime = NULL) { |
2198 | if (empty($toTime)) { | |
2199 | // odd legacy behaviour to treat NULL as 'end of the day' | |
2200 | // recommend updating reports to call CRM_Utils_Date::getFromTo | |
2201 | //directly (default on the function is the actual default there). | |
2202 | $toTime = '235959'; | |
2203 | } | |
7ec58d2b | 2204 | return CRM_Utils_Date::getFromTo($relative, $from, $to, $fromTime, $toTime); |
6a488035 TO |
2205 | } |
2206 | ||
74cf4551 | 2207 | /** |
4b62bc4f EM |
2208 | * Alter display of rows. |
2209 | * | |
2210 | * Iterate through the rows retrieved via SQL and make changes for display purposes, | |
2211 | * such as rendering contacts as links. | |
2212 | * | |
2213 | * @param array $rows | |
2214 | * Rows generated by SQL, with an array for each row. | |
74cf4551 | 2215 | */ |
00be9182 | 2216 | public function alterDisplay(&$rows) { |
6a488035 TO |
2217 | } |
2218 | ||
74cf4551 | 2219 | /** |
42b5c549 EM |
2220 | * Alter the way in which custom data fields are displayed. |
2221 | * | |
2222 | * @param array $rows | |
74cf4551 | 2223 | */ |
00be9182 | 2224 | public function alterCustomDataDisplay(&$rows) { |
6a488035 TO |
2225 | // custom code to alter rows having custom values |
2226 | if (empty($this->_customGroupExtends)) { | |
2227 | return; | |
2228 | } | |
2229 | ||
be2fb01f CW |
2230 | $customFields = []; |
2231 | $customFieldIds = []; | |
6a488035 TO |
2232 | foreach ($this->_params['fields'] as $fieldAlias => $value) { |
2233 | if ($fieldId = CRM_Core_BAO_CustomField::getKeyID($fieldAlias)) { | |
2234 | $customFieldIds[$fieldAlias] = $fieldId; | |
2235 | } | |
2236 | } | |
2237 | if (empty($customFieldIds)) { | |
2238 | return; | |
2239 | } | |
2240 | ||
6a488035 TO |
2241 | // skip for type date and ContactReference since date format is already handled |
2242 | $query = " | |
28241a61 | 2243 | SELECT cg.table_name, cf.id |
6a488035 TO |
2244 | FROM civicrm_custom_field cf |
2245 | INNER JOIN civicrm_custom_group cg ON cg.id = cf.custom_group_id | |
6a488035 TO |
2246 | WHERE cg.extends IN ('" . implode("','", $this->_customGroupExtends) . "') AND |
2247 | cg.is_active = 1 AND | |
2248 | cf.is_active = 1 AND | |
2249 | cf.is_searchable = 1 AND | |
2250 | cf.data_type NOT IN ('ContactReference', 'Date') AND | |
2251 | cf.id IN (" . implode(",", $customFieldIds) . ")"; | |
2252 | ||
2253 | $dao = CRM_Core_DAO::executeQuery($query); | |
2254 | while ($dao->fetch()) { | |
28241a61 | 2255 | $customFields[$dao->table_name . '_custom_' . $dao->id] = $dao->id; |
6a488035 | 2256 | } |
6a488035 TO |
2257 | |
2258 | $entryFound = FALSE; | |
2259 | foreach ($rows as $rowNum => $row) { | |
2260 | foreach ($row as $tableCol => $val) { | |
2261 | if (array_key_exists($tableCol, $customFields)) { | |
28241a61 | 2262 | $rows[$rowNum][$tableCol] = CRM_Core_BAO_CustomField::displayValue($val, $customFields[$tableCol]); |
6a488035 TO |
2263 | $entryFound = TRUE; |
2264 | } | |
2265 | } | |
2266 | ||
2267 | // skip looking further in rows, if first row itself doesn't | |
2268 | // have the column we need | |
2269 | if (!$entryFound) { | |
2270 | break; | |
2271 | } | |
2272 | } | |
2273 | } | |
2274 | ||
74cf4551 | 2275 | /** |
317a8023 | 2276 | * Remove duplicate rows. |
2277 | * | |
2278 | * @param array $rows | |
74cf4551 | 2279 | */ |
00be9182 | 2280 | public function removeDuplicates(&$rows) { |
6a488035 TO |
2281 | if (empty($this->_noRepeats)) { |
2282 | return; | |
2283 | } | |
be2fb01f | 2284 | $checkList = []; |
6a488035 TO |
2285 | |
2286 | foreach ($rows as $key => $list) { | |
2287 | foreach ($list as $colName => $colVal) { | |
8f1445ea | 2288 | if (array_key_exists($colName, $checkList) && |
9d72cede EM |
2289 | $checkList[$colName] == $colVal |
2290 | ) { | |
6a488035 TO |
2291 | $rows[$key][$colName] = ""; |
2292 | } | |
2293 | if (in_array($colName, $this->_noRepeats)) { | |
2294 | $checkList[$colName] = $colVal; | |
2295 | } | |
2296 | } | |
2297 | } | |
2298 | } | |
2299 | ||
74cf4551 | 2300 | /** |
317a8023 | 2301 | * Fix subtotal display. |
2302 | * | |
2303 | * @param array $row | |
2304 | * @param array $fields | |
74cf4551 EM |
2305 | * @param bool $subtotal |
2306 | */ | |
00be9182 | 2307 | public function fixSubTotalDisplay(&$row, $fields, $subtotal = TRUE) { |
6a488035 TO |
2308 | foreach ($row as $colName => $colVal) { |
2309 | if (in_array($colName, $fields)) { | |
6a488035 TO |
2310 | } |
2311 | elseif (isset($this->_columnHeaders[$colName])) { | |
2312 | if ($subtotal) { | |
8c2959c8 | 2313 | $row[$colName] = 'Subtotal'; |
6a488035 TO |
2314 | $subtotal = FALSE; |
2315 | } | |
2316 | else { | |
2317 | unset($row[$colName]); | |
2318 | } | |
2319 | } | |
2320 | } | |
2321 | } | |
2322 | ||
74cf4551 | 2323 | /** |
317a8023 | 2324 | * Calculate grant total. |
2325 | * | |
2326 | * @param array $rows | |
74cf4551 EM |
2327 | * |
2328 | * @return bool | |
2329 | */ | |
00be9182 | 2330 | public function grandTotal(&$rows) { |
c160fde8 | 2331 | if (!$this->_rollup || count($rows) == 1) { |
2332 | return FALSE; | |
2333 | } | |
2334 | ||
2335 | $this->moveSummaryColumnsToTheRightHandSide(); | |
2336 | ||
2337 | if ($this->_limit && count($rows) >= self::ROW_COUNT_LIMIT) { | |
6a488035 TO |
2338 | return FALSE; |
2339 | } | |
8a2bee47 | 2340 | |
2341 | $this->rollupRow = array_pop($rows); | |
6a488035 | 2342 | |
6a488035 TO |
2343 | foreach ($this->_columnHeaders as $fld => $val) { |
2344 | if (!in_array($fld, $this->_statFields)) { | |
2345 | if (!$this->_grandFlag) { | |
658682cd | 2346 | $this->rollupRow[$fld] = ts('Grand Total'); |
6a488035 TO |
2347 | $this->_grandFlag = TRUE; |
2348 | } | |
2349 | else { | |
8a2bee47 | 2350 | $this->rollupRow[$fld] = ""; |
6a488035 TO |
2351 | } |
2352 | } | |
2353 | } | |
2354 | ||
8a2bee47 | 2355 | $this->assign('grandStat', $this->rollupRow); |
6a488035 TO |
2356 | return TRUE; |
2357 | } | |
2358 | ||
74cf4551 | 2359 | /** |
317a8023 | 2360 | * Format display output. |
2361 | * | |
2362 | * @param array $rows | |
74cf4551 EM |
2363 | * @param bool $pager |
2364 | */ | |
00be9182 | 2365 | public function formatDisplay(&$rows, $pager = TRUE) { |
6a488035 TO |
2366 | // set pager based on if any limit was applied in the query. |
2367 | if ($pager) { | |
2368 | $this->setPager(); | |
2369 | } | |
2370 | ||
2371 | // allow building charts if any | |
2372 | if (!empty($this->_params['charts']) && !empty($rows)) { | |
2373 | $this->buildChart($rows); | |
2374 | $this->assign('chartEnabled', TRUE); | |
9d72cede EM |
2375 | $this->_chartId = "{$this->_params['charts']}_" . |
2376 | ($this->_id ? $this->_id : substr(get_class($this), 16)) . '_' . | |
2377 | session_id(); | |
6a488035 TO |
2378 | $this->assign('chartId', $this->_chartId); |
2379 | } | |
2380 | ||
2381 | // unset columns not to be displayed. | |
2382 | foreach ($this->_columnHeaders as $key => $value) { | |
a7488080 | 2383 | if (!empty($value['no_display'])) { |
6a488035 TO |
2384 | unset($this->_columnHeaders[$key]); |
2385 | } | |
2386 | } | |
2387 | ||
2388 | // unset columns not to be displayed. | |
2389 | if (!empty($rows)) { | |
2390 | foreach ($this->_noDisplay as $noDisplayField) { | |
2391 | foreach ($rows as $rowNum => $row) { | |
2392 | unset($this->_columnHeaders[$noDisplayField]); | |
2393 | } | |
2394 | } | |
2395 | } | |
2396 | ||
2397 | // build array of section totals | |
2398 | $this->sectionTotals(); | |
2399 | ||
2400 | // process grand-total row | |
2401 | $this->grandTotal($rows); | |
2402 | ||
59b19369 JJ |
2403 | // Find alter display functions. |
2404 | $firstRow = reset($rows); | |
2405 | if ($firstRow) { | |
2406 | $selectedFields = array_keys($firstRow); | |
be2fb01f | 2407 | $alterFunctions = $alterMap = $alterSpecs = []; |
59b19369 JJ |
2408 | foreach ($this->_columns as $tableName => $table) { |
2409 | if (array_key_exists('metadata', $table)) { | |
2410 | foreach ($table['metadata'] as $field => $specs) { | |
2411 | if (in_array($tableName . '_' . $field, $selectedFields)) { | |
2412 | if (array_key_exists('alter_display', $specs)) { | |
2413 | $alterFunctions[$tableName . '_' . $field] = $specs['alter_display']; | |
2414 | $alterMap[$tableName . '_' . $field] = $field; | |
2415 | $alterSpecs[$tableName . '_' . $field] = NULL; | |
2416 | } | |
2417 | // Add any alters that can be intuited from the field specs. | |
2418 | // So far only boolean but a lot more could be. | |
2419 | if (empty($alterSpecs[$tableName . '_' . $field]) && isset($specs['type']) && $specs['type'] == CRM_Utils_Type::T_BOOLEAN) { | |
2420 | $alterFunctions[$tableName . '_' . $field] = 'alterBoolean'; | |
2421 | $alterMap[$tableName . '_' . $field] = $field; | |
2422 | $alterSpecs[$tableName . '_' . $field] = NULL; | |
2423 | } | |
2424 | } | |
2425 | } | |
2426 | } | |
2427 | } | |
2428 | ||
2429 | // Run the alter display functions | |
2430 | foreach ($rows as $index => & $row) { | |
2431 | foreach ($row as $selectedField => $value) { | |
2432 | if (array_key_exists($selectedField, $alterFunctions)) { | |
2433 | $rows[$index][$selectedField] = $this->{$alterFunctions[$selectedField]}($value, $row, $selectedField, $alterMap[$selectedField], $alterSpecs[$selectedField]); | |
2434 | } | |
2435 | } | |
2436 | } | |
2437 | } | |
2438 | ||
6a488035 TO |
2439 | // use this method for formatting rows for display purpose. |
2440 | $this->alterDisplay($rows); | |
2441 | CRM_Utils_Hook::alterReportVar('rows', $rows, $this); | |
2442 | ||
2443 | // use this method for formatting custom rows for display purpose. | |
2444 | $this->alterCustomDataDisplay($rows); | |
2445 | } | |
2446 | ||
59b19369 JJ |
2447 | /** |
2448 | * @param $value | |
2449 | * @param $row | |
2450 | * @param $selectedfield | |
2451 | * @param $criteriaFieldName | |
2452 | * | |
2453 | * @return array | |
2454 | */ | |
2455 | protected function alterStateProvinceID($value, &$row, $selectedfield, $criteriaFieldName) { | |
2456 | $url = CRM_Utils_System::url(CRM_Utils_System::currentPath(), "reset=1&force=1&{$criteriaFieldName}_op=in&{$criteriaFieldName}_value={$value}", $this->_absoluteUrl); | |
2457 | $row[$selectedfield . '_link'] = $url; | |
be2fb01f | 2458 | $row[$selectedfield . '_hover'] = ts("%1 for this state.", [ |
59b19369 | 2459 | 1 => $value, |
be2fb01f | 2460 | ]); |
59b19369 JJ |
2461 | |
2462 | $states = CRM_Core_PseudoConstant::stateProvince($value, FALSE); | |
2463 | if (!is_array($states)) { | |
2464 | return $states; | |
2465 | } | |
2466 | } | |
2467 | ||
2468 | /** | |
2469 | * @param $value | |
2470 | * @param $row | |
2471 | * @param $selectedField | |
2472 | * @param $criteriaFieldName | |
2473 | * | |
2474 | * @return array | |
2475 | */ | |
2476 | protected function alterCountryID($value, &$row, $selectedField, $criteriaFieldName) { | |
2477 | $url = CRM_Utils_System::url(CRM_Utils_System::currentPath(), "reset=1&force=1&{$criteriaFieldName}_op=in&{$criteriaFieldName}_value={$value}", $this->_absoluteUrl); | |
2478 | $row[$selectedField . '_link'] = $url; | |
be2fb01f | 2479 | $row[$selectedField . '_hover'] = ts("%1 for this country.", [ |
59b19369 | 2480 | 1 => $value, |
be2fb01f | 2481 | ]); |
59b19369 JJ |
2482 | $countries = CRM_Core_PseudoConstant::country($value, FALSE); |
2483 | if (!is_array($countries)) { | |
2484 | return $countries; | |
2485 | } | |
2486 | } | |
2487 | ||
2488 | /** | |
2489 | * @param $value | |
2490 | * @param $row | |
2491 | * @param $selectedfield | |
2492 | * @param $criteriaFieldName | |
2493 | * | |
2494 | * @return array | |
2495 | */ | |
2496 | protected function alterCountyID($value, &$row, $selectedfield, $criteriaFieldName) { | |
2497 | $url = CRM_Utils_System::url(CRM_Utils_System::currentPath(), "reset=1&force=1&{$criteriaFieldName}_op=in&{$criteriaFieldName}_value={$value}", $this->_absoluteUrl); | |
2498 | $row[$selectedfield . '_link'] = $url; | |
be2fb01f | 2499 | $row[$selectedfield . '_hover'] = ts("%1 for this county.", [ |
59b19369 | 2500 | 1 => $value, |
be2fb01f | 2501 | ]); |
59b19369 JJ |
2502 | $counties = CRM_Core_PseudoConstant::county($value, FALSE); |
2503 | if (!is_array($counties)) { | |
2504 | return $counties; | |
2505 | } | |
2506 | } | |
2507 | ||
2508 | /** | |
2509 | * @param $value | |
2510 | * @param $row | |
2511 | * @param $selectedfield | |
2512 | * @param $criteriaFieldName | |
2513 | * | |
2514 | * @return mixed | |
2515 | */ | |
2516 | protected function alterLocationTypeID($value, &$row, $selectedfield, $criteriaFieldName) { | |
d7786eaa | 2517 | return CRM_Core_PseudoConstant::getLabel('CRM_Core_DAO_Address', 'location_type_id', $value); |
59b19369 JJ |
2518 | } |
2519 | ||
2520 | /** | |
2521 | * @param $value | |
2522 | * @param $row | |
2523 | * @param $fieldname | |
2524 | * | |
2525 | * @return mixed | |
2526 | */ | |
2527 | protected function alterContactID($value, &$row, $fieldname) { | |
2528 | $nameField = substr($fieldname, 0, -2) . 'name'; | |
2529 | static $first = TRUE; | |
2530 | static $viewContactList = FALSE; | |
2531 | if ($first) { | |
2532 | $viewContactList = CRM_Core_Permission::check('access CiviCRM'); | |
2533 | $first = FALSE; | |
2534 | } | |
2535 | if (!$viewContactList) { | |
2536 | return $value; | |
2537 | } | |
2538 | if (array_key_exists($nameField, $row)) { | |
2539 | $row[$nameField . '_link'] = CRM_Utils_System::url("civicrm/contact/view", 'reset=1&cid=' . $value, $this->_absoluteUrl); | |
2540 | } | |
2541 | else { | |
2542 | $row[$fieldname . '_link'] = CRM_Utils_System::url("civicrm/contact/view", 'reset=1&cid=' . $value, $this->_absoluteUrl); | |
2543 | } | |
2544 | return $value; | |
2545 | } | |
2546 | ||
2547 | /** | |
2548 | * @param $value | |
2549 | * | |
2550 | * @return mixed | |
2551 | */ | |
2552 | protected function alterBoolean($value) { | |
be2fb01f | 2553 | $options = [0 => '', 1 => ts('Yes')]; |
59b19369 JJ |
2554 | if (isset($options[$value])) { |
2555 | return $options[$value]; | |
2556 | } | |
2557 | return $value; | |
2558 | } | |
2559 | ||
74cf4551 | 2560 | /** |
317a8023 | 2561 | * Build chart. |
2562 | * | |
2563 | * @param array $rows | |
74cf4551 | 2564 | */ |
00be9182 | 2565 | public function buildChart(&$rows) { |
6a488035 TO |
2566 | // override this method for building charts. |
2567 | } | |
2568 | ||
2569 | // select() method below has been added recently (v3.3), and many of the report templates might | |
2570 | // still be having their own select() method. We should fix them as and when encountered and move | |
2571 | // towards generalizing the select() method below. | |
971d41b1 CW |
2572 | |
2573 | /** | |
317a8023 | 2574 | * Generate the SELECT clause and set class variable $_select. |
971d41b1 | 2575 | */ |
00be9182 | 2576 | public function select() { |
be2fb01f | 2577 | $select = $this->_selectAliases = []; |
534c4d20 | 2578 | $this->storeGroupByArray(); |
6a488035 TO |
2579 | |
2580 | foreach ($this->_columns as $tableName => $table) { | |
2581 | if (array_key_exists('fields', $table)) { | |
2582 | foreach ($table['fields'] as $fieldName => $field) { | |
2583 | if ($tableName == 'civicrm_address') { | |
f38e3c19 | 2584 | // deprecated, use $this->isTableSelected. |
6a488035 TO |
2585 | $this->_addressField = TRUE; |
2586 | } | |
2587 | if ($tableName == 'civicrm_email') { | |
2588 | $this->_emailField = TRUE; | |
2589 | } | |
2590 | if ($tableName == 'civicrm_phone') { | |
2591 | $this->_phoneField = TRUE; | |
2592 | } | |
2593 | ||
9d72cede EM |
2594 | if (!empty($field['required']) || |
2595 | !empty($this->_params['fields'][$fieldName]) | |
2596 | ) { | |
6a488035 TO |
2597 | |
2598 | // 1. In many cases we want select clause to be built in slightly different way | |
317a8023 | 2599 | // for a particular field of a particular type. |
6a488035 | 2600 | // 2. This method when used should receive params by reference and modify $this->_columnHeaders |
317a8023 | 2601 | // as needed. |
6a488035 TO |
2602 | $selectClause = $this->selectClause($tableName, 'fields', $fieldName, $field); |
2603 | if ($selectClause) { | |
2604 | $select[] = $selectClause; | |
2605 | continue; | |
2606 | } | |
2607 | ||
2608 | // include statistics columns only if set | |
4b885f84 | 2609 | if (!empty($field['statistics']) && !empty($this->_groupByArray)) { |
0a01dff9 | 2610 | $select = $this->addStatisticsToSelect($field, $tableName, $fieldName, $select); |
6a488035 TO |
2611 | } |
2612 | else { | |
81a22d3d | 2613 | |
2614 | $selectClause = $this->getSelectClauseWithGroupConcatIfNotGroupedBy($tableName, $fieldName, $field); | |
2615 | if ($selectClause) { | |
2616 | $select[] = $selectClause; | |
2617 | } | |
2618 | else { | |
2619 | $select = $this->addBasicFieldToSelect($tableName, $fieldName, $field, $select); | |
2620 | } | |
6a488035 TO |
2621 | } |
2622 | } | |
2623 | } | |
2624 | } | |
2625 | ||
2626 | // select for group bys | |
2627 | if (array_key_exists('group_bys', $table)) { | |
2628 | foreach ($table['group_bys'] as $fieldName => $field) { | |
2629 | ||
2630 | if ($tableName == 'civicrm_address') { | |
2631 | $this->_addressField = TRUE; | |
2632 | } | |
2633 | if ($tableName == 'civicrm_email') { | |
2634 | $this->_emailField = TRUE; | |
2635 | } | |
2636 | if ($tableName == 'civicrm_phone') { | |
2637 | $this->_phoneField = TRUE; | |
2638 | } | |
2639 | // 1. In many cases we want select clause to be built in slightly different way | |
317a8023 | 2640 | // for a particular field of a particular type. |
6a488035 | 2641 | // 2. This method when used should receive params by reference and modify $this->_columnHeaders |
317a8023 | 2642 | // as needed. |
6a488035 TO |
2643 | $selectClause = $this->selectClause($tableName, 'group_bys', $fieldName, $field); |
2644 | if ($selectClause) { | |
2645 | $select[] = $selectClause; | |
2646 | continue; | |
2647 | } | |
2648 | ||
9d72cede EM |
2649 | if (!empty($this->_params['group_bys']) && |
2650 | !empty($this->_params['group_bys'][$fieldName]) && | |
2651 | !empty($this->_params['group_bys_freq']) | |
2652 | ) { | |
6a488035 TO |
2653 | switch (CRM_Utils_Array::value($fieldName, $this->_params['group_bys_freq'])) { |
2654 | case 'YEARWEEK': | |
9d72cede EM |
2655 | $select[] = "DATE_SUB({$field['dbAlias']}, INTERVAL WEEKDAY({$field['dbAlias']}) DAY) AS {$tableName}_{$fieldName}_start"; |
2656 | $select[] = "YEARWEEK({$field['dbAlias']}) AS {$tableName}_{$fieldName}_subtotal"; | |
2657 | $select[] = "WEEKOFYEAR({$field['dbAlias']}) AS {$tableName}_{$fieldName}_interval"; | |
6a488035 TO |
2658 | $field['title'] = 'Week'; |
2659 | break; | |
2660 | ||
2661 | case 'YEAR': | |
9d72cede EM |
2662 | $select[] = "MAKEDATE(YEAR({$field['dbAlias']}), 1) AS {$tableName}_{$fieldName}_start"; |
2663 | $select[] = "YEAR({$field['dbAlias']}) AS {$tableName}_{$fieldName}_subtotal"; | |
2664 | $select[] = "YEAR({$field['dbAlias']}) AS {$tableName}_{$fieldName}_interval"; | |
6a488035 TO |
2665 | $field['title'] = 'Year'; |
2666 | break; | |
2667 | ||
2668 | case 'MONTH': | |
9d72cede EM |
2669 | $select[] = "DATE_SUB({$field['dbAlias']}, INTERVAL (DAYOFMONTH({$field['dbAlias']})-1) DAY) as {$tableName}_{$fieldName}_start"; |
2670 | $select[] = "MONTH({$field['dbAlias']}) AS {$tableName}_{$fieldName}_subtotal"; | |
2671 | $select[] = "MONTHNAME({$field['dbAlias']}) AS {$tableName}_{$fieldName}_interval"; | |
6a488035 TO |
2672 | $field['title'] = 'Month'; |
2673 | break; | |
2674 | ||
2675 | case 'QUARTER': | |
9d72cede EM |
2676 | $select[] = "STR_TO_DATE(CONCAT( 3 * QUARTER( {$field['dbAlias']} ) -2 , '/', '1', '/', YEAR( {$field['dbAlias']} ) ), '%m/%d/%Y') AS {$tableName}_{$fieldName}_start"; |
2677 | $select[] = "QUARTER({$field['dbAlias']}) AS {$tableName}_{$fieldName}_subtotal"; | |
2678 | $select[] = "QUARTER({$field['dbAlias']}) AS {$tableName}_{$fieldName}_interval"; | |
6a488035 TO |
2679 | $field['title'] = 'Quarter'; |
2680 | break; | |
2681 | } | |
2682 | // for graphs and charts - | |
a7488080 | 2683 | if (!empty($this->_params['group_bys_freq'][$fieldName])) { |
6a488035 | 2684 | $this->_interval = $field['title']; |
971d41b1 CW |
2685 | $this->_columnHeaders["{$tableName}_{$fieldName}_start"]['title'] |
2686 | = $field['title'] . ' Beginning'; | |
6a488035 TO |
2687 | $this->_columnHeaders["{$tableName}_{$fieldName}_start"]['type'] = $field['type']; |
2688 | $this->_columnHeaders["{$tableName}_{$fieldName}_start"]['group_by'] = $this->_params['group_bys_freq'][$fieldName]; | |
2689 | ||
7d7c50f9 | 2690 | // just to make sure these values are transferred to rows. |
6a488035 TO |
2691 | // since we 'll need them for calculation purpose, |
2692 | // e.g making subtotals look nicer or graphs | |
be2fb01f CW |
2693 | $this->_columnHeaders["{$tableName}_{$fieldName}_interval"] = ['no_display' => TRUE]; |
2694 | $this->_columnHeaders["{$tableName}_{$fieldName}_subtotal"] = ['no_display' => TRUE]; | |
6a488035 TO |
2695 | } |
2696 | } | |
2697 | } | |
2698 | } | |
2699 | } | |
2700 | ||
048387ef | 2701 | if (empty($select)) { |
2702 | // CRM-21412 Do not give fatal error on report when no fields selected | |
be2fb01f | 2703 | $select = [1]; |
048387ef | 2704 | } |
2705 | ||
1f220d30 | 2706 | $this->_selectClauses = $select; |
6a488035 TO |
2707 | $this->_select = "SELECT " . implode(', ', $select) . " "; |
2708 | } | |
2709 | ||
74cf4551 | 2710 | /** |
317a8023 | 2711 | * Build select clause for a single field. |
2712 | * | |
100fef9d | 2713 | * @param string $tableName |
317a8023 | 2714 | * @param string $tableKey |
100fef9d | 2715 | * @param string $fieldName |
317a8023 | 2716 | * @param string $field |
74cf4551 EM |
2717 | * |
2718 | * @return bool | |
2719 | */ | |
00be9182 | 2720 | public function selectClause(&$tableName, $tableKey, &$fieldName, &$field) { |
81a22d3d | 2721 | if (!empty($field['pseudofield'])) { |
2722 | $alias = "{$tableName}_{$fieldName}"; | |
2723 | $this->_columnHeaders["{$tableName}_{$fieldName}"]['title'] = CRM_Utils_Array::value('title', $field); | |
2724 | $this->_columnHeaders["{$tableName}_{$fieldName}"]['type'] = CRM_Utils_Array::value('type', $field); | |
2725 | $this->_columnHeaders["{$tableName}_{$fieldName}"]['dbAlias'] = CRM_Utils_Array::value('dbAlias', $field); | |
2726 | $this->_selectAliases[] = $alias; | |
2727 | return ' 1 as ' . $alias; | |
2728 | } | |
6a488035 TO |
2729 | return FALSE; |
2730 | } | |
2731 | ||
317a8023 | 2732 | /** |
2733 | * Build where clause. | |
2734 | */ | |
00be9182 | 2735 | public function where() { |
adfe2750 | 2736 | $this->storeWhereHavingClauseArray(); |
2737 | ||
2738 | if (empty($this->_whereClauses)) { | |
2739 | $this->_where = "WHERE ( 1 ) "; | |
2740 | $this->_having = ""; | |
2741 | } | |
2742 | else { | |
2743 | $this->_where = "WHERE " . implode(' AND ', $this->_whereClauses); | |
2744 | } | |
2745 | ||
2746 | if ($this->_aclWhere) { | |
2747 | $this->_where .= " AND {$this->_aclWhere} "; | |
2748 | } | |
2749 | ||
2750 | if (!empty($this->_havingClauses)) { | |
2751 | // use this clause to construct group by clause. | |
2752 | $this->_having = "HAVING " . implode(' AND ', $this->_havingClauses); | |
2753 | } | |
2754 | } | |
2755 | ||
2756 | /** | |
317a8023 | 2757 | * Store Where clauses into an array. |
2758 | * | |
2759 | * Breaking out this step makes over-riding more flexible as the clauses can be used in constructing a | |
adfe2750 | 2760 | * temp table that may not be part of the final where clause or added |
2761 | * in other functions | |
2762 | */ | |
00be9182 | 2763 | public function storeWhereHavingClauseArray() { |
6a488035 TO |
2764 | foreach ($this->_columns as $tableName => $table) { |
2765 | if (array_key_exists('filters', $table)) { | |
2766 | foreach ($table['filters'] as $fieldName => $field) { | |
d12de91c | 2767 | // respect pseudofield to filter spec so fields can be marked as |
2768 | // not to be handled here | |
9d72cede | 2769 | if (!empty($field['pseudofield'])) { |
d12de91c | 2770 | continue; |
2771 | } | |
62491db8 | 2772 | $clause = $this->generateFilterClause($field, $fieldName); |
6a488035 TO |
2773 | |
2774 | if (!empty($clause)) { | |
a7488080 | 2775 | if (!empty($field['having'])) { |
adfe2750 | 2776 | $this->_havingClauses[] = $clause; |
6a488035 TO |
2777 | } |
2778 | else { | |
adfe2750 | 2779 | $this->_whereClauses[] = $clause; |
6a488035 TO |
2780 | } |
2781 | } | |
2782 | } | |
2783 | } | |
2784 | } | |
2785 | ||
6a488035 | 2786 | } |
9d72cede | 2787 | |
317a8023 | 2788 | /** |
2789 | * Set output mode. | |
2790 | */ | |
00be9182 | 2791 | public function processReportMode() { |
182f5081 | 2792 | $this->setOutputMode(); |
6a488035 | 2793 | |
971d41b1 CW |
2794 | $this->_sendmail |
2795 | = CRM_Utils_Request::retrieve( | |
884605ca DL |
2796 | 'sendmail', |
2797 | 'Boolean', | |
2798 | CRM_Core_DAO::$_nullObject | |
2799 | ); | |
6a488035 TO |
2800 | |
2801 | $this->_absoluteUrl = FALSE; | |
2802 | $printOnly = FALSE; | |
2803 | $this->assign('printOnly', FALSE); | |
2804 | ||
182f5081 | 2805 | if ($this->_outputMode == 'print' || |
2806 | ($this->_sendmail && !$this->_outputMode) | |
9d72cede | 2807 | ) { |
6a488035 TO |
2808 | $this->assign('printOnly', TRUE); |
2809 | $printOnly = TRUE; | |
182f5081 | 2810 | $this->addPaging = FALSE; |
6a488035 TO |
2811 | $this->assign('outputMode', 'print'); |
2812 | $this->_outputMode = 'print'; | |
2813 | if ($this->_sendmail) { | |
2814 | $this->_absoluteUrl = TRUE; | |
9d72cede | 2815 | } |
6a488035 | 2816 | } |
182f5081 | 2817 | elseif ($this->_outputMode == 'pdf') { |
6a488035 | 2818 | $printOnly = TRUE; |
182f5081 | 2819 | $this->addPaging = FALSE; |
6a488035 TO |
2820 | $this->_absoluteUrl = TRUE; |
2821 | } | |
182f5081 | 2822 | elseif ($this->_outputMode == 'csv') { |
6a488035 | 2823 | $printOnly = TRUE; |
6a488035 | 2824 | $this->_absoluteUrl = TRUE; |
182f5081 | 2825 | $this->addPaging = FALSE; |
6a488035 | 2826 | } |
182f5081 | 2827 | elseif ($this->_outputMode == 'group') { |
6a488035 | 2828 | $this->assign('outputMode', 'group'); |
6a488035 | 2829 | } |
182f5081 | 2830 | elseif ($this->_outputMode == 'create_report' && $this->_criteriaForm) { |
6a488035 | 2831 | $this->assign('outputMode', 'create_report'); |
6a488035 | 2832 | } |
182f5081 | 2833 | elseif ($this->_outputMode == 'copy' && $this->_criteriaForm) { |
2834 | $this->_createNew = TRUE; | |
6a488035 TO |
2835 | } |
2836 | ||
182f5081 | 2837 | $this->assign('outputMode', $this->_outputMode); |
2838 | $this->assign('printOnly', $printOnly); | |
6a488035 TO |
2839 | // Get today's date to include in printed reports |
2840 | if ($printOnly) { | |
2841 | $reportDate = CRM_Utils_Date::customFormat(date('Y-m-d H:i')); | |
2842 | $this->assign('reportDate', $reportDate); | |
2843 | } | |
2844 | } | |
2845 | ||
9657ccf2 | 2846 | /** |
317a8023 | 2847 | * Post Processing function for Form. |
2848 | * | |
2849 | * postProcessCommon should be used to set other variables from input as the api accesses that function. | |
182f5081 | 2850 | * This function is not accessed when the api calls the report. |
9657ccf2 | 2851 | */ |
00be9182 | 2852 | public function beginPostProcess() { |
c58f66e0 | 2853 | $this->setParams($this->controller->exportValues($this->_name)); |
6a488035 TO |
2854 | if (empty($this->_params) && |
2855 | $this->_force | |
2856 | ) { | |
c58f66e0 | 2857 | $this->setParams($this->_formValues); |
6a488035 TO |
2858 | } |
2859 | ||
2860 | // hack to fix params when submitted from dashboard, CRM-8532 | |
2861 | // fields array is missing because form building etc is skipped | |
2862 | // in dashboard mode for report | |
c58f66e0 | 2863 | //@todo - this could be done in the dashboard no we have a setter |
a7488080 | 2864 | if (empty($this->_params['fields']) && !$this->_noFields) { |
c58f66e0 | 2865 | $this->setParams($this->_formValues); |
6a488035 TO |
2866 | } |
2867 | ||
6a488035 | 2868 | $this->processReportMode(); |
182f5081 | 2869 | |
2870 | if ($this->_outputMode == 'save' || $this->_outputMode == 'copy') { | |
2871 | $this->_createNew = ($this->_outputMode == 'copy'); | |
182f5081 | 2872 | CRM_Report_Form_Instance::postProcess($this); |
2873 | } | |
e3c612db | 2874 | if ($this->_outputMode == 'delete') { |
2875 | CRM_Report_BAO_ReportInstance::doFormDelete($this->_id, 'civicrm/report/list?reset=1', 'civicrm/report/list?reset=1'); | |
2876 | } | |
2877 | ||
a231baad | 2878 | $this->_formValues = $this->_params; |
2879 | ||
c58f66e0 E |
2880 | $this->beginPostProcessCommon(); |
2881 | } | |
2882 | ||
2883 | /** | |
317a8023 | 2884 | * BeginPostProcess function run in both report mode and non-report mode (api). |
c58f66e0 | 2885 | */ |
ccc29f8e | 2886 | public function beginPostProcessCommon() { |
2887 | } | |
6a488035 | 2888 | |
74cf4551 | 2889 | /** |
317a8023 | 2890 | * Build the report query. |
2891 | * | |
74cf4551 EM |
2892 | * @param bool $applyLimit |
2893 | * | |
2894 | * @return string | |
2895 | */ | |
00be9182 | 2896 | public function buildQuery($applyLimit = TRUE) { |
43c1fa19 | 2897 | $this->buildGroupTempTable(); |
6a488035 TO |
2898 | $this->select(); |
2899 | $this->from(); | |
2900 | $this->customDataFrom(); | |
f0384ec0 | 2901 | $this->buildPermissionClause(); |
6a488035 TO |
2902 | $this->where(); |
2903 | $this->groupBy(); | |
2904 | $this->orderBy(); | |
2905 | ||
81a22d3d | 2906 | foreach ($this->unselectedOrderByColumns() as $alias => $field) { |
2907 | $clause = $this->getSelectClauseWithGroupConcatIfNotGroupedBy($field['table_name'], $field['name'], $field); | |
2908 | if (!$clause) { | |
2909 | $clause = "{$field['dbAlias']} as {$alias}"; | |
2910 | } | |
2911 | $this->_select .= ", $clause "; | |
6a488035 TO |
2912 | } |
2913 | ||
8cc574cf | 2914 | if ($applyLimit && empty($this->_params['charts'])) { |
6a488035 TO |
2915 | $this->limit(); |
2916 | } | |
2917 | CRM_Utils_Hook::alterReportVar('sql', $this, $this); | |
2918 | ||
2919 | $sql = "{$this->_select} {$this->_from} {$this->_where} {$this->_groupBy} {$this->_having} {$this->_orderBy} {$this->_limit}"; | |
02d451ab | 2920 | $this->addToDeveloperTab($sql); |
6a488035 TO |
2921 | return $sql; |
2922 | } | |
2923 | ||
317a8023 | 2924 | /** |
2925 | * Build group by clause. | |
2926 | */ | |
00be9182 | 2927 | public function groupBy() { |
4b885f84 | 2928 | $this->storeGroupByArray(); |
6a488035 | 2929 | |
70e504f2 | 2930 | if (!empty($this->_groupByArray)) { |
e40ce31e JM |
2931 | if ($this->optimisedForOnlyFullGroupBy) { |
2932 | // We should probably deprecate this code path. What happens here is that | |
2933 | // the group by is amended to reflect the select columns. This often breaks the | |
2934 | // results. Retrofitting group strict group by onto existing report classes | |
2935 | // went badly. | |
2936 | $this->_groupBy = CRM_Contact_BAO_Query::getGroupByFromSelectColumns($this->_selectClauses, $this->_groupByArray); | |
2937 | } | |
2938 | else { | |
2939 | $this->_groupBy = ' GROUP BY ' . implode($this->_groupByArray); | |
2940 | } | |
6a488035 TO |
2941 | } |
2942 | } | |
2943 | ||
317a8023 | 2944 | /** |
2945 | * Build order by clause. | |
2946 | */ | |
00be9182 | 2947 | public function orderBy() { |
9d72cede | 2948 | $this->_orderBy = ""; |
be2fb01f | 2949 | $this->_sections = []; |
6a488035 | 2950 | $this->storeOrderByArray(); |
9d72cede | 2951 | if (!empty($this->_orderByArray) && !$this->_rollup == 'WITH ROLLUP') { |
6a488035 TO |
2952 | $this->_orderBy = "ORDER BY " . implode(', ', $this->_orderByArray); |
2953 | } | |
2954 | $this->assign('sections', $this->_sections); | |
2955 | } | |
f2947aea | 2956 | |
688d37c6 | 2957 | /** |
317a8023 | 2958 | * Extract order by fields and store as an array. |
2959 | * | |
6a488035 TO |
2960 | * In some cases other functions want to know which fields are selected for ordering by |
2961 | * Separating this into a separate function allows it to be called separately from constructing | |
2962 | * the order by clause | |
2963 | */ | |
00be9182 | 2964 | public function storeOrderByArray() { |
be2fb01f | 2965 | $orderBys = []; |
6a488035 | 2966 | |
a7488080 | 2967 | if (!empty($this->_params['order_bys']) && |
6a488035 TO |
2968 | is_array($this->_params['order_bys']) && |
2969 | !empty($this->_params['order_bys']) | |
2970 | ) { | |
2971 | ||
9907633b | 2972 | // Process order_bys in user-specified order |
6a488035 | 2973 | foreach ($this->_params['order_bys'] as $orderBy) { |
be2fb01f | 2974 | $orderByField = []; |
6a488035 TO |
2975 | foreach ($this->_columns as $tableName => $table) { |
2976 | if (array_key_exists('order_bys', $table)) { | |
2977 | // For DAO columns defined in $this->_columns | |
2978 | $fields = $table['order_bys']; | |
2979 | } | |
2980 | elseif (array_key_exists('extends', $table)) { | |
2981 | // For custom fields referenced in $this->_customGroupExtends | |
be2fb01f | 2982 | $fields = CRM_Utils_Array::value('fields', $table, []); |
6a488035 | 2983 | } |
6f993086 AH |
2984 | else { |
2985 | continue; | |
2986 | } | |
6a488035 TO |
2987 | if (!empty($fields) && is_array($fields)) { |
2988 | foreach ($fields as $fieldName => $field) { | |
2989 | if ($fieldName == $orderBy['column']) { | |
f2947aea | 2990 | $orderByField = array_merge($field, $orderBy); |
6a488035 TO |
2991 | $orderByField['tplField'] = "{$tableName}_{$fieldName}"; |
2992 | break 2; | |
2993 | } | |
2994 | } | |
2995 | } | |
2996 | } | |
2997 | ||
2998 | if (!empty($orderByField)) { | |
55f71fa7 | 2999 | $this->_orderByFields[$orderByField['tplField']] = $orderByField; |
81a22d3d | 3000 | if ($this->groupConcatTested) { |
3001 | $orderBys[$orderByField['tplField']] = "{$orderByField['tplField']} {$orderBy['order']}"; | |
3002 | } | |
3003 | else { | |
3004 | // Not sure when this is preferable to using tplField (which has | |
3005 | // definitely been tested to work in cases then this does not. | |
3006 | // in caution not switching unless report has been tested for | |
3007 | // group concat functionality. | |
3008 | $orderBys[$orderByField['tplField']] = "{$orderByField['dbAlias']} {$orderBy['order']}"; | |
3009 | } | |
6a488035 TO |
3010 | |
3011 | // Record any section headers for assignment to the template | |
a7488080 | 3012 | if (!empty($orderBy['section'])) { |
b5801e1d | 3013 | $orderByField['pageBreak'] = CRM_Utils_Array::value('pageBreak', $orderBy); |
6a488035 TO |
3014 | $this->_sections[$orderByField['tplField']] = $orderByField; |
3015 | } | |
3016 | } | |
3017 | } | |
3018 | } | |
3019 | ||
3020 | $this->_orderByArray = $orderBys; | |
3021 | ||
3022 | $this->assign('sections', $this->_sections); | |
3023 | } | |
3024 | ||
81a22d3d | 3025 | /** |
3026 | * Determine unselected columns. | |
3027 | * | |
3028 | * @return array | |
3029 | */ | |
3030 | public function unselectedOrderByColumns() { | |
3031 | return array_diff_key($this->_orderByFields, $this->getSelectColumns()); | |
3032 | } | |
3033 | ||
74cf4551 | 3034 | /** |
317a8023 | 3035 | * Determine unselected columns. |
3036 | * | |
74cf4551 EM |
3037 | * @return array |
3038 | */ | |
00be9182 | 3039 | public function unselectedSectionColumns() { |
6a488035 | 3040 | if (is_array($this->_sections)) { |
55f71fa7 | 3041 | return array_diff_key($this->_sections, $this->getSelectColumns()); |
6a488035 TO |
3042 | } |
3043 | else { | |
be2fb01f | 3044 | return []; |
6a488035 TO |
3045 | } |
3046 | } | |
3047 | ||
74cf4551 | 3048 | /** |
317a8023 | 3049 | * Build output rows. |
3050 | * | |
3051 | * @param string $sql | |
3052 | * @param array $rows | |
74cf4551 | 3053 | */ |
00be9182 | 3054 | public function buildRows($sql, &$rows) { |
66ddb273 SL |
3055 | if (!$this->optimisedForOnlyFullGroupBy) { |
3056 | CRM_Core_DAO::disableFullGroupByMode(); | |
3057 | } | |
6a488035 | 3058 | $dao = CRM_Core_DAO::executeQuery($sql); |
b040d4b6 | 3059 | if (stristr($this->_select, 'SQL_CALC_FOUND_ROWS')) { |
3060 | $this->_rowsFound = CRM_Core_DAO::singleValueQuery('SELECT FOUND_ROWS()'); | |
3061 | } | |
2f68ef20 | 3062 | CRM_Core_DAO::reenableFullGroupByMode(); |
6a488035 | 3063 | if (!is_array($rows)) { |
be2fb01f | 3064 | $rows = []; |
6a488035 TO |
3065 | } |
3066 | ||
3067 | // use this method to modify $this->_columnHeaders | |
3068 | $this->modifyColumnHeaders(); | |
3069 | ||
3070 | $unselectedSectionColumns = $this->unselectedSectionColumns(); | |
3071 | ||
3072 | while ($dao->fetch()) { | |
be2fb01f | 3073 | $row = []; |
6a488035 TO |
3074 | foreach ($this->_columnHeaders as $key => $value) { |
3075 | if (property_exists($dao, $key)) { | |
3076 | $row[$key] = $dao->$key; | |
3077 | } | |
3078 | } | |
3079 | ||
3080 | // section headers not selected for display need to be added to row | |
3081 | foreach ($unselectedSectionColumns as $key => $values) { | |
3082 | if (property_exists($dao, $key)) { | |
3083 | $row[$key] = $dao->$key; | |
3084 | } | |
3085 | } | |
3086 | ||
3087 | $rows[] = $row; | |
3088 | } | |
3089 | } | |
3090 | ||
3091 | /** | |
317a8023 | 3092 | * Calculate section totals. |
3093 | * | |
6a488035 TO |
3094 | * When "order by" fields are marked as sections, this assigns to the template |
3095 | * an array of total counts for each section. This data is used by the Smarty | |
317a8023 | 3096 | * plugin {sectionTotal}. |
6a488035 | 3097 | */ |
00be9182 | 3098 | public function sectionTotals() { |
6a488035 TO |
3099 | |
3100 | // Reports using order_bys with sections must populate $this->_selectAliases in select() method. | |
3101 | if (empty($this->_selectAliases)) { | |
3102 | return; | |
3103 | } | |
3104 | ||
3105 | if (!empty($this->_sections)) { | |
3106 | // build the query with no LIMIT clause | |
3107 | $select = str_ireplace('SELECT SQL_CALC_FOUND_ROWS ', 'SELECT ', $this->_select); | |
3108 | $sql = "{$select} {$this->_from} {$this->_where} {$this->_groupBy} {$this->_having} {$this->_orderBy}"; | |
3109 | ||
3110 | // pull section aliases out of $this->_sections | |
3111 | $sectionAliases = array_keys($this->_sections); | |
3112 | ||
be2fb01f | 3113 | $ifnulls = []; |
6a488035 TO |
3114 | foreach (array_merge($sectionAliases, $this->_selectAliases) as $alias) { |
3115 | $ifnulls[] = "ifnull($alias, '') as $alias"; | |
3116 | } | |
b708c08d | 3117 | $this->_select = "SELECT " . implode(", ", $ifnulls); |
36d2f4d5 | 3118 | $this->_select = CRM_Contact_BAO_Query::appendAnyValueToSelect($ifnulls, $sectionAliases); |
6a488035 | 3119 | |
971d41b1 CW |
3120 | // Group (un-limited) report by all aliases and get counts. This might |
3121 | // be done more efficiently when the contents of $sql are known, ie. by | |
3122 | // overriding this method in the report class. | |
6a488035 | 3123 | |
b708c08d | 3124 | $query = $this->_select . |
9d72cede EM |
3125 | ", count(*) as ct from ($sql) as subquery group by " . |
3126 | implode(", ", $sectionAliases); | |
6a488035 TO |
3127 | |
3128 | // initialize array of total counts | |
be2fb01f | 3129 | $totals = []; |
6a488035 TO |
3130 | $dao = CRM_Core_DAO::executeQuery($query); |
3131 | while ($dao->fetch()) { | |
3132 | ||
3133 | // let $this->_alterDisplay translate any integer ids to human-readable values. | |
3134 | $rows[0] = $dao->toArray(); | |
3135 | $this->alterDisplay($rows); | |
3136 | $row = $rows[0]; | |
3137 | ||
3138 | // add totals for all permutations of section values | |
be2fb01f | 3139 | $values = []; |
9d72cede | 3140 | $i = 1; |
6a488035 TO |
3141 | $aliasCount = count($sectionAliases); |
3142 | foreach ($sectionAliases as $alias) { | |
3143 | $values[] = $row[$alias]; | |
3144 | $key = implode(CRM_Core_DAO::VALUE_SEPARATOR, $values); | |
3145 | if ($i == $aliasCount) { | |
3146 | // the last alias is the lowest-level section header; use count as-is | |
3147 | $totals[$key] = $dao->ct; | |
3148 | } | |
3149 | else { | |
3150 | // other aliases are higher level; roll count into their total | |
3151 | $totals[$key] += $dao->ct; | |
3152 | } | |
3153 | } | |
3154 | } | |
3155 | $this->assign('sectionTotals', $totals); | |
3156 | } | |
3157 | } | |
3158 | ||
317a8023 | 3159 | /** |
3160 | * Modify column headers. | |
3161 | */ | |
00be9182 | 3162 | public function modifyColumnHeaders() { |
6a488035 TO |
3163 | // use this method to modify $this->_columnHeaders |
3164 | } | |
3165 | ||
06983500 | 3166 | /** |
3167 | * Move totals columns to the right edge of the table. | |
3168 | * | |
3169 | * It seems like a more logical layout to have any totals columns on the far right regardless of | |
3170 | * the location of the rest of their table. | |
3171 | */ | |
3172 | public function moveSummaryColumnsToTheRightHandSide() { | |
3173 | $statHeaders = (array_intersect_key($this->_columnHeaders, array_flip($this->_statFields))); | |
3174 | $this->_columnHeaders = array_merge(array_diff_key($this->_columnHeaders, $statHeaders), $this->_columnHeaders, $statHeaders); | |
3175 | } | |
3176 | ||
74cf4551 | 3177 | /** |
317a8023 | 3178 | * Assign rows to the template. |
3179 | * | |
3180 | * @param array $rows | |
74cf4551 | 3181 | */ |
00be9182 | 3182 | public function doTemplateAssignment(&$rows) { |
6a488035 TO |
3183 | $this->assign_by_ref('columnHeaders', $this->_columnHeaders); |
3184 | $this->assign_by_ref('rows', $rows); | |
3185 | $this->assign('statistics', $this->statistics($rows)); | |
3186 | } | |
3187 | ||
74cf4551 | 3188 | /** |
317a8023 | 3189 | * Build report statistics. |
3190 | * | |
3191 | * Override this method to build your own statistics. | |
3192 | * | |
3193 | * @param array $rows | |
74cf4551 EM |
3194 | * |
3195 | * @return array | |
3196 | */ | |
00be9182 | 3197 | public function statistics(&$rows) { |
be2fb01f | 3198 | $statistics = []; |
6a488035 TO |
3199 | |
3200 | $count = count($rows); | |
8a2bee47 | 3201 | // Why do we increment the count for rollup seems to artificially inflate the count. |
c160fde8 | 3202 | // It seems perhaps intentional to include the summary row in the count of results - although |
3203 | // this just seems odd. | |
6a488035 TO |
3204 | if ($this->_rollup && ($this->_rollup != '') && $this->_grandFlag) { |
3205 | $count++; | |
3206 | } | |
3207 | ||
3208 | $this->countStat($statistics, $count); | |
3209 | ||
3210 | $this->groupByStat($statistics); | |
3211 | ||
3212 | $this->filterStat($statistics); | |
3213 | ||
3214 | return $statistics; | |
3215 | } | |
3216 | ||
74cf4551 | 3217 | /** |
317a8023 | 3218 | * Add count statistics. |
3219 | * | |
3220 | * @param array $statistics | |
3221 | * @param int $count | |
74cf4551 | 3222 | */ |
00be9182 | 3223 | public function countStat(&$statistics, $count) { |
be2fb01f | 3224 | $statistics['counts']['rowCount'] = [ |
9d72cede EM |
3225 | 'title' => ts('Row(s) Listed'), |
3226 | 'value' => $count, | |
be2fb01f | 3227 | ]; |
6a488035 TO |
3228 | |
3229 | if ($this->_rowsFound && ($this->_rowsFound > $count)) { | |
be2fb01f | 3230 | $statistics['counts']['rowsFound'] = [ |
9d72cede EM |
3231 | 'title' => ts('Total Row(s)'), |
3232 | 'value' => $this->_rowsFound, | |
be2fb01f | 3233 | ]; |
6a488035 TO |
3234 | } |
3235 | } | |
3236 | ||
74cf4551 | 3237 | /** |
317a8023 | 3238 | * Add group by statistics. |
3239 | * | |
3240 | * @param array $statistics | |
74cf4551 | 3241 | */ |
00be9182 | 3242 | public function groupByStat(&$statistics) { |
a7488080 | 3243 | if (!empty($this->_params['group_bys']) && |
6a488035 TO |
3244 | is_array($this->_params['group_bys']) && |
3245 | !empty($this->_params['group_bys']) | |
3246 | ) { | |
3247 | foreach ($this->_columns as $tableName => $table) { | |
3248 | if (array_key_exists('group_bys', $table)) { | |
3249 | foreach ($table['group_bys'] as $fieldName => $field) { | |
a7488080 | 3250 | if (!empty($this->_params['group_bys'][$fieldName])) { |
6a488035 TO |
3251 | $combinations[] = $field['title']; |
3252 | } | |
3253 | } | |
3254 | } | |
3255 | } | |
be2fb01f | 3256 | $statistics['groups'][] = [ |
9d72cede EM |
3257 | 'title' => ts('Grouping(s)'), |
3258 | 'value' => implode(' & ', $combinations), | |
be2fb01f | 3259 | ]; |
6a488035 TO |
3260 | } |
3261 | } | |
3262 | ||
74cf4551 | 3263 | /** |
317a8023 | 3264 | * Filter statistics. |
3265 | * | |
3266 | * @param array $statistics | |
74cf4551 | 3267 | */ |
00be9182 | 3268 | public function filterStat(&$statistics) { |
6a488035 TO |
3269 | foreach ($this->_columns as $tableName => $table) { |
3270 | if (array_key_exists('filters', $table)) { | |
3271 | foreach ($table['filters'] as $fieldName => $field) { | |
5aae2a90 | 3272 | if ((CRM_Utils_Array::value('type', $field) & CRM_Utils_Type::T_DATE || |
3273 | CRM_Utils_Array::value('type', $field) & CRM_Utils_Type::T_TIME) && | |
9d72cede EM |
3274 | CRM_Utils_Array::value('operatorType', $field) != |
3275 | CRM_Report_Form::OP_MONTH | |
3276 | ) { | |
971d41b1 CW |
3277 | list($from, $to) |
3278 | = $this->getFromTo( | |
8f1445ea DL |
3279 | CRM_Utils_Array::value("{$fieldName}_relative", $this->_params), |
3280 | CRM_Utils_Array::value("{$fieldName}_from", $this->_params), | |
3281 | CRM_Utils_Array::value("{$fieldName}_to", $this->_params), | |
3282 | CRM_Utils_Array::value("{$fieldName}_from_time", $this->_params), | |
3283 | CRM_Utils_Array::value("{$fieldName}_to_time", $this->_params) | |
3284 | ); | |
0d8afee2 | 3285 | $from_time_format = !empty($this->_params["{$fieldName}_from_time"]) ? 'h' : 'd'; |
be2fb01f | 3286 | $from = CRM_Utils_Date::customFormat($from, NULL, [$from_time_format]); |
6a488035 | 3287 | |
0d8afee2 | 3288 | $to_time_format = !empty($this->_params["{$fieldName}_to_time"]) ? 'h' : 'd'; |
be2fb01f | 3289 | $to = CRM_Utils_Date::customFormat($to, NULL, [$to_time_format]); |
6a488035 TO |
3290 | |
3291 | if ($from || $to) { | |
be2fb01f | 3292 | $statistics['filters'][] = [ |
6a488035 | 3293 | 'title' => $field['title'], |
be2fb01f CW |
3294 | 'value' => ts("Between %1 and %2", [1 => $from, 2 => $to]), |
3295 | ]; | |
6a488035 TO |
3296 | } |
3297 | elseif (in_array($rel = CRM_Utils_Array::value("{$fieldName}_relative", $this->_params), | |
9d72cede EM |
3298 | array_keys($this->getOperationPair(CRM_Report_Form::OP_DATE)) |
3299 | )) { | |
160d32e1 | 3300 | $pair = $this->getOperationPair(CRM_Report_Form::OP_DATE); |
be2fb01f | 3301 | $statistics['filters'][] = [ |
6a488035 TO |
3302 | 'title' => $field['title'], |
3303 | 'value' => $pair[$rel], | |
be2fb01f | 3304 | ]; |
6a488035 TO |
3305 | } |
3306 | } | |
3307 | else { | |
3308 | $op = CRM_Utils_Array::value("{$fieldName}_op", $this->_params); | |
3309 | $value = NULL; | |
3310 | if ($op) { | |
1b36206c | 3311 | $pair = $this->getOperationPair( |
8f1445ea DL |
3312 | CRM_Utils_Array::value('operatorType', $field), |
3313 | $fieldName | |
6a488035 TO |
3314 | ); |
3315 | $min = CRM_Utils_Array::value("{$fieldName}_min", $this->_params); | |
3316 | $max = CRM_Utils_Array::value("{$fieldName}_max", $this->_params); | |
3317 | $val = CRM_Utils_Array::value("{$fieldName}_value", $this->_params); | |
be2fb01f | 3318 | if (in_array($op, ['bw', 'nbw']) && ($min || $max)) { |
2107cde9 CW |
3319 | $value = "{$pair[$op]} $min " . ts('and') . " $max"; |
3320 | } | |
d3e86119 | 3321 | elseif ($val && CRM_Utils_Array::value('operatorType', $field) & self::OP_ENTITYREF) { |
2107cde9 | 3322 | $this->setEntityRefDefaults($field, $tableName); |
9d72cede | 3323 | $result = civicrm_api3($field['attributes']['entity'], 'getlist', |
be2fb01f CW |
3324 | ['id' => $val] + |
3325 | CRM_Utils_Array::value('api', $field['attributes'], [])); | |
3326 | $values = []; | |
2107cde9 CW |
3327 | foreach ($result['values'] as $v) { |
3328 | $values[] = $v['label']; | |
3329 | } | |
3330 | $value = "{$pair[$op]} " . implode(', ', $values); | |
6a488035 TO |
3331 | } |
3332 | elseif ($op == 'nll' || $op == 'nnll') { | |
3333 | $value = $pair[$op]; | |
3334 | } | |
3335 | elseif (is_array($val) && (!empty($val))) { | |
be2fb01f | 3336 | $options = CRM_Utils_Array::value('options', $field, []); |
6a488035 TO |
3337 | foreach ($val as $key => $valIds) { |
3338 | if (isset($options[$valIds])) { | |
3339 | $val[$key] = $options[$valIds]; | |
3340 | } | |
3341 | } | |
9d72cede EM |
3342 | $pair[$op] = (count($val) == 1) ? (($op == 'notin' || $op == |
3343 | 'mnot') ? ts('Is Not') : ts('Is')) : CRM_Utils_Array::value($op, $pair); | |
3344 | $val = implode(', ', $val); | |
3345 | $value = "{$pair[$op]} " . $val; | |
6a488035 | 3346 | } |
9d72cede EM |
3347 | elseif (!is_array($val) && (!empty($val) || $val == '0') && |
3348 | isset($field['options']) && | |
6a488035 TO |
3349 | is_array($field['options']) && !empty($field['options']) |
3350 | ) { | |
9d72cede EM |
3351 | $value = CRM_Utils_Array::value($op, $pair) . " " . |
3352 | CRM_Utils_Array::value($val, $field['options'], $val); | |
6a488035 TO |
3353 | } |
3354 | elseif ($val) { | |
3355 | $value = CRM_Utils_Array::value($op, $pair) . " " . $val; | |
3356 | } | |
3357 | } | |
da7ac680 | 3358 | if ($value && empty($field['no_display'])) { |
be2fb01f | 3359 | $statistics['filters'][] = [ |
9d72cede EM |
3360 | 'title' => CRM_Utils_Array::value('title', $field), |
3361 | 'value' => $value, | |
be2fb01f | 3362 | ]; |
6a488035 TO |
3363 | } |
3364 | } | |
3365 | } | |
3366 | } | |
3367 | } | |
3368 | } | |
3369 | ||
74cf4551 | 3370 | /** |
7d7c50f9 EM |
3371 | * End post processing. |
3372 | * | |
3373 | * @param array|null $rows | |
74cf4551 | 3374 | */ |
00be9182 | 3375 | public function endPostProcess(&$rows = NULL) { |
fae21877 | 3376 | $this->assign('report_class', get_class($this)); |
9d72cede | 3377 | if ($this->_storeResultSet) { |
ae555e90 DS |
3378 | $this->_resultSet = $rows; |
3379 | } | |
3380 | ||
6a488035 TO |
3381 | if ($this->_outputMode == 'print' || |
3382 | $this->_outputMode == 'pdf' || | |
3383 | $this->_sendmail | |
3384 | ) { | |
3385 | ||
3386 | $content = $this->compileContent(); | |
3387 | $url = CRM_Utils_System::url("civicrm/report/instance/{$this->_id}", | |
9d72cede | 3388 | "reset=1", TRUE |
6a488035 TO |
3389 | ); |
3390 | ||
3391 | if ($this->_sendmail) { | |
3392 | $config = CRM_Core_Config::singleton(); | |
be2fb01f | 3393 | $attachments = []; |
6a488035 TO |
3394 | |
3395 | if ($this->_outputMode == 'csv') { | |
971d41b1 CW |
3396 | $content |
3397 | = $this->_formValues['report_header'] . '<p>' . ts('Report URL') . | |
9d72cede EM |
3398 | ": {$url}</p>" . '<p>' . |
3399 | ts('The report is attached as a CSV file.') . '</p>' . | |
3400 | $this->_formValues['report_footer']; | |
3401 | ||
3402 | $csvFullFilename = $config->templateCompileDir . | |
3403 | CRM_Utils_File::makeFileName('CiviReport.csv'); | |
6a488035 TO |
3404 | $csvContent = CRM_Report_Utils_Report::makeCsv($this, $rows); |
3405 | file_put_contents($csvFullFilename, $csvContent); | |
be2fb01f | 3406 | $attachments[] = [ |
6a488035 TO |
3407 | 'fullPath' => $csvFullFilename, |
3408 | 'mime_type' => 'text/csv', | |
3409 | 'cleanName' => 'CiviReport.csv', | |
be2fb01f | 3410 | ]; |
6a488035 TO |
3411 | } |
3412 | if ($this->_outputMode == 'pdf') { | |
3413 | // generate PDF content | |
9d72cede EM |
3414 | $pdfFullFilename = $config->templateCompileDir . |
3415 | CRM_Utils_File::makeFileName('CiviReport.pdf'); | |
6a488035 TO |
3416 | file_put_contents($pdfFullFilename, |
3417 | CRM_Utils_PDF_Utils::html2pdf($content, "CiviReport.pdf", | |
be2fb01f | 3418 | TRUE, ['orientation' => 'landscape'] |
6a488035 TO |
3419 | ) |
3420 | ); | |
3421 | // generate Email Content | |
971d41b1 CW |
3422 | $content |
3423 | = $this->_formValues['report_header'] . '<p>' . ts('Report URL') . | |
9d72cede EM |
3424 | ": {$url}</p>" . '<p>' . |
3425 | ts('The report is attached as a PDF file.') . '</p>' . | |
3426 | $this->_formValues['report_footer']; | |
6a488035 | 3427 | |
be2fb01f | 3428 | $attachments[] = [ |
6a488035 TO |
3429 | 'fullPath' => $pdfFullFilename, |
3430 | 'mime_type' => 'application/pdf', | |
3431 | 'cleanName' => 'CiviReport.pdf', | |
be2fb01f | 3432 | ]; |
6a488035 TO |
3433 | } |
3434 | ||
3435 | if (CRM_Report_Utils_Report::mailReport($content, $this->_id, | |
9d72cede EM |
3436 | $this->_outputMode, $attachments |
3437 | ) | |
3438 | ) { | |
6a488035 TO |
3439 | CRM_Core_Session::setStatus(ts("Report mail has been sent."), ts('Sent'), 'success'); |
3440 | } | |
3441 | else { | |
3442 | CRM_Core_Session::setStatus(ts("Report mail could not be sent."), ts('Mail Error'), 'error'); | |
3443 | } | |
73b448bf | 3444 | return; |
6a488035 TO |
3445 | } |
3446 | elseif ($this->_outputMode == 'print') { | |
3447 | echo $content; | |
3448 | } | |
3449 | else { | |
3450 | if ($chartType = CRM_Utils_Array::value('charts', $this->_params)) { | |
3451 | $config = CRM_Core_Config::singleton(); | |
3452 | //get chart image name | |
3453 | $chartImg = $this->_chartId . '.png'; | |
3454 | //get image url path | |
971d41b1 CW |
3455 | $uploadUrl |
3456 | = str_replace('/persist/contribute/', '/persist/', $config->imageUploadURL) . | |
9d72cede | 3457 | 'openFlashChart/'; |
6a488035 TO |
3458 | $uploadUrl .= $chartImg; |
3459 | //get image doc path to overwrite | |
971d41b1 CW |
3460 | $uploadImg |
3461 | = str_replace('/persist/contribute/', '/persist/', $config->imageUploadDir) . | |
9d72cede | 3462 | 'openFlashChart/' . $chartImg; |
6a488035 TO |
3463 | //Load the image |
3464 | $chart = imagecreatefrompng($uploadUrl); | |
2fe3c48d | 3465 | //convert it into formatted png |
d42a224c | 3466 | CRM_Utils_System::setHttpHeader('Content-type', 'image/png'); |
6a488035 TO |
3467 | //overwrite with same image |
3468 | imagepng($chart, $uploadImg); | |
3469 | //delete the object | |
3470 | imagedestroy($chart); | |
3471 | } | |
be2fb01f | 3472 | CRM_Utils_PDF_Utils::html2pdf($content, "CiviReport.pdf", FALSE, ['orientation' => 'landscape']); |
6a488035 TO |
3473 | } |
3474 | CRM_Utils_System::civiExit(); | |
3475 | } | |
3476 | elseif ($this->_outputMode == 'csv') { | |
3477 | CRM_Report_Utils_Report::export2csv($this, $rows); | |
3478 | } | |
3479 | elseif ($this->_outputMode == 'group') { | |
3480 | $group = $this->_params['groups']; | |
3481 | $this->add2group($group); | |
3482 | } | |
6a488035 | 3483 | } |
8f1445ea | 3484 | |
8a925f33 | 3485 | /** |
7d7c50f9 EM |
3486 | * Set store result set indicator to TRUE. |
3487 | * | |
8a925f33 EM |
3488 | * @todo explain what this does |
3489 | */ | |
00be9182 | 3490 | public function storeResultSet() { |
ae555e90 DS |
3491 | $this->_storeResultSet = TRUE; |
3492 | } | |
3493 | ||
74cf4551 | 3494 | /** |
7d7c50f9 EM |
3495 | * Get result set. |
3496 | * | |
74cf4551 EM |
3497 | * @return bool |
3498 | */ | |
00be9182 | 3499 | public function getResultSet() { |
ae555e90 DS |
3500 | return $this->_resultSet; |
3501 | } | |
3502 | ||
55f71fa7 | 3503 | /** |
3504 | * Get the sql used to generate the report. | |
3505 | * | |
3506 | * @return string | |
3507 | */ | |
3508 | public function getReportSql() { | |
3509 | return $this->sqlArray; | |
3510 | } | |
3511 | ||
74cf4551 | 3512 | /** |
fe482240 | 3513 | * Use the form name to create the tpl file name. |
74cf4551 EM |
3514 | * |
3515 | * @return string | |
74cf4551 | 3516 | */ |
00be9182 | 3517 | public function getTemplateFileName() { |
6a488035 | 3518 | $defaultTpl = parent::getTemplateFileName(); |
9d72cede | 3519 | $template = CRM_Core_Smarty::singleton(); |
6a488035 TO |
3520 | if (!$template->template_exists($defaultTpl)) { |
3521 | $defaultTpl = 'CRM/Report/Form.tpl'; | |
3522 | } | |
3523 | return $defaultTpl; | |
3524 | } | |
3525 | ||
688d37c6 | 3526 | /** |
fe482240 | 3527 | * Compile the report content. |
317a8023 | 3528 | * |
688d37c6 | 3529 | * Although this function is super-short it is useful to keep separate so it can be over-ridden by report classes. |
6a488035 | 3530 | * |
74cf4551 EM |
3531 | * @return string |
3532 | */ | |
00be9182 | 3533 | public function compileContent() { |
8aac22c8 | 3534 | $templateFile = $this->getHookedTemplateFileName(); |
1a7356e7 | 3535 | return CRM_Utils_Array::value('report_header', $this->_formValues) . |
9d72cede | 3536 | CRM_Core_Form::$_template->fetch($templateFile) . |
1a7356e7 | 3537 | CRM_Utils_Array::value('report_footer', $this->_formValues); |
6a488035 TO |
3538 | } |
3539 | ||
317a8023 | 3540 | /** |
3541 | * Post process function. | |
3542 | */ | |
00be9182 | 3543 | public function postProcess() { |
6a488035 TO |
3544 | // get ready with post process params |
3545 | $this->beginPostProcess(); | |
3546 | ||
3547 | // build query | |
3548 | $sql = $this->buildQuery(); | |
3549 | ||
3550 | // build array of result based on column headers. This method also allows | |
3551 | // modifying column headers before using it to build result set i.e $rows. | |
be2fb01f | 3552 | $rows = []; |
6a488035 TO |
3553 | $this->buildRows($sql, $rows); |
3554 | ||
3555 | // format result set. | |
3556 | $this->formatDisplay($rows); | |
3557 | ||
3558 | // assign variables to templates | |
3559 | $this->doTemplateAssignment($rows); | |
3560 | ||
3561 | // do print / pdf / instance stuff if needed | |
3562 | $this->endPostProcess($rows); | |
3563 | } | |
3564 | ||
74cf4551 | 3565 | /** |
317a8023 | 3566 | * Set limit. |
3567 | * | |
74cf4551 | 3568 | * @param int $rowCount |
317a8023 | 3569 | * |
688d37c6 | 3570 | * @return array |
74cf4551 | 3571 | */ |
00be9182 | 3572 | public function limit($rowCount = self::ROW_COUNT_LIMIT) { |
6a488035 TO |
3573 | // lets do the pager if in html mode |
3574 | $this->_limit = NULL; | |
77b97be7 | 3575 | |
dbb4a0f9 PN |
3576 | // CRM-14115, over-ride row count if rowCount is specified in URL |
3577 | if ($this->_dashBoardRowCount) { | |
3578 | $rowCount = $this->_dashBoardRowCount; | |
3579 | } | |
182f5081 | 3580 | if ($this->addPaging) { |
f0b5b73e | 3581 | $this->_select = preg_replace('/SELECT(\s+SQL_CALC_FOUND_ROWS)?\s+/i', 'SELECT SQL_CALC_FOUND_ROWS ', $this->_select); |
6a488035 | 3582 | |
a3d827a7 | 3583 | $pageId = CRM_Utils_Request::retrieve('crmPID', 'Integer'); |
6a488035 | 3584 | |
8a925f33 EM |
3585 | // @todo all http vars should be extracted in the preProcess |
3586 | // - not randomly in the class | |
6a488035 TO |
3587 | if (!$pageId && !empty($_POST)) { |
3588 | if (isset($_POST['PagerBottomButton']) && isset($_POST['crmPID_B'])) { | |
8a925f33 | 3589 | $pageId = max((int) $_POST['crmPID_B'], 1); |
6a488035 TO |
3590 | } |
3591 | elseif (isset($_POST['PagerTopButton']) && isset($_POST['crmPID'])) { | |
8a925f33 | 3592 | $pageId = max((int) $_POST['crmPID'], 1); |
6a488035 TO |
3593 | } |
3594 | unset($_POST['crmPID_B'], $_POST['crmPID']); | |
3595 | } | |
3596 | ||
3597 | $pageId = $pageId ? $pageId : 1; | |
3598 | $this->set(CRM_Utils_Pager::PAGE_ID, $pageId); | |
3599 | $offset = ($pageId - 1) * $rowCount; | |
3600 | ||
bf00d1b6 DL |
3601 | $offset = CRM_Utils_Type::escape($offset, 'Int'); |
3602 | $rowCount = CRM_Utils_Type::escape($rowCount, 'Int'); | |
3603 | ||
dd3a4117 | 3604 | $this->_limit = " LIMIT $offset, $rowCount"; |
be2fb01f | 3605 | return [$offset, $rowCount]; |
6a488035 | 3606 | } |
9d72cede EM |
3607 | if ($this->_limitValue) { |
3608 | if ($this->_offsetValue) { | |
6f900755 E |
3609 | $this->_limit = " LIMIT {$this->_offsetValue}, {$this->_limitValue} "; |
3610 | } | |
3611 | else { | |
3612 | $this->_limit = " LIMIT " . $this->_limitValue; | |
3613 | } | |
3614 | } | |
6a488035 TO |
3615 | } |
3616 | ||
74cf4551 | 3617 | /** |
317a8023 | 3618 | * Set pager. |
3619 | * | |
74cf4551 EM |
3620 | * @param int $rowCount |
3621 | */ | |
00be9182 | 3622 | public function setPager($rowCount = self::ROW_COUNT_LIMIT) { |
dbb4a0f9 PN |
3623 | // CRM-14115, over-ride row count if rowCount is specified in URL |
3624 | if ($this->_dashBoardRowCount) { | |
3625 | $rowCount = $this->_dashBoardRowCount; | |
3626 | } | |
3627 | ||
6a488035 | 3628 | if ($this->_limit && ($this->_limit != '')) { |
c160fde8 | 3629 | if (!$this->_rowsFound) { |
3630 | $sql = "SELECT FOUND_ROWS();"; | |
3631 | $this->_rowsFound = CRM_Core_DAO::singleValueQuery($sql); | |
3632 | } | |
be2fb01f | 3633 | $params = [ |
6a488035 TO |
3634 | 'total' => $this->_rowsFound, |
3635 | 'rowCount' => $rowCount, | |
3636 | 'status' => ts('Records') . ' %%StatusMessage%%', | |
3637 | 'buttonBottom' => 'PagerBottomButton', | |
3638 | 'buttonTop' => 'PagerTopButton', | |
be2fb01f | 3639 | ]; |
f45db615 | 3640 | if (!empty($this->controller)) { |
3641 | // This happens when being called from the api Really we want the api to be able to | |
3642 | // pass paging parameters, but at this stage just preventing test crashes. | |
3643 | $params['pageID'] = $this->get(CRM_Utils_Pager::PAGE_ID); | |
3644 | } | |
6a488035 TO |
3645 | |
3646 | $pager = new CRM_Utils_Pager($params); | |
3647 | $this->assign_by_ref('pager', $pager); | |
ecc20f0e | 3648 | $this->ajaxResponse['totalRows'] = $this->_rowsFound; |
6a488035 TO |
3649 | } |
3650 | } | |
3651 | ||
74cf4551 | 3652 | /** |
43c1fa19 | 3653 | * Build a group filter with contempt for large data sets. |
3654 | * | |
3655 | * This function has been retained as it takes time to migrate the reports over | |
3656 | * to the new method which will not crash on large datasets. | |
3657 | * | |
3658 | * @deprecated | |
317a8023 | 3659 | * |
3660 | * @param string $field | |
3661 | * @param mixed $value | |
3662 | * @param string $op | |
74cf4551 EM |
3663 | * |
3664 | * @return string | |
3665 | */ | |
43c1fa19 | 3666 | public function legacySlowGroupFilterClause($field, $value, $op) { |
6a488035 TO |
3667 | $smartGroupQuery = ""; |
3668 | ||
3669 | $group = new CRM_Contact_DAO_Group(); | |
3670 | $group->is_active = 1; | |
3671 | $group->find(); | |
be2fb01f | 3672 | $smartGroups = []; |
6a488035 | 3673 | while ($group->fetch()) { |
eae0f0d9 | 3674 | if (in_array($group->id, (array) $this->_params['gid_value']) && |
9d72cede EM |
3675 | $group->saved_search_id |
3676 | ) { | |
6a488035 TO |
3677 | $smartGroups[] = $group->id; |
3678 | } | |
3679 | } | |
3680 | ||
3681 | CRM_Contact_BAO_GroupContactCache::check($smartGroups); | |
3682 | ||
3683 | $smartGroupQuery = ''; | |
3684 | if (!empty($smartGroups)) { | |
3685 | $smartGroups = implode(',', $smartGroups); | |
3686 | $smartGroupQuery = " UNION DISTINCT | |
3687 | SELECT DISTINCT smartgroup_contact.contact_id | |
3688 | FROM civicrm_group_contact_cache smartgroup_contact | |
3689 | WHERE smartgroup_contact.group_id IN ({$smartGroups}) "; | |
3690 | } | |
3691 | ||
29fc2b79 | 3692 | $sqlOp = $this->getSQLOperator($op); |
6a488035 | 3693 | if (!is_array($value)) { |
be2fb01f | 3694 | $value = [$value]; |
6a488035 | 3695 | } |
8e4785fa | 3696 | //include child groups if any |
3697 | $value = array_merge($value, CRM_Contact_BAO_Group::getChildGroupIds($value)); | |
3698 | ||
6a488035 TO |
3699 | $clause = "{$field['dbAlias']} IN (" . implode(', ', $value) . ")"; |
3700 | ||
f3e8e853 | 3701 | $contactAlias = $this->_aliases['civicrm_contact']; |
3702 | if (!empty($this->relationType) && $this->relationType == 'b_a') { | |
3703 | $contactAlias = $this->_aliases['civicrm_contact_b']; | |
3704 | } | |
3705 | return " {$contactAlias}.id {$sqlOp} ( | |
6a488035 TO |
3706 | SELECT DISTINCT {$this->_aliases['civicrm_group']}.contact_id |
3707 | FROM civicrm_group_contact {$this->_aliases['civicrm_group']} | |
3708 | WHERE {$clause} AND {$this->_aliases['civicrm_group']}.status = 'Added' | |
3709 | {$smartGroupQuery} ) "; | |
3710 | } | |
3711 | ||
43c1fa19 | 3712 | /** |
3713 | * Build where clause for groups. | |
3714 | * | |
3715 | * @param string $field | |
3716 | * @param mixed $value | |
3717 | * @param string $op | |
3718 | * | |
3719 | * @return string | |
3720 | */ | |
3721 | public function whereGroupClause($field, $value, $op) { | |
3722 | if ($this->groupFilterNotOptimised) { | |
3723 | return $this->legacySlowGroupFilterClause($field, $value, $op); | |
3724 | } | |
3725 | if ($op === 'notin') { | |
3726 | return " group_temp_table.id IS NULL "; | |
3727 | } | |
3728 | // We will have used an inner join instead. | |
3729 | return "1"; | |
3730 | } | |
3731 | ||
43c1fa19 | 3732 | /** |
3733 | * Create a table of the contact ids included by the group filter. | |
3734 | * | |
3735 | * This function is called by both the api (tests) and the UI. | |
3736 | */ | |
3737 | public function buildGroupTempTable() { | |
a2e4e741 | 3738 | if (!empty($this->groupTempTable) || empty($this->_params['gid_value']) || $this->groupFilterNotOptimised) { |
43c1fa19 | 3739 | return; |
3740 | } | |
3741 | $filteredGroups = (array) $this->_params['gid_value']; | |
3742 | ||
be2fb01f | 3743 | $groups = civicrm_api3('Group', 'get', [ |
43c1fa19 | 3744 | 'is_active' => 1, |
be2fb01f CW |
3745 | 'id' => ['IN' => $filteredGroups], |
3746 | 'saved_search_id' => ['>' => 0], | |
43c1fa19 | 3747 | 'return' => 'id', |
be2fb01f | 3748 | ]); |
43c1fa19 | 3749 | $smartGroups = array_keys($groups['values']); |
3750 | ||
3751 | $query = " | |
b6963180 | 3752 | SELECT DISTINCT group_contact.contact_id as id |
43c1fa19 | 3753 | FROM civicrm_group_contact group_contact |
3754 | WHERE group_contact.group_id IN (" . implode(', ', $filteredGroups) . ") | |
3755 | AND group_contact.status = 'Added' "; | |
3756 | ||
3757 | if (!empty($smartGroups)) { | |
3758 | CRM_Contact_BAO_GroupContactCache::check($smartGroups); | |
3759 | $smartGroups = implode(',', $smartGroups); | |
3760 | $query .= " | |
3761 | UNION DISTINCT | |
3762 | SELECT smartgroup_contact.contact_id as id | |
3763 | FROM civicrm_group_contact_cache smartgroup_contact | |
3764 | WHERE smartgroup_contact.group_id IN ({$smartGroups}) "; | |
3765 | } | |
3766 | ||
f0197a3d | 3767 | $this->groupTempTable = $this->createTemporaryTable('rptgrp', $query); |
43c1fa19 | 3768 | CRM_Core_DAO::executeQuery("ALTER TABLE $this->groupTempTable ADD INDEX i_id(id)"); |
3769 | } | |
3770 | ||
3771 | /** | |
3772 | * Execute query and add it to the developer tab. | |
3773 | * | |
3774 | * @param string $query | |
3775 | * @param array $params | |
3776 | * | |
3777 | * @return \CRM_Core_DAO|object | |
3778 | */ | |
be2fb01f | 3779 | protected function executeReportQuery($query, $params = []) { |
43c1fa19 | 3780 | $this->addToDeveloperTab($query); |
3781 | return CRM_Core_DAO::executeQuery($query, $params); | |
3782 | } | |
3783 | ||
74cf4551 | 3784 | /** |
317a8023 | 3785 | * Build where clause for tags. |
3786 | * | |
3787 | * @param string $field | |
3788 | * @param mixed $value | |
3789 | * @param string $op | |
74cf4551 EM |
3790 | * |
3791 | * @return string | |
3792 | */ | |
00be9182 | 3793 | public function whereTagClause($field, $value, $op) { |
6a488035 TO |
3794 | // not using left join in query because if any contact |
3795 | // belongs to more than one tag, results duplicate | |
3796 | // entries. | |
29fc2b79 | 3797 | $sqlOp = $this->getSQLOperator($op); |
6a488035 | 3798 | if (!is_array($value)) { |
be2fb01f | 3799 | $value = [$value]; |
6a488035 TO |
3800 | } |
3801 | $clause = "{$field['dbAlias']} IN (" . implode(', ', $value) . ")"; | |
ed795723 JM |
3802 | $entity_table = $this->_tagFilterTable; |
3803 | return " {$this->_aliases[$entity_table]}.id {$sqlOp} ( | |
6a488035 TO |
3804 | SELECT DISTINCT {$this->_aliases['civicrm_tag']}.entity_id |
3805 | FROM civicrm_entity_tag {$this->_aliases['civicrm_tag']} | |
ed795723 | 3806 | WHERE entity_table = '$entity_table' AND {$clause} ) "; |
6a488035 TO |
3807 | } |
3808 | ||
f587aa17 EM |
3809 | /** |
3810 | * Generate membership organization clause. | |
3811 | * | |
3812 | * @param mixed $value | |
3813 | * @param string $op SQL Operator | |
3814 | * | |
3815 | * @return string | |
3816 | */ | |
3817 | public function whereMembershipOrgClause($value, $op) { | |
114a2c85 DG |
3818 | $sqlOp = $this->getSQLOperator($op); |
3819 | if (!is_array($value)) { | |
be2fb01f | 3820 | $value = [$value]; |
114a2c85 | 3821 | } |
258e2add | 3822 | |
114a2c85 DG |
3823 | $tmp_membership_org_sql_list = implode(', ', $value); |
3824 | return " {$this->_aliases['civicrm_contact']}.id {$sqlOp} ( | |
97709b72 | 3825 | SELECT DISTINCT mem.contact_id |
258e2add | 3826 | FROM civicrm_membership mem |
97709b72 | 3827 | LEFT JOIN civicrm_membership_status mem_status ON mem.status_id = mem_status.id |
258e2add | 3828 | LEFT JOIN civicrm_membership_type mt ON mem.membership_type_id = mt.id |
9d72cede EM |
3829 | WHERE mt.member_of_contact_id IN (" . |
3830 | $tmp_membership_org_sql_list . ") | |
97709b72 DG |
3831 | AND mt.is_active = '1' |
3832 | AND mem_status.is_current_member = '1' | |
3833 | AND mem_status.is_active = '1' ) "; | |
9d72cede | 3834 | } |
114a2c85 | 3835 | |
f587aa17 | 3836 | /** |
fe482240 | 3837 | * Generate Membership Type SQL Clause. |
317a8023 | 3838 | * |
f587aa17 EM |
3839 | * @param mixed $value |
3840 | * @param string $op | |
3841 | * | |
3842 | * @return string | |
3843 | * SQL query string | |
3844 | */ | |
3845 | public function whereMembershipTypeClause($value, $op) { | |
114a2c85 DG |
3846 | $sqlOp = $this->getSQLOperator($op); |
3847 | if (!is_array($value)) { | |
be2fb01f | 3848 | $value = [$value]; |
114a2c85 | 3849 | } |
258e2add | 3850 | |
9d72cede | 3851 | $tmp_membership_sql_list = implode(', ', $value); |
114a2c85 | 3852 | return " {$this->_aliases['civicrm_contact']}.id {$sqlOp} ( |
97709b72 | 3853 | SELECT DISTINCT mem.contact_id |
258e2add | 3854 | FROM civicrm_membership mem |
3855 | LEFT JOIN civicrm_membership_status mem_status ON mem.status_id = mem_status.id | |
3856 | LEFT JOIN civicrm_membership_type mt ON mem.membership_type_id = mt.id | |
9d72cede EM |
3857 | WHERE mem.membership_type_id IN (" . |
3858 | $tmp_membership_sql_list . ") | |
97709b72 DG |
3859 | AND mt.is_active = '1' |
3860 | AND mem_status.is_current_member = '1' | |
3861 | AND mem_status.is_active = '1' ) "; | |
114a2c85 | 3862 | } |
258e2add | 3863 | |
74cf4551 | 3864 | /** |
f0384ec0 CW |
3865 | * Buld contact acl clause |
3866 | * @deprecated in favor of buildPermissionClause | |
317a8023 | 3867 | * |
74cf4551 EM |
3868 | * @param string $tableAlias |
3869 | */ | |
00be9182 | 3870 | public function buildACLClause($tableAlias = 'contact_a') { |
6a488035 TO |
3871 | list($this->_aclFrom, $this->_aclWhere) = CRM_Contact_BAO_Contact_Permission::cacheClause($tableAlias); |
3872 | } | |
3873 | ||
f0384ec0 CW |
3874 | /** |
3875 | * Build the permision clause for all entities in this report | |
3876 | */ | |
3877 | public function buildPermissionClause() { | |
be2fb01f | 3878 | $ret = []; |
f0384ec0 CW |
3879 | foreach ($this->selectedTables() as $tableName) { |
3880 | $baoName = str_replace('_DAO_', '_BAO_', CRM_Core_DAO_AllCoreTables::getClassForTable($tableName)); | |
3881 | if ($baoName && class_exists($baoName) && !empty($this->_columns[$tableName]['alias'])) { | |
3882 | $tableAlias = $this->_columns[$tableName]['alias']; | |
3883 | $clauses = array_filter($baoName::getSelectWhereClause($tableAlias)); | |
3884 | foreach ($clauses as $field => $clause) { | |
3885 | // Skip contact_id field if redundant | |
3886 | if ($field != 'contact_id' || !in_array('civicrm_contact', $this->selectedTables())) { | |
3887 | $ret["$tableName.$field"] = $clause; | |
3888 | } | |
3889 | } | |
3890 | } | |
3891 | } | |
3892 | // Override output from buildACLClause | |
3893 | $this->_aclFrom = NULL; | |
3894 | $this->_aclWhere = implode(' AND ', $ret); | |
3895 | } | |
3896 | ||
74cf4551 | 3897 | /** |
317a8023 | 3898 | * Add custom data to the columns. |
3899 | * | |
74cf4551 EM |
3900 | * @param bool $addFields |
3901 | * @param array $permCustomGroupIds | |
3902 | */ | |
be2fb01f | 3903 | public function addCustomDataToColumns($addFields = TRUE, $permCustomGroupIds = []) { |
6a488035 TO |
3904 | if (empty($this->_customGroupExtends)) { |
3905 | return; | |
3906 | } | |
3907 | if (!is_array($this->_customGroupExtends)) { | |
be2fb01f | 3908 | $this->_customGroupExtends = [$this->_customGroupExtends]; |
6a488035 TO |
3909 | } |
3910 | $customGroupWhere = ''; | |
3911 | if (!empty($permCustomGroupIds)) { | |
9d72cede EM |
3912 | $customGroupWhere = "cg.id IN (" . implode(',', $permCustomGroupIds) . |
3913 | ") AND"; | |
6a488035 TO |
3914 | } |
3915 | $sql = " | |
3916 | SELECT cg.table_name, cg.title, cg.extends, cf.id as cf_id, cf.label, | |
3917 | cf.column_name, cf.data_type, cf.html_type, cf.option_group_id, cf.time_format | |
3918 | FROM civicrm_custom_group cg | |
3919 | INNER JOIN civicrm_custom_field cf ON cg.id = cf.custom_group_id | |
3920 | WHERE cg.extends IN ('" . implode("','", $this->_customGroupExtends) . "') AND | |
3921 | {$customGroupWhere} | |
3922 | cg.is_active = 1 AND | |
3923 | cf.is_active = 1 AND | |
3924 | cf.is_searchable = 1 | |
3925 | ORDER BY cg.weight, cf.weight"; | |
3926 | $customDAO = CRM_Core_DAO::executeQuery($sql); | |
3927 | ||
3928 | $curTable = NULL; | |
3929 | while ($customDAO->fetch()) { | |
3930 | if ($customDAO->table_name != $curTable) { | |
3931 | $curTable = $customDAO->table_name; | |
be2fb01f | 3932 | $curFields = $curFilters = []; |
6a488035 TO |
3933 | |
3934 | // dummy dao object | |
3935 | $this->_columns[$curTable]['dao'] = 'CRM_Contact_DAO_Contact'; | |
3936 | $this->_columns[$curTable]['extends'] = $customDAO->extends; | |
3937 | $this->_columns[$curTable]['grouping'] = $customDAO->table_name; | |
3938 | $this->_columns[$curTable]['group_title'] = $customDAO->title; | |
3939 | ||
be2fb01f | 3940 | foreach (['fields', 'filters', 'group_bys'] as $colKey) { |
6a488035 | 3941 | if (!array_key_exists($colKey, $this->_columns[$curTable])) { |
be2fb01f | 3942 | $this->_columns[$curTable][$colKey] = []; |
6a488035 TO |
3943 | } |
3944 | } | |
3945 | } | |
3946 | $fieldName = 'custom_' . $customDAO->cf_id; | |
3947 | ||
3948 | if ($addFields) { | |
3949 | // this makes aliasing work in favor | |
be2fb01f | 3950 | $curFields[$fieldName] = [ |
6a488035 TO |
3951 | 'name' => $customDAO->column_name, |
3952 | 'title' => $customDAO->label, | |
3953 | 'dataType' => $customDAO->data_type, | |
3954 | 'htmlType' => $customDAO->html_type, | |
be2fb01f | 3955 | ]; |
6a488035 TO |
3956 | } |
3957 | if ($this->_customGroupFilters) { | |
3958 | // this makes aliasing work in favor | |
be2fb01f | 3959 | $curFilters[$fieldName] = [ |
6a488035 TO |
3960 | 'name' => $customDAO->column_name, |
3961 | 'title' => $customDAO->label, | |
3962 | 'dataType' => $customDAO->data_type, | |
3963 | 'htmlType' => $customDAO->html_type, | |
be2fb01f | 3964 | ]; |
6a488035 TO |
3965 | } |
3966 | ||
3967 | switch ($customDAO->data_type) { | |
3968 | case 'Date': | |
3969 | // filters | |
3970 | $curFilters[$fieldName]['operatorType'] = CRM_Report_Form::OP_DATE; | |
3971 | $curFilters[$fieldName]['type'] = CRM_Utils_Type::T_DATE; | |
3972 | // CRM-6946, show time part for datetime date fields | |
3973 | if ($customDAO->time_format) { | |
3974 | $curFields[$fieldName]['type'] = CRM_Utils_Type::T_TIMESTAMP; | |
3975 | } | |
3976 | break; | |
3977 | ||
3978 | case 'Boolean': | |
3979 | $curFilters[$fieldName]['operatorType'] = CRM_Report_Form::OP_SELECT; | |
be2fb01f | 3980 | $curFilters[$fieldName]['options'] = ['' => ts('- select -')] + CRM_Core_PseudoConstant::get('CRM_Core_BAO_CustomField', 'custom_' . $customDAO->cf_id, [], 'search'); |
6a488035 TO |
3981 | $curFilters[$fieldName]['type'] = CRM_Utils_Type::T_INT; |
3982 | break; | |
3983 | ||
3984 | case 'Int': | |
3985 | $curFilters[$fieldName]['operatorType'] = CRM_Report_Form::OP_INT; | |
3986 | $curFilters[$fieldName]['type'] = CRM_Utils_Type::T_INT; | |
3987 | break; | |
3988 | ||
3989 | case 'Money': | |
3990 | $curFilters[$fieldName]['operatorType'] = CRM_Report_Form::OP_FLOAT; | |
3991 | $curFilters[$fieldName]['type'] = CRM_Utils_Type::T_MONEY; | |
c160fde8 | 3992 | $curFields[$fieldName]['type'] = CRM_Utils_Type::T_MONEY; |
6a488035 TO |
3993 | break; |
3994 | ||
3995 | case 'Float': | |
3996 | $curFilters[$fieldName]['operatorType'] = CRM_Report_Form::OP_FLOAT; | |
3997 | $curFilters[$fieldName]['type'] = CRM_Utils_Type::T_FLOAT; | |
3998 | break; | |
3999 | ||
4000 | case 'String': | |
6a488035 | 4001 | case 'StateProvince': |
6a488035 | 4002 | case 'Country': |
106e51b4 CW |
4003 | $curFilters[$fieldName]['type'] = CRM_Utils_Type::T_STRING; |
4004 | ||
be2fb01f | 4005 | $options = CRM_Core_PseudoConstant::get('CRM_Core_BAO_CustomField', 'custom_' . $customDAO->cf_id, [], 'search'); |
03b5a4aa | 4006 | if ((is_array($options) && count($options) != 0) || (!is_array($options) && $options !== FALSE)) { |
106e51b4 CW |
4007 | $curFilters[$fieldName]['operatorType'] = CRM_Core_BAO_CustomField::isSerialized($customDAO) ? CRM_Report_Form::OP_MULTISELECT_SEPARATOR : CRM_Report_Form::OP_MULTISELECT; |
4008 | $curFilters[$fieldName]['options'] = $options; | |
6a488035 | 4009 | } |
6a488035 TO |
4010 | break; |
4011 | ||
4012 | case 'ContactReference': | |
4013 | $curFilters[$fieldName]['type'] = CRM_Utils_Type::T_STRING; | |
4014 | $curFilters[$fieldName]['name'] = 'display_name'; | |
4015 | $curFilters[$fieldName]['alias'] = "contact_{$fieldName}_civireport"; | |
4016 | ||
4017 | $curFields[$fieldName]['type'] = CRM_Utils_Type::T_STRING; | |
4018 | $curFields[$fieldName]['name'] = 'display_name'; | |
4019 | $curFields[$fieldName]['alias'] = "contact_{$fieldName}_civireport"; | |
4020 | break; | |
4021 | ||
4022 | default: | |
4023 | $curFields[$fieldName]['type'] = CRM_Utils_Type::T_STRING; | |
4024 | $curFilters[$fieldName]['type'] = CRM_Utils_Type::T_STRING; | |
4025 | } | |
4026 | ||
d79e67a6 | 4027 | // CRM-19401 fix |
4028 | if ($customDAO->html_type == 'Select' && !array_key_exists('options', $curFilters[$fieldName])) { | |
be2fb01f | 4029 | $options = CRM_Core_PseudoConstant::get('CRM_Core_BAO_CustomField', 'custom_' . $customDAO->cf_id, [], 'search'); |
d79e67a6 | 4030 | if ($options !== FALSE) { |
4031 | $curFilters[$fieldName]['operatorType'] = CRM_Core_BAO_CustomField::isSerialized($customDAO) ? CRM_Report_Form::OP_MULTISELECT_SEPARATOR : CRM_Report_Form::OP_MULTISELECT; | |
4032 | $curFilters[$fieldName]['options'] = $options; | |
4033 | } | |
4034 | } | |
4035 | ||
6a488035 | 4036 | if (!array_key_exists('type', $curFields[$fieldName])) { |
be2fb01f | 4037 | $curFields[$fieldName]['type'] = CRM_Utils_Array::value('type', $curFilters[$fieldName], []); |
6a488035 TO |
4038 | } |
4039 | ||
4040 | if ($addFields) { | |
4041 | $this->_columns[$curTable]['fields'] = array_merge($this->_columns[$curTable]['fields'], $curFields); | |
4042 | } | |
4043 | if ($this->_customGroupFilters) { | |
4044 | $this->_columns[$curTable]['filters'] = array_merge($this->_columns[$curTable]['filters'], $curFilters); | |
4045 | } | |
4046 | if ($this->_customGroupGroupBy) { | |
4047 | $this->_columns[$curTable]['group_bys'] = array_merge($this->_columns[$curTable]['group_bys'], $curFields); | |
4048 | } | |
4049 | } | |
4050 | } | |
4051 | ||
317a8023 | 4052 | /** |
4053 | * Build custom data from clause. | |
568a0946 | 4054 | * |
4055 | * @param bool $joinsForFiltersOnly | |
4056 | * Only include joins to support filters. This would be used if creating a table of contacts to include first. | |
317a8023 | 4057 | */ |
568a0946 | 4058 | public function customDataFrom($joinsForFiltersOnly = FALSE) { |
6a488035 TO |
4059 | if (empty($this->_customGroupExtends)) { |
4060 | return; | |
4061 | } | |
4062 | $mapper = CRM_Core_BAO_CustomQuery::$extendsMap; | |
fae6de7c JL |
4063 | //CRM-18276 GROUP_CONCAT could be used with singleValueQuery and then exploded, |
4064 | //but by default that truncates to 1024 characters, which causes errors with installs with lots of custom field sets | |
be2fb01f | 4065 | $customTables = []; |
33621c4f | 4066 | $customTablesDAO = CRM_Core_DAO::executeQuery("SELECT table_name FROM civicrm_custom_group"); |
fae6de7c JL |
4067 | while ($customTablesDAO->fetch()) { |
4068 | $customTables[] = $customTablesDAO->table_name; | |
4069 | } | |
6a488035 TO |
4070 | |
4071 | foreach ($this->_columns as $table => $prop) { | |
55f71fa7 | 4072 | if (in_array($table, $customTables)) { |
6a488035 | 4073 | $extendsTable = $mapper[$prop['extends']]; |
568a0946 | 4074 | // Check field is required for rendering the report. |
4075 | if ((!$this->isFieldSelected($prop)) || ($joinsForFiltersOnly && !$this->isFieldFiltered($prop))) { | |
6a488035 TO |
4076 | continue; |
4077 | } | |
4c9d78ea | 4078 | $baseJoin = CRM_Utils_Array::value($prop['extends'], $this->_customGroupExtendsJoin, "{$this->_aliases[$extendsTable]}.id"); |
6a488035 | 4079 | |
9d72cede | 4080 | $customJoin = is_array($this->_customGroupJoin) ? $this->_customGroupJoin[$table] : $this->_customGroupJoin; |
6a488035 | 4081 | $this->_from .= " |
aa1aa08e | 4082 | {$customJoin} {$table} {$this->_aliases[$table]} ON {$this->_aliases[$table]}.entity_id = {$baseJoin}"; |
6a488035 TO |
4083 | // handle for ContactReference |
4084 | if (array_key_exists('fields', $prop)) { | |
4085 | foreach ($prop['fields'] as $fieldName => $field) { | |
9d72cede EM |
4086 | if (CRM_Utils_Array::value('dataType', $field) == |
4087 | 'ContactReference' | |
4088 | ) { | |
6a488035 TO |
4089 | $columnName = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_CustomField', CRM_Core_BAO_CustomField::getKeyID($fieldName), 'column_name'); |
4090 | $this->_from .= " | |
4091 | LEFT JOIN civicrm_contact {$field['alias']} ON {$field['alias']}.id = {$this->_aliases[$table]}.{$columnName} "; | |
4092 | } | |
4093 | } | |
4094 | } | |
4095 | } | |
4096 | } | |
4097 | } | |
4098 | ||
74cf4551 | 4099 | /** |
317a8023 | 4100 | * Check if the field is selected. |
4101 | * | |
4102 | * @param string $prop | |
74cf4551 EM |
4103 | * |
4104 | * @return bool | |
4105 | */ | |
00be9182 | 4106 | public function isFieldSelected($prop) { |
6a488035 TO |
4107 | if (empty($prop)) { |
4108 | return FALSE; | |
4109 | } | |
4110 | ||
4111 | if (!empty($this->_params['fields'])) { | |
4112 | foreach (array_keys($prop['fields']) as $fieldAlias) { | |
4113 | $customFieldId = CRM_Core_BAO_CustomField::getKeyID($fieldAlias); | |
4114 | if ($customFieldId) { | |
4115 | if (array_key_exists($fieldAlias, $this->_params['fields'])) { | |
4116 | return TRUE; | |
4117 | } | |
4118 | ||
4119 | //might be survey response field. | |
9d72cede EM |
4120 | if (!empty($this->_params['fields']['survey_response']) && |
4121 | !empty($prop['fields'][$fieldAlias]['isSurveyResponseField']) | |
4122 | ) { | |
6a488035 TO |
4123 | return TRUE; |
4124 | } | |
4125 | } | |
4126 | } | |
4127 | } | |
4128 | ||
4129 | if (!empty($this->_params['group_bys']) && $this->_customGroupGroupBy) { | |
4130 | foreach (array_keys($prop['group_bys']) as $fieldAlias) { | |
9d72cede EM |
4131 | if (array_key_exists($fieldAlias, $this->_params['group_bys']) && |
4132 | CRM_Core_BAO_CustomField::getKeyID($fieldAlias) | |
4133 | ) { | |
6a488035 TO |
4134 | return TRUE; |
4135 | } | |
4136 | } | |
4137 | } | |
4138 | ||
4139 | if (!empty($this->_params['order_bys'])) { | |
4140 | foreach (array_keys($prop['fields']) as $fieldAlias) { | |
4141 | foreach ($this->_params['order_bys'] as $orderBy) { | |
9d72cede EM |
4142 | if ($fieldAlias == $orderBy['column'] && |
4143 | CRM_Core_BAO_CustomField::getKeyID($fieldAlias) | |
4144 | ) { | |
6a488035 TO |
4145 | return TRUE; |
4146 | } | |
4147 | } | |
4148 | } | |
4149 | } | |
568a0946 | 4150 | return $this->isFieldFiltered($prop); |
4151 | ||
4152 | } | |
6a488035 | 4153 | |
568a0946 | 4154 | /** |
4155 | * Check if the field is used as a filter. | |
4156 | * | |
4157 | * @param string $prop | |
4158 | * | |
4159 | * @return bool | |
4160 | */ | |
4161 | protected function isFieldFiltered($prop) { | |
6a488035 TO |
4162 | if (!empty($prop['filters']) && $this->_customGroupFilters) { |
4163 | foreach ($prop['filters'] as $fieldAlias => $val) { | |
be2fb01f | 4164 | foreach ([ |
c86d4e7c SL |
4165 | 'value', |
4166 | 'min', | |
4167 | 'max', | |
4168 | 'relative', | |
4169 | 'from', | |
4170 | 'to', | |
4171 | ] as $attach) { | |
6a488035 | 4172 | if (isset($this->_params[$fieldAlias . '_' . $attach]) && |
dfe4b2f5 | 4173 | (!empty($this->_params[$fieldAlias . '_' . $attach]) |
9d72cede EM |
4174 | || ($attach != 'relative' && |
4175 | $this->_params[$fieldAlias . '_' . $attach] == '0') | |
dfe4b2f5 | 4176 | ) |
9d72cede | 4177 | ) { |
6a488035 TO |
4178 | return TRUE; |
4179 | } | |
4180 | } | |
a7488080 | 4181 | if (!empty($this->_params[$fieldAlias . '_op']) && |
be2fb01f | 4182 | in_array($this->_params[$fieldAlias . '_op'], ['nll', 'nnll']) |
6a488035 TO |
4183 | ) { |
4184 | return TRUE; | |
4185 | } | |
4186 | } | |
4187 | } | |
4188 | ||
4189 | return FALSE; | |
4190 | } | |
4191 | ||
4192 | /** | |
31a8b5f0 | 4193 | * Check for empty order_by configurations and remove them. |
4194 | * | |
4195 | * Also set template to hide them. | |
537c70b8 EM |
4196 | * |
4197 | * @param array $formValues | |
6a488035 | 4198 | */ |
00be9182 | 4199 | public function preProcessOrderBy(&$formValues) { |
6a488035 | 4200 | // Object to show/hide form elements |
ae555e90 | 4201 | $_showHide = new CRM_Core_ShowHideBlocks('', ''); |
6a488035 TO |
4202 | |
4203 | $_showHide->addShow('optionField_1'); | |
4204 | ||
4205 | // Cycle through order_by options; skip any empty ones, and hide them as well | |
4206 | $n = 1; | |
4207 | ||
4208 | if (!empty($formValues['order_bys'])) { | |
4209 | foreach ($formValues['order_bys'] as $order_by) { | |
4210 | if ($order_by['column'] && $order_by['column'] != '-') { | |
4211 | $_showHide->addShow('optionField_' . $n); | |
4212 | $orderBys[$n] = $order_by; | |
4213 | $n++; | |
4214 | } | |
4215 | } | |
4216 | } | |
4217 | for ($i = $n; $i <= 5; $i++) { | |
4218 | if ($i > 1) { | |
4219 | $_showHide->addHide('optionField_' . $i); | |
4220 | } | |
4221 | } | |
4222 | ||
4223 | // overwrite order_by options with modified values | |
4224 | if (!empty($orderBys)) { | |
4225 | $formValues['order_bys'] = $orderBys; | |
4226 | } | |
4227 | else { | |
be2fb01f | 4228 | $formValues['order_bys'] = [1 => ['column' => '-']]; |
6a488035 TO |
4229 | } |
4230 | ||
4231 | // assign show/hide data to template | |
4232 | $_showHide->addToTemplate(); | |
4233 | } | |
4234 | ||
4235 | /** | |
317a8023 | 4236 | * Check if table name has columns in SELECT clause. |
6a488035 | 4237 | * |
7e06c9f5 TO |
4238 | * @param string $tableName |
4239 | * Name of table (index of $this->_columns array). | |
6a488035 TO |
4240 | * |
4241 | * @return bool | |
4242 | */ | |
00be9182 | 4243 | public function isTableSelected($tableName) { |
6a488035 TO |
4244 | return in_array($tableName, $this->selectedTables()); |
4245 | } | |
4246 | ||
568a0946 | 4247 | /** |
4248 | * Check if table name has columns in WHERE or HAVING clause. | |
4249 | * | |
4250 | * @param string $tableName | |
4251 | * Name of table (index of $this->_columns array). | |
4252 | * | |
4253 | * @return bool | |
4254 | */ | |
4255 | public function isTableFiltered($tableName) { | |
4256 | // Cause the array to be generated if not previously done. | |
4257 | if (!$this->_selectedTables && !$this->filteredTables) { | |
4258 | $this->selectedTables(); | |
4259 | } | |
4260 | return in_array($tableName, $this->filteredTables); | |
4261 | } | |
4262 | ||
6a488035 | 4263 | /** |
fe482240 | 4264 | * Fetch array of DAO tables having columns included in SELECT or ORDER BY clause. |
317a8023 | 4265 | * |
4266 | * If the array is unset it will be built. | |
6a488035 | 4267 | * |
971d41b1 CW |
4268 | * @return array |
4269 | * selectedTables | |
6a488035 | 4270 | */ |
00be9182 | 4271 | public function selectedTables() { |
6a488035 | 4272 | if (!$this->_selectedTables) { |
be2fb01f | 4273 | $orderByColumns = []; |
9d72cede EM |
4274 | if (array_key_exists('order_bys', $this->_params) && |
4275 | is_array($this->_params['order_bys']) | |
4276 | ) { | |
6a488035 TO |
4277 | foreach ($this->_params['order_bys'] as $orderBy) { |
4278 | $orderByColumns[] = $orderBy['column']; | |
4279 | } | |
4280 | } | |
4281 | ||
4282 | foreach ($this->_columns as $tableName => $table) { | |
4283 | if (array_key_exists('fields', $table)) { | |
4284 | foreach ($table['fields'] as $fieldName => $field) { | |
9d72cede EM |
4285 | if (!empty($field['required']) || |
4286 | !empty($this->_params['fields'][$fieldName]) | |
4287 | ) { | |
6a488035 TO |
4288 | $this->_selectedTables[] = $tableName; |
4289 | break; | |
4290 | } | |
4291 | } | |
4292 | } | |
4293 | if (array_key_exists('order_bys', $table)) { | |
4294 | foreach ($table['order_bys'] as $orderByName => $orderBy) { | |
4295 | if (in_array($orderByName, $orderByColumns)) { | |
4296 | $this->_selectedTables[] = $tableName; | |
4297 | break; | |
4298 | } | |
4299 | } | |
4300 | } | |
4301 | if (array_key_exists('filters', $table)) { | |
4302 | foreach ($table['filters'] as $filterName => $filter) { | |
3d8f552e | 4303 | if (!empty($this->_params["{$filterName}_value"]) |
4304 | || !empty($this->_params["{$filterName}_relative"]) | |
4305 | || CRM_Utils_Array::value("{$filterName}_op", $this->_params) == | |
4306 | 'nll' | |
4307 | || CRM_Utils_Array::value("{$filterName}_op", $this->_params) == | |
9d72cede | 4308 | 'nnll' |
6a488035 TO |
4309 | ) { |
4310 | $this->_selectedTables[] = $tableName; | |
568a0946 | 4311 | $this->filteredTables[] = $tableName; |
6a488035 TO |
4312 | break; |
4313 | } | |
4314 | } | |
4315 | } | |
4316 | } | |
4317 | } | |
4318 | return $this->_selectedTables; | |
4319 | } | |
4320 | ||
689c6bd2 | 4321 | /** |
4322 | * Add campaign fields. | |
c86d4e7c | 4323 | * @param string $entityTable |
689c6bd2 | 4324 | * @param bool $groupBy |
4325 | * Add GroupBy? Not appropriate for detail report. | |
4326 | * @param bool $orderBy | |
4327 | * Add OrderBy? Not appropriate for detail report. | |
4328 | * @param bool $filters | |
4329 | * | |
4330 | */ | |
4331 | public function addCampaignFields($entityTable = 'civicrm_contribution', $groupBy = FALSE, $orderBy = FALSE, $filters = TRUE) { | |
4332 | // Check if CiviCampaign is a) enabled and b) has active campaigns | |
4333 | $config = CRM_Core_Config::singleton(); | |
4334 | $campaignEnabled = in_array('CiviCampaign', $config->enableComponents); | |
4335 | if ($campaignEnabled) { | |
4336 | $getCampaigns = CRM_Campaign_BAO_Campaign::getPermissionedCampaigns(NULL, NULL, FALSE, FALSE, TRUE); | |
4337 | // If we have a campaign, build out the relevant elements | |
4338 | if (!empty($getCampaigns['campaigns'])) { | |
4238f84b | 4339 | $this->campaigns = $getCampaigns['campaigns']; |
4340 | asort($this->campaigns); | |
be2fb01f | 4341 | $this->_columns[$entityTable]['fields']['campaign_id'] = ['title' => ts('Campaign'), 'default' => 'false']; |
689c6bd2 | 4342 | if ($filters) { |
be2fb01f | 4343 | $this->_columns[$entityTable]['filters']['campaign_id'] = [ |
689c6bd2 | 4344 | 'title' => ts('Campaign'), |
4345 | 'operatorType' => CRM_Report_Form::OP_MULTISELECT, | |
4238f84b | 4346 | 'options' => $this->campaigns, |
689c6bd2 | 4347 | 'type' => CRM_Utils_Type::T_INT, |
be2fb01f | 4348 | ]; |
689c6bd2 | 4349 | } |
9db913d3 | 4350 | |
689c6bd2 | 4351 | if ($groupBy) { |
be2fb01f | 4352 | $this->_columns[$entityTable]['group_bys']['campaign_id'] = ['title' => ts('Campaign')]; |
689c6bd2 | 4353 | } |
9db913d3 | 4354 | |
4355 | if ($orderBy) { | |
be2fb01f | 4356 | $this->_columns[$entityTable]['order_bys']['campaign_id'] = ['title' => ts('Campaign')]; |
9db913d3 | 4357 | } |
689c6bd2 | 4358 | } |
4359 | } | |
4360 | } | |
4361 | ||
850e4640 | 4362 | /** |
317a8023 | 4363 | * Add address fields. |
4364 | * | |
850e4640 E |
4365 | * @deprecated - use getAddressColumns which is a more accurate description |
4366 | * and also accepts an array of options rather than a long list | |
4367 | * | |
c490a46a | 4368 | * adding address fields to construct function in reports |
77b97be7 | 4369 | * |
7e06c9f5 TO |
4370 | * @param bool $groupBy |
4371 | * Add GroupBy? Not appropriate for detail report. | |
4372 | * @param bool $orderBy | |
4373 | * Add GroupBy? Not appropriate for detail report. | |
77b97be7 EM |
4374 | * @param bool $filters |
4375 | * @param array $defaults | |
4376 | * | |
a6c01b45 CW |
4377 | * @return array |
4378 | * address fields for construct clause | |
6a488035 | 4379 | */ |
be2fb01f CW |
4380 | public function addAddressFields($groupBy = TRUE, $orderBy = FALSE, $filters = TRUE, $defaults = ['country_id' => TRUE]) { |
4381 | $defaultAddressFields = [ | |
8b2dc0b1 PN |
4382 | 'street_address' => ts('Street Address'), |
4383 | 'supplemental_address_1' => ts('Supplementary Address Field 1'), | |
4384 | 'supplemental_address_2' => ts('Supplementary Address Field 2'), | |
207f62c6 | 4385 | 'supplemental_address_3' => ts('Supplementary Address Field 3'), |
8b2dc0b1 PN |
4386 | 'street_number' => ts('Street Number'), |
4387 | 'street_name' => ts('Street Name'), | |
4388 | 'street_unit' => ts('Street Unit'), | |
4389 | 'city' => ts('City'), | |
4390 | 'postal_code' => ts('Postal Code'), | |
4391 | 'postal_code_suffix' => ts('Postal Code Suffix'), | |
4392 | 'country_id' => ts('Country'), | |
4393 | 'state_province_id' => ts('State/Province'), | |
4394 | 'county_id' => ts('County'), | |
be2fb01f CW |
4395 | ]; |
4396 | $addressFields = [ | |
4397 | 'civicrm_address' => [ | |
6a488035 | 4398 | 'dao' => 'CRM_Core_DAO_Address', |
be2fb01f CW |
4399 | 'fields' => [ |
4400 | 'address_name' => [ | |
9d72cede | 4401 | 'title' => ts('Address Name'), |
6a488035 | 4402 | 'default' => CRM_Utils_Array::value('name', $defaults, FALSE), |
e5575773 | 4403 | 'name' => 'name', |
be2fb01f CW |
4404 | ], |
4405 | ], | |
6a488035 | 4406 | 'grouping' => 'location-fields', |
be2fb01f CW |
4407 | ], |
4408 | ]; | |
8b2dc0b1 | 4409 | foreach ($defaultAddressFields as $fieldName => $fieldLabel) { |
be2fb01f | 4410 | $addressFields['civicrm_address']['fields'][$fieldName] = [ |
8b2dc0b1 PN |
4411 | 'title' => $fieldLabel, |
4412 | 'default' => CRM_Utils_Array::value($fieldName, $defaults, FALSE), | |
be2fb01f | 4413 | ]; |
8b2dc0b1 | 4414 | } |
6a488035 | 4415 | |
be2fb01f | 4416 | $street_address_filters = $general_address_filters = []; |
6a488035 | 4417 | if ($filters) { |
21c21057 JV |
4418 | // Address filter depends on whether street address parsing is enabled. |
4419 | // (CRM-18696) | |
4420 | $addressOptions = CRM_Core_BAO_Setting::valueOptions(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME, | |
4421 | 'address_options' | |
4422 | ); | |
4423 | if ($addressOptions['street_address_parsing']) { | |
be2fb01f CW |
4424 | $street_address_filters = [ |
4425 | 'street_number' => [ | |
21c21057 | 4426 | 'title' => ts('Street Number'), |
8b2dc0b1 | 4427 | 'type' => CRM_Utils_Type::T_INT, |
21c21057 | 4428 | 'name' => 'street_number', |
be2fb01f CW |
4429 | ], |
4430 | 'street_name' => [ | |
21c21057 JV |
4431 | 'title' => ts('Street Name'), |
4432 | 'name' => 'street_name', | |
8b2dc0b1 | 4433 | 'type' => CRM_Utils_Type::T_STRING, |
be2fb01f CW |
4434 | ], |
4435 | ]; | |
21c21057 JV |
4436 | } |
4437 | else { | |
be2fb01f CW |
4438 | $street_address_filters = [ |
4439 | 'street_address' => [ | |
21c21057 | 4440 | 'title' => ts('Street Address'), |
8b2dc0b1 | 4441 | 'type' => CRM_Utils_Type::T_STRING, |
21c21057 | 4442 | 'name' => 'street_address', |
be2fb01f CW |
4443 | ], |
4444 | ]; | |
21c21057 | 4445 | } |
be2fb01f CW |
4446 | $general_address_filters = [ |
4447 | 'postal_code' => [ | |
9d72cede | 4448 | 'title' => ts('Postal Code'), |
8b2dc0b1 | 4449 | 'type' => CRM_Utils_Type::T_STRING, |
9d72cede | 4450 | 'name' => 'postal_code', |
be2fb01f CW |
4451 | ], |
4452 | 'city' => [ | |
9d72cede | 4453 | 'title' => ts('City'), |
8b2dc0b1 | 4454 | 'type' => CRM_Utils_Type::T_STRING, |
9d72cede | 4455 | 'name' => 'city', |
be2fb01f CW |
4456 | ], |
4457 | 'country_id' => [ | |
863581d1 CW |
4458 | 'name' => 'country_id', |
4459 | 'title' => ts('Country'), | |
6a488035 | 4460 | 'type' => CRM_Utils_Type::T_INT, |
9d72cede | 4461 | 'operatorType' => CRM_Report_Form::OP_MULTISELECT, |
c927c151 | 4462 | 'options' => CRM_Core_PseudoConstant::country(), |
be2fb01f CW |
4463 | ], |
4464 | 'state_province_id' => [ | |
6a488035 TO |
4465 | 'name' => 'state_province_id', |
4466 | 'title' => ts('State/Province'), | |
4467 | 'type' => CRM_Utils_Type::T_INT, | |
c927c151 | 4468 | 'operatorType' => CRM_Report_Form::OP_MULTISELECT, |
be2fb01f CW |
4469 | 'options' => [], |
4470 | ], | |
4471 | 'county_id' => [ | |
863581d1 CW |
4472 | 'name' => 'county_id', |
4473 | 'title' => ts('County'), | |
6a488035 | 4474 | 'type' => CRM_Utils_Type::T_INT, |
c927c151 | 4475 | 'operatorType' => CRM_Report_Form::OP_MULTISELECT, |
be2fb01f CW |
4476 | 'options' => [], |
4477 | ], | |
4478 | ]; | |
6a488035 | 4479 | } |
21c21057 JV |
4480 | $addressFields['civicrm_address']['filters'] = array_merge( |
4481 | $street_address_filters, | |
4482 | $general_address_filters); | |
6a488035 TO |
4483 | |
4484 | if ($orderBy) { | |
be2fb01f CW |
4485 | $addressFields['civicrm_address']['order_bys'] = [ |
4486 | 'street_name' => ['title' => ts('Street Name')], | |
4487 | 'street_number' => ['title' => ts('Odd / Even Street Number')], | |
9d72cede EM |
4488 | 'street_address' => NULL, |
4489 | 'city' => NULL, | |
4490 | 'postal_code' => NULL, | |
be2fb01f | 4491 | ]; |
6a488035 TO |
4492 | } |
4493 | ||
4494 | if ($groupBy) { | |
be2fb01f | 4495 | $addressFields['civicrm_address']['group_bys'] = [ |
6a488035 TO |
4496 | 'street_address' => NULL, |
4497 | 'city' => NULL, | |
4498 | 'postal_code' => NULL, | |
be2fb01f | 4499 | 'state_province_id' => [ |
9d72cede | 4500 | 'title' => ts('State/Province'), |
be2fb01f CW |
4501 | ], |
4502 | 'country_id' => [ | |
9d72cede | 4503 | 'title' => ts('Country'), |
be2fb01f CW |
4504 | ], |
4505 | 'county_id' => [ | |
9d72cede | 4506 | 'title' => ts('County'), |
be2fb01f CW |
4507 | ], |
4508 | ]; | |
6a488035 TO |
4509 | } |
4510 | return $addressFields; | |
4511 | } | |
4512 | ||
74cf4551 | 4513 | /** |
fe482240 | 4514 | * Do AlterDisplay processing on Address Fields. |
66ad82d6 | 4515 | * If there are multiple address field values then |
4516 | * on basis of provided separator the code values are translated into respective labels | |
688d37c6 | 4517 | * |
317a8023 | 4518 | * @param array $row |
4519 | * @param array $rows | |
4520 | * @param int $rowNum | |
4521 | * @param string $baseUrl | |
e4e2ff09 | 4522 | * @param string $linkText |
66ad82d6 | 4523 | * @param string $separator |
74cf4551 EM |
4524 | * |
4525 | * @return bool | |
4526 | */ | |
66ad82d6 | 4527 | public function alterDisplayAddressFields(&$row, &$rows, &$rowNum, $baseUrl, $linkText, $separator = ',') { |
6a488035 TO |
4528 | $criteriaQueryParams = CRM_Report_Utils_Report::getPreviewCriteriaQueryParams($this->_defaults, $this->_params); |
4529 | $entryFound = FALSE; | |
be2fb01f | 4530 | $columnMap = [ |
66ad82d6 | 4531 | 'civicrm_address_country_id' => 'country', |
4532 | 'civicrm_address_county_id' => 'county', | |
4533 | 'civicrm_address_state_province_id' => 'stateProvince', | |
be2fb01f | 4534 | ]; |
66ad82d6 | 4535 | foreach ($columnMap as $fieldName => $fnName) { |
4536 | if (array_key_exists($fieldName, $row)) { | |
4537 | if ($values = $row[$fieldName]) { | |
4538 | $values = (array) explode($separator, $values); | |
4539 | $rows[$rowNum][$fieldName] = []; | |
4540 | $addressField = $fnName == 'stateProvince' ? 'state' : $fnName; | |
4541 | foreach ($values as $value) { | |
4542 | $rows[$rowNum][$fieldName][] = CRM_Core_PseudoConstant::$fnName($value); | |
4543 | } | |
4544 | $rows[$rowNum][$fieldName] = implode($separator, $rows[$rowNum][$fieldName]); | |
4545 | if ($baseUrl) { | |
4546 | $url = CRM_Report_Utils_Report::getNextUrl($baseUrl, | |
4547 | sprintf("reset=1&force=1&%s&%s_op=in&%s_value=%s", | |
4548 | $criteriaQueryParams, | |
4549 | str_replace('civicrm_address_', '', $fieldName), | |
4550 | str_replace('civicrm_address_', '', $fieldName), | |
4551 | implode(',', $values) | |
4552 | ), $this->_absoluteUrl, $this->_id | |
4553 | ); | |
4554 | $rows[$rowNum]["{$fieldName}_link"] = $url; | |
be2fb01f | 4555 | $rows[$rowNum]["{$fieldName}_hover"] = ts("%1 for this %2.", [1 => $linkText, 2 => $addressField]); |
66ad82d6 | 4556 | } |
cec737d8 | 4557 | } |
089492f7 | 4558 | $entryFound = TRUE; |
6a488035 | 4559 | } |
6a488035 TO |
4560 | } |
4561 | ||
4562 | return $entryFound; | |
4563 | } | |
4564 | ||
e5575773 | 4565 | /** |
4566 | * Do AlterDisplay processing on Address Fields. | |
4567 | * | |
4568 | * @param array $row | |
4569 | * @param array $rows | |
4570 | * @param int $rowNum | |
e4e2ff09 | 4571 | * @param string $baseUrl |
4572 | * @param string $linkText | |
e5575773 | 4573 | * |
4574 | * @return bool | |
4575 | */ | |
e4e2ff09 | 4576 | public function alterDisplayContactFields(&$row, &$rows, &$rowNum, $baseUrl, $linkText) { |
e5575773 | 4577 | $entryFound = FALSE; |
d9bf3c53 | 4578 | // There is no reason not to add links for all fields but it seems a bit odd to be able to click on |
4579 | // 'Mrs'. Also, we don't have metadata about the title. So, add selectively to addLinks. | |
be2fb01f CW |
4580 | $addLinks = ['gender_id' => 'Gender']; |
4581 | foreach (['prefix_id', 'suffix_id', 'gender_id', 'contact_sub_type', 'preferred_language'] as $fieldName) { | |
50172d25 | 4582 | if (array_key_exists('civicrm_contact_' . $fieldName, $row)) { |
4583 | if (($value = $row['civicrm_contact_' . $fieldName]) != FALSE) { | |
b706a634 | 4584 | $rowValues = explode(CRM_Core_DAO::VALUE_SEPARATOR, $value); |
be2fb01f | 4585 | $rowLabels = []; |
b706a634 | 4586 | foreach ($rowValues as $rowValue) { |
4587 | if ($rowValue) { | |
074dd766 | 4588 | $rowLabels[] = CRM_Core_PseudoConstant::getLabel('CRM_Contact_BAO_Contact', $fieldName, $rowValue); |
b706a634 | 4589 | } |
4590 | } | |
4591 | $rows[$rowNum]['civicrm_contact_' . $fieldName] = implode(', ', $rowLabels); | |
cec737d8 | 4592 | if ($baseUrl && ($title = CRM_Utils_Array::value($fieldName, $addLinks)) != FALSE) { |
d9bf3c53 | 4593 | $this->addLinkToRow($rows[$rowNum], $baseUrl, $linkText, $value, $fieldName, 'civicrm_contact', $title); |
4594 | } | |
50172d25 | 4595 | } |
4596 | $entryFound = TRUE; | |
e5575773 | 4597 | } |
e5575773 | 4598 | } |
be2fb01f | 4599 | $yesNoFields = [ |
ea477981 | 4600 | 'do_not_email', 'is_deceased', 'do_not_phone', 'do_not_sms', 'do_not_mail', 'is_opt_out', |
be2fb01f | 4601 | ]; |
ea477981 | 4602 | foreach ($yesNoFields as $fieldName) { |
4603 | if (array_key_exists('civicrm_contact_' . $fieldName, $row)) { | |
4604 | // Since these are essentially 'negative fields' it feels like it | |
4605 | // makes sense to only highlight the exceptions hence no 'No'. | |
4606 | $rows[$rowNum]['civicrm_contact_' . $fieldName] = !empty($rows[$rowNum]['civicrm_contact_' . $fieldName]) ? ts('Yes') : ''; | |
4607 | $entryFound = TRUE; | |
4608 | } | |
4609 | } | |
316bcb72 | 4610 | |
4611 | // Handle employer id | |
4612 | if (array_key_exists('civicrm_contact_employer_id', $row)) { | |
4613 | $employerId = $row['civicrm_contact_employer_id']; | |
4614 | if ($employerId) { | |
4615 | $rows[$rowNum]['civicrm_contact_employer_id'] = CRM_Contact_BAO_Contact::displayName($employerId); | |
4616 | $rows[$rowNum]['civicrm_contact_employer_id_link'] = CRM_Utils_System::url('civicrm/contact/view', 'reset=1&cid=' . $employerId, $this->_absoluteUrl); | |
4617 | $rows[$rowNum]['civicrm_contact_employer_id_hover'] = ts('View Contact Summary for Employer.'); | |
4618 | $entryFound = TRUE; | |
4619 | } | |
4620 | } | |
4621 | ||
e5575773 | 4622 | return $entryFound; |
4623 | } | |
4624 | ||
74cf4551 | 4625 | /** |
688d37c6 CW |
4626 | * Adjusts dates passed in to YEAR() for fiscal year. |
4627 | * | |
100fef9d | 4628 | * @param string $fieldName |
74cf4551 EM |
4629 | * |
4630 | * @return string | |
4631 | */ | |
00be9182 | 4632 | public function fiscalYearOffset($fieldName) { |
6a488035 TO |
4633 | $config = CRM_Core_Config::singleton(); |
4634 | $fy = $config->fiscalYearStart; | |
9d72cede EM |
4635 | if (CRM_Utils_Array::value('yid_op', $this->_params) == 'calendar' || |
4636 | ($fy['d'] == 1 && $fy['M'] == 1) | |
4637 | ) { | |
6a488035 TO |
4638 | return "YEAR( $fieldName )"; |
4639 | } | |
9d72cede EM |
4640 | return "YEAR( $fieldName - INTERVAL " . ($fy['M'] - 1) . " MONTH" . |
4641 | ($fy['d'] > 1 ? (" - INTERVAL " . ($fy['d'] - 1) . " DAY") : '') . " )"; | |
6a488035 TO |
4642 | } |
4643 | ||
688d37c6 | 4644 | /** |
fe482240 | 4645 | * Add Address into From Table if required. |
18f511e2 | 4646 | * |
4647 | * @deprecated use joinAddressFromContact | |
4648 | * (left here in case extensions use it). | |
6a488035 | 4649 | */ |
00be9182 | 4650 | public function addAddressFromClause() { |
496320c3 | 4651 | CRM_Core_Error::deprecatedFunctionWarning('CRM_Report_Form::joinAddressFromContact'); |
6a488035 TO |
4652 | // include address field if address column is to be included |
4653 | if ((isset($this->_addressField) && | |
4654 | $this->_addressField | |
4655 | ) || | |
4656 | $this->isTableSelected('civicrm_address') | |
4657 | ) { | |
4658 | $this->_from .= " | |
4659 | LEFT JOIN civicrm_address {$this->_aliases['civicrm_address']} | |
4660 | ON ({$this->_aliases['civicrm_contact']}.id = | |
4661 | {$this->_aliases['civicrm_address']}.contact_id) AND | |
4662 | {$this->_aliases['civicrm_address']}.is_primary = 1\n"; | |
4663 | } | |
4664 | } | |
4665 | ||
850e4640 | 4666 | /** |
fe482240 | 4667 | * Add Phone into From Table if required. |
18f511e2 | 4668 | * |
4669 | * @deprecated use joinPhoneFromContact | |
4670 | * (left here in case extensions use it). | |
850e4640 | 4671 | */ |
00be9182 | 4672 | public function addPhoneFromClause() { |
496320c3 | 4673 | CRM_Core_Error::deprecatedFunctionWarning('CRM_Report_Form::joinPhoneFromContact'); |
850e4640 | 4674 | // include address field if address column is to be included |
d2a1da52 | 4675 | if ($this->isTableSelected('civicrm_phone')) { |
850e4640 E |
4676 | $this->_from .= " |
4677 | LEFT JOIN civicrm_phone {$this->_aliases['civicrm_phone']} | |
4678 | ON ({$this->_aliases['civicrm_contact']}.id = | |
4679 | {$this->_aliases['civicrm_phone']}.contact_id) AND | |
4680 | {$this->_aliases['civicrm_phone']}.is_primary = 1\n"; | |
4681 | } | |
4682 | } | |
4683 | ||
e3c74b61 | 4684 | /** |
4685 | * Add Address into From Table if required. | |
4686 | * | |
4687 | * Prefix will be added to both tables as | |
4688 | * it is assumed you are using it to get address of a secondary contact. | |
4689 | * | |
4690 | * @param string $prefix | |
4691 | * @param array $extra Additional options. | |
4692 | * Not currently used in core but may be used in override extensions. | |
4693 | */ | |
be2fb01f | 4694 | protected function joinAddressFromContact($prefix = '', $extra = []) { |
e3c74b61 | 4695 | $addressTables = ['civicrm_address', 'civicrm_country', 'civicrm_worldregion', 'civicrm_state_province']; |
4696 | $isJoinRequired = $this->_addressField; | |
4697 | foreach ($addressTables as $addressTable) { | |
4698 | if ($this->isTableSelected($prefix . $addressTable)) { | |
4699 | $isJoinRequired = TRUE; | |
4700 | } | |
4701 | } | |
4702 | if ($isJoinRequired) { | |
4703 | $this->_from .= " | |
4704 | LEFT JOIN civicrm_address {$this->_aliases[$prefix . 'civicrm_address']} | |
4705 | ON ({$this->_aliases[$prefix . 'civicrm_contact']}.id = | |
4706 | {$this->_aliases[$prefix . 'civicrm_address']}.contact_id) AND | |
4707 | {$this->_aliases[$prefix . 'civicrm_address']}.is_primary = 1\n"; | |
4708 | } | |
4709 | } | |
4710 | ||
4711 | /** | |
4712 | * Add Country into From Table if required. | |
4713 | * | |
4714 | * Prefix will be added to both tables as | |
4715 | * it is assumed you are using it to get address of a secondary contact. | |
4716 | * | |
4717 | * @param string $prefix | |
4718 | * @param array $extra Additional options. | |
4719 | * Not currently used in core but may be used in override extensions. | |
4720 | */ | |
be2fb01f | 4721 | protected function joinCountryFromAddress($prefix = '', $extra = []) { |
e3c74b61 | 4722 | // include country field if country column is to be included |
6d81d64a | 4723 | if ($this->isTableSelected($prefix . 'civicrm_country') || $this->isTableSelected($prefix . 'civicrm_worldregion')) { |
4724 | if (empty($this->_aliases[$prefix . 'civicrm_country'])) { | |
4725 | $this->_aliases[$prefix . 'civicrm_country'] = $prefix . '_report_country'; | |
4726 | } | |
e3c74b61 | 4727 | $this->_from .= " |
4728 | LEFT JOIN civicrm_country {$this->_aliases[$prefix . 'civicrm_country']} | |
4729 | ON {$this->_aliases[$prefix . 'civicrm_address']}.country_id = {$this->_aliases[$prefix . 'civicrm_country']}.id AND | |
4730 | {$this->_aliases[$prefix . 'civicrm_address']}.is_primary = 1 "; | |
4731 | } | |
4732 | } | |
4733 | ||
4734 | /** | |
4735 | * Add Phone into From Table if required. | |
4736 | * | |
4737 | * Prefix will be added to both tables as | |
4738 | * it is assumed you are using it to get address of a secondary contact. | |
4739 | * | |
4740 | * @param string $prefix | |
4741 | * @param array $extra Additional options. | |
4742 | * Not currently used in core but may be used in override extensions. | |
4743 | */ | |
be2fb01f | 4744 | protected function joinPhoneFromContact($prefix = '', $extra = []) { |
e3c74b61 | 4745 | // include phone field if phone column is to be included |
4746 | if ($this->isTableSelected($prefix . 'civicrm_phone')) { | |
4747 | $this->_from .= " | |
4748 | LEFT JOIN civicrm_phone {$this->_aliases[$prefix . 'civicrm_phone']} | |
4749 | ON {$this->_aliases[$prefix . 'civicrm_contact']}.id = {$this->_aliases[$prefix . 'civicrm_phone']}.contact_id AND | |
4750 | {$this->_aliases[$prefix . 'civicrm_phone']}.is_primary = 1\n"; | |
4751 | } | |
4752 | } | |
4753 | ||
4754 | /** | |
4755 | * Add Email into From Table if required. | |
4756 | * | |
4757 | * Prefix will be added to both tables as | |
4758 | * it is assumed you are using it to get address of a secondary contact. | |
4759 | * | |
4760 | * @param string $prefix | |
4761 | * @param array $extra Additional options. | |
4762 | * Not currently used in core but may be used in override extensions. | |
4763 | */ | |
be2fb01f | 4764 | protected function joinEmailFromContact($prefix = '', $extra = []) { |
e3c74b61 | 4765 | // include email field if email column is to be included |
4766 | if ($this->isTableSelected($prefix . 'civicrm_email')) { | |
4767 | $this->_from .= " | |
4768 | LEFT JOIN civicrm_email {$this->_aliases[$prefix . 'civicrm_email']} | |
4769 | ON ({$this->_aliases[$prefix . 'civicrm_contact']}.id = {$this->_aliases[$prefix . 'civicrm_email']}.contact_id AND | |
4770 | {$this->_aliases[$prefix . 'civicrm_email']}.is_primary = 1) "; | |
4771 | } | |
4772 | } | |
4773 | ||
d2a1da52 ERL |
4774 | /** |
4775 | * Add Financial Transaction into From Table if required. | |
4776 | */ | |
4777 | public function addFinancialTrxnFromClause() { | |
4778 | if ($this->isTableSelected('civicrm_financial_trxn')) { | |
4779 | $this->_from .= " | |
4780 | LEFT JOIN civicrm_entity_financial_trxn eftcc | |
4781 | ON ({$this->_aliases['civicrm_contribution']}.id = eftcc.entity_id AND | |
4782 | eftcc.entity_table = 'civicrm_contribution') | |
4783 | LEFT JOIN civicrm_financial_trxn {$this->_aliases['civicrm_financial_trxn']} | |
4784 | ON {$this->_aliases['civicrm_financial_trxn']}.id = eftcc.financial_trxn_id \n"; | |
4785 | } | |
4786 | } | |
4787 | ||
850e4640 | 4788 | /** |
fe482240 | 4789 | * Get phone columns to add to array. |
9d72cede | 4790 | * |
850e4640 | 4791 | * @param array $options |
16b10e64 CW |
4792 | * - prefix Prefix to add to table (in case of more than one instance of the table) |
4793 | * - prefix_label Label to give columns from this phone table instance | |
9d72cede | 4794 | * |
a6c01b45 CW |
4795 | * @return array |
4796 | * phone columns definition | |
850e4640 | 4797 | */ |
be2fb01f CW |
4798 | public function getPhoneColumns($options = []) { |
4799 | $defaultOptions = [ | |
850e4640 E |
4800 | 'prefix' => '', |
4801 | 'prefix_label' => '', | |
be2fb01f | 4802 | ]; |
850e4640 | 4803 | |
9d72cede | 4804 | $options = array_merge($defaultOptions, $options); |
850e4640 | 4805 | |
be2fb01f CW |
4806 | $fields = [ |
4807 | $options['prefix'] . 'civicrm_phone' => [ | |
9d72cede | 4808 | 'dao' => 'CRM_Core_DAO_Phone', |
be2fb01f CW |
4809 | 'fields' => [ |
4810 | $options['prefix'] . 'phone' => [ | |
c576cb65 | 4811 | 'title' => $options['prefix_label'] . ts('Phone'), |
21dfd5f5 | 4812 | 'name' => 'phone', |
be2fb01f CW |
4813 | ], |
4814 | ], | |
4815 | ], | |
4816 | ]; | |
850e4640 E |
4817 | return $fields; |
4818 | } | |
4819 | ||
e5575773 | 4820 | /** |
4821 | * Get a standard set of contact fields. | |
7777f433 | 4822 | * @deprecated - use getColumns('Contact') instead |
e5575773 | 4823 | * @return array |
4824 | */ | |
4825 | public function getBasicContactFields() { | |
be2fb01f CW |
4826 | return [ |
4827 | 'sort_name' => [ | |
e5575773 | 4828 | 'title' => ts('Contact Name'), |
4829 | 'required' => TRUE, | |
4830 | 'default' => TRUE, | |
be2fb01f CW |
4831 | ], |
4832 | 'id' => [ | |
e5575773 | 4833 | 'no_display' => TRUE, |
4834 | 'required' => TRUE, | |
be2fb01f CW |
4835 | ], |
4836 | 'prefix_id' => [ | |
e5575773 | 4837 | 'title' => ts('Contact Prefix'), |
be2fb01f CW |
4838 | ], |
4839 | 'first_name' => [ | |
e5575773 | 4840 | 'title' => ts('First Name'), |
be2fb01f CW |
4841 | ], |
4842 | 'nick_name' => [ | |
4120c775 | 4843 | 'title' => ts('Nick Name'), |
be2fb01f CW |
4844 | ], |
4845 | 'middle_name' => [ | |
e5575773 | 4846 | 'title' => ts('Middle Name'), |
be2fb01f CW |
4847 | ], |
4848 | 'last_name' => [ | |
e5575773 | 4849 | 'title' => ts('Last Name'), |
be2fb01f CW |
4850 | ], |
4851 | 'suffix_id' => [ | |
e5575773 | 4852 | 'title' => ts('Contact Suffix'), |
be2fb01f CW |
4853 | ], |
4854 | 'postal_greeting_display' => ['title' => ts('Postal Greeting')], | |
4855 | 'email_greeting_display' => ['title' => ts('Email Greeting')], | |
4856 | 'addressee_display' => ['title' => ts('Addressee')], | |
4857 | 'contact_type' => [ | |
e5575773 | 4858 | 'title' => ts('Contact Type'), |
be2fb01f CW |
4859 | ], |
4860 | 'contact_sub_type' => [ | |
e5575773 | 4861 | 'title' => ts('Contact Subtype'), |
be2fb01f CW |
4862 | ], |
4863 | 'gender_id' => [ | |
e5575773 | 4864 | 'title' => ts('Gender'), |
be2fb01f CW |
4865 | ], |
4866 | 'birth_date' => [ | |
e5575773 | 4867 | 'title' => ts('Birth Date'), |
be2fb01f CW |
4868 | ], |
4869 | 'age' => [ | |
e5575773 | 4870 | 'title' => ts('Age'), |
4871 | 'dbAlias' => 'TIMESTAMPDIFF(YEAR, contact_civireport.birth_date, CURDATE())', | |
be2fb01f CW |
4872 | ], |
4873 | 'job_title' => [ | |
e5575773 | 4874 | 'title' => ts('Contact Job title'), |
be2fb01f CW |
4875 | ], |
4876 | 'organization_name' => [ | |
e5575773 | 4877 | 'title' => ts('Organization Name'), |
be2fb01f CW |
4878 | ], |
4879 | 'external_identifier' => [ | |
b4d1eebe | 4880 | 'title' => ts('Contact identifier from external system'), |
be2fb01f CW |
4881 | ], |
4882 | 'do_not_email' => [], | |
4883 | 'do_not_phone' => [], | |
4884 | 'do_not_mail' => [], | |
4885 | 'do_not_sms' => [], | |
4886 | 'is_opt_out' => [], | |
4887 | 'is_deceased' => [], | |
4888 | 'preferred_language' => [], | |
4889 | 'employer_id' => [ | |
316bcb72 | 4890 | 'title' => ts('Current Employer'), |
be2fb01f CW |
4891 | ], |
4892 | ]; | |
e5575773 | 4893 | } |
4894 | ||
aceb083a | 4895 | /** |
4896 | * Get a standard set of contact filters. | |
4897 | * | |
1ebe1a57 FBB |
4898 | * @param array $defaults |
4899 | * | |
aceb083a | 4900 | * @return array |
4901 | */ | |
be2fb01f CW |
4902 | public function getBasicContactFilters($defaults = []) { |
4903 | return [ | |
4904 | 'sort_name' => [ | |
aceb083a | 4905 | 'title' => ts('Contact Name'), |
be2fb01f CW |
4906 | ], |
4907 | 'source' => [ | |
aceb083a | 4908 | 'title' => ts('Contact Source'), |
4909 | 'type' => CRM_Utils_Type::T_STRING, | |
be2fb01f CW |
4910 | ], |
4911 | 'id' => [ | |
aceb083a | 4912 | 'title' => ts('Contact ID'), |
4913 | 'no_display' => TRUE, | |
be2fb01f CW |
4914 | ], |
4915 | 'gender_id' => [ | |
aceb083a | 4916 | 'title' => ts('Gender'), |
4917 | 'operatorType' => CRM_Report_Form::OP_MULTISELECT, | |
4918 | 'options' => CRM_Core_PseudoConstant::get('CRM_Contact_DAO_Contact', 'gender_id'), | |
be2fb01f CW |
4919 | ], |
4920 | 'birth_date' => [ | |
aceb083a | 4921 | 'title' => ts('Birth Date'), |
4922 | 'operatorType' => CRM_Report_Form::OP_DATE, | |
be2fb01f CW |
4923 | ], |
4924 | 'contact_type' => [ | |
aceb083a | 4925 | 'title' => ts('Contact Type'), |
be2fb01f CW |
4926 | ], |
4927 | 'contact_sub_type' => [ | |
aceb083a | 4928 | 'title' => ts('Contact Subtype'), |
be2fb01f CW |
4929 | ], |
4930 | 'modified_date' => [ | |
aceb083a | 4931 | 'title' => ts('Contact Modified'), |
4932 | 'operatorType' => CRM_Report_Form::OP_DATE, | |
4933 | 'type' => CRM_Utils_Type::T_DATE, | |
be2fb01f CW |
4934 | ], |
4935 | 'is_deceased' => [ | |
aceb083a | 4936 | 'title' => ts('Deceased'), |
4937 | 'type' => CRM_Utils_Type::T_BOOLEAN, | |
1ebe1a57 | 4938 | 'default' => CRM_Utils_Array::value('deceased', $defaults, 0), |
be2fb01f CW |
4939 | ], |
4940 | 'do_not_email' => [ | |
b3f2f5e9 | 4941 | 'title' => ts('Do not email'), |
4942 | 'type' => CRM_Utils_Type::T_BOOLEAN, | |
be2fb01f CW |
4943 | ], |
4944 | 'do_not_phone' => [ | |
b3f2f5e9 | 4945 | 'title' => ts('Do not phone'), |
4946 | 'type' => CRM_Utils_Type::T_BOOLEAN, | |
be2fb01f CW |
4947 | ], |
4948 | 'do_not_mail' => [ | |
b3f2f5e9 | 4949 | 'title' => ts('Do not mail'), |
4950 | 'type' => CRM_Utils_Type::T_BOOLEAN, | |
be2fb01f CW |
4951 | ], |
4952 | 'do_not_sms' => [ | |
b3f2f5e9 | 4953 | 'title' => ts('Do not SMS'), |
4954 | 'type' => CRM_Utils_Type::T_BOOLEAN, | |
be2fb01f CW |
4955 | ], |
4956 | 'is_opt_out' => [ | |
b3f2f5e9 | 4957 | 'title' => ts('Do not bulk email'), |
4958 | 'type' => CRM_Utils_Type::T_BOOLEAN, | |
be2fb01f CW |
4959 | ], |
4960 | 'preferred_language' => [ | |
b706a634 | 4961 | 'title' => ts('Preferred Language'), |
be2fb01f CW |
4962 | ], |
4963 | 'is_deleted' => [ | |
da7ac680 CW |
4964 | 'no_display' => TRUE, |
4965 | 'default' => 0, | |
4966 | 'type' => CRM_Utils_Type::T_BOOLEAN, | |
be2fb01f CW |
4967 | ], |
4968 | ]; | |
aceb083a | 4969 | } |
4970 | ||
74cf4551 | 4971 | /** |
317a8023 | 4972 | * Add contact to group. |
4973 | * | |
100fef9d | 4974 | * @param int $groupID |
74cf4551 | 4975 | */ |
00be9182 | 4976 | public function add2group($groupID) { |
6a488035 TO |
4977 | if (is_numeric($groupID) && isset($this->_aliases['civicrm_contact'])) { |
4978 | $select = "SELECT DISTINCT {$this->_aliases['civicrm_contact']}.id AS addtogroup_contact_id, "; | |
f0b5b73e | 4979 | $select = preg_replace('/SELECT(\s+SQL_CALC_FOUND_ROWS)?\s+/i', $select, $this->_select); |
6a488035 | 4980 | $sql = "{$select} {$this->_from} {$this->_where} {$this->_groupBy} {$this->_having} {$this->_orderBy}"; |
e05e0dba | 4981 | $sql = str_replace('WITH ROLLUP', '', $sql); |
6a488035 TO |
4982 | $dao = CRM_Core_DAO::executeQuery($sql); |
4983 | ||
be2fb01f | 4984 | $contact_ids = []; |
6a488035 TO |
4985 | // Add resulting contacts to group |
4986 | while ($dao->fetch()) { | |
4987 | if ($dao->addtogroup_contact_id) { | |
4988 | $contact_ids[$dao->addtogroup_contact_id] = $dao->addtogroup_contact_id; | |
4989 | } | |
4990 | } | |
4991 | ||
9d72cede | 4992 | if (!empty($contact_ids)) { |
6a488035 TO |
4993 | CRM_Contact_BAO_GroupContact::addContactsToGroup($contact_ids, $groupID); |
4994 | CRM_Core_Session::setStatus(ts("Listed contact(s) have been added to the selected group."), ts('Contacts Added'), 'success'); | |
4995 | } | |
4996 | else { | |
4997 | CRM_Core_Session::setStatus(ts("The listed records(s) cannot be added to the group.")); | |
4998 | } | |
4999 | } | |
5000 | } | |
46065582 | 5001 | |
688d37c6 | 5002 | /** |
317a8023 | 5003 | * Show charts on print screen. |
688d37c6 | 5004 | */ |
00be9182 | 5005 | public static function uploadChartImage() { |
46065582 | 5006 | // upload strictly for '.png' images |
d04d4eef PJ |
5007 | $name = trim(basename(CRM_Utils_Request::retrieve('name', 'String', CRM_Core_DAO::$_nullObject, FALSE, NULL, 'GET'))); |
5008 | if (preg_match('/\.png$/', $name)) { | |
053cbadd MM |
5009 | |
5010 | // Get the RAW .png from the input. | |
5011 | $httpRawPostData = file_get_contents("php://input"); | |
46065582 PJ |
5012 | |
5013 | // prepare the directory | |
5014 | $config = CRM_Core_Config::singleton(); | |
971d41b1 CW |
5015 | $defaultPath |
5016 | = str_replace('/persist/contribute/', '/persist/', $config->imageUploadDir) . | |
9d72cede | 5017 | '/openFlashChart/'; |
46065582 PJ |
5018 | if (!file_exists($defaultPath)) { |
5019 | mkdir($defaultPath, 0777, TRUE); | |
5020 | } | |
5021 | ||
5022 | // full path to the saved image including filename | |
d04d4eef | 5023 | $destination = $defaultPath . $name; |
46065582 PJ |
5024 | |
5025 | //write and save | |
5026 | $jfh = fopen($destination, 'w') or die("can't open file"); | |
5027 | fwrite($jfh, $httpRawPostData); | |
5028 | fclose($jfh); | |
5029 | CRM_Utils_System::civiExit(); | |
5030 | } | |
5031 | } | |
2107cde9 CW |
5032 | |
5033 | /** | |
fe482240 | 5034 | * Apply common settings to entityRef fields. |
9d72cede | 5035 | * |
2107cde9 CW |
5036 | * @param array $field |
5037 | * @param string $table | |
5038 | */ | |
b2c5abe3 | 5039 | public function setEntityRefDefaults(&$field, $table) { |
be2fb01f CW |
5040 | $field['attributes'] = $field['attributes'] ? $field['attributes'] : []; |
5041 | $field['attributes'] += [ | |
2107cde9 CW |
5042 | 'entity' => CRM_Core_DAO_AllCoreTables::getBriefName(CRM_Core_DAO_AllCoreTables::getClassForTable($table)), |
5043 | 'multiple' => TRUE, | |
5044 | 'placeholder' => ts('- select -'), | |
be2fb01f | 5045 | ]; |
2107cde9 | 5046 | } |
96025800 | 5047 | |
e4e2ff09 | 5048 | /** |
5049 | * Add link fields to the row. | |
5050 | * | |
5051 | * Function adds the _link & _hover fields to the row. | |
5052 | * | |
5053 | * @param array $row | |
5054 | * @param string $baseUrl | |
5055 | * @param string $linkText | |
5056 | * @param string $value | |
5057 | * @param string $fieldName | |
5058 | * @param string $tablePrefix | |
5059 | * @param string $fieldLabel | |
5060 | * | |
5061 | * @return mixed | |
5062 | */ | |
5063 | protected function addLinkToRow(&$row, $baseUrl, $linkText, $value, $fieldName, $tablePrefix, $fieldLabel) { | |
5064 | $criteriaQueryParams = CRM_Report_Utils_Report::getPreviewCriteriaQueryParams($this->_defaults, $this->_params); | |
5065 | $url = CRM_Report_Utils_Report::getNextUrl($baseUrl, | |
5066 | "reset=1&force=1&{$criteriaQueryParams}&" . | |
5067 | $fieldName . "_op=in&{$fieldName}_value={$value}", | |
5068 | $this->_absoluteUrl, $this->_id | |
5069 | ); | |
5070 | $row["{$tablePrefix}_{$fieldName}_link"] = $url; | |
5071 | $row["{$tablePrefix}_{$fieldName}_hover"] = ts("%1 for this %2.", | |
be2fb01f | 5072 | [1 => $linkText, 2 => $fieldLabel] |
e4e2ff09 | 5073 | ); |
5074 | } | |
5075 | ||
182f5081 | 5076 | /** |
5077 | * Get label for show results buttons. | |
5078 | * | |
5079 | * @return string | |
5080 | */ | |
5081 | public function getResultsLabel() { | |
5082 | $showResultsLabel = $this->resultsDisplayed() ? ts('Refresh results') : ts('View results'); | |
5083 | return $showResultsLabel; | |
5084 | } | |
5085 | ||
5086 | /** | |
5087 | * Determine the output mode from the url or input. | |
5088 | * | |
5089 | * Output could be | |
5090 | * - pdf : Render as pdf | |
5091 | * - csv : Render as csv | |
5092 | * - print : Render in print format | |
5093 | * - save : save the report and display the new report | |
5094 | * - copy : save the report as a new instance and display that. | |
5095 | * - group : go to the add to group screen. | |
5096 | * | |
5097 | * Potentially chart variations could also be included but the complexity | |
5098 | * is that we might print a bar chart as a pdf. | |
5099 | */ | |
5100 | protected function setOutputMode() { | |
1a7356e7 | 5101 | $this->_outputMode = str_replace('report_instance.', '', CRM_Utils_Request::retrieve( |
182f5081 | 5102 | 'output', |
5103 | 'String', | |
5104 | CRM_Core_DAO::$_nullObject, | |
5105 | FALSE, | |
5106 | CRM_Utils_Array::value('task', $this->_params) | |
44543184 | 5107 | )); |
7343d8a7 | 5108 | // if contacts are added to group |
5109 | if (!empty($this->_params['groups']) && empty($this->_outputMode)) { | |
5110 | $this->_outputMode = 'group'; | |
5111 | } | |
88fefc2f | 5112 | if (isset($this->_params['task'])) { |
5113 | unset($this->_params['task']); | |
5114 | } | |
182f5081 | 5115 | } |
5116 | ||
0fefbf7f | 5117 | /** |
ecf1e543 | 5118 | * CRM-17793 - Alter DateTime section header to group by date from the datetime field. |
3b6d61f2 | 5119 | * |
ecf1e543 | 5120 | * @param $tempTable |
5121 | * @param $columnName | |
5122 | */ | |
5123 | public function alterSectionHeaderForDateTime($tempTable, $columnName) { | |
0fefbf7f | 5124 | // add new column with date value for the datetime field |
ecf1e543 | 5125 | $tempQuery = "ALTER TABLE {$tempTable} ADD COLUMN {$columnName}_date VARCHAR(128)"; |
5126 | CRM_Core_DAO::executeQuery($tempQuery); | |
5127 | $updateQuery = "UPDATE {$tempTable} SET {$columnName}_date = date({$columnName})"; | |
5128 | CRM_Core_DAO::executeQuery($updateQuery); | |
b708c08d | 5129 | $this->_selectClauses[] = "{$columnName}_date"; |
ecf1e543 | 5130 | $this->_select .= ", {$columnName}_date"; |
5131 | $this->_sections["{$columnName}_date"] = $this->_sections["{$columnName}"]; | |
5132 | unset($this->_sections["{$columnName}"]); | |
5133 | $this->assign('sections', $this->_sections); | |
5134 | } | |
5135 | ||
55f71fa7 | 5136 | /** |
5137 | * Get an array of the columns that have been selected for display. | |
5138 | * | |
5139 | * @return array | |
5140 | */ | |
5141 | public function getSelectColumns() { | |
be2fb01f | 5142 | $selectColumns = []; |
55f71fa7 | 5143 | foreach ($this->_columns as $tableName => $table) { |
5144 | if (array_key_exists('fields', $table)) { | |
5145 | foreach ($table['fields'] as $fieldName => $field) { | |
5146 | if (!empty($field['required']) || | |
5147 | !empty($this->_params['fields'][$fieldName]) | |
5148 | ) { | |
5149 | ||
5150 | $selectColumns["{$tableName}_{$fieldName}"] = 1; | |
5151 | } | |
5152 | } | |
5153 | } | |
5154 | } | |
5155 | return $selectColumns; | |
5156 | } | |
5157 | ||
c160fde8 | 5158 | /** |
5159 | * Add location tables to the query if they are used for filtering. | |
5160 | * | |
5161 | * This is for when we are running the query separately for filtering and retrieving display fields. | |
5162 | */ | |
5163 | public function selectivelyAddLocationTablesJoinsToFilterQuery() { | |
5164 | if ($this->isTableFiltered('civicrm_email')) { | |
5165 | $this->_from .= " | |
5166 | LEFT JOIN civicrm_email {$this->_aliases['civicrm_email']} | |
5167 | ON {$this->_aliases['civicrm_contact']}.id = {$this->_aliases['civicrm_email']}.contact_id | |
5168 | AND {$this->_aliases['civicrm_email']}.is_primary = 1"; | |
5169 | } | |
5170 | if ($this->isTableFiltered('civicrm_phone')) { | |
5171 | $this->_from .= " | |
5172 | LEFT JOIN civicrm_phone {$this->_aliases['civicrm_phone']} | |
5173 | ON {$this->_aliases['civicrm_contact']}.id = {$this->_aliases['civicrm_phone']}.contact_id | |
5174 | AND {$this->_aliases['civicrm_phone']}.is_primary = 1"; | |
5175 | } | |
5176 | if ($this->isTableFiltered('civicrm_address')) { | |
5177 | $this->_from .= " | |
5178 | LEFT JOIN civicrm_address {$this->_aliases['civicrm_address']} | |
5179 | ON ({$this->_aliases['civicrm_contact']}.id = {$this->_aliases['civicrm_address']}.contact_id) | |
5180 | AND {$this->_aliases['civicrm_address']}.is_primary = 1\n"; | |
5181 | } | |
5182 | } | |
5183 | ||
43c1fa19 | 5184 | /** |
5185 | * Set the base table for the FROM clause. | |
5186 | * | |
5187 | * Sets up the from clause, allowing for the possibility it might be a | |
5188 | * temp table pre-filtered by groups if a group filter is in use. | |
5189 | * | |
5190 | * @param string $baseTable | |
5191 | * @param string $field | |
5192 | * @param null $tableAlias | |
5193 | */ | |
5194 | public function setFromBase($baseTable, $field = 'id', $tableAlias = NULL) { | |
5195 | if (!$tableAlias) { | |
5196 | $tableAlias = $this->_aliases[$baseTable]; | |
5197 | } | |
5198 | $this->_from = $this->_from = " FROM $baseTable $tableAlias "; | |
5199 | $this->joinGroupTempTable($baseTable, $field, $tableAlias); | |
5200 | $this->_from .= " {$this->_aclFrom} "; | |
5201 | } | |
5202 | ||
5203 | /** | |
5204 | * Join the temp table contacting contacts who are members of the filtered groups. | |
5205 | * | |
5206 | * If we are using an IN filter we use an inner join, otherwise a left join. | |
5207 | * | |
5208 | * @param string $baseTable | |
5209 | * @param string $field | |
5210 | * @param string $tableAlias | |
5211 | */ | |
5212 | public function joinGroupTempTable($baseTable, $field, $tableAlias) { | |
5213 | if ($this->groupTempTable) { | |
5214 | if ($this->_params['gid_op'] == 'in') { | |
5215 | $this->_from = " FROM $this->groupTempTable group_temp_table INNER JOIN $baseTable $tableAlias | |
5216 | ON group_temp_table.id = $tableAlias.{$field} "; | |
5217 | } | |
5218 | else { | |
5219 | $this->_from .= " | |
5220 | LEFT JOIN $this->groupTempTable group_temp_table | |
5221 | ON $tableAlias.{$field} = group_temp_table.id "; | |
5222 | } | |
5223 | } | |
5224 | } | |
5225 | ||
fa5fb88c | 5226 | /** |
a51858a1 | 5227 | * Get all labels for fields that are used in a group concat. |
fa5fb88c | 5228 | * |
a51858a1 E |
5229 | * @param string $options |
5230 | * comma separated option values. | |
5231 | * @param string $baoName | |
5232 | * The BAO name for the field. | |
5233 | * @param string $fieldName | |
5234 | * The name of the field for which labels should be retrieved. | |
5235 | * | |
5236 | * return string | |
fa5fb88c | 5237 | */ |
a51858a1 E |
5238 | public function getLabels($options, $baoName, $fieldName) { |
5239 | $types = explode(',', $options); | |
be2fb01f | 5240 | $labels = []; |
fa5fb88c | 5241 | foreach ($types as $value) { |
a51858a1 | 5242 | $labels[$value] = CRM_Core_PseudoConstant::getLabel($baoName, $fieldName, $value); |
fa5fb88c E |
5243 | } |
5244 | return implode(', ', array_filter($labels)); | |
5245 | } | |
5246 | ||
074dd766 | 5247 | /** |
0a01dff9 | 5248 | * Add statistics columns. |
5249 | * | |
5250 | * If a group by is in play then add columns for the statistics fields. | |
5251 | * | |
5252 | * This would lead to a new field in the $row such as $fieldName_sum and a new, matching | |
5253 | * column header field. | |
5254 | * | |
5255 | * @param array $field | |
5256 | * @param string $tableName | |
5257 | * @param string $fieldName | |
5258 | * @param array $select | |
5259 | * | |
5260 | * @return array | |
5261 | */ | |
5262 | protected function addStatisticsToSelect($field, $tableName, $fieldName, $select) { | |
5263 | foreach ($field['statistics'] as $stat => $label) { | |
5264 | $alias = "{$tableName}_{$fieldName}_{$stat}"; | |
5265 | switch (strtolower($stat)) { | |
5266 | case 'max': | |
5267 | case 'sum': | |
5268 | $select[] = "$stat({$field['dbAlias']}) as $alias"; | |
5269 | $this->_columnHeaders["{$tableName}_{$fieldName}_{$stat}"]['title'] = $label; | |
5270 | $this->_columnHeaders["{$tableName}_{$fieldName}_{$stat}"]['type'] = $field['type']; | |
5271 | $this->_statFields[$label] = $alias; | |
5272 | $this->_selectAliases[] = $alias; | |
5273 | break; | |
5274 | ||
5275 | case 'count': | |
5276 | $select[] = "COUNT({$field['dbAlias']}) as $alias"; | |
5277 | $this->_columnHeaders["{$tableName}_{$fieldName}_{$stat}"]['title'] = $label; | |
5278 | $this->_columnHeaders["{$tableName}_{$fieldName}_{$stat}"]['type'] = CRM_Utils_Type::T_INT; | |
5279 | $this->_statFields[$label] = $alias; | |
5280 | $this->_selectAliases[] = $alias; | |
5281 | break; | |
5282 | ||
5283 | case 'count_distinct': | |
5284 | $select[] = "COUNT(DISTINCT {$field['dbAlias']}) as $alias"; | |
5285 | $this->_columnHeaders["{$tableName}_{$fieldName}_{$stat}"]['title'] = $label; | |
5286 | $this->_columnHeaders["{$tableName}_{$fieldName}_{$stat}"]['type'] = CRM_Utils_Type::T_INT; | |
5287 | $this->_statFields[$label] = $alias; | |
5288 | $this->_selectAliases[] = $alias; | |
5289 | break; | |
5290 | ||
5291 | case 'avg': | |
5292 | $select[] = "ROUND(AVG({$field['dbAlias']}),2) as $alias"; | |
5293 | $this->_columnHeaders["{$tableName}_{$fieldName}_{$stat}"]['title'] = $label; | |
5294 | $this->_columnHeaders["{$tableName}_{$fieldName}_{$stat}"]['type'] = $field['type']; | |
5295 | $this->_statFields[$label] = $alias; | |
5296 | $this->_selectAliases[] = $alias; | |
5297 | break; | |
5298 | } | |
5299 | } | |
5300 | return $select; | |
5301 | } | |
5302 | ||
5303 | /** | |
5304 | * Add a basic field to the select clause. | |
5305 | * | |
5306 | * @param string $tableName | |
5307 | * @param string $fieldName | |
5308 | * @param array $field | |
5309 | * @param string $select | |
5310 | * @return array | |
5311 | */ | |
5312 | protected function addBasicFieldToSelect($tableName, $fieldName, $field, $select) { | |
5313 | $alias = "{$tableName}_{$fieldName}"; | |
5314 | $select[] = "{$field['dbAlias']} as $alias"; | |
5315 | $this->_columnHeaders["{$tableName}_{$fieldName}"]['title'] = CRM_Utils_Array::value('title', $field); | |
5316 | $this->_columnHeaders["{$tableName}_{$fieldName}"]['type'] = CRM_Utils_Array::value('type', $field); | |
5317 | $this->_selectAliases[] = $alias; | |
5318 | return $select; | |
5319 | } | |
5320 | ||
8bb36676 | 5321 | /** |
5322 | * Set table alias. | |
5323 | * | |
5324 | * @param array $table | |
5325 | * @param string $tableName | |
5326 | * | |
5327 | * @return string | |
5328 | * Alias for table. | |
5329 | */ | |
5330 | protected function setTableAlias($table, $tableName) { | |
5331 | if (!isset($table['alias'])) { | |
5332 | $this->_columns[$tableName]['alias'] = substr($tableName, 8) . | |
5333 | '_civireport'; | |
5334 | } | |
5335 | else { | |
5336 | $this->_columns[$tableName]['alias'] = $table['alias'] . '_civireport'; | |
5337 | } | |
5338 | ||
5339 | $this->_aliases[$tableName] = $this->_columns[$tableName]['alias']; | |
5340 | return $this->_aliases[$tableName]; | |
5341 | } | |
5342 | ||
d7e34fc6 | 5343 | /** |
5344 | * Function to add columns to reports. | |
5345 | * | |
5346 | * This is ported from extended reports, which also adds join filters to the options. | |
5347 | * | |
5348 | * @param string $type | |
5349 | * @param array $options | |
5350 | * - prefix - A string to prepend to the table name | |
5351 | * - prefix_label A string to prepend to the fields | |
5352 | * - fields (bool) - should the fields for this table be made available | |
5353 | * - group_by (bool) - should the group bys for this table be made available. | |
5354 | * - order_by (bool) - should the group bys for this table be made available. | |
5355 | * - filters (bool) - should the filters for this table by made available. | |
5356 | * - fields_defaults (array) array of fields that should be displayed by default. | |
5357 | * - filters_defaults (array) array of fields that should be filtered by default. | |
5358 | * - join_filters (array) fields available for filtering joins (requires additional custom code). | |
5359 | * - join_fields (array) fields available from join (requires additional custom code). | |
5360 | * - group_by_defaults (array) array of group bys that should be applied by default. | |
5361 | * - order_by_defaults (array) array of order bys that should be applied by default. | |
5362 | * - custom_fields (array) array of entity types for custom fields (not usually required). | |
5363 | * - contact_type (string) optional restriction on contact type for some tables. | |
5364 | * - fields_excluded (array) fields that are in the generic set for the table but not in the report. | |
5365 | * | |
5366 | * @return array | |
5367 | */ | |
be2fb01f CW |
5368 | protected function getColumns($type, $options = []) { |
5369 | $defaultOptions = [ | |
d7e34fc6 | 5370 | 'prefix' => '', |
5371 | 'prefix_label' => '', | |
5372 | 'fields' => TRUE, | |
5373 | 'group_bys' => FALSE, | |
5374 | 'order_bys' => TRUE, | |
5375 | 'filters' => TRUE, | |
5376 | 'join_filters' => FALSE, | |
be2fb01f CW |
5377 | 'fields_defaults' => [], |
5378 | 'filters_defaults' => [], | |
5379 | 'group_bys_defaults' => [], | |
5380 | 'order_bys_defaults' => [], | |
5381 | ]; | |
d7e34fc6 | 5382 | $options = array_merge($defaultOptions, $options); |
5383 | ||
5384 | $fn = 'get' . $type . 'Columns'; | |
5385 | return $this->$fn($options); | |
5386 | } | |
5387 | ||
5388 | /** | |
5389 | * Get columns for contact table. | |
5390 | * | |
5391 | * @param array $options | |
5392 | * | |
5393 | * @return array | |
5394 | */ | |
be2fb01f CW |
5395 | protected function getContactColumns($options = []) { |
5396 | $defaultOptions = [ | |
5397 | 'custom_fields' => ['Individual', 'Contact', 'Organization'], | |
5398 | 'fields_defaults' => ['display_name', 'id'], | |
5399 | 'order_bys_defaults' => ['sort_name ASC'], | |
d7e34fc6 | 5400 | 'contact_type' => NULL, |
be2fb01f | 5401 | ]; |
d7e34fc6 | 5402 | |
5403 | $options = array_merge($defaultOptions, $options); | |
5404 | ||
5405 | $tableAlias = $options['prefix'] . 'contact'; | |
5406 | ||
be2fb01f CW |
5407 | $spec = [ |
5408 | $options['prefix'] . 'display_name' => [ | |
d7e34fc6 | 5409 | 'name' => 'display_name', |
c576cb65 | 5410 | 'title' => $options['prefix_label'] . ts('Contact Name'), |
d7e34fc6 | 5411 | 'is_fields' => TRUE, |
be2fb01f CW |
5412 | ], |
5413 | $options['prefix'] . 'sort_name' => [ | |
d7e34fc6 | 5414 | 'name' => 'sort_name', |
c576cb65 | 5415 | 'title' => $options['prefix_label'] . ts('Contact Name (in sort format)'), |
d7e34fc6 | 5416 | 'is_fields' => TRUE, |
5417 | 'is_filters' => TRUE, | |
5418 | 'is_order_bys' => TRUE, | |
be2fb01f CW |
5419 | ], |
5420 | $options['prefix'] . 'id' => [ | |
d7e34fc6 | 5421 | 'name' => 'id', |
c576cb65 | 5422 | 'title' => $options['prefix_label'] . ts('Contact ID'), |
d7e34fc6 | 5423 | 'alter_display' => 'alterContactID', |
5424 | 'type' => CRM_Utils_Type::T_INT, | |
5425 | 'is_order_bys' => TRUE, | |
5426 | 'is_group_bys' => TRUE, | |
5427 | 'is_fields' => TRUE, | |
bad366ab | 5428 | 'is_filters' => TRUE, |
be2fb01f CW |
5429 | ], |
5430 | $options['prefix'] . 'external_identifier' => [ | |
d7e34fc6 | 5431 | 'name' => 'external_identifier', |
c576cb65 | 5432 | 'title' => $options['prefix_label'] . ts('External ID'), |
d7e34fc6 | 5433 | 'type' => CRM_Utils_Type::T_INT, |
5434 | 'is_fields' => TRUE, | |
be2fb01f CW |
5435 | ], |
5436 | $options['prefix'] . 'contact_type' => [ | |
c576cb65 | 5437 | 'title' => $options['prefix_label'] . ts('Contact Type'), |
d7e34fc6 | 5438 | 'name' => 'contact_type', |
5439 | 'operatorType' => CRM_Report_Form::OP_MULTISELECT, | |
5440 | 'options' => CRM_Contact_BAO_Contact::buildOptions('contact_type'), | |
5441 | 'is_fields' => TRUE, | |
5442 | 'is_filters' => TRUE, | |
5443 | 'is_group_bys' => TRUE, | |
be2fb01f CW |
5444 | ], |
5445 | $options['prefix'] . 'contact_sub_type' => [ | |
c576cb65 | 5446 | 'title' => $options['prefix_label'] . ts('Contact Sub Type'), |
d7e34fc6 | 5447 | 'name' => 'contact_sub_type', |
5448 | 'operatorType' => CRM_Report_Form::OP_MULTISELECT, | |
5449 | 'options' => CRM_Contact_BAO_Contact::buildOptions('contact_sub_type'), | |
5450 | 'is_fields' => TRUE, | |
5451 | 'is_filters' => TRUE, | |
5452 | 'is_group_bys' => TRUE, | |
be2fb01f CW |
5453 | ], |
5454 | $options['prefix'] . 'is_deleted' => [ | |
c576cb65 | 5455 | 'title' => $options['prefix_label'] . ts('Is deleted'), |
d7e34fc6 | 5456 | 'name' => 'is_deleted', |
5457 | 'type' => CRM_Utils_Type::T_BOOLEAN, | |
5458 | 'is_fields' => FALSE, | |
5459 | 'is_filters' => TRUE, | |
5460 | 'is_group_bys' => FALSE, | |
be2fb01f CW |
5461 | ], |
5462 | $options['prefix'] . 'external_identifier' => [ | |
7777f433 JG |
5463 | 'title' => $options['prefix_label'] . ts('Contact identifier from external system'), |
5464 | 'name' => 'external_identifier', | |
5465 | 'is_fields' => TRUE, | |
5466 | 'is_filters' => FALSE, | |
5467 | 'is_group_bys' => FALSE, | |
5468 | 'is_order_bys' => TRUE, | |
be2fb01f CW |
5469 | ], |
5470 | $options['prefix'] . 'preferred_language' => [ | |
7777f433 JG |
5471 | 'title' => $options['prefix_label'] . ts('Preferred Language'), |
5472 | 'name' => 'preferred_language', | |
5473 | 'is_fields' => TRUE, | |
5474 | 'is_filters' => TRUE, | |
5475 | 'is_group_bys' => TRUE, | |
5476 | 'is_order_bys' => TRUE, | |
be2fb01f CW |
5477 | ], |
5478 | ]; | |
7777f433 JG |
5479 | foreach ([ |
5480 | 'postal_greeting_display' => 'Postal Greeting', | |
5481 | 'email_greeting_display' => 'Email Greeting', | |
5482 | 'addressee_display' => 'Addressee', | |
5483 | ] as $field => $title) { | |
be2fb01f | 5484 | $spec[$options['prefix'] . $field] = [ |
7777f433 JG |
5485 | 'title' => $options['prefix_label'] . ts($title), |
5486 | 'name' => $field, | |
5487 | 'is_fields' => TRUE, | |
5488 | 'is_filters' => FALSE, | |
5489 | 'is_group_bys' => FALSE, | |
be2fb01f | 5490 | ]; |
7777f433 JG |
5491 | } |
5492 | foreach (['do_not_email', 'do_not_phone', 'do_not_mail', 'do_not_sms', 'is_opt_out'] as $field) { | |
5493 | $spec[$options['prefix'] . $field] = [ | |
5494 | 'name' => $field, | |
5495 | 'type' => CRM_Utils_Type::T_BOOLEAN, | |
5496 | 'is_fields' => TRUE, | |
5497 | 'is_filters' => TRUE, | |
5498 | 'is_group_bys' => FALSE, | |
5499 | ]; | |
5500 | } | |
be2fb01f CW |
5501 | $individualFields = [ |
5502 | $options['prefix'] . 'first_name' => [ | |
d7e34fc6 | 5503 | 'name' => 'first_name', |
c576cb65 | 5504 | 'title' => $options['prefix_label'] . ts('First Name'), |
d7e34fc6 | 5505 | 'is_fields' => TRUE, |
5506 | 'is_filters' => TRUE, | |
5507 | 'is_order_bys' => TRUE, | |
be2fb01f CW |
5508 | ], |
5509 | $options['prefix'] . 'middle_name' => [ | |
d7e34fc6 | 5510 | 'name' => 'middle_name', |
c576cb65 | 5511 | 'title' => $options['prefix_label'] . ts('Middle Name'), |
d7e34fc6 | 5512 | 'is_fields' => TRUE, |
be2fb01f CW |
5513 | ], |
5514 | $options['prefix'] . 'last_name' => [ | |
d7e34fc6 | 5515 | 'name' => 'last_name', |
c576cb65 | 5516 | 'title' => $options['prefix_label'] . ts('Last Name'), |
d7e34fc6 | 5517 | 'default_order' => 'ASC', |
5518 | 'is_fields' => TRUE, | |
be2fb01f CW |
5519 | ], |
5520 | $options['prefix'] . 'nick_name' => [ | |
d7e34fc6 | 5521 | 'name' => 'nick_name', |
c576cb65 | 5522 | 'title' => $options['prefix_label'] . ts('Nick Name'), |
d7e34fc6 | 5523 | 'is_fields' => TRUE, |
be2fb01f CW |
5524 | ], |
5525 | $options['prefix'] . 'prefix_id' => [ | |
c5185dd8 | 5526 | 'name' => 'prefix_id', |
5527 | 'title' => $options['prefix_label'] . ts('Prefix'), | |
5528 | 'options' => CRM_Contact_BAO_Contact::buildOptions('prefix_id'), | |
5529 | 'operatorType' => CRM_Report_Form::OP_MULTISELECT, | |
5530 | 'is_fields' => TRUE, | |
5531 | 'is_filters' => TRUE, | |
be2fb01f CW |
5532 | ], |
5533 | $options['prefix'] . 'suffix_id' => [ | |
c5185dd8 | 5534 | 'name' => 'suffix_id', |
5535 | 'title' => $options['prefix_label'] . ts('Suffix'), | |
5536 | 'options' => CRM_Contact_BAO_Contact::buildOptions('suffix_id'), | |
5537 | 'operatorType' => CRM_Report_Form::OP_MULTISELECT, | |
5538 | 'is_fields' => TRUE, | |
5539 | 'is_filters' => TRUE, | |
be2fb01f CW |
5540 | ], |
5541 | $options['prefix'] . 'gender_id' => [ | |
d7e34fc6 | 5542 | 'name' => 'gender_id', |
c576cb65 | 5543 | 'title' => $options['prefix_label'] . ts('Gender'), |
d7e34fc6 | 5544 | 'options' => CRM_Contact_BAO_Contact::buildOptions('gender_id'), |
5545 | 'operatorType' => CRM_Report_Form::OP_MULTISELECT, | |
d7e34fc6 | 5546 | 'is_fields' => TRUE, |
5547 | 'is_filters' => TRUE, | |
be2fb01f CW |
5548 | ], |
5549 | 'birth_date' => [ | |
c576cb65 | 5550 | 'title' => $options['prefix_label'] . ts('Birth Date'), |
d7e34fc6 | 5551 | 'operatorType' => CRM_Report_Form::OP_DATE, |
5552 | 'type' => CRM_Utils_Type::T_DATE, | |
5553 | 'is_fields' => TRUE, | |
5554 | 'is_filters' => TRUE, | |
be2fb01f CW |
5555 | ], |
5556 | 'age' => [ | |
c576cb65 | 5557 | 'title' => $options['prefix_label'] . ts('Age'), |
75344f5f | 5558 | 'dbAlias' => 'TIMESTAMPDIFF(YEAR, ' . $tableAlias . '_civireport.birth_date, CURDATE())', |
d7e34fc6 | 5559 | 'type' => CRM_Utils_Type::T_INT, |
5560 | 'is_fields' => TRUE, | |
be2fb01f CW |
5561 | ], |
5562 | $options['prefix'] . 'is_deceased' => [ | |
c576cb65 | 5563 | 'title' => $options['prefix_label'] . ts('Is deceased'), |
d7e34fc6 | 5564 | 'name' => 'is_deceased', |
5565 | 'type' => CRM_Utils_Type::T_BOOLEAN, | |
5566 | 'is_fields' => FALSE, | |
5567 | 'is_filters' => TRUE, | |
5568 | 'is_group_bys' => FALSE, | |
be2fb01f CW |
5569 | ], |
5570 | $options['prefix'] . 'job_title' => [ | |
7777f433 JG |
5571 | 'name' => 'job_title', |
5572 | 'is_fields' => TRUE, | |
5573 | 'is_filters' => FALSE, | |
5574 | 'is_group_bys' => FALSE, | |
be2fb01f CW |
5575 | ], |
5576 | $options['prefix'] . 'employer_id' => [ | |
7777f433 JG |
5577 | 'title' => $options['prefix_label'] . ts('Current Employer'), |
5578 | 'type' => CRM_Utils_Type::T_INT, | |
5579 | 'name' => 'employer_id', | |
5580 | 'is_fields' => TRUE, | |
5581 | 'is_filters' => FALSE, | |
5582 | 'is_group_bys' => TRUE, | |
be2fb01f CW |
5583 | ], |
5584 | ]; | |
d7e34fc6 | 5585 | if (!$options['contact_type'] || $options['contact_type'] === 'Individual') { |
5586 | $spec = array_merge($spec, $individualFields); | |
5587 | } | |
5588 | ||
5589 | if (!empty($options['custom_fields'])) { | |
be2fb01f | 5590 | $this->_customGroupExtended[$options['prefix'] . 'civicrm_contact'] = [ |
d7e34fc6 | 5591 | 'extends' => $options['custom_fields'], |
5592 | 'title' => $options['prefix_label'], | |
5593 | 'filters' => $options['filters'], | |
5594 | 'prefix' => $options['prefix'], | |
5595 | 'prefix_label' => $options['prefix_label'], | |
be2fb01f | 5596 | ]; |
d7e34fc6 | 5597 | } |
5598 | ||
5599 | return $this->buildColumns($spec, $options['prefix'] . 'civicrm_contact', 'CRM_Contact_DAO_Contact', $tableAlias, $this->getDefaultsFromOptions($options), $options); | |
5600 | } | |
5601 | ||
59b19369 JJ |
5602 | /** |
5603 | * Get address columns to add to array. | |
5604 | * | |
5605 | * @param array $options | |
5606 | * - prefix Prefix to add to table (in case of more than one instance of the table) | |
5607 | * - prefix_label Label to give columns from this address table instance | |
5608 | * - group_bys enable these fields for group by - default false | |
5609 | * - order_bys enable these fields for order by | |
5610 | * - filters enable these fields for filtering | |
5611 | * | |
5612 | * @return array address columns definition | |
5613 | */ | |
be2fb01f CW |
5614 | protected function getAddressColumns($options = []) { |
5615 | $defaultOptions = [ | |
59b19369 JJ |
5616 | 'prefix' => '', |
5617 | 'prefix_label' => '', | |
5618 | 'fields' => TRUE, | |
5619 | 'group_bys' => FALSE, | |
5620 | 'order_bys' => TRUE, | |
5621 | 'filters' => TRUE, | |
5622 | 'join_filters' => FALSE, | |
be2fb01f CW |
5623 | 'fields_defaults' => [], |
5624 | 'filters_defaults' => [], | |
5625 | 'group_bys_defaults' => [], | |
5626 | 'order_bys_defaults' => [], | |
5627 | ]; | |
59b19369 JJ |
5628 | |
5629 | $options = array_merge($defaultOptions, $options); | |
5630 | $defaults = $this->getDefaultsFromOptions($options); | |
5631 | $tableAlias = $options['prefix'] . 'address'; | |
5632 | ||
be2fb01f CW |
5633 | $spec = [ |
5634 | $options['prefix'] . 'name' => [ | |
59b19369 JJ |
5635 | 'title' => ts($options['prefix_label'] . 'Address Name'), |
5636 | 'name' => 'name', | |
5637 | 'is_fields' => TRUE, | |
be2fb01f CW |
5638 | ], |
5639 | $options['prefix'] . 'street_number' => [ | |
59b19369 JJ |
5640 | 'name' => 'street_number', |
5641 | 'title' => ts($options['prefix_label'] . 'Street Number'), | |
5642 | 'type' => 1, | |
5643 | 'is_fields' => TRUE, | |
be2fb01f CW |
5644 | ], |
5645 | $options['prefix'] . 'odd_street_number' => [ | |
8fc33241 | 5646 | 'title' => ts('Odd / Even Street Number'), |
5647 | 'name' => 'odd_street_number', | |
5648 | 'type' => CRM_Utils_Type::T_INT, | |
5649 | 'no_display' => TRUE, | |
5650 | 'required' => TRUE, | |
38a85cdd | 5651 | 'dbAlias' => "({$tableAlias}_civireport.street_number % 2)", |
8fc33241 | 5652 | 'is_fields' => TRUE, |
5653 | 'is_order_bys' => TRUE, | |
be2fb01f CW |
5654 | ], |
5655 | $options['prefix'] . 'street_name' => [ | |
59b19369 JJ |
5656 | 'name' => 'street_name', |
5657 | 'title' => ts($options['prefix_label'] . 'Street Name'), | |
5658 | 'type' => 1, | |
5659 | 'is_fields' => TRUE, | |
5660 | 'is_filters' => TRUE, | |
5661 | 'operator' => 'like', | |
5662 | 'is_order_bys' => TRUE, | |
be2fb01f CW |
5663 | ], |
5664 | $options['prefix'] . 'street_address' => [ | |
59b19369 JJ |
5665 | 'title' => ts($options['prefix_label'] . 'Street Address'), |
5666 | 'name' => 'street_address', | |
5667 | 'is_fields' => TRUE, | |
5668 | 'is_filters' => TRUE, | |
5669 | 'is_group_bys' => TRUE, | |
be2fb01f CW |
5670 | ], |
5671 | $options['prefix'] . 'supplemental_address_1' => [ | |
59b19369 JJ |
5672 | 'title' => ts($options['prefix_label'] . 'Supplementary Address Field 1'), |
5673 | 'name' => 'supplemental_address_1', | |
5674 | 'is_fields' => TRUE, | |
be2fb01f CW |
5675 | ], |
5676 | $options['prefix'] . 'supplemental_address_2' => [ | |
59b19369 JJ |
5677 | 'title' => ts($options['prefix_label'] . 'Supplementary Address Field 2'), |
5678 | 'name' => 'supplemental_address_2', | |
5679 | 'is_fields' => TRUE, | |
be2fb01f CW |
5680 | ], |
5681 | $options['prefix'] . 'supplemental_address_3' => [ | |
59b19369 JJ |
5682 | 'title' => ts($options['prefix_label'] . 'Supplementary Address Field 3'), |
5683 | 'name' => 'supplemental_address_3', | |
5684 | 'is_fields' => TRUE, | |
be2fb01f CW |
5685 | ], |
5686 | $options['prefix'] . 'street_number' => [ | |
59b19369 JJ |
5687 | 'name' => 'street_number', |
5688 | 'title' => ts($options['prefix_label'] . 'Street Number'), | |
5689 | 'type' => 1, | |
5690 | 'is_order_bys' => TRUE, | |
5691 | 'is_filters' => TRUE, | |
5692 | 'is_fields' => TRUE, | |
be2fb01f CW |
5693 | ], |
5694 | $options['prefix'] . 'street_unit' => [ | |
59b19369 JJ |
5695 | 'name' => 'street_unit', |
5696 | 'title' => ts($options['prefix_label'] . 'Street Unit'), | |
5697 | 'type' => 1, | |
5698 | 'is_fields' => TRUE, | |
be2fb01f CW |
5699 | ], |
5700 | $options['prefix'] . 'city' => [ | |
59b19369 JJ |
5701 | 'title' => ts($options['prefix_label'] . 'City'), |
5702 | 'name' => 'city', | |
5703 | 'operator' => 'like', | |
5704 | 'is_fields' => TRUE, | |
5705 | 'is_filters' => TRUE, | |
5706 | 'is_group_bys' => TRUE, | |
5707 | 'is_order_bys' => TRUE, | |
be2fb01f CW |
5708 | ], |
5709 | $options['prefix'] . 'postal_code' => [ | |
59b19369 JJ |
5710 | 'title' => ts($options['prefix_label'] . 'Postal Code'), |
5711 | 'name' => 'postal_code', | |
5712 | 'type' => 1, | |
5713 | 'is_fields' => TRUE, | |
5714 | 'is_filters' => TRUE, | |
5715 | 'is_group_bys' => TRUE, | |
5716 | 'is_order_bys' => TRUE, | |
be2fb01f CW |
5717 | ], |
5718 | $options['prefix'] . 'postal_code_suffix' => [ | |
59b19369 JJ |
5719 | 'title' => ts($options['prefix_label'] . 'Postal Code Suffix'), |
5720 | 'name' => 'postal_code', | |
5721 | 'type' => 1, | |
5722 | 'is_fields' => TRUE, | |
5723 | 'is_filters' => TRUE, | |
5724 | 'is_group_bys' => TRUE, | |
5725 | 'is_order_bys' => TRUE, | |
be2fb01f CW |
5726 | ], |
5727 | $options['prefix'] . 'county_id' => [ | |
59b19369 JJ |
5728 | 'title' => ts($options['prefix_label'] . 'County'), |
5729 | 'alter_display' => 'alterCountyID', | |
5730 | 'name' => 'county_id', | |
5731 | 'type' => CRM_Utils_Type::T_INT, | |
5732 | 'operatorType' => CRM_Report_Form::OP_MULTISELECT, | |
5733 | 'options' => CRM_Core_PseudoConstant::county(), | |
5734 | 'is_fields' => TRUE, | |
5735 | 'is_filters' => TRUE, | |
5736 | 'is_group_bys' => TRUE, | |
be2fb01f CW |
5737 | ], |
5738 | $options['prefix'] . 'state_province_id' => [ | |
59b19369 JJ |
5739 | 'title' => ts($options['prefix_label'] . 'State/Province'), |
5740 | 'alter_display' => 'alterStateProvinceID', | |
5741 | 'name' => 'state_province_id', | |
5742 | 'type' => CRM_Utils_Type::T_INT, | |
5743 | 'operatorType' => CRM_Report_Form::OP_MULTISELECT, | |
5744 | 'options' => CRM_Core_PseudoConstant::stateProvince(), | |
5745 | 'is_fields' => TRUE, | |
5746 | 'is_filters' => TRUE, | |
5747 | 'is_group_bys' => TRUE, | |
be2fb01f CW |
5748 | ], |
5749 | $options['prefix'] . 'country_id' => [ | |
59b19369 JJ |
5750 | 'title' => ts($options['prefix_label'] . 'Country'), |
5751 | 'alter_display' => 'alterCountryID', | |
5752 | 'name' => 'country_id', | |
5753 | 'is_fields' => TRUE, | |
5754 | 'is_filters' => TRUE, | |
5755 | 'is_group_bys' => TRUE, | |
5756 | 'type' => CRM_Utils_Type::T_INT, | |
5757 | 'operatorType' => CRM_Report_Form::OP_MULTISELECT, | |
5758 | 'options' => CRM_Core_PseudoConstant::country(), | |
be2fb01f CW |
5759 | ], |
5760 | $options['prefix'] . 'location_type_id' => [ | |
59b19369 JJ |
5761 | 'name' => 'is_primary', |
5762 | 'title' => ts($options['prefix_label'] . 'Location Type'), | |
5763 | 'type' => CRM_Utils_Type::T_INT, | |
5764 | 'is_fields' => TRUE, | |
5765 | 'alter_display' => 'alterLocationTypeID', | |
be2fb01f CW |
5766 | ], |
5767 | $options['prefix'] . 'id' => [ | |
59b19369 JJ |
5768 | 'title' => ts($options['prefix_label'] . 'ID'), |
5769 | 'name' => 'id', | |
5770 | 'is_fields' => TRUE, | |
be2fb01f CW |
5771 | ], |
5772 | $options['prefix'] . 'is_primary' => [ | |
59b19369 JJ |
5773 | 'name' => 'is_primary', |
5774 | 'title' => ts($options['prefix_label'] . 'Primary Address?'), | |
5775 | 'type' => CRM_Utils_Type::T_BOOLEAN, | |
5776 | 'is_fields' => TRUE, | |
be2fb01f CW |
5777 | ], |
5778 | ]; | |
59b19369 JJ |
5779 | return $this->buildColumns($spec, $options['prefix'] . 'civicrm_address', 'CRM_Core_DAO_Address', $tableAlias, $defaults, $options); |
5780 | } | |
5781 | ||
d7e34fc6 | 5782 | /** |
5783 | * Build the columns. | |
5784 | * | |
5785 | * The normal report class needs you to remember to do a few things that are often erratic | |
5786 | * | |
5787 | * 1) use a unique key for any field that might not be unique (e.g. start date, label) | |
5788 | * - this class will prepend an alias to the key & set the 'name' if you don't set it yourself. | |
5789 | * You can suppress the alias with 'no_field_disambiguation' if transitioning existing reports. This | |
5790 | * means any saved filters / fields on saved report instances. This will mean that matching names from | |
5791 | * different tables may be ambigious, but it will smooth any code transition. | |
5792 | * - note that it assumes the value being passed in is the actual table field name | |
5793 | * | |
5794 | * 2) set the field & set it to no display if you don't want the field but you might want to use the field in other | |
5795 | * contexts - the code looks up the fields array for data - so it both defines the field spec & the fields you want to show | |
5796 | * | |
5797 | * 3) this function also sets the 'metadata' array - the extended report class now uses this in place | |
5798 | * of the fields array to reduce the issues caused when metadata is needed but 'fields' are not defined. Code in | |
5799 | * the core classes can start to move towards that. | |
5800 | * | |
5801 | * @param array $specs | |
5802 | * @param string $tableName | |
5803 | * @param string $daoName | |
5804 | * @param string $tableAlias | |
5805 | * @param array $defaults | |
5806 | * @param array $options | |
5807 | * | |
5808 | * @return array | |
5809 | */ | |
be2fb01f | 5810 | protected function buildColumns($specs, $tableName, $daoName = NULL, $tableAlias = NULL, $defaults = [], $options = []) { |
d7e34fc6 | 5811 | if (!$tableAlias) { |
5812 | $tableAlias = str_replace('civicrm_', '', $tableName); | |
5813 | } | |
be2fb01f CW |
5814 | $types = ['filters', 'group_bys', 'order_bys', 'join_filters']; |
5815 | $columns = [$tableName => array_fill_keys($types, [])]; | |
d7e34fc6 | 5816 | // The code that uses this no longer cares if it is a DAO or BAO so just call it a DAO. |
5817 | $columns[$tableName]['dao'] = $daoName; | |
5818 | $columns[$tableName]['alias'] = $tableAlias; | |
5819 | ||
5820 | foreach ($specs as $specName => $spec) { | |
5821 | if (empty($spec['name'])) { | |
5822 | $spec['name'] = $specName; | |
5823 | } | |
5824 | ||
5825 | $fieldAlias = (empty($options['no_field_disambiguation']) ? $tableAlias . '_' : '') . $specName; | |
5826 | $columns[$tableName]['metadata'][$fieldAlias] = $spec; | |
5827 | $columns[$tableName]['fields'][$fieldAlias] = $spec; | |
5828 | if (isset($defaults['fields_defaults']) && in_array($spec['name'], $defaults['fields_defaults'])) { | |
5829 | $columns[$tableName]['fields'][$fieldAlias]['default'] = TRUE; | |
5830 | } | |
5831 | ||
5832 | if (!$spec['is_fields'] || (isset($options['fields_excluded']) && in_array($specName, $options['fields_excluded']))) { | |
5833 | $columns[$tableName]['fields'][$fieldAlias]['no_display'] = TRUE; | |
5834 | } | |
5835 | ||
5836 | if (isset($options['fields_required']) && in_array($specName, $options['fields_required'])) { | |
5837 | $columns[$tableName]['fields'][$fieldAlias]['required'] = TRUE; | |
5838 | } | |
5839 | ||
5840 | foreach ($types as $type) { | |
5841 | if ($options[$type] && !empty($spec['is_' . $type])) { | |
5842 | $columns[$tableName][$type][$fieldAlias] = $spec; | |
5843 | if (isset($defaults[$type . '_defaults']) && isset($defaults[$type . '_defaults'][$spec['name']])) { | |
5844 | $columns[$tableName][$type][$fieldAlias]['default'] = $defaults[$type . '_defaults'][$spec['name']]; | |
5845 | } | |
5846 | } | |
5847 | } | |
5848 | } | |
5849 | return $columns; | |
5850 | } | |
5851 | ||
534c4d20 | 5852 | /** |
5853 | * Store group bys into array - so we can check elsewhere what is grouped. | |
5854 | */ | |
5855 | protected function storeGroupByArray() { | |
5856 | ||
c3fdd2b7 | 5857 | if (!CRM_Utils_Array::value('group_bys', $this->_params) |
5858 | || !is_array($this->_params['group_bys'])) { | |
5859 | $this->_params['group_bys'] = []; | |
5860 | } | |
534c4d20 | 5861 | |
c3fdd2b7 | 5862 | foreach ($this->_columns as $tableName => $table) { |
5863 | $table = $this->_columns[$tableName]; | |
5864 | if (array_key_exists('group_bys', $table)) { | |
5865 | foreach ($table['group_bys'] as $fieldName => $fieldData) { | |
5866 | $field = $this->_columns[$tableName]['metadata'][$fieldName]; | |
5867 | if (!empty($this->_params['group_bys'][$fieldName]) || !empty($fieldData['required'])) { | |
5868 | if (!empty($field['chart'])) { | |
5869 | $this->assign('chartSupported', TRUE); | |
5870 | } | |
534c4d20 | 5871 | |
c3fdd2b7 | 5872 | if (!empty($table['group_bys'][$fieldName]['frequency']) && |
5873 | !empty($this->_params['group_bys_freq'][$fieldName]) | |
5874 | ) { | |
534c4d20 | 5875 | |
c3fdd2b7 | 5876 | switch ($this->_params['group_bys_freq'][$fieldName]) { |
5877 | case 'FISCALYEAR': | |
5878 | $this->_groupByArray[$tableName . '_' . $fieldName . '_start'] = self::fiscalYearOffset($field['dbAlias']); | |
534c4d20 | 5879 | |
c3fdd2b7 | 5880 | case 'YEAR': |
5881 | $this->_groupByArray[$tableName . '_' . $fieldName . '_start'] = " {$this->_params['group_bys_freq'][$fieldName]}({$field['dbAlias']})"; | |
5882 | ||
5883 | default: | |
5884 | $this->_groupByArray[$tableName . '_' . $fieldName . '_start'] = "EXTRACT(YEAR_{$this->_params['group_bys_freq'][$fieldName]} FROM {$field['dbAlias']})"; | |
534c4d20 | 5885 | |
534c4d20 | 5886 | } |
c3fdd2b7 | 5887 | } |
5888 | else { | |
5889 | if (!in_array($field['dbAlias'], $this->_groupByArray)) { | |
5890 | $this->_groupByArray[$tableName . '_' . $fieldName] = $field['dbAlias']; | |
534c4d20 | 5891 | } |
5892 | } | |
5893 | } | |
534c4d20 | 5894 | } |
c3fdd2b7 | 5895 | |
534c4d20 | 5896 | } |
5897 | } | |
5898 | } | |
5899 | ||
d7e34fc6 | 5900 | /** |
5901 | * @param $options | |
5902 | * | |
5903 | * @return array | |
5904 | */ | |
5905 | protected function getDefaultsFromOptions($options) { | |
be2fb01f | 5906 | $defaults = [ |
d7e34fc6 | 5907 | 'fields_defaults' => $options['fields_defaults'], |
5908 | 'filters_defaults' => $options['filters_defaults'], | |
5909 | 'group_bys_defaults' => $options['group_bys_defaults'], | |
5910 | 'order_bys_defaults' => $options['order_bys_defaults'], | |
be2fb01f | 5911 | ]; |
d7e34fc6 | 5912 | return $defaults; |
5913 | } | |
5914 | ||
81a22d3d | 5915 | /** |
5916 | * Get the select clause for a field, wrapping in GROUP_CONCAT if appropriate. | |
5917 | * | |
5918 | * Full group by mode dictates that a field must either be in the group by function or | |
5919 | * wrapped in a aggregate function. Here we wrap the field in GROUP_CONCAT if it is not in the | |
5920 | * group concat. | |
5921 | * | |
5922 | * @param string $tableName | |
5923 | * @param string $fieldName | |
5924 | * @param string $field | |
5925 | * @return string | |
5926 | */ | |
5927 | protected function getSelectClauseWithGroupConcatIfNotGroupedBy($tableName, &$fieldName, &$field) { | |
5928 | if ($this->groupConcatTested && (!empty($this->_groupByArray) || $this->isForceGroupBy)) { | |
5929 | if ((empty($field['statistics']) || in_array('GROUP_CONCAT', $field['statistics']))) { | |
5930 | $label = CRM_Utils_Array::value('title', $field); | |
5931 | $alias = "{$tableName}_{$fieldName}"; | |
5932 | $this->_columnHeaders["{$tableName}_{$fieldName}"]['title'] = $label; | |
5933 | $this->_selectAliases[] = $alias; | |
5934 | if (empty($this->_groupByArray[$tableName . '_' . $fieldName])) { | |
5935 | return "GROUP_CONCAT(DISTINCT {$field['dbAlias']}) as $alias"; | |
5936 | } | |
5937 | return "({$field['dbAlias']}) as $alias"; | |
5938 | } | |
5939 | } | |
5940 | } | |
5941 | ||
62491db8 | 5942 | /** |
5943 | * Generate clause for the selected filter. | |
5944 | * | |
5945 | * @param array $field | |
5946 | * Field specification | |
5947 | * @param string $fieldName | |
5948 | * Field name. | |
5949 | * | |
5950 | * @return string | |
5951 | * Relevant where clause. | |
5952 | */ | |
5953 | protected function generateFilterClause($field, $fieldName) { | |
5954 | if (CRM_Utils_Array::value('type', $field) & CRM_Utils_Type::T_DATE) { | |
5955 | if (CRM_Utils_Array::value('operatorType', $field) == | |
5956 | CRM_Report_Form::OP_MONTH | |
5957 | ) { | |
5958 | $op = CRM_Utils_Array::value("{$fieldName}_op", $this->_params); | |
5959 | $value = CRM_Utils_Array::value("{$fieldName}_value", $this->_params); | |
5960 | if (is_array($value) && !empty($value)) { | |
5961 | return "(month({$field['dbAlias']}) $op (" . implode(', ', $value) . | |
5962 | '))'; | |
5963 | } | |
5964 | } | |
5965 | else { | |
5966 | $relative = CRM_Utils_Array::value("{$fieldName}_relative", $this->_params); | |
5967 | $from = CRM_Utils_Array::value("{$fieldName}_from", $this->_params); | |
5968 | $to = CRM_Utils_Array::value("{$fieldName}_to", $this->_params); | |
5969 | $fromTime = CRM_Utils_Array::value("{$fieldName}_from_time", $this->_params); | |
5970 | $toTime = CRM_Utils_Array::value("{$fieldName}_to_time", $this->_params); | |
5971 | return $this->dateClause($field['dbAlias'], $relative, $from, $to, $field['type'], $fromTime, $toTime); | |
5972 | } | |
5973 | } | |
5974 | else { | |
5975 | $op = CRM_Utils_Array::value("{$fieldName}_op", $this->_params); | |
5976 | if ($op) { | |
5977 | return $this->whereClause($field, | |
5978 | $op, | |
5979 | CRM_Utils_Array::value("{$fieldName}_value", $this->_params), | |
5980 | CRM_Utils_Array::value("{$fieldName}_min", $this->_params), | |
5981 | CRM_Utils_Array::value("{$fieldName}_max", $this->_params) | |
5982 | ); | |
5983 | } | |
5984 | } | |
5985 | return ''; | |
5986 | } | |
5987 | ||
232624b1 | 5988 | } |