Add additional array tests with nested objects, nested combined schemas

Exception indentation
Fix validator filtering on PropertyProxy
Fix id to $id
Fix counting of combined elements

Author: wol-soft

docs/source/complexTypes/array.rst

@@ -1,57 +1,57 @@
-Enum
-====
-
-Enums can be used to define a set of constant values a property must accept.
-
-.. code-block:: json
-
-    {
-        "id": "example",
-        "type": "object",
-        "properties": {
-            "example": {
-                "type": "string",
-                "enum": ["ABC", "DEF"]
-            }
-        }
-    }
-
-Generated interface:
-
-.. code-block:: php
-
-    public function setExample(?string $example): self;
-    public function getExample(): ?string;
-
-Possible exceptions:
-
-* Invalid type for example. Requires string, got __TYPE__
-* Invalid value for example declined by enum constraint
-
-Untyped Enum
-------------
-
-An enum can also be defined without a specific type.
-
-.. code-block:: json
-
-    {
-        "id": "example",
-        "type": "object",
-        "properties": {
-            "example": {
-                "enum": ["ABC", 10, true, null]
-            }
-        }
-    }
-
-Generated interface (no typehints are generated as it's an untyped enum):
-
-.. code-block:: php
-
-    public function setExample($example): self;
-    public function getExample();
-
-Possible exceptions:
-
-* Invalid value for example declined by enum constraint
+Enum
+====
+
+Enums can be used to define a set of constant values a property must accept.
+
+.. code-block:: json
+
+    {
+        "$id": "example",
+        "type": "object",
+        "properties": {
+            "example": {
+                "type": "string",
+                "enum": ["ABC", "DEF"]
+            }
+        }
+    }
+
+Generated interface:
+
+.. code-block:: php
+
+    public function setExample(?string $example): self;
+    public function getExample(): ?string;
+
+Possible exceptions:
+
+* Invalid type for example. Requires string, got __TYPE__
+* Invalid value for example declined by enum constraint
+
+Untyped Enum
+------------
+
+An enum can also be defined without a specific type.
+
+.. code-block:: json
+
+    {
+        "$id": "example",
+        "type": "object",
+        "properties": {
+            "example": {
+                "enum": ["ABC", 10, true, null]
+            }
+        }
+    }
+
+Generated interface (no typehints are generated as it's an untyped enum):
+
+.. code-block:: php
+
+    public function setExample($example): self;
+    public function getExample();
+
+Possible exceptions:
+
+* Invalid value for example declined by enum constraint

docs/source/complexTypes/enum.rst

@@ -0,0 +1,90 @@
+Combined exceptions
+===================
+
+When building larger schema files with complex types like arrays or combined schemas exception messages may get larger as they include information about what violations were found.
+Our example schema provides an array of people. The people object is combined via `allOf`:
+
+.. code-block:: json
+
+    {
+        "definitions": {
+            "name": {
+                "type": "object",
+                "properties": {
+                    "name": {
+                        "type": "string",
+                        "minLength": 2
+                    }
+                },
+                "required": [
+                    "name"
+                ]
+            }
+        },
+        "$id": "example",
+        "type": "object",
+        "properties": {
+            "people": {
+                "type": "array",
+                "items": {
+                    "allOf": [
+                      {
+                            "$ref": "#/definitions/name"
+                        },
+                        {
+                            "type": "object",
+                            "properties": {
+                                "age": {
+                                    "type": "integer"
+                                }
+                            }
+                        }
+                    ]
+                }
+            }
+        }
+    }
+
+after generating the classes for the given schema we provide an array which contains only invalid items:
+
+.. code-block:: php
+
+    $example = new Example([
+        ['name' => false, 'age' => 42],
+        ['name' => 'F', 'age' => 'yes'],
+        5,
+        []
+    ]);
+
+The exception which will be thrown (combined array-exception and combined-schema-exception with indentation to indicate the error structure):
+
+.. code-block:: none
+
+    Invalid item in array property:
+      - invalid item #0
+        * Invalid value for item of array property declined by composition constraint.
+          Requires to match 2 composition elements but matched 1 elements.
+          - Composition element #1: Failed
+            * Invalid type for name. Requires string, got boolean
+          - Composition element #2: Valid
+      - invalid item #1
+        * Invalid value for item of array property declined by composition constraint.
+          Requires to match 2 composition elements but matched 0 elements.
+          - Composition element #1: Failed
+            * Value for name must not be shorter than 2
+          - Composition element #2: Failed
+            * Invalid type for age. Requires int, got string
+      - invalid item #2
+        * Invalid value for item of array property declined by composition constraint.
+          Requires to match 2 composition elements but matched 0 elements.
+          - Composition element #1: Failed
+            * Invalid type for item of array property. Requires object, got integer
+          - Composition element #2: Failed
+            * Invalid type for item of array property. Requires object, got integer
+      - invalid item #3
+        * Invalid value for item of array property declined by composition constraint.
+          Requires to match 2 composition elements but matched 1 elements.
+          - Composition element #1: Failed
+            * Missing required value for name
+            * Invalid type for name. Requires string, got NULL
+          - Composition element #2: Valid

docs/source/generic/combinedException.rst

@@ -1,33 +1,33 @@
-Default values
-==============
-
-Default values are set inside the model if a property which is not required isn't provided in the input data.
-
-.. code-block:: json
-
-    {
-        "id": "example",
-        "type": "object",
-        "properties": {
-            "example": {
-                "type": "string",
-                "default": "Not provided"
-            }
-        }
-    }
-
-Behaviour with different inputs:
-
-.. code-block:: php
-
-    // property example not provided --> fallback to the default value
-    $example = new Example([]);
-    $example->getExample();     // returns "Not provided"
-
-    // property example explicitly set to null (allowed as the property isn't required)
-    $example = new Example(['example' => null]);
-    $example->getExample();     // returns NULL
-
-    // property example set to a custom value
-    $example = new Example(['example' => 'My Input']);
-    $example->getExample();     // returns "My Input"
+Default values
+==============
+
+Default values are set inside the model if a property which is not required isn't provided in the input data.
+
+.. code-block:: json
+
+    {
+        "$id": "example",
+        "type": "object",
+        "properties": {
+            "example": {
+                "type": "string",
+                "default": "Not provided"
+            }
+        }
+    }
+
+Behaviour with different inputs:
+
+.. code-block:: php
+
+    // property example not provided --> fallback to the default value
+    $example = new Example([]);
+    $example->getExample();     // returns "Not provided"
+
+    // property example explicitly set to null (allowed as the property isn't required)
+    $example = new Example(['example' => null]);
+    $example->getExample();     // returns NULL
+
+    // property example set to a custom value
+    $example = new Example(['example' => 'My Input']);
+    $example->getExample();     // returns "My Input"