Process PR comments

Author: rjzondervan

src/ActionHandler/NotificationCaseHandler.php

@@ -5,11 +5,20 @@
 use CommonGateway\VrijBRPToZGWBundle\Service\NewSynchronizationService;
 use CommonGateway\VrijBRPToZGWBundle\Service\VrijBrpService;
 use CommonGateway\CoreBundle\ActionHandler\ActionHandlerInterface;
-
+/**
+ * Handler for firing notifications for new cases.
+ *
+ * @author  Robert Zondervan, Barry Brands, Ruben van der Linde
+ * @license EUPL<github.com/ConductionNL/contactcatalogus/blob/master/LICENSE.md>
+ *
+ * @category ActionHandler
+ */
 class NotificationCaseHandler implements ActionHandlerInterface
 {
 
-
+    /**
+     * @param VrijBrpService $vrijBrpService The VrijBRP Service
+     */
     public function __construct(
         private readonly VrijBrpService $vrijBrpService,
     ) {
@@ -21,6 +30,7 @@ public function __construct(
      *  This function returns the requered configuration as a [json-schema](https://json-schema.org/) array.
      *
      * @throws array a [json-schema](https://json-schema.org/) that this  action should comply to
+     * @return array The default configuration options of this action handler.
      */
     public function getConfiguration(): array
     {
@@ -42,7 +52,7 @@ public function getConfiguration(): array
      * @param array $data          The data from the call
      * @param array $configuration The configuration of the action
      *
-     * @return array
+     * @return array The updated data array
      */
     public function run(array $data, array $configuration): array
     {

src/ActionHandler/NotificationUpdateHandler.php

@@ -6,10 +6,21 @@
 use CommonGateway\VrijBRPToZGWBundle\Service\VrijBrpService;
 use CommonGateway\CoreBundle\ActionHandler\ActionHandlerInterface;
 
+/**
+ * Handler for firing notifications for new statuses.
+ *
+ * @author  Robert Zondervan, Barry Brands, Ruben van der Linde
+ * @license EUPL<github.com/ConductionNL/contactcatalogus/blob/master/LICENSE.md>
+ *
+ * @category ActionHandler
+ */
 class NotificationUpdateHandler implements ActionHandlerInterface
 {
 
 
+    /**
+     * @param VrijBrpService $vrijBrpService The VrijBRP Service
+     */
     public function __construct(
         private readonly VrijBrpService $vrijBrpService,
     ) {
@@ -21,6 +32,7 @@ public function __construct(
      *  This function returns the requered configuration as a [json-schema](https://json-schema.org/) array.
      *
      * @throws array a [json-schema](https://json-schema.org/) that this  action should comply to
+     * @return array The default configuration options of this action handler.
      */
     public function getConfiguration(): array
     {
@@ -42,7 +54,7 @@ public function getConfiguration(): array
      * @param array $data          The data from the call
      * @param array $configuration The configuration of the action
      *
-     * @return array
+     * @return array The updated data array.
      */
     public function run(array $data, array $configuration): array
     {

src/ActionHandler/SynchronizeCollectionHandler.php

@@ -19,8 +19,8 @@ class SynchronizeCollectionHandler implements ActionHandlerInterface
 
 
     /**
-     * @param NewSynchronizationService $syncService
-     * @param VrijBrpService            $vrijBrpService
+     * @param NewSynchronizationService $syncService    The synchronization service.
+     * @param VrijBrpService            $vrijBrpService The VrijBRP service.
      */
     public function __construct(
         private readonly NewSynchronizationService $syncService,

src/Service/VrijBrpService.php

@@ -42,7 +42,8 @@ public function __construct(
      * Set defaults for configuration of synchronize action.
      *
      * @param  array $configuration Incoming configuration.
-     * @return array
+     *
+     * @return array The updated configuration array.
      */
     public function setVrijBRPDefaults(array $configuration): array
     {
@@ -73,7 +74,8 @@ public function setVrijBRPDefaults(array $configuration): array
      *
      * @param  array $data   incoming data.
      * @param  array $config incoming configuration.
-     * @return array
+     *
+     * @return array The updated data array.
      */
     public function createStatusNotification(array $data, array $config): array
     {
@@ -110,7 +112,8 @@ public function createStatusNotification(array $data, array $config): array
      *
      * @param  ObjectEntity $object Incoming object
      * @param  array        $array  Serialised incoming object
-     * @return ObjectEntity
+     *
+     * @return ObjectEntity The updated objectEntity.
      */
     public function extendSync(ObjectEntity $object, array $array): ObjectEntity
     {
@@ -141,7 +144,8 @@ public function extendSync(ObjectEntity $object, array $array): ObjectEntity
      *
      * @param  array $data   Incoming data
      * @param  array $config Incoming configuration
-     * @return array
+     *
+     * @return array The updated data array.
      */
     public function createCaseNotification(array $data, array $config): array
     {