包简介

PHP Library to support Google captcha.

README 文档

README

ReCaptcha is a free CAPTCHA service that protect websites from spam and abuse. This provides plugins for third-party integration with ReCAPTCHA.

https://developers.google.com/recaptcha/intro

This supports the latest Google ReCaptcha with the "I'm not a robot" tickbox.

Installation

Composer is used for installation.

curl -s https://getcomposer.org/installer | php
php composer.phar install

Your composer.json file should look like this:

{
  require: {
    "phpninjas/recaptcha": "~0.3"
  }
}

Example

To load the ReCaptcha on your page.

<html>
  <body>
    <div class="g-recaptcha" data-sitekey="your_site_key"></div>
    <script src="https://www.google.com/recaptcha/api.js" async defer></script>
  </body>
</html>

To verify the captcha at server side.

<?php
require_once "vendor/autoload.php";

use Google\ReCaptcha;

$recaptcha = new ReCaptcha($secret);
$resp = $recaptcha->validate($_POST['g-recaptcha-response']);

assert($resp->isSuccess());

Stubbing for tests

As most people want to be able to stub out the behaviour of a valid/invalid recaptcha it makes sense to be able to do this. Simply replace the http adapter with a mocked/stubbed one and you can validate the functionality of the the recaptcha library in the context of your code.

<?php

require_once "vendor/autoload.php"

class MyTest extends \PHPUnit_Framework_TestCase {

    public function testValidRecaptcha(){

        $goodResponse = [
          "success" => true
        ];

        $mockAdapter = $this->getMock('Google\HttpClientGetAdapter');
        $mockAdapter->expects($this->once())->method('get')->will($this->returnValue(json_encode($goodResponse)));

        $recaptcha = new ReCaptcha("secret", $mockAdapter);
        $this->assertThat($recaptcha->validate("my token thing"), $this->equalTo(new ReCaptchaResponse(true)));
    }

    public function testInvalidRecaptcha(){
        $badResponse = [
          "success" => false,
          "error-codes" => ["error1"]
        ];

        $mockAdapter = $this->getMock('Google\HttpClientGetAdapter');
        $mockAdapter->expects($this->once())->method('get')->will($this->returnValue(json_encode($badResponse)));

        $recaptcha = new ReCaptcha("secret", $mockAdapter);
        $this->assertThat($recaptcha->validate("my token thing"), $this->equalTo(new ReCaptchaResponse(false, ["error1"])));
    }
}

Rest Handlers

By default this library ships with a very skinny http client. This client CAN throws warnings due to network errors. If you want to use something more professional I would recommend looking at Guzzle https://github.com/guzzle/guzzle or another HTTP Client that provides better request/response handling. Until that time the default adapter should suffice.

If you want to provide a separate http adapter then simply implement the HttpClientGetAdapter interface and the only required method.

class MyHttpClient implements Google\HttpClientGetAdapter {
    public function get($uri){
        // do http magics here
        // fsockopen?
        // guzzle->get()
        // curl_exec()
        return $body
    }
}

$recaptcha = new ReCaptcha("secret", new MyHttpClient());
$recaptcha->validate("response token");

Exception Handling

By default the ReCaptcha library handles any exceptions thrown by the http client that it utilises. These get wrapped into ReCaptchaException objects (which contain the inner exception). Thereby you only need to handle 1 exception when utilising the recaptcha.

try {
    $recaptcha = new ReCaptcha("secret", new Guzzle());
    $recaptcha->validate("response token");
} catch(ReCaptchaException $e){
    // peek at the inner exception
    $e->getPrevious();
}

phpninjas/recaptcha 适用场景与选型建议

phpninjas/recaptcha 是一款基于 PHP 开发的 Composer 扩展包，目前已累计 3.08k 次下载、GitHub Stars 达 2，最近一次更新时间为 2014 年 12 月 04 日，在 PHP 生态内属于活跃度较高的组件。

它主要适用于以下技术方向：「security」「recaptcha」「google」等业务场景。在实际项目中，围绕这些方向常见需要落地的问题包括：接口对接、性能调优、并发安全、与既有框架（Laravel / ThinkPHP / Yii / Webman 等）的兼容适配，以及生产环境的日志埋点与稳定性保障。

我们在过去多个企业项目中使用过 phpninjas/recaptcha 或与其功能相近的方案，如果你在选型或落地过程中遇到问题，例如 版本兼容、二次改造、私有化封装、与内部系统对接、生产 BUG 排查，欢迎联系我们协助评估。

围绕 phpninjas/recaptcha 我们能提供哪些服务？

定制开发 / 二次开发

基于 phpninjas/recaptcha 在你已有业务上做功能扩展、字段裁剪、UI 适配、与内部账号 / 权限 / 日志系统的深度对接。

BUG 修复 & 性能优化

线上偶发问题、内存泄漏、慢查询、并发异常等排查修复；针对高流量场景做缓存、队列、索引层面的调优。

项目外包 & 长期维护

承接完整的项目从需求 → 设计 → 开发 → 上线 → 长期运维；也可按月提供技术保姆服务。

yvsm@zunyunkeji.com QQ：316430983 微信：yvsm316 西安尊云信息科技 · 专注 PHP / Go / 分布式系统研发

与 phpninjas/recaptcha 相关的其它包

同方向 / 同关键字的高下载量 PHP Composer 包推荐，方便对比选型：

toskadv/recaptcha 3

Client library for reCAPTCHA with proxy support, a free service that protects websites from spam and abuse.

rsm/rsm-googlerecaptcha-modul 3

Diese Contao 4 Erweiterung stellt Google reCAPTCHA V2 in Form eines neuen Formularfeldes im Formulargenerator bereit. This extension provides Google reCAPTCHA V2 in the form of a new form field in the form generator of Contao Open Source CMS.

sil/route-security-bundle 7

Provide a way to secure accesses to all routes of an symfony application.

goedemiddag/laravel-recaptcha 2

A simple and easy to use Google ReCaptcha v3 package for Laravel

eftec/securityonemysql 6

It's a barebone security class written on PHP

bugbuster/integrity_check 3

Contao CMS integrity check for some files