Added typing / comments to the SenderInterface

src/Senders/AgentSender.php

@@ -55,7 +55,7 @@ public function sendBatch(array $batch, string $accessToken): void
     /**
      * @SuppressWarnings(PHPMD.UnusedFormalParameter)
      */
-    public function wait(string $accessToken, int $max)
+    public function wait(string $accessToken, int $max): void
     {
         return;
     }
@@ -65,9 +65,4 @@ private function loadAgentFile()
         $filename = $this->agentLogLocation . '/rollbar-relay.' . getmypid() . '.' . microtime(true) . '.rollbar';
         $this->agentLog = fopen($filename, 'a');
     }
-
-    public function toString()
-    {
-        return "agent log: " . $this->agentLogLocation;
-    }
 }

src/Senders/CurlSender.php

@@ -96,7 +96,7 @@ public function sendBatch(array $batch, string $accessToken): void
         $this->checkForCompletedRequests($accessToken);
     }
 
-    public function wait(string $accessToken, int $max = 0)
+    public function wait(string $accessToken, int $max = 0): void
     {
         if (count($this->inflightRequests) <= $max) {
             return;
@@ -187,9 +187,4 @@ private function removeFinishedRequests(string $accessToken)
         }
         $this->maybeSendMoreBatchRequests($accessToken);
     }
-
-    public function toString()
-    {
-        return "Rollbar API endpoint: " . $this->getEndpoint();
-    }
 }

src/Senders/FluentSender.php

@@ -96,7 +96,7 @@ public function sendBatch(array $batch, string $accessToken, &$responses = array
     /**
      * @SuppressWarnings(PHPMD.UnusedFormalParameter)
      */
-    public function wait(string $accessToken, int $max)
+    public function wait(string $accessToken, int $max): void
     {
         return;
     }
@@ -108,10 +108,4 @@ protected function loadFluentLogger()
     {
         $this->fluentLogger = new FluentLogger($this->fluentHost, $this->fluentPort);
     }
-
-    public function toString()
-    {
-        return "fluentd " . $this->fluentHost . ":" . $this->fluentPort .
-                " tag: " . $this->fluentTag;
-    }
 }

src/Senders/SenderInterface.php

@@ -2,13 +2,46 @@
 
 namespace Rollbar\Senders;
 
-use Rollbar\Payload\Payload;
 use Rollbar\Payload\EncodedPayload;
+use Rollbar\Payload\Payload;
+use Rollbar\Response;
 
+/**
+ * The sender interface is used to define how an error report sender should transport payloads to Rollbar Service.
+ *
+ * An optional constructor can be included in the implementing class. If the constructor is present a single argument
+ * with the value of the `senderOptions` config option will be passed to the constructor.
+ */
 interface SenderInterface
 {
-    public function send(EncodedPayload $payload, string $accessToken);
+    /**
+     * Sends the payload to the Rollbar service and returns the response.
+     *
+     * @param EncodedPayload $payload     The payload to deliver to the Rollbar service.
+     * @param string         $accessToken The project access token.
+     *
+     * @return Response
+     */
+    public function send(EncodedPayload $payload, string $accessToken): Response;
+
+    /**
+     * Sends an array of payloads to the Rollbar service.
+     *
+     * @param Payload[] $batch       The array of {@see Payload} instances.
+     * @param string    $accessToken The project access token.
+     *
+     * @return void
+     */
     public function sendBatch(array $batch, string $accessToken): void;
-    public function wait(string $accessToken, int $max);
-    public function toString();
+
+    /**
+     * Method used to keep the batch send process alive until all or $max number of Payloads are sent, which ever comes
+     * first.
+     *
+     * @param string $accessToken The project access token.
+     * @param int    $max         The maximum payloads to send before stopping the batch send process.
+     *
+     * @return void
+     */
+    public function wait(string $accessToken, int $max): void;
 }

tests/ConfigTest.php

@@ -124,7 +124,7 @@ public function testLoggingPayload(): void
                         );
         $senderMock = $this->getMockBuilder(SenderInterface::class)
                         ->getMock();
-        $senderMock->method('send')->willReturn(null);
+        $senderMock->method('send')->willReturn(new Response(200, 'Test'));
 
         $payload = new \Rollbar\Payload\EncodedPayload(array('data'=>array()));
         $payload->encode();