fix StrUtility::translate() method bug

Author: dvlpr1996

.gitignore

@@ -3,3 +3,4 @@ vendor/
 /.phpunit.cache
 .phpunit.result.cache
 lang/
+index.php

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 All notable changes to `dvlpr1996/php-string-helpers` will be documented in this file
 
+## 2.0.1(2023-05-22)
+
+fix StrUtility::translate() method bug
+
 ## 2.0.0 (2023-01-18)
 
 Change the implementation of package structure now user can use this library in 3 different ways

README.md

@@ -1,4 +1,4 @@
-# helpful set of PHP string helper functions & utilities class
+# Helpful Set Of Php String Helper Functions Utilities Class
 
 
 [![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)
@@ -112,21 +112,22 @@ StrUtility::alternate(?string $string, string $alternate = null): string
 - translation methods, for using this method you should create a wrapper function 
 for example 
 
-```
-function <your_wrapper_function_name>(string $key, string $replace = '', string $dirName = 'en')
+```php
+function <your_wrapper_function_name>(string $key, string $alternative = '', string $dirName = 'en')
 {
     $BASE_PATH = // base (root) path of your project
 
     $translatePath = StrUtility::translatePath($BASE_PATH, $dirName);
-    return StrUtility::translate($translatePath . $key, $replace);
+    return StrUtility::translate($translatePath . $key, $alternative);
 }
 ```
 
 < your_wrapper_function_name>('app.title') reference to lang/en/app.php and title array key in app.php
 file app.php must only return associative array.
+this translation methods only work for one level
 
 ```php
-StrUtility::translate(string $key, string $replace = '', string $dirName = 'en'): string
+StrUtility::translate(string $key, string $alternative = ''): string|array
 ```
 
 - wrap given string with wrapper param

src/PhpStringHelpers.php

@@ -103,9 +103,9 @@ function alternate(?string $string, ?string $alternate = null): string
 }
 
 if (!function_exists('translate')) {
-    function translate(string $key, string $replace = ''): string
+    function translate(string $key, string $alternative = ''): string|array
     {
-        return strHelpers::translate($key, $replace);
+        return strHelpers::translate($key, $alternative);
     }
 }
 

src/utility/StrUtility.php

@@ -1,7 +1,7 @@
 <?php
 
 /**
- * @Package: some useful php string utility methods
+ * @Package: Some Useful Php String Utility Methods
  * @Class  : StrUtility
  * @Author : Nima jahan bakhshian / dvlpr1996 <nimajahanbakhshian@gmail.com>
  * @URL    : https://github.com/dvlpr1996
@@ -178,32 +178,37 @@ public function alternate(?string $string, string $alternate = null): string
     }
 
     /**
-     * translation methods
+     * translation methods just for one level
      * create lang folder in root of your project
      * then create wrapper function or method based on documentation
      *
      * @param string $key |
      * <your custom wrapper>('app.title') reference to ./lang/en/app.php and
      * title array key in app.php file
-     * @param string $replace
+     * @param string $alternative
      * [optional]
      * @return string
      * @throws FileDoesNotExistsException
      * @throws LanguageFileIsNotArrayException
      */
-    public function translate(string $key, string $replace = ''): string
+    public function translate(string $key, string $alternative = ''): string|array
     {
-        $fileName = explode('.', $key);
-        $key = $fileName[1];
-        $filePath = $this->filePath($fileName[0]);
+        $keys = explode('.', $key);
 
-        $data = require_once $filePath;
+        $filePath = $this->filePath($keys[0]);
+
+        $data = require $filePath;
+
+        if (!isset($keys[1]))
+            return $data;
+
+        $key = $keys[1];
 
         if (!is_array($data))
-            throw new LanguageFileIsNotArrayException("File data should be array");
+            throw new LanguageFileIsNotArrayException('File data should be array');
 
         if (!key_exists($key, $data))
-            return html_entity_decode(htmlentities($replace));
+            return html_entity_decode(htmlentities($alternative));
 
         return html_entity_decode(htmlentities($data[$key]));
     }
@@ -457,7 +462,7 @@ public function hexToRgb(string $color): ?string
         if (strlen($hex) !== 6)
             return null;
 
-        if (!preg_match("/^[0-9ABCDEFabcdef\#]+$/i", $hex))
+        if (!preg_match('/^[0-9ABCDEFabcdef\#]+$/i', $hex))
             return null;
 
         $r = substr($hex, 0, 2);
@@ -480,7 +485,7 @@ public function rgbToHex(string $color): ?string
         $rgb = explode('.', $color);
 
         foreach ($rgb as $value) {
-            if (!preg_match("/^[0-9]+$/i", $value))
+            if (!preg_match('/^[0-9]+$/i', $value))
                 return null;
         }
 
@@ -502,7 +507,7 @@ public function generateAnchor(string|int $content, string $href): string
         if (!filter_var($href, FILTER_VALIDATE_URL))
             throw new UrlIsNotValidException('Url Is Not Valid');
 
-        return "<a href=$href>" . $this->clearString($content) . '</a>';
+        return '<a href=$href>' . $this->clearString($content) . '</a>';
     }
 
     /**
@@ -715,7 +720,7 @@ public function rmEndingNumbers(string $string): string
 
     public function convertToUtf8(string $string): string|bool
     {
-        $converter = iconv(mb_detect_encoding($string, mb_detect_order(), true), "UTF-8", $string);
+        $converter = iconv(mb_detect_encoding($string, mb_detect_order(), true), 'UTF-8', $string);
         return $converter ? $converter : false;
     }
 

tests/StrUtilityTest.php

@@ -212,7 +212,9 @@ public function testTranslateCanReturnStringValue()
     public function testTranslateCanThrowExceptionIfLangFileDoesNotExists()
     {
         $this->expectException(FileDoesNotExistsException::class);
-        $string = strHelpersTest::translate('validation.first_name');
+
+        $translatePath = strHelpersTest::translatePath(realpath($this->basePath), 'en');
+        strHelpersTest::translate($translatePath . 'validation.first_name');
     }
 
     public function testTranslateCanThrowExceptionIfLangFileDoesNotInArrayType()
@@ -222,12 +224,12 @@ public function testTranslateCanThrowExceptionIfLangFileDoesNotInArrayType()
         strHelpersTest::translate($translatePath . 'auth.title');
     }
 
-    // public function testTranslateCanReturnReplaceParamIfGivenKeyDoesNotExists()
-    // {
-    //     $translatePath = strHelpersTest::translatePath(realpath($this->basePath), 'en');
-    //     $string = strHelpersTest::translate($translatePath . 'app.site', 'replace text');
-    //     $this->assertEquals('replace text', $string);
-    // }
+    public function testTranslateCanReturnReplaceParamIfGivenKeyDoesNotExists()
+    {
+        $translatePath = strHelpersTest::translatePath(realpath($this->basePath), 'en');
+        $string = strHelpersTest::translate($translatePath . 'app.site', 'replace text');
+        $this->assertEquals('replace text', $string);
+    }
 
     public function testFilePathCanReturnStringValue()
     {