Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
6a488035 TO |
2 | /* |
3 | +--------------------------------------------------------------------+ | |
fee14197 | 4 | | CiviCRM version 5 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
6b83d5bd | 6 | | Copyright CiviCRM LLC (c) 2004-2019 | |
6a488035 TO |
7 | +--------------------------------------------------------------------+ |
8 | | This file is a part of CiviCRM. | | |
9 | | | | |
10 | | CiviCRM is free software; you can copy, modify, and distribute it | | |
11 | | under the terms of the GNU Affero General Public License | | |
12 | | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. | | |
13 | | | | |
14 | | CiviCRM is distributed in the hope that it will be useful, but | | |
15 | | WITHOUT ANY WARRANTY; without even the implied warranty of | | |
16 | | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. | | |
17 | | See the GNU Affero General Public License for more details. | | |
18 | | | | |
19 | | You should have received a copy of the GNU Affero General Public | | |
20 | | License and the CiviCRM Licensing Exception along | | |
21 | | with this program; if not, contact CiviCRM LLC | | |
22 | | at info[AT]civicrm[DOT]org. If you have questions about the | | |
23 | | GNU Affero General Public License or the licensing of CiviCRM, | | |
24 | | see the CiviCRM license FAQ at http://civicrm.org/licensing | | |
25 | +--------------------------------------------------------------------+ | |
d25dd0ee | 26 | */ |
6a488035 TO |
27 | |
28 | /** | |
29 | * | |
30 | * @package CRM | |
6b83d5bd | 31 | * @copyright CiviCRM LLC (c) 2004-2019 |
6a488035 TO |
32 | */ |
33 | class CRM_Report_Form_Member_Detail extends CRM_Report_Form { | |
34 | ||
6a488035 TO |
35 | protected $_summary = NULL; |
36 | ||
be2fb01f | 37 | protected $_customGroupExtends = [ |
804f9330 DJ |
38 | 'Membership', |
39 | 'Contribution', | |
40 | 'Contact', | |
41 | 'Individual', | |
42 | 'Household', | |
43 | 'Organization', | |
be2fb01f | 44 | ]; |
804f9330 | 45 | |
f813f78e | 46 | protected $_customGroupGroupBy = FALSE; |
47 | ||
1728e9a0 | 48 | /** |
49 | * This report has not been optimised for group filtering. | |
50 | * | |
51 | * The functionality for group filtering has been improved but not | |
52 | * all reports have been adjusted to take care of it. This report has not | |
53 | * and will run an inefficient query until fixed. | |
54 | * | |
55 | * CRM-19170 | |
56 | * | |
57 | * @var bool | |
58 | */ | |
eae0f0d9 | 59 | protected $groupFilterNotOptimised = FALSE; |
1728e9a0 | 60 | |
74cf4551 | 61 | /** |
e5575773 | 62 | * Class constructor. |
74cf4551 | 63 | */ |
00be9182 | 64 | public function __construct() { |
be2fb01f CW |
65 | $this->_columns = [ |
66 | 'civicrm_contact' => [ | |
1e887757 | 67 | 'dao' => 'CRM_Contact_DAO_Contact', |
e5575773 | 68 | 'fields' => $this->getBasicContactFields(), |
be2fb01f CW |
69 | 'filters' => [ |
70 | 'sort_name' => [ | |
1e887757 EM |
71 | 'title' => ts('Contact Name'), |
72 | 'operator' => 'like', | |
be2fb01f CW |
73 | ], |
74 | 'is_deleted' => [ | |
bc390081 JP |
75 | 'title' => ts('Is Deleted'), |
76 | 'default' => 0, | |
77 | 'type' => CRM_Utils_Type::T_BOOLEAN, | |
be2fb01f CW |
78 | ], |
79 | 'id' => ['no_display' => TRUE], | |
80 | ], | |
81 | 'order_bys' => [ | |
82 | 'sort_name' => [ | |
1e887757 EM |
83 | 'title' => ts('Last Name, First Name'), |
84 | 'default' => '1', | |
85 | 'default_weight' => '0', | |
21dfd5f5 | 86 | 'default_order' => 'ASC', |
be2fb01f CW |
87 | ], |
88 | ], | |
1e887757 | 89 | 'grouping' => 'contact-fields', |
be2fb01f CW |
90 | ], |
91 | 'civicrm_membership' => [ | |
8cab7c88 | 92 | 'dao' => 'CRM_Member_DAO_Membership', |
be2fb01f CW |
93 | 'fields' => [ |
94 | 'membership_type_id' => [ | |
ccc29f8e | 95 | 'title' => ts('Membership Type'), |
8cab7c88 EM |
96 | 'required' => TRUE, |
97 | 'no_repeat' => TRUE, | |
be2fb01f CW |
98 | ], |
99 | 'membership_start_date' => [ | |
8cab7c88 EM |
100 | 'title' => ts('Start Date'), |
101 | 'default' => TRUE, | |
be2fb01f CW |
102 | ], |
103 | 'membership_end_date' => [ | |
8cab7c88 EM |
104 | 'title' => ts('End Date'), |
105 | 'default' => TRUE, | |
be2fb01f CW |
106 | ], |
107 | 'owner_membership_id' => [ | |
950351e3 AP |
108 | 'title' => ts('Primary/Inherited?'), |
109 | 'default' => TRUE, | |
be2fb01f CW |
110 | ], |
111 | 'join_date' => [ | |
8cab7c88 EM |
112 | 'title' => ts('Join Date'), |
113 | 'default' => TRUE, | |
be2fb01f CW |
114 | ], |
115 | 'source' => ['title' => ts('Source')], | |
116 | ], | |
117 | 'filters' => [ | |
118 | 'join_date' => ['operatorType' => CRM_Report_Form::OP_DATE], | |
119 | 'membership_start_date' => ['operatorType' => CRM_Report_Form::OP_DATE], | |
120 | 'membership_end_date' => ['operatorType' => CRM_Report_Form::OP_DATE], | |
121 | 'owner_membership_id' => [ | |
455a0d0e | 122 | 'title' => ts('Primary Membership'), |
8cab7c88 | 123 | 'operatorType' => CRM_Report_Form::OP_INT, |
be2fb01f CW |
124 | ], |
125 | 'tid' => [ | |
8cab7c88 EM |
126 | 'name' => 'membership_type_id', |
127 | 'title' => ts('Membership Types'), | |
128 | 'type' => CRM_Utils_Type::T_INT, | |
129 | 'operatorType' => CRM_Report_Form::OP_MULTISELECT, | |
130 | 'options' => CRM_Member_PseudoConstant::membershipType(), | |
be2fb01f CW |
131 | ], |
132 | ], | |
133 | 'order_bys' => [ | |
134 | 'membership_type_id' => [ | |
8d44b023 J |
135 | 'title' => ts('Membership Type'), |
136 | 'default' => '0', | |
137 | 'default_weight' => '1', | |
138 | 'default_order' => 'ASC', | |
be2fb01f CW |
139 | ], |
140 | ], | |
8cab7c88 | 141 | 'grouping' => 'member-fields', |
be2fb01f CW |
142 | 'group_bys' => [ |
143 | 'id' => [ | |
490a6f02 | 144 | 'title' => ts('Membership'), |
145 | 'default' => TRUE, | |
be2fb01f CW |
146 | ], |
147 | ], | |
148 | ], | |
149 | 'civicrm_membership_status' => [ | |
8cab7c88 EM |
150 | 'dao' => 'CRM_Member_DAO_MembershipStatus', |
151 | 'alias' => 'mem_status', | |
be2fb01f CW |
152 | 'fields' => [ |
153 | 'name' => [ | |
8cab7c88 EM |
154 | 'title' => ts('Status'), |
155 | 'default' => TRUE, | |
be2fb01f CW |
156 | ], |
157 | ], | |
158 | 'filters' => [ | |
159 | 'sid' => [ | |
8cab7c88 EM |
160 | 'name' => 'id', |
161 | 'title' => ts('Status'), | |
162 | 'type' => CRM_Utils_Type::T_INT, | |
163 | 'operatorType' => CRM_Report_Form::OP_MULTISELECT, | |
164 | 'options' => CRM_Member_PseudoConstant::membershipStatus(NULL, NULL, 'label'), | |
be2fb01f CW |
165 | ], |
166 | ], | |
8cab7c88 | 167 | 'grouping' => 'member-fields', |
be2fb01f CW |
168 | ], |
169 | 'civicrm_email' => [ | |
8cab7c88 | 170 | 'dao' => 'CRM_Core_DAO_Email', |
be2fb01f | 171 | 'fields' => ['email' => NULL], |
8cab7c88 | 172 | 'grouping' => 'contact-fields', |
be2fb01f CW |
173 | ], |
174 | 'civicrm_phone' => [ | |
8cab7c88 | 175 | 'dao' => 'CRM_Core_DAO_Phone', |
be2fb01f | 176 | 'fields' => ['phone' => NULL], |
8cab7c88 | 177 | 'grouping' => 'contact-fields', |
be2fb01f CW |
178 | ], |
179 | 'civicrm_contribution' => [ | |
8cab7c88 | 180 | 'dao' => 'CRM_Contribute_DAO_Contribution', |
be2fb01f CW |
181 | 'fields' => [ |
182 | 'contribution_id' => [ | |
8cab7c88 EM |
183 | 'name' => 'id', |
184 | 'no_display' => TRUE, | |
185 | 'required' => TRUE, | |
be2fb01f CW |
186 | ], |
187 | 'financial_type_id' => ['title' => ts('Financial Type')], | |
188 | 'contribution_status_id' => ['title' => ts('Contribution Status')], | |
189 | 'payment_instrument_id' => ['title' => ts('Payment Type')], | |
190 | 'currency' => [ | |
8cab7c88 EM |
191 | 'required' => TRUE, |
192 | 'no_display' => TRUE, | |
be2fb01f | 193 | ], |
8cab7c88 EM |
194 | 'trxn_id' => NULL, |
195 | 'receive_date' => NULL, | |
196 | 'receipt_date' => NULL, | |
197 | 'fee_amount' => NULL, | |
198 | 'net_amount' => NULL, | |
be2fb01f | 199 | 'total_amount' => [ |
8cab7c88 | 200 | 'title' => ts('Payment Amount (most recent)'), |
be2fb01f CW |
201 | 'statistics' => ['sum' => ts('Amount')], |
202 | ], | |
203 | ], | |
204 | 'filters' => [ | |
205 | 'receive_date' => ['operatorType' => CRM_Report_Form::OP_DATE], | |
206 | 'financial_type_id' => [ | |
8cab7c88 EM |
207 | 'title' => ts('Financial Type'), |
208 | 'operatorType' => CRM_Report_Form::OP_MULTISELECT, | |
209 | 'options' => CRM_Contribute_PseudoConstant::financialType(), | |
210 | 'type' => CRM_Utils_Type::T_INT, | |
be2fb01f CW |
211 | ], |
212 | 'payment_instrument_id' => [ | |
8cab7c88 EM |
213 | 'title' => ts('Payment Type'), |
214 | 'operatorType' => CRM_Report_Form::OP_MULTISELECT, | |
215 | 'options' => CRM_Contribute_PseudoConstant::paymentInstrument(), | |
216 | 'type' => CRM_Utils_Type::T_INT, | |
be2fb01f CW |
217 | ], |
218 | 'currency' => [ | |
ccc29f8e | 219 | 'title' => ts('Currency'), |
8cab7c88 EM |
220 | 'operatorType' => CRM_Report_Form::OP_MULTISELECT, |
221 | 'options' => CRM_Core_OptionGroup::values('currencies_enabled'), | |
222 | 'default' => NULL, | |
223 | 'type' => CRM_Utils_Type::T_STRING, | |
be2fb01f CW |
224 | ], |
225 | 'contribution_status_id' => [ | |
8cab7c88 EM |
226 | 'title' => ts('Contribution Status'), |
227 | 'operatorType' => CRM_Report_Form::OP_MULTISELECT, | |
228 | 'options' => CRM_Contribute_PseudoConstant::contributionStatus(), | |
229 | 'type' => CRM_Utils_Type::T_INT, | |
be2fb01f CW |
230 | ], |
231 | 'total_amount' => ['title' => ts('Contribution Amount')], | |
232 | ], | |
233 | 'order_bys' => [ | |
234 | 'receive_date' => [ | |
7bc6b5bb | 235 | 'title' => ts('Date Received'), |
8d44b023 J |
236 | 'default_weight' => '2', |
237 | 'default_order' => 'DESC', | |
be2fb01f CW |
238 | ], |
239 | ], | |
8cab7c88 | 240 | 'grouping' => 'contri-fields', |
be2fb01f CW |
241 | ], |
242 | ] + $this->getAddressColumns([ | |
e5575773 | 243 | // These options are only excluded because they were not previously present. |
244 | 'order_by' => FALSE, | |
245 | 'group_by' => FALSE, | |
be2fb01f | 246 | ]); |
6a488035 TO |
247 | $this->_groupFilter = TRUE; |
248 | $this->_tagFilter = TRUE; | |
fdb63ad1 | 249 | |
3b1c6a4f | 250 | // If we have campaigns enabled, add those elements to both the fields, filters and sorting |
251 | $this->addCampaignFields('civicrm_membership', FALSE, TRUE); | |
0211a554 | 252 | |
fdb63ad1 | 253 | $this->_currencyColumn = 'civicrm_contribution_currency'; |
6a488035 TO |
254 | parent::__construct(); |
255 | } | |
256 | ||
00be9182 | 257 | public function preProcess() { |
6a488035 TO |
258 | $this->assign('reportTitle', ts('Membership Detail Report')); |
259 | parent::preProcess(); | |
260 | } | |
261 | ||
00be9182 | 262 | public function from() { |
eae0f0d9 | 263 | $this->setFromBase('civicrm_contact'); |
264 | $this->_from .= " | |
265 | {$this->_aclFrom} | |
f813f78e | 266 | INNER JOIN civicrm_membership {$this->_aliases['civicrm_membership']} |
267 | ON {$this->_aliases['civicrm_contact']}.id = | |
6a488035 TO |
268 | {$this->_aliases['civicrm_membership']}.contact_id AND {$this->_aliases['civicrm_membership']}.is_test = 0 |
269 | LEFT JOIN civicrm_membership_status {$this->_aliases['civicrm_membership_status']} | |
f813f78e | 270 | ON {$this->_aliases['civicrm_membership_status']}.id = |
6a488035 TO |
271 | {$this->_aliases['civicrm_membership']}.status_id "; |
272 | ||
183af103 | 273 | $this->joinAddressFromContact(); |
274 | $this->joinPhoneFromContact(); | |
275 | $this->joinEmailFromContact(); | |
e5575773 | 276 | |
4b885f84 | 277 | //used when contribution field is selected. |
278 | if ($this->isTableSelected('civicrm_contribution')) { | |
6a488035 | 279 | $this->_from .= " |
06d4bf4d TO |
280 | LEFT JOIN civicrm_membership_payment cmp |
281 | ON {$this->_aliases['civicrm_membership']}.id = cmp.membership_id | |
fb7829f2 | 282 | LEFT JOIN civicrm_contribution {$this->_aliases['civicrm_contribution']} |
06d4bf4d | 283 | ON cmp.contribution_id={$this->_aliases['civicrm_contribution']}.id\n"; |
6a488035 TO |
284 | } |
285 | } | |
286 | ||
302ccf93 | 287 | public function getOperationPair($type = "string", $fieldName = NULL) { |
302ccf93 | 288 | //re-name IS NULL/IS NOT NULL for clarity |
289 | if ($fieldName == 'owner_membership_id') { | |
455a0d0e | 290 | $result = []; |
302ccf93 | 291 | $result['nll'] = ts('Primary members only'); |
292 | $result['nnll'] = ts('Non-primary members only'); | |
455a0d0e SL |
293 | $options = parent::getOperationPair($type, $fieldName); |
294 | foreach ($options as $key => $label) { | |
295 | if (!array_key_exists($key, $result)) { | |
296 | $result[$key] = $label; | |
297 | } | |
298 | } | |
299 | } | |
300 | else { | |
301 | $result = parent::getOperationPair($type, $fieldName); | |
302ccf93 | 302 | } |
302ccf93 | 303 | return $result; |
304 | } | |
305 | ||
74cf4551 | 306 | /** |
ced9bfed EM |
307 | * Alter display of rows. |
308 | * | |
309 | * Iterate through the rows retrieved via SQL and make changes for display purposes, | |
310 | * such as rendering contacts as links. | |
311 | * | |
312 | * @param array $rows | |
313 | * Rows generated by SQL, with an array for each row. | |
74cf4551 | 314 | */ |
00be9182 | 315 | public function alterDisplay(&$rows) { |
6a488035 | 316 | $entryFound = FALSE; |
be2fb01f | 317 | $checkList = []; |
f813f78e | 318 | |
244200e1 | 319 | $contributionTypes = CRM_Contribute_PseudoConstant::financialType(); |
6a488035 TO |
320 | $contributionStatus = CRM_Contribute_PseudoConstant::contributionStatus(); |
321 | $paymentInstruments = CRM_Contribute_PseudoConstant::paymentInstrument(); | |
f813f78e | 322 | |
2ac6b1ce | 323 | $repeatFound = FALSE; |
6a488035 | 324 | foreach ($rows as $rowNum => $row) { |
2ac6b1ce J |
325 | if ($repeatFound == FALSE || |
326 | $repeatFound < $rowNum - 1 | |
327 | ) { | |
328 | unset($checkList); | |
be2fb01f | 329 | $checkList = []; |
2ac6b1ce | 330 | } |
6a488035 TO |
331 | if (!empty($this->_noRepeats) && $this->_outputMode != 'csv') { |
332 | // not repeat contact display names if it matches with the one | |
333 | // in previous row | |
6a488035 | 334 | foreach ($row as $colName => $colVal) { |
a5658df0 J |
335 | if (in_array($colName, $this->_noRepeats) && |
336 | $rowNum > 0 | |
6a488035 | 337 | ) { |
a5658df0 J |
338 | if ($rows[$rowNum][$colName] == $rows[$rowNum - 1][$colName] || |
339 | (!empty($checkList[$colName]) && | |
340 | in_array($colVal, $checkList[$colName])) | |
341 | ) { | |
342 | $rows[$rowNum][$colName] = ""; | |
343 | // CRM-15917: Don't blank the name if it's a different contact | |
64e8aa73 | 344 | if ($colName == 'civicrm_contact_exposed_id') { |
a5658df0 J |
345 | $rows[$rowNum]['civicrm_contact_sort_name'] = ""; |
346 | } | |
2ac6b1ce | 347 | $repeatFound = $rowNum; |
5ac295e6 | 348 | } |
6a488035 TO |
349 | } |
350 | if (in_array($colName, $this->_noRepeats)) { | |
351 | $checkList[$colName][] = $colVal; | |
352 | } | |
353 | } | |
354 | } | |
355 | ||
356 | if (array_key_exists('civicrm_membership_membership_type_id', $row)) { | |
357 | if ($value = $row['civicrm_membership_membership_type_id']) { | |
358 | $rows[$rowNum]['civicrm_membership_membership_type_id'] = CRM_Member_PseudoConstant::membershipType($value, FALSE); | |
359 | } | |
360 | $entryFound = TRUE; | |
361 | } | |
362 | ||
6a488035 TO |
363 | if (array_key_exists('civicrm_contact_sort_name', $row) && |
364 | $rows[$rowNum]['civicrm_contact_sort_name'] && | |
365 | array_key_exists('civicrm_contact_id', $row) | |
366 | ) { | |
367 | $url = CRM_Utils_System::url("civicrm/contact/view", | |
368 | 'reset=1&cid=' . $row['civicrm_contact_id'], | |
369 | $this->_absoluteUrl | |
370 | ); | |
371 | $rows[$rowNum]['civicrm_contact_sort_name_link'] = $url; | |
372 | $rows[$rowNum]['civicrm_contact_sort_name_hover'] = ts("View Contact Summary for this Contact."); | |
373 | $entryFound = TRUE; | |
374 | } | |
f813f78e | 375 | |
6a488035 TO |
376 | if ($value = CRM_Utils_Array::value('civicrm_contribution_financial_type_id', $row)) { |
377 | $rows[$rowNum]['civicrm_contribution_financial_type_id'] = $contributionTypes[$value]; | |
378 | $entryFound = TRUE; | |
379 | } | |
380 | if ($value = CRM_Utils_Array::value('civicrm_contribution_contribution_status_id', $row)) { | |
381 | $rows[$rowNum]['civicrm_contribution_contribution_status_id'] = $contributionStatus[$value]; | |
382 | $entryFound = TRUE; | |
383 | } | |
384 | if ($value = CRM_Utils_Array::value('civicrm_contribution_payment_instrument_id', $row)) { | |
385 | $rows[$rowNum]['civicrm_contribution_payment_instrument_id'] = $paymentInstruments[$value]; | |
386 | $entryFound = TRUE; | |
387 | } | |
388 | ||
950351e3 AP |
389 | if (array_key_exists('civicrm_membership_owner_membership_id', $row)) { |
390 | $value = $row['civicrm_membership_owner_membership_id']; | |
391 | $rows[$rowNum]['civicrm_membership_owner_membership_id'] = ($value != '') ? 'Inherited' : 'Primary'; | |
392 | $entryFound = TRUE; | |
393 | } | |
394 | ||
0211a554 | 395 | // Convert campaign_id to campaign title |
229c2785 CD |
396 | if (array_key_exists('civicrm_membership_campaign_id', $row)) { |
397 | if ($value = $row['civicrm_membership_campaign_id']) { | |
3b1c6a4f | 398 | $rows[$rowNum]['civicrm_membership_campaign_id'] = $this->campaigns[$value]; |
0211a554 DL |
399 | $entryFound = TRUE; |
400 | } | |
401 | } | |
e5575773 | 402 | $entryFound = $this->alterDisplayAddressFields($row, $rows, $rowNum, 'member/detail', 'List all memberships(s) for this ') ? TRUE : $entryFound; |
7a4192f7 | 403 | $entryFound = $this->alterDisplayContactFields($row, $rows, $rowNum, 'member/detail', 'List all memberships(s) for this ') ? TRUE : $entryFound; |
0211a554 | 404 | |
6a488035 TO |
405 | if (!$entryFound) { |
406 | break; | |
407 | } | |
408 | } | |
409 | } | |
96025800 | 410 | |
6a488035 | 411 | } |