unreal4u\TelegramAPI\Telegram\Types\Custom\UnsuccessfulRequest

Complexity

Total Complexity

2

Size/Duplication

Total Lines	40
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	2

Test Coverage

Coverage

0%

Importance

Changes

0

1 Method

Rating	Name	Duplication	Size	Complexity
A	mapSubObjects()	0	10	2

<?php
declare(strict_types = 1);

namespace unreal4u\TelegramAPI\Telegram\Types\Custom;

use unreal4u\TelegramAPI\Abstracts\TelegramTypes;
use unreal4u\TelegramAPI\Telegram\Types\ResponseParameters;

/**
 * Not being used by the package itself, but useful for some bots to initialize if no response is actually expected
 */
class UnsuccessfulRequest extends TelegramTypes
{
    /**
     * Per definition, this will always be false, as this is an unsuccessful request
     * @var bool
     */
    public $ok = false;

    /**
     * An Integer ‘error_code’ field is returned, but its contents are subject to change in the future
     * @var int
     */
    public $error_code = 0;

    /**
     * In case of an unsuccessful request, ‘ok’ equals false and the error is explained in the ‘description’
     * @var string
     */
    public $description = '';

    /**
     * Some errors may also have an optional field ‘parameters’ of the type ResponseParameters, which can help to
     * automatically handle the error
     *
     * @see ResponseParameters
     * @var ResponseParameters
     */
    public $parameters = null;

    protected function mapSubObjects(string $key, array $data): TelegramTypes
    {
        switch ($key) {
            case 'parameters':
                return new ResponseParameters($data, $this->logger);
        }

        // Return always null if none of the objects above matches
        return parent::mapSubObjects($key, $data);
    }
}