refactor

Author: efureev

CHANGELOG.md

@@ -4,6 +4,12 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog][keepachangelog] and this project adheres to [Semantic Versioning][semver].
 
+## v4.8.0
+
+### Added
+
+- Add methods `toPostgresPoint`, `fromPostgresPoint` to `Arr` helper
+
 ## v4.7.0
 
 ### Added

composer.json

@@ -20,7 +20,7 @@
   },
   "require-dev": {
     "phpunit/phpunit": "^9.5",
-    "phpstan/phpstan": "~0.12.85",
+    "phpstan/phpstan": "^1.4",
     "squizlabs/php_codesniffer": "^3.6"
   },
   "autoload": {

phpstan.neon.dist

@@ -4,6 +4,6 @@ parameters:
     - src
   checkMissingIterableValueType: false
   checkGenericClassInNonGenericObjectType: false
-  excludes_analyse:
+  excludePaths:
     - 'src/Types/Point.php'
     - 'src/Types/GeoPoint.php'

src/Exceptions/ConfigException.php

@@ -11,22 +11,15 @@
  */
 class ConfigException extends Exception
 {
-    /**
-     * @var mixed
-     */
-    protected $config;
-
     /**
      * ConfigException constructor.
      *
-     * @param mixed|null $config
+     * @param ?array $config
      * @param string $message
      */
-    public function __construct($message = 'Config Exception', $config = null)
+    public function __construct(string $message = 'Config Exception', protected ?array $config = null)
     {
         parent::__construct($message);
-
-        $this->config = $config;
     }
 
     /**

src/Exceptions/InvalidConfigException.php

@@ -14,10 +14,10 @@ class InvalidConfigException extends ConfigException
     /**
      * InvalidConfigException constructor.
      *
-     * @param mixed|null $config
+     * @param ?array $config
      * @param string $message
      */
-    public function __construct($config = null, $message = 'Invalid Configuration')
+    public function __construct(?array $config = null, $message = 'Invalid Configuration')
     {
         parent::__construct($message, $config);
     }

src/Exceptions/MissingConfigException.php

@@ -11,20 +11,13 @@
  */
 class MissingConfigException extends ConfigException
 {
-    /** @var string|null */
-    protected $needKey;
-
     /**
-     * MissingConfigException constructor.
-     *
-     * @param mixed $config
-     * @param string $needKey
+     * @param ?array $config
+     * @param ?string $needKey
      * @param string $message
      */
-    public function __construct($config = null, $needKey = null, $message = 'Missing Config')
+    public function __construct(?array $config = null, protected ?string $needKey = null, $message = 'Missing Config')
     {
-        $this->needKey = $needKey;
-
         parent::__construct($message, $config);
     }
 }

src/Exceptions/MissingPropertyException.php

@@ -11,19 +11,15 @@
  */
 class MissingPropertyException extends ConfigException
 {
-    /** @var string|null */
-    protected $property;
-
     /**
      * MissingPropertyException constructor.
      *
      * @param null|string $message
      * @param null|string $property
-     * @param mixed $config
+     * @param ?array $config
      */
-    public function __construct(?string $message = null, ?string $property = null, $config = null)
+    public function __construct(?string $message = null, protected ?string $property = null, ?array $config = null)
     {
-        $this->property = $property;
         parent::__construct(
             $message ?? ($this->getName() . ($this->property ? ': "' . $this->property . '"' : '')),
             $config

src/Global/base.php

@@ -221,7 +221,7 @@ function remoteStaticCallOrTrow(object|string|null $class, string $method, mixed
             return $class::$method(...$params);
         }
 
-        \Php\Support\Exceptions\MissingMethodException::throw("$class::$method");
+        throw new \Php\Support\Exceptions\MissingMethodException("$class::$method");
     }
 }
 

src/Helpers/Arr.php

@@ -5,6 +5,7 @@
 namespace Php\Support\Helpers;
 
 use ArrayAccess;
+use ArrayObject;
 use JsonSerializable;
 use Php\Support\Interfaces\Arrayable;
 use Php\Support\Interfaces\Jsonable;
@@ -68,7 +69,7 @@ public static function toArray($items): array
             }
         }
 
-        return $res;
+        return (array)$res;
     }
 
     /**
@@ -209,14 +210,14 @@ public static function toIndexedArray(array $array): array
      *
      * @param string|null $s
      * @param int $start
-     * @param null $end
+     * @param ?int $end
      *
      * @return array
      */
     public static function fromPostgresArrayWithBraces(
         ?string $s,
         int $start = 0,
-        &$end = null,
+        ?int &$end = null,
         array $braces = [
             '{',
             '}',
@@ -284,11 +285,23 @@ public static function fromPostgresArrayWithBraces(
         return $return;
     }
 
-    public static function fromPostgresArray(?string $s, int $start = 0, &$end = null): array
+    /**
+     * @param string|null $s
+     * @param int $start
+     * @param ?int $end
+     *
+     * @return array
+     */
+    public static function fromPostgresArray(?string $s, int $start = 0, ?int &$end = null): array
     {
         return static::fromPostgresArrayWithBraces($s, $start, $end, ['{', '}']);
     }
 
+    /**
+     * @param string|null $value
+     *
+     * @return array|null
+     */
     public static function fromPostgresPoint(?string $value): ?array
     {
         if (empty($value)) {
@@ -312,7 +325,7 @@ public static function fromPostgresPoint(?string $value): ?array
      *
      * @return mixed
      */
-    public static function get($array, ?string $key, $default = null)
+    public static function get(mixed $array, ?string $key, mixed $default = null): mixed
     {
         if (!static::accessible($array)) {
             return value($default);
@@ -322,11 +335,12 @@ public static function get($array, ?string $key, $default = null)
             return $array;
         }
 
+        /** @var array|ArrayAccess $array */
         if (static::exists($array, $key)) {
             return $array[$key];
         }
 
-        if (strpos($key, '.') === false) {
+        if (!str_contains($key, '.')) {
             return $array[$key] ?? value($default);
         }
 
@@ -348,7 +362,7 @@ public static function get($array, ?string $key, $default = null)
      *
      * @return bool
      */
-    public static function accessible($value): bool
+    public static function accessible(mixed $value): bool
     {
         return is_array($value) || $value instanceof ArrayAccess;
     }
@@ -361,7 +375,7 @@ public static function accessible($value): bool
      *
      * @return bool
      */
-    public static function exists($array, $key): bool
+    public static function exists(ArrayAccess|array $array, string|int $key): bool
     {
         if ($array instanceof ArrayAccess) {
             return $array->offsetExists($key);
@@ -378,7 +392,7 @@ public static function exists($array, $key): bool
      *
      * @return bool
      */
-    public static function has($array, $keys): bool
+    public static function has(ArrayAccess|array $array, string|array $keys): bool
     {
         $keys = (array)$keys;
 
@@ -410,13 +424,13 @@ public static function has($array, $keys): bool
      *
      * If no key is given to the method, the entire array will be replaced.
      *
-     * @param ?array $array
+     * @param array|ArrayObject|null $array
      * @param string $key
      * @param mixed $value
      *
-     * @return array|null
+     * @return array|ArrayObject|null
      */
-    public static function set(&$array, string $key, $value): ?array
+    public static function set(array|ArrayObject|null &$array, string $key, mixed $value): array|ArrayObject|null
     {
         if ($array === null) {
             return $array;
@@ -442,12 +456,12 @@ public static function set(&$array, string $key, $value): ?array
     /**
      * Remove one or many array items from a given array using "dot" notation.
      *
-     * @param array $array
+     * @param array|ArrayObject $array
      * @param array|string $keys
      *
      * @return void
      */
-    public static function remove(&$array, $keys): void
+    public static function remove(array|ArrayObject &$array, array|string $keys): void
     {
         $original = &$array;
         $keys     = (array)$keys;
@@ -497,7 +511,7 @@ public static function replaceByTemplate(array $array, array $replace): array
     {
         $res = [];
         foreach ($array as $key => $item) {
-            $res[$key] = static::itemReplaceByTemplate($item, $replace);
+            $res[$key] = self::itemReplaceByTemplate($item, $replace);
         }
         return $res;
     }

src/Helpers/Json.php

@@ -41,7 +41,7 @@ public static function htmlEncode($value): ?string
      * @param int $options the encoding options. For more details please refer to
      *                       <http://www.php.net/manual/en/function.json-encode.php>. Default is
      *                       `JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE`.
-     * @param int $depth
+     * @param int<1, max> $depth
      *
      * @return string|null
      */
@@ -59,7 +59,7 @@ public static function encode($value, $options = 320, int $depth = 512): ?string
      * @param null|string $json the JSON string to be decoded
      * @param bool $asArray whether to return objects in terms of associative arrays.
      * @param int $options
-     * @param int $depth
+     * @param int<1, max> $depth
      *
      * @return mixed|null
      */