Merge pull request #332 from hinoguma/feature/add-default-action-for-carousel-column

add defaultAction for CarouselColumnTemplateBuilder

Author: moririnson

src/LINEBot/MessageBuilder/TemplateBuilder/CarouselColumnTemplateBuilder.php

@@ -42,6 +42,11 @@ class CarouselColumnTemplateBuilder implements TemplateBuilder
     /** @var array */
     private $template;
 
+    /**
+     * @var TemplateActionBuilder|null
+     */
+    private $defaultAction;
+
     /**
      * CarouselColumnTemplateBuilder constructor.
      *
@@ -50,14 +55,22 @@ class CarouselColumnTemplateBuilder implements TemplateBuilder
      * @param string $thumbnailImageUrl
      * @param TemplateActionBuilder[] $actionBuilders
      * @param string|null $imageBackgroundColor
+     * @param TemplateActionBuilder|null $defaultAction
      */
-    public function __construct($title, $text, $thumbnailImageUrl, array $actionBuilders, $imageBackgroundColor = null)
-    {
+    public function __construct(
+        $title,
+        $text,
+        $thumbnailImageUrl,
+        array $actionBuilders,
+        $imageBackgroundColor = null,
+        TemplateActionBuilder $defaultAction = null
+    ) {
         $this->title = $title;
         $this->text = $text;
         $this->thumbnailImageUrl = $thumbnailImageUrl;
         $this->actionBuilders = $actionBuilders;
         $this->imageBackgroundColor = $imageBackgroundColor;
+        $this->defaultAction = $defaultAction;
     }
 
     /**
@@ -86,6 +99,9 @@ public function buildTemplate()
         if ($this->imageBackgroundColor) {
             $this->template['imageBackgroundColor'] = $this->imageBackgroundColor;
         }
+        if ($this->defaultAction) {
+            $this->template['defaultAction'] = $this->defaultAction->buildTemplateAction();
+        }
 
         return $this->template;
     }

tests/LINEBot/MessageBuilder/TemplateBuilder/CarouselColumnTemplateBuilderTest.php

@@ -71,6 +71,51 @@ class CarouselColumnTemplateBuilderTest extends TestCase
   ],
   "imageBackgroundColor":"ddd"
 }
+JSON
+        ],
+        [
+            'param' => ['aaa', 'bbb', 'ccc', ['postback'], 'ddd', 'uri'],
+            'json' => <<<JSON
+{
+  "thumbnailImageUrl":"ccc",
+  "title":"aaa",
+  "text":"bbb",
+  "actions":[
+    {"type":"postback","label":"AAA","data":"BBB"}
+  ],
+  "imageBackgroundColor":"ddd",
+  "defaultAction":{"type":"uri","label":"EEE","uri":"FFF"}
+}
+JSON
+        ],
+        [
+            'param' => ['aaa', 'bbb', 'ccc', ['postback'], 'ddd', 'message'],
+            'json' => <<<JSON
+{
+  "thumbnailImageUrl":"ccc",
+  "title":"aaa",
+  "text":"bbb",
+  "actions":[
+    {"type":"postback","label":"AAA","data":"BBB"}
+  ],
+  "imageBackgroundColor":"ddd",
+  "defaultAction":{"type":"message","label":"CCC","text":"DDD"}
+}
+JSON
+        ],
+        [
+            'param' => ['aaa', 'bbb', 'ccc', ['postback'], 'ddd', 'postback'],
+            'json' => <<<JSON
+{
+  "thumbnailImageUrl":"ccc",
+  "title":"aaa",
+  "text":"bbb",
+  "actions":[
+    {"type":"postback","label":"AAA","data":"BBB"}
+  ],
+  "imageBackgroundColor":"ddd",
+  "defaultAction":{"type":"postback","label":"AAA","data":"BBB"}
+}
 JSON
         ],
     ];
@@ -100,6 +145,20 @@ public function test()
                 $actionBuilders = null;
             }
             $imageBackgroundColor = isset($t['param'][4]) ? $t['param'][4] : null;
+            $defaultAction = null;
+            if (isset($t['param'][5])) {
+                switch ($t['param'][5]) {
+                    case 'postback':
+                        $defaultAction = $postbackActionBuilder;
+                        break;
+                    case 'message':
+                        $defaultAction = $messageTemplateActionBuilder;
+                        break;
+                    case 'uri':
+                        $defaultAction = $uriTemplateActionBuilder;
+                        break;
+                }
+            }
 
             if (count($t['param']) == 5) {
                 $builder = new CarouselColumnTemplateBuilder(
@@ -109,6 +168,15 @@ public function test()
                     $actionBuilders,
                     $imageBackgroundColor
                 );
+            } elseif (count($t['param']) == 6) {
+                $builder = new CarouselColumnTemplateBuilder(
+                    $title,
+                    $text,
+                    $thumbnailImageUrl,
+                    $actionBuilders,
+                    $imageBackgroundColor,
+                    $defaultAction
+                );
             } else {
                 $builder = new CarouselColumnTemplateBuilder(
                     $title,