[-]: Remove DotPathTrait - parts have been moved into DotArray [*]: Code Standard Improvements

Author: microThread

phpcs.xml.dist

@@ -159,9 +159,11 @@
     <!-- <rule ref="Squiz.Commenting.ClosingDeclarationComment"/> -->
 
     <rule ref="Squiz.Commenting.BlockComment">
-        <exclude name="Squiz.Commenting.BlockComment.NoEmptyLineAfter"/>
         <exclude name="Squiz.Commenting.BlockComment.NoEmptyLineAfter"/>
         <exclude name="Squiz.Commenting.BlockComment.SingleLine"/>
+        <exclude name="Squiz.Commenting.BlockComment.CloserSameLine"/>
+        <exclude name="Squiz.Commenting.BlockComment.FirstLineIndent"/>
+        <exclude name="Squiz.Commenting.BlockComment.LineIndent"/>
     </rule>
     <rule ref="Squiz.Commenting.DocCommentAlignment"/>
     <rule ref="Squiz.Commenting.EmptyCatchComment"/>
@@ -212,8 +214,10 @@
     <!-- Ensures that switch statements are defined according to PSR2. -->
     <rule ref="PSR2.ControlStructures.SwitchDeclaration"/>
 
-    <!-- Include some sniffs from other standards that don't conflict with PEAR -->
-    <rule ref="Squiz.ControlStructures.ElseIfDeclaration"/>
+    <!-- The keyword elseif SHOULD be used instead of else if so that all control keywords look like single words. -->
+    <rule ref="PSR2.ControlStructures.ElseIfDeclaration">
+        <type>error</type>
+    </rule>
 
 
     <!-- ==================== -->

src/DotArray.php

@@ -19,9 +19,42 @@ class DotArray implements
 {
 
     /* Traits. */
-    use DotPathTrait;
     use DotFilteringTrait;
 
+    /**
+     * Internal Dot Path Config.
+     *
+     * @var array
+     */
+    protected static $dotPathConfig = [
+        'template'  => '#(?|(?|[<token-start>](.*?)[<token-end>])|(.*?))(?:$|\.+)#i',
+        'wrapKey'   => '{%s}',
+        'wildcards' => [
+            '<token-start>' => ['\'', '\"', '\[', '\(', '\{'],
+            '<token-end>'   => ['\'', '\"', '\]', '\)', '\}'],
+        ],
+    ];
+
+    /**
+     * The cached pattern that allow to match the JSON paths that use the dot notation.
+     *
+     * Allowed tokens for more complex paths: '', "", [], (), {}
+     * Examples:
+     *
+     * - foo.bar
+     * - foo.'bar'
+     * - foo."bar"
+     * - foo.[bar]
+     * - foo.(bar)
+     * - foo.{bar}
+     *
+     * Or more complex:
+     * - foo.{bar}.[component].{version.1.0}
+     *
+     * @var string
+     */
+    protected static $dotPathPattern;
+
     /**
      * Unique object identifier.
      *
@@ -61,6 +94,132 @@ public static function createFromJson($json)
     }
 
 
+    /**
+     * Getting the dot path pattern.
+     *
+     * @return string
+     */
+    protected static function dotPathPattern()
+    {
+        if (empty(self::$dotPathPattern)) {
+            $path = self::$dotPathConfig['template'];
+
+            foreach (self::$dotPathConfig['wildcards'] as $wildcard => $tokens) {
+                $path = \str_replace($wildcard, \implode('', $tokens), $path);
+            }
+
+            self::$dotPathPattern = $path;
+        }
+
+        return self::$dotPathPattern;
+    }
+
+
+    /**
+     * Converts dot string path to segments.
+     *
+     * @param string $path
+     *
+     * @return array
+     */
+    protected static function pathToSegments($path)
+    {
+        $path     = \trim($path, " \t\n\r\0\x0B\.");
+        $segments = [];
+        $matches  = [];
+
+        if (\mb_strlen($path, 'UTF-8') === 0) {
+            return [];
+        }
+
+        \preg_match_all(static::dotPathPattern(), $path, $matches);
+
+        if (!empty($matches[1])) {
+            $matches = $matches[1];
+
+            $segments = \array_filter(
+                $matches,
+                function ($match) {
+                    return (\mb_strlen($match, 'UTF-8') > 0);
+                }
+            );
+        }
+
+        unset($path, $matches);
+
+        return $segments;
+    }
+
+
+    /**
+     * Wrap a given string into special characters.
+     *
+     * @param string $key
+     *
+     * @return string
+     */
+    protected static function wrapSegmentKey($key)
+    {
+        return vsprintf(static::$dotPathConfig['wrapKey'], [$key]);
+    }
+
+
+    /**
+     * @param array $segments
+     *
+     * @return string
+     */
+    protected static function segmentsToKey(array $segments)
+    {
+        return (
+        \implode(
+            '.',
+            \array_map(
+                function ($segment) {
+                    return static::wrapSegmentKey($segment);
+                },
+                $segments
+            )
+        )
+        );
+    }
+
+
+    /**
+     * Flatten the internal array using the dot delimiter,
+     * also the keys are wrapped inside {key} (1 x curly braces).
+     *
+     * @param array $items
+     * @param array $prepend
+     *
+     * @return array
+     */
+    protected static function flatten(array $items, $prepend = [])
+    {
+        $flatten = [];
+
+        foreach ($items as $key => $value) {
+            if (\is_array($value) && !empty($value)) {
+                $flatten = array_merge(
+                    $flatten,
+                    static::flatten(
+                        $value,
+                        array_merge($prepend, [$key])
+                    )
+                );
+
+                continue;
+            }
+
+            $segmentsToKey = static::segmentsToKey(array_merge($prepend, [$key]));
+
+            $flatten[$segmentsToKey] = $value;
+        }
+
+        return $flatten;
+    }
+
+
     /**
      * Return the given items as an array
      *