DiscordPHP Documentation

Resolved extends Part
in package

Application

Represents the data associated with an interaction.

$attachments


    public
        Collection|array<string|int, Attachment>|null
    $attachments

The ids and partial Attachment objects.

$channels


    public
        Collection|array<string|int, Channel>|array<string|int, Thread>|null
    $channels

The ids and partial Channel objects.

$created

Is the part already created in the Discord servers?


    public
        bool
    $created
     = false

Whether the part has been created.

$guild_id


    public
        string|null
    $guild_id

ID of the guild internally passed from Interaction.

$members


    public
        Collection|array<string|int, Member>|null
    $members

The ids and partial Member objects.

$messages


    public
        Collection|array<string|int, Message>|null
    $messages

The ids and partial Message objects.

$roles


    public
        Collection|array<string|int, Role>|null
    $roles

The ids and Role objects.

$scriptData

Custom script data.


    public
        mixed
    $scriptData

Used for storing custom information, used by end products.

$users


    public
        Collection|array<string|int, User>|null
    $users

The ids and User objects.

$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

The parts fillable attributes.


    protected
        array<string|int, mixed>
    $fillable
     = [
    'users',
    'members',
    'roles',
    'channels',
    'messages',
    'attachments',
    // @internal
    'guild_id',
]

The array of attributes that can be mass-assigned.

$hidden

Attributes that are hidden from debug info.


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

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.

Return values

mixed —

__debugInfo()

Handles debug calls from var_dump and similar functions.


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

Return values

array<string|int, mixed> —

An array of public attributes.

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

Return values

void —

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

Return values

void —

fetch()

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


    public
                    fetch() : ExtendedPromiseInterface<string|int, self>

Return values

ExtendedPromiseInterface<string|int, self> —

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.

Return values

void —

getCreatableAttributes()

Returns the attributes needed to create.


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

Return values

array<string|int, mixed> —

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.

Return values

mixed —

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.

Return values

void —

offsetUnset()

Unsets an attribute via key. Used for ArrayAccess.


    public
                    offsetUnset(string $key) : void

Parameters

$key : string: The attribute key.

Return values

void —

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.

Return values

void —

afterConstruct()

Called after the part has been constructed.


    protected
                    afterConstruct() : void

Return values

void —

getAttachmentsAttribute()

Returns a collection of resolved attachments.


    protected
                    getAttachmentsAttribute() : Collection|array<string|int, Attachment>|null

Return values

Collection|array<string|int, Attachment>|null —

Map of Snowflakes to attachments objects

getChannelsAttribute()

Returns a collection of resolved channels.


    protected
                    getChannelsAttribute() : Collection|array<string|int, Channel>|array<string|int, Thread>|null

Partial Channel objects only have id, name, type and permissions fields. Threads will also have thread_metadata and parent_id fields.

Return values

Map of Snowflakes to partial channel objects

getMembersAttribute()

Returns a collection of resolved members.


    protected
                    getMembersAttribute() : Collection|array<string|int, Member>|null

Partial Member objects are missing user, deaf and mute fields

Return values

Collection|array<string|int, Member>|null —

Map of Snowflakes to partial member objects

getMessagesAttribute()

Returns a collection of resolved messages.


    protected
                    getMessagesAttribute() : Collection|array<string|int, Message>|null

Return values

Collection|array<string|int, Message>|null —

Map of Snowflakes to partial messages objects

getRolesAttribute()

Returns a collection of resolved roles.


    protected
                    getRolesAttribute() : Collection|array<string|int, Role>|null

Return values

Collection|array<string|int, Role>|null —

Map of Snowflakes to role objects

getUsersAttribute()

Returns a collection of resolved users.


    protected
                    getUsersAttribute() : Collection|array<string|int, User>|null

Return values

Collection|array<string|int, User>|null —

Map of Snowflakes to user objects

checkForMutator()

Checks if there is a mutator present.


    private
                    checkForMutator(string $key, string $type) : string|false

Parameters

$key : string: The attribute name to check.
$type : string: Either get or set.

Return values

string|false —

Either a string if it is callable 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.

Return values

void —

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 —

Resolved extends Part in package Application

Tags

Table of Contents

Properties

$attachments

$channels

$created

$guild_id

$members

$messages

$roles

$scriptData

Tags

$users

$attributes

$discord

$factory

$fillable

$hidden

$http

$repositories

$repositories_cache

$visible

Methods

__construct()

Parameters

Return values

__debugInfo()

Tags

Return values

__get()

Parameters

Tags

Return values

__serialize()

Return values

__set()

Parameters

Tags

Return values

__toString()

Tags

Return values

__unserialize()

Parameters

Return values

fetch()

Tags

Return values

fill()

Parameters

Return values

getCreatableAttributes()

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()

Parameters

Tags

Return values

offsetSet()

Parameters

Tags

Return values

offsetUnset()

Resolved extends Part
in package

Application