Merge pull request #1182 from discord-php/cleanup-rc6

Cleanup rc6

Author: SQKo

src/Discord/Discord.php

@@ -1160,8 +1160,6 @@ public function updatePresence(Activity $activity = null, bool $idle = false, st
 
             if (! in_array($activity['type'], [Activity::TYPE_GAME, Activity::TYPE_STREAMING, Activity::TYPE_LISTENING, Activity::TYPE_WATCHING, Activity::TYPE_CUSTOM, Activity::TYPE_COMPETING])) {
                 throw new \UnexpectedValueException("The given activity type ({$activity['type']}) is invalid.");
-
-                return;
             }
         }
 
@@ -1203,13 +1201,15 @@ public function getVoiceClient(string $guild_id): ?VoiceClient
      * @param bool                 $mute    Whether you should be mute when you join the channel.
      * @param bool                 $deaf    Whether you should be deaf when you join the channel.
      * @param LoggerInterface|null $logger  Voice client logger. If null, uses same logger as Discord client.
-     * @param bool                 $check   Whether to check for system requirements.
      *
      * @throws \RuntimeException
      *
+     * @since 10.0.0 Removed argument $check that has no effect (it is always checked)
+     * @since 4.0.0
+     *
      * @return PromiseInterface
      */
-    public function joinVoiceChannel(Channel $channel, $mute = false, $deaf = true, ?LoggerInterface $logger = null, bool $check = true): ExtendedPromiseInterface
+    public function joinVoiceChannel(Channel $channel, $mute = false, $deaf = true, ?LoggerInterface $logger = null): ExtendedPromiseInterface
     {
         $deferred = new Deferred();
 
@@ -1241,7 +1241,7 @@ public function joinVoiceChannel(Channel $channel, $mute = false, $deaf = true,
             $this->removeListener(Event::VOICE_STATE_UPDATE, $voiceStateUpdate);
         };
 
-        $voiceServerUpdate = function ($vs, $discord) use ($channel, &$data, &$voiceServerUpdate, $deferred, $logger, $check) {
+        $voiceServerUpdate = function ($vs, $discord) use ($channel, &$data, &$voiceServerUpdate, $deferred, $logger) {
             if ($vs->guild_id != $channel->guild_id) {
                 return; // This voice server update isn't for our guild.
             }
@@ -1274,7 +1274,7 @@ public function joinVoiceChannel(Channel $channel, $mute = false, $deaf = true,
                 unset($this->voiceClients[$channel->guild_id]);
             });
 
-            $vc->start($check);
+            $vc->start();
 
             $this->voiceLoggers[$channel->guild_id] = $logger;
             $this->removeListener(Event::VOICE_SERVER_UPDATE, $voiceServerUpdate);

src/Discord/Parts/Channel/Channel.php

@@ -1416,14 +1416,15 @@ public function getCreatableAttributes(): array
         // Marked "Channel Type: All" in documentation
         $attr += $this->makeOptionalAttributes([
             'type' => $this->type,
-            'permission_overwrites' => $this->permission_overwrites,
+            'permission_overwrites' => $this->getPermissionOverwritesAttribute(),
             'position' => $this->position,
         ]);
 
         if (null === $this->type) {
             // Type was not specified but we must not assume its default to GUILD_TEXT as that is determined by API
             $this->discord->getLogger()->warning('Not specifying channel type, creating with all filled attributes');
             $attr += $this->getRawAttributes(); // Send the remaining raw attributes
+
             return $attr;
         }
 
@@ -1509,7 +1510,7 @@ public function getUpdatableAttributes(): array
         $attr = [
             'name' => $this->name,
             'position' => $this->position,
-            'permission_overwrites' => $this->permission_overwrites,
+            'permission_overwrites' => $this->getPermissionOverwritesAttribute(),
         ];
 
         switch ($this->type) {

src/Discord/Parts/Channel/Message.php

@@ -908,7 +908,7 @@ public function delayedReply($message, int $delay, &$timer = null): ExtendedProm
      * @param int            $delay  Time to delay the delete by, in milliseconds.
      * @param TimerInterface &$timer Delay timer passed by reference.
      *
-     * @return ExtendedPromseInterface
+     * @return ExtendedPromiseInterface
      */
     public function delayedDelete(int $delay, &$timer = null): ExtendedPromiseInterface
     {

src/Discord/Parts/Channel/Reaction.php

@@ -90,7 +90,6 @@ public function fetch(): ExtendedPromiseInterface
      *
      * @param string $value name:id or the character of standard emoji
      *
-     * @return void
      *
      * @since 10.0.0
      */

src/Discord/Parts/Guild/AuditLog/AuditLog.php

@@ -30,14 +30,14 @@
  *
  * @since 5.1.0
  *
- * @property Collection|Command[]             $application_commands   List of application commands referenced in the audit log.
- * @property Collection|Entry[]               $audit_log_entries      List of audit log entries.
- * @property Collection|Rule[]                $auto_moderation_rules  List of auto moderation rules referenced in the audit log.
- * @property Collection|GuildScheduledEvent[] $guild_scheduled_events List of guild scheduled events referenced in the audit log.
- * @property Collection|Integration[]         $integrations           List of partial integration objects.
- * @property Collection|Threads[]             $threads                List of threads referenced in the audit log.
- * @property Collection|User[]                $users                  List of users referenced in the audit log.
- * @property Collection|Webhook[]             $webhooks               List of webhooks referenced in the audit log.
+ * @property Collection|Command[]        $application_commands   List of application commands referenced in the audit log.
+ * @property Collection|Entry[]          $audit_log_entries      List of audit log entries.
+ * @property Collection|Rule[]           $auto_moderation_rules  List of auto moderation rules referenced in the audit log.
+ * @property Collection|ScheduledEvent[] $guild_scheduled_events List of guild scheduled events referenced in the audit log.
+ * @property Collection|Integration[]    $integrations           List of partial integration objects.
+ * @property Collection|Thread[]         $threads                List of threads referenced in the audit log.
+ * @property Collection|User[]           $users                  List of users referenced in the audit log.
+ * @property Collection|Webhook[]        $webhooks               List of webhooks referenced in the audit log.
  *
  * @property      string     $guild_id
  * @property-read Guild|null $guild

src/Discord/Parts/Guild/AutoModeration/Rule.php

@@ -12,7 +12,9 @@
 namespace Discord\Parts\Guild\AutoModeration;
 
 use Discord\Helpers\Collection;
+use Discord\Parts\Channel\Channel;
 use Discord\Parts\Guild\Guild;
+use Discord\Parts\Guild\Role;
 use Discord\Parts\Part;
 use Discord\Parts\User\User;
 
@@ -39,8 +41,8 @@
  * @property      object                $trigger_metadata The rule trigger metadata (may contain `keyword_filter`, `regex_patterns`, `presets`, `allow_list`, `mention_total_limit` and `mention_raid_protection_enabled`).
  * @property      Collection|Action[]   $actions          The actions which will execute when the rule is triggered.
  * @property      bool                  $enabled          Whether the rule is enabled.
- * @property      Collection|Roles[]    $exempt_roles     The role ids that should not be affected by the rule (Maximum of 20).
- * @property      Collection|Channels[] $exempt_channels  The channel ids that should not be affected by the rule (Maximum of 50).
+ * @property      Collection|?Role[]    $exempt_roles     The role ids that should not be affected by the rule (Maximum of 20).
+ * @property      Collection|?Channel[] $exempt_channels  The channel ids that should not be affected by the rule (Maximum of 50).
  */
 class Rule extends Part
 {
@@ -111,7 +113,7 @@ protected function getActionsAttribute(): Collection
     /**
      * Returns the exempt roles attribute.
      *
-     * @return Collection<?Role> A collection of roles exempt from the rule.
+     * @return Collection|?Role[] A collection of roles exempt from the rule.
      */
     protected function getExemptRolesAttribute(): Collection
     {
@@ -135,7 +137,7 @@ protected function getExemptRolesAttribute(): Collection
     /**
      * Returns the exempt channels attribute.
      *
-     * @return Collection<?Channel> A collection of channels exempt from the rule.
+     * @return Collection|?Channel[] A collection of channels exempt from the rule.
      */
     protected function getExemptChannelsAttribute(): Collection
     {

src/Discord/Parts/Interactions/Interaction.php

@@ -26,6 +26,7 @@
 use Discord\Parts\Interactions\Request\InteractionData;
 use Discord\Parts\Part;
 use Discord\Parts\Permissions\ChannelPermission;
+use Discord\Parts\Thread\Thread;
 use Discord\Parts\User\Member;
 use Discord\Parts\User\User;
 use Discord\WebSockets\Event;

src/Discord/Parts/Part.php

@@ -188,7 +188,7 @@ public function fill(array $attributes): void
      */
     private function checkForGetMutator(string $key)
     {
-        $str = 'get' . self::studly($key) . 'Attribute';
+        $str = 'get'.self::studly($key).'Attribute';
 
         if (method_exists($this, $str)) {
             return $str;
@@ -208,7 +208,7 @@ private function checkForGetMutator(string $key)
      */
     private function checkForSetMutator(string $key)
     {
-        $str = 'set' . self::studly($key) . 'Attribute';
+        $str = 'set'.self::studly($key).'Attribute';
 
         if (method_exists($this, $str)) {
             return $str;

src/Discord/Parts/User/User.php

@@ -128,11 +128,11 @@ public function getPrivateChannel(): ExtendedPromiseInterface
      *
      * @link https://discord.com/developers/docs/resources/channel#create-message
      *
-     * @param MessageBuilder|string $message          The message builder that should be converted into a message, or the string content of the message.
-     * @param bool                  $tts              Whether the message is TTS.
-     * @param Embed|array|null      $embed            An embed object or array to send in the message.
-     * @param array|null            $allowed_mentions Allowed mentions object for the message.
-     * @param Message|null          $replyTo          Sends the message as a reply to the given message instance.
+     * @param MessageBuilder|string                 $message          The message builder that should be converted into a message, or the string content of the message.
+     * @param bool                                  $tts              Whether the message is TTS.
+     * @param \Discord\Parts\Embed\Embed|array|null $embed            An embed object or array to send in the message.
+     * @param array|null                            $allowed_mentions Allowed mentions object for the message.
+     * @param Message|null                          $replyTo          Sends the message as a reply to the given message instance.
      *
      * @return ExtendedPromiseInterface<Message>
      */

src/Discord/Parts/WebSockets/MessageReaction.php

@@ -17,6 +17,7 @@
 use Discord\Parts\Guild\Emoji;
 use Discord\Parts\Guild\Guild;
 use Discord\Parts\Part;
+use Discord\Parts\Thread\Thread;
 use Discord\Parts\User\Member;
 use Discord\Parts\User\User;
 use React\Promise\ExtendedPromiseInterface;
@@ -31,16 +32,16 @@
  *
  * @since 5.0.0
  *
- * @property      string|null    $user_id    ID of the user that performed the reaction.
- * @property      User|null      $user       User that performed the reaction.
- * @property      string         $channel_id ID of the channel that the reaction was performed in.
- * @property-read Channel|Thread $channel    Channel that the reaction was performed in.
- * @property      string         $message_id ID of the message that the reaction was placed on.
- * @property      Message|null   $message    Message that the reaction was placed on, null if not cached.
- * @property      string|null    $guild_id   ID of the guild that owns the channel.
- * @property-read Guild|null     $guild      Guild that owns the channel.
- * @property      Member|null    $member     Member object of the user that performed the reaction, null if not cached or DM channel.
- * @property      Emoji|null     $emoji      The emoji that was used as the reaction.
+ * @property      string|null         $user_id    ID of the user that performed the reaction.
+ * @property      User|null           $user       User that performed the reaction.
+ * @property      string              $channel_id ID of the channel that the reaction was performed in.
+ * @property-read Channel|Thread|null $channel    Channel that the reaction was performed in.
+ * @property      string              $message_id ID of the message that the reaction was placed on.
+ * @property      Message|null        $message    Message that the reaction was placed on, null if not cached.
+ * @property      string|null         $guild_id   ID of the guild that owns the channel.
+ * @property-read Guild|null          $guild      Guild that owns the channel.
+ * @property      Member|null         $member     Member object of the user that performed the reaction, null if not cached or DM channel.
+ * @property      Emoji|null          $emoji      The emoji that was used as the reaction.
  *
  * @property string $reaction_id ID of the reaction.
  */
@@ -133,9 +134,9 @@ protected function getUserAttribute(): ?User
     /**
      * Gets the channel attribute.
      *
-     * @return Channel|Thread
+     * @return Channel|Thread|null
      */
-    protected function getChannelAttribute(): Part
+    protected function getChannelAttribute(): ?Part
     {
         if ($guild = $this->guild) {
             $channels = $guild->channels;