Unverified Commit 377173e8 authored by Armando Lüscher's avatar Armando Lüscher

Merge branch 'develop' into psr3-logger

parents a933b64d c8329d63
...@@ -7,3 +7,6 @@ charset = utf-8 ...@@ -7,3 +7,6 @@ charset = utf-8
indent_style = space indent_style = space
indent_size = 4 indent_size = 4
trim_trailing_whitespace = true trim_trailing_whitespace = true
[*.{yml, yaml}]
indent_size = 2
/.* export-ignore
/composer.lock export-ignore
/phpcs.xml.dist export-ignore
/phpunit.xml.dist export-ignore
/tests export-ignore
tidelift: packagist/longman%2Ftelegram-bot
patreon: phptelegrambot
liberapay: PHP-Telegram-Bot
open_collective: php-telegram-bot
ko_fi: phptelegrambot
custom: https://github.com/php-telegram-bot/core#donate
<!-- If this is a feature request or idea, please remove all the text below this line before writing. -->
<!-- If this is a bug report or support request, please fill in the info below as accurately as you can. -->
### Required Information
<!-- Please enter exact version numbers, not just "latest" etc.! -->
- Operating system:
- PHP version:
- PHP Telegram Bot version:
- Using MySQL database: yes / no
- MySQL version:
- Update Method: Webhook / getUpdates
- Self-signed certificate: yes / no
- RAW update (if available):
### Expected behaviour
<!-- What SHOULD be happening? -->
### Actual behaviour
<!-- What IS happening? -->
### Steps to reproduce
<!-- Explain how to reproduce the issue -->
### Extra details
<!-- Please post any extra details that might help solve the issue (e.g. logs) -->
---
name: 💥 BC Break
about: Have you encountered an issue during an upgrade? 💣
---
<!--
Before reporting a BC break, please consult the changelog and wiki entry for the particular version to make sure it's not an expected change:
- https://github.com/php-telegram-bot/core/blob/master/CHANGELOG.md
- https://github.com/php-telegram-bot/core/wiki/Breaking-backwards-compatibility
-->
### BC Break Report
<--
❗ NEVER put your Telegram API key or any other private details here. (like passwords, user IDs, etc.)
Substitute them like <API_KEY> or <USER_ID> etc.
-->
#### Required Information
<!-- Fill in the relevant information below to help triage your pull request. -->
<!-- Please enter exact version numbers, not just "latest" etc.! -->
| ? | !
| --- | ---
| Operating system | Name and version
| PHP Telegram Bot version | x.y.z
| PHP version | x.y.z
| MySQL version | x.y.z / none
| Update Method | Webhook / getUpdates
| Self-signed certificate | yes / no
| RAW update (if available) | `{...}`
#### Summary
<!-- Provide a summary describing the problem you are experiencing. -->
#### Previous behaviour
<!-- What was the previous (working) behaviour? -->
#### Current behaviour
<!-- What is the current (broken) behaviour? -->
#### How to reproduce
<!--
Provide steps to reproduce the bug.
If possible, also add any relevant code snippet.
-->
#### Expected behaviour
<!-- What was the expected (correct) behaviour? -->
---
name: 🐞 Bug Report
about: Something is broken? 🔨
---
### Bug Report
<--
❗ NEVER put your Telegram API key or any other private details here. (like passwords, user IDs, etc.)
Substitute them like <API_KEY> or <USER_ID> etc.
-->
#### Required Information
<!-- Fill in the relevant information below to help triage your pull request. -->
<!-- Please enter exact version numbers, not just "latest" etc.! -->
| ? | !
| --- | ---
| Operating system | Name and version
| PHP Telegram Bot version | x.y.z
| PHP version | x.y.z
| MySQL version | x.y.z / none
| Update Method | Webhook / getUpdates
| Self-signed certificate | yes / no
| RAW update (if available) | `{...}`
#### Summary
<!-- Provide a summary describing the problem you are experiencing. -->
### Current behaviour
<!-- What is the current (buggy) behaviour? -->
#### How to reproduce
<!--
Provide steps to reproduce the bug.
If possible, also add any relevant code snippet.
-->
#### Expected behaviour
<!-- What was the expected (correct) behaviour? -->
---
name: 🎉 Feature Request
about: You have a neat idea that should be implemented? 🎩
---
### Feature Request
#### Summary
<!-- Provide a summary of the feature you would like to see implemented. -->
---
name: ❓ Support Question
about: Have a problem that you can't figure out? 🤔
---
### Support Question
<!--
Before asking a question here, please try asking in the support group first.
https://telegram.me/PHP_Telegram_Bot_Support
Keep in mind that GitHub is primarily an issue tracker.
-->
<--
❗ NEVER put your Telegram API key or any other private details here. (like passwords, user IDs, etc.)
Substitute them like <API_KEY> or <USER_ID> etc.
-->
#### Required Information
<!-- Fill in the relevant information below to help triage your pull request. -->
<!-- Please enter exact version numbers, not just "latest" etc.! -->
| ? | !
| --- | ---
| Operating system | Name and version
| PHP Telegram Bot version | x.y.z
| PHP version | x.y.z
| MySQL version | x.y.z / none
| Update Method | Webhook / getUpdates
| Self-signed certificate | yes / no
| RAW update (if available) | `{...}`
#### Summary
<!-- Describe the issue you are facing here. -->
<!-- Important: If this pull request is not related to any issue and contains a new feature, please create an issue first for discussion. --> <!--
Important:
If this pull request is not related to any issue and contains a new feature, please create an issue first for discussion.
https://github.com/php-telegram-bot/core/issues/new?template=Feature_Request.md
<!-- Make sure this pull request is pointed towards the "develop" branch and refers to any issue that it's related to! --> Make sure this pull request is pointed towards the "develop" branch and refers to any issue that it's related to!
-->
<!-- Explain in detail what this pull request contains. --> <!-- Fill in the relevant information below to help triage your pull request. -->
| ? | !
|--- | ---
| Type | bug / feature / improvement
| BC Break | yes / no
| Fixed issues | <!-- use #NUM format to reference an issue -->
#### Summary
<!-- Provide a summary of your change. -->
...@@ -5,28 +5,20 @@ ...@@ -5,28 +5,20 @@
.DS_Store .DS_Store
.idea .idea
.phpintel .phpintel
composer.phar
# Local System Files (i.e. cache, logs, etc.) #
/cache
/build/logs
/build/coverage
/tmp
# Test Related Files #
/phpunit.xml
#Exception output
TelegramException.log
# Composer # Composer
vendor/ /composer.phar
/vendor
# Test-Related Files
/clover.xml
/phpcs.xml
/phpunit.xml
# phpDocumentor Logs # # phpDocumentor Logs
phpdoc-* phpdoc-*
# OSX # # OSX
._* ._*
.Spotlight-V100 .Spotlight-V100
.Trashes .Trashes
build:
nodes:
analysis:
tests:
override:
- php-scrutinizer-run
filter: filter:
paths: [src/*] paths:
- src/
dependency_paths:
- lib/
checks: checks:
php: php:
remove_extra_empty_lines: true check_method_contracts:
remove_php_closing_tag: true verify_interface_like_constraints: true
remove_trailing_whitespace: true verify_documented_constraints: true
fix_use_statements: verify_parent_constraints: true
remove_unused: true fix_doc_comments: true
preserve_multiple: false fix_identation_4spaces: true
preserve_blanklines: true fix_line_ending: true
order_alphabetically: true fix_linefeed: true
fix_php_opening_tag: true fix_php_opening_tag: true
fix_linefeed: true fix_use_statements:
fix_line_ending: true remove_unused: true
fix_identation_4spaces: true preserve_multiple: false
fix_doc_comments: true preserve_blanklines: true
order_alphabetically: true
more_specific_types_in_doc_comments: true
no_goto: true
param_doc_comment_if_not_inferrable: true
parameter_doc_comments: true
remove_extra_empty_lines: true
return_doc_comment_if_not_inferrable: true
return_doc_comments: true
simplify_boolean_return: true
tools: tools:
external_code_coverage: external_code_coverage:
timeout: 120 timeout: 300
dist: trusty
sudo: required
language: php language: php
sudo: required
dist: trusty
addons: addons:
mariadb: 10.1 mariadb: 10.1
cache: cache:
directories: directories:
- "$HOME/.composer/cache" - vendor
- $HOME/.composer/cache
php: php:
- 5.5
- 5.6
- 7.0
- 7.1
- 7.2
- 7.3 - 7.3
- 7.2
- 7.1
- 7.0
- 5.6
- 5.5
- nightly - nightly
- hhvm - hhvm
...@@ -44,7 +45,7 @@ before_script: ...@@ -44,7 +45,7 @@ before_script:
script: script:
- composer check-code - composer check-code
- if [ "$TRAVIS_PHP_VERSION" == "7.2" ] ; then composer test-cov; else composer test; fi - if [ "$TRAVIS_PHP_VERSION" == "7.3" ]; then composer test-cov; else composer test; fi
after_script: after_script:
- if [ "$TRAVIS_PHP_VERSION" == "7.2" ]; then composer test-cov-upload; fi - if [ "$TRAVIS_PHP_VERSION" == "7.3" ]; then composer test-cov-upload; fi
...@@ -5,13 +5,22 @@ Exclamation symbols (:exclamation:) note something of importance e.g. breaking c ...@@ -5,13 +5,22 @@ Exclamation symbols (:exclamation:) note something of importance e.g. breaking c
## [Unreleased] ## [Unreleased]
### Added ### Added
- New funding and support details.
- Custom issue templates. (#972)
### Changed ### Changed
- Use PSR-12 for code style.
- Some general housekeeping. (#972)
- [:exclamation:][unreleased-bc] Return an empty array for Entity properties with no items, instead of `null`. (#969)
- `TelegramLog` now adheres to [PSR-3] `LoggerInterface` and allows custom logger implementations. - `TelegramLog` now adheres to [PSR-3] `LoggerInterface` and allows custom logger implementations.
### Deprecated ### Deprecated
- Old logging that uses Monolog still works but will be removed in the near future. Use `TelegramLog::initialize($logger, $update_logger);` from now on. - Old logging that uses Monolog still works but will be removed in the near future. Use `TelegramLog::initialize($logger, $update_logger);` from now on.
### Removed ### Removed
- Botan.io integration completely removed.
### Fixed ### Fixed
- `forward_date` is now correctly saved to the DB.
- Broken `StickerSet::getStickers()` method.
### Security ### Security
- Security disclosure managed by Tidelift.
## [0.57.0] - 2019-06-01 ## [0.57.0] - 2019-06-01
:exclamation: After updating to this version, you will need to execute the [SQL migration script][0.57.0-sql-migration] on your database. :exclamation: After updating to this version, you will need to execute the [SQL migration script][0.57.0-sql-migration] on your database.
...@@ -264,6 +273,7 @@ Exclamation symbols (:exclamation:) note something of importance e.g. breaking c ...@@ -264,6 +273,7 @@ Exclamation symbols (:exclamation:) note something of importance e.g. breaking c
- Move `hideKeyboard` to `removeKeyboard`. - Move `hideKeyboard` to `removeKeyboard`.
[unreleased-sql-migration]: https://github.com/php-telegram-bot/core/tree/develop/utils/db-schema-update/unreleased.sql [unreleased-sql-migration]: https://github.com/php-telegram-bot/core/tree/develop/utils/db-schema-update/unreleased.sql
[unreleased-bc]: https://github.com/php-telegram-bot/core/wiki/Breaking-backwards-compatibility#unreleased
[0.57.0-sql-migration]: https://github.com/php-telegram-bot/core/tree/master/utils/db-schema-update/0.56.0-0.57.0.sql [0.57.0-sql-migration]: https://github.com/php-telegram-bot/core/tree/master/utils/db-schema-update/0.56.0-0.57.0.sql
[0.55.0-sql-migration]: https://github.com/php-telegram-bot/core/tree/master/utils/db-schema-update/0.54.1-0.55.0.sql [0.55.0-sql-migration]: https://github.com/php-telegram-bot/core/tree/master/utils/db-schema-update/0.54.1-0.55.0.sql
[0.55.0-bc-move-animation-out-of-games-namespace]: https://github.com/php-telegram-bot/core/wiki/Breaking-backwards-compatibility#move-animation-out-of-games-namespace [0.55.0-bc-move-animation-out-of-games-namespace]: https://github.com/php-telegram-bot/core/wiki/Breaking-backwards-compatibility#move-animation-out-of-games-namespace
......
Contributing # Contributing
-------------
The easiest way to contribute is to work on a checkout of your own fork. The easiest way to contribute is to work on a checkout of your own fork.
When working on the `core` repository, it makes sense to rename your fork to `php-telegram-bot`. When working on the `core` repository, it makes sense to rename your fork to `php-telegram-bot`.
Before you contribute code, please make sure it conforms to the PSR-2 coding standard and that the unit tests still pass. Before you contribute code, please make sure it conforms to the PSR-12 coding standard and that the unit tests still pass.
You can run the following commands to check if everything is ready to submit: You can run the following commands to check if everything is ready to submit:
cd php-telegram-bot ```bash
composer install cd php-telegram-bot
composer check-code composer install
composer check-code
```
Which should give you no output, indicating that there are no coding standard errors. Which should give you no output, indicating that there are no coding standard errors.
And then (remember to set up your test database!): And then (remember to set up your test database!):
composer test ```bash
composer test
```
Which should give you no failures or errors. You can ignore any skipped tests as these are for external tools. Which should give you no failures or errors. You can ignore any skipped tests as these are for external tools.
Pushing ## Pushing
-------
Development is based on the git flow branching model (see http://nvie.com/posts/a-successful-git-branching-model/) Development is based on the git flow branching model (see http://nvie.com/posts/a-successful-git-branching-model/)
If you fix a bug please push in hotfix branch. If you fix a bug please push in hotfix branch.
If you develop a new feature please create a new branch. If you develop a new feature please create a new branch.
Version ## Version
-------
Version number: 0.#version.#hotfix Version number: 0.#version.#hotfix
Further code convention adopted ## Further code convention adopted
-------------------------------
- Each method and class is documented with a docblock - Each method and class is documented with a docblock
......
This diff is collapsed.
# Security
To report a security vulnerability, please use the [Tidelift security contact](https://tidelift.com/security).
Tidelift will then coordinate the fix and disclosure.
...@@ -48,16 +48,16 @@ ...@@ -48,16 +48,16 @@
}, },
"scripts": { "scripts": {
"check-code": [ "check-code": [
"\"vendor/bin/phpcs\" --standard=phpcs.xml -snp --encoding=utf-8 src/ tests/ --report-width=150" "\"vendor/bin/phpcs\" -snp src/ tests/"
], ],
"test": [ "test": [
"\"vendor/bin/phpunit\"" "\"vendor/bin/phpunit\""
], ],
"test-cov": [ "test-cov": [
"\"vendor/bin/phpunit\" --coverage-clover build/logs/clover.xml" "\"vendor/bin/phpunit\" --coverage-clover clover.xml"
], ],
"test-cov-upload": [ "test-cov-upload": [
"wget https://scrutinizer-ci.com/ocular.phar && php ocular.phar code-coverage:upload --format=php-clover build/logs/clover.xml" "wget https://scrutinizer-ci.com/ocular.phar && php ocular.phar code-coverage:upload --format=php-clover clover.xml"
] ]
} }
} }
...@@ -3,8 +3,11 @@ ...@@ -3,8 +3,11 @@
<description>PHP Code Sniffer</description> <description>PHP Code Sniffer</description>
<arg name="colors"/> <arg name="colors"/>
<arg name="parallel" value="8"/>
<arg name="encoding" value="utf-8"/>
<arg name="report-width" value="150"/>
<rule ref="PSR2"/> <rule ref="PSR12"/>
<rule ref="Generic.CodeAnalysis.EmptyStatement"/> <rule ref="Generic.CodeAnalysis.EmptyStatement"/>
<rule ref="Generic.CodeAnalysis.UselessOverridingMethod"/> <rule ref="Generic.CodeAnalysis.UselessOverridingMethod"/>
......
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<phpunit <phpunit
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="http://schema.phpunit.de/4.8/phpunit.xsd" xsi:noNamespaceSchemaLocation="http://schema.phpunit.de/4.8/phpunit.xsd"
bootstrap="./tests/bootstrap.php" bootstrap="./tests/bootstrap.php"
backupGlobals="false" backupGlobals="false"
backupStaticAttributes="false" backupStaticAttributes="false"
colors="true" colors="true"
convertErrorsToExceptions="true" convertErrorsToExceptions="true"
convertNoticesToExceptions="true" convertNoticesToExceptions="true"
convertWarningsToExceptions="true" convertWarningsToExceptions="true"
processIsolation="false" processIsolation="false"
stopOnError="false" stopOnError="false"
stopOnFailure="false" stopOnFailure="false"
stopOnIncomplete="false" stopOnIncomplete="false"
stopOnSkipped="false" stopOnSkipped="false"
syntaxCheck="true" syntaxCheck="true"
timeoutForLargeTests="60" timeoutForLargeTests="60"
timeoutForMediumTests="10" timeoutForMediumTests="10"
timeoutForSmallTests="1" timeoutForSmallTests="1"
verbose="false" verbose="false"
> >
<php> <php>
<ini name="error_reporting" value="-1" /> <ini name="error_reporting" value="-1"/>
<const name="PHPUNIT_TESTSUITE" value="true"/> <const name="PHPUNIT_TESTSUITE" value="true"/>
<const name="PHPUNIT_DB_HOST" value="127.0.0.1"/> <const name="PHPUNIT_DB_HOST" value="127.0.0.1"/>
<const name="PHPUNIT_DB_NAME" value="telegrambot"/> <const name="PHPUNIT_DB_NAME" value="telegrambot"/>
......
<?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 GuzzleHttp\Client;
use GuzzleHttp\Exception\RequestException;
use Longman\TelegramBot\Entities\Update;
use Longman\TelegramBot\Exception\TelegramException;
/**
* Class Botan
*
* @deprecated Botan.io service is no longer working
*
* Integration with http://botan.io statistics service for Telegram bots
*/
class Botan
{
/**
* Botan.io API URL
*
* @var string
*/
protected static $api_base_uri = 'https://api.botan.io';
/**
* Yandex AppMetrica application key
*
* @var string
*/
protected static $token = '';
/**
* Guzzle Client object
*
* @var \GuzzleHttp\Client
*/
private static $client;
/**
* The actual command that is going to be reported
*
* Set as public to let the developers either:
* - block tracking from inside commands by setting the value to non-existent command
* - override which command is tracked when commands call other commands with executeCommand()
*
* @var string
*/
public static $command = '';
/**
* Initialize Botan
*
* @param string $token
* @param array $options
*
* @throws \Longman\TelegramBot\Exception\TelegramException
*/
public static function initializeBotan($token, array $options = [])
{
trigger_error('Longman\TelegramBot\Botan::initializeBotan is deprecated and will be removed in future release.', E_USER_DEPRECATED);
if (empty($token)) {
throw new TelegramException('Botan token is empty!');
}
$options_default = [
'timeout' => 3,
];
$options = array_merge($options_default, $options);
if (!is_numeric($options['timeout'])) {
throw new TelegramException('Timeout must be a number!');
}
self::$token = $token;
self::$client = new Client(['base_uri' => self::$api_base_uri, 'timeout' => $options['timeout']]);
BotanDB::initializeBotanDb();
}
/**
* Lock function to make sure only the first command is reported (the one user requested)
*
* This is in case commands are calling other commands with executeCommand()
*
* @param string $command
*/
public static function lock($command = '')
{
if (empty(self::$command)) {
self::$command = strtolower($command);
}
}
/**
* Track function
*
* @param \Longman\TelegramBot\Entities\Update $update
* @param string $command
*
* @return bool|string
* @throws \Longman\TelegramBot\Exception\TelegramException
*/
public static function track(Update $update, $command = '')
{
$command = strtolower($command);
if (empty(self::$token) || $command !== self::$command) {
return false;
}
if ($update === null) {
throw new TelegramException('Update object is empty!');
}
// Release the lock in case this is getUpdates instance in foreach loop
self::$command = '';
$data = [];
$update_data = (array) $update; // For now, this is the only way
$update_type = $update->getUpdateType();
$update_object_names = [
'message' => 'Message',
'edited_message' => 'Edited Message',
'channel_post' => 'Channel Post',
'edited_channel_post' => 'Edited Channel Post',
'inline_query' => 'Inline Query',
'chosen_inline_result' => 'Chosen Inline Result',
'callback_query' => 'Callback Query',
];
if (array_key_exists($update_type, $update_object_names)) {
$data = $update_data[$update_type];
$event_name = $update_object_names[$update_type];
if ($update_type === 'message' && $entities = $update->getMessage()->getEntities()) {
foreach ($entities as $entity) {
if ($entity->getType() === 'bot_command' && $entity->getOffset() === 0) {
if ($command === 'generic') {
$command = 'Generic';
} elseif ($command === 'genericmessage') { // This should not happen as it equals normal message but leaving it as a fail-safe
$command = 'Generic Message';
} else {
$command = '/' . $command;
}
$event_name = 'Command (' . $command . ')';
break;
}
}
}
}
if (empty($event_name)) {
TelegramLog::error('Botan.io stats report failed, no suitable update object found!');
return false;
}
// In case there is no from field assign id = 0
$uid = isset($data['from']['id']) ? $data['from']['id'] : 0;
try {
$response = self::$client->post(
sprintf(
'/track?token=%1$s&uid=%2$s&name=%3$s',
self::$token,
$uid,
urlencode($event_name)
),
[
'headers' => [
'Content-Type' => 'application/json',
],
'json' => $data,
]
);
$result = (string) $response->getBody();
} catch (RequestException $e) {
$result = $e->getMessage();
}
$responseData = json_decode($result, true);
if (!$responseData || $responseData['status'] !== 'accepted') {
TelegramLog::debug('Botan.io stats report failed: %s', $result ?: 'empty response');
return false;
}
return $responseData;
}
/**
* Url Shortener function
*
* @param string $url
* @param integer $user_id
*
* @return string
* @throws \Longman\TelegramBot\Exception\TelegramException
*/
public static function shortenUrl($url, $user_id)
{
if (empty(self::$token)) {
return $url;
}
if (empty($user_id)) {
throw new TelegramException('User id is empty!');
}
if ($cached = BotanDB::selectShortUrl($url, $user_id)) {
return $cached;
}
try {
$response = self::$client->post(
sprintf(
'/s?token=%1$s&user_ids=%2$s&url=%3$s',
self::$token,
$user_id,
urlencode($url)
)
);
$result = (string) $response->getBody();
} catch (RequestException $e) {
$result = $e->getMessage();
}
if (filter_var($result, FILTER_VALIDATE_URL) === false) {
TelegramLog::debug('Botan.io URL shortening failed for "%s": %s', $url, $result ?: 'empty response');
return $url;
}
BotanDB::insertShortUrl($url, $user_id, $result);
return $result;
}
}
<?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 Exception;
use Longman\TelegramBot\Exception\TelegramException;
/**
* Class BotanDB
*
* @deprecated Botan.io service is no longer working
*/
class BotanDB extends DB
{
/**
* Initialize botan shortener table
*/
public static function initializeBotanDb()
{
if (!defined('TB_BOTAN_SHORTENER')) {
define('TB_BOTAN_SHORTENER', self::$table_prefix . 'botan_shortener');
}
}
/**
* Select cached shortened URL from the database
*
* @param string $url
* @param string $user_id
*
* @return array|bool
* @throws TelegramException
*/
public static function selectShortUrl($url, $user_id)
{
if (!self::isDbConnected()) {
return false;
}
try {
$sth = self::$pdo->prepare('
SELECT `short_url`
FROM `' . TB_BOTAN_SHORTENER . '`
WHERE `user_id` = :user_id
AND `url` = :url
ORDER BY `created_at` DESC
LIMIT 1
');
$sth->bindValue(':user_id', $user_id);
$sth->bindValue(':url', $url);
$sth->execute();
return $sth->fetchColumn();
} catch (Exception $e) {
throw new TelegramException($e->getMessage());
}
}
/**
* Insert shortened URL into the database
*
* @param string $url
* @param string $user_id
* @param string $short_url
*
* @return bool
* @throws TelegramException
*/
public static function insertShortUrl($url, $user_id, $short_url)
{
if (!self::isDbConnected()) {
return false;
}
try {
$sth = self::$pdo->prepare('
INSERT INTO `' . TB_BOTAN_SHORTENER . '`
(`user_id`, `url`, `short_url`, `created_at`)
VALUES
(:user_id, :url, :short_url, :created_at)
');
$sth->bindValue(':user_id', $user_id);
$sth->bindValue(':url', $url);
$sth->bindValue(':short_url', $short_url);
$sth->bindValue(':created_at', self::getTimestamp());
return $sth->execute();
} catch (Exception $e) {
throw new TelegramException($e->getMessage());
}
}
}
...@@ -13,6 +13,8 @@ namespace Longman\TelegramBot\Commands\AdminCommands; ...@@ -13,6 +13,8 @@ namespace Longman\TelegramBot\Commands\AdminCommands;
use Longman\TelegramBot\Commands\AdminCommand; use Longman\TelegramBot\Commands\AdminCommand;
use Longman\TelegramBot\DB; use Longman\TelegramBot\DB;
use Longman\TelegramBot\Entities\Chat; use Longman\TelegramBot\Entities\Chat;
use Longman\TelegramBot\Entities\ServerResponse;
use Longman\TelegramBot\Exception\TelegramException;
use Longman\TelegramBot\Request; use Longman\TelegramBot\Request;
class ChatsCommand extends AdminCommand class ChatsCommand extends AdminCommand
...@@ -45,8 +47,8 @@ class ChatsCommand extends AdminCommand ...@@ -45,8 +47,8 @@ class ChatsCommand extends AdminCommand
/** /**
* Command execute method * Command execute method
* *
* @return \Longman\TelegramBot\Entities\ServerResponse * @return ServerResponse
* @throws \Longman\TelegramBot\Exception\TelegramException * @throws TelegramException
*/ */
public function execute() public function execute()
{ {
......
...@@ -12,6 +12,7 @@ namespace Longman\TelegramBot\Commands\AdminCommands; ...@@ -12,6 +12,7 @@ namespace Longman\TelegramBot\Commands\AdminCommands;
use Longman\TelegramBot\Commands\AdminCommand; use Longman\TelegramBot\Commands\AdminCommand;
use Longman\TelegramBot\DB; use Longman\TelegramBot\DB;
use Longman\TelegramBot\Entities\ServerResponse;
use Longman\TelegramBot\Exception\TelegramException; use Longman\TelegramBot\Exception\TelegramException;
use Longman\TelegramBot\Request; use Longman\TelegramBot\Request;
use Longman\TelegramBot\TelegramLog; use Longman\TelegramBot\TelegramLog;
...@@ -68,7 +69,6 @@ class CleanupCommand extends AdminCommand ...@@ -68,7 +69,6 @@ class CleanupCommand extends AdminCommand
* @var array * @var array
*/ */
protected static $default_tables_to_clean = [ protected static $default_tables_to_clean = [
'botan_shortener',
'callback_query', 'callback_query',
'chosen_inline_result', 'chosen_inline_result',
'conversation', 'conversation',
...@@ -85,7 +85,6 @@ class CleanupCommand extends AdminCommand ...@@ -85,7 +85,6 @@ class CleanupCommand extends AdminCommand
* @var array * @var array
*/ */
protected static $default_clean_older_than = [ protected static $default_clean_older_than = [
'botan_shortener' => '30 days',
'chat' => '365 days', 'chat' => '365 days',
'callback_query' => '30 days', 'callback_query' => '30 days',
'chosen_inline_result' => '30 days', 'chosen_inline_result' => '30 days',
...@@ -242,11 +241,6 @@ class CleanupCommand extends AdminCommand ...@@ -242,11 +241,6 @@ class CleanupCommand extends AdminCommand
'request_limiter' => ['table' => TB_REQUEST_LIMITER, 'field' => 'created_at'], 'request_limiter' => ['table' => TB_REQUEST_LIMITER, 'field' => 'created_at'],
]; ];
// Botan table is only available if enabled.
if (defined('TB_BOTAN_SHORTENER')) {
$simple_tables['botan_shortener'] = ['table' => TB_BOTAN_SHORTENER, 'field' => 'created_at'];
}
foreach (array_intersect(array_keys($simple_tables), $tables_to_clean) as $table_to_clean) { foreach (array_intersect(array_keys($simple_tables), $tables_to_clean) as $table_to_clean) {
$queries[] = sprintf( $queries[] = sprintf(
'DELETE FROM `%1$s` 'DELETE FROM `%1$s`
...@@ -345,7 +339,8 @@ class CleanupCommand extends AdminCommand ...@@ -345,7 +339,8 @@ class CleanupCommand extends AdminCommand
/** /**
* Execution if MySQL is required but not available * Execution if MySQL is required but not available
* *
* @return \Longman\TelegramBot\Entities\ServerResponse * @return ServerResponse
* @throws TelegramException
*/ */
public function executeNoDb() public function executeNoDb()
{ {
...@@ -364,8 +359,8 @@ class CleanupCommand extends AdminCommand ...@@ -364,8 +359,8 @@ class CleanupCommand extends AdminCommand
/** /**
* Command execute method * Command execute method
* *
* @return \Longman\TelegramBot\Entities\ServerResponse * @return ServerResponse
* @throws \Longman\TelegramBot\Exception\TelegramException * @throws TelegramException
*/ */
public function execute() public function execute()
{ {
......
...@@ -12,6 +12,7 @@ namespace Longman\TelegramBot\Commands\AdminCommands; ...@@ -12,6 +12,7 @@ namespace Longman\TelegramBot\Commands\AdminCommands;
use Longman\TelegramBot\Commands\AdminCommand; use Longman\TelegramBot\Commands\AdminCommand;
use Longman\TelegramBot\DB; use Longman\TelegramBot\DB;
use Longman\TelegramBot\Exception\TelegramException;
use Longman\TelegramBot\Request; use Longman\TelegramBot\Request;
/** /**
...@@ -43,14 +44,14 @@ class DebugCommand extends AdminCommand ...@@ -43,14 +44,14 @@ class DebugCommand extends AdminCommand
* Command execute method * Command execute method
* *
* @return mixed * @return mixed
* @throws \Longman\TelegramBot\Exception\TelegramException * @throws TelegramException
*/ */
public function execute() public function execute()
{ {
$pdo = DB::getPdo(); $pdo = DB::getPdo();
$message = $this->getMessage(); $message = $this->getMessage();
$chat = $message->getChat(); $chat = $message->getChat();
$text = strtolower($message->getText(true)); $text = strtolower($message->getText(true));
$data = ['chat_id' => $chat->getId()]; $data = ['chat_id' => $chat->getId()];
...@@ -80,7 +81,7 @@ class DebugCommand extends AdminCommand ...@@ -80,7 +81,7 @@ class DebugCommand extends AdminCommand
$debug_info[] = sprintf('*Maximum PHP script execution time:* `%d seconds`', ini_get('max_execution_time')); $debug_info[] = sprintf('*Maximum PHP script execution time:* `%d seconds`', ini_get('max_execution_time'));
$mysql_version = $pdo ? $pdo->query('SELECT VERSION() AS version')->fetchColumn() : null; $mysql_version = $pdo ? $pdo->query('SELECT VERSION() AS version')->fetchColumn() : null;
$debug_info[] = sprintf('*MySQL version:* `%s`', $mysql_version ?: 'disabled'); $debug_info[] = sprintf('*MySQL version:* `%s`', $mysql_version ?: 'disabled');
$debug_info[] = sprintf('*Operating System:* `%s`', php_uname()); $debug_info[] = sprintf('*Operating System:* `%s`', php_uname());
...@@ -88,7 +89,7 @@ class DebugCommand extends AdminCommand ...@@ -88,7 +89,7 @@ class DebugCommand extends AdminCommand
$debug_info[] = sprintf('*Web Server:* `%s`', $_SERVER['SERVER_SOFTWARE']); $debug_info[] = sprintf('*Web Server:* `%s`', $_SERVER['SERVER_SOFTWARE']);
} }
if (function_exists('curl_init')) { if (function_exists('curl_init')) {
$curlversion = curl_version(); $curlversion = curl_version();
$debug_info[] = sprintf('*curl version:* `%1$s; %2$s`', $curlversion['version'], $curlversion['ssl_version']); $debug_info[] = sprintf('*curl version:* `%1$s; %2$s`', $curlversion['version'], $curlversion['ssl_version']);
} }
...@@ -105,8 +106,8 @@ class DebugCommand extends AdminCommand ...@@ -105,8 +106,8 @@ class DebugCommand extends AdminCommand
} }
$webhook_info_result_str = json_encode($webhook_info_result, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES); $webhook_info_result_str = json_encode($webhook_info_result, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES);
$debug_info[] = $webhook_info_title; $debug_info[] = $webhook_info_title;
$debug_info[] = sprintf( $debug_info[] = sprintf(
'```' . PHP_EOL . '%s```', '```' . PHP_EOL . '%s```',
$webhook_info_result_str $webhook_info_result_str
); );
...@@ -116,7 +117,7 @@ class DebugCommand extends AdminCommand ...@@ -116,7 +117,7 @@ class DebugCommand extends AdminCommand
} }
$data['parse_mode'] = 'Markdown'; $data['parse_mode'] = 'Markdown';
$data['text'] = implode(PHP_EOL, $debug_info); $data['text'] = implode(PHP_EOL, $debug_info);
return Request::sendMessage($data); return Request::sendMessage($data);
} }
......
...@@ -13,6 +13,7 @@ namespace Longman\TelegramBot\Commands\AdminCommands; ...@@ -13,6 +13,7 @@ namespace Longman\TelegramBot\Commands\AdminCommands;
use Longman\TelegramBot\Commands\AdminCommand; use Longman\TelegramBot\Commands\AdminCommand;
use Longman\TelegramBot\Entities\Message; use Longman\TelegramBot\Entities\Message;
use Longman\TelegramBot\Entities\ServerResponse; use Longman\TelegramBot\Entities\ServerResponse;
use Longman\TelegramBot\Exception\TelegramException;
use Longman\TelegramBot\Request; use Longman\TelegramBot\Request;
/** /**
...@@ -48,8 +49,8 @@ class SendtoallCommand extends AdminCommand ...@@ -48,8 +49,8 @@ class SendtoallCommand extends AdminCommand
/** /**
* Execute command * Execute command
* *
* @return \Longman\TelegramBot\Entities\ServerResponse * @return ServerResponse
* @throws \Longman\TelegramBot\Exception\TelegramException * @throws TelegramException
*/ */
public function execute() public function execute()
{ {
......
...@@ -15,6 +15,8 @@ use Longman\TelegramBot\Conversation; ...@@ -15,6 +15,8 @@ use Longman\TelegramBot\Conversation;
use Longman\TelegramBot\Entities\Chat; use Longman\TelegramBot\Entities\Chat;
use Longman\TelegramBot\Entities\Keyboard; use Longman\TelegramBot\Entities\Keyboard;
use Longman\TelegramBot\Entities\Message; use Longman\TelegramBot\Entities\Message;
use Longman\TelegramBot\Entities\ServerResponse;
use Longman\TelegramBot\Exception\TelegramException;
use Longman\TelegramBot\Request; use Longman\TelegramBot\Request;
class SendtochannelCommand extends AdminCommand class SendtochannelCommand extends AdminCommand
...@@ -47,15 +49,15 @@ class SendtochannelCommand extends AdminCommand ...@@ -47,15 +49,15 @@ class SendtochannelCommand extends AdminCommand
/** /**
* Conversation Object * Conversation Object
* *
* @var \Longman\TelegramBot\Conversation * @var Conversation
*/ */
protected $conversation; protected $conversation;
/** /**
* Command execute method * Command execute method
* *
* @return \Longman\TelegramBot\Entities\ServerResponse|mixed * @return ServerResponse|mixed
* @throws \Longman\TelegramBot\Exception\TelegramException * @throws TelegramException
*/ */
public function execute() public function execute()
{ {
...@@ -272,11 +274,11 @@ class SendtochannelCommand extends AdminCommand ...@@ -272,11 +274,11 @@ class SendtochannelCommand extends AdminCommand
* @todo This method will be moved to a higher level maybe in AdminCommand or Command * @todo This method will be moved to a higher level maybe in AdminCommand or Command
* @todo Looking for a more significant name * @todo Looking for a more significant name
* *
* @param \Longman\TelegramBot\Entities\Message $message * @param Message $message
* @param array $data * @param array $data
* *
* @return \Longman\TelegramBot\Entities\ServerResponse * @return ServerResponse
* @throws \Longman\TelegramBot\Exception\TelegramException * @throws TelegramException
*/ */
protected function sendBack(Message $message, array $data) protected function sendBack(Message $message, array $data)
{ {
...@@ -311,12 +313,12 @@ class SendtochannelCommand extends AdminCommand ...@@ -311,12 +313,12 @@ class SendtochannelCommand extends AdminCommand
/** /**
* Publish a message to a channel and return success or failure message in markdown format * Publish a message to a channel and return success or failure message in markdown format
* *
* @param \Longman\TelegramBot\Entities\Message $message * @param Message $message
* @param string|int $channel_id * @param string|int $channel_id
* @param string|null $caption * @param string|null $caption
* *
* @return string * @return string
* @throws \Longman\TelegramBot\Exception\TelegramException * @throws TelegramException
*/ */
protected function publish(Message $message, $channel_id, $caption = null) protected function publish(Message $message, $channel_id, $caption = null)
{ {
...@@ -351,7 +353,7 @@ class SendtochannelCommand extends AdminCommand ...@@ -351,7 +353,7 @@ class SendtochannelCommand extends AdminCommand
* @todo Why send just to the first found channel? * @todo Why send just to the first found channel?
* *
* @return mixed * @return mixed
* @throws \Longman\TelegramBot\Exception\TelegramException * @throws TelegramException
*/ */
public function executeNoDb() public function executeNoDb()
{ {
......
...@@ -16,7 +16,9 @@ use Longman\TelegramBot\Commands\AdminCommand; ...@@ -16,7 +16,9 @@ use Longman\TelegramBot\Commands\AdminCommand;
use Longman\TelegramBot\DB; use Longman\TelegramBot\DB;
use Longman\TelegramBot\Entities\Chat; use Longman\TelegramBot\Entities\Chat;
use Longman\TelegramBot\Entities\PhotoSize; use Longman\TelegramBot\Entities\PhotoSize;
use Longman\TelegramBot\Entities\ServerResponse;
use Longman\TelegramBot\Entities\UserProfilePhotos; use Longman\TelegramBot\Entities\UserProfilePhotos;
use Longman\TelegramBot\Exception\TelegramException;
use Longman\TelegramBot\Request; use Longman\TelegramBot\Request;
/** /**
...@@ -52,8 +54,8 @@ class WhoisCommand extends AdminCommand ...@@ -52,8 +54,8 @@ class WhoisCommand extends AdminCommand
/** /**
* Command execute method * Command execute method
* *
* @return \Longman\TelegramBot\Entities\ServerResponse * @return ServerResponse
* @throws \Longman\TelegramBot\Exception\TelegramException * @throws TelegramException
*/ */
public function execute() public function execute()
{ {
......
...@@ -18,7 +18,9 @@ use Longman\TelegramBot\Entities\Message; ...@@ -18,7 +18,9 @@ use Longman\TelegramBot\Entities\Message;
use Longman\TelegramBot\Entities\Payments\PreCheckoutQuery; use Longman\TelegramBot\Entities\Payments\PreCheckoutQuery;
use Longman\TelegramBot\Entities\Payments\ShippingQuery; use Longman\TelegramBot\Entities\Payments\ShippingQuery;
use Longman\TelegramBot\Entities\Poll; use Longman\TelegramBot\Entities\Poll;
use Longman\TelegramBot\Entities\ServerResponse;
use Longman\TelegramBot\Entities\Update; use Longman\TelegramBot\Entities\Update;
use Longman\TelegramBot\Exception\TelegramException;
use Longman\TelegramBot\Request; use Longman\TelegramBot\Request;
use Longman\TelegramBot\Telegram; use Longman\TelegramBot\Telegram;
...@@ -43,14 +45,14 @@ abstract class Command ...@@ -43,14 +45,14 @@ abstract class Command
/** /**
* Telegram object * Telegram object
* *
* @var \Longman\TelegramBot\Telegram * @var Telegram
*/ */
protected $telegram; protected $telegram;
/** /**
* Update object * Update object
* *
* @var \Longman\TelegramBot\Entities\Update * @var Update
*/ */
protected $update; protected $update;
...@@ -120,8 +122,8 @@ abstract class Command ...@@ -120,8 +122,8 @@ abstract class Command
/** /**
* Constructor * Constructor
* *
* @param \Longman\TelegramBot\Telegram $telegram * @param Telegram $telegram
* @param \Longman\TelegramBot\Entities\Update $update * @param Update $update
*/ */
public function __construct(Telegram $telegram, Update $update = null) public function __construct(Telegram $telegram, Update $update = null)
{ {
...@@ -133,9 +135,9 @@ abstract class Command ...@@ -133,9 +135,9 @@ abstract class Command
/** /**
* Set update object * Set update object
* *
* @param \Longman\TelegramBot\Entities\Update $update * @param Update $update
* *
* @return \Longman\TelegramBot\Commands\Command * @return Command
*/ */
public function setUpdate(Update $update = null) public function setUpdate(Update $update = null)
{ {
...@@ -149,8 +151,8 @@ abstract class Command ...@@ -149,8 +151,8 @@ abstract class Command
/** /**
* Pre-execute command * Pre-execute command
* *
* @return \Longman\TelegramBot\Entities\ServerResponse * @return ServerResponse
* @throws \Longman\TelegramBot\Exception\TelegramException * @throws TelegramException
*/ */
public function preExecute() public function preExecute()
{ {
...@@ -182,16 +184,16 @@ abstract class Command ...@@ -182,16 +184,16 @@ abstract class Command
/** /**
* Execute command * Execute command
* *
* @return \Longman\TelegramBot\Entities\ServerResponse * @return ServerResponse
* @throws \Longman\TelegramBot\Exception\TelegramException * @throws TelegramException
*/ */
abstract public function execute(); abstract public function execute();
/** /**
* Execution if MySQL is required but not available * Execution if MySQL is required but not available
* *
* @return \Longman\TelegramBot\Entities\ServerResponse * @return ServerResponse
* @throws \Longman\TelegramBot\Exception\TelegramException * @throws TelegramException
*/ */
public function executeNoDb() public function executeNoDb()
{ {
...@@ -210,7 +212,7 @@ abstract class Command ...@@ -210,7 +212,7 @@ abstract class Command
/** /**
* Get update object * Get update object
* *
* @return \Longman\TelegramBot\Entities\Update * @return Update
*/ */
public function getUpdate() public function getUpdate()
{ {
...@@ -260,7 +262,7 @@ abstract class Command ...@@ -260,7 +262,7 @@ abstract class Command
/** /**
* Get telegram object * Get telegram object
* *
* @return \Longman\TelegramBot\Telegram * @return Telegram
*/ */
public function getTelegram() public function getTelegram()
{ {
...@@ -399,7 +401,8 @@ abstract class Command ...@@ -399,7 +401,8 @@ abstract class Command
* @param string $text * @param string $text
* @param array $data * @param array $data
* *
* @return \Longman\TelegramBot\Entities\ServerResponse * @return ServerResponse
* @throws TelegramException
*/ */
public function replyToChat($text, array $data = []) public function replyToChat($text, array $data = [])
{ {
...@@ -419,7 +422,8 @@ abstract class Command ...@@ -419,7 +422,8 @@ abstract class Command
* @param string $text * @param string $text
* @param array $data * @param array $data
* *
* @return \Longman\TelegramBot\Entities\ServerResponse * @return ServerResponse
* @throws TelegramException
*/ */
public function replyToUser($text, array $data = []) public function replyToUser($text, array $data = [])
{ {
......
...@@ -10,6 +10,7 @@ ...@@ -10,6 +10,7 @@
namespace Longman\TelegramBot\Commands; namespace Longman\TelegramBot\Commands;
use Longman\TelegramBot\Entities\ServerResponse;
use Longman\TelegramBot\Request; use Longman\TelegramBot\Request;
abstract class SystemCommand extends Command abstract class SystemCommand extends Command
...@@ -20,7 +21,7 @@ abstract class SystemCommand extends Command ...@@ -20,7 +21,7 @@ abstract class SystemCommand extends Command
* Although system commands should just work and return a successful ServerResponse, * Although system commands should just work and return a successful ServerResponse,
* each system command can override this method to add custom functionality. * each system command can override this method to add custom functionality.
* *
* @return \Longman\TelegramBot\Entities\ServerResponse * @return ServerResponse
*/ */
public function execute() public function execute()
{ {
......
...@@ -42,7 +42,6 @@ class CallbackqueryCommand extends SystemCommand ...@@ -42,7 +42,6 @@ class CallbackqueryCommand extends SystemCommand
* Command execute method * Command execute method
* *
* @return mixed * @return mixed
* @throws \Longman\TelegramBot\Exception\TelegramException
*/ */
public function execute() public function execute()
{ {
......
...@@ -38,7 +38,6 @@ class ChannelchatcreatedCommand extends SystemCommand ...@@ -38,7 +38,6 @@ class ChannelchatcreatedCommand extends SystemCommand
* Command execute method * Command execute method
* *
* @return mixed * @return mixed
* @throws \Longman\TelegramBot\Exception\TelegramException
*/ */
public function execute() public function execute()
{ {
......
...@@ -38,7 +38,6 @@ class ChannelpostCommand extends SystemCommand ...@@ -38,7 +38,6 @@ class ChannelpostCommand extends SystemCommand
* Execute command * Execute command
* *
* @return mixed * @return mixed
* @throws \Longman\TelegramBot\Exception\TelegramException
*/ */
public function execute() public function execute()
{ {
......
...@@ -38,7 +38,6 @@ class ChoseninlineresultCommand extends SystemCommand ...@@ -38,7 +38,6 @@ class ChoseninlineresultCommand extends SystemCommand
* Command execute method * Command execute method
* *
* @return mixed * @return mixed
* @throws \Longman\TelegramBot\Exception\TelegramException
*/ */
public function execute() public function execute()
{ {
......
...@@ -38,7 +38,6 @@ class DeletechatphotoCommand extends SystemCommand ...@@ -38,7 +38,6 @@ class DeletechatphotoCommand extends SystemCommand
* Command execute method * Command execute method
* *
* @return mixed * @return mixed
* @throws \Longman\TelegramBot\Exception\TelegramException
*/ */
public function execute() public function execute()
{ {
......
...@@ -38,7 +38,6 @@ class EditedchannelpostCommand extends SystemCommand ...@@ -38,7 +38,6 @@ class EditedchannelpostCommand extends SystemCommand
* Execute command * Execute command
* *
* @return mixed * @return mixed
* @throws \Longman\TelegramBot\Exception\TelegramException
*/ */
public function execute() public function execute()
{ {
......
...@@ -38,7 +38,6 @@ class EditedmessageCommand extends SystemCommand ...@@ -38,7 +38,6 @@ class EditedmessageCommand extends SystemCommand
* Command execute method * Command execute method
* *
* @return mixed * @return mixed
* @throws \Longman\TelegramBot\Exception\TelegramException
*/ */
public function execute() public function execute()
{ {
......
...@@ -11,7 +11,7 @@ ...@@ -11,7 +11,7 @@
namespace Longman\TelegramBot\Commands\SystemCommands; namespace Longman\TelegramBot\Commands\SystemCommands;
use Longman\TelegramBot\Commands\SystemCommand; use Longman\TelegramBot\Commands\SystemCommand;
use Longman\TelegramBot\Request; use Longman\TelegramBot\Entities\ServerResponse;
/** /**
* Generic command * Generic command
...@@ -36,8 +36,7 @@ class GenericCommand extends SystemCommand ...@@ -36,8 +36,7 @@ class GenericCommand extends SystemCommand
/** /**
* Command execute method * Command execute method
* *
* @return mixed * @return ServerResponse
* @throws \Longman\TelegramBot\Exception\TelegramException
*/ */
public function execute() public function execute()
{ {
......
...@@ -10,9 +10,11 @@ ...@@ -10,9 +10,11 @@
namespace Longman\TelegramBot\Commands\SystemCommands; namespace Longman\TelegramBot\Commands\SystemCommands;
use Longman\TelegramBot\Commands\SystemCommand;
use Longman\TelegramBot\Conversation; use Longman\TelegramBot\Conversation;
use Longman\TelegramBot\Entities\ServerResponse;
use Longman\TelegramBot\Exception\TelegramException;
use Longman\TelegramBot\Request; use Longman\TelegramBot\Request;
use Longman\TelegramBot\Commands\SystemCommand;
/** /**
* Generic message command * Generic message command
...@@ -42,7 +44,7 @@ class GenericmessageCommand extends SystemCommand ...@@ -42,7 +44,7 @@ class GenericmessageCommand extends SystemCommand
/** /**
* Execution if MySQL is required but not available * Execution if MySQL is required but not available
* *
* @return \Longman\TelegramBot\Entities\ServerResponse * @return ServerResponse
*/ */
public function executeNoDb() public function executeNoDb()
{ {
...@@ -53,8 +55,8 @@ class GenericmessageCommand extends SystemCommand ...@@ -53,8 +55,8 @@ class GenericmessageCommand extends SystemCommand
/** /**
* Execute command * Execute command
* *
* @return \Longman\TelegramBot\Entities\ServerResponse * @return ServerResponse
* @throws \Longman\TelegramBot\Exception\TelegramException * @throws TelegramException
*/ */
public function execute() public function execute()
{ {
......
...@@ -38,7 +38,6 @@ class GroupchatcreatedCommand extends SystemCommand ...@@ -38,7 +38,6 @@ class GroupchatcreatedCommand extends SystemCommand
* Command execute method * Command execute method
* *
* @return mixed * @return mixed
* @throws \Longman\TelegramBot\Exception\TelegramException
*/ */
public function execute() public function execute()
{ {
......
...@@ -11,8 +11,6 @@ ...@@ -11,8 +11,6 @@
namespace Longman\TelegramBot\Commands\SystemCommands; namespace Longman\TelegramBot\Commands\SystemCommands;
use Longman\TelegramBot\Commands\SystemCommand; use Longman\TelegramBot\Commands\SystemCommand;
use Longman\TelegramBot\Entities\InlineQuery\InlineQueryResultArticle;
use Longman\TelegramBot\Entities\InputMessageContent\InputTextMessageContent;
use Longman\TelegramBot\Request; use Longman\TelegramBot\Request;
/** /**
...@@ -39,7 +37,6 @@ class InlinequeryCommand extends SystemCommand ...@@ -39,7 +37,6 @@ class InlinequeryCommand extends SystemCommand
* Command execute method * Command execute method
* *
* @return mixed * @return mixed
* @throws \Longman\TelegramBot\Exception\TelegramException
*/ */
public function execute() public function execute()
{ {
......
...@@ -38,7 +38,6 @@ class LeftchatmemberCommand extends SystemCommand ...@@ -38,7 +38,6 @@ class LeftchatmemberCommand extends SystemCommand
* Command execute method * Command execute method
* *
* @return mixed * @return mixed
* @throws \Longman\TelegramBot\Exception\TelegramException
*/ */
public function execute() public function execute()
{ {
......
...@@ -38,7 +38,6 @@ class MigratefromchatidCommand extends SystemCommand ...@@ -38,7 +38,6 @@ class MigratefromchatidCommand extends SystemCommand
* Command execute method * Command execute method
* *
* @return mixed * @return mixed
* @throws \Longman\TelegramBot\Exception\TelegramException
*/ */
public function execute() public function execute()
{ {
......
...@@ -38,7 +38,6 @@ class MigratetochatidCommand extends SystemCommand ...@@ -38,7 +38,6 @@ class MigratetochatidCommand extends SystemCommand
* Command execute method * Command execute method
* *
* @return mixed * @return mixed
* @throws \Longman\TelegramBot\Exception\TelegramException
*/ */
public function execute() public function execute()
{ {
......
...@@ -38,7 +38,6 @@ class NewchatmembersCommand extends SystemCommand ...@@ -38,7 +38,6 @@ class NewchatmembersCommand extends SystemCommand
* Command execute method * Command execute method
* *
* @return mixed * @return mixed
* @throws \Longman\TelegramBot\Exception\TelegramException
*/ */
public function execute() public function execute()
{ {
......
...@@ -38,7 +38,6 @@ class NewchatphotoCommand extends SystemCommand ...@@ -38,7 +38,6 @@ class NewchatphotoCommand extends SystemCommand
* Command execute method * Command execute method
* *
* @return mixed * @return mixed
* @throws \Longman\TelegramBot\Exception\TelegramException
*/ */
public function execute() public function execute()
{ {
......
...@@ -38,7 +38,6 @@ class NewchattitleCommand extends SystemCommand ...@@ -38,7 +38,6 @@ class NewchattitleCommand extends SystemCommand
* Command execute method * Command execute method
* *
* @return mixed * @return mixed
* @throws \Longman\TelegramBot\Exception\TelegramException
*/ */
public function execute() public function execute()
{ {
......
...@@ -38,7 +38,6 @@ class PinnedmessageCommand extends SystemCommand ...@@ -38,7 +38,6 @@ class PinnedmessageCommand extends SystemCommand
* Execute command * Execute command
* *
* @return mixed * @return mixed
* @throws \Longman\TelegramBot\Exception\TelegramException
*/ */
public function execute() public function execute()
{ {
......
...@@ -11,7 +11,6 @@ ...@@ -11,7 +11,6 @@
namespace Longman\TelegramBot\Commands\SystemCommands; namespace Longman\TelegramBot\Commands\SystemCommands;
use Longman\TelegramBot\Commands\SystemCommand; use Longman\TelegramBot\Commands\SystemCommand;
use Longman\TelegramBot\Request;
/** /**
* Start command * Start command
...@@ -44,7 +43,6 @@ class StartCommand extends SystemCommand ...@@ -44,7 +43,6 @@ class StartCommand extends SystemCommand
* Command execute method * Command execute method
* *
* @return mixed * @return mixed
* @throws \Longman\TelegramBot\Exception\TelegramException
*/ */
public function execute() public function execute()
{ {
......
...@@ -38,7 +38,6 @@ class SupergroupchatcreatedCommand extends SystemCommand ...@@ -38,7 +38,6 @@ class SupergroupchatcreatedCommand extends SystemCommand
* Command execute method * Command execute method
* *
* @return mixed * @return mixed
* @throws \Longman\TelegramBot\Exception\TelegramException
*/ */
public function execute() public function execute()
{ {
......
...@@ -10,6 +10,8 @@ ...@@ -10,6 +10,8 @@
namespace Longman\TelegramBot; namespace Longman\TelegramBot;
use Longman\TelegramBot\Exception\TelegramException;
/** /**
* Class Conversation * Class Conversation
* *
...@@ -67,7 +69,7 @@ class Conversation ...@@ -67,7 +69,7 @@ class Conversation
* @param int $chat_id * @param int $chat_id
* @param string $command * @param string $command
* *
* @throws \Longman\TelegramBot\Exception\TelegramException * @throws TelegramException
*/ */
public function __construct($user_id, $chat_id, $command = null) public function __construct($user_id, $chat_id, $command = null)
{ {
...@@ -100,7 +102,7 @@ class Conversation ...@@ -100,7 +102,7 @@ class Conversation
* Load the conversation from the database * Load the conversation from the database
* *
* @return bool * @return bool
* @throws \Longman\TelegramBot\Exception\TelegramException * @throws TelegramException
*/ */
protected function load() protected function load()
{ {
...@@ -140,7 +142,7 @@ class Conversation ...@@ -140,7 +142,7 @@ class Conversation
* Start a new conversation if the current command doesn't have one yet * Start a new conversation if the current command doesn't have one yet
* *
* @return bool * @return bool
* @throws \Longman\TelegramBot\Exception\TelegramException * @throws TelegramException
*/ */
protected function start() protected function start()
{ {
...@@ -164,6 +166,7 @@ class Conversation ...@@ -164,6 +166,7 @@ class Conversation
* Currently the Conversation is not deleted but just set to 'stopped' * Currently the Conversation is not deleted but just set to 'stopped'
* *
* @return bool * @return bool
* @throws TelegramException
*/ */
public function stop() public function stop()
{ {
...@@ -174,6 +177,7 @@ class Conversation ...@@ -174,6 +177,7 @@ class Conversation
* Cancel the current conversation * Cancel the current conversation
* *
* @return bool * @return bool
* @throws TelegramException
*/ */
public function cancel() public function cancel()
{ {
...@@ -186,6 +190,7 @@ class Conversation ...@@ -186,6 +190,7 @@ class Conversation
* @param string $status * @param string $status
* *
* @return bool * @return bool
* @throws TelegramException
*/ */
protected function updateStatus($status) protected function updateStatus($status)
{ {
...@@ -209,6 +214,7 @@ class Conversation ...@@ -209,6 +214,7 @@ class Conversation
* Store the array/variable in the database with json_encode() function * Store the array/variable in the database with json_encode() function
* *
* @return bool * @return bool
* @throws TelegramException
*/ */
public function update() public function update()
{ {
......
...@@ -844,7 +844,7 @@ class DB ...@@ -844,7 +844,7 @@ class DB
$sth->bindValue(':id', $poll->getId()); $sth->bindValue(':id', $poll->getId());
$sth->bindValue(':question', $poll->getQuestion()); $sth->bindValue(':question', $poll->getQuestion());
$sth->bindValue(':options', self::entitiesArrayToJson($poll->getOptions())); $sth->bindValue(':options', self::entitiesArrayToJson($poll->getOptions() ?: null));
$sth->bindValue(':is_closed', $poll->getIsClosed()); $sth->bindValue(':is_closed', $poll->getIsClosed());
$sth->bindValue(':created_at', self::getTimestamp()); $sth->bindValue(':created_at', self::getTimestamp());
...@@ -881,18 +881,17 @@ class DB ...@@ -881,18 +881,17 @@ class DB
} }
// Insert the forwarded message user in users table // Insert the forwarded message user in users table
$forward_date = null; $forward_date = $message->getForwardDate() ? self::getTimestamp($message->getForwardDate()) : null;
$forward_from = $message->getForwardFrom(); $forward_from = $message->getForwardFrom();
if ($forward_from instanceof User) { if ($forward_from instanceof User) {
self::insertUser($forward_from, $forward_date); self::insertUser($forward_from);
$forward_from = $forward_from->getId(); $forward_from = $forward_from->getId();
$forward_date = self::getTimestamp($message->getForwardDate());
} }
$forward_from_chat = $message->getForwardFromChat(); $forward_from_chat = $message->getForwardFromChat();
if ($forward_from_chat instanceof Chat) { if ($forward_from_chat instanceof Chat) {
self::insertChat($forward_from_chat, $forward_date); self::insertChat($forward_from_chat);
$forward_from_chat = $forward_from_chat->getId(); $forward_from_chat = $forward_from_chat->getId();
$forward_date = self::getTimestamp($message->getForwardDate());
} }
// New and left chat member // New and left chat member
...@@ -977,13 +976,13 @@ class DB ...@@ -977,13 +976,13 @@ class DB
$sth->bindValue(':media_group_id', $message->getMediaGroupId()); $sth->bindValue(':media_group_id', $message->getMediaGroupId());
$sth->bindValue(':author_signature', $message->getAuthorSignature()); $sth->bindValue(':author_signature', $message->getAuthorSignature());
$sth->bindValue(':text', $message->getText()); $sth->bindValue(':text', $message->getText());
$sth->bindValue(':entities', self::entitiesArrayToJson($message->getEntities())); $sth->bindValue(':entities', self::entitiesArrayToJson($message->getEntities() ?: null));
$sth->bindValue(':caption_entities', self::entitiesArrayToJson($message->getCaptionEntities())); $sth->bindValue(':caption_entities', self::entitiesArrayToJson($message->getCaptionEntities() ?: null));
$sth->bindValue(':audio', $message->getAudio()); $sth->bindValue(':audio', $message->getAudio());
$sth->bindValue(':document', $message->getDocument()); $sth->bindValue(':document', $message->getDocument());
$sth->bindValue(':animation', $message->getAnimation()); $sth->bindValue(':animation', $message->getAnimation());
$sth->bindValue(':game', $message->getGame()); $sth->bindValue(':game', $message->getGame());
$sth->bindValue(':photo', self::entitiesArrayToJson($message->getPhoto())); $sth->bindValue(':photo', self::entitiesArrayToJson($message->getPhoto() ?: null));
$sth->bindValue(':sticker', $message->getSticker()); $sth->bindValue(':sticker', $message->getSticker());
$sth->bindValue(':video', $message->getVideo()); $sth->bindValue(':video', $message->getVideo());
$sth->bindValue(':voice', $message->getVoice()); $sth->bindValue(':voice', $message->getVoice());
...@@ -996,7 +995,7 @@ class DB ...@@ -996,7 +995,7 @@ class DB
$sth->bindValue(':new_chat_members', $new_chat_members_ids); $sth->bindValue(':new_chat_members', $new_chat_members_ids);
$sth->bindValue(':left_chat_member', $left_chat_member_id); $sth->bindValue(':left_chat_member', $left_chat_member_id);
$sth->bindValue(':new_chat_title', $message->getNewChatTitle()); $sth->bindValue(':new_chat_title', $message->getNewChatTitle());
$sth->bindValue(':new_chat_photo', self::entitiesArrayToJson($message->getNewChatPhoto())); $sth->bindValue(':new_chat_photo', self::entitiesArrayToJson($message->getNewChatPhoto() ?: null));
$sth->bindValue(':delete_chat_photo', $message->getDeleteChatPhoto()); $sth->bindValue(':delete_chat_photo', $message->getDeleteChatPhoto());
$sth->bindValue(':group_chat_created', $message->getGroupChatCreated()); $sth->bindValue(':group_chat_created', $message->getGroupChatCreated());
$sth->bindValue(':supergroup_chat_created', $message->getSupergroupChatCreated()); $sth->bindValue(':supergroup_chat_created', $message->getSupergroupChatCreated());
...@@ -1059,7 +1058,7 @@ class DB ...@@ -1059,7 +1058,7 @@ class DB
$sth->bindValue(':user_id', $user_id); $sth->bindValue(':user_id', $user_id);
$sth->bindValue(':edit_date', $edit_date); $sth->bindValue(':edit_date', $edit_date);
$sth->bindValue(':text', $edited_message->getText()); $sth->bindValue(':text', $edited_message->getText());
$sth->bindValue(':entities', self::entitiesArrayToJson($edited_message->getEntities())); $sth->bindValue(':entities', self::entitiesArrayToJson($edited_message->getEntities() ?: null));
$sth->bindValue(':caption', $edited_message->getCaption()); $sth->bindValue(':caption', $edited_message->getCaption());
return $sth->execute(); return $sth->execute();
...@@ -1187,13 +1186,13 @@ class DB ...@@ -1187,13 +1186,13 @@ class DB
* @param integer $chat_id * @param integer $chat_id
* @param string $inline_message_id * @param string $inline_message_id
* *
* @return array|bool Array containing TOTAL and CURRENT fields or false on invalid arguments * @return array Array containing TOTAL and CURRENT fields or false on invalid arguments
* @throws TelegramException * @throws TelegramException
*/ */
public static function getTelegramRequestCount($chat_id = null, $inline_message_id = null) public static function getTelegramRequestCount($chat_id = null, $inline_message_id = null)
{ {
if (!self::isDbConnected()) { if (!self::isDbConnected()) {
return false; return [];
} }
try { try {
......
...@@ -30,7 +30,7 @@ class CallbackQuery extends Entity ...@@ -30,7 +30,7 @@ class CallbackQuery extends Entity
/** /**
* {@inheritdoc} * {@inheritdoc}
*/ */
public function subEntities() protected function subEntities()
{ {
return [ return [
'from' => User::class, 'from' => User::class,
......
...@@ -46,7 +46,7 @@ class Chat extends Entity ...@@ -46,7 +46,7 @@ class Chat extends Entity
/** /**
* {@inheritdoc} * {@inheritdoc}
*/ */
public function subEntities() protected function subEntities()
{ {
return [ return [
'photo' => ChatPhoto::class, 'photo' => ChatPhoto::class,
......
...@@ -38,7 +38,7 @@ class ChatMember extends Entity ...@@ -38,7 +38,7 @@ class ChatMember extends Entity
/** /**
* {@inheritdoc} * {@inheritdoc}
*/ */
public function subEntities() protected function subEntities()
{ {
return [ return [
'user' => User::class, 'user' => User::class,
......
...@@ -33,8 +33,6 @@ abstract class Entity ...@@ -33,8 +33,6 @@ abstract class Entity
* *
* @param array $data * @param array $data
* @param string $bot_username * @param string $bot_username
*
* @throws \Longman\TelegramBot\Exception\TelegramException
*/ */
public function __construct($data, $bot_username = '') public function __construct($data, $bot_username = '')
{ {
...@@ -96,8 +94,6 @@ abstract class Entity ...@@ -96,8 +94,6 @@ abstract class Entity
/** /**
* Perform any special entity validation * Perform any special entity validation
*
* @throws \Longman\TelegramBot\Exception\TelegramException
*/ */
protected function validate() protected function validate()
{ {
...@@ -142,7 +138,13 @@ abstract class Entity ...@@ -142,7 +138,13 @@ abstract class Entity
$sub_entities = $this->subEntities(); $sub_entities = $this->subEntities();
if (isset($sub_entities[$property_name])) { if (isset($sub_entities[$property_name])) {
return new $sub_entities[$property_name]($property, $this->getProperty('bot_username')); $class = $sub_entities[$property_name];
if (is_array($class)) {
return $this->makePrettyObjectArray(reset($class), $property_name);
}
return new $class($property, $this->getProperty('bot_username'));
} }
return $property; return $property;
......
...@@ -22,10 +22,12 @@ use Longman\TelegramBot\Entities\PhotoSize; ...@@ -22,10 +22,12 @@ use Longman\TelegramBot\Entities\PhotoSize;
* *
* @link https://core.telegram.org/bots/api#game * @link https://core.telegram.org/bots/api#game
* *
* @method string getTitle() Title of the game * @method string getTitle() Title of the game
* @method string getDescription() Description of the game * @method string getDescription() Description of the game
* @method string getText() Optional. Brief description of the game or high scores included in the game message. Can be automatically edited to include current high scores for the game when the bot calls setGameScore, or manually edited using editMessageText. 0-4096 characters. * @method PhotoSize[] getPhoto() Photo that will be displayed in the game message in chats.
* @method Animation getAnimation() Optional. Animation that will be displayed in the game message in chats. Upload via BotFather * @method string getText() Optional. Brief description of the game or high scores included in the game message. Can be automatically edited to include current high scores for the game when the bot calls setGameScore, or manually edited using editMessageText. 0-4096 characters.
* @method MessageEntity[] getTextEntities() Optional. Special entities that appear in text, such as usernames, URLs, bot commands, etc.
* @method Animation getAnimation() Optional. Animation that will be displayed in the game message in chats. Upload via BotFather
**/ **/
class Game extends Entity class Game extends Entity
{ {
...@@ -35,39 +37,9 @@ class Game extends Entity ...@@ -35,39 +37,9 @@ class Game extends Entity
protected function subEntities() protected function subEntities()
{ {
return [ return [
'photo' => PhotoSize::class, 'photo' => [PhotoSize::class],
'text_entities' => MessageEntity::class, 'text_entities' => [MessageEntity::class],
'animation' => Animation::class, 'animation' => Animation::class,
]; ];
} }
/**
* Photo that will be displayed in the game message in chats.
*
* This method overrides the default getPhoto method
* and returns a nice array of PhotoSize objects.
*
* @return null|\Longman\TelegramBot\Entities\PhotoSize[]
*/
public function getPhoto()
{
$pretty_array = $this->makePrettyObjectArray(PhotoSize::class, 'photo');
return empty($pretty_array) ? null : $pretty_array;
}
/**
* Optional. Special entities that appear in text, such as usernames, URLs, bot commands, etc.
*
* This method overrides the default getTextEntities method
* and returns a nice array of MessageEntity objects.
*
* @return null|\Longman\TelegramBot\Entities\MessageEntity[]
*/
public function getTextEntities()
{
$pretty_array = $this->makePrettyObjectArray(MessageEntity::class, 'text_entities');
return empty($pretty_array) ? null : $pretty_array;
}
} }
...@@ -62,8 +62,6 @@ class InlineQueryResultArticle extends InlineEntity implements InlineQueryResult ...@@ -62,8 +62,6 @@ class InlineQueryResultArticle extends InlineEntity implements InlineQueryResult
* InlineQueryResultArticle constructor * InlineQueryResultArticle constructor
* *
* @param array $data * @param array $data
*
* @throws \Longman\TelegramBot\Exception\TelegramException
*/ */
public function __construct(array $data = []) public function __construct(array $data = [])
{ {
......
...@@ -56,8 +56,6 @@ class InlineQueryResultAudio extends InlineEntity implements InlineQueryResult ...@@ -56,8 +56,6 @@ class InlineQueryResultAudio extends InlineEntity implements InlineQueryResult
* InlineQueryResultAudio constructor * InlineQueryResultAudio constructor
* *
* @param array $data * @param array $data
*
* @throws \Longman\TelegramBot\Exception\TelegramException
*/ */
public function __construct(array $data = []) public function __construct(array $data = [])
{ {
......
...@@ -47,8 +47,6 @@ class InlineQueryResultCachedAudio extends InlineEntity implements InlineQueryRe ...@@ -47,8 +47,6 @@ class InlineQueryResultCachedAudio extends InlineEntity implements InlineQueryRe
* InlineQueryResultCachedAudio constructor * InlineQueryResultCachedAudio constructor
* *
* @param array $data * @param array $data
*
* @throws \Longman\TelegramBot\Exception\TelegramException
*/ */
public function __construct(array $data = []) public function __construct(array $data = [])
{ {
......
...@@ -53,8 +53,6 @@ class InlineQueryResultCachedDocument extends InlineEntity implements InlineQuer ...@@ -53,8 +53,6 @@ class InlineQueryResultCachedDocument extends InlineEntity implements InlineQuer
* InlineQueryResultCachedDocument constructor * InlineQueryResultCachedDocument constructor
* *
* @param array $data * @param array $data
*
* @throws \Longman\TelegramBot\Exception\TelegramException
*/ */
public function __construct(array $data = []) public function __construct(array $data = [])
{ {
......
...@@ -50,8 +50,6 @@ class InlineQueryResultCachedGif extends InlineEntity implements InlineQueryResu ...@@ -50,8 +50,6 @@ class InlineQueryResultCachedGif extends InlineEntity implements InlineQueryResu
* InlineQueryResultCachedGif constructor * InlineQueryResultCachedGif constructor
* *
* @param array $data * @param array $data
*
* @throws \Longman\TelegramBot\Exception\TelegramException
*/ */
public function __construct(array $data = []) public function __construct(array $data = [])
{ {
......
...@@ -50,8 +50,6 @@ class InlineQueryResultCachedMpeg4Gif extends InlineEntity implements InlineQuer ...@@ -50,8 +50,6 @@ class InlineQueryResultCachedMpeg4Gif extends InlineEntity implements InlineQuer
* InlineQueryResultCachedMpeg4Gif constructor * InlineQueryResultCachedMpeg4Gif constructor
* *
* @param array $data * @param array $data
*
* @throws \Longman\TelegramBot\Exception\TelegramException
*/ */
public function __construct(array $data = []) public function __construct(array $data = [])
{ {
......
...@@ -53,8 +53,6 @@ class InlineQueryResultCachedPhoto extends InlineEntity implements InlineQueryRe ...@@ -53,8 +53,6 @@ class InlineQueryResultCachedPhoto extends InlineEntity implements InlineQueryRe
* InlineQueryResultCachedPhoto constructor * InlineQueryResultCachedPhoto constructor
* *
* @param array $data * @param array $data
*
* @throws \Longman\TelegramBot\Exception\TelegramException
*/ */
public function __construct(array $data = []) public function __construct(array $data = [])
{ {
......
...@@ -44,8 +44,6 @@ class InlineQueryResultCachedSticker extends InlineEntity implements InlineQuery ...@@ -44,8 +44,6 @@ class InlineQueryResultCachedSticker extends InlineEntity implements InlineQuery
* InlineQueryResultCachedSticker constructor * InlineQueryResultCachedSticker constructor
* *
* @param array $data * @param array $data
*
* @throws \Longman\TelegramBot\Exception\TelegramException
*/ */
public function __construct(array $data = []) public function __construct(array $data = [])
{ {
......
...@@ -53,8 +53,6 @@ class InlineQueryResultCachedVideo extends InlineEntity implements InlineQueryRe ...@@ -53,8 +53,6 @@ class InlineQueryResultCachedVideo extends InlineEntity implements InlineQueryRe
* InlineQueryResultCachedVideo constructor * InlineQueryResultCachedVideo constructor
* *
* @param array $data * @param array $data
*
* @throws \Longman\TelegramBot\Exception\TelegramException
*/ */
public function __construct(array $data = []) public function __construct(array $data = [])
{ {
......
...@@ -50,8 +50,6 @@ class InlineQueryResultCachedVoice extends InlineEntity implements InlineQueryRe ...@@ -50,8 +50,6 @@ class InlineQueryResultCachedVoice extends InlineEntity implements InlineQueryRe
* InlineQueryResultCachedVoice constructor * InlineQueryResultCachedVoice constructor
* *
* @param array $data * @param array $data
*
* @throws \Longman\TelegramBot\Exception\TelegramException
*/ */
public function __construct(array $data = []) public function __construct(array $data = [])
{ {
......
...@@ -61,8 +61,6 @@ class InlineQueryResultContact extends InlineEntity implements InlineQueryResult ...@@ -61,8 +61,6 @@ class InlineQueryResultContact extends InlineEntity implements InlineQueryResult
* InlineQueryResultContact constructor * InlineQueryResultContact constructor
* *
* @param array $data * @param array $data
*
* @throws \Longman\TelegramBot\Exception\TelegramException
*/ */
public function __construct(array $data = []) public function __construct(array $data = [])
{ {
......
...@@ -65,8 +65,6 @@ class InlineQueryResultDocument extends InlineEntity implements InlineQueryResul ...@@ -65,8 +65,6 @@ class InlineQueryResultDocument extends InlineEntity implements InlineQueryResul
* InlineQueryResultDocument constructor * InlineQueryResultDocument constructor
* *
* @param array $data * @param array $data
*
* @throws \Longman\TelegramBot\Exception\TelegramException
*/ */
public function __construct(array $data = []) public function __construct(array $data = [])
{ {
......
...@@ -40,8 +40,6 @@ class InlineQueryResultGame extends InlineEntity implements InlineQueryResult ...@@ -40,8 +40,6 @@ class InlineQueryResultGame extends InlineEntity implements InlineQueryResult
* InlineQueryResultGame constructor * InlineQueryResultGame constructor
* *
* @param array $data * @param array $data
*
* @throws \Longman\TelegramBot\Exception\TelegramException
*/ */
public function __construct(array $data = []) public function __construct(array $data = [])
{ {
......
...@@ -61,8 +61,6 @@ class InlineQueryResultGif extends InlineEntity implements InlineQueryResult ...@@ -61,8 +61,6 @@ class InlineQueryResultGif extends InlineEntity implements InlineQueryResult
* InlineQueryResultGif constructor * InlineQueryResultGif constructor
* *
* @param array $data * @param array $data
*
* @throws \Longman\TelegramBot\Exception\TelegramException
*/ */
public function __construct(array $data = []) public function __construct(array $data = [])
{ {
......
...@@ -62,8 +62,6 @@ class InlineQueryResultLocation extends InlineEntity implements InlineQueryResul ...@@ -62,8 +62,6 @@ class InlineQueryResultLocation extends InlineEntity implements InlineQueryResul
* InlineQueryResultLocation constructor * InlineQueryResultLocation constructor
* *
* @param array $data * @param array $data
*
* @throws \Longman\TelegramBot\Exception\TelegramException
*/ */
public function __construct(array $data = []) public function __construct(array $data = [])
{ {
......
...@@ -61,8 +61,6 @@ class InlineQueryResultMpeg4Gif extends InlineEntity implements InlineQueryResul ...@@ -61,8 +61,6 @@ class InlineQueryResultMpeg4Gif extends InlineEntity implements InlineQueryResul
* InlineQueryResultMpeg4Gif constructor * InlineQueryResultMpeg4Gif constructor
* *
* @param array $data * @param array $data
*
* @throws \Longman\TelegramBot\Exception\TelegramException
*/ */
public function __construct(array $data = []) public function __construct(array $data = [])
{ {
......
...@@ -62,8 +62,6 @@ class InlineQueryResultPhoto extends InlineEntity implements InlineQueryResult ...@@ -62,8 +62,6 @@ class InlineQueryResultPhoto extends InlineEntity implements InlineQueryResult
* InlineQueryResultPhoto constructor * InlineQueryResultPhoto constructor
* *
* @param array $data * @param array $data
*
* @throws \Longman\TelegramBot\Exception\TelegramException
*/ */
public function __construct(array $data = []) public function __construct(array $data = [])
{ {
......
...@@ -67,8 +67,6 @@ class InlineQueryResultVenue extends InlineEntity implements InlineQueryResult ...@@ -67,8 +67,6 @@ class InlineQueryResultVenue extends InlineEntity implements InlineQueryResult
* InlineQueryResultVenue constructor * InlineQueryResultVenue constructor
* *
* @param array $data * @param array $data
*
* @throws \Longman\TelegramBot\Exception\TelegramException
*/ */
public function __construct(array $data = []) public function __construct(array $data = [])
{ {
......
...@@ -68,8 +68,6 @@ class InlineQueryResultVideo extends InlineEntity implements InlineQueryResult ...@@ -68,8 +68,6 @@ class InlineQueryResultVideo extends InlineEntity implements InlineQueryResult
* InlineQueryResultVideo constructor * InlineQueryResultVideo constructor
* *
* @param array $data * @param array $data
*
* @throws \Longman\TelegramBot\Exception\TelegramException
*/ */
public function __construct(array $data = []) public function __construct(array $data = [])
{ {
......
...@@ -53,8 +53,6 @@ class InlineQueryResultVoice extends InlineEntity implements InlineQueryResult ...@@ -53,8 +53,6 @@ class InlineQueryResultVoice extends InlineEntity implements InlineQueryResult
* InlineQueryResultVoice constructor * InlineQueryResultVoice constructor
* *
* @param array $data * @param array $data
*
* @throws \Longman\TelegramBot\Exception\TelegramException
*/ */
public function __construct(array $data = []) public function __construct(array $data = [])
{ {
......
...@@ -4,5 +4,20 @@ namespace Longman\TelegramBot\Entities\InputMedia; ...@@ -4,5 +4,20 @@ namespace Longman\TelegramBot\Entities\InputMedia;
interface InputMedia interface InputMedia
{ {
/**
* @return string Type of the result.
*/
public function getType();
/**
* @return string File to send.
*/
public function getMedia();
/**
* @param string $media File to send.
*
* @return string
*/
public function setMedia($media);
} }
...@@ -52,8 +52,6 @@ class InputMediaAnimation extends Entity implements InputMedia ...@@ -52,8 +52,6 @@ class InputMediaAnimation extends Entity implements InputMedia
* InputMediaAnimation constructor * InputMediaAnimation constructor
* *
* @param array $data * @param array $data
*
* @throws \Longman\TelegramBot\Exception\TelegramException
*/ */
public function __construct(array $data = []) public function __construct(array $data = [])
{ {
......
...@@ -52,8 +52,6 @@ class InputMediaAudio extends Entity implements InputMedia ...@@ -52,8 +52,6 @@ class InputMediaAudio extends Entity implements InputMedia
* InputMediaAudio constructor * InputMediaAudio constructor
* *
* @param array $data * @param array $data
*
* @throws \Longman\TelegramBot\Exception\TelegramException
*/ */
public function __construct(array $data = []) public function __construct(array $data = [])
{ {
......
...@@ -43,8 +43,6 @@ class InputMediaDocument extends Entity implements InputMedia ...@@ -43,8 +43,6 @@ class InputMediaDocument extends Entity implements InputMedia
* InputMediaDocument constructor * InputMediaDocument constructor
* *
* @param array $data * @param array $data
*
* @throws \Longman\TelegramBot\Exception\TelegramException
*/ */
public function __construct(array $data = []) public function __construct(array $data = [])
{ {
......
...@@ -40,8 +40,6 @@ class InputMediaPhoto extends Entity implements InputMedia ...@@ -40,8 +40,6 @@ class InputMediaPhoto extends Entity implements InputMedia
* InputMediaPhoto constructor * InputMediaPhoto constructor
* *
* @param array $data * @param array $data
*
* @throws \Longman\TelegramBot\Exception\TelegramException
*/ */
public function __construct(array $data = []) public function __construct(array $data = [])
{ {
......
...@@ -55,8 +55,6 @@ class InputMediaVideo extends Entity implements InputMedia ...@@ -55,8 +55,6 @@ class InputMediaVideo extends Entity implements InputMedia
* InputMediaVideo constructor * InputMediaVideo constructor
* *
* @param array $data * @param array $data
*
* @throws \Longman\TelegramBot\Exception\TelegramException
*/ */
public function __construct(array $data = []) public function __construct(array $data = [])
{ {
......
...@@ -54,7 +54,7 @@ class Keyboard extends Entity ...@@ -54,7 +54,7 @@ class Keyboard extends Entity
/** /**
* Get the proper keyboard button class for this keyboard. * Get the proper keyboard button class for this keyboard.
* *
* @return KeyboardButton|InlineKeyboardButton * @return string
*/ */
public function getKeyboardButtonClass() public function getKeyboardButtonClass()
{ {
...@@ -154,9 +154,9 @@ class Keyboard extends Entity ...@@ -154,9 +154,9 @@ class Keyboard extends Entity
/** /**
* Parse a given button to the correct KeyboardButton object type. * Parse a given button to the correct KeyboardButton object type.
* *
* @param array|string|\Longman\TelegramBot\Entities\KeyboardButton $button * @param array|string|KeyboardButton $button
* *
* @return \Longman\TelegramBot\Entities\KeyboardButton|null * @return KeyboardButton|null
*/ */
protected function parseButton($button) protected function parseButton($button)
{ {
...@@ -166,7 +166,7 @@ class Keyboard extends Entity ...@@ -166,7 +166,7 @@ class Keyboard extends Entity
return $button; return $button;
} }
if (!$this->isInlineKeyboard() || $button_class::couldBe($button)) { if (!$this->isInlineKeyboard() || call_user_func([$button_class, 'couldBe'], $button)) {
return new $button_class($button); return new $button_class($button);
} }
...@@ -179,7 +179,7 @@ class Keyboard extends Entity ...@@ -179,7 +179,7 @@ class Keyboard extends Entity
protected function validate() protected function validate()
{ {
$keyboard_type = $this->getKeyboardType(); $keyboard_type = $this->getKeyboardType();
$keyboard = $this->getProperty($keyboard_type); $keyboard = $this->getProperty($keyboard_type);
if ($keyboard !== null) { if ($keyboard !== null) {
if (!is_array($keyboard)) { if (!is_array($keyboard)) {
...@@ -201,8 +201,7 @@ class Keyboard extends Entity ...@@ -201,8 +201,7 @@ class Keyboard extends Entity
* *
* @param array $data * @param array $data
* *
* @return \Longman\TelegramBot\Entities\Keyboard * @return Keyboard
* @throws \Longman\TelegramBot\Exception\TelegramException
*/ */
public static function remove(array $data = []) public static function remove(array $data = [])
{ {
...@@ -216,8 +215,7 @@ class Keyboard extends Entity ...@@ -216,8 +215,7 @@ class Keyboard extends Entity
* *
* @param array $data * @param array $data
* *
* @return \Longman\TelegramBot\Entities\Keyboard * @return Keyboard
* @throws \Longman\TelegramBot\Exception\TelegramException
*/ */
public static function forceReply(array $data = []) public static function forceReply(array $data = [])
{ {
......
...@@ -34,10 +34,13 @@ use Longman\TelegramBot\Entities\TelegramPassport\PassportData; ...@@ -34,10 +34,13 @@ use Longman\TelegramBot\Entities\TelegramPassport\PassportData;
* @method int getEditDate() Optional. Date the message was last edited in Unix time * @method int getEditDate() Optional. Date the message was last edited in Unix time
* @method string getMediaGroupId() Optional. The unique identifier of a media message group this message belongs to * @method string getMediaGroupId() Optional. The unique identifier of a media message group this message belongs to
* @method string getAuthorSignature() Optional. Signature of the post author for messages in channels * @method string getAuthorSignature() Optional. Signature of the post author for messages in channels
* @method MessageEntity[] getEntities() Optional. For text messages, special entities like usernames, URLs, bot commands, etc. that appear in the text
* @method MessageEntity[] getCaptionEntities() Optional. For messages with a caption, special entities like usernames, URLs, bot commands, etc. that appear in the caption
* @method Audio getAudio() Optional. Message is an audio file, information about the file * @method Audio getAudio() Optional. Message is an audio file, information about the file
* @method Document getDocument() Optional. Message is a general file, information about the file * @method Document getDocument() Optional. Message is a general file, information about the file
* @method Animation getAnimation() Optional. Message is an animation, information about the animation. For backward compatibility, when this field is set, the document field will also be set * @method Animation getAnimation() Optional. Message is an animation, information about the animation. For backward compatibility, when this field is set, the document field will also be set
* @method Game getGame() Optional. Message is a game, information about the game. * @method Game getGame() Optional. Message is a game, information about the game.
* @method PhotoSize[] getPhoto() Optional. Message is a photo, available sizes of the photo
* @method Sticker getSticker() Optional. Message is a sticker, information about the sticker * @method Sticker getSticker() Optional. Message is a sticker, information about the sticker
* @method Video getVideo() Optional. Message is a video, information about the video * @method Video getVideo() Optional. Message is a video, information about the video
* @method Voice getVoice() Optional. Message is a voice message, information about the file * @method Voice getVoice() Optional. Message is a voice message, information about the file
...@@ -47,8 +50,10 @@ use Longman\TelegramBot\Entities\TelegramPassport\PassportData; ...@@ -47,8 +50,10 @@ use Longman\TelegramBot\Entities\TelegramPassport\PassportData;
* @method Location getLocation() Optional. Message is a shared location, information about the location * @method Location getLocation() Optional. Message is a shared location, information about the location
* @method Venue getVenue() Optional. Message is a venue, information about the venue * @method Venue getVenue() Optional. Message is a venue, information about the venue
* @method Poll getPoll() Optional. Message is a native poll, information about the poll * @method Poll getPoll() Optional. Message is a native poll, information about the poll
* @method User[] getNewChatMembers() Optional. A new member(s) was added to the group, information about them (one of this members may be the bot itself)
* @method User getLeftChatMember() Optional. A member was removed from the group, information about them (this member may be the bot itself) * @method User getLeftChatMember() Optional. A member was removed from the group, information about them (this member may be the bot itself)
* @method string getNewChatTitle() Optional. A chat title was changed to this value * @method string getNewChatTitle() Optional. A chat title was changed to this value
* @method PhotoSize[] getNewChatPhoto() Optional. A chat photo was changed to this value
* @method bool getDeleteChatPhoto() Optional. Service message: the chat photo was deleted * @method bool getDeleteChatPhoto() Optional. Service message: the chat photo was deleted
* @method bool getGroupChatCreated() Optional. Service message: the group has been created * @method bool getGroupChatCreated() Optional. Service message: the group has been created
* @method bool getSupergroupChatCreated() Optional. Service message: the supergroup has been created. This field can't be received in a message coming through updates, because bot can’t be a member of a supergroup when it is created. It can only be found in reply_to_message if someone replies to a very first message in a directly created supergroup. * @method bool getSupergroupChatCreated() Optional. Service message: the supergroup has been created. This field can't be received in a message coming through updates, because bot can’t be a member of a supergroup when it is created. It can only be found in reply_to_message if someone replies to a very first message in a directly created supergroup.
...@@ -74,13 +79,13 @@ class Message extends Entity ...@@ -74,13 +79,13 @@ class Message extends Entity
'forward_from' => User::class, 'forward_from' => User::class,
'forward_from_chat' => Chat::class, 'forward_from_chat' => Chat::class,
'reply_to_message' => ReplyToMessage::class, 'reply_to_message' => ReplyToMessage::class,
'entities' => MessageEntity::class, 'entities' => [MessageEntity::class],
'caption_entities' => MessageEntity::class, 'caption_entities' => [MessageEntity::class],
'audio' => Audio::class, 'audio' => Audio::class,
'document' => Document::class, 'document' => Document::class,
'animation' => Animation::class, 'animation' => Animation::class,
'game' => Game::class, 'game' => Game::class,
'photo' => PhotoSize::class, 'photo' => [PhotoSize::class],
'sticker' => Sticker::class, 'sticker' => Sticker::class,
'video' => Video::class, 'video' => Video::class,
'voice' => Voice::class, 'voice' => Voice::class,
...@@ -89,9 +94,9 @@ class Message extends Entity ...@@ -89,9 +94,9 @@ class Message extends Entity
'location' => Location::class, 'location' => Location::class,
'venue' => Venue::class, 'venue' => Venue::class,
'poll' => Poll::class, 'poll' => Poll::class,
'new_chat_members' => User::class, 'new_chat_members' => [User::class],
'left_chat_member' => User::class, 'left_chat_member' => User::class,
'new_chat_photo' => PhotoSize::class, 'new_chat_photo' => [PhotoSize::class],
'pinned_message' => Message::class, 'pinned_message' => Message::class,
'invoice' => Invoice::class, 'invoice' => Invoice::class,
'successful_payment' => SuccessfulPayment::class, 'successful_payment' => SuccessfulPayment::class,
...@@ -99,94 +104,6 @@ class Message extends Entity ...@@ -99,94 +104,6 @@ class Message extends Entity
]; ];
} }
/**
* Message constructor
*
* @param array $data
* @param string $bot_username
*
* @throws \Longman\TelegramBot\Exception\TelegramException
*/
public function __construct(array $data, $bot_username = '')
{
parent::__construct($data, $bot_username);
}
/**
* Optional. Message is a photo, available sizes of the photo
*
* This method overrides the default getPhoto method
* and returns a nice array of PhotoSize objects.
*
* @return null|PhotoSize[]
*/
public function getPhoto()
{
$pretty_array = $this->makePrettyObjectArray(PhotoSize::class, 'photo');
return empty($pretty_array) ? null : $pretty_array;
}
/**
* Optional. A chat photo was changed to this value
*
* This method overrides the default getNewChatPhoto method
* and returns a nice array of PhotoSize objects.
*
* @return null|PhotoSize[]
*/
public function getNewChatPhoto()
{
$pretty_array = $this->makePrettyObjectArray(PhotoSize::class, 'new_chat_photo');
return empty($pretty_array) ? null : $pretty_array;
}
/**
* Optional. A new member(s) was added to the group, information about them (one of this members may be the bot itself)
*
* This method overrides the default getNewChatMembers method
* and returns a nice array of User objects.
*
* @return null|User[]
*/
public function getNewChatMembers()
{
$pretty_array = $this->makePrettyObjectArray(User::class, 'new_chat_members');
return empty($pretty_array) ? null : $pretty_array;
}
/**
* Optional. For text messages, special entities like usernames, URLs, bot commands, etc. that appear in the text
*
* This method overrides the default getEntities method
* and returns a nice array of MessageEntity objects.
*
* @return null|MessageEntity[]
*/
public function getEntities()
{
$pretty_array = $this->makePrettyObjectArray(MessageEntity::class, 'entities');
return empty($pretty_array) ? null : $pretty_array;
}
/**
* Optional. For messages with a caption, special entities like usernames, URLs, bot commands, etc. that appear in the caption
*
* This method overrides the default getCaptionEntities method
* and returns a nice array of MessageEntity objects.
*
* @return null|MessageEntity[]
*/
public function getCaptionEntities()
{
$pretty_array = $this->makePrettyObjectArray(MessageEntity::class, 'caption_entities');
return empty($pretty_array) ? null : $pretty_array;
}
/** /**
* return the entire command like /echo or /echo@bot1 if specified * return the entire command like /echo or /echo@bot1 if specified
* *
...@@ -264,7 +181,6 @@ class Message extends Entity ...@@ -264,7 +181,6 @@ class Message extends Entity
* Bot added in chat * Bot added in chat
* *
* @return bool * @return bool
* @throws \Longman\TelegramBot\Exception\TelegramException
*/ */
public function botAddedInChat() public function botAddedInChat()
{ {
......
...@@ -29,7 +29,7 @@ class OrderInfo extends Entity ...@@ -29,7 +29,7 @@ class OrderInfo extends Entity
/** /**
* {@inheritdoc} * {@inheritdoc}
*/ */
public function subEntities() protected function subEntities()
{ {
return [ return [
'shipping_address' => ShippingAddress::class, 'shipping_address' => ShippingAddress::class,
......
...@@ -11,6 +11,7 @@ ...@@ -11,6 +11,7 @@
namespace Longman\TelegramBot\Entities\Payments; namespace Longman\TelegramBot\Entities\Payments;
use Longman\TelegramBot\Entities\Entity; use Longman\TelegramBot\Entities\Entity;
use Longman\TelegramBot\Entities\ServerResponse;
use Longman\TelegramBot\Entities\User; use Longman\TelegramBot\Entities\User;
use Longman\TelegramBot\Request; use Longman\TelegramBot\Request;
...@@ -34,7 +35,7 @@ class PreCheckoutQuery extends Entity ...@@ -34,7 +35,7 @@ class PreCheckoutQuery extends Entity
/** /**
* {@inheritdoc} * {@inheritdoc}
*/ */
public function subEntities() protected function subEntities()
{ {
return [ return [
'from' => User::class, 'from' => User::class,
...@@ -48,7 +49,7 @@ class PreCheckoutQuery extends Entity ...@@ -48,7 +49,7 @@ class PreCheckoutQuery extends Entity
* @param bool $ok * @param bool $ok
* @param array $data * @param array $data
* *
* @return \Longman\TelegramBot\Entities\ServerResponse * @return ServerResponse
*/ */
public function answer($ok, array $data = []) public function answer($ok, array $data = [])
{ {
......
...@@ -19,8 +19,9 @@ use Longman\TelegramBot\Entities\Entity; ...@@ -19,8 +19,9 @@ use Longman\TelegramBot\Entities\Entity;
* *
* @link https://core.telegram.org/bots/api#shippingoption * @link https://core.telegram.org/bots/api#shippingoption
* *
* @method string getId() Shipping option identifier * @method string getId() Shipping option identifier
* @method string getTitle() Option title * @method string getTitle() Option title
* @method LabeledPrice[] getPrices() List of price portions
**/ **/
class ShippingOption extends Entity class ShippingOption extends Entity
{ {
...@@ -30,19 +31,7 @@ class ShippingOption extends Entity ...@@ -30,19 +31,7 @@ class ShippingOption extends Entity
protected function subEntities() protected function subEntities()
{ {
return [ return [
'prices' => LabeledPrice::class, 'prices' => [LabeledPrice::class],
]; ];
} }
/**
* List of price portions
*
* This method overrides the default getPrices method and returns a nice array
*
* @return LabeledPrice[]
*/
public function getPrices()
{
return $this->makePrettyObjectArray(LabeledPrice::class, 'prices');
}
} }
...@@ -11,6 +11,7 @@ ...@@ -11,6 +11,7 @@
namespace Longman\TelegramBot\Entities\Payments; namespace Longman\TelegramBot\Entities\Payments;
use Longman\TelegramBot\Entities\Entity; use Longman\TelegramBot\Entities\Entity;
use Longman\TelegramBot\Entities\ServerResponse;
use Longman\TelegramBot\Entities\User; use Longman\TelegramBot\Entities\User;
use Longman\TelegramBot\Request; use Longman\TelegramBot\Request;
...@@ -31,7 +32,7 @@ class ShippingQuery extends Entity ...@@ -31,7 +32,7 @@ class ShippingQuery extends Entity
/** /**
* {@inheritdoc} * {@inheritdoc}
*/ */
public function subEntities() protected function subEntities()
{ {
return [ return [
'from' => User::class, 'from' => User::class,
...@@ -45,7 +46,7 @@ class ShippingQuery extends Entity ...@@ -45,7 +46,7 @@ class ShippingQuery extends Entity
* @param bool $ok * @param bool $ok
* @param array $data * @param array $data
* *
* @return \Longman\TelegramBot\Entities\ServerResponse * @return ServerResponse
*/ */
public function answer($ok, array $data = []) public function answer($ok, array $data = [])
{ {
......
...@@ -32,7 +32,7 @@ class SuccessfulPayment extends Entity ...@@ -32,7 +32,7 @@ class SuccessfulPayment extends Entity
/** /**
* {@inheritdoc} * {@inheritdoc}
*/ */
public function subEntities() protected function subEntities()
{ {
return [ return [
'order_info' => OrderInfo::class, 'order_info' => OrderInfo::class,
......
...@@ -17,9 +17,10 @@ namespace Longman\TelegramBot\Entities; ...@@ -17,9 +17,10 @@ namespace Longman\TelegramBot\Entities;
* *
* @link https://core.telegram.org/bots/api#poll * @link https://core.telegram.org/bots/api#poll
* *
* @method string getId() Unique poll identifier * @method string getId() Unique poll identifier
* @method string getQuestion() Poll question, 1-255 characters * @method string getQuestion() Poll question, 1-255 characters
* @method bool getIsClosed() True, if the poll is closed * @method PollOption[] getOptions() List of poll options
* @method bool getIsClosed() True, if the poll is closed
*/ */
class Poll extends Entity class Poll extends Entity
{ {
...@@ -29,22 +30,7 @@ class Poll extends Entity ...@@ -29,22 +30,7 @@ class Poll extends Entity
protected function subEntities() protected function subEntities()
{ {
return [ return [
'options' => PollOption::class, 'options' => [PollOption::class],
]; ];
} }
/**
* List of poll options
*
* This method overrides the default getOptions method
* and returns a nice array of PollOption objects.
*
* @return null|PollOption[]
*/
public function getOptions()
{
$pretty_array = $this->makePrettyObjectArray(PollOption::class, 'options');
return empty($pretty_array) ? null : $pretty_array;
}
} }
...@@ -22,8 +22,6 @@ class ReplyToMessage extends Message ...@@ -22,8 +22,6 @@ class ReplyToMessage extends Message
* *
* @param array $data * @param array $data
* @param string $bot_username * @param string $bot_username
*
* @throws \Longman\TelegramBot\Exception\TelegramException
*/ */
public function __construct(array $data, $bot_username = '') public function __construct(array $data, $bot_username = '')
{ {
......
...@@ -30,8 +30,6 @@ class ServerResponse extends Entity ...@@ -30,8 +30,6 @@ class ServerResponse extends Entity
* *
* @param array $data * @param array $data
* @param string $bot_username * @param string $bot_username
*
* @throws \Longman\TelegramBot\Exception\TelegramException
*/ */
public function __construct(array $data, $bot_username) public function __construct(array $data, $bot_username)
{ {
...@@ -105,7 +103,7 @@ class ServerResponse extends Entity ...@@ -105,7 +103,7 @@ class ServerResponse extends Entity
* @param array $result * @param array $result
* @param string $bot_username * @param string $bot_username
* *
* @return \Longman\TelegramBot\Entities\Chat|\Longman\TelegramBot\Entities\ChatMember|\Longman\TelegramBot\Entities\File|\Longman\TelegramBot\Entities\Message|\Longman\TelegramBot\Entities\User|\Longman\TelegramBot\Entities\UserProfilePhotos|\Longman\TelegramBot\Entities\WebhookInfo * @return Chat|ChatMember|File|Message|User|UserProfilePhotos|WebhookInfo
*/ */
private function createResultObject(array $result, $bot_username) private function createResultObject(array $result, $bot_username)
{ {
...@@ -135,7 +133,7 @@ class ServerResponse extends Entity ...@@ -135,7 +133,7 @@ class ServerResponse extends Entity
* @param array $result * @param array $result
* @param string $bot_username * @param string $bot_username
* *
* @return \Longman\TelegramBot\Entities\ChatMember[]|\Longman\TelegramBot\Entities\Games\GameHighScore[]|\Longman\TelegramBot\Entities\Message[]|\Longman\TelegramBot\Entities\Update[] * @return ChatMember[]|GameHighScore[]|Message[]|Update[]
*/ */
private function createResultObjects(array $result, $bot_username) private function createResultObjects(array $result, $bot_username)
{ {
......
...@@ -15,24 +15,20 @@ namespace Longman\TelegramBot\Entities; ...@@ -15,24 +15,20 @@ namespace Longman\TelegramBot\Entities;
* *
* @link https://core.telegram.org/bots/api#stickerset * @link https://core.telegram.org/bots/api#stickerset
* *
* @method string getName() Sticker set name * @method string getName() Sticker set name
* @method string getTitle() Sticker set title * @method string getTitle() Sticker set title
* @method bool getContainsMasks() True, if the sticker set contains masks * @method bool getContainsMasks() True, if the sticker set contains masks
* @method Sticker[] getStickers() List of all set stickers
*/ */
class StickerSet extends Entity class StickerSet extends Entity
{ {
/** /**
* List of all set stickers * {@inheritdoc}
*
* This method overrides the default getStickers method
* and returns a nice array of Sticker objects.
*
* @return null|Sticker[]
*/ */
public function getStickers() protected function subEntities()
{ {
$pretty_array = $this->makePrettyObjectArray(Sticker::class, 'stickers'); return [
'stickers' => [Sticker::class],
return empty($pretty_array) ? null : $pretty_array; ];
} }
} }
...@@ -19,14 +19,16 @@ use Longman\TelegramBot\Entities\Entity; ...@@ -19,14 +19,16 @@ use Longman\TelegramBot\Entities\Entity;
* *
* @link https://core.telegram.org/bots/api#encryptedpassportelement * @link https://core.telegram.org/bots/api#encryptedpassportelement
* *
* @method string getType() Element type. One of “personal_details”, “passport”, “driver_license”, “identity_card”, “internal_passport”, “address”, “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration”, “temporary_registration”, “phone_number”, “email”. * @method string getType() Element type. One of “personal_details”, “passport”, “driver_license”, “identity_card”, “internal_passport”, “address”, “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration”, “temporary_registration”, “phone_number”, “email”.
* @method string getData() Optional. Base64-encoded encrypted Telegram Passport element data provided by the user, available for “personal_details”, “passport”, “driver_license”, “identity_card”, “identity_passport” and “address” types. Can be decrypted and verified using the accompanying EncryptedCredentials. * @method string getData() Optional. Base64-encoded encrypted Telegram Passport element data provided by the user, available for “personal_details”, “passport”, “driver_license”, “identity_card”, “identity_passport” and “address” types. Can be decrypted and verified using the accompanying EncryptedCredentials.
* @method string getPhoneNumber() Optional. User's verified phone number, available only for “phone_number” type * @method string getPhoneNumber() Optional. User's verified phone number, available only for “phone_number” type
* @method string getEmail() Optional. User's verified email address, available only for “email” type * @method string getEmail() Optional. User's verified email address, available only for “email” type
* @method PassportFile getFrontSide() Optional. Encrypted file with the front side of the document, provided by the user. Available for “passport”, “driver_license”, “identity_card” and “internal_passport”. The file can be decrypted and verified using the accompanying EncryptedCredentials. * @method PassportFile[] getFiles() Optional. Array of encrypted files with documents provided by the user, available for “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration” and “temporary_registration” types. Files can be decrypted and verified using the accompanying EncryptedCredentials.
* @method PassportFile getReverseSide() Optional. Encrypted file with the reverse side of the document, provided by the user. Available for “driver_license” and “identity_card”. The file can be decrypted and verified using the accompanying EncryptedCredentials. * @method PassportFile getFrontSide() Optional. Encrypted file with the front side of the document, provided by the user. Available for “passport”, “driver_license”, “identity_card” and “internal_passport”. The file can be decrypted and verified using the accompanying EncryptedCredentials.
* @method PassportFile getSelfie() Optional. Encrypted file with the selfie of the user holding a document, provided by the user; available for “passport”, “driver_license”, “identity_card” and “internal_passport”. The file can be decrypted and verified using the accompanying EncryptedCredentials. * @method PassportFile getReverseSide() Optional. Encrypted file with the reverse side of the document, provided by the user. Available for “driver_license” and “identity_card”. The file can be decrypted and verified using the accompanying EncryptedCredentials.
* @method string getHash() Base64-encoded element hash for using in PassportElementErrorUnspecified * @method PassportFile getSelfie() Optional. Encrypted file with the selfie of the user holding a document, provided by the user; available for “passport”, “driver_license”, “identity_card” and “internal_passport”. The file can be decrypted and verified using the accompanying EncryptedCredentials.
* @method PassportFile[] getTranslation() Optional. Array of encrypted files with translated versions of documents provided by the user. Available if requested for “passport”, “driver_license”, “identity_card”, “internal_passport”, “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration” and “temporary_registration” types. Files can be decrypted and verified using the accompanying EncryptedCredentials.
* @method string getHash() Base64-encoded element hash for using in PassportElementErrorUnspecified
**/ **/
class EncryptedPassportElement extends Entity class EncryptedPassportElement extends Entity
{ {
...@@ -36,41 +38,11 @@ class EncryptedPassportElement extends Entity ...@@ -36,41 +38,11 @@ class EncryptedPassportElement extends Entity
protected function subEntities() protected function subEntities()
{ {
return [ return [
'files' => PassportFile::class, 'files' => [PassportFile::class],
'front_side' => PassportFile::class, 'front_side' => PassportFile::class,
'reverse_side' => PassportFile::class, 'reverse_side' => PassportFile::class,
'selfie' => PassportFile::class, 'selfie' => PassportFile::class,
'translation' => PassportFile::class, 'translation' => [PassportFile::class],
]; ];
} }
/**
* Optional. Array of encrypted files with documents provided by the user, available for “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration” and “temporary_registration” types. Files can be decrypted and verified using the accompanying EncryptedCredentials.
*
* This method overrides the default getFiles method
* and returns a nice array of PassportFile objects.
*
* @return null|PassportFile[]
*/
public function getFiles()
{
$pretty_array = $this->makePrettyObjectArray(PassportFile::class, 'files');
return empty($pretty_array) ? null : $pretty_array;
}
/**
* Optional. Array of encrypted files with translated versions of documents provided by the user. Available if requested for “passport”, “driver_license”, “identity_card”, “internal_passport”, “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration” and “temporary_registration” types. Files can be decrypted and verified using the accompanying EncryptedCredentials.
*
* This method overrides the default getTranslation method
* and returns a nice array of PassportFile objects.
*
* @return null|PassportFile[]
*/
public function getTranslation()
{
$pretty_array = $this->makePrettyObjectArray(PassportFile::class, 'translation');
return empty($pretty_array) ? null : $pretty_array;
}
} }
...@@ -19,7 +19,8 @@ use Longman\TelegramBot\Entities\Entity; ...@@ -19,7 +19,8 @@ use Longman\TelegramBot\Entities\Entity;
* *
* @link https://core.telegram.org/bots/api#passportdata * @link https://core.telegram.org/bots/api#passportdata
* *
* @method EncryptedCredentials getCredentials() Encrypted credentials required to decrypt the data * @method EncryptedPassportElement[] getData() Array with information about documents and other Telegram Passport elements that was shared with the bot
* @method EncryptedCredentials getCredentials() Encrypted credentials required to decrypt the data
**/ **/
class PassportData extends Entity class PassportData extends Entity
{ {
...@@ -29,23 +30,8 @@ class PassportData extends Entity ...@@ -29,23 +30,8 @@ class PassportData extends Entity
protected function subEntities() protected function subEntities()
{ {
return [ return [
'data' => EncryptedPassportElement::class, 'data' => [EncryptedPassportElement::class],
'credentials' => EncryptedCredentials::class, 'credentials' => EncryptedCredentials::class,
]; ];
} }
/**
* Array with information about documents and other Telegram Passport elements that was shared with the bot
*
* This method overrides the default getData method
* and returns a nice array of EncryptedPassportElement objects.
*
* @return null|EncryptedPassportElement[]
*/
public function getData()
{
$pretty_array = $this->makePrettyObjectArray(EncryptedPassportElement::class, 'data');
return empty($pretty_array) ? null : $pretty_array;
}
} }
...@@ -31,8 +31,6 @@ class PassportElementErrorDataField extends Entity implements PassportElementErr ...@@ -31,8 +31,6 @@ class PassportElementErrorDataField extends Entity implements PassportElementErr
* PassportElementErrorDataField constructor * PassportElementErrorDataField constructor
* *
* @param array $data * @param array $data
*
* @throws \Longman\TelegramBot\Exception\TelegramException
*/ */
public function __construct(array $data = []) public function __construct(array $data = [])
{ {
......
...@@ -30,8 +30,6 @@ class PassportElementErrorFile extends Entity implements PassportElementError ...@@ -30,8 +30,6 @@ class PassportElementErrorFile extends Entity implements PassportElementError
* PassportElementErrorFile constructor * PassportElementErrorFile constructor
* *
* @param array $data * @param array $data
*
* @throws \Longman\TelegramBot\Exception\TelegramException
*/ */
public function __construct(array $data = []) public function __construct(array $data = [])
{ {
......
...@@ -30,8 +30,6 @@ class PassportElementErrorFiles extends Entity implements PassportElementError ...@@ -30,8 +30,6 @@ class PassportElementErrorFiles extends Entity implements PassportElementError
* PassportElementErrorFiles constructor * PassportElementErrorFiles constructor
* *
* @param array $data * @param array $data
*
* @throws \Longman\TelegramBot\Exception\TelegramException
*/ */
public function __construct(array $data = []) public function __construct(array $data = [])
{ {
......
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment