dev/core#38 Show Recurring Contributions on Membership Modal View #11903

MiyaNoctem · 2018-03-30T15:51:45Z

Overview

Currently, when viewing a membership from contact's detailed view (on memberships tab), it is hard to tell if a membership has any recurring contributions associated to it, even though you can see all payments done for the membership. It would be good if you could see both payments and recurring contributions associated to the membership, similar to how both are shown on Contact's contribution tab.

Before

Only payment contributions were shown on membership modal view.

After

After the table with contributions done for the membership, a new table is shown, with recurring contributions ssociated to the membership.

Technical Details

The same template used on Contact's Contributions tab is used to ensure the same table structure is used for the contributions shown on membership's view.

Comments

Issue was reported on gitlab:
https://lab.civicrm.org/dev/core/issues/38

seamuslee001 · 2018-03-30T22:02:38Z

CRM/Member/BAO/Membership.php

+   * @return array
+   */
+  public static function getRecurContributions($membershipID) {
+    $query = "


Is there no API w could use here? Also i don't see contribution_count being used om the $recurringContributions array

I could use chained API calls, but other than that, I don't think there is a way to get recurring contributions tied to a membership. I'll remove the contribution_count from the query, though.

eileenmcnaughton · 2018-03-31T04:10:43Z

CRM/Member/Form/MembershipView.php

+   *
+   * @var int
+   */
+  private $_membershipID;


I think we've been moving away from the preceding _ as a matter of style

eileenmcnaughton · 2018-03-31T04:13:30Z

@mattwire are you able/ willng to review this. My main concern is that I'm pretty sure existing code blocks / functions do much the same as the new ones but I've only skimmed it. I think the idea of adding the block is good in principle. Re whether a unit test is required I think that if we do add these big new functions they should be tested.

mattwire · 2018-03-31T09:44:29Z

@MiyaNoctem From the screenshots it looks like you developed this before the link was added to "View recurring contribution" in 4.7.31:

So I'm not sure if we need to display the full details of the recurring contribution here as well, but I don't think it is a problem if we do either!

I don't think we should be touching the BAO class to make form changes and we should be using the API. You can get the recurring contribution ID using:

$result = civicrm_api3('Membership', 'get', array(
  'sequential' => 1,
  'return' => array("contribution_recur_id"),
  'contribution_recur_id' => "",
));

But contribution_recur_id is already available here and could be used to retrieve details of the recurring contribution for display on the form:

civicrm-core/CRM/Member/Form/MembershipView.php

Line 383 in 4627f70

    
           $isRecur = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_Membership', $id, 'contribution_recur_id');

This maybe a useful reference: #11697
As it converts the entire (recurring contribution) form to use the API to retrieve data.

eileenmcnaughton · 2018-04-01T21:17:12Z

Speaking just to the question of whether it still makes sense given the addition of view recurring - I think that's ok but it suggests maybe we should be looking at an ajax-addable block that can also be used on the edit page??? (I'm just thinking that's in line with the payments blocks we use elsewhere)

MiyaNoctem · 2018-04-06T01:13:29Z

@mattwire,
Thanks for the feedback. I don't think that API call would work for what we need. Our use case is as follows:

Contact pays for a 1-year membership with a recurring contribution in 12 monthly installments.
By month 12, contact renews membership, with a new recurring contribution, in 6 bi-monthly installments.
We want to be able to go to membership modal and not only see all the contributions, but also both of the recurring contributions that have been used to pay for the membership.

Maybe I could create a new API call for this (ie. return al recurring contributions used to pay for a membership)?

CC @eileenmcnaughton

eileenmcnaughton · 2018-04-06T03:27:00Z

So you are basically trying to do something like

$result = civicrm_api3('MembershipPayment', 'get', array(
  'sequential' => 1,
  'return' => array("contribution_id.contribution_recur_id.start_date", "contribution_id.contribution_recur_id.contribution_status_id"),
  'contribution_id.contribution_recur_id' => array('IS NOT NULL' => 1),
));

MiyaNoctem · 2018-04-09T15:11:30Z

@eileenmcnaughton,

The API call you suggested kind of works, with a little preprocessing to filter out duplicates. I also moved the code away from the Membership BAO, as @mattwire suggested. Let me know what you guys think.

MiyaNoctem · 2018-04-16T10:32:44Z

Jenkins re test this please

eileenmcnaughton · 2018-04-16T20:50:34Z

I'll take a closer look - but I would still want it separate to that form - probably pulled in by ajax - so it can be re-used in other places - e.g the edit form

MiyaNoctem · 2018-04-17T11:18:21Z

@eileenmcnaughton,

Do you have an example I could follow on how to implement loading the table with ajax?

Thanks!

MiyaNoctem · 2018-04-18T10:45:51Z

Jenkins re test this please

MiyaNoctem · 2018-04-19T13:25:33Z

Jenkins re test this please

MiyaNoctem · 2018-04-19T16:19:08Z

Jenkins re test this please

eileenmcnaughton · 2018-04-22T02:38:03Z

Looking promisting I think it would be better to more the recurring contributions block to it's own class / own tpl with a menu listing in an xml file. I would be inclined to load by ajax - but @colemanw should be the person to answer the best way to pull it in.

To my mind the test to whether it's done the right way should be how easy it would be to add that block to the edit form. At the moment it's part of the view form so it would need refactoring to add to the edit form

guanhuan · 2018-04-26T13:34:37Z

Hi @colemanw, would you please advise on this one too? Thanks!

MiyaNoctem · 2018-05-01T16:25:54Z

Jenkins re test this please

eileenmcnaughton · 2018-05-01T21:33:22Z

@guanhuan the question of ajax adding is one thing - but my minimum is that it is done is a re-usable way (if not via ajax the function to add the block should be in it's own class & it's own tpl) - I would suggest adding it both the edit & the view forms as a 'proof' that it is done in a re-usable way - and also because it would be generally useful to have in both places & consistent with other edit pages that show blocks of related entities

guanhuan · 2018-05-02T11:10:40Z

@eileenmcnaughton got it. Sorry I misunderstood your comment earlier. That makes sense.

@MiyaNoctem Please see how it is done for "related contributions" and we should make the "related recurring contributions" available in edit modal as well for consistency. I have attached some screenshots.

Related contributions in view modal:

Related contributions in edit modal:

MiyaNoctem · 2018-05-03T17:33:43Z

@guanhuan, I originally implemented the list following how it was done for "Related Contributions" (ie. load the contributions in the CRM_Member_Form_MembershipView class and send them to the same template used on contributions tab), but I think this is the behaviour @eileenmcnaughton wants us to refrain from using. That being said, I've implemented a new class and template to show the recurring contributions, added a path to Contribute xml and I've loaded the list with an ajax call. Just waiting for Jenkins now...

eileenmcnaughton · 2018-05-03T22:30:00Z

@MiyaNoctem the reason I'm not keen on adding another block in an existing class that is not really part of that class per se is that I have reviewed a LOT of PRs that then extract it into a shared class to display in more than one place - so I wanted to start from the assumption it might be used in more than one place

MiyaNoctem · 2018-05-04T10:36:51Z

Understood @eileenmcnaughton, I'll take that into account for any future collaborations. Do you think this is ready to be merged now?

eileenmcnaughton · 2018-05-07T01:45:55Z

@MiyaNoctem I tested this & I think it is ready to be merged if you could please squash into one patch & review one proposal - marked inline

eileenmcnaughton · 2018-05-07T01:50:47Z

CRM/Member/Page/RecurringContributions.php

+  private function getRecurContributions($membershipID) {
+    $result = civicrm_api3('MembershipPayment', 'get', array(
+      'sequential' => 1,
+      'return' => array(


I think you need to set limit here - also you can filter on recur here too - ie

'contribution_id.contribution_recur_id.id' => ['IS NOT NULL' => TRUE], 'options' => ['limit' => 0],

eileenmcnaughton · 2018-05-07T01:51:23Z

CRM/Member/Page/RecurringContributions.php

+      $noRecurringContribution = empty($recurringContributionID);
+      $recurringAlreadyProcessed = isset($recurringContributions[$recurringContributionID]);
+
+      if ($noRecurringContribution || $recurringAlreadyProcessed) {


With the line above you wouldn't get any $noRecurringContribution

MiyaNoctem · 2018-05-10T17:37:38Z

@eileenmcnaughton, I've squashed the commits and implemented the changes you suggested... thanks for that. So are we ready now?

Currently, when viewing a membership from contact's detailed view (on memberships tab), it is hard to tell if a membership has any recurring contributions associated to it, even though you can see all payments done for the membership. Added a recurring contributions section below the contributions table currently being shown, by loading recurring contributions using ajax call to load list of recurring contributions. Added recurring contributionslist to membership edit view using ajax call.

eileenmcnaughton · 2018-05-10T21:31:40Z

I think so!

civicrm-builder added the master label Mar 30, 2018

MiyaNoctem force-pushed the CRM-38-show-recurring-contributions-on-membership-modal branch from 5377084 to 82ea345 Compare March 30, 2018 16:04

seamuslee001 reviewed Mar 30, 2018

View reviewed changes

eileenmcnaughton reviewed Mar 31, 2018

View reviewed changes

MiyaNoctem changed the title ~~CRM-38: Show Recurring Contributions on Membership Modal View~~ (dev/core/38) Show Recurring Contributions on Membership Modal View Apr 4, 2018

MiyaNoctem force-pushed the CRM-38-show-recurring-contributions-on-membership-modal branch from 82ea345 to 26f0d17 Compare April 6, 2018 01:16

MiyaNoctem force-pushed the CRM-38-show-recurring-contributions-on-membership-modal branch from 06f2fdb to 487c45e Compare April 17, 2018 16:31

mlutfy changed the title ~~(dev/core/38) Show Recurring Contributions on Membership Modal View~~ dev/core#38 Show Recurring Contributions on Membership Modal View Apr 18, 2018

MiyaNoctem force-pushed the CRM-38-show-recurring-contributions-on-membership-modal branch from 487c45e to 6de6b1e Compare May 1, 2018 16:28

eileenmcnaughton reviewed May 7, 2018

View reviewed changes

MiyaNoctem force-pushed the CRM-38-show-recurring-contributions-on-membership-modal branch from f1eeafa to 6e3ba0b Compare May 10, 2018 15:41

MiyaNoctem force-pushed the CRM-38-show-recurring-contributions-on-membership-modal branch from 6e3ba0b to 669fc25 Compare May 10, 2018 17:42

eileenmcnaughton merged commit 31efb48 into civicrm:master May 10, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

dev/core#38 Show Recurring Contributions on Membership Modal View #11903

dev/core#38 Show Recurring Contributions on Membership Modal View #11903

MiyaNoctem commented Mar 30, 2018 •

edited

Loading

seamuslee001 Mar 30, 2018

MiyaNoctem Apr 6, 2018

eileenmcnaughton Mar 31, 2018

eileenmcnaughton commented Mar 31, 2018

mattwire commented Mar 31, 2018

eileenmcnaughton commented Apr 1, 2018

MiyaNoctem commented Apr 6, 2018 •

edited

Loading

eileenmcnaughton commented Apr 6, 2018

MiyaNoctem commented Apr 9, 2018

MiyaNoctem commented Apr 16, 2018

eileenmcnaughton commented Apr 16, 2018

MiyaNoctem commented Apr 17, 2018

MiyaNoctem commented Apr 18, 2018

MiyaNoctem commented Apr 19, 2018

MiyaNoctem commented Apr 19, 2018

eileenmcnaughton commented Apr 22, 2018

guanhuan commented Apr 26, 2018

MiyaNoctem commented May 1, 2018

eileenmcnaughton commented May 1, 2018

guanhuan commented May 2, 2018

MiyaNoctem commented May 3, 2018

eileenmcnaughton commented May 3, 2018

MiyaNoctem commented May 4, 2018

eileenmcnaughton commented May 7, 2018

eileenmcnaughton May 7, 2018

eileenmcnaughton May 7, 2018

MiyaNoctem commented May 10, 2018

eileenmcnaughton commented May 10, 2018

dev/core#38 Show Recurring Contributions on Membership Modal View #11903

dev/core#38 Show Recurring Contributions on Membership Modal View #11903

Conversation

MiyaNoctem commented Mar 30, 2018 • edited Loading

Overview

Before

After

Technical Details

Comments

seamuslee001 Mar 30, 2018

Choose a reason for hiding this comment

MiyaNoctem Apr 6, 2018

Choose a reason for hiding this comment

eileenmcnaughton Mar 31, 2018

Choose a reason for hiding this comment

eileenmcnaughton commented Mar 31, 2018

mattwire commented Mar 31, 2018

eileenmcnaughton commented Apr 1, 2018

MiyaNoctem commented Apr 6, 2018 • edited Loading

eileenmcnaughton commented Apr 6, 2018

MiyaNoctem commented Apr 9, 2018

MiyaNoctem commented Apr 16, 2018

eileenmcnaughton commented Apr 16, 2018

MiyaNoctem commented Apr 17, 2018

MiyaNoctem commented Apr 18, 2018

MiyaNoctem commented Apr 19, 2018

MiyaNoctem commented Apr 19, 2018

eileenmcnaughton commented Apr 22, 2018

guanhuan commented Apr 26, 2018

MiyaNoctem commented May 1, 2018

eileenmcnaughton commented May 1, 2018

guanhuan commented May 2, 2018

MiyaNoctem commented May 3, 2018

eileenmcnaughton commented May 3, 2018

MiyaNoctem commented May 4, 2018

eileenmcnaughton commented May 7, 2018

eileenmcnaughton May 7, 2018

Choose a reason for hiding this comment

eileenmcnaughton May 7, 2018

Choose a reason for hiding this comment

MiyaNoctem commented May 10, 2018

eileenmcnaughton commented May 10, 2018

MiyaNoctem commented Mar 30, 2018 •

edited

Loading

MiyaNoctem commented Apr 6, 2018 •

edited

Loading