update some and format codes

Author: inhere

.php_cs

@@ -8,36 +8,42 @@ This file is part of toolkit/stdlib.
 @license  MIT
 EOF;
 
+$rules = [
+    '@PSR2' => true,
+    'array_syntax' => [
+        'syntax' => 'short'
+    ],
+    'list_syntax' => [
+        'syntax' => 'short'
+    ],
+    'class_attributes_separation' => true,
+    'declare_strict_types' => true,
+    'global_namespace_import' => [
+        'import_constants' => true,
+        'import_functions' => true,
+    ],
+    'header_comment' => [
+        'comment_type' => 'PHPDoc',
+        'header'    => $header,
+        'separate'  => 'bottom'
+    ],
+    'no_unused_imports' => true,
+    'return_type_declaration' => [
+        'space_before' => 'none',
+    ],
+    'single_quote' => true,
+    'standardize_not_equals' => true,
+    'void_return' => true, // add :void for method
+];
+
 return PhpCsFixer\Config::create()
-    ->setRiskyAllowed(true)
-    ->setRules([
-        '@PSR2' => true,
-        'array_syntax' => [
-            'syntax' => 'short'
-        ],
-        'list_syntax' => [
-            'syntax' => 'short'
-        ],
-        'class_attributes_separation' => true,
-        'declare_strict_types' => true,
-        'global_namespace_import' => [
-            'import_constants' => true,
-            'import_functions' => true,
-        ],
-        'header_comment' => [
-            'comment_type' => 'PHPDoc',
-            'header'    => $header,
-            'separate'  => 'bottom'
-        ],
-        'no_unused_imports' => true,
-        'single_quote' => true,
-        'standardize_not_equals' => true,
-    ])
-    ->setFinder(
-        PhpCsFixer\Finder::create()
-            // ->exclude('test')
-            ->exclude('runtime')
-            ->exclude('vendor')
-            ->in(__DIR__)
-    )
-    ->setUsingCache(false);
+            ->setRiskyAllowed(true)
+            ->setRules($rules)
+            ->setFinder(
+                PhpCsFixer\Finder::create()
+                    // ->exclude('test')
+                     ->exclude('runtime')
+                     ->exclude('vendor')
+                     ->in(__DIR__)
+            )
+            ->setUsingCache(false);

README.md

@@ -1,6 +1,27 @@
 # StdLib
 
-stdlib tools for PHP
+[![License](https://img.shields.io/github/license/php-toolkit/stdlib)](LICENSE)
+[![Php Version](https://img.shields.io/badge/php-%3E7.1.0-brightgreen.svg?maxAge=2592000)](https://packagist.org/packages/toolkit/stdlib)
+[![Latest Stable Version](http://img.shields.io/packagist/v/toolkit/stdlib.svg)](https://packagist.org/packages/toolkit/stdlib)
+
+Some useful basic tool class for php.
+
+Contains:
+
+- array handle
+- object handle
+- string handle
+- simple autoloader
+- dot env load `.env`
+- common php helper
+- os env info
+- and more ...
+
+## Install
+
+```bash
+composer require toolkit/stdlib
+```
 
 ## License
 

src/Arr/ArrayHelper.php

@@ -250,7 +250,7 @@ public static function valueTrim(array $data)
             return trim($data);
         }
 
-        array_walk_recursive($data, function (&$value) {
+        array_walk_recursive($data, function (&$value): void {
             $value = trim($value);
         });
 

src/Arr/FixedArray.php

@@ -72,7 +72,7 @@ public function __isset(string $key)
      * @param string $key
      * @param mixed  $value
      */
-    public function __set(string $key, $value)
+    public function __set(string $key, $value): void
     {
         $this->offsetSet($key, $value);
     }

src/Helper/PhpHelper.php

@@ -1,9 +1,9 @@
 <?php declare(strict_types=1);
 /**
- * This file is part of toolkit/phpkit.
+ * This file is part of toolkit/stdlib.
  *
  * @author   https://github.com/inhere
- * @link     https://github.com/php-toolkit/phpkit
+ * @link     https://github.com/php-toolkit/stdlib
  * @license  MIT
  */
 
@@ -12,7 +12,6 @@
 use Toolkit\Stdlib\Obj\ObjectHelper;
 use function array_sum;
 use function explode;
-use function get_defined_constants;
 use function is_array;
 use function is_object;
 use function is_string;

src/OS.php

@@ -1,9 +1,9 @@
 <?php declare(strict_types=1);
 /**
- * This file is part of toolkit/phpkit.
+ * This file is part of toolkit/stdlib.
  *
  * @author   https://github.com/inhere
- * @link     https://github.com/php-toolkit/phpkit
+ * @link     https://github.com/php-toolkit/stdlib
  * @license  MIT
  */
 

src/Obj/Traits/PropertyAccessByGetterSetterTrait.php

@@ -37,7 +37,7 @@ trait PropertyAccessByGetterSetterTrait
      *
      * @throws SetPropertyException
      */
-    public function __set($name, $value)
+    public function __set($name, $value): void
     {
         $setter = 'set' . ucfirst($name);
 
@@ -94,7 +94,7 @@ public function __isset($name)
      *
      * @throws PropertyException
      */
-    public function __unset($name)
+    public function __unset($name): void
     {
         $setter = 'set' . ucfirst($name);
 

src/Php.php

@@ -1,4 +1,11 @@
 <?php declare(strict_types=1);
+/**
+ * This file is part of toolkit/stdlib.
+ *
+ * @author   https://github.com/inhere
+ * @link     https://github.com/php-toolkit/stdlib
+ * @license  MIT
+ */
 
 namespace Toolkit\Stdlib;
 
@@ -11,5 +18,4 @@
  */
 class Php extends PhpHelper
 {
-
 }

src/Str/HtmlHelper.php

@@ -9,53 +9,61 @@
 
 namespace Toolkit\Stdlib\Str;
 
-use function is_string;
-use function htmlspecialchars;
+use function array_key_exists;
+use function html_entity_decode;
 use function htmlentities;
-use function strpos;
-use function is_array;
+use function htmlspecialchars;
 use function htmlspecialchars_decode;
-use function html_entity_decode;
+use function is_array;
+use function is_string;
 use function preg_match_all;
-use function array_key_exists;
+use function preg_replace;
+use function strpos;
 
 /**
  * Class HtmlHelper
+ *
  * @package Toolkit\Stdlib\Str
  */
 class HtmlHelper
 {
     /**
      * Encodes special characters into HTML entities.
+     *
      * @param string $text data to be encoded
      * @param string $charset
+     *
      * @return string the encoded data
      * @see http://www.php.net/manual/en/function.htmlspecialchars.php
      */
-    public static function encode($text, $charset = 'utf-8'): string
+    public static function encode(string $text, string $charset = 'utf-8'): string
     {
         return htmlspecialchars($text, ENT_QUOTES, $charset);
     }
 
     /**
      * This is the opposite of {@link encode()}.
+     *
      * @param string $text data to be decoded
+     *
      * @return string the decoded data
      * @see http://www.php.net/manual/en/function.htmlspecialchars-decode.php
      */
-    public static function decode($text): string
+    public static function decode(string $text): string
     {
         return htmlspecialchars_decode($text, ENT_QUOTES);
     }
 
     /**
      * @form yii1
+     *
      * @param array  $data data to be encoded
      * @param string $charset
+     *
      * @return array the encoded data
-     * @see http://www.php.net/manual/en/function.htmlspecialchars.php
+     * @see  http://www.php.net/manual/en/function.htmlspecialchars.php
      */
-    public static function encodeArray($data, $charset = 'utf-8'): array
+    public static function encodeArray($data, string $charset = 'utf-8'): array
     {
         $d = [];
 
@@ -84,12 +92,14 @@ public static function encodeArray($data, $charset = 'utf-8'): array
      *  htmlentities() <--> html_entity_decode() — 将特殊的 HTML 实体转换回普通字符
      *  htmlspecialchars() <--> htmlspecialchars_decode() — 将特殊的 HTML 实体转换回普通字符
      * ENT_COMPAT ENT_QUOTES ENT_NOQUOTES ENT_HTML401 ENT_XML1 ENT_XHTML ENT_HTML5
+     *
      * @param        $data
      * @param int    $type
      * @param string $encoding
+     *
      * @return array|mixed|string
      */
-    public static function escape($data, int $type = 0, $encoding = 'UTF-8')
+    public static function escape($data, int $type = 0, string $encoding = 'UTF-8')
     {
         if (is_array($data)) {
             foreach ($data as $k => $v) {
@@ -108,26 +118,28 @@ public static function escape($data, int $type = 0, $encoding = 'UTF-8')
 
         //如‘&#x5FD7;’这样的16进制的html字符，为了防止这样的字符被错误转译，使用正则进行匹配，把这样的字符又转换回来。
         if (strpos($data, '&#')) {
-            $data = \preg_replace('/&((#(\d{3,5}|x[a-fA-F0-9]{4}));)/', '&\\1', $data);
+            $data = preg_replace('/&((#(\d{3,5}|x[a-fA-F0-9]{4}));)/', '&\\1', $data);
         }
 
         return $data;
     }
 
     /**
      * 去掉html转义
-     * @param        $data
-     * @param int    $type
-     * @param string $encoding
+     *
+     * @param string|array $data
+     * @param int          $type
+     * @param string       $encoding
+     *
      * @return array|string
      */
-    public static function unescap($data, $type = 0, $encoding = 'UTF-8')
+    public static function unescap($data, $type = 0, string $encoding = 'UTF-8')
     {
         if (is_array($data)) {
             foreach ($data as $k => $v) {
                 $data[$k] = self::unescap($data, $type, $encoding);
             }
-        } elseif (!$type) {//默认使用  htmlspecialchars_decode()
+        } elseif (!$type) {// 默认使用  htmlspecialchars_decode()
             $data = htmlspecialchars_decode($data, \ENT_QUOTES);
         } else {
             $data = html_entity_decode($data, \ENT_QUOTES, $encoding);
@@ -138,7 +150,9 @@ public static function unescap($data, $type = 0, $encoding = 'UTF-8')
 
     /**
      * Strip img-tags from string
-     * @param   string $string Sting to be cleaned.
+     *
+     * @param string $string Sting to be cleaned.
+     *
      * @return  string  Cleaned string
      */
     public static function stripImages(string $string): string
@@ -148,37 +162,44 @@ public static function stripImages(string $string): string
 
     /**
      * Strip iframe-tags from string
-     * @param   string $string Sting to be cleaned.
+     *
+     * @param string $string Sting to be cleaned.
+     *
      * @return  string  Cleaned string
      */
     public static function stripIframes(string $string): string
     {
-        return \preg_replace('#(<[/]?iframe.*>)#U', '', $string);
+        return preg_replace('#(<[/]?iframe.*>)#U', '', $string);
     }
 
     /**
      * stripScript
+     *
      * @param string $string
+     *
      * @return string
      */
     public static function stripScript(string $string): string
     {
-        return \preg_replace('/<script[^>]*>.*?</script>/si', '', $string);
+        return preg_replace('/<script[^>]*>.*?</script>/si', '', $string);
     }
 
     /**
      * stripStyle
+     *
      * @param string $string
+     *
      * @return string
      */
     public static function stripStyle(string $string): string
     {
-        return \preg_replace('/<style[^>]*>.*?</style>/si', '', $string);
+        return preg_replace('/<style[^>]*>.*?</style>/si', '', $string);
     }
 
     /**
      * @param string    $html
      * @param bool|true $onlySrc
+     *
      * @return array
      */
     public static function matchImages(string $html, bool $onlySrc = true): array
@@ -199,6 +220,7 @@ public static function matchImages(string $html, bool $onlySrc = true): array
 
     /**
      * @param string $html
+     *
      * @return string
      */
     public static function minify(string $html): string
@@ -212,6 +234,6 @@ public static function minify(string $html): string
         ];
         $replace = [' ', ' ', '>', '<', '\\1'];
 
-        return \preg_replace($search, $replace, $html);
+        return preg_replace($search, $replace, $html);
     }
 }