up: add new method for convert val to bool

Author: inhere

src/Helper/DataHelper.php

@@ -0,0 +1,49 @@
+<?php declare(strict_types=1);
+
+namespace Toolkit\Stdlib\Helper;
+
+use function filter_var;
+use function is_scalar;
+use const FILTER_NULL_ON_FAILURE;
+use const FILTER_VALIDATE_BOOLEAN;
+
+/**
+ * Class DataHelper
+ *
+ * @package Toolkit\Stdlib\Helper
+ */
+class DataHelper
+{
+    /**
+     * 布尔值验证，转换成字符串后是下列的一个，就认为他是个bool值
+     *   - "1"、"true"、"on" 和 "yes" (equal TRUE)
+     *   - "0"、"false"、"off"、"no" 和 ""(equal FALSE)
+     * 注意： NULL 不是标量类型
+     *
+     * @param int|string $val
+     * @param bool|mixed  $nullAsFalse
+     *
+     * @return bool
+     */
+    public static function boolean($val, $nullAsFalse = false): bool
+    {
+        if ($val !== null && !is_scalar($val)) {
+            return (bool)$val;
+        }
+
+        return filter_var($val, FILTER_VALIDATE_BOOLEAN, [
+            'flags' => $nullAsFalse ? FILTER_NULL_ON_FAILURE : 0
+        ]);
+    }
+
+    /**
+     * @param mixed $val
+     * @param false|mixed $nullAsFalse
+     *
+     * @return bool
+     */
+    public static function toBool($val, $nullAsFalse = false): bool
+    {
+        return self::boolean($val, $nullAsFalse);
+    }
+}

src/Str/StrObject.php

@@ -92,10 +92,21 @@ public function setString(string $string): void
      */
     public function trim(string $chars = " \t\n\r\0\x0B"): self
     {
-        $this->string = trim($this->string, $chars);
+        if ($this->string) {
+            $this->string = trim($this->string, $chars);
+        }
+
         return $this;
     }
 
+    /**
+     * @return bool
+     */
+    public function isEmpty(): bool
+    {
+        return $this->string !== '';
+    }
+
     /**
      * @return int
      */
@@ -146,6 +157,14 @@ public function hasSuffix(string $suffix): bool
 
     // ------------------ convert ------------------
 
+    /**
+     * @return int
+     */
+    public function toInt(): int
+    {
+        return (int)$this->string;
+    }
+
     /**
      * @return int
      */
@@ -157,19 +176,51 @@ public function getInt(): int
     /**
      * @return int[]
      */
-    public function getInts(string $sep = ','): array
+    public function toInts(string $sep = ','): array
     {
         return Str::str2ints($this->string, $sep);
     }
 
+    /**
+     * @return int[]
+     */
+    public function getInts(string $sep = ','): array
+    {
+        return $this->toInts($sep);
+    }
+
+    /**
+     * @return bool
+     */
+    public function toBool(): bool
+    {
+        return Str::toBool($this->string);
+    }
+
     /**
      * @return string[]
      */
-    public function getStrings(string $sep = ',', int $limit = 0): array
+    public function toArray(string $sep = ',', int $limit = 0): array
+    {
+        return $this->toStrings($sep, $limit);
+    }
+
+    /**
+     * @return string[]
+     */
+    public function toStrings(string $sep = ',', int $limit = 0): array
     {
         return Str::explode($this->string, $sep, $limit);
     }
 
+    /**
+     * @return string[]
+     */
+    public function getStrings(string $sep = ',', int $limit = 0): array
+    {
+        return $this->toStrings($sep, $limit);
+    }
+
     /**
      * @return string
      */

src/Str/StringHelper.php

@@ -13,7 +13,7 @@
 use Toolkit\Stdlib\Str\Traits\StringCaseHelperTrait;
 use Toolkit\Stdlib\Str\Traits\StringCheckHelperTrait;
 use Toolkit\Stdlib\Str\Traits\StringLengthHelperTrait;
-use Toolkit\Stdlib\Str\Traits\StringSplitHelperTrait;
+use Toolkit\Stdlib\Str\Traits\StringConvertTrait;
 use Toolkit\Stdlib\Str\Traits\StringTruncateHelperTrait;
 use Toolkit\Stdlib\Util\UUID;
 use function array_merge;
@@ -50,7 +50,7 @@ abstract class StringHelper
     use StringCaseHelperTrait;
     use StringCheckHelperTrait;
     use StringLengthHelperTrait;
-    use StringSplitHelperTrait;
+    use StringConvertTrait;
     use StringTruncateHelperTrait;
 
     /**

src/Str/Traits/StringCaseHelperTrait.php

@@ -44,7 +44,7 @@ trait StringCaseHelperTrait
     /**
      * Alias of the `strtolower()`
      *
-     * @param string $str
+     * @param string|int $str
      *
      * @return string
      */
@@ -56,7 +56,7 @@ public static function lower($str): string
     /**
      * Alias of the `strtolower()`
      *
-     * @param string $str
+     * @param string|int $str
      *
      * @return string
      */
@@ -86,7 +86,7 @@ public static function strtolower(string $str): string
     /**
      * Alias of the `strtoupper()`
      *
-     * @param string $str
+     * @param string|int $str
      *
      * @return string
      */
@@ -98,7 +98,7 @@ public static function upper($str): string
     /**
      * Alias of the `strtoupper()`
      *
-     * @param string $str
+     * @param string|int $str
      *
      * @return string
      */
@@ -108,7 +108,7 @@ public static function toUpper($str): string
     }
 
     /**
-     * @param string $str
+     * @param string|int $str
      *
      * @return string
      */

src/Str/Traits/StringSplitHelperTrait.php renamed to src/Str/Traits/StringConvertTrait.php

@@ -9,6 +9,7 @@
 
 namespace Toolkit\Stdlib\Str\Traits;
 
+use Toolkit\Stdlib\Helper\DataHelper;
 use function array_map;
 use function array_values;
 use function count;
@@ -29,8 +30,17 @@
  *
  * @package Toolkit\Stdlib\Str\Traits
  */
-trait StringSplitHelperTrait
+trait StringConvertTrait
 {
+    /**
+     * @param string $str
+     *
+     * @return bool
+     */
+    public static function toBool(string $str): bool
+    {
+        return DataHelper::boolean($str);
+    }
 
     ////////////////////////////////////////////////////////////////////////
     /// split to array
@@ -185,7 +195,7 @@ public static function splitByWidth(string $string, int $width = 1): array
 
     /**
      * @param string $str
-     * @param int $length
+     * @param int    $length
      *
      * @return array|string[]
      * @link https://www.php.net/manual/zh/function.str-split.php

test/Helper/DataHelperTest.php

@@ -0,0 +1,25 @@
+<?php declare(strict_types=1);
+
+namespace Toolkit\StdlibTest\Str;
+
+use PHPUnit\Framework\TestCase;
+use Toolkit\Stdlib\Helper\DataHelper;
+
+/**
+ * Class DataHelperTest
+ *
+ * @package Toolkit\StdlibTest\Str
+ */
+class DataHelperTest extends TestCase
+{
+    public function testToBool(): void
+    {
+        self::assertTrue(DataHelper::toBool(1));
+        self::assertTrue(DataHelper::toBool('1'));
+        self::assertTrue(DataHelper::toBool('on'));
+        self::assertTrue(DataHelper::toBool('true'));
+        self::assertFalse(DataHelper::toBool('false'));
+        self::assertFalse(DataHelper::toBool('off'));
+        self::assertFalse(DataHelper::toBool('0'));
+    }
+}