Add ResultFactory and value processors, simplify type and method classes

CHANGELOG.md

@@ -1,8 +1,8 @@
 # Telegram Bot API for PHP Change Log
 
-## 0.2.2 under development
+## 0.3.0 under development
 
-- New #97: Add `getRaw()` and `hasRaw()` methods to `Update` type class.
+- Chg #99: Add `ResultFactory` and value processors, simplify type and method classes.
 
 ## 0.2.1 July 2, 2024
 

README.md

@@ -104,7 +104,7 @@ $request = new TelegramRequest(
     httpMethod: HttpMethod::GET,
     apiMethod: 'getChat',
     data: ['chat_id' => '@sergei_predvoditelev'],
-    successCallback: fn (mixed $result) => ChatFullInfo::fromTelegramResult($result),
+    resultType: ChatFullInfo::class,
 );
 
 // Result is an object of `Vjik\TelegramBot\Api\Type\ChatFullInfo`

src/Method/AnswerCallbackQuery.php

@@ -4,7 +4,7 @@
 
 namespace Vjik\TelegramBot\Api\Method;
 
-use Vjik\TelegramBot\Api\ParseResult\ValueHelper;
+use Vjik\TelegramBot\Api\ParseResult\ValueProcessor\TrueValue;
 use Vjik\TelegramBot\Api\Request\HttpMethod;
 use Vjik\TelegramBot\Api\Request\TelegramRequestWithResultPreparingInterface;
 
@@ -46,9 +46,8 @@ public function getData(): array
         );
     }
 
-    public function prepareResult(mixed $result): true
+    public function getResultType(): TrueValue
     {
-        ValueHelper::assertTrueResult($result);
-        return $result;
+        return new TrueValue();
     }
 }

src/Method/ApproveChatJoinRequest.php

@@ -4,7 +4,7 @@
 
 namespace Vjik\TelegramBot\Api\Method;
 
-use Vjik\TelegramBot\Api\ParseResult\ValueHelper;
+use Vjik\TelegramBot\Api\ParseResult\ValueProcessor\TrueValue;
 use Vjik\TelegramBot\Api\Request\HttpMethod;
 use Vjik\TelegramBot\Api\Request\TelegramRequestWithResultPreparingInterface;
 
@@ -37,9 +37,8 @@ public function getData(): array
         ];
     }
 
-    public function prepareResult(mixed $result): true
+    public function getResultType(): TrueValue
     {
-        ValueHelper::assertTrueResult($result);
-        return $result;
+        return new TrueValue();
     }
 }

src/Method/BanChatMember.php

@@ -5,7 +5,7 @@
 namespace Vjik\TelegramBot\Api\Method;
 
 use DateTimeInterface;
-use Vjik\TelegramBot\Api\ParseResult\ValueHelper;
+use Vjik\TelegramBot\Api\ParseResult\ValueProcessor\TrueValue;
 use Vjik\TelegramBot\Api\Request\HttpMethod;
 use Vjik\TelegramBot\Api\Request\TelegramRequestWithResultPreparingInterface;
 
@@ -45,9 +45,8 @@ public function getData(): array
         );
     }
 
-    public function prepareResult(mixed $result): true
+    public function getResultType(): TrueValue
     {
-        ValueHelper::assertTrueResult($result);
-        return $result;
+        return new TrueValue();
     }
 }

src/Method/BanChatSenderChat.php

@@ -4,7 +4,7 @@
 
 namespace Vjik\TelegramBot\Api\Method;
 
-use Vjik\TelegramBot\Api\ParseResult\ValueHelper;
+use Vjik\TelegramBot\Api\ParseResult\ValueProcessor\TrueValue;
 use Vjik\TelegramBot\Api\Request\HttpMethod;
 use Vjik\TelegramBot\Api\Request\TelegramRequestWithResultPreparingInterface;
 
@@ -37,9 +37,8 @@ public function getData(): array
         ];
     }
 
-    public function prepareResult(mixed $result): true
+    public function getResultType(): TrueValue
     {
-        ValueHelper::assertTrueResult($result);
-        return $result;
+        return new TrueValue();
     }
 }

src/Method/Close.php

@@ -4,7 +4,7 @@
 
 namespace Vjik\TelegramBot\Api\Method;
 
-use Vjik\TelegramBot\Api\ParseResult\ValueHelper;
+use Vjik\TelegramBot\Api\ParseResult\ValueProcessor\TrueValue;
 use Vjik\TelegramBot\Api\Request\HttpMethod;
 use Vjik\TelegramBot\Api\Request\TelegramRequestWithResultPreparingInterface;
 
@@ -28,9 +28,8 @@ public function getData(): array
         return [];
     }
 
-    public function prepareResult(mixed $result): true
+    public function getResultType(): TrueValue
     {
-        ValueHelper::assertTrueResult($result);
-        return $result;
+        return new TrueValue();
     }
 }

src/Method/CloseForumTopic.php

@@ -4,7 +4,7 @@
 
 namespace Vjik\TelegramBot\Api\Method;
 
-use Vjik\TelegramBot\Api\ParseResult\ValueHelper;
+use Vjik\TelegramBot\Api\ParseResult\ValueProcessor\TrueValue;
 use Vjik\TelegramBot\Api\Request\HttpMethod;
 use Vjik\TelegramBot\Api\Request\TelegramRequestWithResultPreparingInterface;
 
@@ -37,9 +37,8 @@ public function getData(): array
         ];
     }
 
-    public function prepareResult(mixed $result): true
+    public function getResultType(): TrueValue
     {
-        ValueHelper::assertTrueResult($result);
-        return $result;
+        return new TrueValue();
     }
 }

src/Method/CloseGeneralForumTopic.php

@@ -4,7 +4,7 @@
 
 namespace Vjik\TelegramBot\Api\Method;
 
-use Vjik\TelegramBot\Api\ParseResult\ValueHelper;
+use Vjik\TelegramBot\Api\ParseResult\ValueProcessor\TrueValue;
 use Vjik\TelegramBot\Api\Request\HttpMethod;
 use Vjik\TelegramBot\Api\Request\TelegramRequestWithResultPreparingInterface;
 
@@ -35,9 +35,8 @@ public function getData(): array
         ];
     }
 
-    public function prepareResult(mixed $result): true
+    public function getResultType(): TrueValue
     {
-        ValueHelper::assertTrueResult($result);
-        return $result;
+        return new TrueValue();
     }
 }

src/Method/CopyMessage.php

@@ -73,8 +73,8 @@ public function getData(): array
         );
     }
 
-    public function prepareResult(mixed $result): MessageId
+    public function getResultType(): string
     {
-        return MessageId::fromTelegramResult($result);
+        return MessageId::class;
     }
 }

src/Method/CopyMessages.php

@@ -4,7 +4,7 @@
 
 namespace Vjik\TelegramBot\Api\Method;
 
-use Vjik\TelegramBot\Api\ParseResult\ValueHelper;
+use Vjik\TelegramBot\Api\ParseResult\ValueProcessor\ArrayOfObjectsValue;
 use Vjik\TelegramBot\Api\Request\HttpMethod;
 use Vjik\TelegramBot\Api\Request\TelegramRequestWithResultPreparingInterface;
 use Vjik\TelegramBot\Api\Type\MessageId;
@@ -54,15 +54,8 @@ public function getData(): array
         );
     }
 
-    /**
-     * @return MessageId[]
-     */
-    public function prepareResult(mixed $result): array
+    public function getResultType(): ArrayOfObjectsValue
     {
-        ValueHelper::assertArrayResult($result);
-        return array_map(
-            static fn($item) => MessageId::fromTelegramResult($item),
-            $result
-        );
+        return new ArrayOfObjectsValue(MessageId::class);
     }
 }

src/Method/CreateChatInviteLink.php

@@ -47,8 +47,8 @@ public function getData(): array
         );
     }
 
-    public function prepareResult(mixed $result): ChatInviteLink
+    public function getResultType(): string
     {
-        return ChatInviteLink::fromTelegramResult($result);
+        return ChatInviteLink::class;
     }
 }

src/Method/CreateForumTopic.php

@@ -44,8 +44,8 @@ public function getData(): array
         );
     }
 
-    public function prepareResult(mixed $result): ForumTopic
+    public function getResultType(): string
     {
-        return ForumTopic::fromTelegramResult($result);
+        return ForumTopic::class;
     }
 }

src/Method/DeclineChatJoinRequest.php

@@ -4,7 +4,7 @@
 
 namespace Vjik\TelegramBot\Api\Method;
 
-use Vjik\TelegramBot\Api\ParseResult\ValueHelper;
+use Vjik\TelegramBot\Api\ParseResult\ValueProcessor\TrueValue;
 use Vjik\TelegramBot\Api\Request\HttpMethod;
 use Vjik\TelegramBot\Api\Request\TelegramRequestWithResultPreparingInterface;
 
@@ -37,9 +37,8 @@ public function getData(): array
         ];
     }
 
-    public function prepareResult(mixed $result): true
+    public function getResultType(): TrueValue
     {
-        ValueHelper::assertTrueResult($result);
-        return $result;
+        return new TrueValue();
     }
 }

src/Method/DeleteChatPhoto.php

@@ -4,7 +4,7 @@
 
 namespace Vjik\TelegramBot\Api\Method;
 
-use Vjik\TelegramBot\Api\ParseResult\ValueHelper;
+use Vjik\TelegramBot\Api\ParseResult\ValueProcessor\TrueValue;
 use Vjik\TelegramBot\Api\Request\HttpMethod;
 use Vjik\TelegramBot\Api\Request\TelegramRequestWithResultPreparingInterface;
 
@@ -35,9 +35,8 @@ public function getData(): array
         ];
     }
 
-    public function prepareResult(mixed $result): true
+    public function getResultType(): TrueValue
     {
-        ValueHelper::assertTrueResult($result);
-        return $result;
+        return new TrueValue();
     }
 }

src/Method/DeleteChatStickerSet.php

@@ -4,7 +4,7 @@
 
 namespace Vjik\TelegramBot\Api\Method;
 
-use Vjik\TelegramBot\Api\ParseResult\ValueHelper;
+use Vjik\TelegramBot\Api\ParseResult\ValueProcessor\TrueValue;
 use Vjik\TelegramBot\Api\Request\HttpMethod;
 use Vjik\TelegramBot\Api\Request\TelegramRequestWithResultPreparingInterface;
 
@@ -35,9 +35,8 @@ public function getData(): array
         ];
     }
 
-    public function prepareResult(mixed $result): true
+    public function getResultType(): TrueValue
     {
-        ValueHelper::assertTrueResult($result);
-        return $result;
+        return new TrueValue();
     }
 }

src/Method/DeleteForumTopic.php

@@ -4,7 +4,7 @@
 
 namespace Vjik\TelegramBot\Api\Method;
 
-use Vjik\TelegramBot\Api\ParseResult\ValueHelper;
+use Vjik\TelegramBot\Api\ParseResult\ValueProcessor\TrueValue;
 use Vjik\TelegramBot\Api\Request\HttpMethod;
 use Vjik\TelegramBot\Api\Request\TelegramRequestWithResultPreparingInterface;
 
@@ -37,9 +37,8 @@ public function getData(): array
         ];
     }
 
-    public function prepareResult(mixed $result): true
+    public function getResultType(): TrueValue
     {
-        ValueHelper::assertTrueResult($result);
-        return $result;
+        return new TrueValue();
     }
 }

src/Method/DeleteMyCommands.php

@@ -4,7 +4,7 @@
 
 namespace Vjik\TelegramBot\Api\Method;
 
-use Vjik\TelegramBot\Api\ParseResult\ValueHelper;
+use Vjik\TelegramBot\Api\ParseResult\ValueProcessor\TrueValue;
 use Vjik\TelegramBot\Api\Request\HttpMethod;
 use Vjik\TelegramBot\Api\Request\TelegramRequestWithResultPreparingInterface;
 use Vjik\TelegramBot\Api\Type\BotCommandScope;
@@ -41,9 +41,8 @@ public function getData(): array
         );
     }
 
-    public function prepareResult(mixed $result): true
+    public function getResultType(): TrueValue
     {
-        ValueHelper::assertTrueResult($result);
-        return $result;
+        return new TrueValue();
     }
 }

src/Method/EditChatInviteLink.php

@@ -49,8 +49,8 @@ public function getData(): array
         );
     }
 
-    public function prepareResult(mixed $result): ChatInviteLink
+    public function getResultType(): string
     {
-        return ChatInviteLink::fromTelegramResult($result);
+        return ChatInviteLink::class;
     }
 }

src/Method/EditForumTopic.php

@@ -4,7 +4,7 @@
 
 namespace Vjik\TelegramBot\Api\Method;
 
-use Vjik\TelegramBot\Api\ParseResult\ValueHelper;
+use Vjik\TelegramBot\Api\ParseResult\ValueProcessor\TrueValue;
 use Vjik\TelegramBot\Api\Request\HttpMethod;
 use Vjik\TelegramBot\Api\Request\TelegramRequestWithResultPreparingInterface;
 
@@ -44,9 +44,8 @@ public function getData(): array
         );
     }
 
-    public function prepareResult(mixed $result): true
+    public function getResultType(): TrueValue
     {
-        ValueHelper::assertTrueResult($result);
-        return $result;
+        return new TrueValue();
     }
 }

src/Method/EditGeneralForumTopic.php

@@ -4,7 +4,7 @@
 
 namespace Vjik\TelegramBot\Api\Method;
 
-use Vjik\TelegramBot\Api\ParseResult\ValueHelper;
+use Vjik\TelegramBot\Api\ParseResult\ValueProcessor\TrueValue;
 use Vjik\TelegramBot\Api\Request\HttpMethod;
 use Vjik\TelegramBot\Api\Request\TelegramRequestWithResultPreparingInterface;
 
@@ -37,9 +37,8 @@ public function getData(): array
         ];
     }
 
-    public function prepareResult(mixed $result): true
+    public function getResultType(): TrueValue
     {
-        ValueHelper::assertTrueResult($result);
-        return $result;
+        return new TrueValue();
     }
 }