Response.php 2.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102
  1. <?php
  2. /**
  3. * This is a PHP library that handles calling reCAPTCHA.
  4. *
  5. * @copyright Copyright (c) 2015, Google Inc.
  6. * @link http://www.google.com/recaptcha
  7. *
  8. * Permission is hereby granted, free of charge, to any person obtaining a copy
  9. * of this software and associated documentation files (the "Software"), to deal
  10. * in the Software without restriction, including without limitation the rights
  11. * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  12. * copies of the Software, and to permit persons to whom the Software is
  13. * furnished to do so, subject to the following conditions:
  14. *
  15. * The above copyright notice and this permission notice shall be included in
  16. * all copies or substantial portions of the Software.
  17. *
  18. * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  19. * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  20. * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  21. * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  22. * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  23. * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  24. * THE SOFTWARE.
  25. */
  26. namespace ReCaptcha;
  27. /**
  28. * The response returned from the service.
  29. */
  30. class Response
  31. {
  32. /**
  33. * Succes or failure.
  34. * @var boolean
  35. */
  36. private $success = false;
  37. /**
  38. * Error code strings.
  39. * @var array
  40. */
  41. private $errorCodes = array();
  42. /**
  43. * Build the response from the expected JSON returned by the service.
  44. *
  45. * @param string $json
  46. * @return \ReCaptcha\Response
  47. */
  48. public static function fromJson($json)
  49. {
  50. $responseData = json_decode($json, true);
  51. if (!$responseData) {
  52. return new Response(false, array('invalid-json'));
  53. }
  54. if (isset($responseData['success']) && $responseData['success'] == true) {
  55. return new Response(true);
  56. }
  57. if (isset($responseData['error-codes']) && is_array($responseData['error-codes'])) {
  58. return new Response(false, $responseData['error-codes']);
  59. }
  60. return new Response(false);
  61. }
  62. /**
  63. * Constructor.
  64. *
  65. * @param boolean $success
  66. * @param array $errorCodes
  67. */
  68. public function __construct($success, array $errorCodes = array())
  69. {
  70. $this->success = $success;
  71. $this->errorCodes = $errorCodes;
  72. }
  73. /**
  74. * Is success?
  75. *
  76. * @return boolean
  77. */
  78. public function isSuccess()
  79. {
  80. return $this->success;
  81. }
  82. /**
  83. * Get error codes.
  84. *
  85. * @return array
  86. */
  87. public function getErrorCodes()
  88. {
  89. return $this->errorCodes;
  90. }
  91. }