DiscordPHP Documentation

RolePermission extends Permission

in package

• Application

Represents a set of permissions for a given role.

Tags

since

2.1.3

Table of Contents

Constants

ALL_PERMISSIONS  = ['create_instant_invite' => 0, 'manage_channels' => 4, 'add_reactions' => 6, 'view_channel' => 10, 'send_messages' => 11, 'send_tts_messages' => 12, 'manage_messages' => 13, 'embed_links' => 14, 'attach_files' => 15, 'read_message_history' => 16, 'mention_everyone' => 17, 'use_external_emojis' => 18, 'manage_roles' => 28, 'manage_webhooks' => 29, 'use_application_commands' => 31, 'use_external_stickers' => 37, 'send_voice_messages' => 46]

Array of permissions for all roles.

ROLE_PERMISSIONS  = ['kick_members' => 1, 'ban_members' => 2, 'administrator' => 3, 'manage_guild' => 5, 'view_audit_log' => 7, 'view_guild_insights' => 19, 'change_nickname' => 26, 'manage_nicknames' => 27, 'manage_guild_expressions' => 30, 'moderate_members' => 40, 'view_creator_monetization_analytics' => 41]

Array of permissions that can only be applied to roles.

STAGE_PERMISSIONS  = ['stream' => 9, 'connect' => 20, 'mute_members' => 22, 'move_members' => 24, 'request_to_speak' => 32, 'manage_events' => 33, 'create_events' => 44]

Array of permissions that only apply to stage channels.

TEXT_PERMISSIONS  = ['manage_threads' => 34, 'create_public_threads' => 35, 'create_private_threads' => 36, 'send_messages_in_threads' => 38]

Array of permissions that only apply to text channels.

VOICE_PERMISSIONS  = ['priority_speaker' => 8, 'stream' => 9, 'connect' => 20, 'speak' => 21, 'mute_members' => 22, 'deafen_members' => 23, 'move_members' => 24, 'use_vad' => 25, 'manage_events' => 33, 'use_embedded_activities' => 39, 'use_soundboard' => 42, 'create_events' => 44, 'use_external_sounds' => 45, 'send_voice_messages' => 46, 'send_polls' => 49]

Array of permissions that only apply to voice channels.

Properties

$add_reactions  : bool

$administrator  : bool

$attach_files  : bool

$ban_members  : bool

$bitwise  : int|string

$change_nickname  : bool

$connect  : bool

$create_events  : bool

$create_instant_invite  : bool

$create_private_threads  : bool

$create_public_threads  : bool

$created  : bool

Is the part already created in the Discord servers?

$deafen_members  : bool

$embed_links  : bool

$kick_members  : bool

$manage_channels  : bool

$manage_events  : bool

$manage_guild  : bool

$manage_guild_expressions  : bool

$manage_messages  : bool

$manage_nicknames  : bool

$manage_roles  : bool

$manage_threads  : bool

$manage_webhooks  : bool

$mention_everyone  : bool

$moderate_members  : bool

$move_members  : bool

$mute_members  : bool

$priority_speaker  : bool

$read_message_history  : bool

$request_to_speak  : bool

$scriptData  : mixed

Custom script data.

$send_messages  : bool

$send_messages_in_threads  : bool

$send_polls  : bool

$send_tts_messages  : bool

$send_voice_messages  : bool

$send_voice_messages  : bool

$speak  : bool

$stream  : bool

$use_application_commands  : bool

$use_embedded_activities  : bool

$use_external_emojis  : bool

$use_external_sounds  : bool

$use_external_stickers  : bool

$use_soundboard  : bool

$use_vad  : bool

$view_audit_log  : bool

$view_channel  : bool

$view_creator_monetization_analytics  : bool

$view_guild_insights  : bool

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

$permissions  : array<string|int, mixed>

Array of permissions.

Methods

__construct()  : mixed

__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

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

Returns the attributes needed to create.

getDiscord()  : Discord

Get the Discord instance that owns this Part.

getPermissions()  : array<string|int, mixed>

Returns an array of extra permissions.

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>

Gets the attributes to pass to repositories.

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

Returns the updatable attributes.

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.

unserialize()  : void

Unserializes some data and stores it. Used for Serializable.

afterConstruct()  : void

Called after the part has been constructed.

getBitwiseAttribute()  : int|string

Gets the bitwise attribute of the permission.

getManageEmojisAndStickersAttribute()  : mixed

makeOptionalAttributes()  : array<string|int, mixed>

Return key-value attributes if it has been filled.

setBitwiseAttribute()  : void

Sets the bitwise attribute of the permission.

setManageEmojisAndStickersAttribute()  : void

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.