Role
extends Part
in package
implements
Stringable
A role defines permissions for the guild. Members can be added to the role.
The role belongs to a guild.
Tags
Table of Contents
Interfaces
- Stringable
Constants
- IN_PROMPT = 1 << 0
Properties
- $color : int
- $colors : Colors
- $created : bool
- Is the part already created in the Discord servers?
- $flags : int
- $guild : Guild|null
- $guild_id : string|null
- $hoist : bool
- $icon_hash : string|null
- $id : string
- $managed : bool
- $mentionable : bool
- $name : string
- $permissions : RolePermission
- $position : int
- $scriptData : mixed
- Custom script data.
- $tags : object|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>
- __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
- Returns a formatted mention.
- __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>
- getDiscord() : Discord
- Get the Discord instance that owns this Part.
- getIconAttribute() : string|null
- Returns the role icon.
- 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.
- serialize() : string|null
- Serializes the data. Used for Serializable.
- setColor() : void
- Sets the color for a role. RGB.
- setColors() : void
- Sets the colors for a role.
- unserialize() : void
- Unserializes some data and stores it. Used for Serializable.
- afterConstruct() : void
- Called after the part has been constructed.
- getColorsAttribute() : Colors
- Gets the colors attribute.
- getGuildAttribute() : Guild|null
- Gets the guild attribute.
- getIconHashAttribute() : string|null
- Returns the role icon hash.
- getPermissionsAttribute() : RolePermission
- Gets the permissions 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.
Constants
IN_PROMPT
public
mixed
IN_PROMPT
= 1 << 0
Properties
$color
public
int
$color
(deprecated) Integer representation of hexadecimal color code.
$colors
public
Colors
$colors
The role's colors.
$created
Is the part already created in the Discord servers?
public
bool
$created
= false
Whether the part has been created.
$flags
public
int
$flags
Role flags combined as a bitfield.
$guild read-only
public
Guild|null
$guild
The guild that the role belongs to.
$guild_id
public
string|null
$guild_id
The unique identifier of the guild that the role belongs to.
$hoist
public
bool
$hoist
If this role is pinned in the user listing
$icon_hash read-only
public
string|null
$icon_hash
The icon hash for the role.
$id
public
string
$id
The unique identifier of the role.
$managed
public
bool
$managed
Whether this role is managed by an integration.
$mentionable
public
bool
$mentionable
Whether the role is mentionable.
$name
public
string
$name
The name of the role.
$permissions
public
RolePermission
$permissions
Permission bit set.
$position
public
int
$position
Position of this role (roles with the same position are sorted by id).
$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.
$tags
public
object|null
$tags
The tags this role has (bot_id
, integration_id
, premium_subscriber
, subscription_listing_id
, available_for_purchase
, and guild_connections
).
$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',
'name',
'color',
'colors',
'hoist',
'icon',
'unicode_emoji',
'position',
'permissions',
'managed',
'mentionable',
'tags',
'flags',
// @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
= []
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
= []
Methods
__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.
Tags
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.
Tags
__toString()
Returns a formatted mention.
public
__toString() : string
Return values
string —A formatted mention.
__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>
Tags
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.
Tags
getCreatableAttributes()
public
getCreatableAttributes() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>getDiscord()
Get the Discord instance that owns this Part.
public
getDiscord() : Discord
Return values
DiscordgetIconAttribute()
Returns the role icon.
public
getIconAttribute([string $format = 'png' ][, int $size = 64 ]) : string|null
Parameters
- $format : string = 'png'
-
The image format.
- $size : int = 64
-
The size of the image.
Return values
string|null —The URL to the role icon or null.
getPublicAttributes()
Returns an array of public attributes.
public
getPublicAttributes() : array<string|int, mixed>
Tags
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>
Tags
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
booljsonSerialize()
Provides data when the part is encoded into JSON. Used for JsonSerializable.
public
jsonSerialize() : array<string|int, mixed>
Tags
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.
Tags
Attributes
- #[ReturnTypeWillChange]
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.
Tags
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.
setColor()
Sets the color for a role. RGB.
public
setColor([int $red = 0 ][, int $green = 0 ][, int $blue = 0 ]) : void
Use Role::setColors()
Parameters
- $red : int = 0
-
The red value in RGB.
- $green : int = 0
-
The green value in RGB.
- $blue : int = 0
-
The blue value in RGB.
setColors()
Sets the colors for a role.
public
setColors([int $primary = 0 ][, int|null $secondary = null ][, int|null $tertiary = null ]) : void
When sending tertiary_color the API enforces the role color to be a holographic style with values of: primary_color = 11127295, secondary_color = 16759788, and tertiary_color = 16761760.
Parameters
- $primary : int = 0
-
The primary color for the role.
- $secondary : int|null = null
-
The secondary color for the role, this will make the role a gradient between the other provided colors.
- $tertiary : int|null = null
-
The tertiary color for the role, this will turn the gradient into a holographic style.
Tags
unserialize()
Unserializes some data and stores it. Used for Serializable.
public
unserialize(string $data) : void
Parameters
- $data : string
-
Some serialized data.
Tags
afterConstruct()
Called after the part has been constructed.
protected
afterConstruct() : void
getColorsAttribute()
Gets the colors attribute.
protected
getColorsAttribute() : Colors
Tags
Return values
Colors —The role's colors.
getGuildAttribute()
Gets the guild attribute.
protected
getGuildAttribute() : Guild|null
Return values
Guild|null —The guild attribute.
getIconHashAttribute()
Returns the role icon hash.
protected
getIconHashAttribute() : string|null
Return values
string|null —The role icon hash or null.
getPermissionsAttribute()
Gets the permissions attribute.
protected
getPermissionsAttribute() : RolePermission
Tags
Return values
RolePermission —The role permission.
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.
Tags
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.
Tags
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.
Tags
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.