Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix non-donation / ecommerce terminology in actions and filters #896

Closed
3 of 5 tasks
DevinWalker opened this issue Aug 15, 2016 · 12 comments
Closed
3 of 5 tasks

Fix non-donation / ecommerce terminology in actions and filters #896

DevinWalker opened this issue Aug 15, 2016 · 12 comments
Assignees
@DevinWalker @ravinderk @mehul0810 @raftaar1191

Comments

@DevinWalker
Copy link
Member

DevinWalker commented Aug 15, 2016 •
edited

There are many actions and filters throughout the plugin which use ecommmerce terminology such as give_purchase_form, give_purchase_form_wrap_bottom, give_purchase_form_before_submit, etc.

We should deprecate them and replace with donation based terminology. give_purchase_form --> give_donation_form, give_purchase_form_wrap_bottom -> give_donation_form_wrap_bottom

Task list:

  • Rename directories
  • Rename variables
  • Rename hooks (actions + filters)
  • Rename classes
  • Rename db tables w/ upgrade routine

All items above with backwards compatibility
@DevinWalker DevinWalker added this to the 1.9 milestone Aug 15, 2016
@ramiy
Copy link
Contributor

ramiy commented Aug 17, 2016

Agree, we need to consolidate Give terminology.

Here is another example for three different names for the same thing:

ternimology

I think we need to fix the front-end first, and only then the classes/functions/hooks names.

@ramiy
Copy link
Contributor

ramiy commented Aug 17, 2016

As for the purchase, it is deeply embedded in the code. We have function names using this word, class properties and methods, and maybe even options (not sure about the last one - I need to check that).

It's a backwards-compatibility nightmare.

@DevinWalker
Copy link
Member Author

Yeah I know, that's why I've been resisting it. This is an ongoing gradual task.

@DevinWalker
Copy link
Member Author

Link for reference to _deprecated_hook function new to WP 4.6

Changeset: https://core.trac.wordpress.org/changeset/37861

Ticket: https://core.trac.wordpress.org/ticket/10441

@DevinWalker DevinWalker removed this from the 1.9 milestone Aug 17, 2016
@ramiy
Copy link
Contributor

ramiy commented Aug 17, 2016

@DevinWalker Translations strings updates are simpler and faster. I can do it in 1.7 , I just need know which word is preferred?

@DevinWalker
Copy link
Member Author

"Transactions" -> "Donations"

"Payment" -> "Donation"

@mathetos thoughts?

DevinWalker pushed a commit that referenced this issue Aug 17, 2016
Fixes JS selector bug due to removal of tables #887
7c561a7 
Updated name of function #896
@ramiy ramiy mentioned this issue Aug 17, 2016
Merged
DevinWalker pushed a commit that referenced this issue Aug 22, 2016
Change log item for #896 added
3b17d28
DevinWalker pushed a commit that referenced this issue Aug 22, 2016
Merge branch 'release/1.7' into issue/176
2c001e8 
* release/1.7: (765 commits)
  Change log added for #922
  Change log item for #896 added
  Change log for #712 added
  a11y: add H1 heading to admin "Donor" screen
  Document filter hooks
  Fix issues #712
  a11y: progress bar accessibility
  a11y: table accessibility in about page
  a11y: table accessibility in export page
  a11y: table accessibility in reports page, and remove un-needed labels and classes
  a11y: table accessibility in donor profile page
  a11y: table accessibility for [give_receipt] shortcode
  a11y: table accessibility for [donation_history] shortcode
  a11y: fix label `for` attribute to focus on the texarea `id`
  a11y: replace `title` attributes with `aria-label`
  Improved Add-on banner style
  Docs: update functions phpDocs
  Docs: document template action hooks
  Fixed variable name
  Fix failing test for file that we removed
  ...

# Conflicts:
#	assets/css/give-admin.min.css
#	assets/js/admin/admin-forms.js
#	assets/js/admin/admin-forms.min.js
#	assets/js/frontend/give.js
#	assets/js/frontend/give.min.js
#	assets/sourcemaps/give-admin.css.map
#	assets/sourcemaps/give.css.map
#	includes/admin/forms/metabox.php
#	includes/admin/payments/actions.php
#	includes/admin/payments/view-order-details.php
#	includes/admin/upgrades/upgrade-functions.php
#	includes/admin/upgrades/upgrades.php
#	includes/class-give-customer.php
#	includes/class-give-db.php
#	includes/class-give-donate-form.php
#	includes/class-give-stats.php
#	includes/emails/class-give-email-tags.php
#	includes/forms/functions.php
#	includes/forms/template.php
#	includes/payments/actions.php
#	includes/payments/class-give-payment.php
#	includes/payments/class-payments-query.php
#	includes/payments/functions.php
#	includes/price-functions.php
#	includes/scripts.php
#	includes/user-functions.php
#	readme.txt
#	templates/give.min.css
#	templates/shortcode-receipt.php
#	tests/framework/helpers/class-helper-form.php
#	tests/framework/helpers/class-helper-payment.php
#	tests/unit-tests/tests-payment-class.php
DevinWalker pushed a commit that referenced this issue Aug 22, 2016
Merge branch 'release/1.7' into issue/357
29028bd 
* release/1.7: (929 commits)
  Change log added for #922
  Change log item for #896 added
  Change log for #712 added
  a11y: add H1 heading to admin "Donor" screen
  Document filter hooks
  Fix issues #712
  a11y: progress bar accessibility
  a11y: table accessibility in about page
  a11y: table accessibility in export page
  a11y: table accessibility in reports page, and remove un-needed labels and classes
  a11y: table accessibility in donor profile page
  a11y: table accessibility for [give_receipt] shortcode
  a11y: table accessibility for [donation_history] shortcode
  a11y: fix label `for` attribute to focus on the texarea `id`
  a11y: replace `title` attributes with `aria-label`
  Improved Add-on banner style
  Docs: update functions phpDocs
  Docs: document template action hooks
  Fixed variable name
  Fix failing test for file that we removed
  ...
DevinWalker pushed a commit that referenced this issue Aug 22, 2016
Merge branch 'release/1.7' into issue/370
f5b6c5c 
* release/1.7: (66 commits)
  Change log added for #922
  Change log item for #896 added
  Change log for #712 added
  a11y: add H1 heading to admin "Donor" screen
  Document filter hooks
  Fix issues #712
  a11y: progress bar accessibility
  a11y: table accessibility in about page
  a11y: table accessibility in export page
  a11y: table accessibility in reports page, and remove un-needed labels and classes
  a11y: table accessibility in donor profile page
  a11y: table accessibility for [give_receipt] shortcode
  a11y: table accessibility for [donation_history] shortcode
  a11y: fix label `for` attribute to focus on the texarea `id`
  a11y: replace `title` attributes with `aria-label`
  Improved Add-on banner style
  Docs: update functions phpDocs
  Docs: document template action hooks
  Fixed variable name
  Fix failing test for file that we removed
  ...

# Conflicts:
#	includes/forms/template.php
DevinWalker pushed a commit that referenced this issue Aug 22, 2016
Merge branch 'release/1.7' into issue/668
022da05 
* release/1.7: (316 commits)
  Change log added for #922
  Change log item for #896 added
  Change log for #712 added
  a11y: add H1 heading to admin "Donor" screen
  Document filter hooks
  Fix issues #712
  a11y: progress bar accessibility
  a11y: table accessibility in about page
  a11y: table accessibility in export page
  a11y: table accessibility in reports page, and remove un-needed labels and classes
  a11y: table accessibility in donor profile page
  a11y: table accessibility for [give_receipt] shortcode
  a11y: table accessibility for [donation_history] shortcode
  a11y: fix label `for` attribute to focus on the texarea `id`
  a11y: replace `title` attributes with `aria-label`
  Improved Add-on banner style
  Docs: update functions phpDocs
  Docs: document template action hooks
  Fixed variable name
  Fix failing test for file that we removed
  ...
@ravinderk ravinderk mentioned this issue Aug 24, 2016
Merged
@DevinWalker DevinWalker changed the title Fix ecommerce terminology in actions and filters Fix non-donation / ecommerce terminology in actions and filters Aug 26, 2016
DevinWalker pushed a commit that referenced this issue Aug 26, 2016
Readme logs added for #896 and #773
7c54b80
DevinWalker pushed a commit that referenced this issue Aug 29, 2016
Merge branch 'release/1.7' into issue/619
c4ca573 
* release/1.7: (177 commits)
  Added change log for #964
  Make exception message translatable
  Update give_do_automatic_upgrades function
  Move upgades to 1.7
  Update function version from 1.6 to 1.7
  add missing `echo` after 9a2f35d
  Set gulp textdomain task autocorretion to true
  Update more action names #957
  Update actions to use newly termed ones rather than now deprecated ones #957
  Version bump for release/1.7 branch
  Change log added for #687
  Readme logs added for #896 and #773
  replace `edd` text-domain with `give`
  replace esc_attr_e() with esc_attr()
  add misisng text-domain
  gulp task
  Update doc block in formatting.php
  Refresh current month transient when payment update
  Add function to get stat transient key
  Update description in Give Settings Screen
  ...
@ramiy
Copy link
Contributor

ramiy commented Aug 30, 2016

@DevinWalker @mathetos

One more terminology suggestion: Donators > Donors

Ref: https://github.com/WordImpress/Give/blob/master/includes/class-give-gravatars.php

Do you agree?

DevinWalker pushed a commit that referenced this issue Aug 30, 2016
Better filter naming give_recount_customer_donation_statuses -> give_…
09cc8a7 
…recount_donors_donation_statuses and give_customer_recount_should_process_donation -> give_donor_recount_should_process_donation

#957 #896
@DevinWalker
Copy link
Member Author

@ramiy yes definitely, that class isn't being used yet though :(

@ramiy ramiy mentioned this issue Aug 30, 2016
Closed
DevinWalker added a commit that referenced this issue May 31, 2017
@DevinWalker
Renaming Give_Customer() -> Give_Donor() #896
eda2931
DevinWalker added a commit that referenced this issue May 31, 2017
@DevinWalker
Renamed file class-give-customer.php -> class-give-donor.php #896
88f78ae
DevinWalker added a commit that referenced this issue May 31, 2017
@DevinWalker
Deprecated a bunch of old customer actions, renamed *_purchase_count() …
52deb1b 
…#896
DevinWalker added a commit that referenced this issue May 31, 2017
@DevinWalker
Deprecated give_checkout_form_top and bottom #896
067d60f
DevinWalker added a commit that referenced this issue Jun 1, 2017
@DevinWalker
New __get() and updated constructor for Give_Customer backwards compa…
5cc9cda 
…tiblity #896
DevinWalker added a commit that referenced this issue Jun 1, 2017
@DevinWalker
Renamed admin customer files to donor #896
c467053
DevinWalker added a commit that referenced this issue Jun 1, 2017
@DevinWalker
donor-functions.php is fully de-customerized #896
9574ccc
DevinWalker added a commit that referenced this issue Jun 1, 2017
@DevinWalker
Continuing terminology updates in donor admin views #896
1c54971
DevinWalker added a commit that referenced this issue Jun 1, 2017
@DevinWalker
Remove use of "customer" from class-give-api.php #896
d9380e1
DevinWalker added a commit that referenced this issue Jun 1, 2017
@DevinWalker
Deprecated give_get_payment_customer_id( ) for give_get_payment_donor…
509351c 
…_id( ) #896
DevinWalker added a commit that referenced this issue Jun 1, 2017
@DevinWalker
Deprecated give_get_total_sales() for give_get_total_donations() #896
4b65e55 
Renamed a bunch of $customer vars to $donor
DevinWalker added a commit that referenced this issue Jun 1, 2017
@DevinWalker
Deprecated give_count_purchases_of_customer for give_count_donations_…
f3643d6 
…of_donor #896
DevinWalker added a commit that referenced this issue Jun 1, 2017
@DevinWalker
Deprecated give_get_purchase_stats_by_user() for give_get_donatiion_s…
dd55482 
…tats_by_user() #896
DevinWalker added a commit that referenced this issue Jun 1, 2017
@DevinWalker
Deprecated give_get_users_purchases() for give_get_users_donations() #…
f6faeff 
…896
DevinWalker added a commit that referenced this issue Jun 1, 2017
@DevinWalker
Deprecated a number of addition user functions using the word "purcha…
3157b30 
…se" #896
DevinWalker added a commit that referenced this issue Jun 1, 2017
@DevinWalker
Continuing deprecating $customer for $donor throughout #896
0d255f3
DevinWalker added a commit that referenced this issue Jun 1, 2017
@DevinWalker
Updating batch export class and var names #896
a137f9a
DevinWalker added a commit that referenced this issue Jun 1, 2017
@DevinWalker
Lots of class updates in html, scss, and JS from customer to donor te…
d3e6406 
…rminology #896
DevinWalker added a commit that referenced this issue Jun 2, 2017
@DevinWalker
View "order" details is now view "payment" details throughout #896
c201ad7
DevinWalker added a commit that referenced this issue Jun 2, 2017
@DevinWalker
Deprecated functions with the word _purchase_ #896
c9bd7ee
DevinWalker added a commit that referenced this issue Jun 2, 2017
@DevinWalker
Deprecated additional functions give_increase_purchase_count and give…
8929f7e 
…_trigger_purchase_delete #896
DevinWalker added a commit that referenced this issue Jun 2, 2017
@DevinWalker
Deprecated action give_pre_complete_purchase for give_pre_complete_do…
268c3f6 
…nation #896
@DevinWalker DevinWalker mentioned this issue Aug 5, 2017
Closed
@DevinWalker
Copy link
Member Author

This bulk of this task is done. As we continue to refactor we can take care of the remaining hooks and variables.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@DevinWalker DevinWalker

@ravinderk ravinderk

@mehul0810 mehul0810

@raftaar1191 raftaar1191

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
5 participants
@ramiy @DevinWalker @ravinderk @mehul0810 @raftaar1191