Photo::getCaption() - Code Metrics - Inspection of "Refactoring article inline type" - TelegramBot/Api - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( e9eebf...b866da )

by Gusev

created 2016-04-15 00:00 UTC

Photo::getCaption() A

↳ Parent: Photo

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	4
Ratio	100 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	4
loc	4
rs	10
cc	1
eloc	2
nc	1
nop	0

<?php

namespace TelegramBot\Api\Types\Inline\QueryResult;

/**
 * Class InlineQueryResultPhoto
 * Represents a link to a photo. By default, this photo will be sent by the user with optional caption.
 * Alternatively, you can provide message_text to send it instead of photo.
 *
 * @package TelegramBot\Api\Types\Inline
 */
class Photo extends AbstractInlineQueryResult

{
    /**
     * {@inheritdoc}
     *
     * @var array
     */
    static protected $requiredParams = ['type', 'id', 'photo_url', 'thumb_url'];

    /**
     * {@inheritdoc}
     *
     * @var array
     */
    static protected $map = [
        'type' => true,
        'id' => true,
        'photo_url' => true,
        'mime_type' => true,
        'photo_width' => true,
        'photo_height' => true,
        'thumb_url' => true,
        'title' => true,
        'description' => true,
        'caption' => true,
        'message_text' => true,
        'parse_mode' => true,
        'disable_web_page_preview' => true,
    ];

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

    /**
     * A valid URL of the photo. Photo size must not exceed 5MB
     *
     * @var string
     */
    protected $photoUrl;

    /**
     * Optional. MIME type of the photo, defaults to image/jpeg
     *
     * @var string
     */
    protected $mimeType;

    /**
     * Optional. Width of the photo
     *
     * @var int
     */
    protected $photoWidth;

    /**
     * Optional. Height of the photo
     *
     * @var int
     */
    protected $photoHeight;

    /**
     * URL of the thumbnail for the photo
     *
     * @var
     */
    protected $thumbUrl;

    /**
     * Optional. Short description of the result
     *
     * @var string
     */
    protected $description;

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

    /**
     * InlineQueryResultPhoto constructor.
     *
     * @param string $id
     * @param string $photoUrl
     * @param string $thumbUrl
     * @param string|null $mimeType
     * @param int|null $photoWidth
     * @param int|null $photoHeight
     * @param string|null $title
     * @param string|null $description
     * @param string|null $caption
     * @param string|null $messageText
     * @param string|null $parseMode
     * @param bool|null $disableWebPagePreview
     */
    public function __construct(
        $id,
        $photoUrl,
        $thumbUrl,
        $mimeType = null,
        $photoWidth = null,
        $photoHeight = null,
        $title = null,
        $description = null,
        $caption = null,
        $messageText = null,
        $parseMode = null,
        $disableWebPagePreview = null
    ) {
        parent::__construct($id, $title, $messageText, $parseMode, $disableWebPagePreview);


        $this->photoUrl = $photoUrl;
        $this->thumbUrl = $thumbUrl;
        $this->mimeType = $mimeType;
        $this->photoWidth = $photoWidth;
        $this->photoHeight = $photoHeight;
        $this->description = $description;
        $this->caption = $caption;
    }


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

    /**
     * @param string $photoUrl
     */
    public function setPhotoUrl($photoUrl)
    {
        $this->photoUrl = $photoUrl;
    }

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

    /**
     * @param string $mimeType
     */
    public function setMimeType($mimeType)
    {
        $this->mimeType = $mimeType;
    }

    /**
     * @return int
     */
    public function getPhotoWidth()
    {
        return $this->photoWidth;
    }

    /**
     * @param int $photoWidth
     */
    public function setPhotoWidth($photoWidth)
    {
        $this->photoWidth = $photoWidth;
    }

    /**
     * @return int
     */
    public function getPhotoHeight()
    {
        return $this->photoHeight;
    }

    /**
     * @param int $photoHeight
     */
    public function setPhotoHeight($photoHeight)
    {
        $this->photoHeight = $photoHeight;
    }

    /**
     * @return mixed
     */
    public function getThumbUrl()
    {
        return $this->thumbUrl;
    }

    /**
     * @param mixed $thumbUrl
     */
    public function setThumbUrl($thumbUrl)
    {
        $this->thumbUrl = $thumbUrl;
    }

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

    /**
     * @param string $description
     */
    public function setDescription($description)
    {
        $this->description = $description;
    }

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

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


1		<?php
2
3		namespace TelegramBot\Api\Types\Inline\QueryResult;
4
5		/**
6		* Class InlineQueryResultPhoto
7		* Represents a link to a photo. By default, this photo will be sent by the user with optional caption.
8		* Alternatively, you can provide message_text to send it instead of photo.
9		*
10		* @package TelegramBot\Api\Types\Inline
11		*/
12	View Code Duplication	class Photo extends AbstractInlineQueryResult
		0 ignored issues – show Duplication introduced 2016-01-05 19:15 UTC by Report Bug Copy Issue Report This class seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
13		{
14		/**
15		* {@inheritdoc}
16		*
17		* @var array
18		*/
19		static protected $requiredParams = ['type', 'id', 'photo_url', 'thumb_url'];
20
21		/**
22		* {@inheritdoc}
23		*
24		* @var array
25		*/
26		static protected $map = [
27		'type' => true,
28		'id' => true,
29		'photo_url' => true,
30		'mime_type' => true,
31		'photo_width' => true,
32		'photo_height' => true,
33		'thumb_url' => true,
34		'title' => true,
35		'description' => true,
36		'caption' => true,
37		'message_text' => true,
38		'parse_mode' => true,
39		'disable_web_page_preview' => true,
40		];
41
42		/**
43		* {@inheritdoc}
44		*
45		* @var string
46		*/
47		protected $type = 'photo';
48
49		/**
50		* A valid URL of the photo. Photo size must not exceed 5MB
51		*
52		* @var string
53		*/
54		protected $photoUrl;
55
56		/**
57		* Optional. MIME type of the photo, defaults to image/jpeg
58		*
59		* @var string
60		*/
61		protected $mimeType;
62
63		/**
64		* Optional. Width of the photo
65		*
66		* @var int
67		*/
68		protected $photoWidth;
69
70		/**
71		* Optional. Height of the photo
72		*
73		* @var int
74		*/
75		protected $photoHeight;
76
77		/**
78		* URL of the thumbnail for the photo
79		*
80		* @var
81		*/
82		protected $thumbUrl;
83
84		/**
85		* Optional. Short description of the result
86		*
87		* @var string
88		*/
89		protected $description;
90
91		/**
92		* Optional. Caption of the photo to be sent, 0-200 characters
93		*
94		* @var string
95		*/
96		protected $caption;
97
98		/**
99		* InlineQueryResultPhoto constructor.
100		*
101		* @param string $id
102		* @param string $photoUrl
103		* @param string $thumbUrl
104		* @param string\|null $mimeType
105		* @param int\|null $photoWidth
106		* @param int\|null $photoHeight
107		* @param string\|null $title
108		* @param string\|null $description
109		* @param string\|null $caption
110		* @param string\|null $messageText
111		* @param string\|null $parseMode
112		* @param bool\|null $disableWebPagePreview
113		*/
114		public function __construct(
115		$id,
116		$photoUrl,
117		$thumbUrl,
118		$mimeType = null,
119		$photoWidth = null,
120		$photoHeight = null,
121		$title = null,
122		$description = null,
123		$caption = null,
124		$messageText = null,
125		$parseMode = null,
126		$disableWebPagePreview = null
127		) {
128		parent::__construct($id, $title, $messageText, $parseMode, $disableWebPagePreview);
		0 ignored issues – show Bug introduced 2016-04-15 00:03 UTC by Report Bug Copy Issue Report It seems like `$messageText` defined by parameter `$messageText` on line 124 can also be of type `string`; however, `TelegramBot\Api\Types\In...ryResult::__construct()` does only seem to accept `object<TelegramBot\Api\T...putMessageContent>\|null`, maybe add an additional type check? This check looks at variables that have been passed in as parameters and are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history... Bug introduced 2016-04-15 00:03 UTC by Report Bug Copy Issue Report It seems like `$parseMode` defined by parameter `$parseMode` on line 125 can also be of type `string`; however, `TelegramBot\Api\Types\In...ryResult::__construct()` does only seem to accept `object<TelegramBot\Api\T...ineKeyboardMarkup>\|null`, maybe add an additional type check? This check looks at variables that have been passed in as parameters and are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history... Unused Code introduced 2016-04-15 00:03 UTC by Report Bug Copy Issue Report The call to `AbstractInlineQueryResult::__construct()` has too many arguments starting with `$disableWebPagePreview`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history...
129
130		$this->photoUrl = $photoUrl;
131		$this->thumbUrl = $thumbUrl;
132		$this->mimeType = $mimeType;
133		$this->photoWidth = $photoWidth;
134		$this->photoHeight = $photoHeight;
135		$this->description = $description;
136		$this->caption = $caption;
137		}
138
139
140		/**
141		* @return string
142		*/
143		public function getPhotoUrl()
144		{
145		return $this->photoUrl;
146		}
147
148		/**
149		* @param string $photoUrl
150		*/
151		public function setPhotoUrl($photoUrl)
152		{
153		$this->photoUrl = $photoUrl;
154		}
155
156		/**
157		* @return string
158		*/
159		public function getMimeType()
160		{
161		return $this->mimeType;
162		}
163
164		/**
165		* @param string $mimeType
166		*/
167		public function setMimeType($mimeType)
168		{
169		$this->mimeType = $mimeType;
170		}
171
172		/**
173		* @return int
174		*/
175		public function getPhotoWidth()
176		{
177		return $this->photoWidth;
178		}
179
180		/**
181		* @param int $photoWidth
182		*/
183		public function setPhotoWidth($photoWidth)
184		{
185		$this->photoWidth = $photoWidth;
186		}
187
188		/**
189		* @return int
190		*/
191		public function getPhotoHeight()
192		{
193		return $this->photoHeight;
194		}
195
196		/**
197		* @param int $photoHeight
198		*/
199		public function setPhotoHeight($photoHeight)
200		{
201		$this->photoHeight = $photoHeight;
202		}
203
204		/**
205		* @return mixed
206		*/
207		public function getThumbUrl()
208		{
209		return $this->thumbUrl;
210		}
211
212		/**
213		* @param mixed $thumbUrl
214		*/
215		public function setThumbUrl($thumbUrl)
216		{
217		$this->thumbUrl = $thumbUrl;
218		}
219
220		/**
221		* @return string
222		*/
223		public function getDescription()
224		{
225		return $this->description;
226		}
227
228		/**
229		* @param string $description
230		*/
231		public function setDescription($description)
232		{
233		$this->description = $description;
234		}
235
236		/**
237		* @return string
238		*/
239		public function getCaption()
240		{
241		return $this->caption;
242		}
243
244		/**
245		* @param string $caption
246		*/
247		public function setCaption($caption)
248		{
249		$this->caption = $caption;
250		}
251		}
252

TelegramBot / Api

Push — master ( e9eebf...b866da )

Photo::getCaption() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like