Initial commit

Author: DaveRandom

.gitignore

@@ -0,0 +1,2 @@
+vendor
+.idea

composer.json

@@ -0,0 +1,11 @@
+{
+  "name": "daverandom/exceptional-json",
+  "description": "JSON encoding and decoding that throws exceptions on failure",
+  "minimum-stability": "stable",
+  "license": "MIT",
+  "authors": [{"name": "Chris Wright"}],
+  "autoload": {
+    "psr-4": {"ExceptionalJSON\\": "src/"},
+    "files": ["src/functions.php"]
+  }
+}

readme.md

@@ -0,0 +1,30 @@
+# Exceptional JSON
+
+Thin wrapper around PHP's `json_encode()` and `json_decode()` functions, which throws exceptions when an operation fails.
+
+**Required PHP Version**
+
+- PHP 7.0+
+
+**Installation**
+
+```bash
+$ composer require amphp/amp
+```
+
+**Usage**
+
+Call the `\ExceptionJSON\encode()` and `\ExceptionJSON\decode()` functions in exactly the same way as you would with
+`json_encode()` and `json_decode()`. The only difference is that they will throw an exception if the operation fails.
+
+Also defines `json_try_encode()` and `json_try_decode()` in the root namespace if they don't already exist, these are
+simply aliases of their namespaced counterparts.
+
+```php
+$encoded = \ExceptionJSON\encode($data);
+$decoded = \ExceptionJSON\decode($encoded);
+```
+
+**What about tests?**
+
+![Tests? Where we're going, we don't need... tests](https://i.imgflip.com/13kfdv.jpg)

src/DecodeErrorException.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace ExceptionalJSON;
+
+/**
+ * Exception thrown when a JSON decoding operation fails.
+ *
+ * @package ExceptionalJSON
+ */
+class DecodeErrorException extends Exception
+{
+    private $json;
+
+    public function __construct(int $code, string $message, string $json)
+    {
+        parent::__construct($message, $code);
+        $this->json = $json;
+    }
+
+    public function getJSON(): string
+    {
+        return $this->json;
+    }
+}

src/EncodeErrorException.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace ExceptionalJSON;
+
+/**
+ * Exception thrown when a JSON decoding operation fails.
+ *
+ * @package ExceptionalJSON
+ */
+class EncodeErrorException extends Exception
+{
+    private $value;
+
+    public function __construct(int $code, string $message, $value)
+    {
+        parent::__construct($message, $code);
+        $this->value = $value;
+    }
+
+    public function getValue(): string
+    {
+        return $this->value;
+    }
+}

src/Exception.php

@@ -0,0 +1,16 @@
+<?php declare(strict_types=1);
+
+namespace ExceptionalJSON;
+
+/**
+ * Base exception thrown when a JSON operation fails.
+ *
+ * @package ExceptionalJSON
+ */
+abstract class Exception extends \RuntimeException
+{
+    public function __construct(int $code, string $message)
+    {
+        parent::__construct($message, $code);
+    }
+}

src/functions.php

@@ -0,0 +1,86 @@
+<?php declare(strict_types=1);
+
+namespace ExceptionalJSON
+{
+    /**
+     * Decodes a JSON string.
+     *
+     * @param string $json The JSON string being decoded.
+     * @param bool $assoc When TRUE, returned objects will be converted into associative arrays.
+     * @param int $depth User specified recursion depth.
+     * @param int $options Bit mask of JSON decode options.
+     * @return mixed The value encoded in JSON in appropriate PHP type.
+     * @throws DecodeErrorException When the decode operation fails.
+     */
+    function decode(string $json, bool $assoc = false, int $depth = 512, int $options = 0)
+    {
+        $result = \json_decode($json, $assoc, $depth, $options);
+        $code = \json_last_error();
+
+        if ($code !== \JSON_ERROR_NONE) {
+            throw new DecodeErrorException($code, \json_last_error_msg(), $json);
+        }
+
+        return $result;
+    }
+
+    /**
+     * Returns the JSON representation of a value.
+     *
+     * @param mixed $value The value being encoded.
+     * @param int $depth User specified recursion depth.
+     * @param int $options Bit mask of JSON encode options.
+     * @return string JSON encoded string.
+     * @throws Exception When the encode operation fails
+     */
+    function encode($value, int $options = 0, int $depth = 512)
+    {
+        $result = \json_encode($value, $options, $depth);
+        $code = \json_last_error();
+
+        if ($code !== \JSON_ERROR_NONE) {
+            throw new EncodeErrorException($code, \json_last_error_msg(), $value);
+        }
+
+        return $result;
+    }
+}
+
+namespace
+{
+    use function ExceptionalJSON\decode;
+    use function ExceptionalJSON\encode;
+
+    if (!function_exists('json_try_decode')) {
+        /**
+         * Decodes a JSON string.
+         *
+         * @param string $json The JSON string being decoded.
+         * @param bool $assoc When TRUE, returned objects will be converted into associative arrays.
+         * @param int $depth User specified recursion depth.
+         * @param int $options Bit mask of JSON decode options.
+         * @return mixed The value encoded in JSON in appropriate PHP type.
+         * @throws \ExceptionalJSON\DecodeErrorException When the decode operation fails.
+         */
+        function json_try_decode(string $json, bool $assoc = false, int $depth = 512, int $options = 0)
+        {
+            return decode($json, $assoc, $depth, $options);
+        }
+    }
+
+    if (!function_exists('json_try_encode')) {
+        /**
+         * Returns the JSON representation of a value.
+         *
+         * @param mixed $value The value being encoded.
+         * @param int $depth User specified recursion depth.
+         * @param int $options Bit mask of JSON encode options.
+         * @return string JSON encoded string.
+         * @throws \ExceptionalJSON\EncodeErrorException When the encode operation fails
+         */
+        function json_try_encode($value, int $options = 0, int $depth = 512)
+        {
+            return encode($value, $options, $depth);
+        }
+    }
+}