django-voting 1.1.0

字段

Vote对象有以下字段

• user – 进行投票的用户。用户由django.contrib.auth.models.User模型表示。

• content_type – 投票对象的ContentType。

• object_id – 投票对象的id。

• object – 投票的对象。

• vote – 投票的内容：+1或-1。

方法

Vote对象有以下自定义方法

• is_upvote – 如果投票为+1，则返回True。

• is_downvote – 如果投票为-1，则返回True。

管理函数

Vote模型有一个自定义管理器，它具有以下辅助函数

• record_vote(obj, user, vote) – 记录用户对指定对象的投票。只允许给定用户在指定对象上投票一次，但投票可以更改。

  vote必须是1（点赞）、-1（踩）或0（移除投票）之一。

• get_score(obj) – 获取obj的总分数和收到的总投票数。

  返回一个包含score和num_votes键的字典。

• get_scores_in_bulk(objects) – 获取所有给定对象的分数和投票计数详情。分数详情由具有score和num_vote键的字典组成。

  返回一个将对象id映射到分数详情的字典。

• get_top(Model, limit=10, reversed=False) – 获取给定模型中分数最高的limit个对象。

  如果reversed为True，则检索分数最低的limit个对象。

  产生(object, score)元组。

• get_bottom(Model, limit=10) – 这是一个便利方法，它使用reversed=True调用get_top。

  获取给定模型分数最低的（即最负面的）limit个对象。

  产生(object, score)元组。

• get_for_user(obj, user) – 获取给定用户对指定对象的投票，如果不存在匹配的投票，则返回 None。

• get_for_user_in_bulk(objects, user) – 获取给定用户对所有指定对象的投票。

  返回一个将对象 ID 映射到投票的字典。

• get_voted_users(object) – 获取对给定对象投票的所有用户。

  返回包含用户 ID 的对象列表。

voting.views.vote_on_object

描述

一个显示确认页面并对对象进行投票的视图。如果请求方法是 POST，则将只对给定对象进行投票。如果通过 GET 获取此视图，它将显示一个包含表单的确认页面，该表单将 POST 到同一 URL。

必需参数

• model：将被投票的对象的 Django 模型类。

• 必需提供 object_id 或 (slug 和 slug_field)。

  如果您提供 object_id，它应该是被投票对象的主键字段的值。

  否则，slug 应该是给定对象的 slug，而 slug_field 应该是 QuerySet 模型中 slug 字段的名称。

• direction：要进行的投票类型，必须是 'up'、'down' 或 'clear' 之一。

• 必须提供定义 URL 的 post_vote_redirect 参数，或者在请求 POST 投票时提供包含 URL 的 next 参数，或者被投票的对象必须定义 get_absolute_url 方法或属性。

  视图将按上述顺序检查这些。

可选参数

• allow_xmlhttprequest：一个布尔值，表示此视图是否还应允许通过 XMLHttpRequest 进行投票。

  如果这是 True，则将检查请求头中的 HTTP_X_REQUESTED_WITH 头，其值为 XMLHttpRequest。如果找到此头，则将当前请求的处理委托给 voting.views.xmlhttprequest_vote_on_object。

• template_name：用于渲染页面的模板的完整名称。这允许您覆盖默认模板名称（见下文）。

• template_loader：用于加载模板的模板加载器。默认情况下，它是 django.template.loader。

• extra_context：要添加到模板上下文的值字典。默认情况下，这是一个空字典。如果字典中的值是可调用的，则通用视图将在渲染模板之前调用它。

• context_processors：要应用到视图模板上的模板上下文处理器列表。

• template_object_name：指定在模板上下文中使用的模板变量的名称。默认情况下，这是'object'。

模板名称

如果没有指定template_name，则此视图将默认使用模板<app_label>/<model_name>_confirm_vote.html。

模板上下文

除了extra_context之外，模板的上下文还将包含

• object：即将进行投票的原始对象。该变量的名称取决于template_object_name参数，默认为'object'。如果template_object_name是'foo'，则该变量的名称将是foo。

• direction：传递给投票方向direction的参数（见上文）。

voting.views.xmlhttprequest_vote_on_object

描述

一个用于通过XMLHttpRequest进行对象投票的视图。如果请求方法是POST，则将对该对象进行投票。此视图将返回JSON文本，而不是渲染模板或重定向。

必需参数

• model：将被投票的对象的 Django 模型类。

• 必需提供 object_id 或 (slug 和 slug_field)。

  如果您提供 object_id，它应该是被投票对象的主键字段的值。

  否则，slug 应该是给定对象的 slug，而 slug_field 应该是 QuerySet 模型中 slug 字段的名称。

• direction：要进行的投票类型，必须是 'up'、'down' 或 'clear' 之一。

JSON文本上下文

返回的JSON文本提供的上下文将是

• success：如果投票成功处理，则为true，否则为false。

• score：一个包含score属性的对象，其中包含对象的更新分数，以及包含为对象投的票总数的num_votes属性。

• error_message：如果投票未成功处理，则此属性将包含错误信息。

标签参考

{% score_for_object widget as score %}

{{ score.score }} point{{ score.score|pluralize }}
after {{ score.num_votes }} vote{{ score.num_votes|pluralize }}

{% scores_for_objects widget_list as scores %}

{% vote_by_user user on widget as vote %}

{% votes_by_user user on widget_list as vote_dict %}

{% dict_entry_for_item widget from vote_dict as vote %}

{% confirm_vote_message widget.title direction %}

过滤器参考

vote_display

给定一个映射上/下投票值的字符串，根据给定的Vote返回一个字符串。

如果没有提供字符串映射，将使用“上”和“下”。

示例用法

{{ vote|vote_display:"Bodacious,Bogus" }}