Added Helpers utility class (#39)

Author: robinsonjohn

CHANGELOG.md

@@ -12,6 +12,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - `Fixed` for any bug fixes.
 - `Security` in case of vulnerabilities
 
+## [5.3.0]- 2024.10.30
+
+### Added
+
+- Added `Helpers` utility class.
+
 ## [5.2.0]- 2024.09.16
 
 ### Added

composer.json

@@ -41,9 +41,9 @@
     "bayfrontmedia/php-http-response": "^2.0",
     "bayfrontmedia/php-time-helpers": "^2.0",
     "bayfrontmedia/route-it": "^3.1",
-    "bayfrontmedia/simple-pdo": "^5.0",
+    "bayfrontmedia/simple-pdo": "^5.3",
     "bayfrontmedia/veil": "^2.1",
-    "filp/whoops": "^2.15",
+    "filp/whoops": "^2.16",
     "symfony/console": "^7.1",
     "vlucas/phpdotenv": "^5.6"
   }

composer.lock

@@ -105,4 +105,5 @@ The following services are included with Bones:
 ### Utilities
 
 - [App](utilities/app.md)
-- [Constants](utilities/constants.md)
+- [Constants](utilities/constants.md)
+- [Helpers](utilities/helpers.md)

docs/README.md

@@ -0,0 +1,42 @@
+# Utilities: Helpers
+
+The helpers utility has the namespace `Bayfront\Bones\Application\Utilities\Helpers` 
+and contains miscellaneous helper functions.
+All methods are static.
+
+## Methods
+
+- [classUses](#classuses)
+- [traituses](#traituses)
+
+<hr />
+
+### classUses
+
+**Description:**
+
+Recursively return the traits used by the given class and all of its parent classes.
+
+**Parameters:**
+
+- `$class` (object|string)
+
+**Returns:**
+
+- (array)
+
+<hr />
+
+### traitUses
+
+**Description:**
+
+Recursively return all traits used by a trait and its traits.
+
+**Parameters:**
+
+- `$trait` (object|string)
+
+**Returns:**
+
+- (array)

docs/utilities/helpers.md

@@ -0,0 +1,54 @@
+<?php
+
+namespace Bayfront\Bones\Application\Utilities;
+
+class Helpers
+{
+
+    /**
+     * Recursively return the traits used by the given class and all of its parent classes.
+     *
+     * See: https://laravel.com/docs/11.x/helpers#method-class-uses-recursive
+     *
+     * @param object|string $class
+     * @return array
+     */
+    public static function classUses(object|string $class): array
+    {
+
+        if (is_object($class)) {
+            $class = get_class($class);
+        }
+
+        $results = [];
+
+        foreach (array_reverse(class_parents($class) ?: []) + [$class => $class] as $class) {
+            $results += self::traitUses($class);
+        }
+
+        return array_unique($results);
+
+    }
+
+    /**
+     * Recursively return all traits used by a trait and its traits.
+     *
+     * See: https://laravel.com/docs/11.x/helpers#method-trait-uses-recursive
+     *
+     * @param object|string $trait
+     * @return array
+     */
+    public static function traitUses(object|string $trait): array
+    {
+
+        $traits = class_uses($trait) ?: [];
+
+        foreach ($traits as $trait) {
+            $traits += self::traitUses($trait);
+        }
+
+        return $traits;
+
+    }
+
+}

src/Application/Utilities/Helpers.php

@@ -150,7 +150,7 @@ public function start(string $interface): void
         Constants::define('APP_STORAGE_PATH', Constants::get('APP_BASE_PATH') . '/storage');
         Constants::define('BONES_BASE_PATH', rtrim(dirname(__FILE__, 2), '/'));
         Constants::define('BONES_RESOURCES_PATH', Constants::get('BONES_BASE_PATH') . '/resources');
-        Constants::define('BONES_VERSION', '5.2.0');
+        Constants::define('BONES_VERSION', '5.3.0');
         // ------------------------- Load environment variables -------------------------
 
         if (file_exists(App::basePath('/.env'))) {