jfinn
/
edan_f0
Watch 1
Star 0
Fork 0
Code Issues 0 Pull Requests 0 Releases 0 Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
2646 Commits
1 Branch
Tree: f9f95f8bcb
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'f9f95f8bcb'
${ noResults }
edan_f0/docs/source/reference/signals.rst

signals.rst 2.0KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119 
  1. =======

  2. Signals

  3. =======

  4. 

  5. Oscar implements a number of custom signals that provide useful hook-points for

  6. adding functionality.

  7. 

  8. product_viewed

  9. --------------

  10. 

  11. .. data:: oscar.apps.catalogue.signals.product_viewed

  12.     :class:

  13. 

  14. Raised when a product detail page is viewed.  

  15. 

  16. Arguments sent with this signal:

  17. 

  18. ``product``

  19.     The product being viewed

  20. 

  21. ``user``

  22.     The user in question

  23. 

  24. ``request``

  25.     The request instance

  26. 

  27. ``response``

  28.     The response instance

  29. 

  30. product_search

  31. --------------

  32. 

  33. .. data:: oscar.apps.catalogue.signals.product_search

  34.     :class:

  35. 

  36. Raised when a search is performed.

  37. 

  38. Arguments sent with this signal:

  39. 

  40. ``query``

  41.     The search term

  42. 

  43. ``user``

  44.     The user in question

  45. 

  46. basket_addition

  47. ---------------

  48. 

  49. .. data:: oscar.apps.basket.signals.basket_addition

  50.     :class:

  51. 

  52. Raised when a product is added to a basket

  53. 

  54. Arguments sent with this signal:

  55. 

  56. ``product``

  57.     The product being added

  58. 

  59. ``user``

  60.     The user in question

  61. 

  62. voucher_addition

  63. ----------------

  64. 

  65. .. data:: oscar.apps.basket.signals.voucher_addition

  66.     :class:

  67. 

  68. Raised when a valid voucher is added to a basket

  69. 

  70. Arguments sent with this signal:

  71. 

  72. ``basket``

  73.     The basket in question

  74. 

  75. ``voucher``

  76.     The voucher in question

  77. 

  78. pre_payment

  79. -----------

  80. 

  81. .. data:: oscar.apps.checkout.signals.pre_payment

  82.     :class:

  83. 

  84. Raised immediately before attempting to take payment in the checkout.

  85. 

  86. Arguments sent with this signal:

  87. 

  88. ``view``

  89.     The view class instance

  90. 

  91. post_payment

  92. ------------

  93. 

  94. .. data:: oscar.apps.checkout.signals.post_payment

  95.     :class:

  96. 

  97. Raised immediately after payment has been taken.

  98. 

  99. Arguments sent with this signal:

  100. 

  101. ``view``

  102.     The view class instance

  103. 

  104. order_placed

  105. ------------

  106. 

  107. .. data:: oscar.apps.order.signals.order_placed

  108.     :class:

  109. 

  110. Raised by the :class:`oscar.apps.order.utils.OrderCreator` class when creating an order.

  111. 

  112. Arguments sent with this signal:

  113. 

  114. ``order``

  115.     The order created

  116. 

  117. ``user``

  118.     The user creating the order (not necessarily the user linked to the order

  119.     instance!)