Update docs, README.md and CHANGELOG.md

Author: Art4

CHANGELOG.md

@@ -5,6 +5,10 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+### Added
+
+- `Helper::isValid()` checks if a string is valid JSON API
+
 ### Fixed
 
 - **BREAKING**: pagination links moved from `Pagination` to `DocumentLink` and `RelationshipLink`

README.md

@@ -61,16 +61,16 @@ JSON API Client can be used as a validator for JSON API contents:
 ```php
 $wrong_jsonapi = '{"data":{},"meta":{"info":"This is wrong JSON API. `data` has to be `null` or containing at least `type` and `id`."}}';
 
-$manager = new \Art4\JsonApiClient\Utils\Manager();
-
-try
+if ( \Art4\JsonApiClient\Utils\Helper::isValid($wrong_jsonapi) )
 {
-	$document = $manager->parse($wrong_jsonapi);
+	echo 'string is valid.';
 }
-catch (\Art4\JsonApiClient\Exception\ValidationException $e)
+else
 {
-	echo $e->getMessage(); // "A resource object MUST contain a type"
+	echo 'string is invalid json api!';
 }
+
+// echos 'string is invalid json api!'
 ```
 
 ### Extend the client

docs/utils-helper.md

@@ -18,22 +18,24 @@ $document = \Art4\JsonApiClient\Utils\Helper::parse($jsonapi_string);
 This returns a [Document](objects-document.md) object which provided all contents.
 
 > **Note:** If `$jsonapi_string` contains not valid JSON or JSON API a [Exception\ValidationException](exception-introduction.md#exceptionvalidationexception) will be thrown.
+>
+> See more about Exceptions in the [Exception section](exception-introduction.md).
 
 ### Validate a JSON API response body
 
-JSON API Client can be used as a validator. It will throw an [Exception\ValidationException](exception-introduction.md#exceptionvalidationexception) if the body contains not valid JSON or JSON API.
+JSON API Client can be used as a validator:
 
 ```php
 $wrong_jsonapi = '{"data":{},"meta":{"info":"This is wrong JSON API. `data` has to be `null` or containing at least `type` and `id`."}}';
 
-try
+if ( \Art4\JsonApiClient\Utils\Helper::isValid($wrong_jsonapi) )
 {
-	$document = \Art4\JsonApiClient\Utils\Helper::parse($wrong_jsonapi);
+	echo 'string is valid.';
 }
-catch (\Art4\JsonApiClient\Exception\ValidationException $e)
+else
 {
-	echo $e->getMessage(); // "A resource object MUST contain a type"
+	echo 'string is invalid json api!';
 }
-```
 
-See more about Exceptions in the [Exception section](exception-introduction.md).
+// echos 'string is invalid json api!'
+```