Gif::getCaption() - Code Metrics - Inspection of "Merge pull request #433 from BoShurik/attachments" - TelegramBot/Api - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( e5cded...a829ef )

by Alexander

created 2023-06-27 12:47 UTC

Gif::getCaption() A

↳ Parent: Gif

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
eloc	1
c	0
b	0
f	0
dl	0
loc	3
ccs	0
cts	0
cp	0
rs	10
cc	1
nc	1
nop	0
crap	2

<?php

namespace TelegramBot\Api\Types\Inline\QueryResult;

use TelegramBot\Api\Types\Inline\InlineKeyboardMarkup;
use TelegramBot\Api\Types\Inline\InputMessageContent;

/**
 * Class InlineQueryResultGif
 * Represents a link to an animated GIF file.
 * By default, this animated GIF file will be sent by the user with optional caption.
 * Alternatively, you can provide InputMessageContent to send it instead of the animation.
 *
 * @package TelegramBot\Api\Types\Inline
 */
class Gif extends AbstractInlineQueryResult
{
    /**
     * {@inheritdoc}
     *
     * @var array
     */
    protected static $requiredParams = ['type', 'id', 'gif_url', 'thumbnail_url'];

    /**
     * {@inheritdoc}
     *
     * @var array
     */
    protected static $map = [
        'type' => true,
        'id' => true,
        'gif_url' => true,
        'gif_width' => true,
        'gif_height' => true,
        'thumbnail_url' => true,
        'title' => true,
        'caption' => true,
        'reply_markup' => InlineKeyboardMarkup::class,
        'input_message_content' => InputMessageContent::class,
    ];

    /**
     * {@inheritdoc}
     *
     * @var string
     */
    protected $type = 'gif';

    /**
     * A valid URL for the GIF file. File size must not exceed 1MB
     *
     * @var string
     */
    protected $gifUrl;

    /**
     * Optional. Width of the GIF
     *
     * @var int|null
     */
    protected $gifWidth;

    /**
     * Optional. Height of the GIF
     *
     * @var int|null
     */
    protected $gifHeight;

    /**
     * URL of the static thumbnail for the result (jpeg or gif)
     *
     * @var string
     */
    protected $thumbnailUrl;

    /**
     * Optional. Caption of the GIF file to be sent, 0-200 characters
     *
     * @var string|null
     */
    protected $caption;

    /**
     * InlineQueryResultGif constructor.
     *
     * @param string $id
     * @param string $gifUrl
     * @param string|null $thumbnailUrl
     * @param int|null $gifWidth
     * @param int|null $gifHeight
     * @param string|null $title
     * @param string|null $caption
     * @param InputMessageContent $inputMessageContent
     * @param InlineKeyboardMarkup|null $inlineKeyboardMarkup
     */
    public function __construct(
        $id,
        $gifUrl,
        $thumbnailUrl = null,
        $title = null,
        $caption = null,
        $gifWidth = null,
        $gifHeight = null,
        $inputMessageContent = null,
        $inlineKeyboardMarkup = null
    ) {
        parent::__construct($id, $title, $inputMessageContent, $inlineKeyboardMarkup);

        $this->gifUrl = $gifUrl;
        $this->thumbnailUrl = is_null($thumbnailUrl) ? $gifUrl : $thumbnailUrl;
        $this->gifWidth = $gifWidth;
        $this->gifHeight = $gifHeight;
        $this->caption = $caption;
    }

    /**
     * @return string
     */
    public function getGifUrl()
    {
        return $this->gifUrl;
    }

    /**
     * @param string $gifUrl
     *
     * @return void
     */
    public function setGifUrl($gifUrl)
    {
        $this->gifUrl = $gifUrl;
    }

    /**
     * @return int|null
     */
    public function getGifWidth()
    {
        return $this->gifWidth;
    }

    /**
     * @param int|null $gifWidth
     *
     * @return void
     */
    public function setGifWidth($gifWidth)
    {
        $this->gifWidth = $gifWidth;
    }

    /**
     * @return int|null
     */
    public function getGifHeight()
    {
        return $this->gifHeight;
    }

    /**
     * @param int|null $gifHeight
     *
     * @return void
     */
    public function setGifHeight($gifHeight)
    {
        $this->gifHeight = $gifHeight;
    }

    /**
     * @return string
     */
    public function getThumbnailUrl()
    {
        return $this->thumbnailUrl;
    }

    /**
     * @param string $thumbnailUrl
     *
     * @return void
     */
    public function setThumbnailUrl($thumbnailUrl)
    {
        $this->thumbnailUrl = $thumbnailUrl;
    }

    /**
     * @deprecated Use getThumbnailUrl
     *
     * @return string
     */
    public function getThumbUrl()
    {
        return $this->getThumbnailUrl();
    }

    /**
     * @deprecated Use setThumbnailUrl
     *
     * @param string $thumbUrl
     *
     * @return void
     */
    public function setThumbUrl($thumbUrl)
    {
        $this->setThumbnailUrl($thumbUrl);
    }

    /**
     * @return string|null
     */
    public function getCaption()
    {
        return $this->caption;
    }

    /**
     * @param string|null $caption
     *
     * @return void
     */
    public function setCaption($caption)
    {
        $this->caption = $caption;
    }
}


1			<?php
2
3			namespace TelegramBot\Api\Types\Inline\QueryResult;
4
5			use TelegramBot\Api\Types\Inline\InlineKeyboardMarkup;
6			use TelegramBot\Api\Types\Inline\InputMessageContent;
7
8			/**
9			* Class InlineQueryResultGif
10			* Represents a link to an animated GIF file.
11			* By default, this animated GIF file will be sent by the user with optional caption.
12			* Alternatively, you can provide InputMessageContent to send it instead of the animation.
13			*
14			* @package TelegramBot\Api\Types\Inline
15			*/
16			class Gif extends AbstractInlineQueryResult
17			{
18			/**
19			* {@inheritdoc}
20			*
21			* @var array
22			*/
23			protected static $requiredParams = ['type', 'id', 'gif_url', 'thumbnail_url'];
24
25			/**
26			* {@inheritdoc}
27			*
28			* @var array
29			*/
30			protected static $map = [
31			'type' => true,
32			'id' => true,
33			'gif_url' => true,
34			'gif_width' => true,
35			'gif_height' => true,
36			'thumbnail_url' => true,
37			'title' => true,
38			'caption' => true,
39			'reply_markup' => InlineKeyboardMarkup::class,
40			'input_message_content' => InputMessageContent::class,
41			];
42
43			/**
44			* {@inheritdoc}
45			*
46			* @var string
47			*/
48			protected $type = 'gif';
49
50			/**
51			* A valid URL for the GIF file. File size must not exceed 1MB
52			*
53			* @var string
54			*/
55			protected $gifUrl;
56
57			/**
58			* Optional. Width of the GIF
59			*
60			* @var int\|null
61			*/
62			protected $gifWidth;
63
64			/**
65			* Optional. Height of the GIF
66			*
67			* @var int\|null
68			*/
69			protected $gifHeight;
70
71			/**
72			* URL of the static thumbnail for the result (jpeg or gif)
73			*
74			* @var string
75			*/
76			protected $thumbnailUrl;
77
78			/**
79			* Optional. Caption of the GIF file to be sent, 0-200 characters
80			*
81			* @var string\|null
82			*/
83			protected $caption;
84
85			/**
86			* InlineQueryResultGif constructor.
87			*
88			* @param string $id
89			* @param string $gifUrl
90			* @param string\|null $thumbnailUrl
91			* @param int\|null $gifWidth
92			* @param int\|null $gifHeight
93			* @param string\|null $title
94			* @param string\|null $caption
95			* @param InputMessageContent $inputMessageContent
96			* @param InlineKeyboardMarkup\|null $inlineKeyboardMarkup
97			*/
98			public function __construct(
99			$id,
100			$gifUrl,
101			$thumbnailUrl = null,
102			$title = null,
103			$caption = null,
104			$gifWidth = null,
105			$gifHeight = null,
106			$inputMessageContent = null,
107			$inlineKeyboardMarkup = null
108			) {
109			parent::__construct($id, $title, $inputMessageContent, $inlineKeyboardMarkup);
110
111			$this->gifUrl = $gifUrl;
112			$this->thumbnailUrl = is_null($thumbnailUrl) ? $gifUrl : $thumbnailUrl;
113			$this->gifWidth = $gifWidth;
114			$this->gifHeight = $gifHeight;
115			$this->caption = $caption;
116			}
117
118			/**
119			* @return string
120			*/
121			public function getGifUrl()
122			{
123			return $this->gifUrl;
124			}
125
126			/**
127			* @param string $gifUrl
128			*
129			* @return void
130			*/
131			public function setGifUrl($gifUrl)
132			{
133			$this->gifUrl = $gifUrl;
134			}
135
136			/**
137			* @return int\|null
138			*/
139			public function getGifWidth()
140			{
141			return $this->gifWidth;
142			}
143
144			/**
145			* @param int\|null $gifWidth
146			*
147			* @return void
148			*/
149			public function setGifWidth($gifWidth)
150			{
151			$this->gifWidth = $gifWidth;
152			}
153
154			/**
155			* @return int\|null
156			*/
157			public function getGifHeight()
158			{
159			return $this->gifHeight;
160			}
161
162			/**
163			* @param int\|null $gifHeight
164			*
165			* @return void
166			*/
167			public function setGifHeight($gifHeight)
168			{
169			$this->gifHeight = $gifHeight;
170			}
171
172			/**
173			* @return string
174			*/
175			public function getThumbnailUrl()
176			{
177			return $this->thumbnailUrl;
178			}
179
180			/**
181			* @param string $thumbnailUrl
182			*
183			* @return void
184			*/
185			public function setThumbnailUrl($thumbnailUrl)
186			{
187			$this->thumbnailUrl = $thumbnailUrl;
188			}
189
190			/**
191			* @deprecated Use getThumbnailUrl
192			*
193			* @return string
194			*/
195			public function getThumbUrl()
196			{
197			return $this->getThumbnailUrl();
198			}
199
200			/**
201			* @deprecated Use setThumbnailUrl
202			*
203			* @param string $thumbUrl
204			*
205			* @return void
206			*/
207			public function setThumbUrl($thumbUrl)
208			{
209			$this->setThumbnailUrl($thumbUrl);
210			}
211
212			/**
213			* @return string\|null
214			*/
215			public function getCaption()
216			{
217			return $this->caption;
218			}
219
220			/**
221			* @param string\|null $caption
222			*
223			* @return void
224			*/
225			public function setCaption($caption)
226			{
227			$this->caption = $caption;
228			}
229			}
230

TelegramBot / Api

Push — master ( e5cded...a829ef )

Gif::getCaption() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like