Message.php 11.3 KB
Newer Older
MBoretto's avatar
MBoretto committed
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
<?php

/*
 * This file is part of the TelegramBot package.
 *
 * (c) Avtandil Kikabidze aka LONGMAN <akalongman@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
*/

namespace Longman\TelegramBot\Entities;

use Longman\TelegramBot\Exception\TelegramException;

class Message extends Entity
{
    protected $message_id;

    protected $from;

    protected $date;

    protected $chat;

    protected $forward_from;

    protected $forward_date;

    protected $reply_to_message;

    protected $text;

    protected $audio;

    protected $document;

    protected $photo;

    protected $sticker;

    protected $video;

MBoretto's avatar
MBoretto committed
44 45 46 47
    protected $voice;

    protected $caption;

MBoretto's avatar
MBoretto committed
48 49 50 51 52 53 54 55 56 57 58 59 60 61 62
    protected $contact;

    protected $location;

    protected $new_chat_participant;

    protected $left_chat_participant;

    protected $new_chat_title;

    protected $new_chat_photo;

    protected $delete_chat_photo;

    protected $group_chat_created;
MBoretto's avatar
MBoretto committed
63 64 65 66 67 68 69 70 71

    protected $supergroup_chat_created;

    protected $channel_chat_created;

    protected $migrate_to_chat_id;

    protected $migrate_from_chat_id;

MBoretto's avatar
MBoretto committed
72

73
    private $command;
MBoretto's avatar
MBoretto committed
74 75 76 77

    private $type;

    public function __construct(array $data, $bot_name)
78 79 80 81 82 83 84 85 86 87 88 89
    {

        $this->reply_to_message = isset($data['reply_to_message']) ? $data['reply_to_message'] : null;
        if (!empty($this->reply_to_message)) {
            $this->reply_to_message = new ReplyToMessage($this->reply_to_message, $bot_name);
        }

        $this->init($data, $bot_name);
    }

    //Common init to Message and ReplyToMessage
    protected function init(array & $data, & $bot_name)
MBoretto's avatar
MBoretto committed
90 91
    {
        $this->bot_name = $bot_name;
92

MBoretto's avatar
MBoretto committed
93
        $this->type = 'Message';
MBoretto's avatar
MBoretto committed
94 95 96 97 98 99 100

        $this->message_id = isset($data['message_id']) ? $data['message_id'] : null;
        if (empty($this->message_id)) {
            throw new TelegramException('message_id is empty!');
        }

        $this->from = isset($data['from']) ? $data['from'] : null;
MBoretto's avatar
MBoretto committed
101 102
        if (!empty($this->from)) {
            $this->from = new User($this->from);
MBoretto's avatar
MBoretto committed
103 104 105 106 107 108 109 110
        }

        $this->chat = isset($data['chat']) ? $data['chat'] : null;
        if (empty($this->chat)) {
            throw new TelegramException('chat is empty!');
        }
        $this->chat = new Chat($this->chat);

111 112 113 114 115
        $this->date = isset($data['date']) ? $data['date'] : null;
        if (empty($this->date)) {
            throw new TelegramException('date is empty!');
        }

MBoretto's avatar
MBoretto committed
116 117 118 119 120 121 122
        $this->forward_from = isset($data['forward_from']) ? $data['forward_from'] : null;
        if (!empty($this->forward_from)) {
            $this->forward_from = new User($this->forward_from);
        }

        $this->forward_date = isset($data['forward_date']) ? $data['forward_date'] : null;

MBoretto's avatar
MBoretto committed
123 124 125 126 127 128 129 130 131
        $this->text = isset($data['text']) ? $data['text'] : null;
        $command = $this->getCommand();
        if (!empty($command)) {
            $this->type = 'command';
        }

        $this->audio = isset($data['audio']) ? $data['audio'] : null;
        if (!empty($this->audio)) {
            $this->audio = new Audio($this->audio);
MBoretto's avatar
MBoretto committed
132
            $this->type = 'Audio';
MBoretto's avatar
MBoretto committed
133 134 135 136 137
        }

        $this->document = isset($data['document']) ? $data['document'] : null;
        if (!empty($this->document)) {
            $this->document = new Document($this->document);
MBoretto's avatar
MBoretto committed
138
            $this->type = 'Document';
MBoretto's avatar
MBoretto committed
139 140 141 142
        }

        $this->photo = isset($data['photo']) ? $data['photo'] : null; //array of photosize
        if (!empty($this->photo)) {
143 144 145
            foreach ($this->photo as $photo) {
                if (!empty($photo)) {
                    $photos[] = new PhotoSize($photo);
MBoretto's avatar
MBoretto committed
146 147 148
                }
            }
            $this->photo = $photos;
MBoretto's avatar
MBoretto committed
149
            $this->type = 'Photo';
MBoretto's avatar
MBoretto committed
150
        }
MBoretto's avatar
MBoretto committed
151

MBoretto's avatar
MBoretto committed
152 153 154
        $this->sticker = isset($data['sticker']) ? $data['sticker'] : null;
        if (!empty($this->sticker)) {
            $this->sticker = new Sticker($this->sticker);
MBoretto's avatar
MBoretto committed
155
            $this->type = 'Sticker';
MBoretto's avatar
MBoretto committed
156 157 158 159 160
        }

        $this->video = isset($data['video']) ? $data['video'] : null;
        if (!empty($this->video)) {
            $this->video = new Video($this->video);
MBoretto's avatar
MBoretto committed
161
            $this->type = 'Video';
MBoretto's avatar
MBoretto committed
162 163 164 165 166
        }

        $this->voice = isset($data['voice']) ? $data['voice'] : null;
        if (!empty($this->voice)) {
            $this->voice = new Voice($this->voice);
MBoretto's avatar
MBoretto committed
167
            $this->type = 'Voice';
MBoretto's avatar
MBoretto committed
168 169 170 171 172 173 174 175 176 177 178 179
        }

        $this->caption = isset($data['caption']) ? $data['caption'] : null;//string

        $this->contact = isset($data['contact']) ? $data['contact'] : null;
        if (!empty($this->contact)) {
            $this->contact = new Contact($this->contact);
        }

        $this->location = isset($data['location']) ? $data['location'] : null;
        if (!empty($this->location)) {
            $this->location = new Location($this->location);
MBoretto's avatar
MBoretto committed
180
            $this->type = 'Location';
MBoretto's avatar
MBoretto committed
181 182
        }

MBoretto's avatar
MBoretto committed
183 184 185 186 187 188 189 190 191 192 193 194 195
        $this->new_chat_participant = isset($data['new_chat_participant']) ? $data['new_chat_participant'] : null;
        if (!empty($this->new_chat_participant)) {
            $this->new_chat_participant = new User($this->new_chat_participant);
            $this->type = 'new_chat_participant';
        }

        $this->left_chat_participant = isset($data['left_chat_participant']) ? $data['left_chat_participant'] : null;
        if (!empty($this->left_chat_participant)) {
            $this->left_chat_participant = new User($this->left_chat_participant);
            $this->type = 'left_chat_participant';
        }

        $this->new_chat_title = isset($data['new_chat_title']) ? $data['new_chat_title'] : null;
MBoretto's avatar
MBoretto committed
196
        if (!is_null($this->new_chat_title)) {
MBoretto's avatar
MBoretto committed
197 198 199
            $this->type = 'new_chat_title';
        }

MBoretto's avatar
MBoretto committed
200 201 202 203 204 205 206 207 208 209
        $this->new_chat_photo = isset($data['new_chat_photo']) ? $data['new_chat_photo'] : null; //array of photosize
        if (!empty($this->new_chat_photo)) {
            foreach ($this->new_chat_photo as $photo) {
                if (!empty($photo)) {
                    $photos[] = new PhotoSize($photo);
                }
            }
            $this->new_chat_photo = $photos;
        }

MBoretto's avatar
MBoretto committed
210 211 212 213 214 215 216 217 218
        $this->delete_chat_photo = isset($data['delete_chat_photo']) ? $data['delete_chat_photo'] : null;
        if ($this->delete_chat_photo) {
            $this->type = 'delete_chat_photo';
        }

        $this->group_chat_created = isset($data['group_chat_created']) ? $data['group_chat_created'] : null;
        if ($this->group_chat_created) {
            $this->type = 'group_chat_created';
        }
219

MBoretto's avatar
MBoretto committed
220 221 222 223 224 225 226 227 228 229 230 231 232
        $this->supergroup_chat_created = isset($data['supergroup_chat_created']) ? $data['supergroup_chat_created'] : null;
        if ($this->supergroup_chat_created) {
            $this->type = 'supergroup_chat_created';
        }

        $this->channel_chat_created = isset($data['channel_chat_created']) ? $data['channel_chat_created'] : null;
        if ($this->channel_chat_created) {
            $this->type = 'channel_chat_created';
        }

        $this->migrate_to_chat_id = isset($data['migrate_to_chat_id']) ? $data['migrate_to_chat_id'] : null;
        $this->migrate_from_chat_id = isset($data['migrate_from_chat_id']) ? $data['migrate_from_chat_id'] : null;

MBoretto's avatar
MBoretto committed
233 234 235 236 237 238
    }

    //return the entire command like /echo or /echo@bot1 if specified
    public function getFullCommand()
    {
        if (substr($this->text, 0, 1) === '/') {
239 240 241 242 243 244 245 246 247
            $no_EOL =  strtok($this->text, PHP_EOL);
            $no_space = strtok($this->text, ' ');

            //try to understand which separator \n or space divide /command from text
            if (strlen($no_space) < strlen($no_EOL)) {
                return $no_space;
            } else {
                return $no_EOL;
            }
MBoretto's avatar
MBoretto committed
248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284
        } else {
            return;
        }
    }

    public function getCommand()
    {
        if (!empty($this->command)) {
            return $this->command;
        }

        $cmd = $this->getFullCommand();

        if (substr($cmd, 0, 1) === '/') {
            $cmd = substr($cmd, 1);

            //check if command is follow by botname
            $split_cmd = explode('@', $cmd);
            if (isset($split_cmd[1])) {
                //command is followed by name check if is addressed to me
                if (strtolower($split_cmd[1]) == strtolower($this->bot_name)) {
                    return $this->command = $split_cmd[0];
                }
            } else {
                //command is not followed by name
                return $this->command = $cmd;
            }
        }

        return false;
    }

    public function getMessageId()
    {
        return $this->message_id;
    }

MBoretto's avatar
MBoretto committed
285
    public function getFrom()
MBoretto's avatar
MBoretto committed
286
    {
MBoretto's avatar
MBoretto committed
287
        return $this->from;
MBoretto's avatar
MBoretto committed
288 289
    }

MBoretto's avatar
MBoretto committed
290
    public function getDate()
MBoretto's avatar
MBoretto committed
291
    {
MBoretto's avatar
MBoretto committed
292
        return $this->date;
MBoretto's avatar
MBoretto committed
293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314
    }

    public function getChat()
    {
        return $this->chat;
    }

    public function getForwardFrom()
    {
        return $this->forward_from;
    }

    public function getForwardDate()
    {
        return $this->forward_date;
    }

    public function getReplyToMessage()
    {
        return $this->reply_to_message;
    }

MBoretto's avatar
MBoretto committed
315 316 317 318 319 320
    public function getText($without_cmd = false)
    {
        $text = $this->text;
        if ($without_cmd) {
            $command = $this->getFullCommand();
            if (!empty($command)) {
321 322
                //$text = substr($text, strlen($command.' '), strlen($text));
                $text = substr($text, strlen($command) + 1, strlen($text));
MBoretto's avatar
MBoretto committed
323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372
            }
        }

        return $text;
    }

    public function getAudio()
    {
        return $this->audio;
    }
    public function getDocument()
    {
        return $this->document;
    }

    public function getPhoto()
    {
        return $this->photo;
    }

    public function getSticker()
    {
        return $this->sticker;
    }

    public function getVideo()
    {
        return $this->video;
    }

    public function getVoice()
    {
        return $this->voice;
    }

    public function getCaption()
    {
        return $this->caption;
    }

    public function getContact()
    {
        return $this->contact;
    }

    public function getLocation()
    {
        return $this->location;
    }

MBoretto's avatar
MBoretto committed
373 374 375 376 377 378 379 380 381 382 383 384 385 386 387
    public function getNewChatParticipant()
    {
        return $this->new_chat_participant;
    }

    public function getLeftChatParticipant()
    {
        return $this->left_chat_participant;
    }

    public function getNewChatTitle()
    {
        return $this->new_chat_title;
    }

MBoretto's avatar
MBoretto committed
388 389 390 391 392 393 394

    public function getNewChatPhoto()
    {
        return $this->new_chat_photo;
    }


MBoretto's avatar
MBoretto committed
395 396 397 398 399 400 401 402 403 404
    public function getDeleteChatPhoto()
    {
        return $this->delete_chat_photo;
    }

    public function getGroupChatCreated()
    {
        return $this->group_chat_created;
    }

MBoretto's avatar
MBoretto committed
405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423
    public function getSupergroupChatCreated()
    {
        return $this->supergroup_chat_created;
    }

    public function getChannelChatCreated()
    {
        return $this->channel_chat_created;
    }

    public function getMigrateToChatId()
    {
        return $this->migrate_to_chat_id;
    }

    public function getMigrateFromChatId()
    {
        return $this->migrate_from_chat_id;
    }
MBoretto's avatar
MBoretto committed
424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440

    public function botAddedInChat()
    {
        if (!empty($this->new_chat_participant)) {
            if ($this->new_chat_participant->getUsername() == $this->getBotName()) {
                return true;
            }
        }

        return false;
    }

    public function getType()
    {
        return $this->type;
    }
}