Pinax Referrals 技术文档

1. 安装指南

1.1 安装步骤

要安装 pinax-referrals，可以通过以下命令使用 pip 进行安装：

$ pip install pinax-referrals

1.2 配置 Django 项目

在 Django 项目的 settings.py 文件中，将 pinax.referrals 添加到 INSTALLED_APPS 中：

INSTALLED_APPS = [
    # 其他应用
    "pinax.referrals",
]

1.3 添加中间件

为了在用户注册并认证后链接到初始的推荐链接，需要在 MIDDLEWARE 中添加 pinax.referrals.middleware.SessionJumpingMiddleware。确保它位于 django.contrib.auth.middleware.AuthenticationMiddleware 之后：

MIDDLEWARE = [
    # 其他中间件
    "django.contrib.auth.middleware.AuthenticationMiddleware",
    "pinax.referrals.middleware.SessionJumpingMiddleware",
]

1.4 配置 URL

在项目的 urls.py 文件中，添加 pinax.referrals.urls 到 URL 配置中：

urlpatterns = [
    # 其他 URL
    url(r"^referrals/", include("pinax.referrals.urls", namespace="pinax_referrals")),
]

2. 项目的使用说明

2.1 创建推荐链接

Referral.create 是一个工厂方法，用于创建推荐链接。可以通过以下方式直接调用：

referral = Referral.create(
    user=profile.user,
    redirect_to=reverse("home")
)
profile.referral = referral
profile.save()

2.2 记录推荐响应

Referral.record_response 方法用于记录用户对推荐链接的响应。例如：

from pinax.referrals.models import Referral

def my_view(request, **kwargs):
    # 其他代码
    referral_response = Referral.record_response(request, "SOME_ACTION")

2.3 获取请求中的推荐对象

Referral.referral_for_request 方法可以获取当前请求中的推荐对象，以便在项目中应用业务逻辑：

referral = Referral.referral_for_request(request)

3. 项目 API 使用文档

3.1 Referral.create

用于创建推荐链接。主要参数包括：

• user: 关联的用户，可选。
• redirect_to: 重定向的 URL，必填。
• label: 推荐链接的标签，可选。

3.2 Referral.record_response

用于记录用户对推荐链接的响应。主要参数包括：

• request: Django 请求对象。
• action: 响应的动作标签。
• target: 关联的目标对象，可选。

3.3 Referral.referral_for_request

用于获取当前请求中的推荐对象。主要参数包括：

• request: Django 请求对象。

4. 项目安装方式

4.1 使用 pip 安装

通过以下命令安装 pinax-referrals：

$ pip install pinax-referrals

4.2 配置 Django 项目

在 settings.py 中配置 INSTALLED_APPS、MIDDLEWARE 和 urls.py，具体步骤见 1.2、1.3 和 1.4。

4.3 自定义设置

可以通过修改 settings.py 中的相关设置来调整 pinax-referrals 的默认行为，例如：

PINAX_COOKIE_MAX_AGE = 3600  # 设置 cookie 的最大存活时间为 1 小时
PINAX_REFERRALS_SECURE_URLS = True  # 使用 HTTPS 生成 URL

通过以上步骤，您可以成功安装并配置 pinax-referrals，并在项目中使用其功能。