summaryrefslogtreecommitdiff
path: root/server/vendor/justinrainbow/json-schema/README.md
diff options
context:
space:
mode:
authorEole <josselin.35@live.fr>2016-01-21 10:29:26 +0100
committerEole <josselin.35@live.fr>2016-01-21 10:29:26 +0100
commita44cc1d2e3c0f147e91a5c052ac7fd879e34e706 (patch)
treebdd6f72e0ba732c4fcc0479d1cfcf4d0baa5885d /server/vendor/justinrainbow/json-schema/README.md
parent35db27b0e62b4cdcb03b0d21bceb4efc769e6161 (diff)
Init Server Composer Components
Diffstat (limited to 'server/vendor/justinrainbow/json-schema/README.md')
-rw-r--r--server/vendor/justinrainbow/json-schema/README.md55
1 files changed, 55 insertions, 0 deletions
diff --git a/server/vendor/justinrainbow/json-schema/README.md b/server/vendor/justinrainbow/json-schema/README.md
new file mode 100644
index 0000000..3f9c58c
--- /dev/null
+++ b/server/vendor/justinrainbow/json-schema/README.md
@@ -0,0 +1,55 @@
+# JSON Schema for PHP
+
+[![Build Status](https://travis-ci.org/justinrainbow/json-schema.svg?branch=master)](https://travis-ci.org/justinrainbow/json-schema)
+[![Latest Stable Version](https://poser.pugx.org/justinrainbow/json-schema/v/stable.png)](https://packagist.org/packages/justinrainbow/json-schema)
+[![Total Downloads](https://poser.pugx.org/justinrainbow/json-schema/downloads.png)](https://packagist.org/packages/justinrainbow/json-schema)
+
+A PHP Implementation for validating `JSON` Structures against a given `Schema`.
+
+See [json-schema](http://json-schema.org/) for more details.
+
+## Installation
+
+### Library
+
+ $ git clone https://github.com/justinrainbow/json-schema.git
+
+### Dependencies
+
+#### [`Composer`](https://github.com/composer/composer) (*will use the Composer ClassLoader*)
+
+ $ wget http://getcomposer.org/composer.phar
+ $ php composer.phar require justinrainbow/json-schema:~1.3
+
+## Usage
+
+```php
+<?php
+
+// Get the schema and data as objects
+$retriever = new JsonSchema\Uri\UriRetriever;
+$schema = $retriever->retrieve('file://' . realpath('schema.json'));
+$data = json_decode(file_get_contents('data.json'));
+
+// If you use $ref or if you are unsure, resolve those references here
+// This modifies the $schema object
+$refResolver = new JsonSchema\RefResolver($retriever);
+$refResolver->resolve($schema, 'file://' . __DIR__);
+
+// Validate
+$validator = new JsonSchema\Validator();
+$validator->check($data, $schema);
+
+if ($validator->isValid()) {
+ echo "The supplied JSON validates against the schema.\n";
+} else {
+ echo "JSON does not validate. Violations:\n";
+ foreach ($validator->getErrors() as $error) {
+ echo sprintf("[%s] %s\n", $error['property'], $error['message']);
+ }
+}
+```
+
+## Running the tests
+
+ $ vendor/bin/phpunit