BPT\types\sticker

Complexity

Total Complexity

4

Size/Duplication

Total Lines	97
Duplicated Lines	0 %

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	download()	0	2	1
A	__construct()	0	3	2
A	link()	0	2	1

<?php

namespace BPT\types;

use BPT\telegram\telegram;
use stdClass;

/**
 * This object represents a sticker.
 */
class sticker extends types {

The type BPT\types\types was not found. Maybe you did not declare it correctly or list all dependencies?

    /** Keep all of properties which has sub properties */
    private const subs = [
        'thumbnail' => 'BPT\types\photoSize',
        'premium_animation' => 'BPT\types\file',
        'mask_position' => 'BPT\types\maskPosition',
    ];

    /** Identifier for this file, which can be used to download or reuse the file */
    public string $file_id;

    /**
     * Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be
     * used to download or reuse the file.
     */
    public string $file_unique_id;

    /**
     * Type of the sticker, currently one of “regular”, “mask”, “custom_emoji”. The type of the sticker is
     * independent from its format, which is determined by the fields is_animated and is_video.
     */
    public string $type;

    /** Sticker width */
    public int $width;

    /** Sticker height */
    public int $height;

    /** True, if the sticker is animated */
    public null|bool $is_animated = null;

    /** True, if the sticker is a video sticker */
    public null|bool $is_video = null;

    /** Optional. Sticker thumbnail in the .WEBP or .JPG format */
    public null|photoSize $thumbnail = null;

    /** Optional. Emoji associated with the sticker */
    public null|string $emoji = null;

    /** Optional. Name of the sticker set to which the sticker belongs */
    public null|string $set_name = null;

    /** Optional. Premium animation for the sticker, if the sticker is premium */
    public null|file $premium_animation = null;

    /** Optional. For mask stickers, the position where the mask should be placed */
    public null|maskPosition $mask_position = null;

    /** Optional. For custom emoji stickers, unique identifier of the custom emoji */
    public string $custom_emoji_id;

    /**
     * Optional. True, if the sticker must be repainted to a text color in messages, the color of the Telegram
     * Premium badge in emoji status, white color on chat photos, or another appropriate color in other places
     */
    public bool $needs_repainting;

    /** Optional. File size in bytes */
    public null|int $file_size = null;


    public function __construct(stdClass|null $object = null) {
        if ($object != null) {
            parent::__construct($object, self::subs);
        }
    }

    /**
     * download this file and save it in destination
     *
     * if destination doesn't set , it will return the downloaded file(as string)
     *
     * It has 20MB download limit(same as telegram)
     *
     * e.g. => $sticker->download();
     *
     * e.g. => $sticker->download('test.png');
     *
     * @param string|null $destination destination for save the file
     *
     * @return bool|string string will be returned when destination doesn't set
     */
    public function download(string|null $destination = null): bool|string {
        return telegram::downloadFile($destination ?? 'unknown.png',$this->file_id);
    }

    /**
     * Get download link of this file
     *
     * It does not bypass telegram limits(e.g: Download size limit in public bot api)
     *
     * @return string
     */
    public function link(): string {
        return telegram::fileLink($this->file_id);
    }
}