DiscordPHP Documentation

FileUpload extends Interactive
in package

TODO.

Tags
link
TODO
since
10.21.0
@property

?int|null $min_values Minimum number of items that must be chosen (defaults to 1); min 0, max 10.

@property

?int|null $max_values Maximum number of items that can be chosen (defaults to 1); max 10.

@property

?bool|null $required Whether this component is required to be filled (defaults to true).

Table of Contents

Constants

TYPE_ACTION_ROW  = 1
TYPE_BUTTON  = 2
TYPE_CHANNEL_SELECT  = 8
TYPE_CONTAINER  = 17
TYPE_CONTENT_INVENTORY_ENTRY  = 16
TYPE_FILE  = 13
TYPE_FILE_UPLOAD  = 19
TYPE_LABEL  = 18
TYPE_MEDIA_GALLERY  = 12
TYPE_MENTIONABLE_SELECT  = 7
TYPE_ROLE_SELECT  = 6
TYPE_SECTION  = 9
TYPE_SELECT_MENU  = 3
TYPE_SEPARATOR  = 14
TYPE_STRING_SELECT  = 3
TYPE_TEXT_DISPLAY  = 10
TYPE_TEXT_INPUT  = 4
TYPE_THUMBNAIL  = 11
TYPE_USER_SELECT  = 5
USAGE  = ['Modal']

Properties

$custom_id  : string
Custom ID to send with interactive component.
$id  : int|null
32 bit integer used as an optional identifier for component.
$max_values  : int|null
Maximum number of files that can be uploaded.
$min_values  : int|null
Minimum number of files that can be uploaded.
$type  : int
Component type.

Methods

__construct()  : mixed
Creates a new button.
__get()  : mixed
Handles dynamic get calls onto the part.
__set()  : void
Handles dynamic set calls onto the part.
fromPart()  : self
Creates a new instance of the builder from a given Part.
getCustomId()  : string|null
Returns the custom ID of the button.
getType()  : int
Retrieves the type of the component.
jsonSerialize()  : array<string|int, mixed>
new()  : self
Creates a new file upload component.
setCustomId()  : $this
Sets the custom ID for the interactive component.
setMaxValues()  : $this
Sets the maximum number of options which must be chosen.
setMinValues()  : $this
Sets the minimum number of options which must be chosen.
setRequired()  : $this
Set if this component is required to be filled, default false. (Modal only).
generateUuid()  : string
Generates a UUID which can be used for component custom IDs.
getId()  : int|null
Retrieves the ID associated with the interactive component.
setId()  : self
The id field is optional and is used to identify components in the response from an interaction. The id must be unique within the message and is generated sequentially if left empty. Generation of ids won't use another id that exists in the message if you have one defined for another component. Sending components with an id of 0 is allowed but will be treated as empty and replaced by the API. 32 bit integer used as an optional identifier for component.
checkForGetMutator()  : string|false
Checks if there is a get mutator present.
checkForSetMutator()  : string|false
Checks if there is a set mutator present.
getProperty()  : mixed
Gets a property on the parent part.
setProperty()  : void
Sets an property on the parent part.
studly()  : string
Converts a string to studlyCase.

Constants

TYPE_ACTION_ROW

public mixed TYPE_ACTION_ROW = 1

TYPE_CHANNEL_SELECT

public mixed TYPE_CHANNEL_SELECT = 8

TYPE_CONTAINER

public mixed TYPE_CONTAINER = 17

TYPE_CONTENT_INVENTORY_ENTRY

public mixed TYPE_CONTENT_INVENTORY_ENTRY = 16

TYPE_FILE_UPLOAD

public mixed TYPE_FILE_UPLOAD = 19

TYPE_MEDIA_GALLERY

public mixed TYPE_MEDIA_GALLERY = 12

TYPE_MENTIONABLE_SELECT

public mixed TYPE_MENTIONABLE_SELECT = 7

TYPE_ROLE_SELECT

public mixed TYPE_ROLE_SELECT = 6

TYPE_SELECT_MENU

Use Component::TYPE_STRING_SELECT

public mixed TYPE_SELECT_MENU = 3

TYPE_SEPARATOR

public mixed TYPE_SEPARATOR = 14

TYPE_STRING_SELECT

public mixed TYPE_STRING_SELECT = 3

TYPE_TEXT_DISPLAY

public mixed TYPE_TEXT_DISPLAY = 10

TYPE_TEXT_INPUT

public mixed TYPE_TEXT_INPUT = 4

TYPE_THUMBNAIL

public mixed TYPE_THUMBNAIL = 11

TYPE_USER_SELECT

public mixed TYPE_USER_SELECT = 5

Properties

$custom_id

Custom ID to send with interactive component.

public string $custom_id

ID for the select menu; max 100 characters.

$id

32 bit integer used as an optional identifier for component.

protected int|null $id

$max_values

Maximum number of files that can be uploaded.

protected int|null $max_values

Default 1, maximum 10.

$min_values

Minimum number of files that can be uploaded.

protected int|null $min_values

Default 0, maximum 10.

$type

Component type.

protected int $type = \Discord\Builders\Components\Component::TYPE_FILE_UPLOAD

Methods

__construct()

Creates a new button.

public __construct([string|null $custom_id = null ]) : mixed
Parameters
$custom_id : string|null = null

custom ID of the button. If not given, a UUID will be used

Tags
throws
InvalidArgumentException

__get()

Handles dynamic get calls onto the part.

public __get(string $key) : mixed
Parameters
$key : string

The attributes key.

Tags
throws
Exception
see
self::getAttribute()

This function forwards onto getAttribute.

Return values
mixed —

The value of the attribute.

__set()

Handles dynamic set calls onto the part.

public __set(string $key, mixed $value) : void
Parameters
$key : string

The attributes key.

$value : mixed

The attributes value.

Tags
see
self::setAttribute()

This function forwards onto setAttribute.

fromPart()

Creates a new instance of the builder from a given Part.

public static fromPart(Part $part) : self
Parameters
$part : Part
Return values
self

getCustomId()

Returns the custom ID of the button.

public getCustomId() : string|null
Return values
string|null

getType()

Retrieves the type of the component.

public getType() : int
Return values
int

jsonSerialize()

public jsonSerialize() : array<string|int, mixed>
Tags
inheritDoc
Return values
array<string|int, mixed>

new()

Creates a new file upload component.

public static new([string $custom_id = null ]) : self
Parameters
$custom_id : string = null

ID for the file upload.

Return values
self

setCustomId()

Sets the custom ID for the interactive component.

public setCustomId(string|null $custom_id) : $this
Parameters
$custom_id : string|null
Tags
throws
LengthException

If the custom ID is longer than 100 characters.

Return values
$this

setMaxValues()

Sets the maximum number of options which must be chosen.

public setMaxValues(int|null $max_values) : $this
Parameters
$max_values : int|null

Default 1 and maximum 10. null to set as default.

Tags
throws
LengthException
Return values
$this

setMinValues()

Sets the minimum number of options which must be chosen.

public setMinValues(int|null $min_values) : $this
Parameters
$min_values : int|null

Default 1, minimum 0 and maximum 10. null to set as default.

Tags
throws
LengthException
Return values
$this

setRequired()

Set if this component is required to be filled, default false. (Modal only).

public setRequired([bool|null $required = null ]) : $this
Parameters
$required : bool|null = null
Return values
$this

generateUuid()

Generates a UUID which can be used for component custom IDs.

protected static generateUuid() : string
Return values
string

getId()

Retrieves the ID associated with the interactive component.

protected getId() : int|null

Always returns null as this component does not have an ID.

Return values
int|null

setId()

The id field is optional and is used to identify components in the response from an interaction. The id must be unique within the message and is generated sequentially if left empty. Generation of ids won't use another id that exists in the message if you have one defined for another component. Sending components with an id of 0 is allowed but will be treated as empty and replaced by the API. 32 bit integer used as an optional identifier for component.

protected setId([string|null $id = null ]) : self
Parameters
$id : string|null = null

32 bit integer used as an optional identifier for component.

Return values
self

checkForGetMutator()

Checks if there is a get mutator present.

private checkForGetMutator(string $key) : string|false
Parameters
$key : string

The property name to check.

Return values
string|false —

Either a string if it is a method or false.

checkForSetMutator()

Checks if there is a set mutator present.

private checkForSetMutator(string $key) : string|false
Parameters
$key : string

The property name to check.

Return values
string|false —

Either a string if it is a method or false.

getProperty()

Gets a property on the parent part.

private getProperty(string $key) : mixed
Parameters
$key : string

The name of the property.

Tags
throws
Exception
Return values
mixed —

Either the property if it exists or void.

setProperty()

Sets an property on the parent part.

private setProperty(string $key, mixed $value) : void
Parameters
$key : string

The name of the property.

$value : mixed

The value of the property.

studly()

Converts a string to studlyCase.

private static studly(string $string) : string

This is a port of updated Laravel's implementation, a non-regex with static cache. This method is private static as we may move it outside this class in future.

Parameters
$string : string

The string to convert.

Tags
since
10.0.0
Return values
string 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results