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