Update docs

Author: wol-soft

docs/source/complexTypes/object.rst

@@ -514,4 +514,48 @@ Multiple violations against the schema dependency may be included.
 Pattern Properties
 ------------------
 
-Pattern properties are currently not supported.
+Using the keyword `patternProperties` further restrictions for properties matching a pattern can be defined.
+
+.. hint::
+
+    If you define constraints via `patternProperties` you may want to use the `PatternPropertiesAccessorPostProcessor <../generator/postProcessor.html#patternpropertiesaccessorpostprocessor>`__ to access your pattern properties.
+
+.. code-block:: json
+
+    {
+        "$id": "example",
+        "type": "object",
+        "properties": {
+            "example": {
+                "type": "integer"
+            }
+        },
+        "patternProperties": {
+            "^a": {
+                "type": "string"
+            }
+        }
+    }
+
+Possible exceptions:
+
+If invalid pattern properties are provided a detailed exception will be thrown containing all violations:
+
+.. code-block:: none
+
+    Provided JSON for Example contains invalid pattern properties.
+      - invalid property 'a0' matching pattern '\^a'
+        * Invalid type for pattern property. Requires string, got integer
+
+The thrown exception will be a *PHPModelGenerator\\Exception\\Object\\InvalidPatternPropertiesException* which provides the following methods to get further error details:
+
+.. code-block:: php
+
+    // returns a two-dimensional array which contains all validation exceptions grouped by property names
+    public function getNestedExceptions(): array
+    // get the pattern which lead to the error
+    public function getPattern(): string
+    // get the name of the property which failed
+    public function getPropertyName(): string
+    // get the value provided to the property
+    public function getProvidedValue()

docs/source/generator/postProcessor.rst

@@ -143,7 +143,68 @@ Generated interface with the **AdditionalPropertiesAccessorPostProcessor**:
 Serialization
 ~~~~~~~~~~~~~
 
-By default additional properties are not included in serialized models. If the **AdditionalPropertiesAccessorPostProcessor** is applied and `serialization <../gettingStarted.html#serialization-methods>`__ is enabled the additional properties will be merged into the serialization result. If the additional properties are processed via a transforming filter each value will be serialized via the serialisation method of the transforming filter.
+By default additional properties are only included in the serialized models if the *additionalProperties* field is set to true or contains further restrictions. If the option *$addForModelsWithoutAdditionalPropertiesDefinition* is set to true also additional properties for entities which don't define the *additionalProperties* field will be included in the serialization result. If the **AdditionalPropertiesAccessorPostProcessor** is applied and `serialization <../gettingStarted.html#serialization-methods>`__ is enabled the additional properties will be merged into the serialization result. If the additional properties are processed via a transforming filter each value will be serialized via the serialisation method of the transforming filter.
+
+PatternPropertiesAccessorPostProcessor
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. code-block:: php
+
+    $generator = new ModelGenerator();
+    $generator->addPostProcessor(new PatternPropertiesAccessorPostProcessor());
+
+The **PatternPropertiesAccessorPostProcessor** adds methods to your model to work with `pattern properties <../complexTypes/object.html#pattern-properties>`__ on your objects. The methods will only be added if the schema for the object defines pattern properties.
+
+Added methods
+~~~~~~~~~~~~~
+
+.. code-block:: json
+
+    {
+        "$id": "example",
+        "type": "object",
+        "properties": {
+            "example": {
+                "type": "string"
+            }
+        },
+        "patternProperties": {
+            "^a": {
+                "type": "string"
+            },
+            "^b": {
+                "key": "numbers"
+                "type": "integer"
+            },
+        }
+    }
+
+Generated interface with the **AdditionalPropertiesAccessorPostProcessor**:
+
+.. code-block:: php
+
+    public function getRawModelDataInput(): array;
+
+    public function setExample(float $example): self;
+    public function getExample(): float;
+
+    public function getPatternProperties(string $key): array;
+
+The added method **getPatternProperties** can be used to fetch a list of all properties matching the given pattern. As *$key* you have to provide the pattern you want to fetch. Alternatively you can define a key in your schema and use the key to fetch the properties.
+
+.. code-block:: php
+
+    $myObject = new Example('a1' => 'Hello', 'b1' => 100);
+
+    // fetches all properties matching the pattern '^a', consequently will return ['a1' => 'Hello']
+    $myObject->getPatternProperties('^a');
+
+    // fetches all properties matching the pattern '^b' (which has a defined key), consequently will return ['b1' => 100]
+    $myObject->getPatternProperties('numbers');
+
+.. note::
+
+    If you want to add or remove pattern properties to your object after the object instantiation you can use the `AdditionalPropertiesAccessorPostProcessor <generator/postProcessor.html#additionalpropertiesaccessorpostprocessor>`__ or the `PopulatePostProcessor <generator/postProcessor.html#populatepostprocessor>`__
 
 Custom Post Processors
 ----------------------