Merge pull request #1015 from creative-commoners/pulls/5/usedontable-…

…extension

NEW Extension to link file submissions to userform on the used on table

_config/extensions.yml

@@ -7,3 +7,6 @@ SilverStripe\UserForms\Model\UserDefinedForm:
 SilverStripe\Assets\File:
   extensions:
     - SilverStripe\UserForms\Extension\UserFormFileExtension
+SilverStripe\Admin\Forms\UsedOnTable:
+  extensions:
+    - SilverStripe\UserForms\Extensions\UsedOnTableExtension

code/Extension/UsedOnTableExtension.php

@@ -0,0 +1,60 @@
+<?php
+
+namespace SilverStripe\UserForms\Extensions;
+
+use SilverStripe\Core\Extension;
+use SilverStripe\ORM\DataObject;
+use SilverStripe\UserForms\Model\EditableFormField;
+use SilverStripe\UserForms\Model\Submission\SubmittedFileField;
+use SilverStripe\UserForms\Model\Submission\SubmittedForm;
+use SilverStripe\UserForms\Model\UserDefinedForm;
+
+/**
+ * Update DataObjects on the file "Used On" table
+ */
+class UsedOnTableExtension extends Extension
+{
+
+    /**
+     * Link submitted file fields to their parent page
+     *
+     * @param array $ancestorDataObjects
+     * @param DataObject $dataObject|null
+     */
+    public function updateUsageDataObject(?DataObject &$dataObject)
+    {
+        if (!($dataObject instanceof SubmittedFileField)) {
+            return;
+        }
+        /** @var SubmittedForm $submittedForm */
+        $submittedForm = $dataObject->Parent();
+        if (!$submittedForm) {
+            $dataObject = null;
+            return;
+        }
+        // Display the submitted form instead of the submitted file field
+        $dataObject = $submittedForm;
+    }
+
+    /**
+     * @param array $ancestorDataObjects
+     * @param DataObject $dataObject
+     */
+    public function updateUsageAncestorDataObjects(array &$ancestorDataObjects, DataObject $dataObject)
+    {
+        // SubmittedFileField was changed to a Submitted Form in updateUsageModifyOrExcludeDataObject()
+        if (!($dataObject instanceof SubmittedForm)) {
+            return;
+        }
+        /** @var UserDefinedForm $page */
+        $page = $dataObject->Parent();
+        if (!$page) {
+            return;
+        }
+        // Use an un-persisted DataObject with a 'Title' field to display the word 'Submissions'
+        $submissions = new EditableFormField();
+        $submissions->Title = 'Submissions';
+        $ancestorDataObjects[] = $submissions;
+        $ancestorDataObjects[] = $page;
+    }
+}

code/Model/Submission/SubmittedForm.php

@@ -9,7 +9,6 @@
 use SilverStripe\Forms\GridField\GridFieldDataColumns;
 use SilverStripe\Forms\GridField\GridFieldExportButton;
 use SilverStripe\Forms\GridField\GridFieldPrintButton;
-use SilverStripe\Forms\GridField\GridFieldToolbarHeader;
 use SilverStripe\Forms\ReadonlyField;
 use SilverStripe\ORM\DataObject;
 use SilverStripe\ORM\DB;

lang/en.yml

@@ -255,11 +255,11 @@ en:
       other: '{count} Submitted File Fields'
     SINGULARNAME: 'Submitted File Field'
   SilverStripe\UserForms\Model\Submission\SubmittedForm:
-    PLURALNAME: 'Submitted Forms'
+    PLURALNAME: 'Submitted forms'
     PLURALS:
-      one: 'A Submitted Form'
-      other: '{count} Submitted Forms'
-    SINGULARNAME: 'Submitted Form'
+      one: 'A Submitted form'
+      other: '{count} Submitted forms'
+    SINGULARNAME: 'Submitted form'
     SUBMITTER: Submitter
   SilverStripe\UserForms\Model\Submission\SubmittedFormField:
     PLURALNAME: 'Submitted Form Fields'