More type and docblock improvements

Author: otsch

src/Exceptions/CouldNotSendNotification.php

@@ -6,11 +6,7 @@
 
 class CouldNotSendNotification extends Exception
 {
-    /**
-     * @param $response
-     * @return CouldNotSendNotification
-     */
-    public static function serviceRespondsNotSuccessful($response): CouldNotSendNotification
+    public static function serviceRespondsNotSuccessful(mixed $response): CouldNotSendNotification
     {
         if (isset($response->error)) {
             return new static("Couldn't post notification. Response: ".$response->error);
@@ -21,11 +17,7 @@ public static function serviceRespondsNotSuccessful($response): CouldNotSendNoti
         return new static("Couldn't post notification. Response: ".$responseBody);
     }
 
-    /**
-     * @param $response
-     * @return CouldNotSendNotification
-     */
-    public static function userWasNotFound($response): CouldNotSendNotification
+    public static function userWasNotFound(mixed $response): CouldNotSendNotification
     {
         $responseBody = print_r($response->errors[0]->message, true);
 

src/TwitterDirectMessage.php

@@ -22,7 +22,6 @@ public function getApiEndpoint(): string
     /**
      * Get Twitter direct message receiver.
      *
-     * @param  TwitterOAuth  $twitter
      * @return string|mixed
      *
      * @throws CouldNotSendNotification
@@ -49,9 +48,6 @@ public function getReceiver(TwitterOAuth $twitter): mixed
     /**
      * Build Twitter request body.
      *
-     * @param  TwitterOAuth  $twitter
-     * @return array
-     *
      * @throws CouldNotSendNotification
      */
     public function getRequestBody(TwitterOAuth $twitter): array

src/TwitterStatusUpdate.php

@@ -31,7 +31,6 @@ public function getApiEndpoint(): string
     /**
      * Set Twitter media files.
      *
-     * @param  array|string  $images
      * @return $this
      */
     public function withImage(array|string $images): static
@@ -47,8 +46,6 @@ public function withImage(array|string $images): static
 
     /**
      * Get Twitter images list.
-     *
-     * @return array|null
      */
     public function getImages(): ?array
     {

tests/TwitterChannelTest.php

@@ -3,6 +3,7 @@
 namespace NotificationChannels\Twitter\Test;
 
 use Abraham\TwitterOAuth\TwitterOAuth;
+use Illuminate\Notifications\Notifiable;
 use Illuminate\Notifications\Notification;
 use Mockery;
 use NotificationChannels\Twitter\Exceptions\CouldNotSendNotification;
@@ -13,11 +14,12 @@
 
 class TwitterChannelTest extends TestCase
 {
-    /** @var Mockery\Mock */
+    /**
+     * @var Mockery\Mock
+     */
     protected $twitter;
 
-    /** @var \NotificationChannels\Twitter\TwitterChannel */
-    protected $channel;
+    protected TwitterChannel $channel;
 
     public function setUp(): void
     {
@@ -100,10 +102,10 @@ public function it_throws_an_exception_when_it_could_not_send_the_notification()
 
 class TestNotifiable
 {
-    use \Illuminate\Notifications\Notifiable;
+    use Notifiable;
 
     /**
-     * @return int
+     * @return false
      */
     public function routeNotificationForTwitter()
     {
@@ -113,9 +115,11 @@ public function routeNotificationForTwitter()
 
 class TestNotifiableWithDifferentSettings
 {
-    use \Illuminate\Notifications\Notifiable;
+    use Notifiable;
 
-    /** @return array */
+    /**
+     * @return array
+     */
     public function routeNotificationForTwitter()
     {
         return ['1', '2', '3', '4'];

tests/TwitterMessageTest.php

@@ -2,22 +2,11 @@
 
 namespace NotificationChannels\Twitter\Test;
 
-use Abraham\TwitterOAuth\TwitterOAuth;
 use ArgumentCountError;
-use Mockery;
-use NotificationChannels\Twitter\TwitterDirectMessage;
 use NotificationChannels\Twitter\TwitterMessage;
 
 class TwitterMessageTest extends TestCase
 {
-//    public function setUp(): void
-//    {
-//        parent::setUp();
-//        $this->twitter = Mockery::mock(TwitterOAuth::class);
-//        $this->messageWithUserId = new TwitterDirectMessage(1234, 'myMessage');
-//        $this->messageWithScreenName = new TwitterDirectMessage('receiver', 'myMessage');
-//    }
-
     /** @test */
     public function it_needs_a_content()
     {