README

HcaptchaField 是用于保护 ATK14 应用中表单免受垃圾邮件攻击的字段。

它使用 hCaptcha API。

HcaptchaField 是不含 Google 的 RecaptchaField 的替代方案。

安装

只需使用 Composer

cd path/to/your/atk14/project/
composer require atk14/hcaptcha-field

您必须在 config/settings.php 中定义两个常量。在 https://dashboard.hcaptcha.com/sites?page=1 和 https://dashboard.hcaptcha.com/settings 注册 hCaptcha 并获取相应的值

<?php
// file: config/settings.php

// ...
define("HCAPTCHA_SITE_KEY","178bdce1-a1be-5969-c712-852308e012a0");
define("HCAPTCHA_SECRET_KEY","0x15722de15712c967eA265F86c79A51a46e461F00");

可选地，您可以创建 HcaptchaField 文件的符号链接到您的项目中

ln -s ../../vendor/atk14/hcaptcha-field/src/app/fields/hcaptcha_field.php app/fields/hcaptcha_field.php
ln -s ../../vendor/atk14/hcaptcha-field/src/app/widgets/hcaptcha_widget.php app/widgets/hcaptcha_widget.php

在 ATK14 应用中使用

在表单中

<?php
// file: app/forms/users/create_new_form.php
class CreateNewForm extends ApplicationForm {

  function set_up(){
    $this->add_field("firstname", new CharField([
      "label" => "Firstname",
      "max_length" => 200,
    ]));

    $this->add_field("lastname", new CharField([
      "label" => "Lastname",
      "max_length" => 200,
    ]));

    // other fields

    $this->add_field("captcha",new HcaptchaField([
      "label" => "Spam protection"
    ]));
  }

  function clean(){
    list($err,$values) = parent::clean();

    // perhaps you may not want to have "captcha" in the cleaned data
    if(is_array($values)){ unset($values["captcha"]); }

    return [$err,$values];
  }
}

在模板中（使用来自 Atk14Skelet 的共享模板）

<h1>User Registration</h1>

{form}

  <fieldset>
    {render partial="shared/form_field" fields="firstname,lastname,..."}
  </fieldset>

  <fieldset>
    {render partial="shared/form_field" fields="captcha"}
  </fieldset>

  <button type="submit">Register</button>

{/form}

在控制器中

<?php
// file: app/controllers/users_controller.php
class UsersController extends ApplicationController {
  
  function create_new(){
    if($this->request->post() && ($values = $this->form->validate($this->params))){
      // There's no need to care about the $values["captcha"] since it was unset in CreateNewForm::clean()
      User::CreateNewRecord($values);
      $this->flash->success("Your registration has been successfully performed");
      $this->_redirect_to("main/index");
    }
  }
}

许可证

HcaptchaField 是免费软件，按照 MIT 许可证的条款 发布