DiscordPHP Documentation

ModalBuilder extends Builder
in package
implements JsonSerializable

Helper class used to build Modals.

Tags
link
https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-response-object-modal
link
https://discord.com/developers/docs/components/using-modal-components
since
10.19.0
author

David Cole david.cole1340@gmail.com

Table of Contents

Interfaces

JsonSerializable

Properties

$components  : array<string|int, ComponentObject>
Between 1 and 5 (inclusive) components that make up the modal.
$custom_id  : string
Developer-defined identifier for the component, max 100 characters.
$title  : string
The title of the popup modal, max 45 characters.
$type  : int
Interaction type.

Methods

__get()  : mixed
Handles dynamic get calls onto the part.
__set()  : void
Handles dynamic set calls onto the part.
addComponent()  : $this
Add a component to the modal.
fromPart()  : self
Creates a new instance of the builder from a given Part.
getComponents()  : array<string|int, ComponentObject>
Returns the components of the modal.
getCustomId()  : string
Returns the custom ID of the modal.
getTitle()  : string
Returns the title of the modal.
jsonSerialize()  : array<string|int, mixed>
new()  : static
Creates a new message builder.
removeComponent()  : $this
Removes a component from the builder.
setComponents()  : $this
Sets the components of the modal (Limit 5).
setCustomId()  : $this
Sets the custom ID of the modal.
setTitle()  : $this
Set the title of the modal.
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.

Properties

$components

Between 1 and 5 (inclusive) components that make up the modal.

protected array<string|int, ComponentObject> $components

$custom_id

Developer-defined identifier for the component, max 100 characters.

protected string $custom_id

$title

The title of the popup modal, max 45 characters.

protected string $title

$type

Interaction type.

protected int $type = \Discord\Parts\Interactions\Interaction::RESPONSE_TYPE_MODAL

Methods

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

addComponent()

Add a component to the modal.

public addComponent(ComponentObject $component) : $this

Only ActionRow, TextDisplay, and Label components are allowed.

Using ActionRow in modals is now deprecated. Use Component::Label as the top level component.

Parameters
$component : ComponentObject
Tags
throws
InvalidArgumentException

Component is not a valid type.

throws
OverflowException

If the modal has more than 5 components.

Return values
$this

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

public getCustomId() : string
Return values
string

getTitle()

Returns the title of the modal.

public getTitle() : string
Return values
string

jsonSerialize()

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

new()

Creates a new message builder.

public static new(string $title, string $custom_id, array<string|int, ComponentObject> $components) : static
Parameters
$title : string
$custom_id : string
$components : array<string|int, ComponentObject>
Return values
static

setComponents()

Sets the components of the modal (Limit 5).

public setComponents(array<string|int, ComponentObject> ...$components) : $this
Parameters
$components : array<string|int, ComponentObject>
Return values
$this

setCustomId()

Sets the custom ID of the modal.

public setCustomId(string $custom_id) : $this
Parameters
$custom_id : string
Tags
throws
LengthException
Return values
$this

setTitle()

Set the title of the modal.

public setTitle(string $title) : $this
Parameters
$title : string

Maximum length is 45 characters.

Tags
throws
LengthException

Modal title too long.

Return values
$this

checkForGetMutator()

Checks if there is a get mutator present.

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

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

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

protected 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