telegram-bot-php / core

src/lib/Entities/Update.php

Indentation +61 added lines, -61 removed lines

@@ -32,70 +32,70 @@
 class Update extends Entity
 {
 
-	public const TYPE_MESSAGE = 'message';
-	public const TYPE_EDITED_MESSAGE = 'edited_message';
-	public const TYPE_CHANNEL_POST = 'channel_post';
-	public const TYPE_EDITED_CHANNEL_POST = 'edited_channel_post';
-	public const TYPE_INLINE_QUERY = 'inline_query';
-	public const TYPE_CHOSEN_INLINE_RESULT = 'chosen_inline_result';
-	public const TYPE_CALLBACK_QUERY = 'callback_query';
-	public const TYPE_SHIPPING_QUERY = 'shipping_query';
-	public const TYPE_PRE_CHECKOUT_QUERY = 'pre_checkout_query';
-	public const TYPE_POLL = 'poll';
-	public const TYPE_POLL_ANSWER = 'poll_answer';
-	public const TYPE_MY_CHAT_MEMBER = 'my_chat_member';
-	public const TYPE_CHAT_MEMBER = 'chat_member';
-	public const TYPE_CHAT_JOIN_REQUEST = 'chat_join_request';
-	public const TYPE_WEB_DATA = 'web_data';
+    public const TYPE_MESSAGE = 'message';
+    public const TYPE_EDITED_MESSAGE = 'edited_message';
+    public const TYPE_CHANNEL_POST = 'channel_post';
+    public const TYPE_EDITED_CHANNEL_POST = 'edited_channel_post';
+    public const TYPE_INLINE_QUERY = 'inline_query';
+    public const TYPE_CHOSEN_INLINE_RESULT = 'chosen_inline_result';
+    public const TYPE_CALLBACK_QUERY = 'callback_query';
+    public const TYPE_SHIPPING_QUERY = 'shipping_query';
+    public const TYPE_PRE_CHECKOUT_QUERY = 'pre_checkout_query';
+    public const TYPE_POLL = 'poll';
+    public const TYPE_POLL_ANSWER = 'poll_answer';
+    public const TYPE_MY_CHAT_MEMBER = 'my_chat_member';
+    public const TYPE_CHAT_MEMBER = 'chat_member';
+    public const TYPE_CHAT_JOIN_REQUEST = 'chat_join_request';
+    public const TYPE_WEB_DATA = 'web_data';
 
-	/**
-	 * {@inheritdoc}
-	 */
-	protected function subEntities(): array
-	{
-		return [
-			self::TYPE_MESSAGE => Message::class,
-			self::TYPE_EDITED_MESSAGE => EditedMessage::class,
-			self::TYPE_CHANNEL_POST => ChannelPost::class,
-			self::TYPE_EDITED_CHANNEL_POST => EditedChannelPost::class,
-			self::TYPE_INLINE_QUERY => InlineQuery::class,
-			self::TYPE_CHOSEN_INLINE_RESULT => ChosenInlineResult::class,
-			self::TYPE_CALLBACK_QUERY => CallbackQuery::class,
-			self::TYPE_SHIPPING_QUERY => ShippingQuery::class,
-			self::TYPE_PRE_CHECKOUT_QUERY => PreCheckoutQuery::class,
-			self::TYPE_POLL => Poll::class,
-			self::TYPE_POLL_ANSWER => PollAnswer::class,
-			self::TYPE_MY_CHAT_MEMBER => ChatMemberUpdated::class,
-			self::TYPE_CHAT_MEMBER => ChatMemberUpdated::class,
-			self::TYPE_CHAT_JOIN_REQUEST => ChatJoinRequest::class,
-			self::TYPE_WEB_DATA => WebAppData::class,
-		];
-	}
+    /**
+     * {@inheritdoc}
+     */
+    protected function subEntities(): array
+    {
+        return [
+            self::TYPE_MESSAGE => Message::class,
+            self::TYPE_EDITED_MESSAGE => EditedMessage::class,
+            self::TYPE_CHANNEL_POST => ChannelPost::class,
+            self::TYPE_EDITED_CHANNEL_POST => EditedChannelPost::class,
+            self::TYPE_INLINE_QUERY => InlineQuery::class,
+            self::TYPE_CHOSEN_INLINE_RESULT => ChosenInlineResult::class,
+            self::TYPE_CALLBACK_QUERY => CallbackQuery::class,
+            self::TYPE_SHIPPING_QUERY => ShippingQuery::class,
+            self::TYPE_PRE_CHECKOUT_QUERY => PreCheckoutQuery::class,
+            self::TYPE_POLL => Poll::class,
+            self::TYPE_POLL_ANSWER => PollAnswer::class,
+            self::TYPE_MY_CHAT_MEMBER => ChatMemberUpdated::class,
+            self::TYPE_CHAT_MEMBER => ChatMemberUpdated::class,
+            self::TYPE_CHAT_JOIN_REQUEST => ChatJoinRequest::class,
+            self::TYPE_WEB_DATA => WebAppData::class,
+        ];
+    }
 
-	/**
-	 * Get the list of all available update types
-	 *
-	 * @return string[]
-	 */
-	public static function getUpdateTypes(): array
-	{
-		return array_keys((new self([]))->subEntities());
-	}
+    /**
+     * Get the list of all available update types
+     *
+     * @return string[]
+     */
+    public static function getUpdateTypes(): array
+    {
+        return array_keys((new self([]))->subEntities());
+    }
 
-	/**
-	 * Get the update type based on the set properties
-	 *
-	 * @return string|null
-	 */
-	public function getUpdateType(): ?string
-	{
-		foreach (self::getUpdateTypes() as $type) {
-			if ($this->getProperty($type)) {
-				return $type;
-			}
-		}
+    /**
+     * Get the update type based on the set properties
+     *
+     * @return string|null
+     */
+    public function getUpdateType(): ?string
+    {
+        foreach (self::getUpdateTypes() as $type) {
+            if ($this->getProperty($type)) {
+                return $type;
+            }
+        }
 
-		return null;
-	}
+        return null;
+    }
 
 }

src/lib/Entity.php

Indentation +150 added lines, -150 removed lines

@@ -12,155 +12,155 @@
 abstract class Entity
 {
 
-	/**
-	 * @var array The raw data passed to this entity
-	 */
-	protected array $raw_data;
-
-	/**
-	 * Entity constructor.
-	 *
-	 * @param ?array $data The raw data passed to this entity
-	 */
-	public function __construct(?array $data)
-	{
-		if (!empty($data)) {
-			$this->assignMemberVariables(($this->raw_data = $data));
-			$this->validate();
-		}
-	}
-
-	/**
-	 * Get the raw data passed to this entity
-	 *
-	 * @param bool $associated
-	 * @return array|string
-	 */
-	public function getRawData(bool $associated = true): array|string
-	{
-		return $associated ? $this->raw_data : json_encode($this->raw_data);
-	}
-
-	/**
-	 * Helper to set member variables
-	 *
-	 * @param array $data
-	 * @return void
-	 */
-	protected function assignMemberVariables(array $data): void
-	{
-		foreach ($data as $key => $value) {
-			$this->$key = $value;
-		}
-	}
-
-	/**
-	 * Get a property from the current Entity
-	 *
-	 * @param string $property
-	 * @param mixed $default
-	 *
-	 * @return mixed
-	 */
-	public function getProperty(string $property, mixed $default = null): mixed
-	{
-		return $this->raw_data[$property] ?? $default;
-	}
-
-	/**
-	 * Get the list of the properties that are themselves Entities
-	 *
-	 * @return array
-	 */
-	protected function subEntities(): array
-	{
-		return [];
-	}
-
-	/**
-	 * Perform any special entity validation
-	 *
-	 * @return void
-	 */
-	protected function validate(): void
-	{
-		// Do nothing by default
-	}
-
-	/**
-	 * @param string $name The name of the property
-	 * @param array $arguments The arguments passed to the method
-	 * @return mixed
-	 */
-	public function __call(string $name, array $arguments): mixed
-	{
-		if (method_exists($this, $name)) {
-			return $this->{$name}(...$arguments);
-		}
-
-		if (str_starts_with($name, 'get')) {
-			$property_name = strtolower(ltrim(preg_replace('/[A-Z]/', '_$0', substr($name, 3)), '_'));
-
-			$property = $this->getProperty($property_name);
-			$sub_entities = $this->subEntities() ?? [];
-
-			if (isset($sub_entities[$property_name])) {
-				$class_name = $sub_entities[$property_name];
-				return Factory::resolveEntityClass($class_name, $property);
-			}
-
-			return $property ?? null;
-		}
-
-		if (str_starts_with($name, 'set')) {
-			$property_name = strtolower(ltrim(preg_replace('/[A-Z]/', '_$0', substr($name, 3)), '_'));
-
-			if (property_exists($this, $property_name)) {
-				$this->{$property_name} = $arguments[0];
-				$this->raw_data[$property_name] = $arguments[0];
-
-				return $this;
-			}
-
-		}
-
-		throw new \BadMethodCallException("Method '$name' does not exist");
-	}
-
-	/**
-	 * Escape markdown (v1) special characters
-	 *
-	 * @see https://core.telegram.org/bots/api#markdown-style
-	 *
-	 * @param string $string
-	 *
-	 * @return string
-	 */
-	public static function escapeMarkdown(string $string): string
-	{
-		return str_replace(
-			['[', '`', '*', '_',],
-			['\[', '\`', '\*', '\_',],
-			$string
-		);
-	}
-
-	/**
-	 * Escape markdown (v2) special characters
-	 *
-	 * @see https://core.telegram.org/bots/api#markdownv2-style
-	 *
-	 * @param string $string
-	 *
-	 * @return string
-	 */
-	public static function escapeMarkdownV2(string $string): string
-	{
-		return str_replace(
-			['_', '*', '[', ']', '(', ')', '~', '`', '>', '#', '+', '-', '=', '|', '{', '}', '.', '!'],
-			['\_', '\*', '\[', '\]', '\(', '\)', '\~', '\`', '\>', '\#', '\+', '\-', '\=', '\|', '\{', '\}', '\.', '\!'],
-			$string
-		);
-	}
+    /**
+     * @var array The raw data passed to this entity
+     */
+    protected array $raw_data;
+
+    /**
+     * Entity constructor.
+     *
+     * @param ?array $data The raw data passed to this entity
+     */
+    public function __construct(?array $data)
+    {
+        if (!empty($data)) {
+            $this->assignMemberVariables(($this->raw_data = $data));
+            $this->validate();
+        }
+    }
+
+    /**
+     * Get the raw data passed to this entity
+     *
+     * @param bool $associated
+     * @return array|string
+     */
+    public function getRawData(bool $associated = true): array|string
+    {
+        return $associated ? $this->raw_data : json_encode($this->raw_data);
+    }
+
+    /**
+     * Helper to set member variables
+     *
+     * @param array $data
+     * @return void
+     */
+    protected function assignMemberVariables(array $data): void
+    {
+        foreach ($data as $key => $value) {
+            $this->$key = $value;
+        }
+    }
+
+    /**
+     * Get a property from the current Entity
+     *
+     * @param string $property
+     * @param mixed $default
+     *
+     * @return mixed
+     */
+    public function getProperty(string $property, mixed $default = null): mixed
+    {
+        return $this->raw_data[$property] ?? $default;
+    }
+
+    /**
+     * Get the list of the properties that are themselves Entities
+     *
+     * @return array
+     */
+    protected function subEntities(): array
+    {
+        return [];
+    }
+
+    /**
+     * Perform any special entity validation
+     *
+     * @return void
+     */
+    protected function validate(): void
+    {
+        // Do nothing by default
+    }
+
+    /**
+     * @param string $name The name of the property
+     * @param array $arguments The arguments passed to the method
+     * @return mixed
+     */
+    public function __call(string $name, array $arguments): mixed
+    {
+        if (method_exists($this, $name)) {
+            return $this->{$name}(...$arguments);
+        }
+
+        if (str_starts_with($name, 'get')) {
+            $property_name = strtolower(ltrim(preg_replace('/[A-Z]/', '_$0', substr($name, 3)), '_'));
+
+            $property = $this->getProperty($property_name);
+            $sub_entities = $this->subEntities() ?? [];
+
+            if (isset($sub_entities[$property_name])) {
+                $class_name = $sub_entities[$property_name];
+                return Factory::resolveEntityClass($class_name, $property);
+            }
+
+            return $property ?? null;
+        }
+
+        if (str_starts_with($name, 'set')) {
+            $property_name = strtolower(ltrim(preg_replace('/[A-Z]/', '_$0', substr($name, 3)), '_'));
+
+            if (property_exists($this, $property_name)) {
+                $this->{$property_name} = $arguments[0];
+                $this->raw_data[$property_name] = $arguments[0];
+
+                return $this;
+            }
+
+        }
+
+        throw new \BadMethodCallException("Method '$name' does not exist");
+    }
+
+    /**
+     * Escape markdown (v1) special characters
+     *
+     * @see https://core.telegram.org/bots/api#markdown-style
+     *
+     * @param string $string
+     *
+     * @return string
+     */
+    public static function escapeMarkdown(string $string): string
+    {
+        return str_replace(
+            ['[', '`', '*', '_',],
+            ['\[', '\`', '\*', '\_',],
+            $string
+        );
+    }
+
+    /**
+     * Escape markdown (v2) special characters
+     *
+     * @see https://core.telegram.org/bots/api#markdownv2-style
+     *
+     * @param string $string
+     *
+     * @return string
+     */
+    public static function escapeMarkdownV2(string $string): string
+    {
+        return str_replace(
+            ['_', '*', '[', ']', '(', ')', '~', '`', '>', '#', '+', '-', '=', '|', '{', '}', '.', '!'],
+            ['\_', '\*', '\[', '\]', '\(', '\)', '\~', '\`', '\>', '\#', '\+', '\-', '\=', '\|', '\{', '\}', '\.', '\!'],
+            $string
+        );
+    }
 
 }
\ No newline at end of file

src/lib/WebhookHandler.php

Indentation +217 added lines, -217 removed lines

@@ -17,222 +17,222 @@
 abstract class WebhookHandler extends Telegram
 {
 
-	/**
-	 * @var ?Update
-	 */
-	protected ?Update $update;
-
-	/**
-	 * @var array<Plugin>
-	 */
-	private array $plugins = [];
-
-	/**
-	 * @var bool
-	 */
-	private bool $isActive = false;
-
-	/**
-	 * The default configuration of the webhook.
-	 *
-	 * @var array
-	 */
-	private array $config = [
-		'autoload_env_file' => false,
-		'env_file_path' => null,
-	];
-
-	/**
-	 * Webhook constructor.
-	 *
-	 * @param string $api_key The API key of the bot. Leave it blank for autoload from .env file.
-	 */
-	public function __construct(string $api_key = '')
-	{
-		parent::__construct($api_key);
-
-		if (!Telegram::validateToken(self::getApiKey())) {
-			throw new InvalidBotTokenException();
-		}
-	}
-
-	/**
-	 * Initialize the receiver.
-	 *
-	 * @return void
-	 */
-	public function init(): void
-	{
-		$this->config['env_file_path'] = $_SERVER['DOCUMENT_ROOT'] . '/.env';
-	}
-
-	/**
-	 * Add a plugin to the receiver
-	 *
-	 * @param array<Plugin> $plugins
-	 */
-	public function addPlugin(array $plugins): void
-	{
-		foreach ($plugins as $plugin) {
-			if (!is_subclass_of($plugin, Plugin::class)) {
-				throw new \RuntimeException(
-					sprintf('The plugin %s must be an instance of %s', get_class($plugin), Plugin::class)
-				);
-			}
-			$this->plugins[] = $plugin;
-		}
-	}
-
-	/**
-	 * Match the update with the given plugins
-	 *
-	 * @param array<Plugin> $plugins
-	 * @param ?Update $update The update to match
-	 * @return void
-	 */
-	public function loadPluginsWith(array $plugins, Update $update = null): void
-	{
-		$update = $update ?? ($this->update ?? Telegram::getUpdate());
-
-		foreach ($plugins as $plugin) {
-			if (!is_subclass_of($plugin, Plugin::class)) {
-				throw new \InvalidArgumentException(
-					sprintf('The plugin %s must be an instance of %s', get_class($plugin), Plugin::class)
-				);
-			}
-		}
-
-		if ($update instanceof Update) {
-			$this->spreadUpdateWith($update, $plugins);
-		}
-	}
-
-	/**
-	 * Match the message to the plugins
-	 *
-	 * @param ?Update $update The update to match
-	 * @return void
-	 */
-	public function loadPlugins(Update $update = null): void
-	{
-		$update = $update ?? ($this->update ?? Telegram::getUpdate());
-		$this->loadPluginsWith($this->plugins, $update);
-	}
-
-	/**
-	 * Load the environment's
-	 *
-	 * @param string $path
-	 * @retrun void
-	 */
-	public function loadFileOfEnv(string $path): void
-	{
-		DotEnv::load($path);
-	}
-
-	/**
-	 * Update the configuration
-	 *
-	 * @param array $configuration
-	 * @return void
-	 */
-	public function updateConfiguration(array $configuration): void
-	{
-		$this->config = array_merge($this->config, $configuration);
-	}
-
-	/**
-	 * Resolve the request.
-	 *
-	 * @param ?Update $update The custom to work with
-	 * @param array $config The configuration of the receiver
-	 *
-	 * @retrun void
-	 */
-	public function resolve(Update $update = null, array $config = []): void
-	{
-		$method = '__process';
-		if (!method_exists($this, $method)) {
-			throw new \RuntimeException(sprintf('The method %s does not exist', $method));
-		}
-
-		if (is_array($config)) $this->updateConfiguration($config);
-
-		if (!empty($update)) $this->update = $update;
-		else $this->update = Telegram::getUpdate() !== false ? Telegram::getUpdate() : null;
-
-		if (empty($this->update)) {
-			TelegramLog::error(
-				'The update is empty, the request is not processed'
-			);
-			return;
-		}
-
-		try {
-
-			Common::arrest($this, $method, $this->update);
-
-		} catch (\RuntimeException $exception) {
-
-			$e = $exception->getPrevious();
-			TelegramLog::error(($message = sprintf(
-				'%s(%d): %s\n%s', $e->getFile(), $e->getLine(), $e->getMessage(), $e->getTraceAsString()
-			)));
-
-			if (defined('TG_ADMIN_ID') && TG_ADMIN_ID && defined('DEBUG_MODE') && DEBUG_MODE) {
-				file_put_contents(
-					($file = getcwd() . '/' . uniqid('error_') . '.log'),
-					$message . PHP_EOL . PHP_EOL . $update->getRawData(false)
-				);
-				Request::sendMessage([
-					'chat_id' => TG_ADMIN_ID,
-					'text' => $message,
-				]);
-				Request::sendDocument([
-					'chat_id' => TG_ADMIN_ID,
-					'document' => $file,
-				]);
-				unlink($file);
-			}
-		}
-	}
-
-	/**
-	 * This function will get update and spread it to the plugins
-	 *
-	 * @param Update $update
-	 * @param array<Plugin> $plugins
-	 * @return void
-	 */
-	private function spreadUpdateWith(Update $update, array $plugins): void
-	{
-		$this->isActive = true;
-
-		foreach ($plugins as $plugin) {
-			/** @var Plugin $plugin */
-			(new $plugin())->__execute($this, $update);
-			if ($this->isActive === false) break;
-		}
-
-		$this->isActive = false;
-	}
-
-	/**
-	 * Kill the speeding process
-	 *
-	 * @return void
-	 */
-	public function kill(): void
-	{
-		$this->isActive = false;
-	}
-
-	/**
-	 * Use this method on the webhook class to get the updates
-	 *
-	 * @param Update $update
-	 * @return void
-	 */
-	abstract public function __process(Update $update): void;
+    /**
+     * @var ?Update
+     */
+    protected ?Update $update;
+
+    /**
+     * @var array<Plugin>
+     */
+    private array $plugins = [];
+
+    /**
+     * @var bool
+     */
+    private bool $isActive = false;
+
+    /**
+     * The default configuration of the webhook.
+     *
+     * @var array
+     */
+    private array $config = [
+        'autoload_env_file' => false,
+        'env_file_path' => null,
+    ];
+
+    /**
+     * Webhook constructor.
+     *
+     * @param string $api_key The API key of the bot. Leave it blank for autoload from .env file.
+     */
+    public function __construct(string $api_key = '')
+    {
+        parent::__construct($api_key);
+
+        if (!Telegram::validateToken(self::getApiKey())) {
+            throw new InvalidBotTokenException();
+        }
+    }
+
+    /**
+     * Initialize the receiver.
+     *
+     * @return void
+     */
+    public function init(): void
+    {
+        $this->config['env_file_path'] = $_SERVER['DOCUMENT_ROOT'] . '/.env';
+    }
+
+    /**
+     * Add a plugin to the receiver
+     *
+     * @param array<Plugin> $plugins
+     */
+    public function addPlugin(array $plugins): void
+    {
+        foreach ($plugins as $plugin) {
+            if (!is_subclass_of($plugin, Plugin::class)) {
+                throw new \RuntimeException(
+                    sprintf('The plugin %s must be an instance of %s', get_class($plugin), Plugin::class)
+                );
+            }
+            $this->plugins[] = $plugin;
+        }
+    }
+
+    /**
+     * Match the update with the given plugins
+     *
+     * @param array<Plugin> $plugins
+     * @param ?Update $update The update to match
+     * @return void
+     */
+    public function loadPluginsWith(array $plugins, Update $update = null): void
+    {
+        $update = $update ?? ($this->update ?? Telegram::getUpdate());
+
+        foreach ($plugins as $plugin) {
+            if (!is_subclass_of($plugin, Plugin::class)) {
+                throw new \InvalidArgumentException(
+                    sprintf('The plugin %s must be an instance of %s', get_class($plugin), Plugin::class)
+                );
+            }
+        }
+
+        if ($update instanceof Update) {
+            $this->spreadUpdateWith($update, $plugins);
+        }
+    }
+
+    /**
+     * Match the message to the plugins
+     *
+     * @param ?Update $update The update to match
+     * @return void
+     */
+    public function loadPlugins(Update $update = null): void
+    {
+        $update = $update ?? ($this->update ?? Telegram::getUpdate());
+        $this->loadPluginsWith($this->plugins, $update);
+    }
+
+    /**
+     * Load the environment's
+     *
+     * @param string $path
+     * @retrun void
+     */
+    public function loadFileOfEnv(string $path): void
+    {
+        DotEnv::load($path);
+    }
+
+    /**
+     * Update the configuration
+     *
+     * @param array $configuration
+     * @return void
+     */
+    public function updateConfiguration(array $configuration): void
+    {
+        $this->config = array_merge($this->config, $configuration);
+    }
+
+    /**
+     * Resolve the request.
+     *
+     * @param ?Update $update The custom to work with
+     * @param array $config The configuration of the receiver
+     *
+     * @retrun void
+     */
+    public function resolve(Update $update = null, array $config = []): void
+    {
+        $method = '__process';
+        if (!method_exists($this, $method)) {
+            throw new \RuntimeException(sprintf('The method %s does not exist', $method));
+        }
+
+        if (is_array($config)) $this->updateConfiguration($config);
+
+        if (!empty($update)) $this->update = $update;
+        else $this->update = Telegram::getUpdate() !== false ? Telegram::getUpdate() : null;
+
+        if (empty($this->update)) {
+            TelegramLog::error(
+                'The update is empty, the request is not processed'
+            );
+            return;
+        }
+
+        try {
+
+            Common::arrest($this, $method, $this->update);
+
+        } catch (\RuntimeException $exception) {
+
+            $e = $exception->getPrevious();
+            TelegramLog::error(($message = sprintf(
+                '%s(%d): %s\n%s', $e->getFile(), $e->getLine(), $e->getMessage(), $e->getTraceAsString()
+            )));
+
+            if (defined('TG_ADMIN_ID') && TG_ADMIN_ID && defined('DEBUG_MODE') && DEBUG_MODE) {
+                file_put_contents(
+                    ($file = getcwd() . '/' . uniqid('error_') . '.log'),
+                    $message . PHP_EOL . PHP_EOL . $update->getRawData(false)
+                );
+                Request::sendMessage([
+                    'chat_id' => TG_ADMIN_ID,
+                    'text' => $message,
+                ]);
+                Request::sendDocument([
+                    'chat_id' => TG_ADMIN_ID,
+                    'document' => $file,
+                ]);
+                unlink($file);
+            }
+        }
+    }
+
+    /**
+     * This function will get update and spread it to the plugins
+     *
+     * @param Update $update
+     * @param array<Plugin> $plugins
+     * @return void
+     */
+    private function spreadUpdateWith(Update $update, array $plugins): void
+    {
+        $this->isActive = true;
+
+        foreach ($plugins as $plugin) {
+            /** @var Plugin $plugin */
+            (new $plugin())->__execute($this, $update);
+            if ($this->isActive === false) break;
+        }
+
+        $this->isActive = false;
+    }
+
+    /**
+     * Kill the speeding process
+     *
+     * @return void
+     */
+    public function kill(): void
+    {
+        $this->isActive = false;
+    }
+
+    /**
+     * Use this method on the webhook class to get the updates
+     *
+     * @param Update $update
+     * @return void
+     */
+    abstract public function __process(Update $update): void;
 
 }
\ No newline at end of file

Braces +11 added lines, -4 removed lines

@@ -156,10 +156,15 @@ 
 			throw new \RuntimeException(sprintf('The method %s does not exist', $method));
 		}
 
-		if (is_array($config)) $this->updateConfiguration($config);
+		if (is_array($config)) {
+		    $this->updateConfiguration($config);
+		}
 
-		if (!empty($update)) $this->update = $update;
-		else $this->update = Telegram::getUpdate() !== false ? Telegram::getUpdate() : null;
+		if (!empty($update)) {
+		    $this->update = $update;
+		} else {
+		    $this->update = Telegram::getUpdate() !== false ? Telegram::getUpdate() : null;
+		}
 
 		if (empty($this->update)) {
 			TelegramLog::error(
@@ -211,7 +216,9 @@ 
 		foreach ($plugins as $plugin) {
 			/** @var Plugin $plugin */
 			(new $plugin())->__execute($this, $update);
-			if ($this->isActive === false) break;
+			if ($this->isActive === false) {
+			    break;
+			}
 		}
 
 		$this->isActive = false;

src/lib/Telegram.php

Indentation +318 added lines, -318 removed lines

@@ -18,323 +18,323 @@
 class Telegram
 {
 
-	/**
-	 * @var string
-	 */
-	private string $api_key;
-
-	/**
-	 * @var string
-	 */
-	public static string $VERSION = 'v1.0.0';
-
-	/**
-	 * Telegram constructor.
-	 *
-	 * @param string $api_key
-	 */
-	public function __construct(string $api_key = '')
-	{
-		if ($api_key === '') {
-			$env_file = $this->getEnvFilePath();
-			$api_key = DotEnv::load($env_file)->get('TELEGRAM_API_KEY');
-		}
-
-		if (empty($api_key) || !is_string($api_key)) {
-			throw new TelegramException('API Key is required');
-		}
-
-		DotEnv::put('TG_CURRENT_KEY', ($this->api_key = $api_key));
-		DotEnv::put('TELEGRAM_API_KEY', ($this->api_key = $api_key));
-	}
-
-	/**
-	 * Get env file path and return it
-	 *
-	 * @return string
-	 */
-	private function getEnvFilePath(): string
-	{
-		$defaultEnvPaths = [
-			$_SERVER['DOCUMENT_ROOT'] . '/.env',
-			getcwd() . '/../.env',
-			getcwd() . '/.env',
-		];
-
-		foreach ($defaultEnvPaths as $path) {
-			if (file_exists($path)) {
-				return $path;
-			}
-		}
-
-		return '';
-	}
-
-	/**
-	 * Get API key from temporary ENV variable
-	 *
-	 * @return ?string
-	 */
-	public static function getApiKey(): ?string
-	{
-		return DotEnv::get('TG_CURRENT_KEY');
-	}
-
-	/**
-	 * Get bot info from given API key
-	 *
-	 * @return Response
-	 * @throws TelegramException
-	 */
-	public function getInfo(): Response
-	{
-		$result = Request::getMe();
-
-		if (!$result->isOk()) {
-			throw new TelegramException($result->getErrorCode() . ': ' . $result->getDescription());
-		}
-
-		return $result;
-	}
-
-	/**
-	 * Set Webhook for bot
-	 *
-	 * @param string $url
-	 * @param array $data Optional parameters.
-	 * @return Response
-	 * @throws TelegramException
-	 */
-	public function setWebhook(string $url, array $data = []): Response
-	{
-		if ($url === '') {
-			throw new TelegramException('Hook url is empty!');
-		}
-
-		if (!str_starts_with($url, 'https://')) {
-			throw new TelegramException('Hook url must start with https://');
-		}
-
-		$data = array_intersect_key($data, array_flip([
-			'certificate',
-			'ip_address',
-			'max_connections',
-			'allowed_updates',
-			'drop_pending_updates',
-		]));
-		$data['url'] = $url;
-
-		$result = Request::setWebhook($data);
-
-		if (!$result->isOk()) {
-			throw new TelegramException(
-				'Webhook was not set! Error: ' . $result->getErrorCode() . ' ' . $result->getDescription()
-			);
-		}
-
-		return $result;
-	}
-
-	/**
-	 * Delete any assigned webhook
-	 *
-	 * @param array $data
-	 * @return Response
-	 * @throws TelegramException
-	 */
-	public function deleteWebhook(array $data = []): Response
-	{
-		$result = Request::deleteWebhook($data);
-
-		if (!$result->isOk()) {
-			throw new TelegramException(
-				'Webhook was not deleted! Error: ' . $result->getErrorCode() . ' ' . $result->getDescription()
-			);
-		}
-
-		return $result;
-	}
-
-	/**
-	 * This method sets the admin username. and will be used to send you a message if the bot is not working.
-	 *
-	 * @param int $chat_id
-	 * @return void
-	 */
-	public function setAdmin(int $chat_id): void
-	{
-		defined('TG_ADMIN_ID') or define('TG_ADMIN_ID', $chat_id);
-	}
-
-	/**
-	 * Get input from stdin and return it
-	 *
-	 * @return ?string
-	 */
-	public static function getInput(): ?string
-	{
-		return file_get_contents('php://input') ?? null;
-	}
-
-	/**
-	 * This method will convert a string to an update object
-	 *
-	 * @param string $input The input string
-	 * @param string $apiKey The API key
-	 * @return Update|false
-	 */
-	public static function processUpdate(string $input, string $apiKey): Update|false
-	{
-		if (empty($input)) {
-			throw new TelegramException(
-				'Input is empty! Please check your code and try again.'
-			);
-		}
-
-		if (!self::validateToken($apiKey)) {
-			throw new TelegramException(
-				'Invalid token! Please check your code and try again.'
-			);
-		}
-
-		if (self::validateWebData($apiKey, $input)) {
-			if (Common::isUrlEncode($input)) {
-				$web_data = Common::urlDecode($input);
-			}
-
-			if (Common::isJson($input)) {
-				$web_data = json_decode($input, true);
-			}
-
-			$input = json_encode([
-				'web_data' => $web_data,
-			]);
-		}
-
-		if (!Common::isJson($input)) {
-			throw new TelegramException(
-				'Input is not a valid JSON string! Please check your code and try again.'
-			);
-		}
-
-		$input = json_decode($input, true);
-
-		return new Update($input);
-	}
-
-	/**
-	 * Validate webapp data from is from Telegram
-	 *
-	 * @link https://core.telegram.org/bots/webapps#validating-data-received-via-the-web-app
-	 *
-	 * @param string $token The bot token
-	 * @param string $body The message body from getInput()
-	 * @return bool
-	 */
-	public static function validateWebData(string $token, string $body): bool
-	{
-		if (!Common::isJson($body)) {
-			$raw_data = rawurldecode(str_replace('_auth=', '', $body));
-			$data = Common::urlDecode($raw_data);
-
-			if (empty($data['user'])) {
-				return false;
-			}
-
-			$data['user'] = urldecode($data['user']);
-
-		} else {
-			$data = json_decode($body, true);
-
-			if (empty($data['user'])) {
-				return false;
-			}
-
-			$data['user'] = json_encode($data['user']);
-		}
-
-		$data_check_string = "auth_date={$data['auth_date']}\nquery_id={$data['query_id']}\nuser={$data['user']}";
-		$secret_key = hash_hmac('sha256', $token, "WebAppData", true);
-
-		return hash_hmac('sha256', $data_check_string, $secret_key) == $data['hash'];
-	}
-
-	/**
-	 * Get the update from input
-	 *
-	 * @return Update|false
-	 */
-	public static function getUpdate(): Update|false
-	{
-		$input = self::getInput();
-		if (empty($input)) return false;
-		return Telegram::processUpdate($input, self::getApiKey());
-	}
-
-	/**
-	 * Validate the token
-	 *
-	 * @param string $token (e.g. 123456789:ABC-DEF1234ghIkl-zyx57W2v1u123ew11) {digit}:{alphanumeric[34]}
-	 * @return bool
-	 */
-	public static function validateToken(string $token): bool
-	{
-		preg_match_all('/([0-9]+:[a-zA-Z0-9-_]+)/', $token, $matches);
-		return count($matches[0]) == 1;
-	}
-
-	/**
-	 * Pass the update to the given webhook handler
-	 *
-	 * @param WebhookHandler $webhook_handler The webhook handler
-	 * @param ?Update $update By default, it will get the update from input
-	 * @return void
-	 */
-	public function fetchWith(WebhookHandler $webhook_handler, ?Update $update = null): void
-	{
-		if (is_subclass_of($webhook_handler, WebhookHandler::class)) {
-			if ($update === null) $update = self::getUpdate();
-			$webhook_handler->resolve($update);
-		}
-	}
-
-	/**
-	 * Get token from env file.
-	 *
-	 * @param string $file
-	 * @return ?string
-	 */
-	protected function getTokenFromEnvFile(string $file): ?string
-	{
-		if (!file_exists($file)) return null;
-		return DotEnv::load($file)::get('TELEGRAM_API_KEY');
-	}
-
-	/**
-	 * Debug mode
-	 *
-	 * @param ?int $admin_id Fill this or use setAdmin()
-	 * @return void
-	 */
-	public static function setDebugMode(?int $admin_id = null): void
-	{
-		error_reporting(E_ALL);
-		ini_set('display_errors', 1);
-		defined('DEBUG_MODE') or define('DEBUG_MODE', true);
-		if ($admin_id) {
-			defined('TG_ADMIN_ID') or define('TG_ADMIN_ID', $admin_id);
-		}
-	}
-
-	/**
-	 * Just another echo
-	 *
-	 * @param string $text
-	 * @return void
-	 */
-	public static function echo(string $text): void
-	{
-		echo $text;
-	}
+    /**
+     * @var string
+     */
+    private string $api_key;
+
+    /**
+     * @var string
+     */
+    public static string $VERSION = 'v1.0.0';
+
+    /**
+     * Telegram constructor.
+     *
+     * @param string $api_key
+     */
+    public function __construct(string $api_key = '')
+    {
+        if ($api_key === '') {
+            $env_file = $this->getEnvFilePath();
+            $api_key = DotEnv::load($env_file)->get('TELEGRAM_API_KEY');
+        }
+
+        if (empty($api_key) || !is_string($api_key)) {
+            throw new TelegramException('API Key is required');
+        }
+
+        DotEnv::put('TG_CURRENT_KEY', ($this->api_key = $api_key));
+        DotEnv::put('TELEGRAM_API_KEY', ($this->api_key = $api_key));
+    }
+
+    /**
+     * Get env file path and return it
+     *
+     * @return string
+     */
+    private function getEnvFilePath(): string
+    {
+        $defaultEnvPaths = [
+            $_SERVER['DOCUMENT_ROOT'] . '/.env',
+            getcwd() . '/../.env',
+            getcwd() . '/.env',
+        ];
+
+        foreach ($defaultEnvPaths as $path) {
+            if (file_exists($path)) {
+                return $path;
+            }
+        }
+
+        return '';
+    }
+
+    /**
+     * Get API key from temporary ENV variable
+     *
+     * @return ?string
+     */
+    public static function getApiKey(): ?string
+    {
+        return DotEnv::get('TG_CURRENT_KEY');
+    }
+
+    /**
+     * Get bot info from given API key
+     *
+     * @return Response
+     * @throws TelegramException
+     */
+    public function getInfo(): Response
+    {
+        $result = Request::getMe();
+
+        if (!$result->isOk()) {
+            throw new TelegramException($result->getErrorCode() . ': ' . $result->getDescription());
+        }
+
+        return $result;
+    }
+
+    /**
+     * Set Webhook for bot
+     *
+     * @param string $url
+     * @param array $data Optional parameters.
+     * @return Response
+     * @throws TelegramException
+     */
+    public function setWebhook(string $url, array $data = []): Response
+    {
+        if ($url === '') {
+            throw new TelegramException('Hook url is empty!');
+        }
+
+        if (!str_starts_with($url, 'https://')) {
+            throw new TelegramException('Hook url must start with https://');
+        }
+
+        $data = array_intersect_key($data, array_flip([
+            'certificate',
+            'ip_address',
+            'max_connections',
+            'allowed_updates',
+            'drop_pending_updates',
+        ]));
+        $data['url'] = $url;
+
+        $result = Request::setWebhook($data);
+
+        if (!$result->isOk()) {
+            throw new TelegramException(
+                'Webhook was not set! Error: ' . $result->getErrorCode() . ' ' . $result->getDescription()
+            );
+        }
+
+        return $result;
+    }
+
+    /**
+     * Delete any assigned webhook
+     *
+     * @param array $data
+     * @return Response
+     * @throws TelegramException
+     */
+    public function deleteWebhook(array $data = []): Response
+    {
+        $result = Request::deleteWebhook($data);
+
+        if (!$result->isOk()) {
+            throw new TelegramException(
+                'Webhook was not deleted! Error: ' . $result->getErrorCode() . ' ' . $result->getDescription()
+            );
+        }
+
+        return $result;
+    }
+
+    /**
+     * This method sets the admin username. and will be used to send you a message if the bot is not working.
+     *
+     * @param int $chat_id
+     * @return void
+     */
+    public function setAdmin(int $chat_id): void
+    {
+        defined('TG_ADMIN_ID') or define('TG_ADMIN_ID', $chat_id);
+    }
+
+    /**
+     * Get input from stdin and return it
+     *
+     * @return ?string
+     */
+    public static function getInput(): ?string
+    {
+        return file_get_contents('php://input') ?? null;
+    }
+
+    /**
+     * This method will convert a string to an update object
+     *
+     * @param string $input The input string
+     * @param string $apiKey The API key
+     * @return Update|false
+     */
+    public static function processUpdate(string $input, string $apiKey): Update|false
+    {
+        if (empty($input)) {
+            throw new TelegramException(
+                'Input is empty! Please check your code and try again.'
+            );
+        }
+
+        if (!self::validateToken($apiKey)) {
+            throw new TelegramException(
+                'Invalid token! Please check your code and try again.'
+            );
+        }
+
+        if (self::validateWebData($apiKey, $input)) {
+            if (Common::isUrlEncode($input)) {
+                $web_data = Common::urlDecode($input);
+            }
+
+            if (Common::isJson($input)) {
+                $web_data = json_decode($input, true);
+            }
+
+            $input = json_encode([
+                'web_data' => $web_data,
+            ]);
+        }
+
+        if (!Common::isJson($input)) {
+            throw new TelegramException(
+                'Input is not a valid JSON string! Please check your code and try again.'
+            );
+        }
+
+        $input = json_decode($input, true);
+
+        return new Update($input);
+    }
+
+    /**
+     * Validate webapp data from is from Telegram
+     *
+     * @link https://core.telegram.org/bots/webapps#validating-data-received-via-the-web-app
+     *
+     * @param string $token The bot token
+     * @param string $body The message body from getInput()
+     * @return bool
+     */
+    public static function validateWebData(string $token, string $body): bool
+    {
+        if (!Common::isJson($body)) {
+            $raw_data = rawurldecode(str_replace('_auth=', '', $body));
+            $data = Common::urlDecode($raw_data);
+
+            if (empty($data['user'])) {
+                return false;
+            }
+
+            $data['user'] = urldecode($data['user']);
+
+        } else {
+            $data = json_decode($body, true);
+
+            if (empty($data['user'])) {
+                return false;
+            }
+
+            $data['user'] = json_encode($data['user']);
+        }
+
+        $data_check_string = "auth_date={$data['auth_date']}\nquery_id={$data['query_id']}\nuser={$data['user']}";
+        $secret_key = hash_hmac('sha256', $token, "WebAppData", true);
+
+        return hash_hmac('sha256', $data_check_string, $secret_key) == $data['hash'];
+    }
+
+    /**
+     * Get the update from input
+     *
+     * @return Update|false
+     */
+    public static function getUpdate(): Update|false
+    {
+        $input = self::getInput();
+        if (empty($input)) return false;
+        return Telegram::processUpdate($input, self::getApiKey());
+    }
+
+    /**
+     * Validate the token
+     *
+     * @param string $token (e.g. 123456789:ABC-DEF1234ghIkl-zyx57W2v1u123ew11) {digit}:{alphanumeric[34]}
+     * @return bool
+     */
+    public static function validateToken(string $token): bool
+    {
+        preg_match_all('/([0-9]+:[a-zA-Z0-9-_]+)/', $token, $matches);
+        return count($matches[0]) == 1;
+    }
+
+    /**
+     * Pass the update to the given webhook handler
+     *
+     * @param WebhookHandler $webhook_handler The webhook handler
+     * @param ?Update $update By default, it will get the update from input
+     * @return void
+     */
+    public function fetchWith(WebhookHandler $webhook_handler, ?Update $update = null): void
+    {
+        if (is_subclass_of($webhook_handler, WebhookHandler::class)) {
+            if ($update === null) $update = self::getUpdate();
+            $webhook_handler->resolve($update);
+        }
+    }
+
+    /**
+     * Get token from env file.
+     *
+     * @param string $file
+     * @return ?string
+     */
+    protected function getTokenFromEnvFile(string $file): ?string
+    {
+        if (!file_exists($file)) return null;
+        return DotEnv::load($file)::get('TELEGRAM_API_KEY');
+    }
+
+    /**
+     * Debug mode
+     *
+     * @param ?int $admin_id Fill this or use setAdmin()
+     * @return void
+     */
+    public static function setDebugMode(?int $admin_id = null): void
+    {
+        error_reporting(E_ALL);
+        ini_set('display_errors', 1);
+        defined('DEBUG_MODE') or define('DEBUG_MODE', true);
+        if ($admin_id) {
+            defined('TG_ADMIN_ID') or define('TG_ADMIN_ID', $admin_id);
+        }
+    }
+
+    /**
+     * Just another echo
+     *
+     * @param string $text
+     * @return void
+     */
+    public static function echo(string $text): void
+    {
+        echo $text;
+    }
 
 }
\ No newline at end of file

src/lib/Plugin.php

Indentation +110 added lines, -110 removed lines

@@ -14,115 +14,115 @@
 abstract class Plugin
 {
 
-	/**
-	 * The Update types
-	 *
-	 * @var array
-	 */
-	protected array $update_types = [
-		'message',
-		'edited_message',
-		'channel_post',
-		'edited_channel_post',
-		'inline_query',
-		'chosen_inline_result',
-		'callback_query',
-		'shipping_query',
-		'pre_checkout_query',
-	];
-
-	/**
-	 * @var WebhookHandler
-	 */
-	protected WebhookHandler $hook;
-
-	/**
-	 * @var \Generator
-	 */
-	protected \Generator $returns;
-
-	/**
-	 * @var bool
-	 */
-	protected bool $kill_on_yield = false;
-
-	/**
-	 * Check for the exit of the plugin.
-	 *
-	 * @param \Generator $return
-	 * @return void
-	 */
-	public function __checkExit(\Generator $return): void
-	{
-		if ($return->valid()) {
-			if ($return->current() !== null && $this->kill_on_yield === true) {
-				$this->kill();
-			}
-		}
-
-		if ($return->valid()) {
-			$return->next();
-			$this->__checkExit($return);
-		}
-	}
-
-	/**
-	 * Identify the update type. e.g. Message, EditedMessage, etc.
-	 *
-	 * @param Update $update
-	 * @return string|null
-	 */
-	public function __identify(Update $update): ?string
-	{
-		$type = $update->getUpdateType();
-
-		if ($type === null) {
-			return null;
-		}
-
-		return str_replace('_', '', ucwords($type, '_'));
-	}
-
-
-	/**
-	 * Execute the plugin.
-	 *
-	 * @param WebhookHandler $receiver
-	 * @param Update $update
-	 * @return void
-	 */
-	public function __execute(WebhookHandler $receiver, Update $update): void
-	{
-		$this->hook = $receiver;
-
-		if (method_exists($this, 'onReceivedUpdate')) {
-			$return = $this->onReceivedUpdate($update);
-			$this->__checkExit($return);
-		}
-
-		$type = $this->__identify($update);
-		if (method_exists($this, ($method = 'on' . $type)) && $type !== null) {
-			$return = $this->$method($update);
-			$this->__checkExit($return);
-		}
-	}
-
-	/**
-	 * Identify the update type and if method of the type is exists, execute it.
-	 *
-	 * @param Update $update
-	 * @return \Generator
-	 */
-	abstract protected function onReceivedUpdate(Update $update): \Generator;
-
-	/**
-	 * Kill the plugin.
-	 *
-	 * @return void
-	 */
-	public function kill(): void
-	{
-		$this->hook->kill();
-	}
+    /**
+     * The Update types
+     *
+     * @var array
+     */
+    protected array $update_types = [
+        'message',
+        'edited_message',
+        'channel_post',
+        'edited_channel_post',
+        'inline_query',
+        'chosen_inline_result',
+        'callback_query',
+        'shipping_query',
+        'pre_checkout_query',
+    ];
+
+    /**
+     * @var WebhookHandler
+     */
+    protected WebhookHandler $hook;
+
+    /**
+     * @var \Generator
+     */
+    protected \Generator $returns;
+
+    /**
+     * @var bool
+     */
+    protected bool $kill_on_yield = false;
+
+    /**
+     * Check for the exit of the plugin.
+     *
+     * @param \Generator $return
+     * @return void
+     */
+    public function __checkExit(\Generator $return): void
+    {
+        if ($return->valid()) {
+            if ($return->current() !== null && $this->kill_on_yield === true) {
+                $this->kill();
+            }
+        }
+
+        if ($return->valid()) {
+            $return->next();
+            $this->__checkExit($return);
+        }
+    }
+
+    /**
+     * Identify the update type. e.g. Message, EditedMessage, etc.
+     *
+     * @param Update $update
+     * @return string|null
+     */
+    public function __identify(Update $update): ?string
+    {
+        $type = $update->getUpdateType();
+
+        if ($type === null) {
+            return null;
+        }
+
+        return str_replace('_', '', ucwords($type, '_'));
+    }
+
+
+    /**
+     * Execute the plugin.
+     *
+     * @param WebhookHandler $receiver
+     * @param Update $update
+     * @return void
+     */
+    public function __execute(WebhookHandler $receiver, Update $update): void
+    {
+        $this->hook = $receiver;
+
+        if (method_exists($this, 'onReceivedUpdate')) {
+            $return = $this->onReceivedUpdate($update);
+            $this->__checkExit($return);
+        }
+
+        $type = $this->__identify($update);
+        if (method_exists($this, ($method = 'on' . $type)) && $type !== null) {
+            $return = $this->$method($update);
+            $this->__checkExit($return);
+        }
+    }
+
+    /**
+     * Identify the update type and if method of the type is exists, execute it.
+     *
+     * @param Update $update
+     * @return \Generator
+     */
+    abstract protected function onReceivedUpdate(Update $update): \Generator;
+
+    /**
+     * Kill the plugin.
+     *
+     * @return void
+     */
+    public function kill(): void
+    {
+        $this->hook->kill();
+    }
 
 }
\ No newline at end of file