Longman\TelegramBot\Entities\ServerResponse

Complexity

Total Complexity

11

Size/Duplication

Total Lines	143
Duplicated Lines	0 %

Test Coverage

Coverage

89.66%

Importance

Changes	4
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	18	4
A	isOk()	0	3	1
A	isAssoc()	0	3	1
A	printError()	0	11	2
A	createResultObjects()	0	25	2
A	createResultObject()	0	26	1

<?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\Entities;

use Longman\TelegramBot\Entities\ChatMember\ChatMember;
use Longman\TelegramBot\Entities\ChatMember\Factory as ChatMemberFactory;
use Longman\TelegramBot\Entities\Games\GameHighScore;
use Longman\TelegramBot\Entities\MenuButton\Factory as MenuButtonFactory;
use Longman\TelegramBot\Request;

/**
 * Class ServerResponse
 *
 * @link https://core.telegram.org/bots/api#making-requests
 *
 * @method bool   getOk()          If the request was successful
 * @method mixed  getResult()      The result of the query
 * @method int    getErrorCode()   Error code of the unsuccessful request
 * @method string getDescription() Human-readable description of the result / unsuccessful request
 *
 * @todo method ResponseParameters getParameters()  Field which can help to automatically handle the error
 */
class ServerResponse extends Entity
{
    /**
     * ServerResponse constructor.
     *
     * @param array  $data
     * @param string $bot_username
     */
    public function __construct(array $data, string $bot_username = '')
    {
        // Make sure we don't double-save the raw_data
        unset($data['raw_data']);
        $data['raw_data'] = $data;

        $is_ok  = (bool) ($data['ok'] ?? false);
        $result = $data['result'] ?? null;

        if ($is_ok && is_array($result)) {
            if ($this->isAssoc($result)) {
                $data['result'] = $this->createResultObject($result, $bot_username);
            } else {
                $data['result'] = $this->createResultObjects($result, $bot_username);
            }
        }

        parent::__construct($data, $bot_username);
    }

    /**
     * Check if array is associative
     *
     * @link https://stackoverflow.com/a/4254008
     *
     * @param array $array
     *
     * @return bool
     */
    protected function isAssoc(array $array): bool
    {
        return count(array_filter(array_keys($array), 'is_string')) > 0;
    }

    /**
     * If response is ok
     *
     * @return bool
     */
    public function isOk(): bool
    {
        return (bool) $this->getOk();
    }

    /**
     * Print error
     *
     * @see https://secure.php.net/manual/en/function.print-r.php
     *
     * @param bool $return
     *
     * @return bool|string
     */
    public function printError($return = false)
    {
        $error = sprintf('Error N: %s, Description: %s', $this->getErrorCode(), $this->getDescription());

        if ($return) {
            return $error;
        }

        echo $error;

        return true;
    }

    /**
     * Create and return the object of the received result
     *
     * @param array  $result
     * @param string $bot_username
     *
     * @return BotDescription|BotName|BotShortDescription|Chat|ChatAdministratorRights|ChatMember|File|Message|MenuButton|Poll|SentWebAppMessage|StickerSet|User|UserProfilePhotos|WebhookInfo
     */
    private function createResultObject(array $result, string $bot_username): Entity
    {
        $result_object_types = [
            'getWebhookInfo'                  => WebhookInfo::class,
            'getMe'                           => User::class,
            'getUserProfilePhotos'            => UserProfilePhotos::class,
            'getFile'                         => File::class,
            'getChat'                         => Chat::class,
            'getChatMember'                   => ChatMemberFactory::class,
            'getMyName'                       => BotName::class,
            'getMyDescription'                => BotDescription::class,
            'getMyShortDescription'           => BotShortDescription::class,
            'getChatMenuButton'               => MenuButtonFactory::class,
            'getMyDefaultAdministratorRights' => ChatAdministratorRights::class,
            'getStickerSet'                   => StickerSet::class,
            'stopPoll'                        => Poll::class,
            'answerWebAppQuery'               => SentWebAppMessage::class,
        ];

        $action       = Request::getCurrentAction();
        $object_class = $result_object_types[$action] ?? Message::class;

        // We don't need to save the raw_data of the response object!
        $result['raw_data'] = null;

        return Factory::resolveEntityClass($object_class, $result, $bot_username);
    }

    /**
     * Create and return the objects array of the received result
     *
     * @param array  $results
     * @param string $bot_username
     *
     * @return BotCommand[]|ChatMember[]|GameHighScore[]|Message[]|Sticker[]|Update[]
     */
    private function createResultObjects(array $results, string $bot_username): array
    {
        $result_object_types = [
            'getUpdates'                => Update::class,
            'getChatAdministrators'     => ChatMemberFactory::class,
            'getForumTopicIconStickers' => Sticker::class,
            'getMyCommands'             => BotCommand::class,
            'getCustomEmojiStickers'    => Sticker::class,
            'getGameHighScores'         => GameHighScore::class,
            'sendMediaGroup'            => Message::class,
        ];

        $action       = Request::getCurrentAction();
        $object_class = $result_object_types[$action] ?? Update::class;

        $objects = [];

        foreach ($results as $result) {
            // We don't need to save the raw_data of the response object!
            $result['raw_data'] = null;

            $objects[] = Factory::resolveEntityClass($object_class, $result, $bot_username);
        }

        return $objects;
    }
}