Page MenuHomePhabricator (Chris)
Files F627217

Conversation.php
No OneTemporary
Actions

Authored By
Unknown
Size
5 KB
Referenced Files
None
Subscribers
None

Conversation.php
View Options

<?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;
use Longman\TelegramBot\Exception\TelegramException;
/**
* Class Conversation
*
* Only one conversation can be active at any one time.
* A conversation is directly linked to a user, chat and the command that is managing the conversation.
*/
class Conversation
{
/**
* All information fetched from the database
*
* @var array|null
*/
protected $conversation;
/**
* Notes stored inside the conversation
*
* @var mixed
*/
protected $protected_notes;
/**
* Notes to be stored
*
* @var mixed
*/
public $notes;
/**
* Telegram user id
*
* @var int
*/
protected $user_id;
/**
* Telegram chat id
*
* @var int
*/
protected $chat_id;
/**
* Command to be executed if the conversation is active
*
* @var string
*/
protected $command;
/**
* Conversation constructor to initialize a new conversation
*
* @param int $user_id
* @param int $chat_id
* @param string $command
*
* @throws TelegramException
*/
public function __construct(int $user_id, int $chat_id, string $command = '')
{
$this->user_id = $user_id;
$this->chat_id = $chat_id;
$this->command = $command;
//Try to load an existing conversation if possible
if (!$this->load() && $command !== '') {
//A new conversation start
$this->start();
}
}
/**
* Clear all conversation variables.
*
* @return bool Always return true, to allow this method in an if statement.
*/
protected function clear(): bool
{
$this->conversation = null;
$this->protected_notes = null;
$this->notes = null;
return true;
}
/**
* Load the conversation from the database
*
* @return bool
* @throws TelegramException
*/
protected function load(): bool
{
//Select an active conversation
$conversation = ConversationDB::selectConversation($this->user_id, $this->chat_id, 1);
if (isset($conversation[0])) {
//Pick only the first element
$this->conversation = $conversation[0];
//Load the command from the conversation if it hasn't been passed
$this->command = $this->command ?: $this->conversation['command'];
if ($this->command !== $this->conversation['command']) {
$this->cancel();
return false;
}
//Load the conversation notes
$this->protected_notes = json_decode($this->conversation['notes'], true);
$this->notes = $this->protected_notes;
}
return $this->exists();
}
/**
* Check if the conversation already exists
*
* @return bool
*/
public function exists(): bool
{
return $this->conversation !== null;
}
/**
* Start a new conversation if the current command doesn't have one yet
*
* @return bool
* @throws TelegramException
*/
protected function start(): bool
{
if (
$this->command
&& !$this->exists()
&& ConversationDB::insertConversation(
$this->user_id,
$this->chat_id,
$this->command
)
) {
return $this->load();
}
return false;
}
/**
* Delete the current conversation
*
* Currently the Conversation is not deleted but just set to 'stopped'
*
* @return bool
* @throws TelegramException
*/
public function stop(): bool
{
return $this->updateStatus('stopped') && $this->clear();
}
/**
* Cancel the current conversation
*
* @return bool
* @throws TelegramException
*/
public function cancel(): bool
{
return $this->updateStatus('cancelled') && $this->clear();
}
/**
* Update the status of the current conversation
*
* @param string $status
*
* @return bool
* @throws TelegramException
*/
protected function updateStatus(string $status): bool
{
if ($this->exists()) {
$fields = ['status' => $status];
$where = [
'id' => $this->conversation['id'],
'status' => 'active',
'user_id' => $this->user_id,
'chat_id' => $this->chat_id,
];
if (ConversationDB::updateConversation($fields, $where)) {
return true;
}
}
return false;
}
/**
* Store the array/variable in the database with json_encode() function
*
* @return bool
* @throws TelegramException
*/
public function update(): bool
{
if ($this->exists()) {
$fields = ['notes' => json_encode($this->notes, JSON_UNESCAPED_UNICODE)];
//I can update a conversation whatever the state is
$where = ['id' => $this->conversation['id']];
if (ConversationDB::updateConversation($fields, $where)) {
return true;
}
}
return false;
}
/**
* Retrieve the command to execute from the conversation
*
* @return string
*/
public function getCommand(): string
{
return $this->command;
}
/**
* Retrieve the user id
*
* @return int
*/
public function getUserId(): int
{
return $this->user_id;
}
/**
* Retrieve the chat id
*
* @return int
*/
public function getChatId(): int
{
return $this->chat_id;
}
}

File Metadata

Mime Type
text/x-php
Expires
Sun, Nov 15, 1:44 AM (1 d, 21 h)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
111214
Default Alt Text
Conversation.php (5 KB)

Event Timeline