ex
Fork of mbed-os-example-mbed5-blinky by
Diff: dumi_doc-master/schema/vendor/justinrainbow/json-schema/README.md
- Revision:
- 49:b9eb462f36a9
- Parent:
- 48:c7ee67edcf1d
- Child:
- 50:9ecaa144d1f3
--- a/dumi_doc-master/schema/vendor/justinrainbow/json-schema/README.md Tue Jul 18 16:56:22 2017 +0800
+++ /dev/null Thu Jan 01 00:00:00 1970 +0000
@@ -1,136 +0,0 @@
-# JSON Schema for PHP
-
-[](https://travis-ci.org/justinrainbow/json-schema)
-[](https://packagist.org/packages/justinrainbow/json-schema)
-[](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:~2.0
-
-## Usage
-
-### Basic usage
-
-```php
-<?php
-
-$data = json_decode(file_get_contents('data.json'));
-
-// Validate
-$validator = new JsonSchema\Validator;
-$validator->check($data, (object)['$ref' => 'file://' . realpath('schema.json')]);
-
-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']);
- }
-}
-```
-###Type Coercion
-If you're validating data passed to your application via HTTP, you can cast strings and booleans to the expected types defined by your schema:
-```php
-use JsonSchema\SchemaStorage;
-use JsonSchema\Validator;
-use JsonSchema\Constraints\Factory;
-use JsonSchema\Constraints\Constraint;
-
-$request = (object)[
- 'processRefund'=>"true",
- 'refundAmount'=>"17"
-];
-
-$factory = new Factory( null, null, Constraint::CHECK_MODE_TYPE_CAST | Constraint::CHECK_MODE_COERCE );
-
-$validator = new Validator($factory);
-$validator->check($request, (object) [
- "type"=>"object",
- "properties"=>(object)[
- "processRefund"=>(object)[
- "type"=>"boolean"
- ],
- "refundAmount"=>(object)[
- "type"=>"number"
- ]
- ]
-]); // validates!
-
-is_bool($request->processRefund); // true
-is_int($request->refundAmount); // true
-```
-
-Note that the ```CHECK_MODE_COERCE``` flag will only take effect when an object is passed into the ```check``` method.
-
-### With inline references
-
-```php
-<?php
-
-use JsonSchema\SchemaStorage;
-use JsonSchema\Validator;
-use JsonSchema\Constraints\Factory;
-
-$jsonSchema = <<<'JSON'
-{
- "type": "object",
- "properties": {
- "data": {
- "oneOf": [
- { "$ref": "#/definitions/integerData" },
- { "$ref": "#/definitions/stringData" }
- ]
- }
- },
- "required": ["data"],
- "definitions": {
- "integerData" : {
- "type": "integer",
- "minimum" : 0
- },
- "stringData" : {
- "type": "string"
- }
- }
-}
-JSON;
-
-// Schema must be decoded before it can be used for validation
-$jsonSchemaObject = json_decode($jsonSchema);
-
-// The SchemaStorage can resolve references, loading additional schemas from file as needed, etc.
-$schemaStorage = new SchemaStorage();
-
-// This does two things:
-// 1) Mutates $jsonSchemaObject to normalize the references (to file://mySchema#/definitions/integerData, etc)
-// 2) Tells $schemaStorage that references to file://mySchema... should be resolved by looking in $jsonSchemaObject
-$schemaStorage->addSchema('file://mySchema', $jsonSchemaObject);
-
-// Provide $schemaStorage to the Validator so that references can be resolved during validation
-$jsonValidator = new Validator( new Factory($schemaStorage));
-
-// JSON must be decoded before it can be validated
-$jsonToValidateObject = json_decode('{"data":123}');
-
-// Do validation (use isValid() and getErrors() to check the result)
-$jsonValidator->check($jsonToValidateObject, $jsonSchemaObject);
-```
-
-## Running the tests
-
- $ vendor/bin/phpunit
