0.8.0

Author: SoftCreatR

CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+### 0.8.0
+🔻 Breaking changes ahead:
+
+ - Dropped support for PHP < 8.0
+ - Removed deprecated method `JSONPath->data()`
+
+
 ### 0.7.5
  - Added support for $.length
  - Added trim to explode to support both 1,2,3 and 1, 2, 3 inputs

README.md

@@ -20,7 +20,7 @@ This project aims to be a clean and simple implementation with the following goa
 ## Installation
 
 ```bash
-composer require softcreatr/jsonpath:"^0.5 || ^0.7"
+composer require softcreatr/jsonpath:"^0.5 || ^0.7 || ^0.8"
 ```
 
 ## JSONPath Examples

composer.json

@@ -1,7 +1,7 @@
 {
   "name": "softcreatr/jsonpath",
   "description": "JSONPath implementation for parsing, searching and flattening arrays",
-  "version": "0.7.5",
+  "version": "0.8.0",
   "license": "MIT",
   "authors": [
     {
@@ -13,21 +13,21 @@
     {
       "name": "Sascha Greuel",
       "email": "[email protected]",
-      "homepage": "http://1-2.dev",
+      "homepage": "https://1-2.dev",
       "role": "Developer"
     }
   ],
   "require": {
-    "php": ">=7.1",
+    "php": ">=8.0",
     "ext-json": "*"
   },
   "replace": {
     "flow/jsonpath": "*"
   },
   "require-dev": {
-    "phpunit/phpunit": ">=7.0",
-    "roave/security-advisories": "dev-master",
-    "squizlabs/php_codesniffer": "^3.5"
+    "phpunit/phpunit": "^9.5",
+    "roave/security-advisories": "dev-latest",
+    "squizlabs/php_codesniffer": "^3.6"
   },
   "config": {
     "optimize-autoloader": true,

src/AccessHelper.php

@@ -26,10 +26,7 @@
 
 class AccessHelper
 {
-    /**
-     * @param array|ArrayAccess $collection
-     */
-    public static function collectionKeys($collection): array
+    public static function collectionKeys(mixed $collection): array
     {
         if (is_object($collection)) {
             return array_keys(get_object_vars($collection));
@@ -38,18 +35,12 @@ public static function collectionKeys($collection): array
         return array_keys($collection);
     }
 
-    /**
-     * @param array|ArrayAccess $collection
-     */
-    public static function isCollectionType($collection): bool
+    public static function isCollectionType(mixed $collection): bool
     {
         return is_array($collection) || is_object($collection);
     }
 
-    /**
-     * @param array|ArrayAccess $collection
-     */
-    public static function keyExists($collection, $key, bool $magicIsAllowed = false): bool
+    public static function keyExists(mixed $collection, $key, bool $magicIsAllowed = false): bool
     {
         if ($magicIsAllowed && is_object($collection) && method_exists($collection, '__get')) {
             return true;
@@ -76,14 +67,9 @@ public static function keyExists($collection, $key, bool $magicIsAllowed = false
 
     /**
      * @todo Optimize conditions
-     *
-     * @param array|ArrayAccess $collection
-     * @noinspection NotOptimalIfConditionsInspection
      */
-    public static function getValue($collection, $key, bool $magicIsAllowed = false)
+    public static function getValue(mixed $collection, $key, bool $magicIsAllowed = false)
     {
-        $return = null;
-
         if (
             $magicIsAllowed &&
             is_object($collection) &&
@@ -112,12 +98,8 @@ public static function getValue($collection, $key, bool $magicIsAllowed = false)
     /**
      * Find item in php collection by index
      * Written this way to handle instances ArrayAccess or Traversable objects
-     *
-     * @param array|ArrayAccess $collection
-     *
-     * @return mixed|null
      */
-    private static function getValueByIndex($collection, $key)
+    private static function getValueByIndex(mixed $collection, $key): mixed
     {
         $i = 0;
 
@@ -145,26 +127,21 @@ private static function getValueByIndex($collection, $key)
         return null;
     }
 
-    /**
-     * @param array|ArrayAccess $collection
-     */
-    public static function setValue(&$collection, $key, $value)
+    public static function setValue(mixed &$collection, $key, $value)
     {
         if (is_object($collection) && !$collection instanceof ArrayAccess) {
             return $collection->$key = $value;
         }
 
         if ($collection instanceof ArrayAccess) {
+            /** @noinspection PhpVoidFunctionResultUsedInspection */
             return $collection->offsetSet($key, $value);
         }
 
         return $collection[$key] = $value;
     }
 
-    /**
-     * @param array|ArrayAccess $collection
-     */
-    public static function unsetValue(&$collection, $key): void
+    public static function unsetValue(mixed &$collection, $key): void
     {
         if (is_object($collection) && !$collection instanceof ArrayAccess) {
             unset($collection->$key);
@@ -180,11 +157,9 @@ public static function unsetValue(&$collection, $key): void
     }
 
     /**
-     * @param array|ArrayAccess $collection
-     *
      * @throws JSONPathException
      */
-    public static function arrayValues($collection): array
+    public static function arrayValues(array|ArrayAccess $collection): array
     {
         if (is_array($collection)) {
             return array_values($collection);

src/Filters/AbstractFilter.php

@@ -15,27 +15,15 @@
 
 abstract class AbstractFilter
 {
-    /**
-     * @var JSONPathToken
-     */
-    protected $token;
-
-    /**
-     * @var  bool
-     */
-    protected $magicIsAllowed = false;
-
-    /**
-     * @param int|bool $options
-     */
-    public function __construct(JSONPathToken $token, $options = false)
+    protected JSONPathToken $token;
+
+    protected bool $magicIsAllowed = false;
+
+    public function __construct(JSONPathToken $token, int|bool $options = false)
     {
         $this->token = $token;
         $this->magicIsAllowed = (bool)($options & JSONPath::ALLOW_MAGIC);
     }
 
-    /**
-     * @param array|ArrayAccess $collection
-     */
-    abstract public function filter($collection): array;
+    abstract public function filter(array|ArrayAccess $collection): array;
 }

src/Filters/IndexFilter.php

@@ -15,8 +15,6 @@
 class IndexFilter extends AbstractFilter
 {
     /**
-     * @inheritDoc
-     *
      * @throws JSONPathException
      */
     public function filter($collection): array

src/Filters/IndexesFilter.php

@@ -14,9 +14,6 @@
 
 class IndexesFilter extends AbstractFilter
 {
-    /**
-     * @inheritDoc
-     */
     public function filter($collection): array
     {
         $return = [];

src/Filters/QueryMatchFilter.php

@@ -19,7 +19,8 @@
 use function is_string;
 use function preg_match;
 use function preg_replace;
-use function strpos;
+use function str_ends_with;
+use function str_starts_with;
 use function strtolower;
 use function substr;
 
@@ -30,9 +31,6 @@ class QueryMatchFilter extends AbstractFilter
       (\s*(?<operator>==|=~|=|<>|!==|!=|>=|<=|>|<|in|!in|nin)\s*(?<comparisonValue>.+))?
     ';
 
-    /**
-     * @inheritDoc
-     */
     public function filter($collection): array
     {
         preg_match('/^' . static::MATCH_QUERY_OPERATORS . '$/x', $this->token->value, $matches);
@@ -51,7 +49,7 @@ public function filter($collection): array
         $comparisonValue = $matches['comparisonValue'] ?? null;
 
         if (is_string($comparisonValue)) {
-            if (strpos($comparisonValue, "[") === 0 && substr($comparisonValue, -1) === "]") {
+            if (str_starts_with($comparisonValue, "[") && str_ends_with($comparisonValue, "]")) {
                 $comparisonValue = substr($comparisonValue, 1, -1);
                 $comparisonValue = preg_replace('/^[\'"]/', '', $comparisonValue);
                 $comparisonValue = preg_replace('/[\'"]$/', '', $comparisonValue);
@@ -113,14 +111,14 @@ public function filter($collection): array
                     $return[] = $value;
                 }
 
-                if ($operator === 'in' && is_array($comparisonValue) && in_array($value1, $comparisonValue)) {
+                if ($operator === 'in' && is_array($comparisonValue) && in_array($value1, $comparisonValue, false)) {
                     $return[] = $value;
                 }
 
                 if (
                     ($operator === 'nin' || $operator === '!in') &&
                     is_array($comparisonValue) &&
-                    !in_array($value1, $comparisonValue)
+                    !in_array($value1, $comparisonValue, false)
                 ) {
                     $return[] = $value;
                 }

src/Filters/QueryResultFilter.php

@@ -18,8 +18,6 @@
 class QueryResultFilter extends AbstractFilter
 {
     /**
-     * @inheritDoc
-     *
      * @throws JSONPathException
      */
     public function filter($collection): array
@@ -36,22 +34,13 @@ public function filter($collection): array
             return [];
         }
 
-        switch ($matches['operator']) {
-            case '+':
-                $resultKey = $value + $matches['numeric'];
-                break;
-            case '*':
-                $resultKey = $value * $matches['numeric'];
-                break;
-            case '-':
-                $resultKey = $value - $matches['numeric'];
-                break;
-            case '/':
-                $resultKey = $value / $matches['numeric'];
-                break;
-            default:
-                throw new JSONPathException('Unsupported operator in expression');
-        }
+        $resultKey = match ($matches['operator']) {
+            '+' => $value + $matches['numeric'],
+            '*' => $value * $matches['numeric'],
+            '-' => $value - $matches['numeric'],
+            '/' => $value / $matches['numeric'],
+            default => throw new JSONPathException('Unsupported operator in expression'),
+        };
 
         $result = [];
 

src/Filters/RecursiveFilter.php

@@ -16,8 +16,6 @@
 class RecursiveFilter extends AbstractFilter
 {
     /**
-     * @inheritDoc
-     *
      * @throws JSONPathException
      */
     public function filter($collection): array
@@ -30,18 +28,14 @@ public function filter($collection): array
     }
 
     /**
-     * @param array|ArrayAccess $data
-     *
      * @throws JSONPathException
      */
-    private function recurse(array &$result, $data): void
+    private function recurse(array &$result, array|ArrayAccess $data): void
     {
         $result[] = $data;
 
         if (AccessHelper::isCollectionType($data)) {
-            foreach (AccessHelper::arrayValues($data) as $key => $value) {
-                $results[] = $value;
-
+            foreach (AccessHelper::arrayValues($data) as $value) {
                 if (AccessHelper::isCollectionType($value)) {
                     $this->recurse($result, $value);
                 }