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:
<?php
/**
* 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;
use LINE\LINEBot\Constant\MessageType;
use LINE\LINEBot\MessageBuilder;
use LINE\LINEBot\QuickReplyBuilder;
use LINE\LINEBot\SenderBuilder\SenderBuilder;
/**
* A builder class for text message.
*
* @package LINE\LINEBot\MessageBuilder
*/
class TextMessageBuilder implements MessageBuilder
{
/** @var string[] */
private $texts;
/** @var array */
private $message = [];
/** @var QuickReplyBuilder|null */
private $quickReply;
/** @var SenderBuilder|null */
private $sender;
/**
* TextMessageBuilder constructor.
*
* Exact signature of this constructor is <code>new TextMessageBuilder(string $text, string[] $extraTexts)</code>.
*
* Means, this constructor can also receive multiple messages like so;
*
* <code>
* $textBuilder = new TextMessageBuilder('text', 'extra text1', 'extra text2', ...);
* </code>
*
* @param string $text
* @param string[]|null $extraTexts
*/
public function __construct($text, $extraTexts = null)
{
$extras = [];
if (!is_null($extraTexts)) {
$args = func_get_args();
$extras = array_slice($args, 1);
foreach ($extras as $key => $extra) {
if ($extra instanceof QuickReplyBuilder) {
$this->quickReply = $extra;
unset($extras[$key]);
break;
} elseif ($extra instanceof SenderBuilder) {
$this->sender = $extra;
unset($extras[$key]);
break;
}
}
$extras = array_values($extras);
}
$this->texts = array_merge([$text], $extras);
}
/**
* Builds text message structure.
*
* @return array
*/
public function buildMessage()
{
if (!empty($this->message)) {
return $this->message;
}
foreach ($this->texts as $text) {
$this->message[] = [
'type' => MessageType::TEXT,
'text' => $text,
];
}
if ($this->quickReply) {
$lastKey = count($this->message) - 1;
// If the user receives multiple message objects.
// The quickReply property of the last message object is displayed.
$this->message[$lastKey]['quickReply'] = $this->quickReply->buildQuickReply();
}
if ($this->sender) {
foreach ($this->message as $messageKey => $message) {
$this->message[$messageKey]['sender'] = $this->sender->buildSender();
}
}
return $this->message;
}
}