*/ protected $params = [ 'noscript' => false, /* Includes the

*/ protected $options = [ 'theme' => 'light', 'type' => 'image', 'size' => 'normal', 'tabindex' => 0, 'callback' => null, 'expired-callback' => null, 'hl' => null, // Auto-detect language ]; /** @var HttpClient */ protected $httpClient; /** * @param string $siteKey * @param string $secretKey * @param iterable $params * @param iterable $options * @param string $ip */ public function __construct( $siteKey = null, $secretKey = null, $params = null, $options = null, $ip = null, ?HttpClient $httpClient = null ) { if ($siteKey !== null) { $this->setSiteKey($siteKey); } if ($secretKey !== null) { $this->setSecretKey($secretKey); } if ($ip !== null) { $this->setIp($ip); } elseif (isset($_SERVER['REMOTE_ADDR'])) { $this->setIp($_SERVER['REMOTE_ADDR']); } if ($params !== null) { $this->setParams($params); } if ($options !== null) { $this->setOptions($options); } $this->setHttpClient($httpClient ?: new HttpClient()); } /** @return $this */ public function setHttpClient(HttpClient $httpClient) { $this->httpClient = $httpClient; return $this; } /** @return HttpClient */ public function getHttpClient() { return $this->httpClient; } /** * Serialize as string * * When the instance is used as a string it will display the recaptcha. * Since we can't throw exceptions within this method we will trigger * a user warning instead. */ public function __toString(): string { try { $return = $this->getHtml(); } catch (PhpException $phpException) { $return = ''; trigger_error($phpException->getMessage(), E_USER_WARNING); } return $return; } /** * Set the ip property * * @param string $ip * @return self */ public function setIp($ip) { $this->ip = $ip; return $this; } /** * Get the ip property * * @return string */ public function getIp() { return $this->ip; } /** * Set a single parameter * * @param string $key * @param mixed $value * @return self */ public function setParam($key, $value) { $this->params[$key] = $value; return $this; } /** * Set parameters * * @param iterable $params * @return self * @throws Exception */ public function setParams($params) { if ($params instanceof Traversable) { $params = ArrayUtils::iteratorToArray($params); } if (! is_array($params)) { throw new Exception(sprintf( '%s expects an array or Traversable set of params; received "%s"', __METHOD__, get_debug_type($params) )); } foreach ($params as $k => $v) { $this->setParam($k, $v); } return $this; } /** * Get the parameter array * * @return array */ public function getParams() { return $this->params; } /** * Get a single parameter * * @param string $key * @return mixed */ public function getParam($key) { if (! isset($this->params[$key])) { return null; } return $this->params[$key]; } /** * Set a single option * * @param string $key * @param mixed $value * @return self */ public function setOption($key, $value) { $this->options[$key] = $value; return $this; } /** * Set options * * @param iterable $options * @return self * @throws Exception */ public function setOptions($options) { if ($options instanceof Traversable) { $options = ArrayUtils::iteratorToArray($options); } if (is_array($options)) { foreach ($options as $k => $v) { $this->setOption($k, $v); } } else { throw new Exception('Expected array or Traversable object'); } return $this; } /** * Get the options array * * @return array */ public function getOptions() { return $this->options; } /** * Get a single option * * @param string $key * @return mixed */ public function getOption($key) { if (! isset($this->options[$key])) { return null; } return $this->options[$key]; } /** * Get the site key * * @return string */ public function getSiteKey() { return $this->siteKey; } /** * Set the site key * * @param string $siteKey * @return self */ public function setSiteKey($siteKey) { $this->siteKey = $siteKey; return $this; } /** * Get the secret key * * @return string */ public function getSecretKey() { return $this->secretKey; } /** * Set the secret key * * @param string $secretKey * @return self */ public function setSecretKey($secretKey) { $this->secretKey = $secretKey; return $this; } /** * Get the HTML code for the captcha * * This method uses the public key to fetch a recaptcha form. * * @return string * @throws Exception */ public function getHtml() { if ($this->siteKey === null) { throw new Exception('Missing site key'); } $host = self::API_SERVER; // Should we use an onload callback? if (! empty($this->options['onload'])) { return sprintf( '', $host, $this->options['onload'] ); } $langOption = ''; if (! empty($this->options['hl'])) { $langOption = sprintf('?hl=%s', $this->options['hl']); } $data = sprintf('data-sitekey="%s"', $this->siteKey); foreach ( [ 'theme', 'type', 'size', 'tabindex', 'callback', 'expired-callback', ] as $option ) { if (! empty($this->options[$option])) { $data .= sprintf(' data-%s="%s"', $option, $this->options[$option]); } } $return = <<

HTML; if ($this->params['noscript']) { $return .= <<

HTML; } return $return; } /** * Gets a solution to the verify server * * @param string $responseField * @return \Laminas\Http\Response * @throws Exception */ protected function post($responseField) { if ($this->secretKey === null) { throw new Exception('Missing secret key'); } if ($this->ip === null) { throw new Exception('Missing ip address'); } /* Fetch an instance of the http client */ $httpClient = $this->getHttpClient(); $params = [ 'secret' => $this->secretKey, 'remoteip' => $this->ip, 'response' => $responseField, ]; $request = new HttpRequest(); $request->setUri(self::VERIFY_SERVER); $request->getPost()->fromArray($params); $request->setMethod(HttpRequest::METHOD_POST); $httpClient->setEncType($httpClient::ENC_URLENCODED); return $httpClient->send($request); } /** * Verify the user input * * This method calls up the post method and returns a * \Laminas\ReCaptcha\Response object. * * @param string $responseField * @return Response */ public function verify($responseField) { $response = $this->post($responseField); return new Response(null, null, $response); } }