Refactor getShortNameClass() method to support optional suffix parameter. (#4)

Author: terabytesoftw

CHANGELOG.md

@@ -1,6 +1,8 @@
 # Change Log
 
-## 0.1.1 Under development
+## 0.1.2 February 29, 2024
+
+- Enh #4: Refactor `getShortNameClass()` method to support optional `suffix` and `lowercase` parameters (@terabytesoftw)
 
 ## 0.1.1 February 29, 2024
 

README.md

@@ -153,6 +153,10 @@ The `Utils::class` helper can be used to get the short class name.
 The method accepts one parameter:
 
 - `class:` (string): The class name to get the short name.
+- `suffix:` (string): Whether to append the `::class` suffix to the class name. 
+  For default, it is `true`. If it is `false`, the method will return the short name without the `::class` suffix.
+- `lowercase:` (bool): Whether to convert the class name to lowercase or not. 
+  For default, it is `false`.
 
 ```php
 <?php
@@ -161,7 +165,7 @@ declare(strict_types=1);
 
 use PHPForge\Html\Helper\Utils;
 
-$shortName = Utils::getShortClassName('PHPForge\Html\Helper\Utils'); // return: `Utils`
+$shortName = Utils::getShortClassName('PHPForge\Html\Helper\Utils'); // return: `Utils::class`
 ```
 
 ### Generate arrayable name

src/Utils.php

@@ -10,10 +10,12 @@
 use function mb_strtolower;
 use function preg_match;
 use function preg_replace;
+use function str_ends_with;
 use function str_replace;
 use function strlen;
 use function strrchr;
 use function strrpos;
+use function strtolower;
 use function substr;
 use function uniqid;
 
@@ -155,10 +157,20 @@ public static function generateInputName(string $fieldModel, string $property, b
      * Returns the short name of the given class.
      *
      * @param string $class The class name.
+     * @param bool $suffix Whether to append the `::class` suffix to the class name. If `false`, the suffix will not be
+     * appended.
+     * @param bool $lowercase Whether to return the class name in lowercase. If `false`, the class name will be returned
+     * in its original case.
      */
-    public static function getShortNameClass(string $class): string
+    public static function getShortNameClass(string $class, bool $suffix = true, bool $lowercase = false): string
     {
-        return substr(strrchr($class, '\\'), 1) . '::class';
+        if ($lowercase === true) {
+            $class = strtolower($class);
+        }
+
+        $class = substr(strrchr($class, '\\'), 1);
+
+        return $suffix === true ? "$class::class" : $class;
     }
 
     /**

tests/UtilsTest.php

@@ -95,6 +95,16 @@ public function testGetShortNameClass(): void
         $this->assertSame('UtilsTest::class', Utils::getShortNameClass(self::class));
     }
 
+    public function testGetShortNameClassWithLowercase(): void
+    {
+        $this->assertSame('utilstest', Utils::getShortNameClass(self::class, false, true));
+    }
+
+    public function testGetShortNameClassWithoutSuffix(): void
+    {
+        $this->assertSame('UtilsTest', Utils::getShortNameClass(self::class, false));
+    }
+
     public function testMultibyteGenerateArrayableName(): void
     {
         $this->assertSame('登录[]', Utils::generateArrayableName('登录'));