(feat): add 'zaak' document descriptions

Mike van den Hoek · Mike van den Hoek · commit d6986eebf0c9 · 2025-07-17T08:29:46.000+02:00
diff --git a/resources/views/partials/gf-field-options.php b/resources/views/partials/gf-field-options.php
@@ -1,24 +1,25 @@
 <?php
+
 declare(strict_types=1);
 
 use function OWC\Zaaksysteem\Foundation\Helpers\config;
 
 ?>
 <li class="label_setting field_setting">
     <label for="linkedFieldZGW" class="section_label">
-        <?php _e('Zaaksysteem mapping', config('core.text_domain')) ?>
+        <?php esc_html_e('Zaaksysteem mapping', config('core.text_domain')) ?>
     </label>
 
     <select id="linkedFieldZGW" onchange="SetFieldProperty('linkedFieldValueZGW', this.value);">
-        <option value=""><?php _e('Kies veldnaam Zaaksysteem', config('core.text_domain')) ?></option>
-        <option value="bronorganisatie"><?php _e('Bronorganisatie', config('core.text_domain')) ?></option>
-        <option value="zaaktype"><?php _e('Zaaktype', config('core.text_domain')) ?></option>
-        <option value="omschrijving"><?php _e('Omschrijving', config('core.text_domain')) ?></option>
-        <option value="toelichting"><?php _e('Toelichting', config('core.text_domain')) ?></option>
-        <option value="registratiedatum"><?php _e('Registratiedatum', config('core.text_domain')) ?></option>
-        <option value="verantwoordelijkeOrganisatie"><?php _e('Verantwoordelijke organisatie', config('core.text_domain')) ?></option>
-        <option value="startdatum"><?php _e('Startdatum', config('core.text_domain')) ?></option>
-		<option value="informatieobject"><?php _e('Informatieobject', config('core.text_domain')) ?></option>
+        <option value=""><?php esc_html_e('Kies veldnaam Zaaksysteem', config('core.text_domain')) ?></option>
+        <option value="bronorganisatie"><?php esc_html_e('Bronorganisatie', config('core.text_domain')) ?></option>
+        <option value="zaaktype"><?php esc_html_e('Zaaktype', config('core.text_domain')) ?></option>
+        <option value="omschrijving"><?php esc_html_e('Omschrijving', config('core.text_domain')) ?></option>
+        <option value="toelichting"><?php esc_html_e('Toelichting', config('core.text_domain')) ?></option>
+        <option value="registratiedatum"><?php esc_html_e('Registratiedatum', config('core.text_domain')) ?></option>
+        <option value="verantwoordelijkeOrganisatie"><?php esc_html_e('Verantwoordelijke organisatie', config('core.text_domain')) ?></option>
+        <option value="startdatum"><?php esc_html_e('Startdatum', config('core.text_domain')) ?></option>
+		<option value="informatieobject"><?php esc_html_e('Informatieobject', config('core.text_domain')) ?></option>
         <optgroup label="Zaakeigenschappen">
         <?php foreach ($vars['properties'] ?? [] as $property) : ?>
             <option value="<?php echo $property['value']; ?>">
@@ -29,10 +30,10 @@
 </li>
 <li class="label_setting field_setting">
     <label for="linkedFieldDocumentType" class="section_label">
-        <?php _e('Document typen', config('core.text_domain')) ?>
+        <?php esc_html_e('Document typen', config('core.text_domain')) ?>
     </label>
 	<select id="linkedFieldDocumentType" onchange="SetFieldProperty('linkedFieldValueDocumentType', this.value);">
-		<option value=""><?php _e('Kies een document type', config('core.text_domain')) ?></option>
+		<option value=""><?php esc_html_e('Kies een document type', config('core.text_domain')) ?></option>
 		<?php foreach ($vars['objecttypes'] ?? [] as $property) : ?>
 			<option value="<?php echo $property['value']; ?>">
 					<?php echo $property['label']; ?>
diff --git a/resources/views/partials/gf-upload-field-options.php b/resources/views/partials/gf-upload-field-options.php
@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+use function OWC\Zaaksysteem\Foundation\Helpers\config;
+
+?>
+
+<li class="zgw_upload_setting field_setting">
+    <label for="linkedUploadFieldDescriptionZGW" class="section_label">
+        <?php esc_html_e('Document beschrijving', config('core.text_domain')); ?>
+    </label>
+    <input type="text" id="linkedUploadFieldDescriptionZGW" onchange="SetFieldProperty('linkedUploadFieldDescriptionValueZGW', this.value);" />
+	<small><?php esc_html_e('Gebruik het ID van een veld om de waarde daarvan te gebruiken (e.g. [id]) in de beschrijving van het bestand.', config('core.text_domain')); ?></small>
+</li>
diff --git a/resources/views/scriptSelect.php b/resources/views/scriptSelect.php
@@ -7,9 +7,14 @@
     // To display custom field under each type of Gravity Forms field.
     jQuery.each(fieldSettings, function(index, value) {
         fieldSettings[index] += ', .highlight_setting_zgw';
+
+		if (index === 'fileupload') {
+			fieldSettings[index] += ', .zgw_upload_setting';
+		}
     });
     jQuery(document).bind('gform_load_field_settings', function(event, field, form) {
         jQuery('#linkedFieldZGW').val(field['linkedFieldValueZGW']);
 		jQuery('#linkedFieldDocumentType').val(field['linkedFieldValueDocumentType']);
+		jQuery('#linkedUploadFieldDescriptionZGW').val(field['linkedUploadFieldDescriptionValueZGW']);
     });
 </script>
diff --git a/src/Clients/DecosJoin/Actions/CreateUploadedDocumentsAction.php b/src/Clients/DecosJoin/Actions/CreateUploadedDocumentsAction.php
@@ -31,7 +31,7 @@ public function addUploadedDocuments(): ?bool
                 continue;
             }
 
-            $args = $this->prepareInformationObjectArgs($object['url'], $object['type']);
+            $args = $this->prepareInformationObjectArgs($object['url'], $object['type'], $object['description']);
             $connectionResult = $this->connectZaakToInformationObject($this->createInformationObject($args));
 
             if ($connectionResult instanceof Zaakinformatieobject) {
diff --git a/src/Clients/OpenZaak/Actions/CreateUploadedDocumentsAction.php b/src/Clients/OpenZaak/Actions/CreateUploadedDocumentsAction.php
@@ -31,7 +31,7 @@ public function addUploadedDocuments(): ?bool
                 continue;
             }
 
-            $args = $this->prepareInformationObjectArgs($object['url'], $object['type']);
+            $args = $this->prepareInformationObjectArgs($object['url'], $object['type'], $object['description']);
             $connectionResult = $this->connectZaakToInformationObject($this->createInformationObject($args));
 
             if ($connectionResult instanceof Zaakinformatieobject) {
diff --git a/src/Clients/Procura/Actions/CreateUploadedDocumentsAction.php b/src/Clients/Procura/Actions/CreateUploadedDocumentsAction.php
@@ -31,7 +31,7 @@ public function addUploadedDocuments(): ?bool
                 continue;
             }
 
-            $args = $this->prepareInformationObjectArgs($object['url'], $object['type']);
+            $args = $this->prepareInformationObjectArgs($object['url'], $object['type'], $object['description']);
             $connectionResult = $this->connectZaakToInformationObject($this->createInformationObject($args));
 
             if ($connectionResult instanceof Zaakinformatieobject) {
diff --git a/src/Clients/RxMission/Actions/CreateUploadedDocumentsAction.php b/src/Clients/RxMission/Actions/CreateUploadedDocumentsAction.php
@@ -31,7 +31,7 @@ public function addUploadedDocuments(): ?bool
                 continue;
             }
 
-            $args = $this->prepareInformationObjectArgs($object['url'], $object['type']);
+            $args = $this->prepareInformationObjectArgs($object['url'], $object['type'], $object['description']);
             $connectionResult = $this->connectZaakToInformationObject($this->createInformationObject($args));
 
             if ($connectionResult instanceof Zaakinformatieobject) {
diff --git a/src/Clients/Xxllnc/Actions/CreateUploadedDocumentsAction.php b/src/Clients/Xxllnc/Actions/CreateUploadedDocumentsAction.php
@@ -31,7 +31,7 @@ public function addUploadedDocuments(): ?bool
                 continue;
             }
 
-            $args = $this->prepareInformationObjectArgs($object['url'], $object['type']);
+            $args = $this->prepareInformationObjectArgs($object['url'], $object['type'], $object['description']);
             $connectionResult = $this->connectZaakToInformationObject($this->createInformationObject($args));
 
             if ($connectionResult instanceof Zaakinformatieobject) {
diff --git a/src/Contracts/AbstractCreateUploadedDocumentsAction.php b/src/Contracts/AbstractCreateUploadedDocumentsAction.php
@@ -11,11 +11,13 @@
 use OWC\Zaaksysteem\Resolvers\ContainerResolver;
 use OWC\Zaaksysteem\Traits\CheckURL;
 use OWC\Zaaksysteem\Traits\InformationObject;
+use OWC\Zaaksysteem\Traits\MergeTags;
 
 abstract class AbstractCreateUploadedDocumentsAction
 {
     use CheckURL;
     use InformationObject;
+    use MergeTags;
 
     public const CLIENT_NAME = '';
 
@@ -77,7 +79,7 @@ protected function mapInformationObjectArg(array $args, GF_Field $field, $fieldV
 
         if (is_string($fieldValue)) {
             $fieldValue = [
-                ['type' => $field->linkedFieldValueDocumentType, 'url' => $fieldValue],
+                ['type' => $field->linkedFieldValueDocumentType, 'url' => $fieldValue, 'description' => $field->linkedUploadFieldDescriptionValueZGW ?? ''],
             ];
         }
 
@@ -107,7 +109,7 @@ protected function convertInformationObjectFieldJSON(string $fieldValue, $field)
         }
 
         return array_map(function ($fieldValue) use ($field) {
-            return ['type' => $field->linkedFieldValueDocumentType, 'url' => $fieldValue];
+            return ['type' => $field->linkedFieldValueDocumentType, 'url' => $fieldValue, 'description' => $field->linkedUploadFieldDescriptionValueZGW ?? ''];
         }, $fieldValues);
     }
 
@@ -132,7 +134,7 @@ protected function connectZaakToInformationObject(?Enkelvoudiginformatieobject $
         return $this->client->zaakinformatieobjecten()->create(new Zaakinformatieobject($object->toArray(), $this->client->getClientName(), $this->client->getClientNamePretty())); // What to do when this one fails?
     }
 
-    protected function prepareInformationObjectArgs(string $objectURL, string $informationObjectType): array
+    protected function prepareInformationObjectArgs(string $objectURL, string $informationObjectType, string $objectDescription): array
     {
         if (empty($informationObjectType)) {
             return [];
@@ -147,6 +149,7 @@ protected function prepareInformationObjectArgs(string $objectURL, string $infor
         $args['formaat'] = $this->getContentType($objectURL);
         $args['bestandsnaam'] = sprintf('%s.%s', \sanitize_title($fileName), $this->getExtension($objectURL));
         $args['bestandsomvang'] = $bestandsomvang ? (int) $bestandsomvang : strlen($inhoud);
+        $args['beschrijving'] = 0 < strlen($objectDescription) ? $this->handleMergeTags($this->entry, $objectDescription) : $fileName;
         $args['inhoud'] = $inhoud;
         $args['vertrouwelijkheidaanduiding'] = 'vertrouwelijk';
         $args['auteur'] = 'OWC';
diff --git a/src/Contracts/AbstractCreateZaakAction.php b/src/Contracts/AbstractCreateZaakAction.php
@@ -15,10 +15,12 @@
 use OWC\Zaaksysteem\Resolvers\ContainerResolver;
 use OWC\Zaaksysteem\Support\PagedCollection;
 use OWC\Zaaksysteem\Traits\FormSetting;
+use OWC\Zaaksysteem\Traits\MergeTags;
 
 abstract class AbstractCreateZaakAction
 {
     use FormSetting;
+    use MergeTags;
 
     public const CLIENT_NAME = '';
     public const CALLABLE_NAME = '';
@@ -110,7 +112,7 @@ protected function mapArgs(array $args, array $form, array $entry): array
                 $fieldValue = (new DateTime($fieldValue))->format('Y-m-d');
             }
 
-            $args[$field->linkedFieldValueZGW] = $fieldValue;
+            $args[$field->linkedFieldValueZGW] = $this->handleMergeTags($entry, $fieldValue);
         }
 
         return $args;
@@ -144,7 +146,7 @@ public function addZaakEigenschappen(Zaak $zaak, $fields, $entry): void
                 );
             } catch (BadRequestError $e) {
                 $e->getInvalidParameters();
-            } catch(Exception $e) {
+            } catch (Exception $e) {
                 // Fail silently.
             }
         }
@@ -224,7 +226,7 @@ public function addRolToZaak(Zaak $zaak, string $zaaktypeURL): ?Rol
                 $rol = $client->rollen()->create(new Rol($args, $client->getClientName(), $client->getClientNamePretty()));
             } catch (BadRequestError $e) {
                 $e->getInvalidParameters();
-            } catch(Exception $e) {
+            } catch (Exception $e) {
                 // Fail silently.
             }
 
diff --git a/src/GravityForms/GravityFormsFieldSettings.php b/src/GravityForms/GravityFormsFieldSettings.php
@@ -9,11 +9,11 @@
 use OWC\Zaaksysteem\Endpoints\Filter\EigenschappenFilter;
 use OWC\Zaaksysteem\Entities\Informatieobjecttype;
 use OWC\Zaaksysteem\Entities\Zaaktype;
+use function OWC\Zaaksysteem\Foundation\Helpers\get_supplier;
+use function OWC\Zaaksysteem\Foundation\Helpers\view;
 use OWC\Zaaksysteem\Resolvers\ContainerResolver;
 use OWC\Zaaksysteem\Support\Collection;
 use OWC\Zaaksysteem\Traits\FormSetting;
-use function OWC\Zaaksysteem\Foundation\Helpers\get_supplier;
-use function OWC\Zaaksysteem\Foundation\Helpers\view;
 
 class GravityFormsFieldSettings
 {
@@ -203,5 +203,6 @@ public function addSelect($position, $formId): void
             'properties' => $properties instanceof Collection ? $this->preparePropertiesOptions($properties) : [],
             'objecttypes' => $this->prepareObjectTypesOptions($this->getInformatieObjectTypen($zaaktype, $zaaktypeIdentification), $zaaktypeIdentification),
         ]);
+        echo view('partials/gf-upload-field-options.php');
     }
 }
diff --git a/src/Traits/MergeTags.php b/src/Traits/MergeTags.php
@@ -0,0 +1,94 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OWC\Zaaksysteem\Traits;
+
+use DateTime;
+use Exception;
+use GF_Field;
+
+trait MergeTags
+{
+    public function handleMergeTags(array $entry, string $value)
+    {
+        return preg_replace_callback('/\[[^\]]*\]/', function ($matches) use ($entry) {
+            $fieldID = str_replace(['[', ']'], '', $matches[0]);
+            $fieldValue = null;
+
+            if ($field = $this->checkFieldType($fieldID, 'checkbox')) {
+                $fieldValue = [];
+
+                foreach ($field->inputs as $input) {
+                    $fieldValue[] = rgar($entry, $input['id']);
+                }
+            } elseif ($this->checkFieldType($fieldID, 'multiselect')) {
+                $fieldValue = json_decode(rgar($entry, $fieldID), true) ?: [];
+            } else {
+                $fieldValue = rgar($entry, $fieldID);
+            }
+
+            if (is_array($fieldValue)) {
+                $fieldValue = $this->formatArrayToString($fieldValue);
+            }
+
+            if (! is_string($fieldValue) || empty($fieldValue)) {
+                return '';
+            }
+
+            $possibleDate = $this->convertPossibleMergeTagDate($fieldValue);
+
+            return ! empty($possibleDate) ? $possibleDate : $fieldValue;
+        }, $value);
+    }
+
+    protected function checkFieldType(string $fieldID, string $fieldType): ?GF_Field
+    {
+        $fields = array_filter($this->form['fields'], function ($field) use ($fieldID, $fieldType) {
+            return $field->id == $fieldID && $fieldType === $field->type;
+        });
+
+        $field = reset($fields);
+
+        return $field instanceof GF_Field ? $field : null;
+    }
+
+    protected function formatArrayToString(array $items): ?string
+    {
+        $items = array_filter($items, fn ($item) => trim($item) !== '');
+
+        if (empty($items)) {
+            return null;
+        }
+
+        if (count($items) === 1) {
+            return reset($items);
+        }
+
+        $lastItem = array_pop($items);
+
+        return implode(', ', $items) . ' en ' . $lastItem;
+    }
+
+    /**
+     * When a merge tag contains a date, convert to given format.
+     */
+    protected function convertPossibleMergeTagDate(string $value, string $format = 'd-m-Y'): string
+    {
+        /**
+         * A valid date string has a length of 10.
+         * Housenumber additions could be 'B' for example, 'B' also corrensponds with a timezone.
+         */
+        if (strlen($value) !== 10) {
+            return '';
+        }
+
+        try {
+            $date = new DateTime($value);
+        } catch (Exception $e) {
+            return '';
+        }
+
+        return $date->format($format);
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ public function addUploadedDocuments(): ?bool`
`31`	`31`	`continue;`
`32`	`32`	`}`
`33`	`33`
`34`		`- $args = $this->prepareInformationObjectArgs($object['url'], $object['type']);`
	`34`	`+ $args = $this->prepareInformationObjectArgs($object['url'], $object['type'], $object['description']);`
`35`	`35`	`$connectionResult = $this->connectZaakToInformationObject($this->createInformationObject($args));`
`36`	`36`
`37`	`37`	`if ($connectionResult instanceof Zaakinformatieobject) {`
Original file line number	Diff line number	Diff line change
`@@ -15,10 +15,12 @@`
`15`	`15`	`use OWC\Zaaksysteem\Resolvers\ContainerResolver;`
`16`	`16`	`use OWC\Zaaksysteem\Support\PagedCollection;`
`17`	`17`	`use OWC\Zaaksysteem\Traits\FormSetting;`
	`18`	`+use OWC\Zaaksysteem\Traits\MergeTags;`
`18`	`19`
`19`	`20`	`abstract class AbstractCreateZaakAction`
`20`	`21`	`{`
`21`	`22`	`use FormSetting;`
	`23`	`+ use MergeTags;`
`22`	`24`
`23`	`25`	`public const CLIENT_NAME = '';`
`24`	`26`	`public const CALLABLE_NAME = '';`
`@@ -110,7 +112,7 @@ protected function mapArgs(array $args, array $form, array $entry): array`
`110`	`112`	`$fieldValue = (new DateTime($fieldValue))->format('Y-m-d');`
`111`	`113`	`}`
`112`	`114`
`113`		`- $args[$field->linkedFieldValueZGW] = $fieldValue;`
	`115`	`+ $args[$field->linkedFieldValueZGW] = $this->handleMergeTags($entry, $fieldValue);`
`114`	`116`	`}`
`115`	`117`
`116`	`118`	`return $args;`
`@@ -144,7 +146,7 @@ public function addZaakEigenschappen(Zaak $zaak, $fields, $entry): void`
`144`	`146`	`);`
`145`	`147`	`} catch (BadRequestError $e) {`
`146`	`148`	`$e->getInvalidParameters();`
`147`		`- } catch(Exception $e) {`
	`149`	`+ } catch (Exception $e) {`
`148`	`150`	`// Fail silently.`
`149`	`151`	`}`
`150`	`152`	`}`
`@@ -224,7 +226,7 @@ public function addRolToZaak(Zaak $zaak, string $zaaktypeURL): ?Rol`
`224`	`226`	`$rol = $client->rollen()->create(new Rol($args, $client->getClientName(), $client->getClientNamePretty()));`
`225`	`227`	`} catch (BadRequestError $e) {`
`226`	`228`	`$e->getInvalidParameters();`
`227`		`- } catch(Exception $e) {`
	`229`	`+ } catch (Exception $e) {`
`228`	`230`	`// Fail silently.`
`229`	`231`	`}`
`230`	`232`