From 1461569614e59258a2f7127faeec5a0ebee08c81 Mon Sep 17 00:00:00 2001 From: Wilco Louwerse Date: Tue, 2 Jul 2024 12:28:01 +0200 Subject: [PATCH 1/6] We no longer need to give $search parameter to searchobjects --- src/Service/FirstRegistrationService.php | 4 ++-- src/Service/ZGWDocumentToFileService.php | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/src/Service/FirstRegistrationService.php b/src/Service/FirstRegistrationService.php index 677307c..9c903cc 100644 --- a/src/Service/FirstRegistrationService.php +++ b/src/Service/FirstRegistrationService.php @@ -268,7 +268,7 @@ public function zgwToFirstRegistrationHandler(array $data, array $configuration) $identification = $this->data['body']['SOAP-ENV:Body']['ns2:edcLk01']['ns2:object']['ns2:isRelevantVoor']['ns2:gerelateerde']['ns2:identificatie']; // Search zaak objects with the identification. - $zaken = $this->cacheService->searchObjects(null, ['identificatie' => $identification], [$schema->getId()->toString()])['results']; + $zaken = $this->cacheService->searchObjects(['identificatie' => $identification], [$schema->getId()->toString()])['results']; // Create error response if the document is not empty and if there is more then one result. if (empty($zaken) === false && count($zaken) > 1) { @@ -313,7 +313,7 @@ public function zgwToFirstRegistrationHandler(array $data, array $configuration) // Loop through the $documents = []; - $zaakInformatieObjecten = $this->cacheService->searchObjects(null, ['embedded.zaak.identificatie' => $identification], ['https://vng.opencatalogi.nl/schemas/zrc.zaakInformatieObject.schema.json'])['results']; + $zaakInformatieObjecten = $this->cacheService->searchObjects(['embedded.zaak.identificatie' => $identification], ['https://vng.opencatalogi.nl/schemas/zrc.zaakInformatieObject.schema.json'])['results']; foreach ($zaakInformatieObjecten as $zaakInfoArray) { $zaakInfoObject = $this->entityManager->getRepository(ObjectEntity::class)->find($zaakInfoArray['_id']); diff --git a/src/Service/ZGWDocumentToFileService.php b/src/Service/ZGWDocumentToFileService.php index c586058..35a35f9 100644 --- a/src/Service/ZGWDocumentToFileService.php +++ b/src/Service/ZGWDocumentToFileService.php @@ -352,7 +352,7 @@ public function zgwDocumentToFileHandler(array $data, array $configuration): arr $identification = $this->data['body']['SOAP-ENV:Body']['ns2:edcLk01']['ns2:object']['ns2:identificatie']; // Search enkelvoudiginformatieobject objects with the identificatie in informatieobject identificatie. - $documenten = $this->cacheService->searchObjects(null, ['identificatie' => $identification], [$schema->getId()->toString()])['results']; + $documenten = $this->cacheService->searchObjects(['identificatie' => $identification], [$schema->getId()->toString()])['results']; // Create error response if the document is not empty and if there is more then one result. if (empty($documenten) === false && count($documenten) > 1) { From d8b6d6122be860149c958000e5a53c40651cc6cb Mon Sep 17 00:00:00 2001 From: GitHub Actions <> Date: Tue, 2 Jul 2024 10:29:24 +0000 Subject: [PATCH 2/6] Update phpdoc --- docs/classes/README.md | 4 +- .../Service/FirstRegistrationService.md | 99 +++++++++++++------ docs/classes/Service/InstallationService.md | 64 +++++++++--- 3 files changed, 122 insertions(+), 45 deletions(-) diff --git a/docs/classes/README.md b/docs/classes/README.md index 6094f0f..5ae3038 100644 --- a/docs/classes/README.md +++ b/docs/classes/README.md @@ -1,4 +1,4 @@ # CommonGateway\FirstRegistrationBundle -* [Service\InstallationService](Service/InstallationService.md) -* [Service\FirstRegistrationService](Service/FirstRegistrationService.md) +* [Service\InstallationService](Service/InstallationService.md) +* [Service\FirstRegistrationService](Service/FirstRegistrationService.md) diff --git a/docs/classes/Service/FirstRegistrationService.md b/docs/classes/Service/FirstRegistrationService.md index 8754ca3..6b672d8 100644 --- a/docs/classes/Service/FirstRegistrationService.md +++ b/docs/classes/Service/FirstRegistrationService.md @@ -1,10 +1,16 @@ -# CommonGateway\FirstRegistrationBundle\Service\FirstRegistrationService +# CommonGateway\FirstRegistrationBundle\Service\FirstRegistrationService + + + + + + ## Methods | Name | Description | |------|-------------| -|[\_\_construct](#firstregistrationservice__construct)|| +|[__construct](#firstregistrationservice__construct)|| |[firstRegistrationHandler](#firstregistrationservicefirstregistrationhandler)|A first registration handler that is triggered by an action.| |[getRolValues](#firstregistrationservicegetrolvalues)|Gets the values from the zaakEigenschappen of the zaak.| |[getZaakEigenschappenValues](#firstregistrationservicegetzaakeigenschappenvalues)|Gets the values from the zaakEigenschappen of the zaak.| @@ -13,7 +19,10 @@ |[sendFirstRegistration](#firstregistrationservicesendfirstregistration)|A first registration handler that is triggered by an action.| |[zgwToFirstRegistrationHandler](#firstregistrationservicezgwtofirstregistrationhandler)|A first registration handler that is triggered by an action.| -### FirstRegistrationService::\_\_construct + + + +### FirstRegistrationService::__construct **Description** @@ -21,6 +30,10 @@ __construct (void) ``` + + + + **Parameters** `This function has no parameters.` @@ -29,9 +42,11 @@ `void` +
-### FirstRegistrationService::firstRegistrationHandler + +### FirstRegistrationService::firstRegistrationHandler **Description** @@ -39,14 +54,16 @@ public firstRegistrationHandler (array $data, array $configuration) ``` -A first registration handler that is triggered by an action. +A first registration 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** @@ -54,9 +71,11 @@ A first registration handler that is triggered by an action. > A handler must ALWAYS return an array +
-### FirstRegistrationService::getRolValues + +### FirstRegistrationService::getRolValues **Description** @@ -64,14 +83,16 @@ A first registration handler that is triggered by an action. public getRolValues (\ObjectEntity $zaaktypeObject, \ObjectEntity $zaakObject) ``` -Gets the values from the zaakEigenschappen of the zaak. +Gets the values from the zaakEigenschappen of the zaak. + + **Parameters** * `(\ObjectEntity) $zaaktypeObject` - : The zaaktype object of the zaak. +: The zaaktype object of the zaak. * `(\ObjectEntity) $zaakObject` - : The zaak object. +: The zaak object. **Return Values** @@ -79,9 +100,11 @@ Gets the values from the zaakEigenschappen of the zaak. > The values of the zaakEigenschappen. +
-### FirstRegistrationService::getZaakEigenschappenValues + +### FirstRegistrationService::getZaakEigenschappenValues **Description** @@ -89,14 +112,16 @@ Gets the values from the zaakEigenschappen of the zaak. public getZaakEigenschappenValues (\ObjectEntity $zaaktypeObject, \ObjectEntity $zaakObject) ``` -Gets the values from the zaakEigenschappen of the zaak. +Gets the values from the zaakEigenschappen of the zaak. + + **Parameters** * `(\ObjectEntity) $zaaktypeObject` - : The zaaktype object of the zaak. +: The zaaktype object of the zaak. * `(\ObjectEntity) $zaakObject` - : The zaak object. +: The zaak object. **Return Values** @@ -104,9 +129,11 @@ Gets the values from the zaakEigenschappen of the zaak. > The values of the zaakEigenschappen. +
-### FirstRegistrationService::getZaaktype + +### FirstRegistrationService::getZaaktype **Description** @@ -114,7 +141,9 @@ Gets the values from the zaakEigenschappen of the zaak. public getZaaktype (void) ``` -Gets the zaaktype object from the zaak. +Gets the zaaktype object from the zaak. + + **Parameters** @@ -126,9 +155,11 @@ Gets the zaaktype object from the zaak. > The zaaktype from the zaak. +
-### FirstRegistrationService::removeSelf + +### FirstRegistrationService::removeSelf **Description** @@ -136,12 +167,14 @@ Gets the zaaktype object from the zaak. public removeSelf (array $object) ``` -Recursively removes self parameters from object. +Recursively removes self parameters from object. + + **Parameters** * `(array) $object` - : The object to remove self parameters from. +: The object to remove self parameters from. **Return Values** @@ -149,9 +182,11 @@ Recursively removes self parameters from object. > The cleaned object. +
-### FirstRegistrationService::sendFirstRegistration + +### FirstRegistrationService::sendFirstRegistration **Description** @@ -159,14 +194,16 @@ Recursively removes self parameters from object. public sendFirstRegistration (array $data, array $configuration) ``` -A first registration handler that is triggered by an action. +A first registration 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** @@ -174,9 +211,11 @@ A first registration handler that is triggered by an action. > A handler must ALWAYS return an array +
-### FirstRegistrationService::zgwToFirstRegistrationHandler + +### FirstRegistrationService::zgwToFirstRegistrationHandler **Description** @@ -184,14 +223,16 @@ A first registration handler that is triggered by an action. public zgwToFirstRegistrationHandler (array $data, array $configuration) ``` -A first registration handler that is triggered by an action. +A first registration 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** @@ -199,4 +240,6 @@ A first registration handler that is triggered by an action. > A handler must ALWAYS return an array +
+ diff --git a/docs/classes/Service/InstallationService.md b/docs/classes/Service/InstallationService.md index d72c04f..8d3a2bc 100644 --- a/docs/classes/Service/InstallationService.md +++ b/docs/classes/Service/InstallationService.md @@ -1,20 +1,26 @@ -# CommonGateway\FirstRegistrationBundle\Service\InstallationService +# CommonGateway\FirstRegistrationBundle\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` + + +
+ From dd1e3b64a1359443ff11a77cbc5ee13d4f4ca713 Mon Sep 17 00:00:00 2001 From: Wilco Louwerse Date: Tue, 2 Jul 2024 12:31:14 +0200 Subject: [PATCH 3/6] We need CoreBundle 1.4.13 or higher for this --- composer.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/composer.json b/composer.json index d7d1306..7f63f0e 100644 --- a/composer.json +++ b/composer.json @@ -17,7 +17,7 @@ "minimum-stability": "dev", "require": { "php": ">=7.4", - "commongateway/corebundle": "^1.1.110 | <2.0" + "commongateway/corebundle": "^1.4.13 | <2.0" }, "require-dev": { "symfony/dependency-injection": "~3.4|~4.1|~5.0" From a4c9f2ac649342fbf9545589a8ffa4684b97793b Mon Sep 17 00:00:00 2001 From: GitHub Actions <> Date: Tue, 2 Jul 2024 10:31:38 +0000 Subject: [PATCH 4/6] Update src from remark-lint --- docs/classes/README.md | 4 +- .../Service/FirstRegistrationService.md | 99 ++++++------------- docs/classes/Service/InstallationService.md | 64 +++--------- 3 files changed, 45 insertions(+), 122 deletions(-) diff --git a/docs/classes/README.md b/docs/classes/README.md index 5ae3038..6094f0f 100644 --- a/docs/classes/README.md +++ b/docs/classes/README.md @@ -1,4 +1,4 @@ # CommonGateway\FirstRegistrationBundle -* [Service\InstallationService](Service/InstallationService.md) -* [Service\FirstRegistrationService](Service/FirstRegistrationService.md) +* [Service\InstallationService](Service/InstallationService.md) +* [Service\FirstRegistrationService](Service/FirstRegistrationService.md) diff --git a/docs/classes/Service/FirstRegistrationService.md b/docs/classes/Service/FirstRegistrationService.md index 6b672d8..8754ca3 100644 --- a/docs/classes/Service/FirstRegistrationService.md +++ b/docs/classes/Service/FirstRegistrationService.md @@ -1,16 +1,10 @@ -# CommonGateway\FirstRegistrationBundle\Service\FirstRegistrationService - - - - - - +# CommonGateway\FirstRegistrationBundle\Service\FirstRegistrationService ## Methods | Name | Description | |------|-------------| -|[__construct](#firstregistrationservice__construct)|| +|[\_\_construct](#firstregistrationservice__construct)|| |[firstRegistrationHandler](#firstregistrationservicefirstregistrationhandler)|A first registration handler that is triggered by an action.| |[getRolValues](#firstregistrationservicegetrolvalues)|Gets the values from the zaakEigenschappen of the zaak.| |[getZaakEigenschappenValues](#firstregistrationservicegetzaakeigenschappenvalues)|Gets the values from the zaakEigenschappen of the zaak.| @@ -19,10 +13,7 @@ |[sendFirstRegistration](#firstregistrationservicesendfirstregistration)|A first registration handler that is triggered by an action.| |[zgwToFirstRegistrationHandler](#firstregistrationservicezgwtofirstregistrationhandler)|A first registration handler that is triggered by an action.| - - - -### FirstRegistrationService::__construct +### FirstRegistrationService::\_\_construct **Description** @@ -30,10 +21,6 @@ __construct (void) ``` - - - - **Parameters** `This function has no parameters.` @@ -42,11 +29,9 @@ `void` -
- -### FirstRegistrationService::firstRegistrationHandler +### FirstRegistrationService::firstRegistrationHandler **Description** @@ -54,16 +39,14 @@ public firstRegistrationHandler (array $data, array $configuration) ``` -A first registration handler that is triggered by an action. - - +A first registration 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** @@ -71,11 +54,9 @@ A first registration handler that is triggered by an action. > A handler must ALWAYS return an array -
- -### FirstRegistrationService::getRolValues +### FirstRegistrationService::getRolValues **Description** @@ -83,16 +64,14 @@ A first registration handler that is triggered by an action. public getRolValues (\ObjectEntity $zaaktypeObject, \ObjectEntity $zaakObject) ``` -Gets the values from the zaakEigenschappen of the zaak. - - +Gets the values from the zaakEigenschappen of the zaak. **Parameters** * `(\ObjectEntity) $zaaktypeObject` -: The zaaktype object of the zaak. + : The zaaktype object of the zaak. * `(\ObjectEntity) $zaakObject` -: The zaak object. + : The zaak object. **Return Values** @@ -100,11 +79,9 @@ Gets the values from the zaakEigenschappen of the zaak. > The values of the zaakEigenschappen. -
- -### FirstRegistrationService::getZaakEigenschappenValues +### FirstRegistrationService::getZaakEigenschappenValues **Description** @@ -112,16 +89,14 @@ Gets the values from the zaakEigenschappen of the zaak. public getZaakEigenschappenValues (\ObjectEntity $zaaktypeObject, \ObjectEntity $zaakObject) ``` -Gets the values from the zaakEigenschappen of the zaak. - - +Gets the values from the zaakEigenschappen of the zaak. **Parameters** * `(\ObjectEntity) $zaaktypeObject` -: The zaaktype object of the zaak. + : The zaaktype object of the zaak. * `(\ObjectEntity) $zaakObject` -: The zaak object. + : The zaak object. **Return Values** @@ -129,11 +104,9 @@ Gets the values from the zaakEigenschappen of the zaak. > The values of the zaakEigenschappen. -
- -### FirstRegistrationService::getZaaktype +### FirstRegistrationService::getZaaktype **Description** @@ -141,9 +114,7 @@ Gets the values from the zaakEigenschappen of the zaak. public getZaaktype (void) ``` -Gets the zaaktype object from the zaak. - - +Gets the zaaktype object from the zaak. **Parameters** @@ -155,11 +126,9 @@ Gets the zaaktype object from the zaak. > The zaaktype from the zaak. -
- -### FirstRegistrationService::removeSelf +### FirstRegistrationService::removeSelf **Description** @@ -167,14 +136,12 @@ Gets the zaaktype object from the zaak. public removeSelf (array $object) ``` -Recursively removes self parameters from object. - - +Recursively removes self parameters from object. **Parameters** * `(array) $object` -: The object to remove self parameters from. + : The object to remove self parameters from. **Return Values** @@ -182,11 +149,9 @@ Recursively removes self parameters from object. > The cleaned object. -
- -### FirstRegistrationService::sendFirstRegistration +### FirstRegistrationService::sendFirstRegistration **Description** @@ -194,16 +159,14 @@ Recursively removes self parameters from object. public sendFirstRegistration (array $data, array $configuration) ``` -A first registration handler that is triggered by an action. - - +A first registration 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** @@ -211,11 +174,9 @@ A first registration handler that is triggered by an action. > A handler must ALWAYS return an array -
- -### FirstRegistrationService::zgwToFirstRegistrationHandler +### FirstRegistrationService::zgwToFirstRegistrationHandler **Description** @@ -223,16 +184,14 @@ A first registration handler that is triggered by an action. public zgwToFirstRegistrationHandler (array $data, array $configuration) ``` -A first registration handler that is triggered by an action. - - +A first registration 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** @@ -240,6 +199,4 @@ A first registration handler that is triggered by an action. > A handler must ALWAYS return an array -
- diff --git a/docs/classes/Service/InstallationService.md b/docs/classes/Service/InstallationService.md index 8d3a2bc..d72c04f 100644 --- a/docs/classes/Service/InstallationService.md +++ b/docs/classes/Service/InstallationService.md @@ -1,26 +1,20 @@ -# CommonGateway\FirstRegistrationBundle\Service\InstallationService - - +# CommonGateway\FirstRegistrationBundle\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` - - -
- From d504a00c511bf724f843359558a83e97bd032ea7 Mon Sep 17 00:00:00 2001 From: Wilco Louwerse Date: Tue, 2 Jul 2024 12:32:50 +0200 Subject: [PATCH 5/6] also update publiccode.yaml --- publiccode.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/publiccode.yaml b/publiccode.yaml index 69665e4..de8d63a 100644 --- a/publiccode.yaml +++ b/publiccode.yaml @@ -77,9 +77,9 @@ dependsOn: version: 1.2.47 optional: false - name: CoreBundle - versionMin: 1.2 - versionMax: 1.3 - version: 1.2.47 + versionMin: 1.4 + versionMax: 1.5 + version: 1.4.13 optional: false roadmap: null inputTypes: From 56605ba7578d315f70dcbad7848e0d3a516ae193 Mon Sep 17 00:00:00 2001 From: GitHub Actions <> Date: Tue, 2 Jul 2024 10:34:03 +0000 Subject: [PATCH 6/6] Update phpdoc --- docs/classes/README.md | 4 +- .../Service/FirstRegistrationService.md | 99 +++++++++++++------ docs/classes/Service/InstallationService.md | 64 +++++++++--- 3 files changed, 122 insertions(+), 45 deletions(-) diff --git a/docs/classes/README.md b/docs/classes/README.md index 6094f0f..5ae3038 100644 --- a/docs/classes/README.md +++ b/docs/classes/README.md @@ -1,4 +1,4 @@ # CommonGateway\FirstRegistrationBundle -* [Service\InstallationService](Service/InstallationService.md) -* [Service\FirstRegistrationService](Service/FirstRegistrationService.md) +* [Service\InstallationService](Service/InstallationService.md) +* [Service\FirstRegistrationService](Service/FirstRegistrationService.md) diff --git a/docs/classes/Service/FirstRegistrationService.md b/docs/classes/Service/FirstRegistrationService.md index 8754ca3..6b672d8 100644 --- a/docs/classes/Service/FirstRegistrationService.md +++ b/docs/classes/Service/FirstRegistrationService.md @@ -1,10 +1,16 @@ -# CommonGateway\FirstRegistrationBundle\Service\FirstRegistrationService +# CommonGateway\FirstRegistrationBundle\Service\FirstRegistrationService + + + + + + ## Methods | Name | Description | |------|-------------| -|[\_\_construct](#firstregistrationservice__construct)|| +|[__construct](#firstregistrationservice__construct)|| |[firstRegistrationHandler](#firstregistrationservicefirstregistrationhandler)|A first registration handler that is triggered by an action.| |[getRolValues](#firstregistrationservicegetrolvalues)|Gets the values from the zaakEigenschappen of the zaak.| |[getZaakEigenschappenValues](#firstregistrationservicegetzaakeigenschappenvalues)|Gets the values from the zaakEigenschappen of the zaak.| @@ -13,7 +19,10 @@ |[sendFirstRegistration](#firstregistrationservicesendfirstregistration)|A first registration handler that is triggered by an action.| |[zgwToFirstRegistrationHandler](#firstregistrationservicezgwtofirstregistrationhandler)|A first registration handler that is triggered by an action.| -### FirstRegistrationService::\_\_construct + + + +### FirstRegistrationService::__construct **Description** @@ -21,6 +30,10 @@ __construct (void) ``` + + + + **Parameters** `This function has no parameters.` @@ -29,9 +42,11 @@ `void` +
-### FirstRegistrationService::firstRegistrationHandler + +### FirstRegistrationService::firstRegistrationHandler **Description** @@ -39,14 +54,16 @@ public firstRegistrationHandler (array $data, array $configuration) ``` -A first registration handler that is triggered by an action. +A first registration 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** @@ -54,9 +71,11 @@ A first registration handler that is triggered by an action. > A handler must ALWAYS return an array +
-### FirstRegistrationService::getRolValues + +### FirstRegistrationService::getRolValues **Description** @@ -64,14 +83,16 @@ A first registration handler that is triggered by an action. public getRolValues (\ObjectEntity $zaaktypeObject, \ObjectEntity $zaakObject) ``` -Gets the values from the zaakEigenschappen of the zaak. +Gets the values from the zaakEigenschappen of the zaak. + + **Parameters** * `(\ObjectEntity) $zaaktypeObject` - : The zaaktype object of the zaak. +: The zaaktype object of the zaak. * `(\ObjectEntity) $zaakObject` - : The zaak object. +: The zaak object. **Return Values** @@ -79,9 +100,11 @@ Gets the values from the zaakEigenschappen of the zaak. > The values of the zaakEigenschappen. +
-### FirstRegistrationService::getZaakEigenschappenValues + +### FirstRegistrationService::getZaakEigenschappenValues **Description** @@ -89,14 +112,16 @@ Gets the values from the zaakEigenschappen of the zaak. public getZaakEigenschappenValues (\ObjectEntity $zaaktypeObject, \ObjectEntity $zaakObject) ``` -Gets the values from the zaakEigenschappen of the zaak. +Gets the values from the zaakEigenschappen of the zaak. + + **Parameters** * `(\ObjectEntity) $zaaktypeObject` - : The zaaktype object of the zaak. +: The zaaktype object of the zaak. * `(\ObjectEntity) $zaakObject` - : The zaak object. +: The zaak object. **Return Values** @@ -104,9 +129,11 @@ Gets the values from the zaakEigenschappen of the zaak. > The values of the zaakEigenschappen. +
-### FirstRegistrationService::getZaaktype + +### FirstRegistrationService::getZaaktype **Description** @@ -114,7 +141,9 @@ Gets the values from the zaakEigenschappen of the zaak. public getZaaktype (void) ``` -Gets the zaaktype object from the zaak. +Gets the zaaktype object from the zaak. + + **Parameters** @@ -126,9 +155,11 @@ Gets the zaaktype object from the zaak. > The zaaktype from the zaak. +
-### FirstRegistrationService::removeSelf + +### FirstRegistrationService::removeSelf **Description** @@ -136,12 +167,14 @@ Gets the zaaktype object from the zaak. public removeSelf (array $object) ``` -Recursively removes self parameters from object. +Recursively removes self parameters from object. + + **Parameters** * `(array) $object` - : The object to remove self parameters from. +: The object to remove self parameters from. **Return Values** @@ -149,9 +182,11 @@ Recursively removes self parameters from object. > The cleaned object. +
-### FirstRegistrationService::sendFirstRegistration + +### FirstRegistrationService::sendFirstRegistration **Description** @@ -159,14 +194,16 @@ Recursively removes self parameters from object. public sendFirstRegistration (array $data, array $configuration) ``` -A first registration handler that is triggered by an action. +A first registration 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** @@ -174,9 +211,11 @@ A first registration handler that is triggered by an action. > A handler must ALWAYS return an array +
-### FirstRegistrationService::zgwToFirstRegistrationHandler + +### FirstRegistrationService::zgwToFirstRegistrationHandler **Description** @@ -184,14 +223,16 @@ A first registration handler that is triggered by an action. public zgwToFirstRegistrationHandler (array $data, array $configuration) ``` -A first registration handler that is triggered by an action. +A first registration 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** @@ -199,4 +240,6 @@ A first registration handler that is triggered by an action. > A handler must ALWAYS return an array +
+ diff --git a/docs/classes/Service/InstallationService.md b/docs/classes/Service/InstallationService.md index d72c04f..8d3a2bc 100644 --- a/docs/classes/Service/InstallationService.md +++ b/docs/classes/Service/InstallationService.md @@ -1,20 +1,26 @@ -# CommonGateway\FirstRegistrationBundle\Service\InstallationService +# CommonGateway\FirstRegistrationBundle\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` + + +
+