DiscordPHP Documentation

UserSelect extends SelectMenu
in package

Application

A User Select is an interactive component that allows users to select one or more users in a message. Options are automatically populated based on the server's available users.

User Selects can be configured for both single-select and multi-select behavior. When a user finishes making their choice(s) your app receives an interaction.

User Selects must be placed inside an Action Row and are only available in messages. An Action Row can contain only one select menu and cannot contain buttons if it has a select menu.

Constants

TYPES = [ 0 => \Discord\Parts\Channel\Message\Component::class, // Fallback for unknown types \Discord\Builders\Components\Component::TYPE_ACTION_ROW => \Discord\Parts\Channel\Message\ActionRow::class, \Discord\Builders\Components\Component::TYPE_BUTTON => \Discord\Parts\Channel\Message\Button::class, \Discord\Builders\Components\Component::TYPE_STRING_SELECT => \Discord\Parts\Channel\Message\StringSelect::class, \Discord\Builders\Components\Component::TYPE_TEXT_INPUT => \Discord\Parts\Channel\Message\TextInput::class, \Discord\Builders\Components\Component::TYPE_USER_SELECT => \Discord\Parts\Channel\Message\UserSelect::class, \Discord\Builders\Components\Component::TYPE_ROLE_SELECT => \Discord\Parts\Channel\Message\RoleSelect::class, \Discord\Builders\Components\Component::TYPE_MENTIONABLE_SELECT => \Discord\Parts\Channel\Message\MentionableSelect::class, \Discord\Builders\Components\Component::TYPE_CHANNEL_SELECT => \Discord\Parts\Channel\Message\ChannelSelect::class, \Discord\Builders\Components\Component::TYPE_SECTION => \Discord\Parts\Channel\Message\Section::class, \Discord\Builders\Components\Component::TYPE_TEXT_DISPLAY => \Discord\Parts\Channel\Message\TextDisplay::class, \Discord\Builders\Components\Component::TYPE_THUMBNAIL => \Discord\Parts\Channel\Message\Thumbnail::class, \Discord\Builders\Components\Component::TYPE_MEDIA_GALLERY => \Discord\Parts\Channel\Message\MediaGallery::class, \Discord\Builders\Components\Component::TYPE_FILE => \Discord\Parts\Channel\Message\File::class, \Discord\Builders\Components\Component::TYPE_SEPARATOR => \Discord\Parts\Channel\Message\Separator::class, \Discord\Builders\Components\Component::TYPE_CONTAINER => \Discord\Parts\Channel\Message\Container::class, ]: Available components and their respective classes.

Properties

$created : bool: Is the part already created in the Discord servers?
$custom_id : string
$custom_id : string
$default_values : ExCollectionInterface|array<string|int, DefaultValue>|null
$disabled : bool|null
$id : string|null
$id : string|null
$id : string|null
$max_values : int|null
$min_values : int|null
$placeholder : string|null
$scriptData : mixed: Custom script data.
$type : int
$type : int
$type : int
$attributes : array<string|int, mixed>: The parts attributes.
$discord : Discord: The Discord client.
$factory : Factory: The factory.
$fillable : mixed: {@inheritDoc}
$hidden : array<string|int, mixed>: Attributes that are hidden from debug info.
$http : Http: The HTTP client.
$repositories : array<string|int, mixed>: An array of repositories that can exist in a part.
$repositories_cache : array<string|int, mixed>: An array of repositories.
$visible : array<string|int, mixed>: Attributes which are visible from debug info.

Methods

__construct() : mixed: Create a new part instance.
__debugInfo() : array<string|int, mixed>
__get() : mixed: Handles dynamic get calls onto the part.
__serialize() : array<string|int, mixed>
__set() : void: Handles dynamic set calls onto the part.
__toString() : string: Converts the part to a string.
__unserialize() : void
fetch() : PromiseInterface<string|int, static>: Fetches any missing information about the part from Discord's servers.
fill() : void: Fills the parts attributes from an array.
getCreatableAttributes() : array<string|int, mixed>: Returns the attributes needed to create.
getDiscord() : Discord: Get the Discord instance that owns this Part.
getPublicAttributes() : array<string|int, mixed>: Returns an array of public attributes.
getRawAttributes() : array<string|int, mixed>: Returns an array of raw attributes.
getRepositoryAttributes() : array<string|int, mixed>: Gets the attributes to pass to repositories.
getUpdatableAttributes() : array<string|int, mixed>: Returns the updatable attributes.
isPartial() : bool: Whether the part is considered partial i.e. missing information which can be fetched from Discord.
jsonSerialize() : array<string|int, mixed>: Provides data when the part is encoded into JSON. Used for JsonSerializable.
offsetExists() : bool: Checks if an attribute exists via key. Used for ArrayAccess.
offsetGet() : mixed: Gets an attribute via key. Used for ArrayAccess.
offsetSet() : void: Sets an attribute via key. Used for ArrayAccess.
offsetUnset() : void: Unsets an attribute via key. Used for ArrayAccess.
serialize() : string|null: Serializes the data. Used for Serializable.
unserialize() : void: Unserializes some data and stores it. Used for Serializable.
afterConstruct() : void: Called after the part has been constructed.
getComponentsAttribute() : ExCollectionInterface|array<string|int, Component>|null: Gets the components of the interaction.
getDefaultValuesAttribute() : ExCollectionInterface|null
makeOptionalAttributes() : array<string|int, mixed>: Return key-value attributes if it has been filled.
checkForGetMutator() : string|false: Checks if there is a get mutator present.
checkForSetMutator() : string|false: Checks if there is a set mutator present.
getAttribute() : mixed: Gets an attribute on the part.
setAttribute() : void: Sets an attribute on the part.
studly() : string: Converts a string to studlyCase.

TYPES

Available components and their respective classes.


    public
        array<int, string>
    TYPES
    = [
    0 => \Discord\Parts\Channel\Message\Component::class,
    // Fallback for unknown types
    \Discord\Builders\Components\Component::TYPE_ACTION_ROW => \Discord\Parts\Channel\Message\ActionRow::class,
    \Discord\Builders\Components\Component::TYPE_BUTTON => \Discord\Parts\Channel\Message\Button::class,
    \Discord\Builders\Components\Component::TYPE_STRING_SELECT => \Discord\Parts\Channel\Message\StringSelect::class,
    \Discord\Builders\Components\Component::TYPE_TEXT_INPUT => \Discord\Parts\Channel\Message\TextInput::class,
    \Discord\Builders\Components\Component::TYPE_USER_SELECT => \Discord\Parts\Channel\Message\UserSelect::class,
    \Discord\Builders\Components\Component::TYPE_ROLE_SELECT => \Discord\Parts\Channel\Message\RoleSelect::class,
    \Discord\Builders\Components\Component::TYPE_MENTIONABLE_SELECT => \Discord\Parts\Channel\Message\MentionableSelect::class,
    \Discord\Builders\Components\Component::TYPE_CHANNEL_SELECT => \Discord\Parts\Channel\Message\ChannelSelect::class,
    \Discord\Builders\Components\Component::TYPE_SECTION => \Discord\Parts\Channel\Message\Section::class,
    \Discord\Builders\Components\Component::TYPE_TEXT_DISPLAY => \Discord\Parts\Channel\Message\TextDisplay::class,
    \Discord\Builders\Components\Component::TYPE_THUMBNAIL => \Discord\Parts\Channel\Message\Thumbnail::class,
    \Discord\Builders\Components\Component::TYPE_MEDIA_GALLERY => \Discord\Parts\Channel\Message\MediaGallery::class,
    \Discord\Builders\Components\Component::TYPE_FILE => \Discord\Parts\Channel\Message\File::class,
    \Discord\Builders\Components\Component::TYPE_SEPARATOR => \Discord\Parts\Channel\Message\Separator::class,
    \Discord\Builders\Components\Component::TYPE_CONTAINER => \Discord\Parts\Channel\Message\Container::class,
]

$created

Is the part already created in the Discord servers?


    public
        bool
    $created
     = false

Whether the part has been created.

$custom_id


    public
        string
    $custom_id

Developer-defined identifier, max 100 characters

$custom_id


    public
        string
    $custom_id

ID for the select menu; max 100 characters

$default_values


    public
        ExCollectionInterface|array<string|int, DefaultValue>|null
    $default_values

List of default values for auto-populated select menu components; number of default values must be in the range defined by min_values and max_values

$disabled


    public
        bool|null
    $disabled

Whether select menu is disabled (defaults to false).

$id


    public
        string|null
    $id

32 bit integer used as an optional identifier for component.

$id


    public
        string|null
    $id

32 bit integer used as an optional identifier for component.

$id


    public
        string|null
    $id

Optional identifier for component.

$max_values


    public
        int|null
    $max_values

Maximum number of items that can be chosen (defaults to 1); max 25.

$min_values


    public
        int|null
    $min_values

Minimum number of items that must be chosen (defaults to 1); min 0, max 25.

$placeholder


    public
        string|null
    $placeholder

Placeholder text if nothing is selected; max 150 characters.

$scriptData

Custom script data.

Relying on this variable with dynamic caching is discouraged.


    public
        mixed
    $scriptData

Used for storing custom information, used by end products.

$type


    public
        int
    $type

The type of the component.

$type


    public
        int
    $type

The type of the component.

$type


    public
        int
    $type

5 for user select.

$attributes

The parts attributes.


    protected
        array<string|int, mixed>
    $attributes
     = []

The parts attributes and content.

$discord

The Discord client.


    protected
        Discord
    $discord

Client.

$factory

The factory.


    protected
        Factory
    $factory

Factory.

$fillable

{@inheritDoc}


    protected
        mixed
    $fillable
     = ['type', 'id', 'custom_id', 'placeholder', 'default_values', 'min_values', 'max_values', 'disabled']

$hidden

Attributes that are hidden from debug info.


    protected
        array<string|int, mixed>
    $hidden
     = []

Attributes that are hidden from public.

$http

The HTTP client.


    protected
        Http
    $http

Client.

$repositories

An array of repositories that can exist in a part.


    protected
        array<string|int, mixed>
    $repositories
     = []

Repositories.

$repositories_cache

An array of repositories.


    protected
        array<string|int, mixed>
    $repositories_cache
     = []

$visible

Attributes which are visible from debug info.


    protected
        array<string|int, mixed>
    $visible
     = []

__construct()

Create a new part instance.


    public
                    __construct(Discord $discord[, array<string|int, mixed> $attributes = [] ][, bool $created = false ]) : mixed

Parameters

$discord : Discord: The Discord client.
$attributes : array<string|int, mixed> = []: An array of attributes to build the part.
$created : bool = false: Whether the part has already been created.

__debugInfo()


    public
                    __debugInfo() : array<string|int, mixed>

Return values

array<string|int, mixed>

__get()

Handles dynamic get calls onto the part.


    public
                    __get(string $key) : mixed

Parameters

$key : string: The attributes key.

Return values

mixed —

The value of the attribute.

__serialize()


    public
                    __serialize() : array<string|int, mixed>

Return values

array<string|int, mixed>

__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.

__toString()

Converts the part to a string.


    public
                    __toString() : string

Return values

string —

A JSON string of attributes.

__unserialize()


    public
                    __unserialize(array<string|int, mixed> $data) : void

Parameters

$data : array<string|int, mixed>

fetch()

Fetches any missing information about the part from Discord's servers.


    public
                    fetch() : PromiseInterface<string|int, static>

Return values

PromiseInterface<string|int, static>

fill()

Fills the parts attributes from an array.


    public
                    fill(array<string|int, mixed> $attributes) : void

Parameters

$attributes : array<string|int, mixed>: An array of attributes to build the part.

getCreatableAttributes()

Returns the attributes needed to create.


    public
                    getCreatableAttributes() : array<string|int, mixed>

Return values

array<string|int, mixed>

getDiscord()

Get the Discord instance that owns this Part.


    public
                    getDiscord() : Discord

Return values

Discord

getPublicAttributes()

Returns an array of public attributes.


    public
                    getPublicAttributes() : array<string|int, mixed>

Return values

array<string|int, mixed> —

An array of public attributes.

getRawAttributes()

Returns an array of raw attributes.


    public
                    getRawAttributes() : array<string|int, mixed>

Return values

array<string|int, mixed> —

Raw attributes.

getRepositoryAttributes()

Gets the attributes to pass to repositories.


    public
                    getRepositoryAttributes() : array<string|int, mixed>

Note: The order matters for repository tree (top to bottom).

Return values

array<string|int, mixed> —

Attributes.

getUpdatableAttributes()

Returns the updatable attributes.


    public
                    getUpdatableAttributes() : array<string|int, mixed>

Return values

array<string|int, mixed>

isPartial()

Whether the part is considered partial i.e. missing information which can be fetched from Discord.


    public
                    isPartial() : bool

Return values

bool

jsonSerialize()

Provides data when the part is encoded into JSON. Used for JsonSerializable.


    public
                    jsonSerialize() : array<string|int, mixed>

Return values

array<string|int, mixed> —

An array of public attributes.

offsetExists()

Checks if an attribute exists via key. Used for ArrayAccess.


    public
                    offsetExists(string $key) : bool

Parameters

$key : string: The attribute key.

Return values

bool —

Whether the offset exists.

offsetGet()

Gets an attribute via key. Used for ArrayAccess.


    public
                    offsetGet(string $key) : mixed

Parameters

$key : string: The attribute key.

offsetSet()

Sets an attribute via key. Used for ArrayAccess.


    public
                    offsetSet(string $key, mixed $value) : void

Parameters

$key : string: The attribute key.
$value : mixed: The attribute value.

offsetUnset()

Unsets an attribute via key. Used for ArrayAccess.


    public
                    offsetUnset(string $key) : void

Parameters

$key : string: The attribute key.

serialize()

Serializes the data. Used for Serializable.


    public
                    serialize() : string|null

Return values

string|null —

A string of serialized data.

unserialize()

Unserializes some data and stores it. Used for Serializable.


    public
                    unserialize(string $data) : void

Parameters

$data : string: Some serialized data.

afterConstruct()

Called after the part has been constructed.


    protected
                    afterConstruct() : void

getComponentsAttribute()

Gets the components of the interaction.


    protected
                    getComponentsAttribute() : ExCollectionInterface|array<string|int, Component>|null

Return values

ExCollectionInterface|array<string|int, Component>|null —

$components

getDefaultValuesAttribute()


    protected
                    getDefaultValuesAttribute() : ExCollectionInterface|null

Return values

ExCollectionInterface|null

makeOptionalAttributes()

Return key-value attributes if it has been filled.


    protected
                    makeOptionalAttributes(array<string|int, mixed> $attributes) : array<string|int, mixed>

To be used with fields marked "optional?" from the API.

Parameters

$attributes : array<string|int, mixed>: Names of optional attribute

Return values

array<string|int, mixed>

checkForGetMutator()

Checks if there is a get mutator present.


    private
                    checkForGetMutator(string $key) : string|false

Parameters

$key : string: The attribute 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 attribute name to check.

Return values

string|false —

Either a string if it is a method or false.

getAttribute()

Gets an attribute on the part.


    private
                    getAttribute(string $key) : mixed

Parameters

$key : string: The key to the attribute.

Return values

mixed —

Either the attribute if it exists or void.

setAttribute()

Sets an attribute on the part.


    private
                    setAttribute(string $key, mixed $value) : void

Parameters

$key : string: The key to the attribute.
$value : mixed: The value of the attribute.

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. The Discord\studly() is kept due to unintended bug and we do not want to introduce BC by replacing it. This method is private static as we may move it outside this class in future.

Parameters

$string : string: The string to convert.

Return values

string

UserSelect extends SelectMenu in package Application

Tags

Table of Contents

Constants

Properties

Methods

Constants

TYPES

Properties

$created

$custom_id

$custom_id

$default_values

$disabled

$id

$id

$id

$max_values

$min_values

$placeholder

$scriptData

$type

$type

$type

$attributes

$discord

$factory

$fillable

$hidden

$http

$repositories

$repositories_cache

$visible

Methods

__construct()

Parameters

__debugInfo()

Return values

__get()

Parameters

Tags

Return values

__serialize()

Return values

__set()

Parameters

Tags

__toString()

Tags

Return values

__unserialize()

Parameters

fetch()

Tags

Return values

fill()

Parameters

Tags

getCreatableAttributes()

Return values

getDiscord()

Return values

getPublicAttributes()

Tags

Return values

getRawAttributes()

Return values

getRepositoryAttributes()

Return values

getUpdatableAttributes()

Return values

isPartial()

Return values

jsonSerialize()

Tags

Return values

offsetExists()

Parameters

Return values

offsetGet()

UserSelect extends SelectMenu
in package

Application