1:   2:   3:   4:   5:   6:   7:   8:   9:  10:  11:  12:  13:  14:  15:  16:  17:  18:  19:  20:  21:  22:  23:  24:  25:  26:  27:  28:  29:  30:  31:  32:  33:  34:  35:  36:  37:  38:  39:  40:  41:  42:  43:  44:  45:  46:  47:  48:  49:  50:  51:  52:  53:  54:  55:  56:  57:  58:  59:  60:  61:  62:  63:  64:  65:  66:  67:  68:  69:  70:  71:  72:  73:  74:  75:  76:  77:  78:  79:  80:  81:  82:  83:  84:  85:  86:  87:  88:  89:  90:  91:  92:  93:  94:  95:  96:  97:  98:  99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 

<?php /** @noinspection PhpOptionalBeforeRequiredParametersInspection */

/**
 * Copyright 2016 LINE Corporation
 *
 * LINE Corporation licenses this file to you under the Apache License,
 * version 2.0 (the "License"); you may not use this file except in compliance
 * with the License. You may obtain a copy of the License at:
 *
 *   https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations
 * under the License.
 */

namespace LINE\LINEBot\MessageBuilder\TemplateBuilder;

use LINE\LINEBot\Constant\TemplateType;
use LINE\LINEBot\MessageBuilder\TemplateBuilder;
use LINE\LINEBot\TemplateActionBuilder;

/**
 * A builder class for button template message.
 *
 * @package LINE\LINEBot\MessageBuilder\TemplateBuilder
 * @SuppressWarnings(PHPMD.NPathComplexity)
 */
class ButtonTemplateBuilder implements TemplateBuilder
{
    /** @var string */
    private $title;

    /** @var string */
    private $text;

    /** @var string */
    private $thumbnailImageUrl;

    /** @var string */
    private $imageAspectRatio;

    /** @var string */
    private $imageSize;

    /** @var string */
    private $imageBackgroundColor;

    /** @var TemplateActionBuilder[] */
    private $actionBuilders;

    /** @var array */
    private $template;

    /**
     * @var TemplateActionBuilder
     */
    private $defaultAction;

    /**
     * ButtonTemplateBuilder constructor.
     *
     * @param string|null $title
     * @param string $text
     * @param string|null $thumbnailImageUrl
     * @param TemplateActionBuilder[] $actionBuilders
     * @param string|null $imageAspectRatio
     * @param string|null $imageSize
     * @param string|null $imageBackgroundColor
     * @param TemplateActionBuilder|null $defaultAction
     */
    public function __construct(
        $title = null,
        $text, // phpcs:ignore
        $thumbnailImageUrl = null,
        array $actionBuilders,
        $imageAspectRatio = null,
        $imageSize = null,
        $imageBackgroundColor = null,
        TemplateActionBuilder $defaultAction = null
    ) {
        $this->title = $title;
        $this->text = $text;
        $this->thumbnailImageUrl = $thumbnailImageUrl;
        $this->actionBuilders = $actionBuilders;
        $this->imageAspectRatio = $imageAspectRatio;
        $this->imageSize = $imageSize;
        $this->imageBackgroundColor = $imageBackgroundColor;
        $this->defaultAction = $defaultAction;
    }

    /**
     * Builds button template message structure.
     *
     * @return array
     */
    public function buildTemplate()
    {
        if (!empty($this->template)) {
            return $this->template;
        }

        $actions = [];
        foreach ($this->actionBuilders as $actionBuilder) {
            $actions[] = $actionBuilder->buildTemplateAction();
        }

        $this->template = [
            'type' => TemplateType::BUTTONS,
            'text' => $this->text,
            'actions' => $actions,
        ];

        if (isset($this->title)) {
            $this->template['title'] = $this->title;
        }

        if ($this->thumbnailImageUrl) {
            $this->template['thumbnailImageUrl'] = $this->thumbnailImageUrl;
        }

        if ($this->imageAspectRatio) {
            $this->template['imageAspectRatio'] = $this->imageAspectRatio;
        }

        if ($this->imageSize) {
            $this->template['imageSize'] = $this->imageSize;
        }

        if ($this->imageBackgroundColor) {
            $this->template['imageBackgroundColor'] = $this->imageBackgroundColor;
        }

        if ($this->defaultAction) {
            $this->template['defaultAction'] = $this->defaultAction->buildTemplateAction();
        }

        return $this->template;
    }
}