Merge pull request #588 from rollbar/4.0/update-response-handler-inte…

…rface

Updated the typing and comments for the `ResponseHandlerInterface`

src/Config.php

@@ -1077,7 +1077,7 @@ public function wait(string $accessToken, $max = 0): void
         $this->sender->wait($accessToken, $max);
     }
 
-    public function handleResponse(Payload $payload, mixed $response): void
+    public function handleResponse(Payload $payload, Response $response): void
     {
         if (!is_null($this->responseHandler)) {
             $this->verboseLogger()->debug(

src/ResponseHandlerInterface.php

@@ -4,7 +4,22 @@
 
 use Rollbar\Payload\Payload;
 
+/**
+ * The response handler interface allows the processing of responses from the Rollbar service after a log message or
+ * error report has been sent to Rollbar. A custom response handler FQCN may be passed in the config array with the key
+ * "responseHandler". The custom handler class constructor may be a single argument by including it in the config array
+ * with the "responseHandlerOptions" key. If the "responseHandlerOptions" key does not exist an empty array will be
+ * passed to the constructor.
+ */
 interface ResponseHandlerInterface
 {
-    public function handleResponse(Payload $payload, mixed $response): void;
+    /**
+     * The handleResponse method is called with the response from the Rollbar service after an error or log message has
+     * been sent.
+     *
+     * @param Payload  $payload  The payload object that was sent to Rollbar.
+     * @param Response $response The response that was returned. If the response status code is 0, it likely represents
+     *                           an ignored error that was never sent.
+     */
+    public function handleResponse(Payload $payload, Response $response): void;
 }

src/RollbarLogger.php

@@ -426,12 +426,12 @@ public function verboseLogger(): LoggerInterface
     /**
      * Calls the custom 'responseHandler', config if it exists.
      *
-     * @param Payload $payload  The payload that was sent.
-     * @param mixed   $response The response from the Rollbar service.
+     * @param Payload  $payload  The payload that was sent.
+     * @param Response $response The response from the Rollbar service.
      *
      * @return void
      */
-    protected function handleResponse(Payload $payload, mixed $response): void
+    protected function handleResponse(Payload $payload, Response $response): void
     {
         $this->config->handleResponse($payload, $response);
     }