From ac6c582a37653d1d31d22179fe73308ecb4565ce Mon Sep 17 00:00:00 2001 From: Danny van der Sluijs Date: Tue, 9 Sep 2025 15:07:11 +0200 Subject: [PATCH] docs: Document how custom error messages is being handled --- _docs/advanced-topics.md | 25 +++- _site/advanced-topics.html | 142 -------------------- _site/community-guide.html | 142 -------------------- _site/configuration.html | 142 -------------------- _site/contributors.html | 149 --------------------- _site/docs/advanced-topics.html | 98 ++++++++++++-- _site/docs/check-mode.html | 29 +++-- _site/docs/contributors.html | 12 +- _site/docs/getting-started.html | 8 +- _site/docs/search.html | 224 ++++++++++++++++++++++++++++++++ _site/docs/search.json | 2 +- _site/feed.xml | 2 + _site/getting-started.html | 202 ---------------------------- _site/media/mix-manifest.json | 9 -- 14 files changed, 364 insertions(+), 822 deletions(-) delete mode 100644 _site/advanced-topics.html delete mode 100644 _site/community-guide.html delete mode 100644 _site/configuration.html delete mode 100644 _site/contributors.html create mode 100644 _site/docs/search.html create mode 100644 _site/feed.xml delete mode 100644 _site/getting-started.html delete mode 100644 _site/media/mix-manifest.json diff --git a/_docs/advanced-topics.md b/_docs/advanced-topics.md index f4f8707..310bd6b 100644 --- a/_docs/advanced-topics.md +++ b/_docs/advanced-topics.md @@ -67,4 +67,27 @@ if ($validator->isValid()) { This paragraph needs to be written, want to help out? Checkout GitHub repo! ## Using custom error messages -This paragraph needs to be written, want to help out? Checkout GitHub repo! +All the errors returned from the library contain a unique constraint name. Using this constraint name you can replace the +error message with own, adjusting for your tone of voice or language. + +```php +addSchema('internal://mySchema', $jsonSchema); +$validator = new JsonSchema\Validator( + new JsonSchema\Constraints\Factory($schemaStorage) +); +$validator->validate($data, $jsonSchemaObject); + +foreach ($validator->getErrors() as $error) { + echo sprintf( + customErrorMessagePatternFunction($error['constraint']['name']), + ...$error['constraint']['params'] + ); +} +``` diff --git a/_site/advanced-topics.html b/_site/advanced-topics.html deleted file mode 100644 index 37624f6..0000000 --- a/_site/advanced-topics.html +++ /dev/null @@ -1,142 +0,0 @@ - - - - - -JSON Schema for PHP - Advanced topics - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
-
-

Advanced topics

-

This page needs to be written, want to help out? Checkout GitHub repo!

- -
-
-
-
- - - - - - - - - - - - - - - - - diff --git a/_site/community-guide.html b/_site/community-guide.html deleted file mode 100644 index e1d8a63..0000000 --- a/_site/community-guide.html +++ /dev/null @@ -1,142 +0,0 @@ - - - - - -JSON Schema for PHP - Community guide - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
-
-

Community guide

-

This page needs to be written, want to help out? Checkout GitHub repo!

- -
-
-
-
- - - - - - - - - - - - - - - - - diff --git a/_site/configuration.html b/_site/configuration.html deleted file mode 100644 index c6022a3..0000000 --- a/_site/configuration.html +++ /dev/null @@ -1,142 +0,0 @@ - - - - - -JSON Schema for PHP - Configuration - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
-
-

Configuration

-

This page needs to be written, want to help out? Checkout GitHub repo!

- -
-
-
-
- - - - - - - - - - - - - - - - - diff --git a/_site/contributors.html b/_site/contributors.html deleted file mode 100644 index 513c2b3..0000000 --- a/_site/contributors.html +++ /dev/null @@ -1,149 +0,0 @@ - - - - - -JSON Schema for PHP - Contributors - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
-
-

Contributors

-

JSON Schema for PHP would not exist without the dedication, time, and expertise of our community.
-Every feature, improvement, and bug fix is the result of people generously sharing their skills and ideas.
-We are deeply grateful for each and every contribution — large or small — that has helped shape this project.

-

Check out all the amazing people who have made this possible:

- - - -

Made with contrib.rocks.

- -
-
-
-
- - - - - - - - - - - - - - - - - diff --git a/_site/docs/advanced-topics.html b/_site/docs/advanced-topics.html index d354701..4b0b6f4 100644 --- a/_site/docs/advanced-topics.html +++ b/_site/docs/advanced-topics.html @@ -20,7 +20,7 @@ - + @@ -78,8 +78,8 @@ Getting started
  • - - Configuration + + Check mode
  • @@ -87,12 +87,14 @@ Table of contents - + +
  • - - Community guide - -
  • Contributors @@ -110,7 +112,83 @@

    Advanced topics

    -

    This page needs to be written, want to help out? Checkout GitHub repo!

    +

    Validation using schema on disk

    +

    Validation of a JSON document can be done using a schema located on disk.

    +
    <?php
+
+$data = json_decode(file_get_contents('data.json'));
+
+// Validate
+$validator = new JsonSchema\Validator;
+$validator->validate($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) {
+        printf("[%s] %s\n", $error['property'], $error['message']);
+    }
+}
+
    +

    Validation using inline schema

    +

    Validation of a JSON document can be done using a inline schema. This requires some additional setup of the schema storage

    +
    <?php
+
+$data = json_decode(file_get_contents('data.json'));
+$jsonSchemaAsString = <<<'JSON'
+{
+  "type": "object",
+  "properties": {
+    "name": { "type": "string"},
+    "email": {"type": "string"}
+  },
+  "required": ["name","email"]
+}
+JSON;
+
+$jsonSchema = json_decode($jsonSchemaAsString);
+$schemaStorage = new JsonSchema\SchemaStorage();
+$schemaStorage->addSchema('internal://mySchema', $jsonSchema);
+$validator = new JsonSchema\Validator(
+    new JsonSchema\Constraints\Factory($schemaStorage)
+);
+$validator->validate($data, $jsonSchemaObject);
+
+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) {
+        printf("[%s] %s\n", $error['property'], $error['message']);
+    }
+}
+
    +

    Validation using online schema

    +

    This paragraph needs to be written, want to help out? Checkout GitHub repo!

    +

    Using custom error messages

    +

    All the errors returned from the library contain a unique constraint name. Using this constraint name you can replace the +error message with own, adjusting for your tone of voice or language.

    +
    <?php 
+
+$data = '{"age": "John Doe"}'
+$jsonSchemaAsString = ' { "type": "object", "properties": { "age": { "type": "integer" } } } ';
+
+$jsonSchema = json_decode($jsonSchemaAsString);
+$schemaStorage = new JsonSchema\SchemaStorage();
+$schemaStorage->addSchema('internal://mySchema', $jsonSchema);
+$validator = new JsonSchema\Validator(
+    new JsonSchema\Constraints\Factory($schemaStorage)
+);
+$validator->validate($data, $jsonSchemaObject);
+
+foreach ($validator->getErrors() as $error) {
+    echo sprintf(
+        customErrorMessagePatternFunction($error['constraint']['name']),
+        ...$error['constraint']['params']
+    );
+}
+

    @@ -188,7 +266,7 @@

    Advanced topics

    }); - + diff --git a/_site/docs/check-mode.html b/_site/docs/check-mode.html index 4387116..16dc97b 100644 --- a/_site/docs/check-mode.html +++ b/_site/docs/check-mode.html @@ -20,7 +20,7 @@ - + @@ -91,10 +91,6 @@ Advanced topics -
  • - - Community guide -
  • Contributors @@ -115,10 +111,23 @@

    Check mode

    JSON Schema for PHP check mode can be configured using the flags from the Constraint class. These can be configured as default or provided for a single validate() call.

    -
    $checkMode = Constraint::CHECK_MODE_NORMAL | Constraint::CHECK_MODE_VALIDATE_SCHEMA | Constraint::CHECK_MODE_APPLY_DEFAULTS;
-
-$validator = new Validator(new Factory(null, null, $checkMode)); // Setting the default check mode for all validate calls.
-$validator->validate($data, $schema, $checkMode); // Or set the check mode for this validation call.
+
    $checkMode = Constraint::CHECK_MODE_NORMAL | Constraint::CHECK_MODE_VALIDATE_SCHEMA;
+
+$validator = new Validator(
+    new Factory(
+        null,
+        null,
+        $checkMode  // Setting the default check mode for all validate calls.
+    )
+);
+
+// -- OR -- 
+
+$validator->validate(
+    $data,
+    $schema,
+    $checkMode  // Or set the check mode for this validation call.
+);
 
    
 
    Available flags
    
 
@@ -264,7 +273,7 @@ 
    Available flags
+    
 
 
 
diff --git a/_site/docs/contributors.html b/_site/docs/contributors.html
index 7087a2a..04a3166 100644
--- a/_site/docs/contributors.html
+++ b/_site/docs/contributors.html
@@ -20,7 +20,7 @@
 
 
 
-    
+    
 
 
 
@@ -78,17 +78,13 @@
             Getting started
         
                         
  • 
-            
-            Configuration
+            
+            Check mode
         
     
    •                     
  • 
             
             Advanced topics
         
-    
    •                     
  • 
-            
-            Community guide
-        
     
    •                     
  • 
             
             Contributors
@@ -195,7 +191,7 @@ 
    Contributors
    
     });
             
 
-    
+    
 
 
 
diff --git a/_site/docs/getting-started.html b/_site/docs/getting-started.html
index 8c0d023..b45305c 100644
--- a/_site/docs/getting-started.html
+++ b/_site/docs/getting-started.html
@@ -20,7 +20,7 @@
 
 
 
-    
+    
 
 
 
@@ -93,10 +93,6 @@
                 
             Advanced topics
         
-    
    •                     
  • 
-            
-            Community guide
-        
     
    •                     
  • 
             
             Contributors
@@ -251,7 +247,7 @@ 
    Validating using an inline schema            
 
-    
+    
 
 
 
diff --git a/_site/docs/search.html b/_site/docs/search.html
new file mode 100644
index 0000000..f95130f
--- /dev/null
+++ b/_site/docs/search.html
@@ -0,0 +1,224 @@
+
+
+
+    
+
+JSON Schema for PHP - Search
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+    
+
+
+
+
+
+    
+    
+    
+
+
+
+
+
+
+
+
+
+            
+    
    
+        
    
+        
    Search the documentation site
    
+    
+    
+    
    
+        
+    
    
+    
    
+        
+    
    
+    
+
        
    
+
+    
    
+        
+                    
+
+
+            
+            
    
+
+    
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/_site/docs/search.json b/_site/docs/search.json
index 85b177b..cca7996 100644
--- a/_site/docs/search.json
+++ b/_site/docs/search.json
@@ -1 +1 @@
-[{"slug":"advanced-topics","title":"Advanced topics","content":"Advanced topics\n\nThis page needs to be written, want to help out? Checkout GitHub repo!","destination":"advanced-topics.html"},{"slug":"check-mode","title":"Check mode","content":"Check mode\n\nJSON Schema for PHP check mode can be configured using the flags from the Constraint class. These can be configured as default\nor provided for a single validate() call.\n\n$checkMode = Constraint::CHECKMODENORMAL | Constraint::CHECKMODEVALIDATESCHEMA | Constraint::CHECKMODEAPPLYDEFAULTS;\n\n$validator = new Validator(new Factory(null, null, $checkMode)); \/\/ Setting the default check mode for all validate calls.\n$validator->validate($data, $schema, $checkMode); \/\/ Or set the check mode for this validation call.\n\nAvailable flags\nFlag                                              Value        Description\n:\nConstraint::CHECKMODENORMAL                   0x00000001 Validate in 'normal' mode - this is the default\nConstraint::CHECKMODETYPE_CAST                0x00000002 Enable fuzzy type checking for associative arrays and objects\nConstraint::CHECKMODECOERCE_TYPES             0x00000004 Convert data types to match the schema where possible\nConstraint::CHECKMODEAPPLY_DEFAULTS           0x00000008 Apply default values from the schema if not set\nConstraint::CHECKMODEEXCEPTIONS               0x00000010 Throw an exception immediately if validation fails\nConstraint::CHECKMODEDISABLE_FORMAT           0x00000020 Do not validate \"format\" constraints\nConstraint::CHECKMODEEARLY_COERCE             0x00000040 Apply type coercion as soon as possible\nConstraint::CHECKMODEONLYREQUIREDDEFAULTS   0x00000080 When applying defaults, only set values that are required\nConstraint::CHECKMODEVALIDATE_SCHEMA          0x00000100 Validate the schema as well as the provided document","destination":"check-mode.html"},{"slug":"community-guide","title":"Community guide","content":"Community guide\n\nThis page needs to be written, want to help out? Checkout GitHub repo!","destination":"community-guide.html"},{"slug":"contributors","title":"Contributors","content":"Contributors\n\nJSON Schema for PHP would not exist without the dedication, time, and expertise of our community.\nEvery feature, improvement, and bug fix is the result of people generously sharing their skills and ideas.\nWe are deeply grateful for each and every contribution \u2014 large or small \u2014 that has helped shape this project.\n\nCheck out all the amazing people who have made this possible:\n\n\n\nMade with contrib.rocks.","destination":"contributors.html"},{"slug":"getting-started","title":"Getting started","content":"Getting started\n\nInstalling JSON Schema Using Composer\nThe recommended method of installing JSON Schema is using Composer, which installs the required dependencies on\na per-project basis.\n\ncomposer require justinrainbow\/json-schema\n\nValidating using a schema on disk\n\nvalidate($data, (object)['$ref' => 'file:\/\/' . realpath('schema.json')]);\n\nif ($validator->isValid()) {\necho \"The supplied JSON validates against the schema.\\n\";\n} else {\necho \"JSON does not validate. Violations:\\n\";\nforeach ($validator->getErrors() as $error) {\nprintf(\"[%s] %s\\n\", $error['property'], $error['message']);\n}\n}\n\nValidating using an inline schema\n\naddSchema('internal:\/\/mySchema', $jsonSchema);\n$validator = new Validator(new Factory($schemaStorage));\n\n$validator->validate($data, $jsonSchemaObject);\nif ($validator->isValid()) {\necho \"The supplied JSON validates against the schema.\\n\";\n} else {\necho \"JSON does not validate. Violations:\\n\";\nforeach ($validator->getErrors() as $error) {\nprintf(\"[%s] %s\\n\", $error['property'], $error['message']);\n}\n}","destination":"getting-started.html"}]
\ No newline at end of file
+[{"slug":"advanced-topics","title":"Advanced topics","content":"Advanced topics\n\nValidation using schema on disk\nValidation of a JSON document can be done using a schema located on disk.\n\nvalidate($data, (object)['$ref' => 'file:\/\/' . realpath('schema.json')]);\n\nif ($validator->isValid()) {\necho \"The supplied JSON validates against the schema.\\n\";\n} else {\necho \"JSON does not validate. Violations:\\n\";\nforeach ($validator->getErrors() as $error) {\nprintf(\"[%s] %s\\n\", $error['property'], $error['message']);\n}\n}\n\nValidation using inline schema\nValidation of a JSON document can be done using a inline schema. This requires some additional setup of the schema storage\naddSchema('internal:\/\/mySchema', $jsonSchema);\n$validator = new JsonSchema\\Validator(\nnew JsonSchema\\Constraints\\Factory($schemaStorage)\n);\n$validator->validate($data, $jsonSchemaObject);\n\nif ($validator->isValid()) {\necho \"The supplied JSON validates against the schema.\\n\";\n} else {\necho \"JSON does not validate. Violations:\\n\";\nforeach ($validator->getErrors() as $error) {\nprintf(\"[%s] %s\\n\", $error['property'], $error['message']);\n}\n}\n\nValidation using online schema\nThis paragraph needs to be written, want to help out? Checkout GitHub repo!\n\nUsing custom error messages\nAll the errors returned from the library contain a unique constraint name. Using this constraint name you can replace the\nerror message with own, adjusting for your tone of voice or language.\n\naddSchema('internal:\/\/mySchema', $jsonSchema);\n$validator = new JsonSchema\\Validator(\nnew JsonSchema\\Constraints\\Factory($schemaStorage)\n);\n$validator->validate($data, $jsonSchemaObject);\n\nforeach ($validator->getErrors() as $error) {\necho sprintf(\ncustomErrorMessagePatternFunction($error'constraint'),\n...$error'constraint'\n);\n}","destination":"advanced-topics.html"},{"slug":"check-mode","title":"Check mode","content":"Check mode\n\nJSON Schema for PHP check mode can be configured using the flags from the Constraint class. These can be configured as default\nor provided for a single validate() call.\n\n$checkMode = Constraint::CHECKMODENORMAL | Constraint::CHECKMODEVALIDATE_SCHEMA;\n\n$validator = new Validator(\nnew Factory(\nnull,\nnull,\n$checkMode  \/\/ Setting the default check mode for all validate calls.\n)\n);\n\n\/\/ -- OR --\n\n$validator->validate(\n$data,\n$schema,\n$checkMode  \/\/ Or set the check mode for this validation call.\n);\n\nAvailable flags\nFlag                                              Value        Description\n:\nConstraint::CHECKMODENORMAL                   0x00000001 Validate in 'normal' mode - this is the default\nConstraint::CHECKMODETYPE_CAST                0x00000002 Enable fuzzy type checking for associative arrays and objects\nConstraint::CHECKMODECOERCE_TYPES             0x00000004 Convert data types to match the schema where possible\nConstraint::CHECKMODEAPPLY_DEFAULTS           0x00000008 Apply default values from the schema if not set\nConstraint::CHECKMODEEXCEPTIONS               0x00000010 Throw an exception immediately if validation fails\nConstraint::CHECKMODEDISABLE_FORMAT           0x00000020 Do not validate \"format\" constraints\nConstraint::CHECKMODEEARLY_COERCE             0x00000040 Apply type coercion as soon as possible\nConstraint::CHECKMODEONLYREQUIREDDEFAULTS   0x00000080 When applying defaults, only set values that are required\nConstraint::CHECKMODEVALIDATE_SCHEMA          0x00000100 Validate the schema as well as the provided document","destination":"check-mode.html"},{"slug":"contributors","title":"Contributors","content":"Contributors\n\nJSON Schema for PHP would not exist without the dedication, time, and expertise of our community.\nEvery feature, improvement, and bug fix is the result of people generously sharing their skills and ideas.\nWe are deeply grateful for each and every contribution \u2014 large or small \u2014 that has helped shape this project.\n\nCheck out all the amazing people who have made this possible:\n\n\n\nMade with contrib.rocks.","destination":"contributors.html"},{"slug":"getting-started","title":"Getting started","content":"Getting started\n\nInstalling JSON Schema Using Composer\nThe recommended method of installing JSON Schema is using Composer, which installs the required dependencies on\na per-project basis.\n\ncomposer require justinrainbow\/json-schema\n\nValidating using a schema on disk\n\nvalidate($data, (object)['$ref' => 'file:\/\/' . realpath('schema.json')]);\n\nif ($validator->isValid()) {\necho \"The supplied JSON validates against the schema.\\n\";\n} else {\necho \"JSON does not validate. Violations:\\n\";\nforeach ($validator->getErrors() as $error) {\nprintf(\"[%s] %s\\n\", $error['property'], $error['message']);\n}\n}\n\nValidating using an inline schema\n\naddSchema('internal:\/\/mySchema', $jsonSchema);\n$validator = new Validator(new Factory($schemaStorage));\n\n$validator->validate($data, $jsonSchemaObject);\nif ($validator->isValid()) {\necho \"The supplied JSON validates against the schema.\\n\";\n} else {\necho \"JSON does not validate. Violations:\\n\";\nforeach ($validator->getErrors() as $error) {\nprintf(\"[%s] %s\\n\", $error['property'], $error['message']);\n}\n}","destination":"getting-started.html"}]
\ No newline at end of file
diff --git a/_site/feed.xml b/_site/feed.xml
new file mode 100644
index 0000000..cbee999
--- /dev/null
+++ b/_site/feed.xml
@@ -0,0 +1,2 @@
+
+JSON Schema for PHPhttp://localhostJSON Schema for PHP RSS FeedenHydePHP 1.8.0Tue, 09 Sep 2025 13:06:32 +0000
diff --git a/_site/getting-started.html b/_site/getting-started.html
deleted file mode 100644
index f0c3c16..0000000
--- a/_site/getting-started.html
+++ /dev/null
@@ -1,202 +0,0 @@
-
-
-
-    
-
-JSON Schema for PHP - Getting started
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-    
-
-
-
-
-
-    
-    
-    
-
-
-
-
-
-
-
-
-        
-    
    
-        
    
-    
    
-        
    
-            
    Getting started
    
-
    Installing JSON Schema Using Composer
    
-
    The recommended method of installing JSON Schema is using Composer, which installs the required dependencies on
-a per-project basis.
    
-
    composer require justinrainbow/json-schema
-
    
-
    Validating using a schema on disk
    
-
    <?php
-
-$data = json_decode(file_get_contents('data.json'));
-
-// Validate
-$validator = new JsonSchema\Validator;
-$validator->validate($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) {
-        printf("[%s] %s\n", $error['property'], $error['message']);
-    }
-}
-
    
-
    Validating using an inline schema
    
-
    <?php
-
-use JsonSchema\Constraints\Factory;
-use JsonSchema\SchemaStorage;
-use JsonSchema\Validator;
-
-require_once './vendor/autoload.php';
-
-$data = json_decode(file_get_contents('data.json'));
-$jsonSchemaAsString = <<<'JSON'
-{
-  "type": "object",
-  "properties": {
-    "name": { "type": "string"},
-    "email": {"type": "string"}
-  },
-  "required": ["name","email"]
-}
-JSON;
-
-$jsonSchema = json_decode($jsonSchemaAsString);
-$schemaStorage = new SchemaStorage();
-$schemaStorage->addSchema('internal://mySchema', $jsonSchema);
-$validator = new Validator(new Factory($schemaStorage));
-
-$validator->validate($data, $jsonSchemaObject);
-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) {
-        printf("[%s] %s\n", $error['property'], $error['message']);
-    }
-}
-
    
-
-        
    
-    
    
-
    
-    
    
-
-    
-
-    
-
-
-
-
-
-
-
-
-
-
-
-
-
diff --git a/_site/media/mix-manifest.json b/_site/media/mix-manifest.json
deleted file mode 100644
index 5afdfcc..0000000
--- a/_site/media/mix-manifest.json
+++ /dev/null
@@ -1,9 +0,0 @@
-{
-    "/app.js": "/app.js",
-    "/app.css": "/app.css",
-    "/_media/app.css": "/_media/app.css",
-    "/_media/app.js": "/_media/app.js",
-    "/_media/json-schema-logo-blue.svg": "/_media/json-schema-logo-blue.svg",
-    "/_media/mix-manifest.json": "/_media/mix-manifest.json",
-    "/_media/php-logo.svg": "/_media/php-logo.svg"
-}