unreal4u\TelegramAPI\Telegram\Methods\AnswerPreCheckoutQuery

Complexity

Total Complexity

2

Size/Duplication

Total Lines	39
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

0%

Importance

Changes

0

1 Method

Rating	Name	Duplication	Size	Complexity
A	getMandatoryFields()	0	14	2

<?php

declare(strict_types = 1);

namespace unreal4u\TelegramAPI\Telegram\Methods;

use unreal4u\TelegramAPI\Abstracts\TelegramMethods;

/**
 * Once the user has confirmed their payment and shipping details, the Bot API sends the final confirmation in the form
 * of an Update with the field pre_checkout_query. Use this method to respond to such pre-checkout queries. On success,
 * True is returned. Note: The Bot API must receive an answer within 10 seconds after the pre-checkout query was sent
 *
 * Objects defined as-is May 2017
 *
 * @see https://core.telegram.org/bots/api#answerprecheckoutquery
 */
class AnswerPreCheckoutQuery extends TelegramMethods
{
    /**
     * Unique identifier for the query to be answered
     * @var string
     */
    public $pre_checkout_query_id = '';

    /**
     * Specify True if everything is alright (goods are available, etc.) and the bot is ready to proceed with the order.
     * Use False if there are any problems
     * @var bool
     */
    public $ok;

    /**
     * Required if ok is False. Error message in human readable form that explains the reason for failure to proceed
     * with the checkout (e.g. "Sorry, somebody just bought the last of our amazing black T-shirts while you were busy
     * filling out your payment details. Please choose a different color or garment!"). Telegram will display this
     * message to the user
     * @var string
     */
    public $error_message = '';

    public function getMandatoryFields(): array
    {
        $return = [
            'pre_checkout_query_id',
            'ok',
        ];

        // Shipping options are mandatory if ok is set to true, otherwise, error_message is
        if ($this->ok === false) {
            $return[] = 'error_message';
        }

        return $return;
    }
}