Modernize to PHP 8.4

Author: phpfui

src/ReCaptcha/ReCaptcha.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * This is a PHP library that handles calling reCAPTCHA.
  *
@@ -43,7 +44,7 @@ class ReCaptcha
      * Version of this client library.
      * @const string
      */
-    public const VERSION = 'php_1.3.0';
+    public const VERSION = 'php_2.0.0';
 
     /**
      * URL for reCAPTCHA siteverify API
@@ -115,28 +116,28 @@ class ReCaptcha
      * Shared secret for the site.
      * @var string
      */
-    private $secret;
+    private string $secret;
 
     /**
      * Method used to communicate with service. Defaults to POST request.
      * @var RequestMethod
      */
-    private $requestMethod;
+    private ?RequestMethod $requestMethod;
 
-    private $hostname;
-    private $apkPackageName;
-    private $action;
-    private $threshold;
-    private $timeoutSeconds;
+    private string $hostname;
+    private string $apkPackageName;
+    private string $action;
+    private float $threshold;
+    private int $timeoutSeconds;
 
     /**
      * Create a configured instance to use the reCAPTCHA service.
      *
      * @param string $secret The shared key between your site and reCAPTCHA.
-     * @param RequestMethod $requestMethod method used to send the request. Defaults to POST.
+     * @param ?RequestMethod $requestMethod method used to send the request. Defaults to POST.
      * @throws \RuntimeException if $secret is invalid
      */
-    public function __construct($secret, ?RequestMethod $requestMethod = null)
+    public function __construct(string $secret, ?RequestMethod $requestMethod = null)
     {
         if (empty($secret)) {
             throw new \RuntimeException('No secret provided');
@@ -156,20 +157,21 @@ public function __construct($secret, ?RequestMethod $requestMethod = null)
      *
      * @param string $response The user response token provided by reCAPTCHA, verifying the user on your site.
      * @param string $remoteIp The end user's IP address.
+     *
      * @return Response Response from the service.
      */
-    public function verify(string $response, ?string $remoteIp = null)
+    public function verify(string $response, ?string $remoteIp = null): Response
     {
         // Discard empty solution submissions
         if (empty($response)) {
-            $recaptchaResponse = new Response(false, array(self::E_MISSING_INPUT_RESPONSE));
+            $recaptchaResponse = new Response(false, [self::E_MISSING_INPUT_RESPONSE]);
             return $recaptchaResponse;
         }
 
         $params = new RequestParameters($this->secret, $response, $remoteIp, self::VERSION);
         $rawResponse = $this->requestMethod->submit($params);
         $initialResponse = Response::fromJson($rawResponse);
-        $validationErrors = array();
+        $validationErrors = [];
 
         if (isset($this->hostname) && strcasecmp($this->hostname, $initialResponse->getHostname()) !== 0) {
             $validationErrors[] = self::E_HOSTNAME_MISMATCH;
@@ -215,23 +217,23 @@ public function verify(string $response, ?string $remoteIp = null)
      * This should be without a protocol or trailing slash, e.g. www.google.com
      *
      * @param string $hostname Expected hostname
-     * @return ReCaptcha Current instance for fluent interface
      */
-    public function setExpectedHostname(string $hostname)
+    public function setExpectedHostname(string $hostname): static
     {
         $this->hostname = $hostname;
+
         return $this;
     }
 
     /**
      * Provide an APK package name to match against in verify()
      *
      * @param string $apkPackageName Expected APK package name
-     * @return ReCaptcha Current instance for fluent interface
      */
-    public function setExpectedApkPackageName(string $apkPackageName)
+    public function setExpectedApkPackageName(string $apkPackageName): static
     {
         $this->apkPackageName = $apkPackageName;
+
         return $this;
     }
 
@@ -240,11 +242,11 @@ public function setExpectedApkPackageName(string $apkPackageName)
      * This should be set per page.
      *
      * @param string $action Expected action
-     * @return ReCaptcha Current instance for fluent interface
      */
-    public function setExpectedAction(string $action)
+    public function setExpectedAction(string $action): static
     {
         $this->action = $action;
+
         return $this;
     }
 
@@ -253,23 +255,23 @@ public function setExpectedAction(string $action)
      * Threshold should be a float between 0 and 1 which will be tested as response >= threshold.
      *
      * @param float $threshold Expected threshold
-     * @return ReCaptcha Current instance for fluent interface
      */
-    public function setScoreThreshold(float $threshold)
+    public function setScoreThreshold(float $threshold): static
     {
         $this->threshold = floatval($threshold);
+
         return $this;
     }
 
     /**
      * Provide a timeout in seconds to test against the challenge timestamp in verify()
      *
      * @param int $timeoutSeconds Expected hostname
-     * @return ReCaptcha Current instance for fluent interface
      */
-    public function setChallengeTimeout(int $timeoutSeconds)
+    public function setChallengeTimeout(int $timeoutSeconds): static
     {
         $this->timeoutSeconds = $timeoutSeconds;
+
         return $this;
     }
 }

src/ReCaptcha/RequestMethod.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * This is a PHP library that handles calling reCAPTCHA.
  *
@@ -45,5 +46,5 @@ interface RequestMethod
      * @param RequestParameters $params Request parameters
      * @return string Body of the reCAPTCHA response
      */
-    public function submit(RequestParameters $params);
+    public function submit(RequestParameters $params): string;
 }

src/ReCaptcha/RequestMethod/Curl.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * This is a PHP library that handles calling reCAPTCHA.
  *
@@ -41,8 +42,8 @@ class Curl
 {
     /**
      * @see http://php.net/curl_init
-     * @param string $url
-     * @return resource cURL handle
+     *
+     * @return resource cURL handle  *
      */
     public function init(?string $url = null)
     {
@@ -52,20 +53,17 @@ public function init(?string $url = null)
     /**
      * @see http://php.net/curl_setopt_array
      * @param resource $ch
-     * @param array $options
-     * @return bool
      */
-    public function setoptArray($ch, array $options)
+    public function setoptArray($ch, array $options): bool
     {
         return curl_setopt_array($ch, $options);
     }
 
     /**
      * @see http://php.net/curl_exec
      * @param resource $ch
-     * @return mixed
      */
-    public function exec($ch)
+    public function exec($ch): mixed
     {
         return curl_exec($ch);
     }
@@ -74,7 +72,7 @@ public function exec($ch)
      * @see http://php.net/curl_close
      * @param resource $ch
      */
-    public function close($ch)
+    public function close($ch): void
     {
         curl_close($ch);
     }

src/ReCaptcha/RequestMethod/CurlPost.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * This is a PHP library that handles calling reCAPTCHA.
  *
@@ -45,51 +46,44 @@
  */
 class CurlPost implements RequestMethod
 {
-    /**
-     * Curl connection to the reCAPTCHA service
-     * @var Curl
-     */
-    private $curl;
-
-    /**
-     * URL for reCAPTCHA siteverify API
-     * @var string
-     */
-    private $siteVerifyUrl;
-
     /**
      * Only needed if you want to override the defaults
      *
-     * @param Curl $curl Curl resource
-     * @param string $siteVerifyUrl URL for reCAPTCHA siteverify API
+     * @param ?Curl $curl Curl connection to the reCAPTCHA service
+     * @param ?string $siteVerifyUrl URL for reCAPTCHA siteverify API
      */
-    public function __construct(?Curl $curl = null, ?string $siteVerifyUrl = null)
+    public function __construct(private ?Curl $curl = null, private ?string $siteVerifyUrl = null)
     {
-        $this->curl = (is_null($curl)) ? new Curl() : $curl;
-        $this->siteVerifyUrl = (is_null($siteVerifyUrl)) ? ReCaptcha::SITE_VERIFY_URL : $siteVerifyUrl;
+        if (is_null($curl)) {
+            $this->curl = new Curl();
+        }
+        if (is_null($siteVerifyUrl)) {
+            $this->siteVerifyUrl = ReCaptcha::SITE_VERIFY_URL;
+        }
     }
 
     /**
      * Submit the cURL request with the specified parameters.
      *
      * @param RequestParameters $params Request parameters
+     *
      * @return string Body of the reCAPTCHA response
      */
-    public function submit(RequestParameters $params)
+    public function submit(RequestParameters $params): string
     {
         $handle = $this->curl->init($this->siteVerifyUrl);
 
-        $options = array(
+        $options = [
             CURLOPT_POST => true,
             CURLOPT_POSTFIELDS => $params->toQueryString(),
-            CURLOPT_HTTPHEADER => array(
+            CURLOPT_HTTPHEADER => [
                 'Content-Type: application/x-www-form-urlencoded'
-            ),
+            ],
             CURLINFO_HEADER_OUT => false,
             CURLOPT_HEADER => false,
             CURLOPT_RETURNTRANSFER => true,
             CURLOPT_SSL_VERIFYPEER => true
-        );
+        ];
         $this->curl->setoptArray($handle, $options);
 
         $response = $this->curl->exec($handle);

src/ReCaptcha/RequestMethod/Post.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * This is a PHP library that handles calling reCAPTCHA.
  *
@@ -43,43 +44,40 @@
  */
 class Post implements RequestMethod
 {
-    /**
-     * URL for reCAPTCHA siteverify API
-     * @var string
-     */
-    private $siteVerifyUrl;
-
     /**
      * Only needed if you want to override the defaults
      *
      * @param string $siteVerifyUrl URL for reCAPTCHA siteverify API
      */
-    public function __construct(?string $siteVerifyUrl = null)
+    public function __construct(private ?string $siteVerifyUrl = null)
     {
-        $this->siteVerifyUrl = (is_null($siteVerifyUrl)) ? ReCaptcha::SITE_VERIFY_URL : $siteVerifyUrl;
+        if (is_null($siteVerifyUrl)) {
+            $this->siteVerifyUrl = ReCaptcha::SITE_VERIFY_URL;
+        }
     }
 
     /**
      * Submit the POST request with the specified parameters.
      *
      * @param RequestParameters $params Request parameters
+     *
      * @return string Body of the reCAPTCHA response
      */
-    public function submit(RequestParameters $params)
+    public function submit(RequestParameters $params): string
     {
-        $options = array(
-            'http' => array(
+        $options = [
+            'http' => [
                 'header' => "Content-type: application/x-www-form-urlencoded\r\n",
                 'method' => 'POST',
                 'content' => $params->toQueryString(),
                 // Force the peer to validate (not needed in 5.6.0+, but still works)
                 'verify_peer' => true,
-            ),
-        );
+            ],
+        ];
         $context = stream_context_create($options);
         $response = file_get_contents($this->siteVerifyUrl, false, $context);
 
-        if ($response !== false) {
+        if ($response) {
             return $response;
         }