From 330ede452bc9e4c600229161c2254c5d18038d02 Mon Sep 17 00:00:00 2001 From: Robert Zondervan Date: Thu, 15 Feb 2024 11:15:36 +0100 Subject: [PATCH 01/21] Map a Lv01 to a ZGW GeoSearch, add endpoint and source --- .../Endpoint/zds.request.endpoint.json | 16 +++++++++++ .../ZdsLv01ToZgwGeoSearch.mapping.json | 18 +++++++++++++ Installation/Source/zgw.zrc.source.json | 27 +++++++++++++++++++ 3 files changed, 61 insertions(+) create mode 100644 Installation/Endpoint/zds.request.endpoint.json create mode 100644 Installation/Mapping/ZdsLv01ToZgwGeoSearch.mapping.json create mode 100644 Installation/Source/zgw.zrc.source.json diff --git a/Installation/Endpoint/zds.request.endpoint.json b/Installation/Endpoint/zds.request.endpoint.json new file mode 100644 index 0000000..56cf8fa --- /dev/null +++ b/Installation/Endpoint/zds.request.endpoint.json @@ -0,0 +1,16 @@ +{ + "title": "ZDS Request Endpoint", + "$id": "https://zds.vng.nl/endpoints/zds.request.endpoint.json", + "path": [ + "stuf", + "zds", + "requests" + ], + "pathRegex": "^stuf/zds/requests$", + "methods": [ + "POST" + ], + "source": "https://zds.vng.nl/endpoints/zgw.zrc.source.json", + "description": "", + "proxy": "/admin/gateways/a29e78fa-c3b9-416f-8b03-8ea973a678a7" +} \ No newline at end of file diff --git a/Installation/Mapping/ZdsLv01ToZgwGeoSearch.mapping.json b/Installation/Mapping/ZdsLv01ToZgwGeoSearch.mapping.json new file mode 100644 index 0000000..5ad56a2 --- /dev/null +++ b/Installation/Mapping/ZdsLv01ToZgwGeoSearch.mapping.json @@ -0,0 +1,18 @@ +{ + "$id": "https://zds.vng.nl/mappings/zdsLv01ToZGWGeoSearch.mapping.json", + "version": "0.0.1", + "title": "ZDS Lv01 to ZGW GeoSearch", + "description": "", + "mapping": { + "rol__betrokkeneIdentificatie__natuurlijkPersoon__inpBsn": "SOAP-ENV:Body.ns2:zakLv01.ns2:gelijk.ns2:heeftAlsInitiator.ns2:gerelateerde.ns2:identificatie", + "identificatie": "SOAP-ENV:Body.ns2:zakLv01.ns2:gelijk.ns2:identificatie" + }, + "unset": [], + "cast": { + "rol__betrokkeneIdentificatie__natuurlijkPersoon__inpBsn": "unsetIfValue==SOAP-ENV:Body.ns2:zakLv01.ns2:gelijk.ns2:heeftAlsInitiator.ns2:gerelateerde.ns2:identificatie", + "identificatie": "unsetIfValue==SOAP-ENV:Body.ns2:zakLv01.ns2:gelijk.ns2:identificatie" + }, + "passTrough": false, + "dateCreated": "2024-02-15T09:48:17+00:00", + "dateModified": "2024-02-15T09:48:17+00:00" +} \ No newline at end of file diff --git a/Installation/Source/zgw.zrc.source.json b/Installation/Source/zgw.zrc.source.json new file mode 100644 index 0000000..6c38d1a --- /dev/null +++ b/Installation/Source/zgw.zrc.source.json @@ -0,0 +1,27 @@ +{ + "title": "ZGW ZRC API", + "$id": "https://zds.vng.nl/endpoints/zgw.zrc.source.json", + "$schema": "https://docs.commongateway.nl/schemas/Gateway.schema.json", + "version": "0.0.1", + "description": "ZGW ZRC source for ZDS proxies", + "location": "!ChangeMe!", + "isEnabled" : false, + "headers": { + "accept" : "application/json", + "Accept-Crs": "EPSG:4326", + "Content-Crs": "EPSG:4326" + }, + "auth": "none", + "configuration": { + "verify": false + }, + "endpointsConfig": { + "zaken/_zoek": { + "out": { + "body": { + "mapping": "https://zds.vng.nl/mappings/zdsLv01ToZGWGeoSearch.mapping.json" + } + } + } + } +} \ No newline at end of file From 0663e38b8cdab94bf7c09be815cb6239fae2ead9 Mon Sep 17 00:00:00 2001 From: GitHub Actions <> Date: Thu, 15 Feb 2024 10:16:45 +0000 Subject: [PATCH 02/21] Update src from remark-lint --- README.md | 40 ++++++++++++--------- docs/classes/README.md | 4 +-- docs/classes/Service/InstallationService.md | 8 ++--- docs/classes/Service/PetStoreService.md | 8 ++--- docs/classes/Service/ZGWToZDSService.md | 32 ++++++++--------- 5 files changed, 49 insertions(+), 43 deletions(-) diff --git a/README.md b/README.md index 887d789..8ad7f21 100644 --- a/README.md +++ b/README.md @@ -50,21 +50,21 @@ Basic knowledge of the [Common Gateway](https://github.com/CommonGateway) This template is for rapid Symfony bundle development and meant as a model to base your custom plugin on. Follow the next steps to create your plugin within 45 minutes or less -1. Login on [GitHub](https://github.com) -2. Use [this template](https://github.com/CommonGateway/ZGW-to-ZDSBundle/generate) -3. Name your Bundle (CamelCase). The bundle needs to end with `Bundle` as per Symfony [naming](https://symfony.com/doc/current/bundles/best_practices.html#bundles-naming-conventions) conventions. -4. Press the green button `Create repository from template` -5. Update file names and namespace to your fitting : +1. Login on [GitHub](https://github.com) +2. Use [this template](https://github.com/CommonGateway/ZGW-to-ZDSBundle/generate) +3. Name your Bundle (CamelCase). The bundle needs to end with `Bundle` as per Symfony [naming](https://symfony.com/doc/current/bundles/best_practices.html#bundles-naming-conventions) conventions. +4. Press the green button `Create repository from template` +5. Update file names and namespace to your fitting : - * Open composer.json, and change the name to your fitting. The first word should be the namespace, and the second the bundle's name. + * Open composer.json, and change the name to your fitting. The first word should be the namespace, and the second the bundle's name. - > Note: this is kebab-case. Also read: [naming your package](https://packagist.org/about#naming-your-package) + > Note: this is kebab-case. Also read: [naming your package](https://packagist.org/about#naming-your-package) - * Check the autoload field to be set accordingly. - * Open PetStoreBundle.php and change the Bundle `name` and `namespace`. The namespace should be the same as your package name in `composer.json` but in CamelCase. So `common-gateway/pet-store-bundle` becomes `CommonGateway/ZGW-to-ZDSBundle` - * Rename the `/Service` and `/ActionHandler` accordingly (or delete if not used). - * Rename the `/DependencyInjection/PetStoreExtension.php` to your `BundleNameExtension.php` - * Rename the `/Resources/config/services.yaml` namespaces + * Check the autoload field to be set accordingly. + * Open PetStoreBundle.php and change the Bundle `name` and `namespace`. The namespace should be the same as your package name in `composer.json` but in CamelCase. So `common-gateway/pet-store-bundle` becomes `CommonGateway/ZGW-to-ZDSBundle` + * Rename the `/Service` and `/ActionHandler` accordingly (or delete if not used). + * Rename the `/DependencyInjection/PetStoreExtension.php` to your `BundleNameExtension.php` + * Rename the `/Resources/config/services.yaml` namespaces ### Adding schemas @@ -74,16 +74,22 @@ You can add existing schemas or create your own and add them to the`/Schema` fol The following properties are required, and without them, the Gateway won't recognize the schema as valid: - - `version` can start on '0.1.0.' +``` +- `version` can start on '0.1.0.' +``` > without this property, you can't update schemes - - `$schema` (https://docs.commongateway.nl/schemas/Entity.schema.json) - - `$id` (https://example.com/schema/{Your scheme name}.schema.json) +``` +- `$schema` (https://docs.commongateway.nl/schemas/Entity.schema.json) +- `$id` (https://example.com/schema/{Your scheme name}.schema.json) +``` > Unique `$id` to be relatable to other schemas. - - `type` must be 'object' - - `properties` must be schema properties +``` +- `type` must be 'object' +- `properties` must be schema properties +``` Once you add schemas to the repository, you can also add objects/data for those schemas. There is an example shown in the [`/Data`](https://github.com/CommonGateway/ZGW-to-ZDSBundle/tree/main/Data) folder. diff --git a/docs/classes/README.md b/docs/classes/README.md index 87f39f1..825467e 100644 --- a/docs/classes/README.md +++ b/docs/classes/README.md @@ -1,4 +1,4 @@ # CommonGateway\ZGWToZDSBundle -* [Service\InstallationService](Service/InstallationService.md) -* [Service\ZGWToZDSService](Service/ZGWToZDSService.md) +* [Service\InstallationService](Service/InstallationService.md) +* [Service\ZGWToZDSService](Service/ZGWToZDSService.md) diff --git a/docs/classes/Service/InstallationService.md b/docs/classes/Service/InstallationService.md index 9211ae7..76ab28b 100644 --- a/docs/classes/Service/InstallationService.md +++ b/docs/classes/Service/InstallationService.md @@ -26,10 +26,10 @@ The constructor **Parameters** -* `(\EntityManagerInterface) $entityManager` - : The entity manager. -* `(\LoggerInterface) $installationLogger` - : The installation logger. +* `(\EntityManagerInterface) $entityManager` + : The entity manager. +* `(\LoggerInterface) $installationLogger` + : The installation logger. **Return Values** diff --git a/docs/classes/Service/PetStoreService.md b/docs/classes/Service/PetStoreService.md index 659c277..232ba68 100644 --- a/docs/classes/Service/PetStoreService.md +++ b/docs/classes/Service/PetStoreService.md @@ -37,10 +37,10 @@ An example handler that is triggered by an action. **Parameters** -* `(array) $data` - : The data array -* `(array) $configuration` - : The configuration array +* `(array) $data` + : The data array +* `(array) $configuration` + : The configuration array **Return Values** diff --git a/docs/classes/Service/ZGWToZDSService.md b/docs/classes/Service/ZGWToZDSService.md index 4ea0f1d..8200989 100644 --- a/docs/classes/Service/ZGWToZDSService.md +++ b/docs/classes/Service/ZGWToZDSService.md @@ -40,10 +40,10 @@ An example handler that is triggered by an action. **Parameters** -* `(array) $data` - : The data array -* `(array) $configuration` - : The configuration array +* `(array) $data` + : The data array +* `(array) $configuration` + : The configuration array **Return Values** @@ -65,10 +65,10 @@ Creates a ZDS Di02 call to the ZDS source, and takes the identification in the r **Parameters** -* `(array) $data` - : The data from the response. -* `(array) $configuration` - : The configuration for this action. +* `(array) $data` + : The data from the response. +* `(array) $configuration` + : The configuration for this action. **Return Values** @@ -90,10 +90,10 @@ Translate information objects to Lk01 messages and send them to a source. **Parameters** -* `(array) $data` - : The data array -* `(array) $configuration` - : The configuration array +* `(array) $data` + : The data array +* `(array) $configuration` + : The configuration array **Return Values** @@ -115,10 +115,10 @@ Creates a ZDS Di02 call to the ZDS source, and takes the identification in the r **Parameters** -* `(array) $data` - : The data from the response. -* `(array) $configuration` - : The configuration for this action. +* `(array) $data` + : The data from the response. +* `(array) $configuration` + : The configuration for this action. **Return Values** From 16d6d81e6c6fedea283d57b6f95cccef0727f50c Mon Sep 17 00:00:00 2001 From: Wilco Louwerse Date: Thu, 15 Feb 2024 11:51:32 +0100 Subject: [PATCH 03/21] Fix endpoint --- Installation/Endpoint/zds.request.endpoint.json | 16 ---------------- Installation/installation.json | 12 ++++++++++++ 2 files changed, 12 insertions(+), 16 deletions(-) delete mode 100644 Installation/Endpoint/zds.request.endpoint.json diff --git a/Installation/Endpoint/zds.request.endpoint.json b/Installation/Endpoint/zds.request.endpoint.json deleted file mode 100644 index 56cf8fa..0000000 --- a/Installation/Endpoint/zds.request.endpoint.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "title": "ZDS Request Endpoint", - "$id": "https://zds.vng.nl/endpoints/zds.request.endpoint.json", - "path": [ - "stuf", - "zds", - "requests" - ], - "pathRegex": "^stuf/zds/requests$", - "methods": [ - "POST" - ], - "source": "https://zds.vng.nl/endpoints/zgw.zrc.source.json", - "description": "", - "proxy": "/admin/gateways/a29e78fa-c3b9-416f-8b03-8ea973a678a7" -} \ No newline at end of file diff --git a/Installation/installation.json b/Installation/installation.json index de826dc..18a7b6f 100644 --- a/Installation/installation.json +++ b/Installation/installation.json @@ -1,5 +1,17 @@ { "installationService": "CommonGateway\\ZGWToZDSBundle\\Service\\InstallationService", + "endpoints": { + "sources": [ + { + "name": "ZDS Request Endpoint", + "reference": "https://zds.vng.nl/endpoints/zgw.zrc.source.json", + "path": "stuf/zds/requests", + "methods": [ + "POST" + ] + } + ] + }, "actions": { "handlers": [ { From 6cb405024ab46d464d6a3a39c06d1bdf73415d17 Mon Sep 17 00:00:00 2001 From: GitHub Actions <> Date: Thu, 15 Feb 2024 10:52:50 +0000 Subject: [PATCH 04/21] Update phpdoc --- docs/classes/README.md | 4 +- docs/classes/Service/InstallationService.md | 64 ++++++++++++++----- docs/classes/Service/ZGWToZDSService.md | 69 +++++++++++++++------ 3 files changed, 101 insertions(+), 36 deletions(-) diff --git a/docs/classes/README.md b/docs/classes/README.md index 825467e..c27427b 100644 --- a/docs/classes/README.md +++ b/docs/classes/README.md @@ -1,4 +1,4 @@ # CommonGateway\ZGWToZDSBundle -* [Service\InstallationService](Service/InstallationService.md) -* [Service\ZGWToZDSService](Service/ZGWToZDSService.md) +* [Service\InstallationService](Service/InstallationService.md) +* [Service\ZGWToZDSService](Service/ZGWToZDSService.md) diff --git a/docs/classes/Service/InstallationService.md b/docs/classes/Service/InstallationService.md index 76ab28b..9792b14 100644 --- a/docs/classes/Service/InstallationService.md +++ b/docs/classes/Service/InstallationService.md @@ -1,20 +1,26 @@ -# CommonGateway\ZGWToZDSBundle\Service\InstallationService +# CommonGateway\ZGWToZDSBundle\Service\InstallationService + -## Implements: +## Implements: CommonGateway\CoreBundle\Installer\InstallerInterface + + ## Methods | Name | Description | |------|-------------| -|[\_\_construct](#installationservice__construct)|The constructor| +|[__construct](#installationservice__construct)|The constructor| |[checkDataConsistency](#installationservicecheckdataconsistency)|The actual code run on update and installation of this bundle| |[install](#installationserviceinstall)|Every installation service should implement an install function| |[uninstall](#installationserviceuninstall)|Every installation service should implement an uninstall function| |[update](#installationserviceupdate)|Every installation service should implement an update function| -### InstallationService::\_\_construct + + + +### InstallationService::__construct **Description** @@ -22,22 +28,26 @@ CommonGateway\CoreBundle\Installer\InstallerInterface public __construct (\EntityManagerInterface $entityManager, \LoggerInterface $installationLogger) ``` -The constructor +The constructor + + **Parameters** * `(\EntityManagerInterface) $entityManager` - : The entity manager. +: The entity manager. * `(\LoggerInterface) $installationLogger` - : The installation logger. +: The installation logger. **Return Values** `void` +
-### InstallationService::checkDataConsistency + +### InstallationService::checkDataConsistency **Description** @@ -45,7 +55,9 @@ The constructor public checkDataConsistency (void) ``` -The actual code run on update and installation of this bundle +The actual code run on update and installation of this bundle + + **Parameters** @@ -55,9 +67,13 @@ The actual code run on update and installation of this bundle `void` + + +
-### InstallationService::install + +### InstallationService::install **Description** @@ -65,7 +81,9 @@ The actual code run on update and installation of this bundle public install (void) ``` -Every installation service should implement an install function +Every installation service should implement an install function + + **Parameters** @@ -75,9 +93,13 @@ Every installation service should implement an install function `void` + + +
-### InstallationService::uninstall + +### InstallationService::uninstall **Description** @@ -85,7 +107,9 @@ Every installation service should implement an install function public uninstall (void) ``` -Every installation service should implement an uninstall function +Every installation service should implement an uninstall function + + **Parameters** @@ -95,9 +119,13 @@ Every installation service should implement an uninstall function `void` + + +
-### InstallationService::update + +### InstallationService::update **Description** @@ -105,7 +133,9 @@ Every installation service should implement an uninstall function public update (void) ``` -Every installation service should implement an update function +Every installation service should implement an update function + + **Parameters** @@ -115,4 +145,8 @@ Every installation service should implement an update function `void` + + +
+ diff --git a/docs/classes/Service/ZGWToZDSService.md b/docs/classes/Service/ZGWToZDSService.md index 8200989..31fc0cd 100644 --- a/docs/classes/Service/ZGWToZDSService.md +++ b/docs/classes/Service/ZGWToZDSService.md @@ -1,16 +1,25 @@ -# CommonGateway\ZGWToZDSBundle\Service\ZGWToZDSService +# CommonGateway\ZGWToZDSBundle\Service\ZGWToZDSService + + + + + + ## Methods | Name | Description | |------|-------------| -|[\_\_construct](#zgwtozdsservice__construct)|| +|[__construct](#zgwtozdsservice__construct)|| |[zgwToZdsHandler](#zgwtozdsservicezgwtozdshandler)|An example handler that is triggered by an action.| |[zgwToZdsIdentificationHandler](#zgwtozdsservicezgwtozdsidentificationhandler)|Creates a ZDS Di02 call to the ZDS source, and takes the identification in the respons as case identifier| |[zgwToZdsInformationObjectHandler](#zgwtozdsservicezgwtozdsinformationobjecthandler)|Translate information objects to Lk01 messages and send them to a source.| |[zgwToZdsObjectIdentificationHandler](#zgwtozdsservicezgwtozdsobjectidentificationhandler)|Creates a ZDS Di02 call to the ZDS source, and takes the identification in the respons as case identifier| -### ZGWToZDSService::\_\_construct + + + +### ZGWToZDSService::__construct **Description** @@ -18,6 +27,10 @@ __construct (void) ``` + + + + **Parameters** `This function has no parameters.` @@ -26,9 +39,11 @@ `void` +
-### ZGWToZDSService::zgwToZdsHandler + +### ZGWToZDSService::zgwToZdsHandler **Description** @@ -36,14 +51,16 @@ public zgwToZdsHandler (array $data, array $configuration) ``` -An example handler that is triggered by an action. +An example handler that is triggered by an action. + + **Parameters** * `(array) $data` - : The data array +: The data array * `(array) $configuration` - : The configuration array +: The configuration array **Return Values** @@ -51,9 +68,11 @@ An example handler that is triggered by an action. > A handler must ALWAYS return an array +
-### ZGWToZDSService::zgwToZdsIdentificationHandler + +### ZGWToZDSService::zgwToZdsIdentificationHandler **Description** @@ -61,14 +80,16 @@ An example handler that is triggered by an action. public zgwToZdsIdentificationHandler (array $data, array $configuration) ``` -Creates a ZDS Di02 call to the ZDS source, and takes the identification in the respons as case identifier +Creates a ZDS Di02 call to the ZDS source, and takes the identification in the respons as case identifier + + **Parameters** * `(array) $data` - : The data from the response. +: The data from the response. * `(array) $configuration` - : The configuration for this action. +: The configuration for this action. **Return Values** @@ -76,9 +97,11 @@ Creates a ZDS Di02 call to the ZDS source, and takes the identification in the r > The resulting data array. +
-### ZGWToZDSService::zgwToZdsInformationObjectHandler + +### ZGWToZDSService::zgwToZdsInformationObjectHandler **Description** @@ -86,14 +109,16 @@ Creates a ZDS Di02 call to the ZDS source, and takes the identification in the r public zgwToZdsInformationObjectHandler (array $data, array $configuration) ``` -Translate information objects to Lk01 messages and send them to a source. +Translate information objects to Lk01 messages and send them to a source. + + **Parameters** * `(array) $data` - : The data array +: The data array * `(array) $configuration` - : The configuration array +: The configuration array **Return Values** @@ -101,9 +126,11 @@ Translate information objects to Lk01 messages and send them to a source. > The updated data array +
-### ZGWToZDSService::zgwToZdsObjectIdentificationHandler + +### ZGWToZDSService::zgwToZdsObjectIdentificationHandler **Description** @@ -111,14 +138,16 @@ Translate information objects to Lk01 messages and send them to a source. public zgwToZdsObjectIdentificationHandler (array $data, array $configuration) ``` -Creates a ZDS Di02 call to the ZDS source, and takes the identification in the respons as case identifier +Creates a ZDS Di02 call to the ZDS source, and takes the identification in the respons as case identifier + + **Parameters** * `(array) $data` - : The data from the response. +: The data from the response. * `(array) $configuration` - : The configuration for this action. +: The configuration for this action. **Return Values** @@ -126,4 +155,6 @@ Creates a ZDS Di02 call to the ZDS source, and takes the identification in the r > The resulting data array. +
+ From 2cad6d553dbfc389dd29b1d5f20f4d3cebea8f71 Mon Sep 17 00:00:00 2001 From: Wilco Louwerse Date: Thu, 15 Feb 2024 14:16:58 +0100 Subject: [PATCH 05/21] Start with some basics for get zaken collection mapping --- .../Mapping/ZgwZaakToZdsResponse.json | 32 ++++++++++ .../Mapping/ZgwZaakToZdsResponseItem.json | 60 +++++++++++++++++++ Installation/Source/zgw.zrc.source.json | 5 ++ 3 files changed, 97 insertions(+) create mode 100644 Installation/Mapping/ZgwZaakToZdsResponse.json create mode 100644 Installation/Mapping/ZgwZaakToZdsResponseItem.json diff --git a/Installation/Mapping/ZgwZaakToZdsResponse.json b/Installation/Mapping/ZgwZaakToZdsResponse.json new file mode 100644 index 0000000..9910e92 --- /dev/null +++ b/Installation/Mapping/ZgwZaakToZdsResponse.json @@ -0,0 +1,32 @@ +{ + "title": "ZgwZaakToZdsResponse", + "$id": "https://zds.nl/mapping/zds.ZgwZaakToZdsResponse.mapping.json", + "$schema": "https://docs.commongateway.nl/schemas/Mapping.schema.json", + "version": "0.0.1", + "passTrough": false, + "mapping": { + "SOAP-ENV:Body.ZKN:zakLa01.ZKN:stuurgegevens.ns1:berichtcode": "La01", + "SOAP-ENV:Body.ZKN:zakLa01.ZKN:stuurgegevens.ns1:zender.ns1:organisatie": "SIM", + "SOAP-ENV:Body.ZKN:zakLa01.ZKN:stuurgegevens.ns1:zender.ns1:applicatie": "SIMsite", + "SOAP-ENV:Body.ZKN:zakLa01.ZKN:stuurgegevens.ns1:zender.ns1:administratie": "", + "SOAP-ENV:Body.ZKN:zakLa01.ZKN:stuurgegevens.ns1:zender.ns1:gebruiker": "", + "SOAP-ENV:Body.ZKN:zakLa01.ZKN:stuurgegevens.ns1:ontvanger.ns1:organisatie": "1892", + "SOAP-ENV:Body.ZKN:zakLa01.ZKN:stuurgegevens.ns1:ontvanger.ns1:applicatie": "Liber", + "SOAP-ENV:Body.ZKN:zakLa01.ZKN:stuurgegevens.ns1:ontvanger.ns1:administratie": "", + "SOAP-ENV:Body.ZKN:zakLa01.ZKN:stuurgegevens.ns1:ontvanger.ns1:gebruiker": "", + "SOAP-ENV:Body.ZKN:zakLa01.ZKN:stuurgegevens.ns1:referentienummer": "identificatie", + "SOAP-ENV:Body.ZKN:zakLa01.ZKN:stuurgegevens.ns1:tijdstipBericht": "{{ 'now'|date('YmdHisv') }}", + "SOAP-ENV:Body.ZKN:zakLa01.ZKN:stuurgegevens.ns1:entiteittype": "ZAK", + "SOAP-ENV:Body.ZKN:zakLa01.ZKN:parameters.ns1:mutatiesoort": "T", + "SOAP-ENV:Body.ZKN:zakLa01.ZKN:parameters.ns1:indicatorOvername": "V", + "SOAP-ENV:Body.ZKN:zakLa01.ZKN:antwoord": "{{ map(\"https://zds.nl/mapping/zds.ZgwZaakToZdsResponseItem.mapping.json\", results, true)|json_encode }}", + "@xmlns:SOAP-ENV": "http://schemas.xmlsoap.org/soap/envelope/", + "@xmlns:ns1": "http://www.egem.nl/StUF/StUF0301", + "@xmlns:ZKN": "http://www.egem.nl/StUF/sector/zkn/0310", + "@xmlns:ns3": "http://www.egem.nl/StUF/sector/bg/0310", + "@xmlns:xsi": "http://www.w3.org/2001/XMLSchema-instance" + }, + "cast": { + "SOAP-ENV:Body.ZKN:zakLa01.ZKN:antwoord": ["jsonToArray"] + } +} diff --git a/Installation/Mapping/ZgwZaakToZdsResponseItem.json b/Installation/Mapping/ZgwZaakToZdsResponseItem.json new file mode 100644 index 0000000..479ba1b --- /dev/null +++ b/Installation/Mapping/ZgwZaakToZdsResponseItem.json @@ -0,0 +1,60 @@ +{ + "title": "ZgwZaakToZdsResponseItem", + "$id": "https://zds.nl/mapping/zds.ZgwZaakToZdsResponseItem.mapping.json", + "$schema": "https://docs.commongateway.nl/schemas/Mapping.schema.json", + "version": "0.0.1", + "passTrough": false, + "mapping": { + "ZKN:object.@StUF:entiteittype": "ZAK", + "ZKN:object.@StUF:sleutelVerzendend": "12004", + "ZKN:object.@StUF:sleutelGegevensbeheer": "12004", + "ZKN:object.ZKN:identificatie": "identificatie", + "ZKN:object.ZKN:omschrijving": "omschrijving", + "ZKN:object.ZKN:toelichting": "toelichting", + "ZKN:object.ZKN:startdatum": "startdatum", + "ZKN:object.ZKN:registratiedatum": "registratiedatum", + "ZKN:object.ZKN:publicatiedatum": "publicatiedatum", + "ZKN:object.ZKN:einddatumGepland": "einddatumGepland", + "ZKN:object.ZKN:uiterlijkeEinddatum": "uiterlijkeEinddatumAfdoening", + "ZKN:object.ZKN:betalingsIndicatie": "betalingsindicatie", + "ZKN:object.ZKN:laatsteBetaaldatum": "laatsteBetaaldatum", + "ZKN:object.ZKN:zaakniveau": "1", + "ZKN:object.ZKN:deelzakenIndicatie": "N", + "ZKN:object.ns1:extraElementen.ns1:extraElement": "[{% for eigenschap in eigenschappen %}{% if eigenschap.waarde is not empty and 'MEEVERHUIZENDE_GEZINSLEDEN' not in eigenschap.naam %}{% if not loop.first %},{% endif %}{{ map('https://zds.nl/mapping/zds.ZgwEigenschapToZds.mapping.json', eigenschap)|json_encode }}{% endif %}{% endfor %}]", + "ZKN:object.ZKN:isVan.@StUF:entiteittype": "ZAKZKT", + "ZKN:object.ZKN:isVan.@StUF:verwerkingssoort": "T", + "ZKN:object.ZKN:isVan.ZKN:gerelateerde.@StUF:entiteittype": "ZKT", + "ZKN:object.ZKN:isVan.ZKN:gerelateerde.@StUF:sleutelOntvangend": "5700000000000000000000000000000000000001", + "ZKN:object.ZKN:isVan.ZKN:gerelateerde.@StUF:verwerkingssoort": "T", + "ZKN:object.ZKN:isVan.ZKN:gerelateerde.ZKN:omschrijving": "Verhuizing doorgeven", + "ZKN:object.ZKN:isVan.ZKN:gerelateerde.ZKN:code": "VERDOOR", + "ZKN:object.ZKN:heeftAlsInitiator.@StUF:entiteittype": "ZAKBTRINI", + "ZKN:object.ZKN:heeftAlsInitiator.@StUF:verwerkingssoort": "T", + "ZKN:object.ZKN:heeftAlsInitiator.ZKN:gerelateerde.ZKN:natuurlijkPersoon.@StUF:entiteittype": "NPS", + "ZKN:object.ZKN:heeftAlsInitiator.ZKN:gerelateerde.ZKN:natuurlijkPersoon.@StUF:verwerkingssoort": "T", + "ZKN:object.ZKN:heeftAlsInitiator.ZKN:gerelateerde.ZKN:natuurlijkPersoon.ns3:inp.bsn": "rollen.0.betrokkeneIdentificatie.inpBsn", + "ZKN:object.ZKN:heeftAlsInitiator.ZKN:gerelateerde.ZKN:natuurlijkPersoon.ns3:authentiek.@StUF:metagegeven": "true", + "ZKN:object.ZKN:heeftAlsInitiator.ZKN:gerelateerde.ZKN:natuurlijkPersoon.ns3:authentiek": "J", + "ZKN:object.ZKN:heeftAlsInitiator.ZKN:gerelateerde.ZKN:natuurlijkPersoon.ns3:geslachtsnaam": "rollen.0.betrokkeneIdentificatie.geslachtsnaam", + "ZKN:object.ZKN:heeftAlsInitiator.ZKN:gerelateerde.ZKN:natuurlijkPersoon.ns3:voorvoegselGeslachtsnaam.@xsi:nil": "true", + "ZKN:object.ZKN:heeftAlsInitiator.ZKN:gerelateerde.ZKN:natuurlijkPersoon.ns3:voorvoegselGeslachtsnaam": "rollen.0.betrokkeneIdentificatie.voorvoegselGeslachtsnaam", + "ZKN:object.ZKN:heeftAlsInitiator.ZKN:gerelateerde.ZKN:natuurlijkPersoon.ns3:voorletters.@xsi:nil": "true", + "ZKN:object.ZKN:heeftAlsInitiator.ZKN:gerelateerde.ZKN:natuurlijkPersoon.ns3:voorletters": "rollen.0.betrokkeneIdentificatie.voorletters", + "ZKN:object.ZKN:heeftAlsInitiator.ZKN:gerelateerde.ZKN:natuurlijkPersoon.ns3:voornamen": "rollen.0.betrokkeneIdentificatie.voornamen", + "ZKN:object.ZKN:heeftAlsInitiator.ZKN:gerelateerde.ZKN:natuurlijkPersoon.ns3:geslachtsaanduiding.@xsi:nil": "true", + "ZKN:object.ZKN:heeftAlsInitiator.ZKN:gerelateerde.ZKN:natuurlijkPersoon.ns3:geslachtsaanduiding": "rollen.0.betrokkeneIdentificatie.geslachtsaanduiding", + "ZKN:object.ZKN:heeftAlsInitiator.ZKN:gerelateerde.ZKN:natuurlijkPersoon.ns3:geboortedatum": "rollen.0.betrokkeneIdentificatie.geboortedatum", + "ZKN:object.ZKN:heeftAlsInitiator.ZKN:gerelateerde.ZKN:natuurlijkPersoon.ns3:verblijfsadres.ns3:wpl.woonplaatsNaam": "rollen.0.betrokkeneIdentificatie.verblijfsadres.wplWoonplaatsNaam", + "ZKN:object.ZKN:heeftAlsInitiator.ZKN:gerelateerde.ZKN:natuurlijkPersoon.ns3:verblijfsadres.ns3:gor.openbareRuimteNaam": "rollen.0.betrokkeneIdentificatie.verblijfsadres.gorOpenbareRuimteNaam", + "ZKN:object.ZKN:heeftAlsInitiator.ZKN:gerelateerde.ZKN:natuurlijkPersoon.ns3:verblijfsadres.ns3:gor.straatnaam.@xsi:nil": "true", + "ZKN:object.ZKN:heeftAlsInitiator.ZKN:gerelateerde.ZKN:natuurlijkPersoon.ns3:verblijfsadres.ns3:aoa.postcode": "rollen.0.betrokkeneIdentificatie.verblijfsadres.aoaPostcode", + "ZKN:object.ZKN:heeftAlsInitiator.ZKN:gerelateerde.ZKN:natuurlijkPersoon.ns3:verblijfsadres.ns3:aoa.huisnummer": "rollen.0.betrokkeneIdentificatie.verblijfsadres.aoaHuisnummer", + "ZKN:object.ZKN:heeftAlsInitiator.ZKN:gerelateerde.ZKN:natuurlijkPersoon.ns3:verblijfsadres.ns3:aoa.huisletter": "rollen.0.betrokkeneIdentificatie.verblijfsadres.aoaHuisletter", + "ZKN:object.ZKN:heeftAlsInitiator.ZKN:gerelateerde.ZKN:natuurlijkPersoon.ns3:verblijfsadres.ns3:aoa.huisnummertoevoeging": "rollen.0.betrokkeneIdentificatie.verblijfsadres.aoaHuisnummertoevoeging", + "ZKN:object.ZKN:heeftAlsOverigBetrokkene": "{% set dotArray = [] %}{% for eigenschap in eigenschappen %}{% if'MEEVERHUIZENDE_GEZINSLEDEN' in eigenschap.naam %}{% set dotArray = dotArray|merge({(eigenschap.naam): eigenschap.waarde}) %}{% endif %}{% endfor %}{% set object = dotToObject(dotArray) %}[{% for gezinslid in object.MEEVERHUIZENDE_GEZINSLEDEN.MEEVERHUIZEND_GEZINSLID %}{% if not loop.first %},{% endif %}{{ map('https://zds.nl/mapping/zds.ZgwOverigBetrokkeneToZds.mapping.json', gezinslid)|json_encode }}{% endfor %}]" + }, + "cast": { + "ZKN:object.ns1:extraElementen.ns1:extraElement": "jsonToArray", + "ZKN:object.ZKN:heeftAlsOverigBetrokkene": "jsonToArray" + } +} \ No newline at end of file diff --git a/Installation/Source/zgw.zrc.source.json b/Installation/Source/zgw.zrc.source.json index 6c38d1a..270f09e 100644 --- a/Installation/Source/zgw.zrc.source.json +++ b/Installation/Source/zgw.zrc.source.json @@ -21,6 +21,11 @@ "body": { "mapping": "https://zds.vng.nl/mappings/zdsLv01ToZGWGeoSearch.mapping.json" } + }, + "in": { + "body": { + "mapping": "https://zds.nl/mapping/zds.ZgwZaakToZdsResponse.mapping.json" + } } } } From e342856ef0abbc3f9b08b000856904bb2cf27f68 Mon Sep 17 00:00:00 2001 From: GitHub Actions <> Date: Thu, 15 Feb 2024 13:17:35 +0000 Subject: [PATCH 06/21] Update src from remark-lint --- docs/classes/README.md | 4 +- docs/classes/Service/InstallationService.md | 64 +++++-------------- docs/classes/Service/ZGWToZDSService.md | 69 ++++++--------------- 3 files changed, 36 insertions(+), 101 deletions(-) diff --git a/docs/classes/README.md b/docs/classes/README.md index c27427b..825467e 100644 --- a/docs/classes/README.md +++ b/docs/classes/README.md @@ -1,4 +1,4 @@ # CommonGateway\ZGWToZDSBundle -* [Service\InstallationService](Service/InstallationService.md) -* [Service\ZGWToZDSService](Service/ZGWToZDSService.md) +* [Service\InstallationService](Service/InstallationService.md) +* [Service\ZGWToZDSService](Service/ZGWToZDSService.md) diff --git a/docs/classes/Service/InstallationService.md b/docs/classes/Service/InstallationService.md index 9792b14..76ab28b 100644 --- a/docs/classes/Service/InstallationService.md +++ b/docs/classes/Service/InstallationService.md @@ -1,26 +1,20 @@ -# CommonGateway\ZGWToZDSBundle\Service\InstallationService - - +# CommonGateway\ZGWToZDSBundle\Service\InstallationService ## Implements: -CommonGateway\CoreBundle\Installer\InstallerInterface - +CommonGateway\CoreBundle\Installer\InstallerInterface ## Methods | Name | Description | |------|-------------| -|[__construct](#installationservice__construct)|The constructor| +|[\_\_construct](#installationservice__construct)|The constructor| |[checkDataConsistency](#installationservicecheckdataconsistency)|The actual code run on update and installation of this bundle| |[install](#installationserviceinstall)|Every installation service should implement an install function| |[uninstall](#installationserviceuninstall)|Every installation service should implement an uninstall function| |[update](#installationserviceupdate)|Every installation service should implement an update function| - - - -### InstallationService::__construct +### InstallationService::\_\_construct **Description** @@ -28,26 +22,22 @@ CommonGateway\CoreBundle\Installer\InstallerInterface public __construct (\EntityManagerInterface $entityManager, \LoggerInterface $installationLogger) ``` -The constructor - - +The constructor **Parameters** * `(\EntityManagerInterface) $entityManager` -: The entity manager. + : The entity manager. * `(\LoggerInterface) $installationLogger` -: The installation logger. + : The installation logger. **Return Values** `void` -
- -### InstallationService::checkDataConsistency +### InstallationService::checkDataConsistency **Description** @@ -55,9 +45,7 @@ The constructor public checkDataConsistency (void) ``` -The actual code run on update and installation of this bundle - - +The actual code run on update and installation of this bundle **Parameters** @@ -67,13 +55,9 @@ The actual code run on update and installation of this bundle `void` - - -
- -### InstallationService::install +### InstallationService::install **Description** @@ -81,9 +65,7 @@ The actual code run on update and installation of this bundle public install (void) ``` -Every installation service should implement an install function - - +Every installation service should implement an install function **Parameters** @@ -93,13 +75,9 @@ Every installation service should implement an install function `void` - - -
- -### InstallationService::uninstall +### InstallationService::uninstall **Description** @@ -107,9 +85,7 @@ Every installation service should implement an install function public uninstall (void) ``` -Every installation service should implement an uninstall function - - +Every installation service should implement an uninstall function **Parameters** @@ -119,13 +95,9 @@ Every installation service should implement an uninstall function `void` - - -
- -### InstallationService::update +### InstallationService::update **Description** @@ -133,9 +105,7 @@ Every installation service should implement an uninstall function public update (void) ``` -Every installation service should implement an update function - - +Every installation service should implement an update function **Parameters** @@ -145,8 +115,4 @@ Every installation service should implement an update function `void` - - -
- diff --git a/docs/classes/Service/ZGWToZDSService.md b/docs/classes/Service/ZGWToZDSService.md index 31fc0cd..8200989 100644 --- a/docs/classes/Service/ZGWToZDSService.md +++ b/docs/classes/Service/ZGWToZDSService.md @@ -1,25 +1,16 @@ -# CommonGateway\ZGWToZDSBundle\Service\ZGWToZDSService - - - - - - +# CommonGateway\ZGWToZDSBundle\Service\ZGWToZDSService ## Methods | Name | Description | |------|-------------| -|[__construct](#zgwtozdsservice__construct)|| +|[\_\_construct](#zgwtozdsservice__construct)|| |[zgwToZdsHandler](#zgwtozdsservicezgwtozdshandler)|An example handler that is triggered by an action.| |[zgwToZdsIdentificationHandler](#zgwtozdsservicezgwtozdsidentificationhandler)|Creates a ZDS Di02 call to the ZDS source, and takes the identification in the respons as case identifier| |[zgwToZdsInformationObjectHandler](#zgwtozdsservicezgwtozdsinformationobjecthandler)|Translate information objects to Lk01 messages and send them to a source.| |[zgwToZdsObjectIdentificationHandler](#zgwtozdsservicezgwtozdsobjectidentificationhandler)|Creates a ZDS Di02 call to the ZDS source, and takes the identification in the respons as case identifier| - - - -### ZGWToZDSService::__construct +### ZGWToZDSService::\_\_construct **Description** @@ -27,10 +18,6 @@ __construct (void) ``` - - - - **Parameters** `This function has no parameters.` @@ -39,11 +26,9 @@ `void` -
- -### ZGWToZDSService::zgwToZdsHandler +### ZGWToZDSService::zgwToZdsHandler **Description** @@ -51,16 +36,14 @@ public zgwToZdsHandler (array $data, array $configuration) ``` -An example handler that is triggered by an action. - - +An example handler that is triggered by an action. **Parameters** * `(array) $data` -: The data array + : The data array * `(array) $configuration` -: The configuration array + : The configuration array **Return Values** @@ -68,11 +51,9 @@ An example handler that is triggered by an action. > A handler must ALWAYS return an array -
- -### ZGWToZDSService::zgwToZdsIdentificationHandler +### ZGWToZDSService::zgwToZdsIdentificationHandler **Description** @@ -80,16 +61,14 @@ An example handler that is triggered by an action. public zgwToZdsIdentificationHandler (array $data, array $configuration) ``` -Creates a ZDS Di02 call to the ZDS source, and takes the identification in the respons as case identifier - - +Creates a ZDS Di02 call to the ZDS source, and takes the identification in the respons as case identifier **Parameters** * `(array) $data` -: The data from the response. + : The data from the response. * `(array) $configuration` -: The configuration for this action. + : The configuration for this action. **Return Values** @@ -97,11 +76,9 @@ Creates a ZDS Di02 call to the ZDS source, and takes the identification in the r > The resulting data array. -
- -### ZGWToZDSService::zgwToZdsInformationObjectHandler +### ZGWToZDSService::zgwToZdsInformationObjectHandler **Description** @@ -109,16 +86,14 @@ Creates a ZDS Di02 call to the ZDS source, and takes the identification in the r public zgwToZdsInformationObjectHandler (array $data, array $configuration) ``` -Translate information objects to Lk01 messages and send them to a source. - - +Translate information objects to Lk01 messages and send them to a source. **Parameters** * `(array) $data` -: The data array + : The data array * `(array) $configuration` -: The configuration array + : The configuration array **Return Values** @@ -126,11 +101,9 @@ Translate information objects to Lk01 messages and send them to a source. > The updated data array -
- -### ZGWToZDSService::zgwToZdsObjectIdentificationHandler +### ZGWToZDSService::zgwToZdsObjectIdentificationHandler **Description** @@ -138,16 +111,14 @@ Translate information objects to Lk01 messages and send them to a source. public zgwToZdsObjectIdentificationHandler (array $data, array $configuration) ``` -Creates a ZDS Di02 call to the ZDS source, and takes the identification in the respons as case identifier - - +Creates a ZDS Di02 call to the ZDS source, and takes the identification in the respons as case identifier **Parameters** * `(array) $data` -: The data from the response. + : The data from the response. * `(array) $configuration` -: The configuration for this action. + : The configuration for this action. **Return Values** @@ -155,6 +126,4 @@ Creates a ZDS Di02 call to the ZDS source, and takes the identification in the r > The resulting data array. -
- From d939cce229b2b6c6ec56d8ed6371039d2b7592ef Mon Sep 17 00:00:00 2001 From: Wilco Louwerse Date: Thu, 15 Feb 2024 15:04:27 +0100 Subject: [PATCH 07/21] First fixes for get zaken collection mapping --- Installation/Mapping/ZgwZaakToZdsResponseItem.json | 5 ++--- Installation/Source/zgw.zrc.source.json | 2 +- 2 files changed, 3 insertions(+), 4 deletions(-) diff --git a/Installation/Mapping/ZgwZaakToZdsResponseItem.json b/Installation/Mapping/ZgwZaakToZdsResponseItem.json index 479ba1b..5db0826 100644 --- a/Installation/Mapping/ZgwZaakToZdsResponseItem.json +++ b/Installation/Mapping/ZgwZaakToZdsResponseItem.json @@ -20,7 +20,7 @@ "ZKN:object.ZKN:laatsteBetaaldatum": "laatsteBetaaldatum", "ZKN:object.ZKN:zaakniveau": "1", "ZKN:object.ZKN:deelzakenIndicatie": "N", - "ZKN:object.ns1:extraElementen.ns1:extraElement": "[{% for eigenschap in eigenschappen %}{% if eigenschap.waarde is not empty and 'MEEVERHUIZENDE_GEZINSLEDEN' not in eigenschap.naam %}{% if not loop.first %},{% endif %}{{ map('https://zds.nl/mapping/zds.ZgwEigenschapToZds.mapping.json', eigenschap)|json_encode }}{% endif %}{% endfor %}]", + "ZKN:object.ns1:extraElementen.ns1:extraElement": "[{% for eigenschap in eigenschappen %}{% if not loop.first %},{% endif %}{{ map('https://zds.nl/mapping/zds.ZgwEigenschapToZds.mapping.json', eigenschap)|json_encode }}{% endfor %}]", "ZKN:object.ZKN:isVan.@StUF:entiteittype": "ZAKZKT", "ZKN:object.ZKN:isVan.@StUF:verwerkingssoort": "T", "ZKN:object.ZKN:isVan.ZKN:gerelateerde.@StUF:entiteittype": "ZKT", @@ -50,8 +50,7 @@ "ZKN:object.ZKN:heeftAlsInitiator.ZKN:gerelateerde.ZKN:natuurlijkPersoon.ns3:verblijfsadres.ns3:aoa.postcode": "rollen.0.betrokkeneIdentificatie.verblijfsadres.aoaPostcode", "ZKN:object.ZKN:heeftAlsInitiator.ZKN:gerelateerde.ZKN:natuurlijkPersoon.ns3:verblijfsadres.ns3:aoa.huisnummer": "rollen.0.betrokkeneIdentificatie.verblijfsadres.aoaHuisnummer", "ZKN:object.ZKN:heeftAlsInitiator.ZKN:gerelateerde.ZKN:natuurlijkPersoon.ns3:verblijfsadres.ns3:aoa.huisletter": "rollen.0.betrokkeneIdentificatie.verblijfsadres.aoaHuisletter", - "ZKN:object.ZKN:heeftAlsInitiator.ZKN:gerelateerde.ZKN:natuurlijkPersoon.ns3:verblijfsadres.ns3:aoa.huisnummertoevoeging": "rollen.0.betrokkeneIdentificatie.verblijfsadres.aoaHuisnummertoevoeging", - "ZKN:object.ZKN:heeftAlsOverigBetrokkene": "{% set dotArray = [] %}{% for eigenschap in eigenschappen %}{% if'MEEVERHUIZENDE_GEZINSLEDEN' in eigenschap.naam %}{% set dotArray = dotArray|merge({(eigenschap.naam): eigenschap.waarde}) %}{% endif %}{% endfor %}{% set object = dotToObject(dotArray) %}[{% for gezinslid in object.MEEVERHUIZENDE_GEZINSLEDEN.MEEVERHUIZEND_GEZINSLID %}{% if not loop.first %},{% endif %}{{ map('https://zds.nl/mapping/zds.ZgwOverigBetrokkeneToZds.mapping.json', gezinslid)|json_encode }}{% endfor %}]" + "ZKN:object.ZKN:heeftAlsInitiator.ZKN:gerelateerde.ZKN:natuurlijkPersoon.ns3:verblijfsadres.ns3:aoa.huisnummertoevoeging": "rollen.0.betrokkeneIdentificatie.verblijfsadres.aoaHuisnummertoevoeging" }, "cast": { "ZKN:object.ns1:extraElementen.ns1:extraElement": "jsonToArray", diff --git a/Installation/Source/zgw.zrc.source.json b/Installation/Source/zgw.zrc.source.json index 270f09e..3d75af4 100644 --- a/Installation/Source/zgw.zrc.source.json +++ b/Installation/Source/zgw.zrc.source.json @@ -16,7 +16,7 @@ "verify": false }, "endpointsConfig": { - "zaken/_zoek": { + "/zaken/_zoek": { "out": { "body": { "mapping": "https://zds.vng.nl/mappings/zdsLv01ToZGWGeoSearch.mapping.json" From b6d75f5414b91bab8785e1422e7e0a9aa8b653e9 Mon Sep 17 00:00:00 2001 From: Robert Zondervan Date: Thu, 15 Feb 2024 15:20:48 +0100 Subject: [PATCH 08/21] Fix request mapping --- Installation/Mapping/ZdsLv01ToZgwGeoSearch.mapping.json | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/Installation/Mapping/ZdsLv01ToZgwGeoSearch.mapping.json b/Installation/Mapping/ZdsLv01ToZgwGeoSearch.mapping.json index 5ad56a2..a381710 100644 --- a/Installation/Mapping/ZdsLv01ToZgwGeoSearch.mapping.json +++ b/Installation/Mapping/ZdsLv01ToZgwGeoSearch.mapping.json @@ -5,14 +5,13 @@ "description": "", "mapping": { "rol__betrokkeneIdentificatie__natuurlijkPersoon__inpBsn": "SOAP-ENV:Body.ns2:zakLv01.ns2:gelijk.ns2:heeftAlsInitiator.ns2:gerelateerde.ns2:identificatie", - "identificatie": "SOAP-ENV:Body.ns2:zakLv01.ns2:gelijk.ns2:identificatie" + "identificatie": "SOAP-ENV:Body.ns2:zakLv01.ns2:gelijk.ns2:identificatie", + "expand": "zaaktype,status,resultaat,resultaat.resultaattype,zaakinformatieobjecten,status.statustype" }, "unset": [], "cast": { "rol__betrokkeneIdentificatie__natuurlijkPersoon__inpBsn": "unsetIfValue==SOAP-ENV:Body.ns2:zakLv01.ns2:gelijk.ns2:heeftAlsInitiator.ns2:gerelateerde.ns2:identificatie", "identificatie": "unsetIfValue==SOAP-ENV:Body.ns2:zakLv01.ns2:gelijk.ns2:identificatie" }, - "passTrough": false, - "dateCreated": "2024-02-15T09:48:17+00:00", - "dateModified": "2024-02-15T09:48:17+00:00" + "passTrough": false } \ No newline at end of file From 162cf97d421cdd3e83bc6f8e615db1ef346c76b6 Mon Sep 17 00:00:00 2001 From: GitHub Actions <> Date: Thu, 15 Feb 2024 14:22:07 +0000 Subject: [PATCH 09/21] Update phpdoc --- docs/classes/README.md | 4 +- docs/classes/Service/InstallationService.md | 64 ++++++++++++++----- docs/classes/Service/ZGWToZDSService.md | 69 +++++++++++++++------ 3 files changed, 101 insertions(+), 36 deletions(-) diff --git a/docs/classes/README.md b/docs/classes/README.md index 825467e..c27427b 100644 --- a/docs/classes/README.md +++ b/docs/classes/README.md @@ -1,4 +1,4 @@ # CommonGateway\ZGWToZDSBundle -* [Service\InstallationService](Service/InstallationService.md) -* [Service\ZGWToZDSService](Service/ZGWToZDSService.md) +* [Service\InstallationService](Service/InstallationService.md) +* [Service\ZGWToZDSService](Service/ZGWToZDSService.md) diff --git a/docs/classes/Service/InstallationService.md b/docs/classes/Service/InstallationService.md index 76ab28b..9792b14 100644 --- a/docs/classes/Service/InstallationService.md +++ b/docs/classes/Service/InstallationService.md @@ -1,20 +1,26 @@ -# CommonGateway\ZGWToZDSBundle\Service\InstallationService +# CommonGateway\ZGWToZDSBundle\Service\InstallationService + -## Implements: +## Implements: CommonGateway\CoreBundle\Installer\InstallerInterface + + ## Methods | Name | Description | |------|-------------| -|[\_\_construct](#installationservice__construct)|The constructor| +|[__construct](#installationservice__construct)|The constructor| |[checkDataConsistency](#installationservicecheckdataconsistency)|The actual code run on update and installation of this bundle| |[install](#installationserviceinstall)|Every installation service should implement an install function| |[uninstall](#installationserviceuninstall)|Every installation service should implement an uninstall function| |[update](#installationserviceupdate)|Every installation service should implement an update function| -### InstallationService::\_\_construct + + + +### InstallationService::__construct **Description** @@ -22,22 +28,26 @@ CommonGateway\CoreBundle\Installer\InstallerInterface public __construct (\EntityManagerInterface $entityManager, \LoggerInterface $installationLogger) ``` -The constructor +The constructor + + **Parameters** * `(\EntityManagerInterface) $entityManager` - : The entity manager. +: The entity manager. * `(\LoggerInterface) $installationLogger` - : The installation logger. +: The installation logger. **Return Values** `void` +
-### InstallationService::checkDataConsistency + +### InstallationService::checkDataConsistency **Description** @@ -45,7 +55,9 @@ The constructor public checkDataConsistency (void) ``` -The actual code run on update and installation of this bundle +The actual code run on update and installation of this bundle + + **Parameters** @@ -55,9 +67,13 @@ The actual code run on update and installation of this bundle `void` + + +
-### InstallationService::install + +### InstallationService::install **Description** @@ -65,7 +81,9 @@ The actual code run on update and installation of this bundle public install (void) ``` -Every installation service should implement an install function +Every installation service should implement an install function + + **Parameters** @@ -75,9 +93,13 @@ Every installation service should implement an install function `void` + + +
-### InstallationService::uninstall + +### InstallationService::uninstall **Description** @@ -85,7 +107,9 @@ Every installation service should implement an install function public uninstall (void) ``` -Every installation service should implement an uninstall function +Every installation service should implement an uninstall function + + **Parameters** @@ -95,9 +119,13 @@ Every installation service should implement an uninstall function `void` + + +
-### InstallationService::update + +### InstallationService::update **Description** @@ -105,7 +133,9 @@ Every installation service should implement an uninstall function public update (void) ``` -Every installation service should implement an update function +Every installation service should implement an update function + + **Parameters** @@ -115,4 +145,8 @@ Every installation service should implement an update function `void` + + +
+ diff --git a/docs/classes/Service/ZGWToZDSService.md b/docs/classes/Service/ZGWToZDSService.md index 8200989..31fc0cd 100644 --- a/docs/classes/Service/ZGWToZDSService.md +++ b/docs/classes/Service/ZGWToZDSService.md @@ -1,16 +1,25 @@ -# CommonGateway\ZGWToZDSBundle\Service\ZGWToZDSService +# CommonGateway\ZGWToZDSBundle\Service\ZGWToZDSService + + + + + + ## Methods | Name | Description | |------|-------------| -|[\_\_construct](#zgwtozdsservice__construct)|| +|[__construct](#zgwtozdsservice__construct)|| |[zgwToZdsHandler](#zgwtozdsservicezgwtozdshandler)|An example handler that is triggered by an action.| |[zgwToZdsIdentificationHandler](#zgwtozdsservicezgwtozdsidentificationhandler)|Creates a ZDS Di02 call to the ZDS source, and takes the identification in the respons as case identifier| |[zgwToZdsInformationObjectHandler](#zgwtozdsservicezgwtozdsinformationobjecthandler)|Translate information objects to Lk01 messages and send them to a source.| |[zgwToZdsObjectIdentificationHandler](#zgwtozdsservicezgwtozdsobjectidentificationhandler)|Creates a ZDS Di02 call to the ZDS source, and takes the identification in the respons as case identifier| -### ZGWToZDSService::\_\_construct + + + +### ZGWToZDSService::__construct **Description** @@ -18,6 +27,10 @@ __construct (void) ``` + + + + **Parameters** `This function has no parameters.` @@ -26,9 +39,11 @@ `void` +
-### ZGWToZDSService::zgwToZdsHandler + +### ZGWToZDSService::zgwToZdsHandler **Description** @@ -36,14 +51,16 @@ public zgwToZdsHandler (array $data, array $configuration) ``` -An example handler that is triggered by an action. +An example handler that is triggered by an action. + + **Parameters** * `(array) $data` - : The data array +: The data array * `(array) $configuration` - : The configuration array +: The configuration array **Return Values** @@ -51,9 +68,11 @@ An example handler that is triggered by an action. > A handler must ALWAYS return an array +
-### ZGWToZDSService::zgwToZdsIdentificationHandler + +### ZGWToZDSService::zgwToZdsIdentificationHandler **Description** @@ -61,14 +80,16 @@ An example handler that is triggered by an action. public zgwToZdsIdentificationHandler (array $data, array $configuration) ``` -Creates a ZDS Di02 call to the ZDS source, and takes the identification in the respons as case identifier +Creates a ZDS Di02 call to the ZDS source, and takes the identification in the respons as case identifier + + **Parameters** * `(array) $data` - : The data from the response. +: The data from the response. * `(array) $configuration` - : The configuration for this action. +: The configuration for this action. **Return Values** @@ -76,9 +97,11 @@ Creates a ZDS Di02 call to the ZDS source, and takes the identification in the r > The resulting data array. +
-### ZGWToZDSService::zgwToZdsInformationObjectHandler + +### ZGWToZDSService::zgwToZdsInformationObjectHandler **Description** @@ -86,14 +109,16 @@ Creates a ZDS Di02 call to the ZDS source, and takes the identification in the r public zgwToZdsInformationObjectHandler (array $data, array $configuration) ``` -Translate information objects to Lk01 messages and send them to a source. +Translate information objects to Lk01 messages and send them to a source. + + **Parameters** * `(array) $data` - : The data array +: The data array * `(array) $configuration` - : The configuration array +: The configuration array **Return Values** @@ -101,9 +126,11 @@ Translate information objects to Lk01 messages and send them to a source. > The updated data array +
-### ZGWToZDSService::zgwToZdsObjectIdentificationHandler + +### ZGWToZDSService::zgwToZdsObjectIdentificationHandler **Description** @@ -111,14 +138,16 @@ Translate information objects to Lk01 messages and send them to a source. public zgwToZdsObjectIdentificationHandler (array $data, array $configuration) ``` -Creates a ZDS Di02 call to the ZDS source, and takes the identification in the respons as case identifier +Creates a ZDS Di02 call to the ZDS source, and takes the identification in the respons as case identifier + + **Parameters** * `(array) $data` - : The data from the response. +: The data from the response. * `(array) $configuration` - : The configuration for this action. +: The configuration for this action. **Return Values** @@ -126,4 +155,6 @@ Creates a ZDS Di02 call to the ZDS source, and takes the identification in the r > The resulting data array. +
+ From 2c139c673e3d416e3c7ccdaf65dba6ee7bf42b48 Mon Sep 17 00:00:00 2001 From: Wilco Louwerse Date: Thu, 15 Feb 2024 15:42:25 +0100 Subject: [PATCH 10/21] Only add gerelateerde natuurlijkPersoon (initiator rol) if present --- .../Mapping/ZgwZaakToZdsResponseItem.json | 26 ++------------- .../ZgwZaakToZdsResponseItemInitiator.json | 32 +++++++++++++++++++ 2 files changed, 34 insertions(+), 24 deletions(-) create mode 100644 Installation/Mapping/ZgwZaakToZdsResponseItemInitiator.json diff --git a/Installation/Mapping/ZgwZaakToZdsResponseItem.json b/Installation/Mapping/ZgwZaakToZdsResponseItem.json index 5db0826..97cfcd6 100644 --- a/Installation/Mapping/ZgwZaakToZdsResponseItem.json +++ b/Installation/Mapping/ZgwZaakToZdsResponseItem.json @@ -28,32 +28,10 @@ "ZKN:object.ZKN:isVan.ZKN:gerelateerde.@StUF:verwerkingssoort": "T", "ZKN:object.ZKN:isVan.ZKN:gerelateerde.ZKN:omschrijving": "Verhuizing doorgeven", "ZKN:object.ZKN:isVan.ZKN:gerelateerde.ZKN:code": "VERDOOR", - "ZKN:object.ZKN:heeftAlsInitiator.@StUF:entiteittype": "ZAKBTRINI", - "ZKN:object.ZKN:heeftAlsInitiator.@StUF:verwerkingssoort": "T", - "ZKN:object.ZKN:heeftAlsInitiator.ZKN:gerelateerde.ZKN:natuurlijkPersoon.@StUF:entiteittype": "NPS", - "ZKN:object.ZKN:heeftAlsInitiator.ZKN:gerelateerde.ZKN:natuurlijkPersoon.@StUF:verwerkingssoort": "T", - "ZKN:object.ZKN:heeftAlsInitiator.ZKN:gerelateerde.ZKN:natuurlijkPersoon.ns3:inp.bsn": "rollen.0.betrokkeneIdentificatie.inpBsn", - "ZKN:object.ZKN:heeftAlsInitiator.ZKN:gerelateerde.ZKN:natuurlijkPersoon.ns3:authentiek.@StUF:metagegeven": "true", - "ZKN:object.ZKN:heeftAlsInitiator.ZKN:gerelateerde.ZKN:natuurlijkPersoon.ns3:authentiek": "J", - "ZKN:object.ZKN:heeftAlsInitiator.ZKN:gerelateerde.ZKN:natuurlijkPersoon.ns3:geslachtsnaam": "rollen.0.betrokkeneIdentificatie.geslachtsnaam", - "ZKN:object.ZKN:heeftAlsInitiator.ZKN:gerelateerde.ZKN:natuurlijkPersoon.ns3:voorvoegselGeslachtsnaam.@xsi:nil": "true", - "ZKN:object.ZKN:heeftAlsInitiator.ZKN:gerelateerde.ZKN:natuurlijkPersoon.ns3:voorvoegselGeslachtsnaam": "rollen.0.betrokkeneIdentificatie.voorvoegselGeslachtsnaam", - "ZKN:object.ZKN:heeftAlsInitiator.ZKN:gerelateerde.ZKN:natuurlijkPersoon.ns3:voorletters.@xsi:nil": "true", - "ZKN:object.ZKN:heeftAlsInitiator.ZKN:gerelateerde.ZKN:natuurlijkPersoon.ns3:voorletters": "rollen.0.betrokkeneIdentificatie.voorletters", - "ZKN:object.ZKN:heeftAlsInitiator.ZKN:gerelateerde.ZKN:natuurlijkPersoon.ns3:voornamen": "rollen.0.betrokkeneIdentificatie.voornamen", - "ZKN:object.ZKN:heeftAlsInitiator.ZKN:gerelateerde.ZKN:natuurlijkPersoon.ns3:geslachtsaanduiding.@xsi:nil": "true", - "ZKN:object.ZKN:heeftAlsInitiator.ZKN:gerelateerde.ZKN:natuurlijkPersoon.ns3:geslachtsaanduiding": "rollen.0.betrokkeneIdentificatie.geslachtsaanduiding", - "ZKN:object.ZKN:heeftAlsInitiator.ZKN:gerelateerde.ZKN:natuurlijkPersoon.ns3:geboortedatum": "rollen.0.betrokkeneIdentificatie.geboortedatum", - "ZKN:object.ZKN:heeftAlsInitiator.ZKN:gerelateerde.ZKN:natuurlijkPersoon.ns3:verblijfsadres.ns3:wpl.woonplaatsNaam": "rollen.0.betrokkeneIdentificatie.verblijfsadres.wplWoonplaatsNaam", - "ZKN:object.ZKN:heeftAlsInitiator.ZKN:gerelateerde.ZKN:natuurlijkPersoon.ns3:verblijfsadres.ns3:gor.openbareRuimteNaam": "rollen.0.betrokkeneIdentificatie.verblijfsadres.gorOpenbareRuimteNaam", - "ZKN:object.ZKN:heeftAlsInitiator.ZKN:gerelateerde.ZKN:natuurlijkPersoon.ns3:verblijfsadres.ns3:gor.straatnaam.@xsi:nil": "true", - "ZKN:object.ZKN:heeftAlsInitiator.ZKN:gerelateerde.ZKN:natuurlijkPersoon.ns3:verblijfsadres.ns3:aoa.postcode": "rollen.0.betrokkeneIdentificatie.verblijfsadres.aoaPostcode", - "ZKN:object.ZKN:heeftAlsInitiator.ZKN:gerelateerde.ZKN:natuurlijkPersoon.ns3:verblijfsadres.ns3:aoa.huisnummer": "rollen.0.betrokkeneIdentificatie.verblijfsadres.aoaHuisnummer", - "ZKN:object.ZKN:heeftAlsInitiator.ZKN:gerelateerde.ZKN:natuurlijkPersoon.ns3:verblijfsadres.ns3:aoa.huisletter": "rollen.0.betrokkeneIdentificatie.verblijfsadres.aoaHuisletter", - "ZKN:object.ZKN:heeftAlsInitiator.ZKN:gerelateerde.ZKN:natuurlijkPersoon.ns3:verblijfsadres.ns3:aoa.huisnummertoevoeging": "rollen.0.betrokkeneIdentificatie.verblijfsadres.aoaHuisnummertoevoeging" + "ZKN:object.ZKN:heeftAlsInitiator": "{% if rollen.0 is defined %}{{ map(\"https://zds.nl/mapping/zds.ZgwZaakToZdsResponseItemInitiator.mapping.json\", rollen.0)|json_encode }}{% else %}\"\"{% endif %}" }, "cast": { "ZKN:object.ns1:extraElementen.ns1:extraElement": "jsonToArray", - "ZKN:object.ZKN:heeftAlsOverigBetrokkene": "jsonToArray" + "ZKN:object.ZKN:heeftAlsInitiator": ["jsonToArray", "unsetIfValue=="] } } \ No newline at end of file diff --git a/Installation/Mapping/ZgwZaakToZdsResponseItemInitiator.json b/Installation/Mapping/ZgwZaakToZdsResponseItemInitiator.json new file mode 100644 index 0000000..f636768 --- /dev/null +++ b/Installation/Mapping/ZgwZaakToZdsResponseItemInitiator.json @@ -0,0 +1,32 @@ +{ + "title": "ZgwZaakToZdsResponseItemInitiator", + "$id": "https://zds.nl/mapping/zds.ZgwZaakToZdsResponseItemInitiator.mapping.json", + "$schema": "https://docs.commongateway.nl/schemas/Mapping.schema.json", + "version": "0.0.1", + "passTrough": false, + "mapping": { + "@StUF:entiteittype": "ZAKBTRINI", + "@StUF:verwerkingssoort": "T", + "ZKN:gerelateerde.ZKN:natuurlijkPersoon.@StUF:entiteittype": "NPS", + "ZKN:gerelateerde.ZKN:natuurlijkPersoon.@StUF:verwerkingssoort": "T", + "ZKN:gerelateerde.ZKN:natuurlijkPersoon.BG:inp.bsn": "betrokkeneIdentificatie.inpBsn", + "ZKN:gerelateerde.ZKN:natuurlijkPersoon.BG:authentiek.@StUF:metagegeven": "true", + "ZKN:gerelateerde.ZKN:natuurlijkPersoon.BG:authentiek": "J", + "ZKN:gerelateerde.ZKN:natuurlijkPersoon.BG:geslachtsnaam": "betrokkeneIdentificatie.geslachtsnaam", + "ZKN:gerelateerde.ZKN:natuurlijkPersoon.BG:voorvoegselGeslachtsnaam.@xsi:nil": "true", + "ZKN:gerelateerde.ZKN:natuurlijkPersoon.BG:voorvoegselGeslachtsnaam": "betrokkeneIdentificatie.voorvoegselGeslachtsnaam", + "ZKN:gerelateerde.ZKN:natuurlijkPersoon.BG:voorletters.@xsi:nil": "true", + "ZKN:gerelateerde.ZKN:natuurlijkPersoon.BG:voorletters": "betrokkeneIdentificatie.voorletters", + "ZKN:gerelateerde.ZKN:natuurlijkPersoon.BG:voornamen": "betrokkeneIdentificatie.voornamen", + "ZKN:gerelateerde.ZKN:natuurlijkPersoon.BG:geslachtsaanduiding.@xsi:nil": "true", + "ZKN:gerelateerde.ZKN:natuurlijkPersoon.BG:geslachtsaanduiding": "betrokkeneIdentificatie.geslachtsaanduiding", + "ZKN:gerelateerde.ZKN:natuurlijkPersoon.BG:geboortedatum": "betrokkeneIdentificatie.geboortedatum", + "ZKN:gerelateerde.ZKN:natuurlijkPersoon.BG:verblijfsadres.BG:wpl.woonplaatsNaam": "betrokkeneIdentificatie.verblijfsadres.wplWoonplaatsNaam", + "ZKN:gerelateerde.ZKN:natuurlijkPersoon.BG:verblijfsadres.BG:gor.openbareRuimteNaam": "betrokkeneIdentificatie.verblijfsadres.gorOpenbareRuimteNaam", + "ZKN:gerelateerde.ZKN:natuurlijkPersoon.BG:verblijfsadres.BG:gor.straatnaam.@xsi:nil": "true", + "ZKN:gerelateerde.ZKN:natuurlijkPersoon.BG:verblijfsadres.BG:aoa.postcode": "betrokkeneIdentificatie.verblijfsadres.aoaPostcode", + "ZKN:gerelateerde.ZKN:natuurlijkPersoon.BG:verblijfsadres.BG:aoa.huisnummer": "betrokkeneIdentificatie.verblijfsadres.aoaHuisnummer", + "ZKN:gerelateerde.ZKN:natuurlijkPersoon.BG:verblijfsadres.BG:aoa.huisletter": "betrokkeneIdentificatie.verblijfsadres.aoaHuisletter", + "ZKN:gerelateerde.ZKN:natuurlijkPersoon.BG:verblijfsadres.BG:aoa.huisnummertoevoeging": "betrokkeneIdentificatie.verblijfsadres.aoaHuisnummertoevoeging" + } +} \ No newline at end of file From 21c704fe3cd2a17d86ce0c03945ad5e22eb1aeb0 Mon Sep 17 00:00:00 2001 From: GitHub Actions <> Date: Thu, 15 Feb 2024 14:43:01 +0000 Subject: [PATCH 11/21] Update src from remark-lint --- docs/classes/README.md | 4 +- docs/classes/Service/InstallationService.md | 64 +++++-------------- docs/classes/Service/ZGWToZDSService.md | 69 ++++++--------------- 3 files changed, 36 insertions(+), 101 deletions(-) diff --git a/docs/classes/README.md b/docs/classes/README.md index c27427b..825467e 100644 --- a/docs/classes/README.md +++ b/docs/classes/README.md @@ -1,4 +1,4 @@ # CommonGateway\ZGWToZDSBundle -* [Service\InstallationService](Service/InstallationService.md) -* [Service\ZGWToZDSService](Service/ZGWToZDSService.md) +* [Service\InstallationService](Service/InstallationService.md) +* [Service\ZGWToZDSService](Service/ZGWToZDSService.md) diff --git a/docs/classes/Service/InstallationService.md b/docs/classes/Service/InstallationService.md index 9792b14..76ab28b 100644 --- a/docs/classes/Service/InstallationService.md +++ b/docs/classes/Service/InstallationService.md @@ -1,26 +1,20 @@ -# CommonGateway\ZGWToZDSBundle\Service\InstallationService - - +# CommonGateway\ZGWToZDSBundle\Service\InstallationService ## Implements: -CommonGateway\CoreBundle\Installer\InstallerInterface - +CommonGateway\CoreBundle\Installer\InstallerInterface ## Methods | Name | Description | |------|-------------| -|[__construct](#installationservice__construct)|The constructor| +|[\_\_construct](#installationservice__construct)|The constructor| |[checkDataConsistency](#installationservicecheckdataconsistency)|The actual code run on update and installation of this bundle| |[install](#installationserviceinstall)|Every installation service should implement an install function| |[uninstall](#installationserviceuninstall)|Every installation service should implement an uninstall function| |[update](#installationserviceupdate)|Every installation service should implement an update function| - - - -### InstallationService::__construct +### InstallationService::\_\_construct **Description** @@ -28,26 +22,22 @@ CommonGateway\CoreBundle\Installer\InstallerInterface public __construct (\EntityManagerInterface $entityManager, \LoggerInterface $installationLogger) ``` -The constructor - - +The constructor **Parameters** * `(\EntityManagerInterface) $entityManager` -: The entity manager. + : The entity manager. * `(\LoggerInterface) $installationLogger` -: The installation logger. + : The installation logger. **Return Values** `void` -
- -### InstallationService::checkDataConsistency +### InstallationService::checkDataConsistency **Description** @@ -55,9 +45,7 @@ The constructor public checkDataConsistency (void) ``` -The actual code run on update and installation of this bundle - - +The actual code run on update and installation of this bundle **Parameters** @@ -67,13 +55,9 @@ The actual code run on update and installation of this bundle `void` - - -
- -### InstallationService::install +### InstallationService::install **Description** @@ -81,9 +65,7 @@ The actual code run on update and installation of this bundle public install (void) ``` -Every installation service should implement an install function - - +Every installation service should implement an install function **Parameters** @@ -93,13 +75,9 @@ Every installation service should implement an install function `void` - - -
- -### InstallationService::uninstall +### InstallationService::uninstall **Description** @@ -107,9 +85,7 @@ Every installation service should implement an install function public uninstall (void) ``` -Every installation service should implement an uninstall function - - +Every installation service should implement an uninstall function **Parameters** @@ -119,13 +95,9 @@ Every installation service should implement an uninstall function `void` - - -
- -### InstallationService::update +### InstallationService::update **Description** @@ -133,9 +105,7 @@ Every installation service should implement an uninstall function public update (void) ``` -Every installation service should implement an update function - - +Every installation service should implement an update function **Parameters** @@ -145,8 +115,4 @@ Every installation service should implement an update function `void` - - -
- diff --git a/docs/classes/Service/ZGWToZDSService.md b/docs/classes/Service/ZGWToZDSService.md index 31fc0cd..8200989 100644 --- a/docs/classes/Service/ZGWToZDSService.md +++ b/docs/classes/Service/ZGWToZDSService.md @@ -1,25 +1,16 @@ -# CommonGateway\ZGWToZDSBundle\Service\ZGWToZDSService - - - - - - +# CommonGateway\ZGWToZDSBundle\Service\ZGWToZDSService ## Methods | Name | Description | |------|-------------| -|[__construct](#zgwtozdsservice__construct)|| +|[\_\_construct](#zgwtozdsservice__construct)|| |[zgwToZdsHandler](#zgwtozdsservicezgwtozdshandler)|An example handler that is triggered by an action.| |[zgwToZdsIdentificationHandler](#zgwtozdsservicezgwtozdsidentificationhandler)|Creates a ZDS Di02 call to the ZDS source, and takes the identification in the respons as case identifier| |[zgwToZdsInformationObjectHandler](#zgwtozdsservicezgwtozdsinformationobjecthandler)|Translate information objects to Lk01 messages and send them to a source.| |[zgwToZdsObjectIdentificationHandler](#zgwtozdsservicezgwtozdsobjectidentificationhandler)|Creates a ZDS Di02 call to the ZDS source, and takes the identification in the respons as case identifier| - - - -### ZGWToZDSService::__construct +### ZGWToZDSService::\_\_construct **Description** @@ -27,10 +18,6 @@ __construct (void) ``` - - - - **Parameters** `This function has no parameters.` @@ -39,11 +26,9 @@ `void` -
- -### ZGWToZDSService::zgwToZdsHandler +### ZGWToZDSService::zgwToZdsHandler **Description** @@ -51,16 +36,14 @@ public zgwToZdsHandler (array $data, array $configuration) ``` -An example handler that is triggered by an action. - - +An example handler that is triggered by an action. **Parameters** * `(array) $data` -: The data array + : The data array * `(array) $configuration` -: The configuration array + : The configuration array **Return Values** @@ -68,11 +51,9 @@ An example handler that is triggered by an action. > A handler must ALWAYS return an array -
- -### ZGWToZDSService::zgwToZdsIdentificationHandler +### ZGWToZDSService::zgwToZdsIdentificationHandler **Description** @@ -80,16 +61,14 @@ An example handler that is triggered by an action. public zgwToZdsIdentificationHandler (array $data, array $configuration) ``` -Creates a ZDS Di02 call to the ZDS source, and takes the identification in the respons as case identifier - - +Creates a ZDS Di02 call to the ZDS source, and takes the identification in the respons as case identifier **Parameters** * `(array) $data` -: The data from the response. + : The data from the response. * `(array) $configuration` -: The configuration for this action. + : The configuration for this action. **Return Values** @@ -97,11 +76,9 @@ Creates a ZDS Di02 call to the ZDS source, and takes the identification in the r > The resulting data array. -
- -### ZGWToZDSService::zgwToZdsInformationObjectHandler +### ZGWToZDSService::zgwToZdsInformationObjectHandler **Description** @@ -109,16 +86,14 @@ Creates a ZDS Di02 call to the ZDS source, and takes the identification in the r public zgwToZdsInformationObjectHandler (array $data, array $configuration) ``` -Translate information objects to Lk01 messages and send them to a source. - - +Translate information objects to Lk01 messages and send them to a source. **Parameters** * `(array) $data` -: The data array + : The data array * `(array) $configuration` -: The configuration array + : The configuration array **Return Values** @@ -126,11 +101,9 @@ Translate information objects to Lk01 messages and send them to a source. > The updated data array -
- -### ZGWToZDSService::zgwToZdsObjectIdentificationHandler +### ZGWToZDSService::zgwToZdsObjectIdentificationHandler **Description** @@ -138,16 +111,14 @@ Translate information objects to Lk01 messages and send them to a source. public zgwToZdsObjectIdentificationHandler (array $data, array $configuration) ``` -Creates a ZDS Di02 call to the ZDS source, and takes the identification in the respons as case identifier - - +Creates a ZDS Di02 call to the ZDS source, and takes the identification in the respons as case identifier **Parameters** * `(array) $data` -: The data from the response. + : The data from the response. * `(array) $configuration` -: The configuration for this action. + : The configuration for this action. **Return Values** @@ -155,6 +126,4 @@ Creates a ZDS Di02 call to the ZDS source, and takes the identification in the r > The resulting data array. -
- From 76e39085ad5ad84d5100ad4c907fc549fcb52d95 Mon Sep 17 00:00:00 2001 From: Wilco Louwerse Date: Thu, 15 Feb 2024 15:58:23 +0100 Subject: [PATCH 12/21] Fix mapping ZKN.object --- .../Mapping/ZgwZaakToZdsResponse.json | 4 +- .../Mapping/ZgwZaakToZdsResponseItem.json | 52 +++++++++---------- 2 files changed, 28 insertions(+), 28 deletions(-) diff --git a/Installation/Mapping/ZgwZaakToZdsResponse.json b/Installation/Mapping/ZgwZaakToZdsResponse.json index 9910e92..781e2bf 100644 --- a/Installation/Mapping/ZgwZaakToZdsResponse.json +++ b/Installation/Mapping/ZgwZaakToZdsResponse.json @@ -19,7 +19,7 @@ "SOAP-ENV:Body.ZKN:zakLa01.ZKN:stuurgegevens.ns1:entiteittype": "ZAK", "SOAP-ENV:Body.ZKN:zakLa01.ZKN:parameters.ns1:mutatiesoort": "T", "SOAP-ENV:Body.ZKN:zakLa01.ZKN:parameters.ns1:indicatorOvername": "V", - "SOAP-ENV:Body.ZKN:zakLa01.ZKN:antwoord": "{{ map(\"https://zds.nl/mapping/zds.ZgwZaakToZdsResponseItem.mapping.json\", results, true)|json_encode }}", + "SOAP-ENV:Body.ZKN:zakLa01.ZKN:antwoord.ZKN:object": "{{ map(\"https://zds.nl/mapping/zds.ZgwZaakToZdsResponseItem.mapping.json\", results, true)|json_encode }}", "@xmlns:SOAP-ENV": "http://schemas.xmlsoap.org/soap/envelope/", "@xmlns:ns1": "http://www.egem.nl/StUF/StUF0301", "@xmlns:ZKN": "http://www.egem.nl/StUF/sector/zkn/0310", @@ -27,6 +27,6 @@ "@xmlns:xsi": "http://www.w3.org/2001/XMLSchema-instance" }, "cast": { - "SOAP-ENV:Body.ZKN:zakLa01.ZKN:antwoord": ["jsonToArray"] + "SOAP-ENV:Body.ZKN:zakLa01.ZKN:antwoord.ZKN:object": ["jsonToArray"] } } diff --git a/Installation/Mapping/ZgwZaakToZdsResponseItem.json b/Installation/Mapping/ZgwZaakToZdsResponseItem.json index 97cfcd6..e116536 100644 --- a/Installation/Mapping/ZgwZaakToZdsResponseItem.json +++ b/Installation/Mapping/ZgwZaakToZdsResponseItem.json @@ -5,33 +5,33 @@ "version": "0.0.1", "passTrough": false, "mapping": { - "ZKN:object.@StUF:entiteittype": "ZAK", - "ZKN:object.@StUF:sleutelVerzendend": "12004", - "ZKN:object.@StUF:sleutelGegevensbeheer": "12004", - "ZKN:object.ZKN:identificatie": "identificatie", - "ZKN:object.ZKN:omschrijving": "omschrijving", - "ZKN:object.ZKN:toelichting": "toelichting", - "ZKN:object.ZKN:startdatum": "startdatum", - "ZKN:object.ZKN:registratiedatum": "registratiedatum", - "ZKN:object.ZKN:publicatiedatum": "publicatiedatum", - "ZKN:object.ZKN:einddatumGepland": "einddatumGepland", - "ZKN:object.ZKN:uiterlijkeEinddatum": "uiterlijkeEinddatumAfdoening", - "ZKN:object.ZKN:betalingsIndicatie": "betalingsindicatie", - "ZKN:object.ZKN:laatsteBetaaldatum": "laatsteBetaaldatum", - "ZKN:object.ZKN:zaakniveau": "1", - "ZKN:object.ZKN:deelzakenIndicatie": "N", - "ZKN:object.ns1:extraElementen.ns1:extraElement": "[{% for eigenschap in eigenschappen %}{% if not loop.first %},{% endif %}{{ map('https://zds.nl/mapping/zds.ZgwEigenschapToZds.mapping.json', eigenschap)|json_encode }}{% endfor %}]", - "ZKN:object.ZKN:isVan.@StUF:entiteittype": "ZAKZKT", - "ZKN:object.ZKN:isVan.@StUF:verwerkingssoort": "T", - "ZKN:object.ZKN:isVan.ZKN:gerelateerde.@StUF:entiteittype": "ZKT", - "ZKN:object.ZKN:isVan.ZKN:gerelateerde.@StUF:sleutelOntvangend": "5700000000000000000000000000000000000001", - "ZKN:object.ZKN:isVan.ZKN:gerelateerde.@StUF:verwerkingssoort": "T", - "ZKN:object.ZKN:isVan.ZKN:gerelateerde.ZKN:omschrijving": "Verhuizing doorgeven", - "ZKN:object.ZKN:isVan.ZKN:gerelateerde.ZKN:code": "VERDOOR", - "ZKN:object.ZKN:heeftAlsInitiator": "{% if rollen.0 is defined %}{{ map(\"https://zds.nl/mapping/zds.ZgwZaakToZdsResponseItemInitiator.mapping.json\", rollen.0)|json_encode }}{% else %}\"\"{% endif %}" + "@StUF:entiteittype": "ZAK", + "@StUF:sleutelVerzendend": "12004", + "@StUF:sleutelGegevensbeheer": "12004", + "ZKN:identificatie": "identificatie", + "ZKN:omschrijving": "omschrijving", + "ZKN:toelichting": "toelichting", + "ZKN:startdatum": "startdatum", + "ZKN:registratiedatum": "registratiedatum", + "ZKN:publicatiedatum": "publicatiedatum", + "ZKN:einddatumGepland": "einddatumGepland", + "ZKN:uiterlijkeEinddatum": "uiterlijkeEinddatumAfdoening", + "ZKN:betalingsIndicatie": "betalingsindicatie", + "ZKN:laatsteBetaaldatum": "laatsteBetaaldatum", + "ZKN:zaakniveau": "1", + "ZKN:deelzakenIndicatie": "N", + "ns1:extraElementen.ns1:extraElement": "[{% for eigenschap in eigenschappen %}{% if not loop.first %},{% endif %}{{ map('https://zds.nl/mapping/zds.ZgwEigenschapToZds.mapping.json', eigenschap)|json_encode }}{% endfor %}]", + "ZKN:isVan.@StUF:entiteittype": "ZAKZKT", + "ZKN:isVan.@StUF:verwerkingssoort": "T", + "ZKN:isVan.ZKN:gerelateerde.@StUF:entiteittype": "ZKT", + "ZKN:isVan.ZKN:gerelateerde.@StUF:sleutelOntvangend": "5700000000000000000000000000000000000001", + "ZKN:isVan.ZKN:gerelateerde.@StUF:verwerkingssoort": "T", + "ZKN:isVan.ZKN:gerelateerde.ZKN:omschrijving": "Verhuizing doorgeven", + "ZKN:isVan.ZKN:gerelateerde.ZKN:code": "VERDOOR", + "ZKN:heeftAlsInitiator": "{% if rollen.0 is defined %}{{ map(\"https://zds.nl/mapping/zds.ZgwZaakToZdsResponseItemInitiator.mapping.json\", rollen.0)|json_encode }}{% else %}\"\"{% endif %}" }, "cast": { - "ZKN:object.ns1:extraElementen.ns1:extraElement": "jsonToArray", - "ZKN:object.ZKN:heeftAlsInitiator": ["jsonToArray", "unsetIfValue=="] + "ns1:extraElementen.ns1:extraElement": "jsonToArray", + "ZKN:heeftAlsInitiator": ["jsonToArray", "unsetIfValue=="] } } \ No newline at end of file From 03cc73cf7afcb68cbfd7ad528229b1342886dc11 Mon Sep 17 00:00:00 2001 From: GitHub Actions <> Date: Thu, 15 Feb 2024 14:59:53 +0000 Subject: [PATCH 13/21] Update phpdoc --- docs/classes/README.md | 4 +- docs/classes/Service/InstallationService.md | 64 ++++++++++++++----- docs/classes/Service/ZGWToZDSService.md | 69 +++++++++++++++------ 3 files changed, 101 insertions(+), 36 deletions(-) diff --git a/docs/classes/README.md b/docs/classes/README.md index 825467e..c27427b 100644 --- a/docs/classes/README.md +++ b/docs/classes/README.md @@ -1,4 +1,4 @@ # CommonGateway\ZGWToZDSBundle -* [Service\InstallationService](Service/InstallationService.md) -* [Service\ZGWToZDSService](Service/ZGWToZDSService.md) +* [Service\InstallationService](Service/InstallationService.md) +* [Service\ZGWToZDSService](Service/ZGWToZDSService.md) diff --git a/docs/classes/Service/InstallationService.md b/docs/classes/Service/InstallationService.md index 76ab28b..9792b14 100644 --- a/docs/classes/Service/InstallationService.md +++ b/docs/classes/Service/InstallationService.md @@ -1,20 +1,26 @@ -# CommonGateway\ZGWToZDSBundle\Service\InstallationService +# CommonGateway\ZGWToZDSBundle\Service\InstallationService + -## Implements: +## Implements: CommonGateway\CoreBundle\Installer\InstallerInterface + + ## Methods | Name | Description | |------|-------------| -|[\_\_construct](#installationservice__construct)|The constructor| +|[__construct](#installationservice__construct)|The constructor| |[checkDataConsistency](#installationservicecheckdataconsistency)|The actual code run on update and installation of this bundle| |[install](#installationserviceinstall)|Every installation service should implement an install function| |[uninstall](#installationserviceuninstall)|Every installation service should implement an uninstall function| |[update](#installationserviceupdate)|Every installation service should implement an update function| -### InstallationService::\_\_construct + + + +### InstallationService::__construct **Description** @@ -22,22 +28,26 @@ CommonGateway\CoreBundle\Installer\InstallerInterface public __construct (\EntityManagerInterface $entityManager, \LoggerInterface $installationLogger) ``` -The constructor +The constructor + + **Parameters** * `(\EntityManagerInterface) $entityManager` - : The entity manager. +: The entity manager. * `(\LoggerInterface) $installationLogger` - : The installation logger. +: The installation logger. **Return Values** `void` +
-### InstallationService::checkDataConsistency + +### InstallationService::checkDataConsistency **Description** @@ -45,7 +55,9 @@ The constructor public checkDataConsistency (void) ``` -The actual code run on update and installation of this bundle +The actual code run on update and installation of this bundle + + **Parameters** @@ -55,9 +67,13 @@ The actual code run on update and installation of this bundle `void` + + +
-### InstallationService::install + +### InstallationService::install **Description** @@ -65,7 +81,9 @@ The actual code run on update and installation of this bundle public install (void) ``` -Every installation service should implement an install function +Every installation service should implement an install function + + **Parameters** @@ -75,9 +93,13 @@ Every installation service should implement an install function `void` + + +
-### InstallationService::uninstall + +### InstallationService::uninstall **Description** @@ -85,7 +107,9 @@ Every installation service should implement an install function public uninstall (void) ``` -Every installation service should implement an uninstall function +Every installation service should implement an uninstall function + + **Parameters** @@ -95,9 +119,13 @@ Every installation service should implement an uninstall function `void` + + +
-### InstallationService::update + +### InstallationService::update **Description** @@ -105,7 +133,9 @@ Every installation service should implement an uninstall function public update (void) ``` -Every installation service should implement an update function +Every installation service should implement an update function + + **Parameters** @@ -115,4 +145,8 @@ Every installation service should implement an update function `void` + + +
+ diff --git a/docs/classes/Service/ZGWToZDSService.md b/docs/classes/Service/ZGWToZDSService.md index 8200989..31fc0cd 100644 --- a/docs/classes/Service/ZGWToZDSService.md +++ b/docs/classes/Service/ZGWToZDSService.md @@ -1,16 +1,25 @@ -# CommonGateway\ZGWToZDSBundle\Service\ZGWToZDSService +# CommonGateway\ZGWToZDSBundle\Service\ZGWToZDSService + + + + + + ## Methods | Name | Description | |------|-------------| -|[\_\_construct](#zgwtozdsservice__construct)|| +|[__construct](#zgwtozdsservice__construct)|| |[zgwToZdsHandler](#zgwtozdsservicezgwtozdshandler)|An example handler that is triggered by an action.| |[zgwToZdsIdentificationHandler](#zgwtozdsservicezgwtozdsidentificationhandler)|Creates a ZDS Di02 call to the ZDS source, and takes the identification in the respons as case identifier| |[zgwToZdsInformationObjectHandler](#zgwtozdsservicezgwtozdsinformationobjecthandler)|Translate information objects to Lk01 messages and send them to a source.| |[zgwToZdsObjectIdentificationHandler](#zgwtozdsservicezgwtozdsobjectidentificationhandler)|Creates a ZDS Di02 call to the ZDS source, and takes the identification in the respons as case identifier| -### ZGWToZDSService::\_\_construct + + + +### ZGWToZDSService::__construct **Description** @@ -18,6 +27,10 @@ __construct (void) ``` + + + + **Parameters** `This function has no parameters.` @@ -26,9 +39,11 @@ `void` +
-### ZGWToZDSService::zgwToZdsHandler + +### ZGWToZDSService::zgwToZdsHandler **Description** @@ -36,14 +51,16 @@ public zgwToZdsHandler (array $data, array $configuration) ``` -An example handler that is triggered by an action. +An example handler that is triggered by an action. + + **Parameters** * `(array) $data` - : The data array +: The data array * `(array) $configuration` - : The configuration array +: The configuration array **Return Values** @@ -51,9 +68,11 @@ An example handler that is triggered by an action. > A handler must ALWAYS return an array +
-### ZGWToZDSService::zgwToZdsIdentificationHandler + +### ZGWToZDSService::zgwToZdsIdentificationHandler **Description** @@ -61,14 +80,16 @@ An example handler that is triggered by an action. public zgwToZdsIdentificationHandler (array $data, array $configuration) ``` -Creates a ZDS Di02 call to the ZDS source, and takes the identification in the respons as case identifier +Creates a ZDS Di02 call to the ZDS source, and takes the identification in the respons as case identifier + + **Parameters** * `(array) $data` - : The data from the response. +: The data from the response. * `(array) $configuration` - : The configuration for this action. +: The configuration for this action. **Return Values** @@ -76,9 +97,11 @@ Creates a ZDS Di02 call to the ZDS source, and takes the identification in the r > The resulting data array. +
-### ZGWToZDSService::zgwToZdsInformationObjectHandler + +### ZGWToZDSService::zgwToZdsInformationObjectHandler **Description** @@ -86,14 +109,16 @@ Creates a ZDS Di02 call to the ZDS source, and takes the identification in the r public zgwToZdsInformationObjectHandler (array $data, array $configuration) ``` -Translate information objects to Lk01 messages and send them to a source. +Translate information objects to Lk01 messages and send them to a source. + + **Parameters** * `(array) $data` - : The data array +: The data array * `(array) $configuration` - : The configuration array +: The configuration array **Return Values** @@ -101,9 +126,11 @@ Translate information objects to Lk01 messages and send them to a source. > The updated data array +
-### ZGWToZDSService::zgwToZdsObjectIdentificationHandler + +### ZGWToZDSService::zgwToZdsObjectIdentificationHandler **Description** @@ -111,14 +138,16 @@ Translate information objects to Lk01 messages and send them to a source. public zgwToZdsObjectIdentificationHandler (array $data, array $configuration) ``` -Creates a ZDS Di02 call to the ZDS source, and takes the identification in the respons as case identifier +Creates a ZDS Di02 call to the ZDS source, and takes the identification in the respons as case identifier + + **Parameters** * `(array) $data` - : The data from the response. +: The data from the response. * `(array) $configuration` - : The configuration for this action. +: The configuration for this action. **Return Values** @@ -126,4 +155,6 @@ Creates a ZDS Di02 call to the ZDS source, and takes the identification in the r > The resulting data array. +
+ From e8358ec88cdee162db76f94a55e0ddaf615d52e9 Mon Sep 17 00:00:00 2001 From: Wilco Louwerse Date: Thu, 15 Feb 2024 16:05:28 +0100 Subject: [PATCH 14/21] Added xmlEncode actionHandler --- .../ZgwZaakToZdsXmlEncodeAction.action.json | 13 ++++ Installation/installation.json | 3 + .../ZgwToZDSXMLEncodeHandler.php | 76 +++++++++++++++++++ src/Service/ZGWToZDSService.php | 16 ++++ 4 files changed, 108 insertions(+) create mode 100644 Installation/Action/ZgwZaakToZdsXmlEncodeAction.action.json create mode 100644 src/ActionHandler/ZgwToZDSXMLEncodeHandler.php diff --git a/Installation/Action/ZgwZaakToZdsXmlEncodeAction.action.json b/Installation/Action/ZgwZaakToZdsXmlEncodeAction.action.json new file mode 100644 index 0000000..bcaf9b5 --- /dev/null +++ b/Installation/Action/ZgwZaakToZdsXmlEncodeAction.action.json @@ -0,0 +1,13 @@ +{ + "title": "ZgwZaakToZdsXmlEncodeAction.action.json", + "$id": "https://dowr.simxml.nl/action/ZgwZaakToZdsXmlEncodeAction.action.json.action.json", + "$schema": "https://docs.commongateway.nl/schemas/Action.schema.json", + "version": "0.0.1", + "listens": [ + "zgwToZds.xmlEncode" + ], + "conditions": { + "==": [1,1] + }, + "class": "CommonGateway\\ZGWToZDSBundle\\ActionHandler\\ZgwToZDSXMLEncodeHandler" +} diff --git a/Installation/installation.json b/Installation/installation.json index 18a7b6f..470963e 100644 --- a/Installation/installation.json +++ b/Installation/installation.json @@ -8,6 +8,9 @@ "path": "stuf/zds/requests", "methods": [ "POST" + ], + "throws": [ + "zgwToZds.xmlEncode" ] } ] diff --git a/src/ActionHandler/ZgwToZDSXMLEncodeHandler.php b/src/ActionHandler/ZgwToZDSXMLEncodeHandler.php new file mode 100644 index 0000000..47743c9 --- /dev/null +++ b/src/ActionHandler/ZgwToZDSXMLEncodeHandler.php @@ -0,0 +1,76 @@ +, Wilco Louwerse + * @license EUPL-1.2 https://joinup.ec.europa.eu/collection/eupl/eupl-text-eupl-12 + */ +class ZgwToZDSXMLEncodeHandler implements ActionHandlerInterface +{ + + /** + * The zgw to zds service used by the handler + * + * @var ZGWToZDSService + */ + private ZGWToZDSService $service; + + + /** + * The constructor + * + * @param ZGWToZDSService $service The zgw to zds service + */ + public function __construct(ZGWToZDSService $service) + { + $this->service = $service; + + }//end __construct() + + + /** + * Returns the required configuration as a https://json-schema.org array. + * + * @return array The configuration that this action should comply to + */ + public function getConfiguration(): array + { + return [ + '$id' => 'https://example.com/ActionHandler/ZGWToZDSHandler.ActionHandler.json', + '$schema' => 'https://docs.commongateway.nl/schemas/ActionHandler.schema.json', + 'title' => 'ZGW Zaak to ZDS XmlEncode ActionHandler', + 'description' => 'ZGW Zaak to ZDS XmlEncode ActionHandler', + 'required' => [], + 'properties' => [], + ]; + + }//end getConfiguration() + + + /** + * This function runs the service. + * + * @param array $data The data from the call + * @param array $configuration The configuration of the action + * + * @return array + * + * @SuppressWarnings("unused") Handlers ara strict implementations + */ + public function run(array $data, array $configuration): array + { + + return $this->service->zgwToZdsXmlEncodeHandler($data, $configuration); + + }//end run() + + +}//end class diff --git a/src/Service/ZGWToZDSService.php b/src/Service/ZGWToZDSService.php index 2be65e4..50bb0ae 100644 --- a/src/Service/ZGWToZDSService.php +++ b/src/Service/ZGWToZDSService.php @@ -330,6 +330,22 @@ public function zgwToZdsInformationObjectHandler(array $data, array $configurati return $data; }//end zgwToZdsInformationObjectHandler() + + /** + * Does an xmlEncode on the response data. (temporary solution) + * + * @param array $data The data array. + * @param array $configuration The configuration array. + * + * @return array The updated data array. + */ + public function zgwToZdsXmlEncodeHandler(array $data, array $configuration): array + { +// $encoder = new XmlEncoder(['xml_root_node_name' => 'SOAP-ENV:Envelope']); +// $message = $encoder->encode($data['response'], 'xml'); + + return $data; + } }//end class From 00bee76791de791e79375a22d2f95fb7ae8caedf Mon Sep 17 00:00:00 2001 From: GitHub Actions <> Date: Thu, 15 Feb 2024 15:05:51 +0000 Subject: [PATCH 15/21] Update src from PHP Codesniffer --- src/Service/ZGWToZDSService.php | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/src/Service/ZGWToZDSService.php b/src/Service/ZGWToZDSService.php index 50bb0ae..6b631e2 100644 --- a/src/Service/ZGWToZDSService.php +++ b/src/Service/ZGWToZDSService.php @@ -330,22 +330,23 @@ public function zgwToZdsInformationObjectHandler(array $data, array $configurati return $data; }//end zgwToZdsInformationObjectHandler() - + + /** * Does an xmlEncode on the response data. (temporary solution) * - * @param array $data The data array. + * @param array $data The data array. * @param array $configuration The configuration array. * * @return array The updated data array. */ public function zgwToZdsXmlEncodeHandler(array $data, array $configuration): array { -// $encoder = new XmlEncoder(['xml_root_node_name' => 'SOAP-ENV:Envelope']); -// $message = $encoder->encode($data['response'], 'xml'); - + // $encoder = new XmlEncoder(['xml_root_node_name' => 'SOAP-ENV:Envelope']); + // $message = $encoder->encode($data['response'], 'xml'); return $data; - } + + }//end zgwToZdsXmlEncodeHandler() }//end class From 981c9d9a5bc5e01901f4dbec70c700b5babb2d15 Mon Sep 17 00:00:00 2001 From: Wilco Louwerse Date: Thu, 15 Feb 2024 16:11:46 +0100 Subject: [PATCH 16/21] Replace ns1 with Stuf in mapping --- .../Mapping/ZgwZaakToZdsResponse.json | 30 +++++++++---------- .../Mapping/ZgwZaakToZdsResponseItem.json | 4 +-- 2 files changed, 17 insertions(+), 17 deletions(-) diff --git a/Installation/Mapping/ZgwZaakToZdsResponse.json b/Installation/Mapping/ZgwZaakToZdsResponse.json index 781e2bf..46dba8d 100644 --- a/Installation/Mapping/ZgwZaakToZdsResponse.json +++ b/Installation/Mapping/ZgwZaakToZdsResponse.json @@ -5,23 +5,23 @@ "version": "0.0.1", "passTrough": false, "mapping": { - "SOAP-ENV:Body.ZKN:zakLa01.ZKN:stuurgegevens.ns1:berichtcode": "La01", - "SOAP-ENV:Body.ZKN:zakLa01.ZKN:stuurgegevens.ns1:zender.ns1:organisatie": "SIM", - "SOAP-ENV:Body.ZKN:zakLa01.ZKN:stuurgegevens.ns1:zender.ns1:applicatie": "SIMsite", - "SOAP-ENV:Body.ZKN:zakLa01.ZKN:stuurgegevens.ns1:zender.ns1:administratie": "", - "SOAP-ENV:Body.ZKN:zakLa01.ZKN:stuurgegevens.ns1:zender.ns1:gebruiker": "", - "SOAP-ENV:Body.ZKN:zakLa01.ZKN:stuurgegevens.ns1:ontvanger.ns1:organisatie": "1892", - "SOAP-ENV:Body.ZKN:zakLa01.ZKN:stuurgegevens.ns1:ontvanger.ns1:applicatie": "Liber", - "SOAP-ENV:Body.ZKN:zakLa01.ZKN:stuurgegevens.ns1:ontvanger.ns1:administratie": "", - "SOAP-ENV:Body.ZKN:zakLa01.ZKN:stuurgegevens.ns1:ontvanger.ns1:gebruiker": "", - "SOAP-ENV:Body.ZKN:zakLa01.ZKN:stuurgegevens.ns1:referentienummer": "identificatie", - "SOAP-ENV:Body.ZKN:zakLa01.ZKN:stuurgegevens.ns1:tijdstipBericht": "{{ 'now'|date('YmdHisv') }}", - "SOAP-ENV:Body.ZKN:zakLa01.ZKN:stuurgegevens.ns1:entiteittype": "ZAK", - "SOAP-ENV:Body.ZKN:zakLa01.ZKN:parameters.ns1:mutatiesoort": "T", - "SOAP-ENV:Body.ZKN:zakLa01.ZKN:parameters.ns1:indicatorOvername": "V", + "SOAP-ENV:Body.ZKN:zakLa01.ZKN:stuurgegevens.StUF:berichtcode": "La01", + "SOAP-ENV:Body.ZKN:zakLa01.ZKN:stuurgegevens.StUF:zender.StUF:organisatie": "SIM", + "SOAP-ENV:Body.ZKN:zakLa01.ZKN:stuurgegevens.StUF:zender.StUF:applicatie": "SIMsite", + "SOAP-ENV:Body.ZKN:zakLa01.ZKN:stuurgegevens.StUF:zender.StUF:administratie": "", + "SOAP-ENV:Body.ZKN:zakLa01.ZKN:stuurgegevens.StUF:zender.StUF:gebruiker": "", + "SOAP-ENV:Body.ZKN:zakLa01.ZKN:stuurgegevens.StUF:ontvanger.StUF:organisatie": "1892", + "SOAP-ENV:Body.ZKN:zakLa01.ZKN:stuurgegevens.StUF:ontvanger.StUF:applicatie": "Liber", + "SOAP-ENV:Body.ZKN:zakLa01.ZKN:stuurgegevens.StUF:ontvanger.StUF:administratie": "", + "SOAP-ENV:Body.ZKN:zakLa01.ZKN:stuurgegevens.StUF:ontvanger.StUF:gebruiker": "", + "SOAP-ENV:Body.ZKN:zakLa01.ZKN:stuurgegevens.StUF:referentienummer": "identificatie", + "SOAP-ENV:Body.ZKN:zakLa01.ZKN:stuurgegevens.StUF:tijdstipBericht": "{{ 'now'|date('YmdHisv') }}", + "SOAP-ENV:Body.ZKN:zakLa01.ZKN:stuurgegevens.StUF:entiteittype": "ZAK", + "SOAP-ENV:Body.ZKN:zakLa01.ZKN:parameters.StUF:mutatiesoort": "T", + "SOAP-ENV:Body.ZKN:zakLa01.ZKN:parameters.StUF:indicatorOvername": "V", "SOAP-ENV:Body.ZKN:zakLa01.ZKN:antwoord.ZKN:object": "{{ map(\"https://zds.nl/mapping/zds.ZgwZaakToZdsResponseItem.mapping.json\", results, true)|json_encode }}", "@xmlns:SOAP-ENV": "http://schemas.xmlsoap.org/soap/envelope/", - "@xmlns:ns1": "http://www.egem.nl/StUF/StUF0301", + "@xmlns:StUF": "http://www.egem.nl/StUF/StUF0301", "@xmlns:ZKN": "http://www.egem.nl/StUF/sector/zkn/0310", "@xmlns:ns3": "http://www.egem.nl/StUF/sector/bg/0310", "@xmlns:xsi": "http://www.w3.org/2001/XMLSchema-instance" diff --git a/Installation/Mapping/ZgwZaakToZdsResponseItem.json b/Installation/Mapping/ZgwZaakToZdsResponseItem.json index e116536..be33a0e 100644 --- a/Installation/Mapping/ZgwZaakToZdsResponseItem.json +++ b/Installation/Mapping/ZgwZaakToZdsResponseItem.json @@ -20,7 +20,7 @@ "ZKN:laatsteBetaaldatum": "laatsteBetaaldatum", "ZKN:zaakniveau": "1", "ZKN:deelzakenIndicatie": "N", - "ns1:extraElementen.ns1:extraElement": "[{% for eigenschap in eigenschappen %}{% if not loop.first %},{% endif %}{{ map('https://zds.nl/mapping/zds.ZgwEigenschapToZds.mapping.json', eigenschap)|json_encode }}{% endfor %}]", + "StUF:extraElementen.StUF:extraElement": "[{% for eigenschap in eigenschappen %}{% if not loop.first %},{% endif %}{{ map('https://zds.nl/mapping/zds.ZgwEigenschapToZds.mapping.json', eigenschap)|json_encode }}{% endfor %}]", "ZKN:isVan.@StUF:entiteittype": "ZAKZKT", "ZKN:isVan.@StUF:verwerkingssoort": "T", "ZKN:isVan.ZKN:gerelateerde.@StUF:entiteittype": "ZKT", @@ -31,7 +31,7 @@ "ZKN:heeftAlsInitiator": "{% if rollen.0 is defined %}{{ map(\"https://zds.nl/mapping/zds.ZgwZaakToZdsResponseItemInitiator.mapping.json\", rollen.0)|json_encode }}{% else %}\"\"{% endif %}" }, "cast": { - "ns1:extraElementen.ns1:extraElement": "jsonToArray", + "StUF:extraElementen.StUF:extraElement": "jsonToArray", "ZKN:heeftAlsInitiator": ["jsonToArray", "unsetIfValue=="] } } \ No newline at end of file From 306a926f72aa532cfd8de62a63a92b19b8cdb17d Mon Sep 17 00:00:00 2001 From: GitHub Actions <> Date: Thu, 15 Feb 2024 15:12:11 +0000 Subject: [PATCH 17/21] Update src from remark-lint --- docs/classes/README.md | 4 +- docs/classes/Service/InstallationService.md | 64 +++++-------------- docs/classes/Service/ZGWToZDSService.md | 69 ++++++--------------- 3 files changed, 36 insertions(+), 101 deletions(-) diff --git a/docs/classes/README.md b/docs/classes/README.md index c27427b..825467e 100644 --- a/docs/classes/README.md +++ b/docs/classes/README.md @@ -1,4 +1,4 @@ # CommonGateway\ZGWToZDSBundle -* [Service\InstallationService](Service/InstallationService.md) -* [Service\ZGWToZDSService](Service/ZGWToZDSService.md) +* [Service\InstallationService](Service/InstallationService.md) +* [Service\ZGWToZDSService](Service/ZGWToZDSService.md) diff --git a/docs/classes/Service/InstallationService.md b/docs/classes/Service/InstallationService.md index 9792b14..76ab28b 100644 --- a/docs/classes/Service/InstallationService.md +++ b/docs/classes/Service/InstallationService.md @@ -1,26 +1,20 @@ -# CommonGateway\ZGWToZDSBundle\Service\InstallationService - - +# CommonGateway\ZGWToZDSBundle\Service\InstallationService ## Implements: -CommonGateway\CoreBundle\Installer\InstallerInterface - +CommonGateway\CoreBundle\Installer\InstallerInterface ## Methods | Name | Description | |------|-------------| -|[__construct](#installationservice__construct)|The constructor| +|[\_\_construct](#installationservice__construct)|The constructor| |[checkDataConsistency](#installationservicecheckdataconsistency)|The actual code run on update and installation of this bundle| |[install](#installationserviceinstall)|Every installation service should implement an install function| |[uninstall](#installationserviceuninstall)|Every installation service should implement an uninstall function| |[update](#installationserviceupdate)|Every installation service should implement an update function| - - - -### InstallationService::__construct +### InstallationService::\_\_construct **Description** @@ -28,26 +22,22 @@ CommonGateway\CoreBundle\Installer\InstallerInterface public __construct (\EntityManagerInterface $entityManager, \LoggerInterface $installationLogger) ``` -The constructor - - +The constructor **Parameters** * `(\EntityManagerInterface) $entityManager` -: The entity manager. + : The entity manager. * `(\LoggerInterface) $installationLogger` -: The installation logger. + : The installation logger. **Return Values** `void` -
- -### InstallationService::checkDataConsistency +### InstallationService::checkDataConsistency **Description** @@ -55,9 +45,7 @@ The constructor public checkDataConsistency (void) ``` -The actual code run on update and installation of this bundle - - +The actual code run on update and installation of this bundle **Parameters** @@ -67,13 +55,9 @@ The actual code run on update and installation of this bundle `void` - - -
- -### InstallationService::install +### InstallationService::install **Description** @@ -81,9 +65,7 @@ The actual code run on update and installation of this bundle public install (void) ``` -Every installation service should implement an install function - - +Every installation service should implement an install function **Parameters** @@ -93,13 +75,9 @@ Every installation service should implement an install function `void` - - -
- -### InstallationService::uninstall +### InstallationService::uninstall **Description** @@ -107,9 +85,7 @@ Every installation service should implement an install function public uninstall (void) ``` -Every installation service should implement an uninstall function - - +Every installation service should implement an uninstall function **Parameters** @@ -119,13 +95,9 @@ Every installation service should implement an uninstall function `void` - - -
- -### InstallationService::update +### InstallationService::update **Description** @@ -133,9 +105,7 @@ Every installation service should implement an uninstall function public update (void) ``` -Every installation service should implement an update function - - +Every installation service should implement an update function **Parameters** @@ -145,8 +115,4 @@ Every installation service should implement an update function `void` - - -
- diff --git a/docs/classes/Service/ZGWToZDSService.md b/docs/classes/Service/ZGWToZDSService.md index 31fc0cd..8200989 100644 --- a/docs/classes/Service/ZGWToZDSService.md +++ b/docs/classes/Service/ZGWToZDSService.md @@ -1,25 +1,16 @@ -# CommonGateway\ZGWToZDSBundle\Service\ZGWToZDSService - - - - - - +# CommonGateway\ZGWToZDSBundle\Service\ZGWToZDSService ## Methods | Name | Description | |------|-------------| -|[__construct](#zgwtozdsservice__construct)|| +|[\_\_construct](#zgwtozdsservice__construct)|| |[zgwToZdsHandler](#zgwtozdsservicezgwtozdshandler)|An example handler that is triggered by an action.| |[zgwToZdsIdentificationHandler](#zgwtozdsservicezgwtozdsidentificationhandler)|Creates a ZDS Di02 call to the ZDS source, and takes the identification in the respons as case identifier| |[zgwToZdsInformationObjectHandler](#zgwtozdsservicezgwtozdsinformationobjecthandler)|Translate information objects to Lk01 messages and send them to a source.| |[zgwToZdsObjectIdentificationHandler](#zgwtozdsservicezgwtozdsobjectidentificationhandler)|Creates a ZDS Di02 call to the ZDS source, and takes the identification in the respons as case identifier| - - - -### ZGWToZDSService::__construct +### ZGWToZDSService::\_\_construct **Description** @@ -27,10 +18,6 @@ __construct (void) ``` - - - - **Parameters** `This function has no parameters.` @@ -39,11 +26,9 @@ `void` -
- -### ZGWToZDSService::zgwToZdsHandler +### ZGWToZDSService::zgwToZdsHandler **Description** @@ -51,16 +36,14 @@ public zgwToZdsHandler (array $data, array $configuration) ``` -An example handler that is triggered by an action. - - +An example handler that is triggered by an action. **Parameters** * `(array) $data` -: The data array + : The data array * `(array) $configuration` -: The configuration array + : The configuration array **Return Values** @@ -68,11 +51,9 @@ An example handler that is triggered by an action. > A handler must ALWAYS return an array -
- -### ZGWToZDSService::zgwToZdsIdentificationHandler +### ZGWToZDSService::zgwToZdsIdentificationHandler **Description** @@ -80,16 +61,14 @@ An example handler that is triggered by an action. public zgwToZdsIdentificationHandler (array $data, array $configuration) ``` -Creates a ZDS Di02 call to the ZDS source, and takes the identification in the respons as case identifier - - +Creates a ZDS Di02 call to the ZDS source, and takes the identification in the respons as case identifier **Parameters** * `(array) $data` -: The data from the response. + : The data from the response. * `(array) $configuration` -: The configuration for this action. + : The configuration for this action. **Return Values** @@ -97,11 +76,9 @@ Creates a ZDS Di02 call to the ZDS source, and takes the identification in the r > The resulting data array. -
- -### ZGWToZDSService::zgwToZdsInformationObjectHandler +### ZGWToZDSService::zgwToZdsInformationObjectHandler **Description** @@ -109,16 +86,14 @@ Creates a ZDS Di02 call to the ZDS source, and takes the identification in the r public zgwToZdsInformationObjectHandler (array $data, array $configuration) ``` -Translate information objects to Lk01 messages and send them to a source. - - +Translate information objects to Lk01 messages and send them to a source. **Parameters** * `(array) $data` -: The data array + : The data array * `(array) $configuration` -: The configuration array + : The configuration array **Return Values** @@ -126,11 +101,9 @@ Translate information objects to Lk01 messages and send them to a source. > The updated data array -
- -### ZGWToZDSService::zgwToZdsObjectIdentificationHandler +### ZGWToZDSService::zgwToZdsObjectIdentificationHandler **Description** @@ -138,16 +111,14 @@ Translate information objects to Lk01 messages and send them to a source. public zgwToZdsObjectIdentificationHandler (array $data, array $configuration) ``` -Creates a ZDS Di02 call to the ZDS source, and takes the identification in the respons as case identifier - - +Creates a ZDS Di02 call to the ZDS source, and takes the identification in the respons as case identifier **Parameters** * `(array) $data` -: The data from the response. + : The data from the response. * `(array) $configuration` -: The configuration for this action. + : The configuration for this action. **Return Values** @@ -155,6 +126,4 @@ Creates a ZDS Di02 call to the ZDS source, and takes the identification in the r > The resulting data array. -
- From 433abd715f91b14d8d5271b05d416cc43d903873 Mon Sep 17 00:00:00 2001 From: Wilco Louwerse Date: Thu, 15 Feb 2024 16:24:11 +0100 Subject: [PATCH 18/21] Fix action for xmlEncode --- src/Service/ZGWToZDSService.php | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/src/Service/ZGWToZDSService.php b/src/Service/ZGWToZDSService.php index 6b631e2..f63cf60 100644 --- a/src/Service/ZGWToZDSService.php +++ b/src/Service/ZGWToZDSService.php @@ -342,10 +342,16 @@ public function zgwToZdsInformationObjectHandler(array $data, array $configurati */ public function zgwToZdsXmlEncodeHandler(array $data, array $configuration): array { - // $encoder = new XmlEncoder(['xml_root_node_name' => 'SOAP-ENV:Envelope']); - // $message = $encoder->encode($data['response'], 'xml'); + $response = $data['response']; + $responseBody = json_decode($response->getContent(), true); + + $encoder = new XmlEncoder(['xml_root_node_name' => 'SOAP-ENV:Envelope']); + $responseBody = $encoder->encode($responseBody, 'xml'); + + $data['response'] = new Response($responseBody, $response->getStatusCode(), ['content-type' => 'text/xml']); + return $data; - + }//end zgwToZdsXmlEncodeHandler() From 8703f02e809aff13da6cb7db102f6701b2ed4363 Mon Sep 17 00:00:00 2001 From: GitHub Actions <> Date: Thu, 15 Feb 2024 15:24:44 +0000 Subject: [PATCH 19/21] Update src from PHP Codesniffer --- src/Service/ZGWToZDSService.php | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/src/Service/ZGWToZDSService.php b/src/Service/ZGWToZDSService.php index f63cf60..b99e03b 100644 --- a/src/Service/ZGWToZDSService.php +++ b/src/Service/ZGWToZDSService.php @@ -342,16 +342,16 @@ public function zgwToZdsInformationObjectHandler(array $data, array $configurati */ public function zgwToZdsXmlEncodeHandler(array $data, array $configuration): array { - $response = $data['response']; + $response = $data['response']; $responseBody = json_decode($response->getContent(), true); - - $encoder = new XmlEncoder(['xml_root_node_name' => 'SOAP-ENV:Envelope']); + + $encoder = new XmlEncoder(['xml_root_node_name' => 'SOAP-ENV:Envelope']); $responseBody = $encoder->encode($responseBody, 'xml'); - + $data['response'] = new Response($responseBody, $response->getStatusCode(), ['content-type' => 'text/xml']); - + return $data; - + }//end zgwToZdsXmlEncodeHandler() From 0047dcc57184f4cc5a041a89b951ce7966197c38 Mon Sep 17 00:00:00 2001 From: Robert Zondervan Date: Fri, 16 Feb 2024 09:07:39 +0100 Subject: [PATCH 20/21] Add schema definition --- Installation/Mapping/ZdsLv01ToZgwGeoSearch.mapping.json | 1 + 1 file changed, 1 insertion(+) diff --git a/Installation/Mapping/ZdsLv01ToZgwGeoSearch.mapping.json b/Installation/Mapping/ZdsLv01ToZgwGeoSearch.mapping.json index a381710..9ff5865 100644 --- a/Installation/Mapping/ZdsLv01ToZgwGeoSearch.mapping.json +++ b/Installation/Mapping/ZdsLv01ToZgwGeoSearch.mapping.json @@ -1,5 +1,6 @@ { "$id": "https://zds.vng.nl/mappings/zdsLv01ToZGWGeoSearch.mapping.json", + "$schema": "https://docs.commongateway.nl/schemas/Mapping.schema.json", "version": "0.0.1", "title": "ZDS Lv01 to ZGW GeoSearch", "description": "", From cfeaae2e78be0c8e7770346c0f590ef74ca11efb Mon Sep 17 00:00:00 2001 From: GitHub Actions <> Date: Fri, 16 Feb 2024 08:08:54 +0000 Subject: [PATCH 21/21] Update phpdoc --- docs/classes/README.md | 4 +- docs/classes/Service/InstallationService.md | 64 +++++++++---- docs/classes/Service/ZGWToZDSService.md | 99 +++++++++++++++++---- 3 files changed, 131 insertions(+), 36 deletions(-) diff --git a/docs/classes/README.md b/docs/classes/README.md index 825467e..c27427b 100644 --- a/docs/classes/README.md +++ b/docs/classes/README.md @@ -1,4 +1,4 @@ # CommonGateway\ZGWToZDSBundle -* [Service\InstallationService](Service/InstallationService.md) -* [Service\ZGWToZDSService](Service/ZGWToZDSService.md) +* [Service\InstallationService](Service/InstallationService.md) +* [Service\ZGWToZDSService](Service/ZGWToZDSService.md) diff --git a/docs/classes/Service/InstallationService.md b/docs/classes/Service/InstallationService.md index 76ab28b..9792b14 100644 --- a/docs/classes/Service/InstallationService.md +++ b/docs/classes/Service/InstallationService.md @@ -1,20 +1,26 @@ -# CommonGateway\ZGWToZDSBundle\Service\InstallationService +# CommonGateway\ZGWToZDSBundle\Service\InstallationService + -## Implements: +## Implements: CommonGateway\CoreBundle\Installer\InstallerInterface + + ## Methods | Name | Description | |------|-------------| -|[\_\_construct](#installationservice__construct)|The constructor| +|[__construct](#installationservice__construct)|The constructor| |[checkDataConsistency](#installationservicecheckdataconsistency)|The actual code run on update and installation of this bundle| |[install](#installationserviceinstall)|Every installation service should implement an install function| |[uninstall](#installationserviceuninstall)|Every installation service should implement an uninstall function| |[update](#installationserviceupdate)|Every installation service should implement an update function| -### InstallationService::\_\_construct + + + +### InstallationService::__construct **Description** @@ -22,22 +28,26 @@ CommonGateway\CoreBundle\Installer\InstallerInterface public __construct (\EntityManagerInterface $entityManager, \LoggerInterface $installationLogger) ``` -The constructor +The constructor + + **Parameters** * `(\EntityManagerInterface) $entityManager` - : The entity manager. +: The entity manager. * `(\LoggerInterface) $installationLogger` - : The installation logger. +: The installation logger. **Return Values** `void` +
-### InstallationService::checkDataConsistency + +### InstallationService::checkDataConsistency **Description** @@ -45,7 +55,9 @@ The constructor public checkDataConsistency (void) ``` -The actual code run on update and installation of this bundle +The actual code run on update and installation of this bundle + + **Parameters** @@ -55,9 +67,13 @@ The actual code run on update and installation of this bundle `void` + + +
-### InstallationService::install + +### InstallationService::install **Description** @@ -65,7 +81,9 @@ The actual code run on update and installation of this bundle public install (void) ``` -Every installation service should implement an install function +Every installation service should implement an install function + + **Parameters** @@ -75,9 +93,13 @@ Every installation service should implement an install function `void` + + +
-### InstallationService::uninstall + +### InstallationService::uninstall **Description** @@ -85,7 +107,9 @@ Every installation service should implement an install function public uninstall (void) ``` -Every installation service should implement an uninstall function +Every installation service should implement an uninstall function + + **Parameters** @@ -95,9 +119,13 @@ Every installation service should implement an uninstall function `void` + + +
-### InstallationService::update + +### InstallationService::update **Description** @@ -105,7 +133,9 @@ Every installation service should implement an uninstall function public update (void) ``` -Every installation service should implement an update function +Every installation service should implement an update function + + **Parameters** @@ -115,4 +145,8 @@ Every installation service should implement an update function `void` + + +
+ diff --git a/docs/classes/Service/ZGWToZDSService.md b/docs/classes/Service/ZGWToZDSService.md index 8200989..c293a4c 100644 --- a/docs/classes/Service/ZGWToZDSService.md +++ b/docs/classes/Service/ZGWToZDSService.md @@ -1,16 +1,26 @@ -# CommonGateway\ZGWToZDSBundle\Service\ZGWToZDSService +# CommonGateway\ZGWToZDSBundle\Service\ZGWToZDSService + + + + + + ## Methods | Name | Description | |------|-------------| -|[\_\_construct](#zgwtozdsservice__construct)|| +|[__construct](#zgwtozdsservice__construct)|| |[zgwToZdsHandler](#zgwtozdsservicezgwtozdshandler)|An example handler that is triggered by an action.| |[zgwToZdsIdentificationHandler](#zgwtozdsservicezgwtozdsidentificationhandler)|Creates a ZDS Di02 call to the ZDS source, and takes the identification in the respons as case identifier| |[zgwToZdsInformationObjectHandler](#zgwtozdsservicezgwtozdsinformationobjecthandler)|Translate information objects to Lk01 messages and send them to a source.| |[zgwToZdsObjectIdentificationHandler](#zgwtozdsservicezgwtozdsobjectidentificationhandler)|Creates a ZDS Di02 call to the ZDS source, and takes the identification in the respons as case identifier| +|[zgwToZdsXmlEncodeHandler](#zgwtozdsservicezgwtozdsxmlencodehandler)|Does an xmlEncode on the response data. (temporary solution)| -### ZGWToZDSService::\_\_construct + + + +### ZGWToZDSService::__construct **Description** @@ -18,6 +28,10 @@ __construct (void) ``` + + + + **Parameters** `This function has no parameters.` @@ -26,9 +40,11 @@ `void` +
-### ZGWToZDSService::zgwToZdsHandler + +### ZGWToZDSService::zgwToZdsHandler **Description** @@ -36,14 +52,16 @@ public zgwToZdsHandler (array $data, array $configuration) ``` -An example handler that is triggered by an action. +An example handler that is triggered by an action. + + **Parameters** * `(array) $data` - : The data array +: The data array * `(array) $configuration` - : The configuration array +: The configuration array **Return Values** @@ -51,9 +69,11 @@ An example handler that is triggered by an action. > A handler must ALWAYS return an array +
-### ZGWToZDSService::zgwToZdsIdentificationHandler + +### ZGWToZDSService::zgwToZdsIdentificationHandler **Description** @@ -61,14 +81,16 @@ An example handler that is triggered by an action. public zgwToZdsIdentificationHandler (array $data, array $configuration) ``` -Creates a ZDS Di02 call to the ZDS source, and takes the identification in the respons as case identifier +Creates a ZDS Di02 call to the ZDS source, and takes the identification in the respons as case identifier + + **Parameters** * `(array) $data` - : The data from the response. +: The data from the response. * `(array) $configuration` - : The configuration for this action. +: The configuration for this action. **Return Values** @@ -76,9 +98,11 @@ Creates a ZDS Di02 call to the ZDS source, and takes the identification in the r > The resulting data array. +
-### ZGWToZDSService::zgwToZdsInformationObjectHandler + +### ZGWToZDSService::zgwToZdsInformationObjectHandler **Description** @@ -86,14 +110,16 @@ Creates a ZDS Di02 call to the ZDS source, and takes the identification in the r public zgwToZdsInformationObjectHandler (array $data, array $configuration) ``` -Translate information objects to Lk01 messages and send them to a source. +Translate information objects to Lk01 messages and send them to a source. + + **Parameters** * `(array) $data` - : The data array +: The data array * `(array) $configuration` - : The configuration array +: The configuration array **Return Values** @@ -101,9 +127,11 @@ Translate information objects to Lk01 messages and send them to a source. > The updated data array +
-### ZGWToZDSService::zgwToZdsObjectIdentificationHandler + +### ZGWToZDSService::zgwToZdsObjectIdentificationHandler **Description** @@ -111,14 +139,16 @@ Translate information objects to Lk01 messages and send them to a source. public zgwToZdsObjectIdentificationHandler (array $data, array $configuration) ``` -Creates a ZDS Di02 call to the ZDS source, and takes the identification in the respons as case identifier +Creates a ZDS Di02 call to the ZDS source, and takes the identification in the respons as case identifier + + **Parameters** * `(array) $data` - : The data from the response. +: The data from the response. * `(array) $configuration` - : The configuration for this action. +: The configuration for this action. **Return Values** @@ -126,4 +156,35 @@ Creates a ZDS Di02 call to the ZDS source, and takes the identification in the r > The resulting data array. +
+ + +### ZGWToZDSService::zgwToZdsXmlEncodeHandler + +**Description** + +```php +public zgwToZdsXmlEncodeHandler (array $data, array $configuration) +``` + +Does an xmlEncode on the response data. (temporary solution) + + + +**Parameters** + +* `(array) $data` +: The data array. +* `(array) $configuration` +: The configuration array. + +**Return Values** + +`array` + +> The updated data array. + + +
+