You are here

Home » API reference » UC Wish List 7

README.txt in UC Wish List 7

Same filename and directory in other branches
  1. 6 README.txt
/**
 * uc_wishlist: Wish List / Gift Registry module for Ubercart
 *
 * 2.x development sponsored by Commerce Guys (http://www.commerceguys.com)
 *
 * Original credits, 1.x development:
 *
 * Developed by Joe Turgeon (http://arithmetric.com)
 * Sponsored by Sundays Energy (http://sundaysenergy.com)
 * Version 0.7 (November/11/2008)
 * Licensed under GPLv2
 */

1. ABOUT

uc_wishlist is a module that adds wish list/gift registry functionality
to Ubercart.

This module has been tested with Ubercart 2.0-beta5.

2. INSTALLATION

Download the latest release of this module from:
http://drupal.org/project/uc_wishlist

Uncompress the archive in your Ubercart contrib directory:
[your Drupal root]/sites/all/modules/ubercart/contrib

Enable the Wish list module under 'Ubercart - extra' in the
Drupal module administration page.

3. FEATURES

This module enables users to create a gift list for use as a personal
shopping list or a public gift registry. An 'Add to wish list' button
is added wherever there is an 'Add to cart' button.

4. DEVELOPMENT

The number of products purchased from a user's wish list is tracked
through a uc_order hook. When an item is added to the shopping cart
from a wish list, extra information (the wish list and wish list
product id) is added to the data array. When a sale is completed
(and the order state changes to post_checkout) the order is checked
for items that came from a wish list. If any are found, the corresponding
wish list items are updated, and information about the order (the order
id, order product id, user id, and time) are added to the purchase field
in the wish list products table.

The module introduces two new tables:

{uc_wishlists}
wid (int) -- wish list id
uid (text) -- user id or session id
title (text) -- wish list title
date (int) -- wish list expiration time
address (text) -- serialized object of delivery address fields

{uc_wishlist_products}
wpid (int) -- wish list product id
wid (int) -- wish list id
nid (int) -- product node id
qty (int) -- quantity wanted
changed (int) -- timestamp of last modification
data (text) -- serialized array of product attributes and data
purchase (text) -- serialized array of purchase records

Please post questions, comments, or suggestions to the project's issue tracker:
http://drupal.org/project/issues/uc_wishlist

File

README.txt
View source 
  1. /**

  2.  * uc_wishlist: Wish List / Gift Registry module for Ubercart

  3.  *

  4.  * 2.x development sponsored by Commerce Guys (http://www.commerceguys.com)

  5.  *

  6.  * Original credits, 1.x development:

  7.  *

  8.  * Developed by Joe Turgeon (http://arithmetric.com)

  9.  * Sponsored by Sundays Energy (http://sundaysenergy.com)

  10.  * Version 0.7 (November/11/2008)

  11.  * Licensed under GPLv2

  12.  */

  13. 

  14. 1. ABOUT

  15. 

  16. uc_wishlist is a module that adds wish list/gift registry functionality

  17. to Ubercart.

  18. 

  19. This module has been tested with Ubercart 2.0-beta5.

  20. 

  21. 2. INSTALLATION

  22. 

  23. Download the latest release of this module from:

  24. http://drupal.org/project/uc_wishlist

  25. 

  26. Uncompress the archive in your Ubercart contrib directory:

  27. [your Drupal root]/sites/all/modules/ubercart/contrib

  28. 

  29. Enable the Wish list module under 'Ubercart - extra' in the

  30. Drupal module administration page.

  31. 

  32. 3. FEATURES

  33. 

  34. This module enables users to create a gift list for use as a personal

  35. shopping list or a public gift registry. An 'Add to wish list' button

  36. is added wherever there is an 'Add to cart' button.

  37. 

  38. 4. DEVELOPMENT

  39. 

  40. The number of products purchased from a user's wish list is tracked

  41. through a uc_order hook. When an item is added to the shopping cart

  42. from a wish list, extra information (the wish list and wish list

  43. product id) is added to the data array. When a sale is completed

  44. (and the order state changes to post_checkout) the order is checked

  45. for items that came from a wish list. If any are found, the corresponding

  46. wish list items are updated, and information about the order (the order

  47. id, order product id, user id, and time) are added to the purchase field

  48. in the wish list products table.

  49. 

  50. The module introduces two new tables:

  51. 

  52. {uc_wishlists}

  53. wid (int) -- wish list id

  54. uid (text) -- user id or session id

  55. title (text) -- wish list title

  56. date (int) -- wish list expiration time

  57. address (text) -- serialized object of delivery address fields

  58. 

  59. {uc_wishlist_products}

  60. wpid (int) -- wish list product id

  61. wid (int) -- wish list id

  62. nid (int) -- product node id

  63. qty (int) -- quantity wanted

  64. changed (int) -- timestamp of last modification

  65. data (text) -- serialized array of product attributes and data

  66. purchase (text) -- serialized array of purchase records

  67. 

  68. Please post questions, comments, or suggestions to the project's issue tracker:

  69. http://drupal.org/project/issues/uc_wishlist

  70.