Initial commit

Author: zooh

.gitignore

@@ -0,0 +1,3 @@
+/.idea/
+/vendor/
+/composer.lock

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Edward Surov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README.md

@@ -0,0 +1,64 @@
+PHP JSON Pointer
+================
+This library allows usage of RFC-6901-compliant JSON pointers with PHP
+ variables.
+
+#License
+PHP JSON Pointer is licensed under MIT license.
+
+#Documentation
+To get ready to access data with JSON Pointer links you need just 3 simple steps:
+
+1. Create an object of `\ESurov\JSONPointer\Pointer` class by calling it's static `factory()` method.
+2. Link data to the pointer object by calling it's `setData()` method.
+3. Set up JSON Pointer link text by calling it's `setText()` method.
+
+After doing so, you can call `test()`, `read()` and `write()` methods to access data.
+
+##Example of usage
+```php
+<?php
+
+use \ESurov\JSONPointer\Pointer;
+
+// Setting up data.
+$data = (object) [
+    'a' => (object) [
+        'b' => ['c', 'd', 'e'],
+    ],
+];
+
+// Setting up pointer.
+$link = '/a/b/1';
+$pointer = Pointer::factory()
+    ->setData($data)
+    ->setText($link);
+    
+// Readind value.
+echo $pointer->read();  // d
+
+// Writing value
+echo $pointer
+    ->write('f')        // Sets $data->a->b[1] to 'f'.
+    ->read();           // f
+    
+// Testing value.
+$result = $pointer->test(); // Sets $result to TRUE.
+$link = '/a/c';         // Link to non-existing property
+$result = $pointer
+    ->setText($link)
+    ->test();           // Sets $result to FALSE.
+    
+// Treating PHP objects as arrays (not compliant with RFC6901, but
+// it's the only way to access non-numeric index in PHP array).
+$subData = ['g' => 2, 'h' => 3];
+$link = '/a/c/g';       // Link to non-numeric index of array.
+$result = $pointer
+    ->write($subData)   // Sets $data->a->c to ['g' => 2, 'h' => 3].
+    ->setText($link)
+    ->test();           // Sets $result to FALSE.
+$result $pointer
+    ->setOptions(Pointer::OPTION_NON_NUMERIC_ARRAY_INDICES)
+    ->test();           // Sets $result to TRUE.
+echo $pointer->read();  // 2    
+```

composer.json

@@ -0,0 +1,26 @@
+{
+  "name": "remorhaz/php-json-pointer",
+  "description": "JSON Pointer (RFC-6901) PHP implementation",
+  "authors": [
+    {
+      "name": "Edward Surov",
+      "email": "zoohie@gmail.com"
+    }
+  ],
+  "require": {
+    "php": ">=5.6"
+  },
+  "require-dev": {
+    "phpunit/phpunit": "@stable"
+  },
+  "autoload": {
+    "psr-4": {
+      "Remorhaz\\JSONPointer\\": "src/"
+    }
+  },
+  "autoload-dev": {
+    "psr-4": {
+      "Remorhaz\\JSONPointer\\Test\\": "tests/"
+    }
+  }
+}

src/EvaluateException.php

@@ -0,0 +1,7 @@
+<?php
+
+namespace Remorhaz\JSONPointer;
+
+interface EvaluateException extends Exception
+{
+}

src/Exception.php

@@ -0,0 +1,7 @@
+<?php
+
+namespace Remorhaz\JSONPointer;
+
+interface Exception
+{
+}

src/Locator.php

@@ -0,0 +1,74 @@
+<?php
+
+namespace Remorhaz\JSONPointer;
+
+class Locator
+{
+
+    /**
+     * Reference list.
+     *
+     * @var Locator\Reference[]
+     */
+    protected $referenceList = [];
+
+    /**
+     * @var Locator\Reference|null
+     */
+    protected $lastReference;
+
+
+    /**
+     * Constructor.
+     */
+    protected function __construct()
+    {
+    }
+
+
+    /**
+     * Creates object instance.
+     *
+     * @return static
+     */
+    public static function factory()
+    {
+        return new static();
+    }
+
+
+    /**
+     * Returns reference list.
+     *
+     * @return Locator\Reference[]
+     */
+    public function getReferenceList()
+    {
+        return $this->referenceList;
+    }
+
+
+    /**
+     * Adds reference to list.
+     *
+     * @param Locator\Reference $reference
+     * @return $this
+     */
+    public function addReference(Locator\Reference $reference)
+    {
+        $this->referenceList[] = $reference;
+        if (null === $this->lastReference) {
+            $pathPrefix = '';
+        } else {
+            $pathPrefix = $this
+                ->lastReference
+                ->setLast(false)
+                ->getPath();
+        }
+
+        $this->lastReference = $reference
+            ->setLast()
+            ->setPath("{$pathPrefix}/{$reference->getText()}");
+        return $this;
+    }
+}

src/Locator/Exception.php

@@ -0,0 +1,7 @@
+<?php
+
+namespace Remorhaz\JSONPointer\Locator;
+
+interface Exception extends \Remorhaz\JSONPointer\Exception
+{
+}