You are here

README.txt in Ubercart Addresses 5

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

Most of the code in this module was written by Ben Thompson. I (Tony
Freixas) adapted the code, giving it a rather different mode of
operation.

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.

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

When users create an account, they will be asked to provide contact
information. This initial entry can be edited later, but not deleted.

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
  * Delete any address except the first one

When placing an order, users will be able to:

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

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

Unlike core Ubercart and unlike Ben's original code, the orders are
never searched for addresses.

To accommodate sites that have existing users, the code will work even
when users have no addresses. Once they save the first address, it
will become their default contact information and they won't be
allowed to delete it.

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.

If you installed a version of Ben's module, you will need to disable
and uninstall it. I've kept the same database name, but the fields are
slightly different.

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 Ben Thompson
  4. modified by Tony Freixas
  5. Most of the code in this module was written by Ben Thompson. I (Tony
  6. Freixas) adapted the code, giving it a rather different mode of
  7. operation.
  8. The module changes the way Ubercart handles addresses. By default,
  9. Ubercart looks at a customer's previous orders and finds all unique
  10. addresses. It displays these in a select box, using the Street Address
  11. as a label. A customer who has registered but never ordered will have
  12. no contact information other than an e-mail address.
  13. With this module installed, user addresses are stored in a new
  14. database table, one that the user can manipulate as part of the user profile.
  15. Module overview:
  16. ---------------------
  17. When users create an account, they will be asked to provide contact
  18. information. This initial entry can be edited later, but not deleted.
  19. When users visit their "My account" page, a new tab will be present:
  20. Addresses. They will be able to:
  21. * Add a new address
  22. * Edit an existing address
  23. * Delete any address except the first one
  24. When placing an order, users will be able to:
  25. * Select an address from the set that appears in their profile
  26. * Modify the address, but just for the order
  27. * Modify the address for the order and save it as another address in
  28. their profile.
  29. Instead of selecting an address by street name, the selector will
  30. display the entire address: Name, street1, street2, city, etc.
  31. Unlike core Ubercart and unlike Ben's original code, the orders are
  32. never searched for addresses.
  33. To accommodate sites that have existing users, the code will work even
  34. when users have no addresses. Once they save the first address, it
  35. will become their default contact information and they won't be
  36. allowed to delete it.
  37. Note: when a user is deleted, all their address are also deleted.
  38. Dependencies
  39. ------------
  40. This module requires uc_order and uc_store.
  41. Installation
  42. ------------
  43. * Copy the uc_addresses module's directory to your modules directory
  44. and activate it. I have mine in /sites/all/modules/uc_addresses.
  45. * Activate the module, set up permissions and go to your account
  46. page to begin using the new Addresses tab.
  47. If you installed a version of Ben's module, you will need to disable
  48. and uninstall it. I've kept the same database name, but the fields are
  49. slightly different.
  50. Permissions
  51. -----------
  52. view default addresses: Roles with this permission can view anyone's
  53. default address.
  54. view all addresses: Roles with this permission can view anyone's list
  55. of addresses.
  56. add/edit addresses: Roles with this permission can add to or edit
  57. anyone's address list. To be useful, roles with this permission can
  58. also view anyone's list of addresses.
  59. To be complete, I should add 'view own default address', 'view own
  60. addresses', and 'add/edit own addresses', but I can't see that any of
  61. these make sense.
  62. Tony Freixas
  63. tony@tigerheron.com
  64. http://www.tigerheron.com