README

将 reCAPTCHA 控制器添加到 Nette 框架表单中。

文档

安装
配置
使用
请求者
AJAX
不可见 reCAPTCHA
测试

安装

为了方便安装，请使用 Composer

composer require uestla/recaptcha-control

也不要忘记包含官方的 JavaScript 库

<script src="https://www.google.com/recaptcha/api.js" async defer></script>

如果你使用 AJAX，则可能希望使用库资产 - 查看更多。

配置

为了在表单中使用 reCAPTCHA 控制器，只需在您的 config.neon 中注册 DI 扩展即可

extensions:
	recaptcha: ReCaptchaControl\DI\Extension

recaptcha:
	# required
	siteKey: '<your_site_key>'
	secretKey: '<your_secret_key>'

	# optional
	methodName: 'addReCaptcha'
	requester: ReCaptchaControl\Http\Requester\CurlRequester

参数

使用

表单

要实际上将 reCAPTCHA 添加到您的表单中，只需调用

$form->addReCaptcha(
	'captcha', // control name
	'reCAPTCHA for you', // label
	"Please prove you're not a robot." // error message
);

请注意，验证规则会自动添加，因此您根本不需要调用任何 addRule()。

模板

然后您可以在 Latte 模板中使用宏和 n:attr 方法来渲染控件

<form ...>
	{* n:attr *}
	<div n:name="captcha"></div>

	{* or macro *}
	{input captcha}
</form>

就这样！:-)

请求者

请求者是发送 HTTP 请求的层。当您的生产环境不符合默认要求（cURL 扩展等）时，它会很有用。

您可以通过设置配置中的 requester 键来更改默认请求者。该值可以是类名或另一个服务的名称（见下文详细信息）。

CurlRequester

这是默认的，因为配置中的 requester 值是可选的。

它使用 PHP cURL 扩展。如果您要为请求设置任何 CURLOPT_* 值，则必须创建单独的服务并传递这些选项给构造函数

recaptcha:
	...
	requester: @curlRequester

services:
	curlRequester:
		class: ReCaptchaControl\Http\Requester\CurlRequester
		arguments:
			-
				CURLOPT_CAINFO: %appDir%/res/cacert.pem
				CURLOPT_SSL_VERIFYPEER: false # Verify SSL OFF
				CURLOPT_USERAGENT: 'Mozilla/5.0 (Windows NT 6.1; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/59.0.3071.104 Safari/537.36'

如您在示例中所见，可以使用所有 CURLOPT_* 常量作为字符串键（它们在内部被转换）。

SimpleRequester

使用流上下文调用 file_get_contents()。

recaptcha:
	...
	requester: ReCaptchaControl\Http\Requester\SimpleRequester

GuzzleRequester

如果您已经在您的应用程序中使用 Guzzle HTTP 客户端，则此请求者可能很有用

recaptcha:
	...
	requester: ReCaptchaControl\Http\Requester\GuzzleRequester

services:
	- Guzzle\Http\Client # will be autowired to the GuzzleRequester constructor

如果您正在使用多个客户端，则最好将请求者定义为单独的服务

recaptcha:
	...
	requester: @guzzleRequester

services:
	guzzleRequester: ReCaptchaControl\Http\Requester\GuzzleRequester(@primaryGuzzleHttpClient)

	primaryGuzzleHttpClient: Guzzle\Http\Client
	secondaryGuzzleHttpClient: Guzzle\Http\Client

自定义请求者

您还可以实现自己的请求者。只需确保它实现了 ReCaptchaControl\Http\Requester\IRequester 接口。

它基本上需要一个单一的 public function post($url, array $values = []) 方法，该方法接受一个字符串作为 URL，使用给定的 $values 执行 HTTP POST 请求，并返回响应体的字符串或失败时的 FALSE。

然后您可以使用它像上面一样
```
recaptcha:
	requester: MyRequesterClass
```
或者当您有某些依赖关系时
```
recaptcha:
	requester: @myRequester

services:
	myRequester:
		factory: MyRequesterClass( ... )
		...
```

AJAX

当包含 reCAPTCHA 控制的片段被更新时，reCAPTCHA 本身也需要重新渲染。

如果您使用 nette.ajax.js，则可能希望使用 assets/recaptcha.ajax.js 脚本。

您可以通过 bower 安装它

bower install

重要提示：脚本 recaptcha.ajax.js 加载官方JavaScript库，因为它需要显式渲染reCATPCHAs。所以请务必小心，不要自己加载。

不可见 reCAPTCHA

您还可以使用这个库来实现隐形reCAPTCHA。后端部分保持不变，因此只需要在前端进行适当配置。要查看其效果，您可以访问 https://kesspess.cz/recaptcha/invisible 和测试中的代码。

测试

您可能已经注意到了 tests/manual 目录。其内容实际上在 https://kesspess.cz/recaptcha 上是实时存在的。

要在本地机器上运行它，请按照以下步骤操作：

将 app/config/config.local.neon.template 复制到 app/config/config.local.neon
在 app/config/config.local.neon 中正确填写reCAPTCHA密钥
运行 composer install
运行 bower install

之后，您应该能够通过本地Web服务器运行它。

表单定义在 TestPresenter 中。

单独的示例模板位于 presenters/templates 目录中。

xnukes / recaptcha-control

维护者

详细信息