Change to be able to set text field to PostbackTemplate

Fix #47

Author: moznion

src/LINEBot/TemplateActionBuilder/PostbackTemplateActionBuilder.php

@@ -32,17 +32,21 @@ class PostbackTemplateActionBuilder implements TemplateActionBuilder
     private $label;
     /** @var string */
     private $data;
+    /** @var string|null */
+    private $text;
 
     /**
      * PostbackAction constructor.
      *
      * @param string $label Label of action.
      * @param string $data Data of postback.
+     * @param string|null $text The text which will be sent when action is executed (optional).
      */
-    public function __construct($label, $data)
+    public function __construct($label, $data, $text = null)
     {
         $this->label = $label;
         $this->data = $data;
+        $this->text = $text;
     }
 
     /**
@@ -52,10 +56,17 @@ public function __construct($label, $data)
      */
     public function buildTemplateAction()
     {
-        return [
+        $action = [
             'type' => ActionType::POSTBACK,
             'label' => $this->label,
             'data' => $this->data,
         ];
+
+        if (isset($this->text)) {
+            // If text is set, append extend field.
+            $action['text'] = $this->text;
+        }
+
+        return $action;
     }
 }

tests/LINEBot/SendTemplateTest.php

@@ -19,13 +19,13 @@
 namespace LINE\Tests\LINEBot;
 
 use LINE\LINEBot;
-use LINE\LINEBot\TemplateActionBuilder\MessageTemplateActionBuilder;
-use LINE\LINEBot\TemplateActionBuilder\PostbackTemplateActionBuilder;
-use LINE\LINEBot\TemplateActionBuilder\UriTemplateActionBuilder;
 use LINE\LINEBot\Constant\ActionType;
 use LINE\LINEBot\Constant\MessageType;
 use LINE\LINEBot\Constant\TemplateType;
 use LINE\LINEBot\MessageBuilder\TemplateBuilder\ButtonTemplateBuilder;
+use LINE\LINEBot\TemplateActionBuilder\MessageTemplateActionBuilder;
+use LINE\LINEBot\TemplateActionBuilder\PostbackTemplateActionBuilder;
+use LINE\LINEBot\TemplateActionBuilder\UriTemplateActionBuilder;
 use LINE\Tests\LINEBot\Util\DummyHttpClient;
 
 class SendTemplateTest extends \PHPUnit_Framework_TestCase
@@ -147,4 +147,51 @@ public function testPushTemplate()
         $this->assertTrue($res->isSucceeded());
         $this->assertEquals(200, $res->getJSONDecodedBody()['status']);
     }
+
+    public function testPushTemplateWithText()
+    {
+        // Support text field on postback template
+        // Ref: https://github.com/line/line-bot-sdk-php/issues/47
+        $mock = function ($testRunner, $httpMethod, $url, $data) {
+            /** @var \PHPUnit_Framework_TestCase $testRunner */
+            $testRunner->assertEquals('POST', $httpMethod);
+            $testRunner->assertEquals('https://api.line.me/v2/bot/message/push', $url);
+
+            $testRunner->assertEquals('DESTINATION', $data['to']);
+            $testRunner->assertEquals(1, count($data['messages']));
+
+            $message = $data['messages'][0];
+            $template = $message['template'];
+            $actions = $template['actions'];
+
+            $testRunner->assertEquals(3, count($actions));
+            $testRunner->assertEquals(ActionType::POSTBACK, $actions[0]['type']);
+            $testRunner->assertEquals('postback label', $actions[0]['label']);
+            $testRunner->assertEquals('post=back', $actions[0]['data']);
+            $testRunner->assertEquals('extend text', $actions[0]['text']);
+
+            return ['status' => 200];
+        };
+        $bot = new LINEBot(new DummyHttpClient($this, $mock), ['channelSecret' => 'CHANNEL-SECRET']);
+        $res = $bot->pushMessage(
+            'DESTINATION',
+            new LINEBot\MessageBuilder\TemplateMessageBuilder(
+                'alt test',
+                new ButtonTemplateBuilder(
+                    'button title',
+                    'button button',
+                    'https://example.com/thumbnail.jpg',
+                    [
+                        new PostbackTemplateActionBuilder('postback label', 'post=back', 'extend text'), // <= Test here
+                        new MessageTemplateActionBuilder('message label', 'test message'),
+                        new UriTemplateActionBuilder('uri label', 'https://example.com'),
+                    ]
+                )
+            )
+        );
+
+        $this->assertEquals(200, $res->getHTTPStatus());
+        $this->assertTrue($res->isSucceeded());
+        $this->assertEquals(200, $res->getJSONDecodedBody()['status']);
+    }
 }