DiscordPHP Documentation

Client extends Part
in package

Application

The client is the main interface for the client. Most calls on the main class are forwarded here.

Properties

$application : Application
$avatar : string|null
$avatar_hash : string|null
$bot : bool
$created : bool: Is the part already created in the Discord servers?
$discriminator : string
$emojis : EmojiRepository
$flags : int|null
$global_name : string|null
$guilds : GuildRepository
$id : string
$mfa_enabled : bool|null
$private_channels : PrivateChannelRepository
$public_flags : int|null
$scriptData : mixed: Custom script data.
$sounds : SoundRepository
$user : User
$username : string
$users : UserRepository
$verified : bool|null
$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
afterConstruct() : void: Runs any extra construction tasks.
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>
getUpdatableAttributes() : array<string|int, mixed>
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.
save() : PromiseInterface: Saves the client instance.
serialize() : string|null: Serializes the data. Used for Serializable.
setAvatar() : bool: Sets the users avatar.
unserialize() : void: Unserializes some data and stores it. Used for Serializable.
getAvatarAttribute() : string
getAvatarHashAttribute() : string|null
getUserAttribute() : User: Gets the user 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.

$application


    public
        Application
    $application

The OAuth2 application of the bot.

$avatar


    public
        string|null
    $avatar

The avatar URL of the client.

$avatar_hash


    public
        string|null
    $avatar_hash

The avatar hash of the client.

$bot


    public
        bool
    $bot

Whether the client is a bot.

$created

Is the part already created in the Discord servers?


    public
        bool
    $created
     = false

Whether the part has been created.

$discriminator


    public
        string
    $discriminator

The unique discriminator of the client.

$emojis


    public
        EmojiRepository
    $emojis

$flags


    public
        int|null
    $flags

The flags on a user's account.

$global_name


    public
        string|null
    $global_name

The user's display name, if it is set. For bots, this is the application name.

$guilds


    public
        GuildRepository
    $guilds

$id


    public
        string
    $id

The unique identifier of the client.

$mfa_enabled


    public
        bool|null
    $mfa_enabled

Whether the Bot owner has two factor enabled on their account.

$private_channels


    public
        PrivateChannelRepository
    $private_channels

$public_flags


    public
        int|null
    $public_flags

The public flags on a user's account.

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

$sounds


    public
        SoundRepository
    $sounds

$user


    public
        User
    $user

The user instance of the client.

$username


    public
        string
    $username

The username of the client.

$users


    public
        UserRepository
    $users

$verified


    public
        bool|null
    $verified

Whether the client has verified their email.

$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
     = [
    'verified',
    'username',
    'public_flags',
    'mfa_enabled',
    'id',
    'flags',
    'email',
    'discriminator',
    'global_name',
    'bot',
    'avatar',
    // actual form
    'user',
    'application',
]

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
     = ['emojis' => \Discord\Repository\EmojiRepository::class, 'guilds' => \Discord\Repository\GuildRepository::class, 'private_channels' => \Discord\Repository\PrivateChannelRepository::class, 'sounds' => \Discord\Repository\SoundRepository::class, 'users' => \Discord\Repository\UserRepository::class]

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>

afterConstruct()

Runs any extra construction tasks.


    public
                    afterConstruct() : void

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


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

Return values

array<string|int, mixed>

getUpdatableAttributes()


    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.

save()

Saves the client instance.


    public
                    save() : PromiseInterface

Return values

PromiseInterface

serialize()

Serializes the data. Used for Serializable.


    public
                    serialize() : string|null

Return values

string|null —

A string of serialized data.

setAvatar()

Sets the users avatar.


    public
                    setAvatar(string $filepath) : bool

Parameters

$filepath : string: The path to the file.

Return values

bool —

Whether the setting succeeded or failed.

unserialize()

Unserializes some data and stores it. Used for Serializable.


    public
                    unserialize(string $data) : void

Parameters

$data : string: Some serialized data.

getAvatarAttribute()


    protected
                    getAvatarAttribute() : string

Return values

string —

The URL to the client's avatar.

getAvatarHashAttribute()


    protected
                    getAvatarHashAttribute() : string|null

Return values

string|null —

The avatar hash for the client.

getUserAttribute()

Gets the user attribute.


    protected
                    getUserAttribute() : User

Return values

User

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

Client extends Part in package Application

Tags

Table of Contents

Properties

Methods

Properties

$application

$avatar

$avatar_hash

$bot

$created

$discriminator

$emojis

$flags

$global_name

$guilds

$id

$mfa_enabled

$private_channels

$public_flags

$scriptData

$sounds

$user

$username

$users

$verified

$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

afterConstruct()

fetch()

Tags

Return values

fill()

Parameters

Tags

getCreatableAttributes()

Return values

getDiscord()

Return values

getPublicAttributes()

Tags

Return values

getRawAttributes()

Return values

getRepositoryAttributes()

Return values

getUpdatableAttributes()

Tags

Return values

isPartial()

Return values

jsonSerialize()

Tags

Client extends Part
in package

Application