dev/core#1403 - CRM/Contribute - Change "Date Received" to "Contribution Date"

[olayiwola-compucorp]

Overview

Development work for https://lab.civicrm.org/dev/core/-/issues/1403

This PR updates the Contribution receive_date title/label from Date Received to Contribution Date so it's clear that the date is the contribution date. Also, the receive_date description /commenthas been removed.

Before

The contribution receive_date has the title Date Received or Received.

After

The contribution receive_date title has now been changed to Contribution Date.

e.g.
New/Edit Contribution Screen

Contact Contributions

Contribution Searckit

New Membership Screen

In summary, the changes will affect screens such as the Contribution Import/Export screen which previously used "Date Received" or "Received" as a label for the Contribution "receive_date" field.

[civibot]

No issue was found matching the number given in the pull request title. Please check the issue number.

[civicrm-builder]

Can one of the admins verify this patch?

[civicrm-builder]

Can one of the admins verify this patch?

[civibot]

(Standard links)

• If you are reviewing this pull-request, you may wish to consult the test sites and the Review Standards (long template, short template).

[larssandergreen]

I have reviewed.
Code changes look good, except we need to update the schema here and then run GenCode.php (see the top info box here) to regenerate the DAO file, rather than editing it directly.
No issues on r-run.

It looks like the consensus in the linked issue was to change the label to "Contribution date" and this changes to "Date", but I think it is clear that it is a contribution date in context and "Contribution date" would be redundant, so that seems better to me.

There are also a lot more places where Received Date or just Received is used. I think it would make sense to update all of those at the same time in this PR.

Wouldn't it make sense to change the descriptions at the same time? Since we're saying this is not, in some cases, actually the receive date, it doesn't really make sense to have a description that says something about the date the contribution was received. I think different orgs are going to use date differently and we shouldn't be trying to describe specific use cases. I'm in favour of removing the description entirely, both the schema comment and where it appears on forms.

[kcristiano]

I agree @larssandergreen about the approved label change. I think Date is too ambiguous and will cause confusion. I'd have brought this up on the issue had it been simply Date. I think that it needs more clarification. What Date? If Pay Later does this reflect the original Date or the date Payment was received? How does it relate to Transaction Date? I'd rather see this label as Contribution Date and not simply Date.

[magnolia61]

Agree!
"Contribution date" would be a welcome alternative. Just 'date' would be too general

[demeritcowboy]

jenkins test this please

[demeritcowboy]

jenkins retest this please

[demeritcowboy]

Just commenting based on the discussion this would be mergeable, but I haven't merged yet because the tests haven't run and I can't seem to get them to run (note it only says 2 checks have run - those are the style check and test site build, but not the actual unit tests).

I think maybe an admin needs to add to whitelist to get them to run?

[larssandergreen]

I had a quick look and looks good, but there is one "Received" still here and another here, another here, and here, here, some "Received Date" here and here.

There are more, but I'm not able to catalogue them all here right now. So I think perhaps best to wait to merge to make this change in full?

[larssandergreen]

Few more here and here.

There are also a few in the tests here and here that will need to be updated.

There are also two instances of "Received" in civicrm_uf_field in civicrm_data.tpl, which I believe will require changing and adding upgrade SQL to change this in existing installations.

I think that's it.

[seamuslee001]

Jenkins add to whitelist

[olayiwola-compucorp]

Thanks for the review @larssandergreen, The necessary "Received" or "Received Date" fields have all been changed to "Contribution Date".

Except for those in https://github.com/civicrm/civicrm-core/blob/master/sql/civicrm_generated.mysql, running the GenCode script doesn't update them.

[larssandergreen]

To update civicrm_generated.mysql, you need to run bin/regen.sh.

But when you update civicrm_data.tpl, you also need to update this data on existing installations (since this file is only used on install), which you do by adding SQL in CRM/Upgrade/Incremental/sql/5.63.alpha1.mysql.tpl (you can see samples of this in upgrades for past versions in the same folder).

[demeritcowboy]

Note when you run regen.sh it will then fail unrelated tests because a recent membership wording change was merged that needs some tests updated first.

It's a bit messy right now.

Note you can also run regen online in your fork: see https://github.com/civicrm/civicrm-core/blob/master/.github/workflows/regen.yml

[demeritcowboy]

The test is failing because this would need to be done in php and accounting for multilingual where the field is called label_enUS, etc, like in FiveThirtyOne.php. But I think it would also be ok to leave it out so we can get this merged.

[larssandergreen]

Suggested change

	UPDATE civicrm_uf_field SET label = '{ts escape="sql"}Contribution Date{/ts}' WHERE field_name = 'receive_date';
	{if $multilingual}
	{foreach from=$locales item=locale}
	UPDATE IGNORE civicrm_uf_field SET label_{$locale} = '{ts escape="sql"}Contribution Date{/ts}' WHERE field_name = 'receive_date';
	{/foreach}
	{else}
	UPDATE IGNORE civicrm_uf_field SET label = '{ts escape="sql"}Contribution Date{/ts}' WHERE field_name = 'receive_date';
	{/if}

Sorry, I should have thought to mention that. This should do the job. It still works in SQL, @demeritcowboy?

[larssandergreen]

I mean, it does work, I tested it. But there's no specific reason we can't still use SQL here, is what I meant.

[olayiwola-compucorp]

@larssandergreen, thanks for the suggestion it looks good, is it okay to commit?
or do we want to leave it as it is?

[demeritcowboy]

It can't be left as is, and now there is also a merge conflict. Either sql or php but also it should only change it if the current label is Date Received, otherwise it will overwrite someone's preferred wording if they already changed it in the profile.

[demeritcowboy]

Hi @olayiwola-compucorp it's still failing tests since this is the same code as before. Can I suggest leaving this out and then we can merge the rest? You can always put up another PR after.

[magnolia61]

Would this also change the name of the token? from {contribution.receive_date} to {contribution.date}
I think that would be consistent, could not find that change but maybe I overlooked

[olayiwola-compucorp]

@magnolia61 This change wouldn't affect the name of the token, that would require making changes to the schema.

This PR only changes the label/title the field name still remains as receive_date

[demeritcowboy]

Yay.

@olayiwola-compucorp Can you make a PR to add yourself to contributor-key.yml for release notes credit?

[olayiwola-compucorp]

Thanks @demeritcowboy, done #26225

[jamienovick]

Great job @olayiwola-compucorp and a big thank you to everyone on this ticket who has got this over the line. One small change for civi, a giant leap for civi-kind!