DiscordPHP Documentation

Reaction extends Part
in package

Application

Represents a reaction emoji to a message by members(s).

Properties

$channel : Channel|Thread
$channel_id : string
$count : int
$created : bool: Is the part already created in the Discord servers?
$emoji : Emoji
$guild : Guild|null
$guild_id : string|null
$id : string
$me : bool
$message : Message|null
$message_id : string
$scriptData : mixed: Custom script data.
$attributes : array<string|int, mixed>: The parts attributes.
$discord : Discord: The Discord client.
$factory : Factory: The factory.
$fillable : array<string|int, mixed>: The parts fillable attributes.
$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>: Handles debug calls from var_dump and similar functions.
__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
fill() : void: Fills the parts attributes from an array.
getAllUsers() : PromiseInterface<string|int, Collection|array<string|int, User>>: Gets all the users that have used this reaction.
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>
getUpdatableAttributes() : array<string|int, mixed>: Returns the updatable attributes.
getUsers() : PromiseInterface<string|int, Collection|array<string|int, User>>: Gets the users that have used the reaction.
isPartial() : bool
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.
getChannelAttribute() : Channel|Thread: Gets the channel attribute.
getEmojiAttribute() : Emoji|null: Gets the partial emoji attribute.
getGuildAttribute() : Guild|null: Returns the guild that owns the channel the message was sent in.
getIdAttribute() : string: Gets the emoji identifier.
getMessageAttribute() : Message|null: Gets the message attribute.
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.

$channel read-only


    public
        Channel|Thread
    $channel

The channel that the message belongs to.

$channel_id


    public
        string
    $channel_id

The channel ID that the message belongs in.

$count


    public
        int
    $count

Number of reactions.

$created

Is the part already created in the Discord servers?


    public
        bool
    $created
     = false

Whether the part has been created.

$emoji


    public
        Emoji
    $emoji

The emoji that was reacted with.

$guild read-only


    public
        Guild|null
    $guild

The guild that owns the channel the message belongs in.

$guild_id


    public
        string|null
    $guild_id

The guild ID of the guild that owns the channel the message belongs in.

$id read-only


    public
        string
    $id

The identifier of the reaction.

$me


    public
        bool
    $me

Whether the current bot has reacted.

$message


    public
        Message|null
    $message

The message the reaction is for.

$message_id


    public
        string
    $message_id

The message ID the reaction is for.

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

$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
     = [
    'id',
    // internal
    'count',
    'me',
    'emoji',
    // events only
    'channel_id',
    'message_id',
    '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
     = []

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

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.

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


    public
                    fetch() : PromiseInterface

Return values

PromiseInterface

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.

getAllUsers()

Gets all the users that have used this reaction.


    public
                    getAllUsers() : PromiseInterface<string|int, Collection|array<string|int, User>>

Wrapper of the lower-level getUsers() function.

Return values

PromiseInterface<string|int, Collection|array<string|int, User>>

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


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

Return values

array<string|int, mixed>

getUpdatableAttributes()

Returns the updatable attributes.


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

Return values

array<string|int, mixed>

getUsers()

Gets the users that have used the reaction.


    public
                    getUsers([int|null $options = [] ]) : PromiseInterface<string|int, Collection|array<string|int, User>>

Parameters

$options : int|null = []: ['limit'] Max number of users to return (1-100).

Return values

PromiseInterface<string|int, Collection|array<string|int, User>>

isPartial()


    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

getChannelAttribute()

Gets the channel attribute.


    protected
                    getChannelAttribute() : Channel|Thread

Return values

Channel|Thread

getEmojiAttribute()

Gets the partial emoji attribute.


    protected
                    getEmojiAttribute() : Emoji|null

Return values

Emoji|null

getGuildAttribute()

Returns the guild that owns the channel the message was sent in.


    protected
                    getGuildAttribute() : Guild|null

Return values

Guild|null

getIdAttribute()

Gets the emoji identifier.


    protected
                    getIdAttribute() : string

Return values

string

getMessageAttribute()

Gets the message attribute.


    protected
                    getMessageAttribute() : Message|null

Return values

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

Reaction extends Part in package Application

Tags

Table of Contents

Properties

Methods

Properties

$channel read-only

$channel_id

$count

$created

$emoji

$guild read-only

$guild_id

$id read-only

$me

$message

$message_id

$scriptData

$attributes

$discord

$factory

$fillable

$hidden

$http

$repositories

$repositories_cache

$visible

Methods

__construct()

Parameters

__debugInfo()

Tags

Return values

__get()

Parameters

Tags

Return values

__serialize()

Return values

__set()

Parameters

Tags

__toString()

Tags

Return values

__unserialize()

Parameters

fetch()

Return values

fill()

Parameters

Tags

getAllUsers()

Tags

Return values

getCreatableAttributes()

Return values

getDiscord()

Return values

getPublicAttributes()

Tags

Return values

getRawAttributes()

Return values

getRepositoryAttributes()

Return values

getUpdatableAttributes()

Return values

getUsers()

Parameters

Tags

Return values

isPartial()

Return values

jsonSerialize()

Tags

Return values

offsetExists()

Parameters

Return values

Reaction extends Part
in package

Application