Core of the framework. More...

Inheritance diagram for PhpBotFramework\Core\CoreBot:

Public Member Functions
	__construct (string $token)

int	getChatID ()
	Get chat ID of the current user. More...

	setChatID ($chat_id)
	Set current chat ID. More...

int	getBotID ()
	Get bot ID using `getMe` method. More...

mixed	apiRequest (string $method, array $parameters)
	Execute any API request using this method. More...

	checkRequestError ($response)

Public Member Functions inherited from PhpBotFramework\Core\Updates
	setWebhook (array $params)
	Set bot's webhook. More...

Array false	getWebhookInfo ()
	Get information about bot's webhook. More...

	deleteWebhook ()
	Delete bot's webhook. More...

Array false	getUpdates (int $offset=0, int $limit=100, int $timeout=60)
	Request bot updates. More...

	setUpdateReturned (array $allowed_updates=[])
	Set updates received by the bot for getUpdates handling. More...

Public Member Functions inherited from PhpBotFramework\Core\Send
Message false	sendMessage ($text, string $reply_markup=null, int $reply_to=null, string $parse_mode='HTML', bool $disable_web_preview=true, bool $disable_notification=false)
	Send a text message. More...

Message false	forwardMessage ($from_chat_id, int $message_id, bool $disable_notification=false)
	Forward a message. More...

Message false	sendPhoto (&$photo, string $reply_markup=null, string $caption='', bool $disable_notification=false)
	Send a photo. More...

Message false	sendAudio ($audio, string $caption=null, string $reply_markup=null, int $duration=null, string $performer, string $title=null, bool $disable_notification=false, int $reply_to_message_id=null)
	Send an audio. More...

Message false	sendDocument (string $document, string $caption='', string $reply_markup=null, bool $disable_notification=false, int $reply_to_message_id=null)
	Send a document. More...

Message false	sendSticker ($sticker, string $reply_markup=null, bool $disable_notification=false, int $reply_to_message_id=null)
	Send a sticker. More...

Message false	sendVoice ($voice, string $caption, int $duration, string $reply_markup=null, bool $disable_notification, int $reply_to_message_id=0)
	Send audio files. More...

bool	sendChatAction (string $action)
	Say the user what action bot's going to do. More...

Public Member Functions inherited from PhpBotFramework\Core\Edit
Message false	editMessageText (int $message_id, string $text, string $reply_markup=null, string $parse_mode='HTML', bool $disable_web_preview=true)
	Edit text of a message sent by the bot. More...

bool	editInlineMessageText (string $inline_message_id, string $text, string $reply_markup=null, string $parse_mode='HTML', bool $disable_web_preview=false)
	Edit text of a message sent via the bot. More...

Message false	editMessageReplyMarkup (int $message_id, string $inline_keyboard)
	Edit only the inline keyboard of a message. More...

Public Member Functions inherited from PhpBotFramework\Core\Inline
bool	answerCallbackQuery ($text='', $show_alert=false, string $url='')
	Answer a callback query. More...

bool	answerInlineQuery (string $results='', string $switch_pm_text='', $switch_pm_parameter='', bool $is_personal=true, int $cache_time=300)
	Answer a inline query (when the user write "Query") with a button, that will make user switch to the private chat with the bot, on the top of the results. Api reference More...

Public Member Functions inherited from PhpBotFramework\Core\Chat
Array false	getMe ()
	A simple method for testing bot's auth token. More...

Array false	getChat ($chat_id)
	Get info about a chat. More...

Array false	getChatAdministrators ($chat_id)
	Use this method to get the list of chat's administrators. More...

Public Attributes
	$_http

Protected Member Functions
mixed	processRequest (string $method, string $class='', $file=false)

PhpBotFramework Entities File false	checkCurrentFile ()

Array false	execRequest (string $url)

Array false	execMultipartRequest (string $url)

Protected Member Functions inherited from PhpBotFramework\Core\Updates
	execRequest (string $url)

Protected Member Functions inherited from PhpBotFramework\Core\Send
	execRequest (string $url)

	processRequest (string $method, string $class, $file)

	checkCurrentFile (TelegramFile $file)

Protected Member Functions inherited from PhpBotFramework\Core\Edit
	execRequest (string $url)

Protected Member Functions inherited from PhpBotFramework\Core\Inline
	execRequest (string $url)

Protected Member Functions inherited from PhpBotFramework\Core\Chat
	execRequest (string $url)

Protected Attributes
	$_chat_id

	$_bot_id

	$_api_url

	$_file

	$parameters

Protected Attributes inherited from PhpBotFramework\Core\Send
	$parameters

Protected Attributes inherited from PhpBotFramework\Core\Edit
	$parameters

Protected Attributes inherited from PhpBotFramework\Core\Inline
	$_callback_query_id

	$_inline_query_id

Detailed Description

Core of the framework.

Contains data used by the bot to works, curl request handling, and all api methods (sendMessage, editMessageText, etc).

Constructor & Destructor Documentation

◆ __construct()

PhpBotFramework\Core\CoreBot::__construct ( string $token )

@internal brief Initialize a new bot.

Initialize a new bot passing its token.

Parameters

$token Bot's token given by .

Member Function Documentation

◆ processRequest()

mixed PhpBotFramework\Core\CoreBot::processRequest	(	string	$method,
		string	$class = `''`,
			$file = `false`
	)

protected

@internal brief Process an API method by taking method and parameter.

optionally create a object of $class class name with the response as constructor param.

Parameters

string	$method	Method to call.
array	$param	Parameter for the method.
string	$class	Class name of the object to create using response.

Returns: mixed Response or object of $class class name.

Member Data Documentation

◆ $parameters

PhpBotFramework\Core\CoreBot::$parameters

protected

@internal brief Contains parameters of the next request.

The documentation for this class was generated from the following file:

src/Core/CoreBot.php

Public Member Functions

Public Attributes

Protected Member Functions