InputMediaDocument::__construct()   A
last analyzed

Complexity

Conditions 1
Paths 1

Size

Total Lines 4
Code Lines 2

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 0
CRAP Score 2

Importance

Changes 0
Metric Value
cc 1
eloc 2
c 0
b 0
f 0
nc 1
nop 1
dl 0
loc 4
ccs 0
cts 3
cp 0
crap 2
rs 10
1
<?php
2
3
/**
4
 * This file is part of the TelegramBot package.
5
 *
6
 * (c) Avtandil Kikabidze aka LONGMAN <[email protected]>
7
 *
8
 * For the full copyright and license information, please view the LICENSE
9
 * file that was distributed with this source code.
10
 */
11
12
namespace Longman\TelegramBot\Entities\InputMedia;
13
14
use Longman\TelegramBot\Entities\Entity;
15
16
/**
17
 * Class InputMediaDocument
18
 *
19
 * @link https://core.telegram.org/bots/api#inputmediadocument
20
 *
21
 * <code>
22
 * $data = [
23
 *   'media'      => '123abc',
24
 *   'thumbnail'  => '456def',
25
 *   'caption'    => '*Document* caption',
26
 *   'parse_mode' => 'markdown',
27
 * ];
28
 * </code>
29
 *
30
 * @method string          getType()                        Type of the result, must be document
31
 * @method string          getMedia()                       File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass "attach://<file_attach_name>" to upload a new one using multipart/form-data under <file_attach_name> name.
32
 * @method string          getThumbnail()                   Optional. Thumbnail of the file sent. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail‘s width and height should not exceed 90. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can’t be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More info on Sending Files »
33
 * @method string          getCaption()                     Optional. Caption of the document to be sent, 0-200 characters
34
 * @method string          getParseMode()                   Optional. Mode for parsing entities in the document caption
35
 * @method MessageEntity[] getCaptionEntities()             Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode
36
 * @method bool            getDisableContentTypeDetection() Optional. Disables automatic server-side content type detection for files uploaded using multipart/form-data. Always true, if the document is sent as part of an album.
37
 *
38
 * @method $this setMedia(string $media)                                              File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass "attach://<file_attach_name>" to upload a new one using multipart/form-data under <file_attach_name> name.
39
 * @method $this setThumbnail(string $thumbnail)                                      Optional. Thumbnail of the file sent. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail‘s width and height should not exceed 90. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can’t be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More info on Sending Files »
40
 * @method $this setCaption(string $caption)                                          Optional. Caption of the document to be sent, 0-200 characters
41
 * @method $this setParseMode(string $parse_mode)                                     Optional. Mode for parsing entities in the document caption
42
 * @method $this setCaptionEntities(array $caption_entities)                          Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode
43
 * @method $this setDisableContentTypeDetection(bool $disable_content_type_detection) Optional. Disables automatic server-side content type detection for files uploaded using multipart/form-data. Always true, if the document is sent as part of an album.
44
 */
45
class InputMediaDocument extends Entity implements InputMedia
46
{
47
    /**
48
     * InputMediaDocument constructor
49
     *
50
     * @param array $data
51
     */
52
    public function __construct(array $data = [])
53
    {
54
        $data['type'] = 'document';
55
        parent::__construct($data);
56
    }
57
}
58