Skip to content

Commit 07c725e

Browse files
committed
update docs
1 parent efc32a5 commit 07c725e

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

docs/source/gettingStarted.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ The recommended way to install php-json-model-generator is through `Composer <ht
1111
composer require --dev wol-soft/php-json-schema-model-generator
1212
composer require wol-soft/php-json-schema-model-generator-production
1313
14-
To avoid adding all dependencies of the php-json-model-generator to your production dependencies it's recommended to add the library as a dev-dependency and include the php-json-model-generator-exception library. The exception library provides all classes to run the generated code. Generating the classes should either be a step done in the development environment or as a build step of your application (for example you could generate the models in a `composer post-autoload-dump script<https://getcomposer.org/doc/articles/scripts.md#command-events>`__, which is the recommended workflow).
14+
To avoid adding all dependencies of the php-json-model-generator to your production dependencies it's recommended to add the library as a dev-dependency and include the php-json-model-generator-exception library. The exception library provides all classes to run the generated code. Generating the classes should either be a step done in the development environment or as a build step of your application (for example you could generate the models in a `composer post-autoload-dump script <https://getcomposer.org/doc/articles/scripts.md#command-events>`__, which is the recommended workflow).
1515

1616
Generating classes
1717
------------------
@@ -182,7 +182,9 @@ By default the complete input is validated and in case of failing validations al
182182
The exceptions are implemented in the php-json-schema-model-generator-production repository. Default exceptions:
183183

184184
* Error collection enabled: **PHPModelGenerator\\Exception\\ErrorRegistryException**
185-
* Error collection disabled: **PHPModelGenerator\\Exception\\ValidationException**
185+
* Error collection disabled: specific exceptions extending the **PHPModelGenerator\\Exception\\ValidationException**
186+
187+
All collected exceptions from an ErrorRegistryException are accessible via the *getErrors* method. The collected errors are the specific exceptions extending the **PHPModelGenerator\\Exception\\ValidationException** which would be thrown directly if error collection is disabled. Each exception provides various specific details about the validation violation.
186188

187189
.. code-block:: php
188190

0 commit comments

Comments
 (0)