Added chain support

Author: vanodevium

src/Dot.php

@@ -52,6 +52,7 @@ public function __construct($items = [], $parse = false)
      *
      * @param array|int|string $keys
      * @param mixed            $value
+     * @return Dot
      */
     public function add($keys, $value = null)
     {
@@ -62,6 +63,8 @@ public function add($keys, $value = null)
         } elseif ($this->get($keys) === null) {
             $this->set($keys, $value);
         }
+
+        return $this;
     }
 
     /**
@@ -78,26 +81,30 @@ public function all()
      * Delete the contents of a given key or keys
      *
      * @param array|int|string|null $keys
+     * @return Dot
      */
     public function clear($keys = null)
     {
         if ($keys === null) {
             $this->items = [];
 
-            return;
+            return $this;
         }
 
         $keys = (array) $keys;
 
         foreach ($keys as $key) {
             $this->set($key, []);
         }
+
+        return $this;
     }
 
     /**
      * Delete the given key or keys
      *
      * @param array|int|string $keys
+     * @return Dot
      */
     public function delete($keys)
     {
@@ -124,6 +131,8 @@ public function delete($keys)
 
             unset($items[$lastSegment]);
         }
+
+        return $this;
     }
 
     /**
@@ -280,6 +289,7 @@ public function isEmpty($keys = null)
      *
      * @param array|string|self $key
      * @param array|self        $value
+     * @return Dot
      */
     public function merge($key, $value = [])
     {
@@ -293,6 +303,8 @@ public function merge($key, $value = [])
         } elseif ($key instanceof self) {
             $this->items = array_merge($this->items, $key->all());
         }
+
+        return $this;
     }
 
     /**
@@ -303,6 +315,7 @@ public function merge($key, $value = [])
      *
      * @param array|string|self $key
      * @param array|self        $value
+     * @return Dot
      */
     public function mergeRecursive($key, $value = [])
     {
@@ -316,6 +329,8 @@ public function mergeRecursive($key, $value = [])
         } elseif ($key instanceof self) {
             $this->items = array_merge_recursive($this->items, $key->all());
         }
+
+        return $this;
     }
 
     /**
@@ -327,6 +342,7 @@ public function mergeRecursive($key, $value = [])
      *
      * @param array|string|self $key
      * @param array|self        $value
+     * @return Dot
      */
     public function mergeRecursiveDistinct($key, $value = [])
     {
@@ -340,6 +356,8 @@ public function mergeRecursiveDistinct($key, $value = [])
         } elseif ($key instanceof self) {
             $this->items = $this->arrayMergeRecursiveDistinct($this->items, $key->all());
         }
+
+        return $this;
     }
 
     /**
@@ -395,13 +413,14 @@ public function pull($key = null, $default = null)
      *
      * @param mixed $key
      * @param mixed $value
+     * @return Dot
      */
     public function push($key, $value = null)
     {
         if ($value === null) {
             $this->items[] = $key;
 
-            return;
+            return $this;
         }
 
         $items = $this->get($key);
@@ -410,6 +429,8 @@ public function push($key, $value = null)
             $items[] = $value;
             $this->set($key, $items);
         }
+
+        return $this;
     }
 
     /**
@@ -418,6 +439,7 @@ public function push($key, $value = null)
      *
      * @param array|string|self $key
      * @param array|self        $value
+     * @return Dot
      */
     public function replace($key, $value = [])
     {
@@ -431,13 +453,16 @@ public function replace($key, $value = [])
         } elseif ($key instanceof self) {
             $this->items = array_replace($this->items, $key->all());
         }
+
+        return $this;
     }
 
     /**
      * Set a given key / value pair or pairs
      *
      * @param array|int|string $keys
      * @param mixed            $value
+     * @return Dot
      */
     public function set($keys, $value = null)
     {
@@ -446,7 +471,7 @@ public function set($keys, $value = null)
                 $this->set($key, $value);
             }
 
-            return;
+            return $this;
         }
 
         $items = &$this->items;
@@ -460,26 +485,34 @@ public function set($keys, $value = null)
         }
 
         $items = $value;
+
+        return $this;
     }
 
     /**
      * Replace all items with a given array
      *
      * @param mixed $items
+     * @return Dot
      */
     public function setArray($items)
     {
         $this->items = $this->getArrayItems($items);
+
+        return $this;
     }
 
     /**
      * Replace all items with a given array as a reference
      *
      * @param array $items
+     * @return Dot
      */
     public function setReference(array &$items)
     {
         $this->items = &$items;
+
+        return $this;
     }
 
     /**

tests/DotTest.php

@@ -79,6 +79,7 @@ public function testAddKeyValuePair()
         $dot->add('foo.bar', 'baz');
 
         $this->assertEquals('baz', $dot->get('foo.bar'));
+        $this->assertInstanceOf(Dot::class, $dot);
     }
 
     public function testAddValueToExistingKey()
@@ -125,6 +126,7 @@ public function testClearKey()
         $dot->clear('foo.bar');
 
         $this->assertSame([], $dot->get('foo.bar'));
+        $this->assertInstanceOf(Dot::class, $dot);
     }
 
     public function testClearNonExistingKey()
@@ -163,6 +165,7 @@ public function testDeleteKey()
         $dot->delete('foo.bar');
 
         $this->assertFalse($dot->has('foo.bar'));
+        $this->assertInstanceOf(Dot::class, $dot);
     }
 
     public function testDeleteNonExistingKey()
@@ -315,6 +318,7 @@ public function testMergeArrayWithDot()
         $dot->merge(['foo' => ['bar' => 'qux']]);
 
         $this->assertEquals('qux', $dot->get('foo.bar'));
+        $this->assertInstanceOf(Dot::class, $dot);
     }
 
     public function testMergeArrayWithKey()
@@ -356,6 +360,7 @@ public function testRecursiveMergeArrayWithDot()
 
         $this->assertEquals(['baz', 'qux'], $dot->get('foo.bar'));
         $this->assertEquals('quuz', $dot->get('foo.quux'));
+        $this->assertInstanceOf(Dot::class, $dot);
     }
 
     public function testRecursiveMergeArrayWithKey()
@@ -400,6 +405,7 @@ public function testRecursiveDistinctMergeArrayWithDot()
 
         $this->assertEquals('qux', $dot->get('foo.bar'));
         $this->assertEquals('quuz', $dot->get('foo.quux'));
+        $this->assertInstanceOf(Dot::class, $dot);
     }
 
     public function testRecursiveDistinctMergeArrayWithKey()
@@ -479,6 +485,7 @@ public function testPushValue()
         $dot->push('foo');
 
         $this->assertEquals('foo', $dot->get(0));
+        $this->assertInstanceOf(Dot::class, $dot);
     }
 
     public function testPushValueToKey()
@@ -501,6 +508,7 @@ public function testReplaceWithArray()
         $dot->replace(['foo' => ['qux' => 'quux']]);
 
         $this->assertEquals(['qux' => 'quux'], $dot->get('foo'));
+        $this->assertInstanceOf(Dot::class, $dot);
     }
 
     public function testReplaceKeyWithArray()
@@ -541,6 +549,7 @@ public function testSetKeyValuePair()
         $dot->set('foo.bar', 'baz');
 
         $this->assertEquals('baz', $dot->get('foo.bar'));
+        $this->assertInstanceOf(Dot::class, $dot);
     }
 
     public function testSetArrayOfKeyValuePairs()
@@ -563,6 +572,7 @@ public function testSetArray()
         $dot->setArray(['foo' => 'bar']);
 
         $this->assertSame(['foo' => 'bar'], $dot->all());
+        $this->assertInstanceOf(Dot::class, $dot);
     }
 
     /*
@@ -579,6 +589,7 @@ public function testSetReference()
         $dot->set('foo', 'baz');
 
         $this->assertEquals('baz', $items['foo']);
+        $this->assertInstanceOf(Dot::class, $dot);
     }
 
     /*