3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2019
33 class CRM_Report_Form_Member_Detail
extends CRM_Report_Form
{
35 protected $_summary = NULL;
37 protected $_customGroupExtends = [
46 protected $_customGroupGroupBy = FALSE;
49 * This report has not been optimised for group filtering.
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.
59 protected $groupFilterNotOptimised = FALSE;
64 public function __construct() {
66 'civicrm_contact' => [
67 'dao' => 'CRM_Contact_DAO_Contact',
68 'fields' => $this->getBasicContactFields(),
71 'title' => ts('Contact Name'),
75 'title' => ts('Is Deleted'),
77 'type' => CRM_Utils_Type
::T_BOOLEAN
,
79 'id' => ['no_display' => TRUE],
83 'title' => ts('Last Name, First Name'),
85 'default_weight' => '0',
86 'default_order' => 'ASC',
89 'grouping' => 'contact-fields',
91 'civicrm_membership' => [
92 'dao' => 'CRM_Member_DAO_Membership',
94 'membership_type_id' => [
95 'title' => ts('Membership Type'),
99 'membership_start_date' => [
100 'title' => ts('Start Date'),
103 'membership_end_date' => [
104 'title' => ts('End Date'),
107 'owner_membership_id' => [
108 'title' => ts('Primary/Inherited?'),
112 'title' => ts('Join Date'),
115 'source' => ['title' => ts('Source')],
118 'membership_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' => [
122 'title' => ts('Primary Membership'),
123 'operatorType' => CRM_Report_Form
::OP_INT
,
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(),
134 'membership_type_id' => [
135 'title' => ts('Membership Type'),
137 'default_weight' => '1',
138 'default_order' => 'ASC',
141 'grouping' => 'member-fields',
144 'title' => ts('Membership'),
149 'civicrm_membership_status' => [
150 'dao' => 'CRM_Member_DAO_MembershipStatus',
151 'alias' => 'mem_status',
154 'title' => ts('Status'),
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'),
167 'grouping' => 'member-fields',
170 'dao' => 'CRM_Core_DAO_Email',
171 'fields' => ['email' => NULL],
172 'grouping' => 'contact-fields',
175 'dao' => 'CRM_Core_DAO_Phone',
176 'fields' => ['phone' => NULL],
177 'grouping' => 'contact-fields',
179 'civicrm_contribution' => [
180 'dao' => 'CRM_Contribute_DAO_Contribution',
182 'contribution_id' => [
184 'no_display' => TRUE,
187 'financial_type_id' => ['title' => ts('Financial Type')],
188 'contribution_status_id' => ['title' => ts('Contribution Status')],
189 'payment_instrument_id' => ['title' => ts('Payment Type')],
192 'no_display' => TRUE,
195 'receive_date' => NULL,
196 'receipt_date' => NULL,
197 'fee_amount' => NULL,
198 'net_amount' => NULL,
200 'title' => ts('Payment Amount (most recent)'),
201 'statistics' => ['sum' => ts('Amount')],
205 'receive_date' => ['operatorType' => CRM_Report_Form
::OP_DATE
],
206 'financial_type_id' => [
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
,
212 'payment_instrument_id' => [
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
,
219 'title' => ts('Currency'),
220 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
221 'options' => CRM_Core_OptionGroup
::values('currencies_enabled'),
223 'type' => CRM_Utils_Type
::T_STRING
,
225 'contribution_status_id' => [
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
,
231 'total_amount' => ['title' => ts('Contribution Amount')],
235 'title' => ts('Date Received'),
236 'default_weight' => '2',
237 'default_order' => 'DESC',
240 'grouping' => 'contri-fields',
242 ] +
$this->getAddressColumns([
243 // These options are only excluded because they were not previously present.
247 $this->_groupFilter
= TRUE;
248 $this->_tagFilter
= TRUE;
250 // If we have campaigns enabled, add those elements to both the fields, filters and sorting
251 $this->addCampaignFields('civicrm_membership', FALSE, TRUE);
253 $this->_currencyColumn
= 'civicrm_contribution_currency';
254 parent
::__construct();
257 public function preProcess() {
258 $this->assign('reportTitle', ts('Membership Detail Report'));
259 parent
::preProcess();
262 public function from() {
263 $this->setFromBase('civicrm_contact');
266 INNER JOIN civicrm_membership {$this->_aliases['civicrm_membership']}
267 ON {$this->_aliases['civicrm_contact']}.id =
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']}
270 ON {$this->_aliases['civicrm_membership_status']}.id =
271 {$this->_aliases['civicrm_membership']}.status_id ";
273 $this->joinAddressFromContact();
274 $this->joinPhoneFromContact();
275 $this->joinEmailFromContact();
277 //used when contribution field is selected.
278 if ($this->isTableSelected('civicrm_contribution')) {
280 LEFT JOIN civicrm_membership_payment cmp
281 ON {$this->_aliases['civicrm_membership']}.id = cmp.membership_id
282 LEFT JOIN civicrm_contribution {$this->_aliases['civicrm_contribution']}
283 ON cmp.contribution_id={$this->_aliases['civicrm_contribution']}.id\n";
287 public function getOperationPair($type = "string", $fieldName = NULL) {
288 //re-name IS NULL/IS NOT NULL for clarity
289 if ($fieldName == 'owner_membership_id') {
291 $result['nll'] = ts('Primary members only');
292 $result['nnll'] = ts('Non-primary members only');
293 $options = parent
::getOperationPair($type, $fieldName);
294 foreach ($options as $key => $label) {
295 if (!array_key_exists($key, $result)) {
296 $result[$key] = $label;
301 $result = parent
::getOperationPair($type, $fieldName);
307 * Alter display of rows.
309 * Iterate through the rows retrieved via SQL and make changes for display purposes,
310 * such as rendering contacts as links.
313 * Rows generated by SQL, with an array for each row.
315 public function alterDisplay(&$rows) {
319 $contributionTypes = CRM_Contribute_PseudoConstant
::financialType();
320 $contributionStatus = CRM_Contribute_PseudoConstant
::contributionStatus();
321 $paymentInstruments = CRM_Contribute_PseudoConstant
::paymentInstrument();
323 $repeatFound = FALSE;
324 foreach ($rows as $rowNum => $row) {
325 if ($repeatFound == FALSE ||
326 $repeatFound < $rowNum - 1
331 if (!empty($this->_noRepeats
) && $this->_outputMode
!= 'csv') {
332 // not repeat contact display names if it matches with the one
334 foreach ($row as $colName => $colVal) {
335 if (in_array($colName, $this->_noRepeats
) &&
338 if ($rows[$rowNum][$colName] == $rows[$rowNum - 1][$colName] ||
339 (!empty($checkList[$colName]) &&
340 in_array($colVal, $checkList[$colName]))
342 $rows[$rowNum][$colName] = "";
343 // CRM-15917: Don't blank the name if it's a different contact
344 if ($colName == 'civicrm_contact_exposed_id') {
345 $rows[$rowNum]['civicrm_contact_sort_name'] = "";
347 $repeatFound = $rowNum;
350 if (in_array($colName, $this->_noRepeats
)) {
351 $checkList[$colName][] = $colVal;
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);
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)
367 $url = CRM_Utils_System
::url("civicrm/contact/view",
368 'reset=1&cid=' . $row['civicrm_contact_id'],
371 $rows[$rowNum]['civicrm_contact_sort_name_link'] = $url;
372 $rows[$rowNum]['civicrm_contact_sort_name_hover'] = ts("View Contact Summary for this Contact.");
376 if ($value = CRM_Utils_Array
::value('civicrm_contribution_financial_type_id', $row)) {
377 $rows[$rowNum]['civicrm_contribution_financial_type_id'] = $contributionTypes[$value];
380 if ($value = CRM_Utils_Array
::value('civicrm_contribution_contribution_status_id', $row)) {
381 $rows[$rowNum]['civicrm_contribution_contribution_status_id'] = $contributionStatus[$value];
384 if ($value = CRM_Utils_Array
::value('civicrm_contribution_payment_instrument_id', $row)) {
385 $rows[$rowNum]['civicrm_contribution_payment_instrument_id'] = $paymentInstruments[$value];
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';
395 // Convert campaign_id to campaign title
396 if (array_key_exists('civicrm_membership_campaign_id', $row)) {
397 if ($value = $row['civicrm_membership_campaign_id']) {
398 $rows[$rowNum]['civicrm_membership_campaign_id'] = $this->campaigns
[$value];
402 $entryFound = $this->alterDisplayAddressFields($row, $rows, $rowNum, 'member/detail', 'List all memberships(s) for this ') ?
TRUE : $entryFound;
403 $entryFound = $this->alterDisplayContactFields($row, $rows, $rowNum, 'member/detail', 'List all memberships(s) for this ') ?
TRUE : $entryFound;