RequestParameters.php 2.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103
  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. * Stores and formats the parameters for the request to the reCAPTCHA service.
  29. */
  30. class RequestParameters
  31. {
  32. /**
  33. * Site secret.
  34. * @var string
  35. */
  36. private $secret;
  37. /**
  38. * Form response.
  39. * @var string
  40. */
  41. private $response;
  42. /**
  43. * Remote user's IP address.
  44. * @var string
  45. */
  46. private $remoteIp;
  47. /**
  48. * Client version.
  49. * @var string
  50. */
  51. private $version;
  52. /**
  53. * Initialise parameters.
  54. *
  55. * @param string $secret Site secret.
  56. * @param string $response Value from g-captcha-response form field.
  57. * @param string $remoteIp User's IP address.
  58. * @param string $version Version of this client library.
  59. */
  60. public function __construct($secret, $response, $remoteIp = null, $version = null)
  61. {
  62. $this->secret = $secret;
  63. $this->response = $response;
  64. $this->remoteIp = $remoteIp;
  65. $this->version = $version;
  66. }
  67. /**
  68. * Array representation.
  69. *
  70. * @return array Array formatted parameters.
  71. */
  72. public function toArray()
  73. {
  74. $params = array('secret' => $this->secret, 'response' => $this->response);
  75. if (!is_null($this->remoteIp)) {
  76. $params['remoteip'] = $this->remoteIp;
  77. }
  78. if (!is_null($this->version)) {
  79. $params['version'] = $this->version;
  80. }
  81. return $params;
  82. }
  83. /**
  84. * Query string representation for HTTP request.
  85. *
  86. * @return string Query string formatted parameters.
  87. */
  88. public function toQueryString()
  89. {
  90. return http_build_query($this->toArray());
  91. }
  92. }