PageRenderTime 156ms CodeModel.GetById 13ms RepoModel.GetById 0ms app.codeStats 0ms

/docs/ref/contrib/comments/signals.txt

https://code.google.com/p/mango-py/
Plain Text | 91 lines | 64 code | 27 blank | 0 comment | 0 complexity | 9e60ad21cf4c26a23ccf387ea2df6b7d MD5 | raw file
Possible License(s): BSD-3-Clause 
    

  1. ================================
    2. 

  2. Signals sent by the comments app
    3. 

  3. ================================
    4. 

  4. 

  5. .. module:: django.contrib.comments.signals
    6. 

  6.    :synopsis: Signals sent by the comment module.
    7. 

  7. 

  8. The comment app sends a series of :doc:`signals </topics/signals>` to allow for
    9. 

  9. comment moderation and similar activities. See :doc:`the introduction to signals
    10. 

  10. </topics/signals>` for information about how to register for and receive these
    11. 

  11. signals.
    12. 

  12. 

  13. comment_will_be_posted
    14. 

  14. ======================
    15. 

  15. 

  16. .. data:: django.contrib.comments.signals.comment_will_be_posted
    17. 

  17.    :module:
    18. 

  18. 

  19. Sent just before a comment will be saved, after it's been sanity checked and
    20. 

  20. submitted. This can be used to modify the comment (in place) with posting
    21. 

  21. details or other such actions.
    22. 

  22. 

  23. If any receiver returns ``False`` the comment will be discarded and a 403 (not
    24. 

  24. allowed) response will be returned.
    25. 

  25. 

  26. This signal is sent at more or less the same time (just before, actually) as the
    27. 

  27. ``Comment`` object's :data:`~django.db.models.signals.pre_save` signal.
    28. 

    29. 

  29. Arguments sent with this signal:
    30. 

  30.     
    31. 

  31.     ``sender``
    32. 

  32.         The comment model.
    33. 

  33.         
    34. 

  34.     ``comment``
    35. 

  35.         The comment instance about to be posted. Note that it won't have been
    36. 

  36.         saved into the database yet, so it won't have a primary key, and any
    37. 

  37.         relations might not work correctly yet.
    38. 

  38.         
    39. 

  39.     ``request``
    40. 

  40.         The :class:`~django.http.HttpRequest` that posted the comment.
    41. 

  41.         
    42. 

  42. comment_was_posted
    43. 

  43. ==================
    44. 

  44. 

  45. .. data:: django.contrib.comments.signals.comment_was_posted
    46. 

  46.    :module:
    47. 

  47.    
    48. 

  48. Sent just after the comment is saved.
    49. 

  49. 

  50. Arguments sent with this signal:
    51. 

  51.     
    52. 

  52.     ``sender``
    53. 

  53.         The comment model.
    54. 

  54.         
    55. 

  55.     ``comment``
    56. 

  56.         The comment instance that was posted. Note that it will have already
    57. 

  57.         been saved, so if you modify it you'll need to call
    58. 

  58.         :meth:`~django.db.models.Model.save` again.
    59. 

  59.         
    60. 

  60.     ``request``
    61. 

  61.         The :class:`~django.http.HttpRequest` that posted the comment.
    62. 

  62. 

  63. comment_was_flagged
    64. 

  64. ===================
    65. 

  65. 

  66. .. data:: django.contrib.comments.signals.comment_was_flagged
    67. 

  67.    :module:
    68. 

  68. 

  69. Sent after a comment was "flagged" in some way. Check the flag to see if this
    70. 

  70. was a user requesting removal of a comment, a moderator approving/removing a
    71. 

  71. comment, or some other custom user flag.
    72. 

  72. 

  73. Arguments sent with this signal:
    74. 

  74.     
    75. 

  75.     ``sender``
    76. 

  76.         The comment model.
    77. 

  77.         
    78. 

  78.     ``comment``
    79. 

  79.         The comment instance that was posted. Note that it will have already
    80. 

  80.         been saved, so if you modify it you'll need to call
    81. 

  81.         :meth:`~django.db.models.Model.save` again.
    82. 

  82.         
    83. 

  83.     ``flag``
    84. 

  84.         The :class:`~django.contrib.comments.models.CommentFlag` that's been
    85. 

  85.         attached to the comment.
    86. 

  86.         
    87. 

  87.     ``created``
    88. 

  88.         ``True`` if this is a new flag; ``False`` if it's a duplicate flag.
    89. 

  89.         
    90. 

  90.     ``request``
    91. 

  91.         The :class:`~django.http.HttpRequest` that posted the comment.
    92. 

  92.