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: 144: 145: 146: 147: 148: 149: 150: 151: 152: 153: 154: 155: 156: 157: 158: 159: 160: 161: 162: 163: 164: 165: 166: 167: 168: 169: 170: 171: 172: 173: 174: 175: 176: 177: 178: 179: 180: 181: 182: 183: 184: 185: 186: 187: 188: 189: 190: 191: 192: 193: 194: 195: 196: 197: 198: 199: 200: 201: 202: 203: 204: 205: 206: 207: 208:
<?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;
use LINE\LINEBot\Event\Parser\EventRequestParser;
use LINE\LINEBot\HTTPClient;
use LINE\LINEBot\MessageBuilder;
use LINE\LINEBot\MessageBuilder\TextMessageBuilder;
use LINE\LINEBot\Response;
use LINE\LINEBot\SignatureValidator;
use ReflectionClass;
/**
* A client class of LINE Messaging API.
*
* @package LINE
*/
class LINEBot
{
const DEFAULT_ENDPOINT_BASE = 'https://api.line.me';
/** @var string */
private $channelSecret;
/** @var string */
private $endpointBase;
/** @var HTTPClient */
private $httpClient;
/**
* LINEBot constructor.
*
* @param HTTPClient $httpClient HTTP client instance to use API calling.
* @param array $args Configurations.
*/
public function __construct(HTTPClient $httpClient, array $args)
{
$this->httpClient = $httpClient;
$this->channelSecret = $args['channelSecret'];
$this->endpointBase = LINEBot::DEFAULT_ENDPOINT_BASE;
if (array_key_exists('endpointBase', $args) && !empty($args['endpointBase'])) {
$this->endpointBase = $args['endpointBase'];
}
}
/**
* Gets specified user's profile through API calling.
*
* @param string $userId The user ID to retrieve profile.
* @return Response
*/
public function getProfile($userId)
{
return $this->httpClient->get($this->endpointBase . '/v2/bot/profile/' . urlencode($userId));
}
/**
* Gets message content which is associated with specified message ID.
*
* @param string $messageId The message ID to retrieve content.
* @return Response
*/
public function getMessageContent($messageId)
{
return $this->httpClient->get($this->endpointBase . '/v2/bot/message/' . urlencode($messageId) . '/content');
}
/**
* Replies arbitrary message to destination which is associated with reply token.
*
* @param string $replyToken Identifier of destination.
* @param MessageBuilder $messageBuilder Message builder to send.
* @return Response
*/
public function replyMessage($replyToken, MessageBuilder $messageBuilder)
{
return $this->httpClient->post($this->endpointBase . '/v2/bot/message/reply', [
'replyToken' => $replyToken,
'messages' => $messageBuilder->buildMessage(),
]);
}
/**
* Replies text message(s) to destination which is associated with reply token.
*
* This method receives variable texts. It can send text(s) message as bulk.
*
* Exact signature of this method is <code>replyText(string $replyToken, string $text, string[] $extraTexts)</code>.
*
* Means, this method can also receive multiple texts like so;
*
* <code>
* $bot->replyText('reply-text', 'text', 'extra text1', 'extra text2', ...)
* </code>
*
* @param string $replyToken Identifier of destination.
* @param string $text Text of message.
* @param string[]|null $extraTexts Extra text of message.
* @return Response
*/
public function replyText($replyToken, $text, $extraTexts = null)
{
$extra = [];
if (!is_null($extraTexts)) {
$args = func_get_args();
$extra = array_slice($args, 2);
}
/** @var TextMessageBuilder $textMessageBuilder */
$ref = new ReflectionClass('LINE\LINEBot\MessageBuilder\TextMessageBuilder');
$textMessageBuilder = $ref->newInstanceArgs(array_merge([$text], $extra));
return $this->replyMessage($replyToken, $textMessageBuilder);
}
/**
* Sends arbitrary message to destination.
*
* @param string $to Identifier of destination.
* @param MessageBuilder $messageBuilder Message builder to send.
* @return Response
*/
public function pushMessage($to, MessageBuilder $messageBuilder)
{
return $this->httpClient->post($this->endpointBase . '/v2/bot/message/push', [
'to' => $to,
'messages' => $messageBuilder->buildMessage(),
]);
}
/**
* Sends arbitrary message to multi destinations.
*
* @param array $tos Identifiers of destination.
* @param MessageBuilder $messageBuilder Message builder to send.
* @return Response
*/
public function multicast(array $tos, MessageBuilder $messageBuilder)
{
return $this->httpClient->post($this->endpointBase . '/v2/bot/message/multicast', [
'to' => $tos,
'messages' => $messageBuilder->buildMessage(),
]);
}
/**
* Leaves from group.
*
* @param string $groupId Identifier of group to leave.
* @return Response
*/
public function leaveGroup($groupId)
{
return $this->httpClient->post($this->endpointBase . '/v2/bot/group/' . urlencode($groupId) . '/leave', []);
}
/**
* Leaves from room.
*
* @param string $roomId Identifier of room to leave.
* @return Response
*/
public function leaveRoom($roomId)
{
return $this->httpClient->post($this->endpointBase . '/v2/bot/room/' . urlencode($roomId) . '/leave', []);
}
/**
* Parse event request to Event objects.
*
* @param string $body Request body.
* @param string $signature Signature of request.
* @return LINEBot\Event\BaseEvent[]
*/
public function parseEventRequest($body, $signature)
{
return EventRequestParser::parseEventRequest($body, $this->channelSecret, $signature);
}
/**
* Validate request with signature.
*
* @param string $body Request body.
* @param string $signature Signature of request.
* @return bool Request is valid or not.
*/
public function validateSignature($body, $signature)
{
return SignatureValidator::validateSignature($body, $this->channelSecret, $signature);
}
}