Tweaks to studly params & ran cs-unsupported

valzargaming · valzargaming · commit b91267a94001 · 2025-07-28T01:02:07.000-04:00
The library only uses studly for the magic methods on attributes, but it's easier to ensure consistency in other aspects by making ucfirst a toggle
diff --git a/src/Discord/Builders/Components/Button.php b/src/Discord/Builders/Components/Button.php
@@ -602,7 +602,7 @@ public function isDisabled(): bool
     }
 
     /**
-     * {@inheritDoc}
+     * @inheritDoc
      */
     public function jsonSerialize(): array
     {
diff --git a/src/Discord/Builders/MessageBuilder.php b/src/Discord/Builders/MessageBuilder.php
@@ -864,7 +864,7 @@ public function setIsComponentsV2Flag(bool $enable = true): self
     {
         if ($enable) {
             if (! ($this->flags & Message::FLAG_IS_COMPONENTS_V2)) {
-                $this->flags |= Message::FLAG_IS_COMPONENTS_V2 ;
+                $this->flags |= Message::FLAG_IS_COMPONENTS_V2;
             }
         } elseif ($this->flags & Message::FLAG_IS_COMPONENTS_V2) {
             $this->flags &= ~Message::FLAG_IS_COMPONENTS_V2;
diff --git a/src/Discord/Parts/Channel/ChannelTrait.php b/src/Discord/Parts/Channel/ChannelTrait.php
@@ -514,7 +514,9 @@ public function sendMessage($message, bool $tts = false, $embed = null, $allowed
         if (is_string($message)) {
             $message = MessageBuilder::new()->setContent($message);
             $message->setTts($tts);
-            if ($embed) $message->addEmbed($embed);
+            if ($embed) {
+                $message->addEmbed($embed);
+            }
             $message->setAllowedMentions($allowed_mentions);
             $message->setReplyTo($replyTo);
         }
diff --git a/src/Discord/Parts/Channel/Message/MediaGallery.php b/src/Discord/Parts/Channel/Message/MediaGallery.php
@@ -32,7 +32,7 @@
 class MediaGallery extends Content
 {
     /**
-     * {@inheritDoc}
+     * @inheritDoc
      */
     protected $fillable = [
         'type',
diff --git a/src/Discord/Parts/Channel/Message/MessagePinData.php b/src/Discord/Parts/Channel/Message/MessagePinData.php
@@ -30,7 +30,7 @@
 class MessagePinData extends Part
 {
     /**
-     * {@inheritDoc}
+     * @inheritDoc
      */
     protected $fillable = [
         'items',
diff --git a/src/Discord/Parts/Guild/AuditLog/Entry.php b/src/Discord/Parts/Guild/AuditLog/Entry.php
@@ -175,7 +175,7 @@ class Entry extends Part
     // AUDIT LOG ENTRY TYPES
 
     /**
-     * {@inheritDoc}
+     * @inheritDoc
      */
     protected $fillable = [
         'target_id',
diff --git a/src/Discord/Parts/Guild/Role.php b/src/Discord/Parts/Guild/Role.php
@@ -49,7 +49,7 @@ class Role extends Part implements Stringable
     public const IN_PROMPT = 1 << 0; // Role can be selected by members in an onboarding prompt.
 
     /**
-     * {@inheritDoc}
+     * @inheritDoc
      */
     protected $fillable = [
         'id',
@@ -196,7 +196,7 @@ protected function getTagsAttribute(): ?RoleTags
     }
 
     /**
-     * {@inheritDoc}
+     * @inheritDoc
      *
      * @link https://discord.com/developers/docs/resources/guild#create-guild-role-json-params
      */
@@ -214,7 +214,7 @@ public function getCreatableAttributes(): array
     }
 
     /**
-     * {@inheritDoc}
+     * @inheritDoc
      *
      * @link https://discord.com/developers/docs/resources/guild#modify-guild-role-json-params
      */
@@ -232,7 +232,7 @@ public function getUpdatableAttributes(): array
     }
 
     /**
-     * {@inheritDoc}
+     * @inheritDoc
      */
     public function getRepositoryAttributes(): array
     {
diff --git a/src/Discord/Parts/PartInterface.php b/src/Discord/Parts/PartInterface.php
@@ -51,7 +51,7 @@ public function getUpdatableAttributes(): array;
     //protected function makeOptionalAttributes(array $attributes): array;
     public function getDiscord(): Discord;
     public function createOf(string $class, array|object $data): self;
-    //private static function studly(string $string): string;
+    //private static function studly(string $string, bool $ucfirst = true): string;
     public function __toString(): string;
     public function __debugInfo(): array;
     public function __get(string $key);
diff --git a/src/Discord/Parts/PartTrait.php b/src/Discord/Parts/PartTrait.php
@@ -419,13 +419,14 @@ public function createOf(string $class, array|object $data): self
      * do not want to introduce BC by replacing it. This method is private
      * static as we may move it outside this class in future.
      *
-     * @param string $string The string to convert.
+     * @param string $string  The string to convert.
+     * @param bool   $ucfirst Whether to uppercase the first character.
      *
      * @return string
      *
      * @since 10.0.0
      */
-    private static function studly(string $string): string
+    private static function studly(string $string, bool $ucfirst = true): string
     {
         static $studlyCache = [];
 
@@ -435,7 +436,7 @@ private static function studly(string $string): string
 
         $words = explode(' ', str_replace(['-', '_'], ' ', $string));
 
-        $studlyWords = array_map('ucfirst', $words);
+        $studlyWords = array_map($ucfirst ? 'ucfirst' : null, $words);
 
         return $studlyCache[$string] = implode($studlyWords);
     }
@@ -454,6 +455,7 @@ public function getConstArray(): array
         foreach ($reflection->getConstants() as $name => $value) {
             $map[$name] = $value;
         }
+
         return $map;
     }
 
diff --git a/src/Discord/Parts/User/Activity.php b/src/Discord/Parts/User/Activity.php
@@ -32,7 +32,7 @@
  * @property Carbon|null   $created_at          Timestamp of when the activity was added to the user's session.
  * @property object|null   $timestamps          Unix timestamps for start and/or end of the game.
  * @property string|null   $application_id      Application id for the game.
- * @property ?integer|null $status_display_type Status display type; controls which field is displayed in the user's status text in the member list.
+ * @property ?int|null     $status_display_type Status display type; controls which field is displayed in the user's status text in the member list.
  * @property ?string|null  $details             What the player is currently doing.
  * @property ?string|null  $details_url         URL that is linked when clicking on the details text
  * @property ?string|null  $state               The user's current party status, or text used for a custom status.
diff --git a/src/Discord/Parts/User/Member.php b/src/Discord/Parts/User/Member.php
@@ -90,12 +90,12 @@ class Member extends Part implements Stringable
     /** Member's username, display name, or nickname is blocked by AutoMod. */
     public const FLAGS_AUTOMOD_QUARANTINED_USERNAME = (1 << 7);
     /** Member has dismissed the DM settings upsell. */
-    public const FLAGS_DM_SETTINGS_UPSELL_ACKNOWLEDGED  = (1 << 9);
+    public const FLAGS_DM_SETTINGS_UPSELL_ACKNOWLEDGED = (1 << 9);
     /** Member's guild tag is blocked by AutoMod. */
     public const FLAGS_AUTOMOD_QUARANTINED_GUILD_TAG = (1 << 10);
 
     /**
-     * {@inheritDoc}
+     * @inheritDoc
      */
     protected $fillable = [
         'user',
@@ -875,7 +875,7 @@ public function getVoiceChannel(): ?Channel
     }
 
     /**
-     * {@inheritDoc}
+     * @inheritDoc
      *
      * @link https://discord.com/developers/docs/resources/guild#modify-guild-member-json-params
      */
@@ -887,7 +887,7 @@ public function getUpdatableAttributes(): array
     }
 
     /**
-     * {@inheritDoc}
+     * @inheritDoc
      */
     public function getRepositoryAttributes(): array
     {
diff --git a/src/Discord/Parts/User/Party.php b/src/Discord/Parts/User/Party.php
@@ -22,8 +22,8 @@
  *
  * @since 10.19.0
  *
- * @property string        $id   ID of the party
- * @property object|array  $size Array of two integers (current_size, max_size). Used to show the party's current and maximum size.
+ * @property string       $id   ID of the party
+ * @property object|array $size Array of two integers (current_size, max_size). Used to show the party's current and maximum size.
  */
 class Party extends Part
 {
diff --git a/src/Discord/Parts/User/PrimaryGuild.php b/src/Discord/Parts/User/PrimaryGuild.php
@@ -34,7 +34,7 @@
 class PrimaryGuild extends Part
 {
     /**
-     * {@inheritDoc}
+     * @inheritDoc
      */
     protected $fillable = [
         'id', // @internal
diff --git a/src/Discord/Repository/ActivityInstanceRepository.php b/src/Discord/Repository/ActivityInstanceRepository.php
@@ -13,7 +13,6 @@
 
 namespace Discord\Repository;
 
-use Discord\Discord;
 use Discord\Http\Endpoint;
 use Discord\Parts\OAuth\ActivityInstance;
 
diff --git a/src/Discord/Repository/Channel/MessageRepository.php b/src/Discord/Repository/Channel/MessageRepository.php
@@ -13,7 +13,6 @@
 
 namespace Discord\Repository\Channel;
 
-use Discord\Discord;
 use Discord\Http\Endpoint;
 use Discord\Parts\Channel\Message;
 use Discord\Repository\AbstractRepository;
diff --git a/src/Discord/Repository/EmojiRepository.php b/src/Discord/Repository/EmojiRepository.php
@@ -13,7 +13,6 @@
 
 namespace Discord\Repository;
 
-use Discord\Discord;
 use Discord\Http\Endpoint;
 use Discord\Parts\Guild\Emoji;
 use React\Promise\PromiseInterface;
@@ -37,7 +36,7 @@
 class EmojiRepository extends AbstractRepository
 {
     /**
-     * {@inheritDoc}
+     * @inheritDoc
      */
     protected $endpoints = [
         'all' => Endpoint::APPLICATION_EMOJIS,
@@ -48,12 +47,12 @@ class EmojiRepository extends AbstractRepository
     ];
 
     /**
-     * {@inheritDoc}
+     * @inheritDoc
      */
     protected $class = Emoji::class;
 
     /**
-     * {@inheritDoc}
+     * @inheritDoc
      */
     public function __construct($discord, array $vars = [])
     {
diff --git a/src/Discord/Repository/Guild/CommandPermissionsRepository.php b/src/Discord/Repository/Guild/CommandPermissionsRepository.php
@@ -36,20 +36,20 @@
 class CommandPermissionsRepository extends AbstractRepository
 {
     /**
-     * {@inheritDoc}
+     * @inheritDoc
      */
     protected $endpoints = [
         'all' => Endpoint::GUILD_APPLICATION_COMMANDS_PERMISSIONS,
         'get' => Endpoint::GUILD_APPLICATION_COMMAND_PERMISSIONS,
     ];
 
     /**
-     * {@inheritDoc}
+     * @inheritDoc
      */
     protected $class = CommandPermissions::class;
 
     /**
-     * {@inheritDoc}
+     * @inheritDoc
      *
      * @param Discord $discord
      */
diff --git a/src/Discord/Repository/Guild/GuildCommandRepository.php b/src/Discord/Repository/Guild/GuildCommandRepository.php
@@ -13,7 +13,6 @@
 
 namespace Discord\Repository\Guild;
 
-use Discord\Discord;
 use Discord\Http\Endpoint;
 use Discord\Parts\Interactions\Command\Command;
 use Discord\Repository\AbstractRepository;
@@ -35,7 +34,7 @@
 class GuildCommandRepository extends AbstractRepository
 {
     /**
-     * {@inheritDoc}
+     * @inheritDoc
      */
     protected $endpoints = [
         'all' => Endpoint::GUILD_APPLICATION_COMMANDS,
@@ -46,12 +45,12 @@ class GuildCommandRepository extends AbstractRepository
     ];
 
     /**
-     * {@inheritDoc}
+     * @inheritDoc
      */
     protected $class = Command::class;
 
     /**
-     * {@inheritDoc}
+     * @inheritDoc
      */
     public function __construct($discord, array $vars = [])
     {
diff --git a/src/Discord/Repository/Monetization/EntitlementRepository.php b/src/Discord/Repository/Monetization/EntitlementRepository.php
@@ -36,7 +36,7 @@
 class EntitlementRepository extends AbstractRepository
 {
     /**
-     * {@inheritDoc}
+     * @inheritDoc
      */
     protected $endpoints = [
         'all' => Endpoint::APPLICATION_ENTITLEMENTS,
@@ -46,12 +46,12 @@ class EntitlementRepository extends AbstractRepository
     ];
 
     /**
-     * {@inheritDoc}
+     * @inheritDoc
      */
     protected $class = Entitlement::class;
 
     /**
-     * {@inheritDoc}
+     * @inheritDoc
      */
     public function __construct($discord, array $vars = [])
     {
diff --git a/src/Discord/Repository/Monetization/SKURepository.php b/src/Discord/Repository/Monetization/SKURepository.php
@@ -13,7 +13,6 @@
 
 namespace Discord\Repository\Monetization;
 
-use Discord\Discord;
 use Discord\Http\Endpoint;
 use Discord\Parts\Monetization\SKU;
 use Discord\Repository\AbstractRepository;
diff --git a/src/Discord/Repository/Thread/MemberRepository.php b/src/Discord/Repository/Thread/MemberRepository.php
@@ -13,7 +13,6 @@
 
 namespace Discord\Repository\Thread;
 
-use Discord\Discord;
 use Discord\Http\Endpoint;
 use Discord\Parts\Thread\Member;
 use Discord\Repository\AbstractRepository;
@@ -35,25 +34,25 @@
 class MemberRepository extends AbstractRepository
 {
     /**
-     * {@inheritDoc}
+     * @inheritDoc
      */
     protected $discrim = 'user_id';
 
     /**
-     * {@inheritDoc}
+     * @inheritDoc
      */
     protected $endpoints = [
         'all' => Endpoint::THREAD_MEMBERS,
         'get' => Endpoint::THREAD_MEMBER,
     ];
 
     /**
-     * {@inheritDoc}
+     * @inheritDoc
      */
     protected $class = Member::class;
 
     /**
-     * {@inheritDoc}
+     * @inheritDoc
      */
     public function __construct($discord, array $vars = [])
     {
diff --git a/src/Discord/functions.php b/src/Discord/functions.php
@@ -140,15 +140,16 @@ function contains(string $string, array $matches): bool
 /**
  * Converts a string to studlyCase.
  *
- * @param string $string The string to convert.
+ * @param string $string  The string to convert.
+ * @param bool   $ucfirst The function to apply to each word (default: ucfirst).
  *
  * @return string
  *
  * @since 5.0.12
  */
-function studly(string $string): string
+function studly(string $string, bool $ucfirst = true): string
 {
-    return implode('', array_map('ucfirst', array_map('strtolower', preg_split('/[^a-z0-9]+/i', $string))));
+    return implode('', array_map($ucfirst ? 'ucfirst' : null, array_map('strtolower', preg_split('/[^a-z0-9]+/i', $string))));
 }
 
 /**

Original file line number	Diff line number	Diff line change
`@@ -602,7 +602,7 @@ public function isDisabled(): bool`
`602`	`602`	`}`
`603`	`603`
`604`	`604`	`/**`
`605`		`- * {@inheritDoc}`
	`605`	`+ * @inheritDoc`
`606`	`606`	`*/`
`607`	`607`	`public function jsonSerialize(): array`
`608`	`608`	`{`
Original file line number	Diff line number	Diff line change
`@@ -864,7 +864,7 @@ public function setIsComponentsV2Flag(bool $enable = true): self`
`864`	`864`	`{`
`865`	`865`	`if ($enable) {`
`866`	`866`	`if (! ($this->flags & Message::FLAG_IS_COMPONENTS_V2)) {`
`867`		`- $this->flags \|= Message::FLAG_IS_COMPONENTS_V2 ;`
	`867`	`+ $this->flags \|= Message::FLAG_IS_COMPONENTS_V2;`
`868`	`868`	`}`
`869`	`869`	`} elseif ($this->flags & Message::FLAG_IS_COMPONENTS_V2) {`
`870`	`870`	`$this->flags &= ~Message::FLAG_IS_COMPONENTS_V2;`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@`
`32`	`32`	`class MediaGallery extends Content`
`33`	`33`	`{`
`34`	`34`	`/**`
`35`		`- * {@inheritDoc}`
	`35`	`+ * @inheritDoc`
`36`	`36`	`*/`
`37`	`37`	`protected $fillable = [`
`38`	`38`	`'type',`
Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@`
`30`	`30`	`class MessagePinData extends Part`
`31`	`31`	`{`
`32`	`32`	`/**`
`33`		`- * {@inheritDoc}`
	`33`	`+ * @inheritDoc`
`34`	`34`	`*/`
`35`	`35`	`protected $fillable = [`
`36`	`36`	`'items',`
Original file line number	Diff line number	Diff line change
`@@ -49,7 +49,7 @@ class Role extends Part implements Stringable`
`49`	`49`	`public const IN_PROMPT = 1 << 0; // Role can be selected by members in an onboarding prompt.`
`50`	`50`
`51`	`51`	`/**`
`52`		`- * {@inheritDoc}`
	`52`	`+ * @inheritDoc`
`53`	`53`	`*/`
`54`	`54`	`protected $fillable = [`
`55`	`55`	`'id',`
`@@ -196,7 +196,7 @@ protected function getTagsAttribute(): ?RoleTags`
`196`	`196`	`}`
`197`	`197`
`198`	`198`	`/**`
`199`		`- * {@inheritDoc}`
	`199`	`+ * @inheritDoc`
`200`	`200`	`*`
`201`	`201`	`* @link https://discord.com/developers/docs/resources/guild#create-guild-role-json-params`
`202`	`202`	`*/`
`@@ -214,7 +214,7 @@ public function getCreatableAttributes(): array`
`214`	`214`	`}`
`215`	`215`
`216`	`216`	`/**`
`217`		`- * {@inheritDoc}`
	`217`	`+ * @inheritDoc`
`218`	`218`	`*`
`219`	`219`	`* @link https://discord.com/developers/docs/resources/guild#modify-guild-role-json-params`
`220`	`220`	`*/`
`@@ -232,7 +232,7 @@ public function getUpdatableAttributes(): array`
`232`	`232`	`}`
`233`	`233`
`234`	`234`	`/**`
`235`		`- * {@inheritDoc}`
	`235`	`+ * @inheritDoc`
`236`	`236`	`*/`
`237`	`237`	`public function getRepositoryAttributes(): array`
`238`	`238`	`{`
Original file line number	Diff line number	Diff line change
`@@ -419,13 +419,14 @@ public function createOf(string $class, array\|object $data): self`
`419`	`419`	`* do not want to introduce BC by replacing it. This method is private`
`420`	`420`	`* static as we may move it outside this class in future.`
`421`	`421`	`*`
`422`		`- * @param string $string The string to convert.`
	`422`	`+ * @param string $string The string to convert.`
	`423`	`+ * @param bool $ucfirst Whether to uppercase the first character.`
`423`	`424`	`*`
`424`	`425`	`* @return string`
`425`	`426`	`*`
`426`	`427`	`* @since 10.0.0`
`427`	`428`	`*/`
`428`		`- private static function studly(string $string): string`
	`429`	`+ private static function studly(string $string, bool $ucfirst = true): string`
`429`	`430`	`{`
`430`	`431`	`static $studlyCache = [];`
`431`	`432`
`@@ -435,7 +436,7 @@ private static function studly(string $string): string`
`435`	`436`
`436`	`437`	`$words = explode(' ', str_replace(['-', '_'], ' ', $string));`
`437`	`438`
`438`		`- $studlyWords = array_map('ucfirst', $words);`
	`439`	`+ $studlyWords = array_map($ucfirst ? 'ucfirst' : null, $words);`
`439`	`440`
`440`	`441`	`return $studlyCache[$string] = implode($studlyWords);`
`441`	`442`	`}`
`@@ -454,6 +455,7 @@ public function getConstArray(): array`
`454`	`455`	`foreach ($reflection->getConstants() as $name => $value) {`
`455`	`456`	`$map[$name] = $value;`
`456`	`457`	`}`
	`458`	`+`
`457`	`459`	`return $map;`
`458`	`460`	`}`
`459`	`461`