telegram-bot-php / core

src/lib/Request.php

Indentation +222 added lines, -222 removed lines

@@ -145,227 +145,227 @@
 class Request
 {
 
-	/**
-	 * Available fields for InputFile helper
-	 *
-	 * This is basically the list of all fields that allow InputFile objects
-	 * for which input can be simplified by providing local path directly  as string.
-	 *
-	 * @var array
-	 */
-	private static array $input_file_fields = [
-		'setWebhook' => ['certificate'],
-		'sendPhoto' => ['photo'],
-		'sendAudio' => ['audio', 'thumb'],
-		'sendDocument' => ['document', 'thumb'],
-		'sendVideo' => ['video', 'thumb'],
-		'sendAnimation' => ['animation', 'thumb'],
-		'sendVoice' => ['voice', 'thumb'],
-		'sendVideoNote' => ['video_note', 'thumb'],
-		'setChatPhoto' => ['photo'],
-		'sendSticker' => ['sticker'],
-		'uploadStickerFile' => ['png_sticker'],
-		'createNewStickerSet' => ['png_sticker', 'tgs_sticker', 'webm_sticker'],
-		'addStickerToSet' => ['png_sticker', 'tgs_sticker', 'webm_sticker'],
-		'setStickerSetThumb' => ['thumb'],
-	];
-
-	/**
-	 * URI of the Telegram API
-	 *
-	 * @var string
-	 */
-	private static string $api_base_uri = 'https://api.telegram.org';
-
-	/**
-	 * URI of the Telegram API for downloading files (relative to $api_base_url or absolute)
-	 *
-	 * @var string
-	 */
-	private static string $api_base_download_uri = '/file/bot{API_KEY}';
-
-	/**
-	 * The current action that is being executed
-	 *
-	 * @var string
-	 */
-	private static string $current_action = '';
-
-	/**
-	 * Get the Telegram API path
-	 *
-	 * @return string
-	 */
-	public static function getApiPath(): string
-	{
-		return self::$api_base_uri . '/bot' . Telegram::getApiKey() . '/';
-	}
-
-	/**
-	 * Initialize a http client
-	 *
-	 * @return Client
-	 */
-	private static function getClient(): Client
-	{
-		return new Client();
-	}
-
-	/**
-	 * Use this method to get stats of given user in a supergroup or channel.
-	 *
-	 * @param int $user_id User identifier
-	 * @param int $chat_id Identifier of the chat to get stats for
-	 *
-	 * @return string [left, member, administrator, creator]
-	 */
-	public static function getChatMemberStatus(int $user_id, int $chat_id): string
-	{
-		$response = self::getChatMember([
-			'user_id' => $user_id,
-			'chat_id' => $chat_id,
-		]);
-
-		return $response->getResult()->status ?? "left";
-	}
-
-	/**
-	 * Properly set up the request params
-	 *
-	 * If any item of the array is a resource, reformat it to a multipart request.
-	 * Else, just return the passed data as form params.
-	 *
-	 * @param array $data
-	 * @return array
-	 */
-	private static function setUpRequestParams(array $data): array
-	{
-		$multipart = [];
-		$has_resource = false;
-
-		$options = [
-			'header' => [
-				'Content-Type' => 'application/json',
-				'Accept' => 'application/json',
-				'User-Agent' => 'TelegramBot-PHP/' . Telegram::$VERSION
-			]
-		];
-
-		foreach ($data as $key => &$item) {
-			if (array_key_exists(self::$current_action, self::$input_file_fields) && in_array($key, self::$input_file_fields[self::$current_action], true)) {
-
-				if (is_string($item) && file_exists($item)) {
-					$has_resource = true;
-
-				} elseif (filter_var($item, FILTER_VALIDATE_URL)) {
-					$has_resource = false;
-					continue;
-
-				} else {
-					throw new TelegramException(
-						'Invalid file path or URL: ' . $item . ' for ' . self::$current_action . ' action'
-					);
-				}
-
-				$multipart[$key] = $item;
-				continue;
-			}
-
-			if ($item instanceof Entity) {
-				$item = $item->getRawData();
-			}
-
-			if (is_array($item)) {
-				$item = json_encode($item);
-			}
-
-			$options['query'][$key] = $item;
-		}
-		unset($item);
-
-		if ($has_resource) {
-			$options['multipart'] = FormData::create($multipart);
-		}
-
-		return $options;
-	}
-
-	/**
-	 * Create a Http Request
-	 *
-	 * @param string $action Action to execute
-	 * @param array $data Data to attach to the execution
-	 *
-	 * @return array An array of the setUpRequestParams and the url
-	 */
-	public static function create(string $action, array $data): array
-	{
-		return [
-			'url' => self::getApiPath() . $action,
-			'options' => self::setUpRequestParams($data)
-		];
-	}
-
-	/**
-	 * Execute HTTP Request
-	 *
-	 * @param string $action Action to execute
-	 * @param array $data Data to attach to the execution
-	 *
-	 * @return string Result of the HTTP Request
-	 */
-	private static function execute(string $action, array $data): string
-	{
-		[$url, $options] = self::create($action, $data);
-
-		$response = self::getClient()->get($url, $options);
-
-		return $response->getBody();
-	}
-
-	/**
-	 * Send command
-	 *
-	 * @param string $action
-	 * @param array $data
-	 *
-	 * @return Response
-	 * @throws TelegramException
-	 */
-	public static function send(string $action, array $data = []): Response
-	{
-		self::$current_action = $action;
-
-		$raw_response = self::execute($action, $data);
-
-		if (!Common::isJson($raw_response)) {
-			TelegramLog::debug($raw_response);
-			throw new TelegramException('Invalid response from API');
-		}
-
-		$response = new Response(json_decode($raw_response, true));
-
-		if (!$response->isOk() && $response->getErrorCode() === 401 && $response->getDescription() === 'Unauthorized') {
-			throw new InvalidBotTokenException();
-		}
-
-		self::$current_action = '';
-
-		return $response;
-	}
-
-	/**
-	 * Any statically called method should be relayed to the `send` method.
-	 *
-	 * @param string $action
-	 * @param array $data
-	 *
-	 * @return Response
-	 * @throws TelegramException
-	 */
-	public static function __callStatic(string $action, array $data): Response
-	{
-		return static::send($action, reset($data) ?: []);
-	}
+    /**
+     * Available fields for InputFile helper
+     *
+     * This is basically the list of all fields that allow InputFile objects
+     * for which input can be simplified by providing local path directly  as string.
+     *
+     * @var array
+     */
+    private static array $input_file_fields = [
+        'setWebhook' => ['certificate'],
+        'sendPhoto' => ['photo'],
+        'sendAudio' => ['audio', 'thumb'],
+        'sendDocument' => ['document', 'thumb'],
+        'sendVideo' => ['video', 'thumb'],
+        'sendAnimation' => ['animation', 'thumb'],
+        'sendVoice' => ['voice', 'thumb'],
+        'sendVideoNote' => ['video_note', 'thumb'],
+        'setChatPhoto' => ['photo'],
+        'sendSticker' => ['sticker'],
+        'uploadStickerFile' => ['png_sticker'],
+        'createNewStickerSet' => ['png_sticker', 'tgs_sticker', 'webm_sticker'],
+        'addStickerToSet' => ['png_sticker', 'tgs_sticker', 'webm_sticker'],
+        'setStickerSetThumb' => ['thumb'],
+    ];
+
+    /**
+     * URI of the Telegram API
+     *
+     * @var string
+     */
+    private static string $api_base_uri = 'https://api.telegram.org';
+
+    /**
+     * URI of the Telegram API for downloading files (relative to $api_base_url or absolute)
+     *
+     * @var string
+     */
+    private static string $api_base_download_uri = '/file/bot{API_KEY}';
+
+    /**
+     * The current action that is being executed
+     *
+     * @var string
+     */
+    private static string $current_action = '';
+
+    /**
+     * Get the Telegram API path
+     *
+     * @return string
+     */
+    public static function getApiPath(): string
+    {
+        return self::$api_base_uri . '/bot' . Telegram::getApiKey() . '/';
+    }
+
+    /**
+     * Initialize a http client
+     *
+     * @return Client
+     */
+    private static function getClient(): Client
+    {
+        return new Client();
+    }
+
+    /**
+     * Use this method to get stats of given user in a supergroup or channel.
+     *
+     * @param int $user_id User identifier
+     * @param int $chat_id Identifier of the chat to get stats for
+     *
+     * @return string [left, member, administrator, creator]
+     */
+    public static function getChatMemberStatus(int $user_id, int $chat_id): string
+    {
+        $response = self::getChatMember([
+            'user_id' => $user_id,
+            'chat_id' => $chat_id,
+        ]);
+
+        return $response->getResult()->status ?? "left";
+    }
+
+    /**
+     * Properly set up the request params
+     *
+     * If any item of the array is a resource, reformat it to a multipart request.
+     * Else, just return the passed data as form params.
+     *
+     * @param array $data
+     * @return array
+     */
+    private static function setUpRequestParams(array $data): array
+    {
+        $multipart = [];
+        $has_resource = false;
+
+        $options = [
+            'header' => [
+                'Content-Type' => 'application/json',
+                'Accept' => 'application/json',
+                'User-Agent' => 'TelegramBot-PHP/' . Telegram::$VERSION
+            ]
+        ];
+
+        foreach ($data as $key => &$item) {
+            if (array_key_exists(self::$current_action, self::$input_file_fields) && in_array($key, self::$input_file_fields[self::$current_action], true)) {
+
+                if (is_string($item) && file_exists($item)) {
+                    $has_resource = true;
+
+                } elseif (filter_var($item, FILTER_VALIDATE_URL)) {
+                    $has_resource = false;
+                    continue;
+
+                } else {
+                    throw new TelegramException(
+                        'Invalid file path or URL: ' . $item . ' for ' . self::$current_action . ' action'
+                    );
+                }
+
+                $multipart[$key] = $item;
+                continue;
+            }
+
+            if ($item instanceof Entity) {
+                $item = $item->getRawData();
+            }
+
+            if (is_array($item)) {
+                $item = json_encode($item);
+            }
+
+            $options['query'][$key] = $item;
+        }
+        unset($item);
+
+        if ($has_resource) {
+            $options['multipart'] = FormData::create($multipart);
+        }
+
+        return $options;
+    }
+
+    /**
+     * Create a Http Request
+     *
+     * @param string $action Action to execute
+     * @param array $data Data to attach to the execution
+     *
+     * @return array An array of the setUpRequestParams and the url
+     */
+    public static function create(string $action, array $data): array
+    {
+        return [
+            'url' => self::getApiPath() . $action,
+            'options' => self::setUpRequestParams($data)
+        ];
+    }
+
+    /**
+     * Execute HTTP Request
+     *
+     * @param string $action Action to execute
+     * @param array $data Data to attach to the execution
+     *
+     * @return string Result of the HTTP Request
+     */
+    private static function execute(string $action, array $data): string
+    {
+        [$url, $options] = self::create($action, $data);
+
+        $response = self::getClient()->get($url, $options);
+
+        return $response->getBody();
+    }
+
+    /**
+     * Send command
+     *
+     * @param string $action
+     * @param array $data
+     *
+     * @return Response
+     * @throws TelegramException
+     */
+    public static function send(string $action, array $data = []): Response
+    {
+        self::$current_action = $action;
+
+        $raw_response = self::execute($action, $data);
+
+        if (!Common::isJson($raw_response)) {
+            TelegramLog::debug($raw_response);
+            throw new TelegramException('Invalid response from API');
+        }
+
+        $response = new Response(json_decode($raw_response, true));
+
+        if (!$response->isOk() && $response->getErrorCode() === 401 && $response->getDescription() === 'Unauthorized') {
+            throw new InvalidBotTokenException();
+        }
+
+        self::$current_action = '';
+
+        return $response;
+    }
+
+    /**
+     * Any statically called method should be relayed to the `send` method.
+     *
+     * @param string $action
+     * @param array $data
+     *
+     * @return Response
+     * @throws TelegramException
+     */
+    public static function __callStatic(string $action, array $data): Response
+    {
+        return static::send($action, reset($data) ?: []);
+    }
 
 }

src/lib/Plugin.php

Indentation +74 added lines, -74 removed lines

@@ -15,88 +15,88 @@
 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',
-	];
+    /**
+     * 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 WebhookHandler
+     */
+    protected WebhookHandler $hook;
 
-	/**
-	 * @var \Generator
-	 */
-	protected \Generator $returns;
+    /**
+     * @var \Generator
+     */
+    protected \Generator $returns;
 
-	/**
-	 * @var bool
-	 */
-	protected bool $kill_on_yield = false;
+    /**
+     * @var bool
+     */
+    protected bool $kill_on_yield = false;
 
-	/**
-	 * Execute the plugin.
-	 *
-	 * @param WebhookHandler $receiver
-	 * @param Update $update
-	 * @return void
-	 */
-	public function __execute(WebhookHandler $receiver, Update $update): void
-	{
-		$this->hook = $receiver;
+    /**
+     * Execute the plugin.
+     *
+     * @param WebhookHandler $receiver
+     * @param Update $update
+     * @return void
+     */
+    public function __execute(WebhookHandler $receiver, Update $update): void
+    {
+        $this->hook = $receiver;
 
-		$method = 'onReceivedUpdate';
-		if (method_exists($this, $method)) {
-			/** @var \Generator $return */
-			$return = $this->{$method}($update);
-		}
+        $method = 'onReceivedUpdate';
+        if (method_exists($this, $method)) {
+            /** @var \Generator $return */
+            $return = $this->{$method}($update);
+        }
 
-		if (isset($return) && $return instanceof \Generator) {
-			while ($return->valid()) {
-				$return->next();
-			}
+        if (isset($return) && $return instanceof \Generator) {
+            while ($return->valid()) {
+                $return->next();
+            }
 
-			if ($return->valid() && $return->getReturn()) {
-				if ($this->kill_on_yield) $this->kill();
-			}
-		}
-	}
+            if ($return->valid() && $return->getReturn()) {
+                if ($this->kill_on_yield) $this->kill();
+            }
+        }
+    }
 
-	/**
-	 * Identify the update type and if method of the type is exists, execute it.
-	 *
-	 * @param Update $update
-	 * @return \Generator
-	 */
-	protected function onReceivedUpdate(Update $update): \Generator
-	{
-		$method = UpdateTypes::identify($update);
-		if (method_exists($this, $method)) {
-			yield $this->$method($update);
-		}
-	}
+    /**
+     * Identify the update type and if method of the type is exists, execute it.
+     *
+     * @param Update $update
+     * @return \Generator
+     */
+    protected function onReceivedUpdate(Update $update): \Generator
+    {
+        $method = UpdateTypes::identify($update);
+        if (method_exists($this, $method)) {
+            yield $this->$method($update);
+        }
+    }
 
-	/**
-	 * Kill the plugin.
-	 *
-	 * @return void
-	 */
-	public function kill(): void
-	{
-		$this->hook->kill();
-	}
+    /**
+     * Kill the plugin.
+     *
+     * @return void
+     */
+    public function kill(): void
+    {
+        $this->hook->kill();
+    }
 
 }
\ No newline at end of file

Braces +3 added lines, -1 removed lines

@@ -70,7 +70,9 @@
 			}
 
 			if ($return->valid() && $return->getReturn()) {
-				if ($this->kill_on_yield) $this->kill();
+				if ($this->kill_on_yield) {
+				    $this->kill();
+				}
 			}
 		}
 	}