You are here

README.txt in Ubercart Addresses 6

Same filename and directory in other branches
  1. 5.2 README.txt
  2. 5 README.txt
  3. 6.2 README.txt
  4. 7 README.txt
uc_addresses Module
------------------------
by Tony Freixas

This module was originally authored by Ben Thompson. I've made a lot
of changes since acquiring the module.

The module changes the way Ubercart handles addresses. By default,
Ubercart looks at a customer's previous orders and finds all unique
addresses. It displays these in a select box, using the Street Address
as a label. A customer who has registered but never ordered will have
no contact information other than an e-mail address.

With this module installed, user addresses are stored in a new
database table, one that the user can manipulate as part of the user
profile.

One caveat: The admin order system continues to work as it always did.
Addresses come from previous orders and not from the uc_addresses
table. This trips up a lot of people.

Module overview:
---------------------

When users create an account, you can request that they be asked to
provide contact information. This initial entry can be edited later.

When users visit their "My account" page, a new tab will be present:
Addresses. They will be able to:

  * Add a new address
  * Edit an existing address
  * Mark any one address as the "default"
  * Delete any address except the "default" address

Each address can be given a short "nickname".

When placing an order, users will be able to:

  * Select an address from the set that appears in their profile
  * Modify the address for the order and save it as another address in
    their profile.

At your discretion, the delivery and/or the billing address can be
pre-filled with the user's "default" address.

  Warning: If pre-filling the delivery address and you charge for
  shipping, be sure to require that the user select a shipping method
  before they can place an order. Otherwise, the order may go through
  without shipping being charged. You may also want to use the
  Auto-calculate Shipping module to make things easier for your users.

Instead of selecting an address by street name, the selector will
display the address's nickname or else the entire address: Name,
street1, street2, city, etc.

To accommodate sites that have existing users, the code will work even
when users have no addresses.

Note: when a user is deleted, all their address are also deleted.

Dependencies
------------

This module requires uc_order and uc_store.

Installation
------------

  * Copy the uc_addresses module's directory to your modules directory
    and activate it. I have mine in /sites/all/modules/uc_addresses.
  * Activate the module, set up permissions and go to your account
    page to begin using the new Addresses tab.


Permissions
-----------

view default addresses: Roles with this permission can view anyone's
default address.

view all addresses: Roles with this permission can view anyone's list
of addresses.

add/edit addresses: Roles with this permission can add to or edit
anyone's address list. To be useful, roles with this permission can
also view anyone's list of addresses.

To be complete, I should add 'view own default address', 'view own
addresses', and 'add/edit own addresses', but I can't see that any of
these make sense.

Tony Freixas
tony@tigerheron.com
http://www.tigerheron.com

File

README.txt
View source
  1. uc_addresses Module
  2. ------------------------
  3. by Tony Freixas
  4. This module was originally authored by Ben Thompson. I've made a lot
  5. of changes since acquiring the module.
  6. The module changes the way Ubercart handles addresses. By default,
  7. Ubercart looks at a customer's previous orders and finds all unique
  8. addresses. It displays these in a select box, using the Street Address
  9. as a label. A customer who has registered but never ordered will have
  10. no contact information other than an e-mail address.
  11. With this module installed, user addresses are stored in a new
  12. database table, one that the user can manipulate as part of the user
  13. profile.
  14. One caveat: The admin order system continues to work as it always did.
  15. Addresses come from previous orders and not from the uc_addresses
  16. table. This trips up a lot of people.
  17. Module overview:
  18. ---------------------
  19. When users create an account, you can request that they be asked to
  20. provide contact information. This initial entry can be edited later.
  21. When users visit their "My account" page, a new tab will be present:
  22. Addresses. They will be able to:
  23. * Add a new address
  24. * Edit an existing address
  25. * Mark any one address as the "default"
  26. * Delete any address except the "default" address
  27. Each address can be given a short "nickname".
  28. When placing an order, users will be able to:
  29. * Select an address from the set that appears in their profile
  30. * Modify the address for the order and save it as another address in
  31. their profile.
  32. At your discretion, the delivery and/or the billing address can be
  33. pre-filled with the user's "default" address.
  34. Warning: If pre-filling the delivery address and you charge for
  35. shipping, be sure to require that the user select a shipping method
  36. before they can place an order. Otherwise, the order may go through
  37. without shipping being charged. You may also want to use the
  38. Auto-calculate Shipping module to make things easier for your users.
  39. Instead of selecting an address by street name, the selector will
  40. display the address's nickname or else the entire address: Name,
  41. street1, street2, city, etc.
  42. To accommodate sites that have existing users, the code will work even
  43. when users have no addresses.
  44. Note: when a user is deleted, all their address are also deleted.
  45. Dependencies
  46. ------------
  47. This module requires uc_order and uc_store.
  48. Installation
  49. ------------
  50. * Copy the uc_addresses module's directory to your modules directory
  51. and activate it. I have mine in /sites/all/modules/uc_addresses.
  52. * Activate the module, set up permissions and go to your account
  53. page to begin using the new Addresses tab.
  54. Permissions
  55. -----------
  56. view default addresses: Roles with this permission can view anyone's
  57. default address.
  58. view all addresses: Roles with this permission can view anyone's list
  59. of addresses.
  60. add/edit addresses: Roles with this permission can add to or edit
  61. anyone's address list. To be useful, roles with this permission can
  62. also view anyone's list of addresses.
  63. To be complete, I should add 'view own default address', 'view own
  64. addresses', and 'add/edit own addresses', but I can't see that any of
  65. these make sense.
  66. Tony Freixas
  67. tony@tigerheron.com
  68. http://www.tigerheron.com