Response.php in reCAPTCHA 6.2

Namespace

ReCaptcha

File

recaptcha-php/src/ReCaptcha/Response.php

<?php

/**
 * This is a PHP library that handles calling reCAPTCHA.
 *
 * @copyright Copyright (c) 2015, Google Inc.
 * @link      http://www.google.com/recaptcha
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
namespace ReCaptcha;


/**
 * The response returned from the service.
 */
class Response {

  /**
   * Succes or failure.
   * @var boolean
   */
  private $success = false;

  /**
   * Error code strings.
   * @var array
   */
  private $errorCodes = array();

  /**
   * Build the response from the expected JSON returned by the service.
   *
   * @param string $json
   * @return \ReCaptcha\Response
   */
  public static function fromJson($json) {
    $responseData = json_decode($json, true);
    if (!$responseData) {
      return new Response(false, array(
        'invalid-json',
      ));
    }
    if (isset($responseData['success']) && $responseData['success'] == true) {
      return new Response(true);
    }
    if (isset($responseData['error-codes']) && is_array($responseData['error-codes'])) {
      return new Response(false, $responseData['error-codes']);
    }
    return new Response(false);
  }

  /**
   * Constructor.
   *
   * @param boolean $success
   * @param array $errorCodes
   */
  public function __construct($success, array $errorCodes = array()) {
    $this->success = $success;
    $this->errorCodes = $errorCodes;
  }

  /**
   * Is success?
   *
   * @return boolean
   */
  public function isSuccess() {
    return $this->success;
  }

  /**
   * Get error codes.
   *
   * @return array
   */
  public function getErrorCodes() {
    return $this->errorCodes;
  }

}

Classes

Name	Description
Response	The response returned from the service.