Merge pull request #478 from BoShurik/new-type-fixes

Psalm and type fixes

CHANGELOG.md

@@ -2,7 +2,7 @@
 
 All Notable changes to `PHP Telegram Bot Api` will be documented in this file
 
-## 2.6.0 - YYYY-MM-DD
+## 3.0.0 - YYYY-MM-DD
 - Add `\TelegramBot\Api\Types\Update::$myChatMember` field
 - Add `\TelegramBot\Api\Types\Update::$chatMember` field
 - Add `\TelegramBot\Api\Types\Update::$chatJoinRequest` field
@@ -15,6 +15,7 @@ All Notable changes to `PHP Telegram Bot Api` will be documented in this file
 - Add support for local bot API server
 - Add method `\TelegramBot\Api\BotApi::validateWebAppData` to validate `window.Telegram.WebApp.initData`
 - Add `\TelegramBot\Api\Types\Message::$videoNote` field
+- Drop php < 8.1
 
 ## 2.5.0 - 2023-08-09
 

psalm.xml

@@ -23,5 +23,14 @@
         <DeprecatedMethod errorLevel="suppress" />
         <DeprecatedClass errorLevel="suppress" />
         <DeprecatedProperty errorLevel="suppress" />
+
+        <MissingReturnType errorLevel="suppress" />
+        <MissingParamType errorLevel="suppress" />
+        <MissingPropertyType errorLevel="suppress" />
+
+        <RedundantConditionGivenDocblockType errorLevel="suppress" />
+        <DocblockTypeContradiction errorLevel="suppress" />
+
+        <RiskyTruthyFalsyComparison errorLevel="suppress" />
     </issueHandlers>
 </psalm>

src/BotApi.php

@@ -12,6 +12,7 @@
 use TelegramBot\Api\Types\ArrayOfUpdates;
 use TelegramBot\Api\Types\BotCommand;
 use TelegramBot\Api\Types\Chat;
+use TelegramBot\Api\Types\ChatFullInfo;
 use TelegramBot\Api\Types\ChatInviteLink;
 use TelegramBot\Api\Types\ChatMember;
 use TelegramBot\Api\Types\File;
@@ -278,7 +279,7 @@ public function downloadFile($fileId)
      *
      * Response validation
      *
-     * @param resource $curl
+     * @param \CurlHandle $curl
      * @param string|false|null $response
      *
      * @throws HttpException
@@ -2254,12 +2255,12 @@ public function unpinChatMessage($chatId, $messageId = null)
      * @param string|int $chatId Unique identifier for the target chat or username of the target channel
      *                           (in the format @channelusername)
      *
-     * @return Chat
+     * @return ChatFullInfo
      * @throws Exception
      */
     public function getChat($chatId)
     {
-        return Chat::fromResponse($this->call('getChat', [
+        return ChatFullInfo::fromResponse($this->call('getChat', [
             'chat_id' => $chatId
         ]));
     }

src/Http/CurlHttpClient.php

@@ -92,7 +92,7 @@ class CurlHttpClient extends AbstractHttpClient
     /**
      * CURL object
      *
-     * @var resource
+     * @var \CurlHandle
      */
     private $curl;
 
@@ -178,7 +178,7 @@ private static function jsonValidate($jsonString)
     }
 
     /**
-     * @param resource $curl
+     * @param \CurlHandle $curl
      * @param string|null $response
      * @return void
      * @throws HttpException

src/Types/CallbackQuery.php

@@ -58,7 +58,7 @@ class CallbackQuery extends BaseType
      * Note that message content and message date will not be available
      * if the message is too old
      *
-     * @var \TelegramBot\Api\Types\MaybeInaccessibleMessage|null
+     * @var Message|InaccessibleMessage|null
      */
     protected $message;
 
@@ -129,15 +129,15 @@ public function setFrom(User $from)
     }
 
     /**
-     * @return MaybeInaccessibleMessage|null
+     * @return Message|InaccessibleMessage|null
      */
     public function getMessage()
     {
         return $this->message;
     }
 
     /**
-     * @param MaybeInaccessibleMessage $message
+     * @param Message|InaccessibleMessage|null $message
      * @return void
      */
     public function setMessage($message)

src/Types/ChatBoostSource.php

@@ -31,6 +31,9 @@ class ChatBoostSource extends BaseType implements TypeInterface
         'user' => User::class,
     ];
 
+    /**
+     * @psalm-suppress LessSpecificReturnStatement,MoreSpecificReturnType
+     */
     public static function fromResponse($data)
     {
         self::validate($data);

src/Types/ChatBoostSourceGiveaway.php

@@ -54,6 +54,8 @@ public static function fromResponse($data)
     protected $giveawayMessageId;
 
     /**
+     * @psalm-suppress NonInvariantDocblockPropertyType
+     *
      * Optional. User that won the prize in the giveaway if any
      *
      * @var User|null

src/Types/ChatMember.php

@@ -16,11 +16,7 @@ abstract class ChatMember extends BaseType implements TypeInterface
     protected static $requiredParams = ['status', 'user'];
 
     /**
-     * Factory method to create a concrete ChatMember instance
-     *
-     * @param array $data
-     * @return ChatMember
-     * @throws InvalidArgumentException
+     * @psalm-suppress MoreSpecificReturnType,LessSpecificImplementedReturnType,LessSpecificReturnStatement
      */
     public static function fromResponse($data)
     {

src/Types/ExternalReplyInfo.php

@@ -604,43 +604,3 @@ public function setVenue($venue)
         $this->venue = $venue;
     }
 }
-
-/**
- * Class ArrayOfPhotoSize
- * Represents an array of PhotoSize objects.
- *
- * @package TelegramBot\Api\Types
- */
-class ArrayOfPhotoSize extends BaseType implements TypeInterface
-{
-    /**
-     * {@inheritdoc}
-     *
-     * @var array
-     */
-    protected static $map = [
-        'photos' => PhotoSize::class,
-    ];
-
-    /**
-     * @var array
-     */
-    protected $photos;
-
-    /**
-     * @return array
-     */
-    public function getPhotos()
-    {
-        return $this->photos;
-    }
-
-    /**
-     * @param array $photos
-     * @return void
-     */
-    public function setPhotos($photos)
-    {
-        $this->photos = $photos;
-    }
-}

src/Types/InputMedia/InputMedia.php

@@ -17,6 +17,8 @@
 class InputMedia extends BaseType implements TypeInterface, CollectionItemInterface
 {
     /**
+     * @psalm-suppress LessSpecificImplementedReturnType
+     *
      * Factory method to create an instance of the appropriate InputMedia subclass based on the type.
      *
      * @param array $data

src/Types/MaybeInaccessibleMessage.php

@@ -14,6 +14,9 @@
  */
 class MaybeInaccessibleMessage extends BaseType implements TypeInterface
 {
+    /**
+     * @psalm-suppress MoreSpecificReturnType,LessSpecificReturnStatement
+     */
     public static function fromResponse($data)
     {
         self::validate($data);

src/Types/Message.php

@@ -118,7 +118,7 @@ class Message extends BaseType implements TypeInterface
     /**
      * Unique message identifier inside this chat
      *
-     * @var int
+     * @var int|float
      */
     protected $messageId;
 
@@ -287,7 +287,7 @@ class Message extends BaseType implements TypeInterface
     /**
      * Optional. For text messages, special entities like usernames, URLs, bot commands, etc. that appear in the text
      *
-     * @var \TelegramBot\Api\Types\ArrayOfMessageEntity|null
+     * @var MessageEntity[]|null
      */
     protected $entities;
 
@@ -330,7 +330,7 @@ class Message extends BaseType implements TypeInterface
     /**
      * Optional. Message is a photo, available sizes of the photo
      *
-     * @var \TelegramBot\Api\Types\ArrayOfPhotoSize|null
+     * @var PhotoSize[]|null
      */
     protected $photo;
 
@@ -379,7 +379,7 @@ class Message extends BaseType implements TypeInterface
     /**
      * Optional. For messages with a caption, special entities like usernames, URLs, bot commands, etc. that appear in the caption
      *
-     * @var \TelegramBot\Api\Types\ArrayOfMessageEntity|null
+     * @var MessageEntity[]|null
      */
     protected $captionEntities;
 
@@ -444,7 +444,7 @@ class Message extends BaseType implements TypeInterface
      * Optional. New members that were added to the group or supergroup and information about them
      * (the bot itself may be one of these members)
      *
-     * @var \TelegramBot\Api\Types\ArrayOfUser|null
+     * @var User[]|null
      */
     protected $newChatMembers;
 
@@ -465,7 +465,7 @@ class Message extends BaseType implements TypeInterface
     /**
      * Optional. A chat photo was change to this value
      *
-     * @var \TelegramBot\Api\Types\ArrayOfPhotoSize|null
+     * @var PhotoSize[]|null
      */
     protected $newChatPhoto;
 
@@ -531,7 +531,7 @@ class Message extends BaseType implements TypeInterface
     /**
      * Optional. Specified message was pinned. Note that the Message object in this field will not contain further reply_to_message fields even if it itself is a reply.
      *
-     * @var \TelegramBot\Api\Types\MaybeInaccessibleMessage|null
+     * @var Message|InaccessibleMessage|null
      */
     protected $pinnedMessage;
 
@@ -578,12 +578,12 @@ class Message extends BaseType implements TypeInterface
      */
     protected $writeAccessAllowed;
 
-    /**
-     * Optional. Telegram Passport data
-     *
-     * @var \TelegramBot\Api\Types\PassportData|null
-     */
-    protected $passportData;
+    // /**
+    //  * Optional. Telegram Passport data
+    //  *
+    //  * @var \TelegramBot\Api\Types\PassportData|null
+    //  */
+    // protected $passportData;
 
     /**
      * Optional. Service message. A user in the chat triggered another user's proximity alert while sharing Live Location
@@ -719,7 +719,7 @@ class Message extends BaseType implements TypeInterface
     protected $replyMarkup;
 
     /**
-     * @return int
+     * @return int|float
      */
     public function getMessageId()
     {
@@ -1311,15 +1311,15 @@ public function setCaption($caption)
     }
 
     /**
-     * @return ArrayOfMessageEntity|null
+     * @return MessageEntity[]|null
      */
     public function getCaptionEntities()
     {
         return $this->captionEntities;
     }
 
     /**
-     * @param ArrayOfMessageEntity|null $captionEntities
+     * @param MessageEntity[]|null $captionEntities
      */
     public function setCaptionEntities($captionEntities)
     {

src/Types/MessageOrigin.php

@@ -23,6 +23,26 @@ class MessageOrigin extends BaseType implements TypeInterface
     protected $type;
     protected $date;
 
+    /**
+     * @psalm-suppress MoreSpecificReturnType,LessSpecificReturnStatement
+     */
+    public static function fromResponse($data)
+    {
+        self::validate($data);
+        $class = match ($data['type']) {
+            'user' => MessageOriginUser::class,
+            'hidden_user' => MessageOriginHiddenUser::class,
+            'chat' => MessageOriginChat::class,
+            'channel' => MessageOriginChannel::class,
+            default => MessageOrigin::class
+        };
+
+        $instance = new $class();
+        $instance->map($data);
+
+        return $instance;
+    }
+
     public function getType()
     {
         return $this->type;

src/Types/User.php

@@ -125,7 +125,7 @@ class User extends BaseType implements TypeInterface
      */
     protected $canConnectToBusiness;
 
-    public function getId(): int
+    public function getId(): int|float
     {
         return $this->id;
     }
@@ -180,7 +180,7 @@ public function setLanguageCode($languageCode): void
 
     public function isBot(): bool
     {
-        return $this->isBot;
+        return (bool) $this->isBot;
     }
 
     public function setIsBot($isBot): void

tests/Types/UserTest.php

@@ -55,7 +55,7 @@ protected function assertMinItem($item)
         $this->assertNull($item->getCanJoinGroups());
         $this->assertNull($item->getCanReadAllGroupMessages());
         $this->assertNull($item->getSupportsInlineQueries());
-        $this->assertNull($item->isBot());
+        $this->assertFalse($item->isBot());
     }
 
     /**