pkp#10680 Add description field to library files (pkp#10710)

lepidus · Jan 14, 2025 · 53e4857 · 53e4857
1 parent d617258
commit 53e4857
Show file tree

Hide file tree

Showing 10 changed files with 32 additions and 2 deletions.
diff --git a/classes/context/LibraryFileDAO.php b/classes/context/LibraryFileDAO.php
@@ -112,7 +112,7 @@ public function newDataObject()
      */
     public function getLocaleFieldNames(): array
     {
-        return ['name'];
+        return ['name', 'description'];
     }
 
     /**

diff --git a/controllers/grid/files/form/LibraryFileForm.php b/controllers/grid/files/form/LibraryFileForm.php
@@ -73,6 +73,6 @@ public function fetch($request, $template = null, $display = false): ?string
      */
     public function readInputData(): void
     {
-        $this->readUserVars(['libraryFileName', 'fileType', 'publicAccess']);
+        $this->readUserVars(['libraryFileName', 'description', 'fileType', 'publicAccess']);
     }
 }
diff --git a/controllers/grid/files/submissionDocuments/form/EditLibraryFileForm.php b/controllers/grid/files/submissionDocuments/form/EditLibraryFileForm.php
@@ -56,6 +56,7 @@ public function initData()
         $this->_data = [
             'submissionId' => $this->libraryFile->getSubmissionId(),
             'libraryFileName' => $this->libraryFile->getName(null), // Localized
+            'description' => $this->libraryFile->getData('description'), // Localized
             'libraryFile' => $this->libraryFile // For read-only info
         ];
     }
@@ -66,6 +67,7 @@ public function initData()
     public function execute(...$functionArgs)
     {
         $this->libraryFile->setName($this->getData('libraryFileName'), null); // Localized
+        $this->libraryFile->setData('description', $this->getData('description'), null); // Localized
         $this->libraryFile->setType($this->getData('fileType'));
 
         $libraryFileDao = DAORegistry::getDAO('LibraryFileDAO'); /** @var LibraryFileDAO $libraryFileDao */

diff --git a/controllers/grid/files/submissionDocuments/form/NewLibraryFileForm.php b/controllers/grid/files/submissionDocuments/form/NewLibraryFileForm.php
@@ -87,6 +87,7 @@ public function execute(...$functionArgs)
         assert(isset($libraryFile));
         $libraryFile->setContextId($this->contextId);
         $libraryFile->setName($this->getData('libraryFileName'), null); // Localized
+        $libraryFile->setData('description', $this->getData('description'), null); // Localized
         $libraryFile->setType($this->getData('fileType'));
         $libraryFile->setSubmissionId($this->getData('submissionId'));
 

diff --git a/controllers/grid/settings/library/form/EditLibraryFileForm.php b/controllers/grid/settings/library/form/EditLibraryFileForm.php
@@ -63,6 +63,7 @@ public function initData(): void
     {
         $this->_data = [
             'libraryFileName' => $this->libraryFile->getName(null), // Localized
+            'description' => $this->libraryFile->getData('description'), // Localized
             'libraryFile' => $this->libraryFile, // For read-only info
             'publicAccess' => $this->libraryFile->getPublicAccess() ? true : false,
             'temporaryFileId' => null,
@@ -93,6 +94,7 @@ public function execute(...$functionArgs)
             $temporaryFileManager->deleteById($this->getData('temporaryFileId'), $userId);
         }
         $this->libraryFile->setName($this->getData('libraryFileName'), null); // Localized
+        $this->libraryFile->setData('description', $this->getData('description'), null); // Localized
         $this->libraryFile->setType($this->getData('fileType'));
         $this->libraryFile->setPublicAccess($this->getData('publicAccess'));
 

diff --git a/controllers/grid/settings/library/form/NewLibraryFileForm.php b/controllers/grid/settings/library/form/NewLibraryFileForm.php
@@ -72,6 +72,7 @@ public function execute(...$functionArgs)
         assert(isset($libraryFile));
         $libraryFile->setContextId($this->contextId);
         $libraryFile->setName($this->getData('libraryFileName'), null); // Localized
+        $libraryFile->setData('description', $this->getData('description'), null); // Localized
         $libraryFile->setType($this->getData('fileType'));
         $libraryFile->setPublicAccess($this->getData('publicAccess'));
 

diff --git a/templates/controllers/grid/files/submissionDocuments/form/editFileForm.tpl b/templates/controllers/grid/files/submissionDocuments/form/editFileForm.tpl
@@ -32,6 +32,12 @@
 		{/fbvFormSection}
 	{/fbvFormArea}
 
+	{fbvFormArea id="description"}
+		{fbvFormSection title="common.description" required=true}
+			{fbvElement type="textarea" multilingual="true" id="description" value=$description}
+		{/fbvFormSection}
+	{/fbvFormArea}
+
 	{fbvFormArea id="file"}
 		{fbvFormSection title="common.file"}
 			<table id="fileInfo" class="data" width="100%">

diff --git a/templates/controllers/grid/files/submissionDocuments/form/newFileForm.tpl b/templates/controllers/grid/files/submissionDocuments/form/newFileForm.tpl
@@ -43,6 +43,12 @@
 		{/fbvFormSection}
 	{/fbvFormArea}
 
+	{fbvFormArea id="description"}
+		{fbvFormSection title="common.description" required=true}
+			{fbvElement type="textarea" multilingual="true" id="description" value=$description}
+		{/fbvFormSection}
+	{/fbvFormArea}
+
 	{fbvFormArea id="file"}
 		{fbvFormSection title="common.file" required=true}
 			{include file="controllers/fileUploadContainer.tpl" id="plupload"}

diff --git a/templates/controllers/grid/settings/library/form/editFileForm.tpl b/templates/controllers/grid/settings/library/form/editFileForm.tpl
@@ -39,6 +39,12 @@
 		{/fbvFormSection}
 	{/fbvFormArea}
 
+	{fbvFormArea id="description"}
+		{fbvFormSection title="common.description" required=true}
+			{fbvElement type="textarea" multilingual="true" id="description" value=$description}
+		{/fbvFormSection}
+	{/fbvFormArea}
+
 	{fbvFormArea id="file"}
 		{fbvFormSection title="common.file"}
 			<table id="fileInfo" class="data" width="100%">

diff --git a/templates/controllers/grid/settings/library/form/newFileForm.tpl b/templates/controllers/grid/settings/library/form/newFileForm.tpl
@@ -40,6 +40,12 @@
 		{/fbvFormSection}
 	{/fbvFormArea}
 
+	{fbvFormArea id="description"}
+		{fbvFormSection title="common.description" required=true}
+			{fbvElement type="textarea" multilingual="true" id="description" value=$description}
+		{/fbvFormSection}
+	{/fbvFormArea}
+
 	{fbvFormArea id="file"}
 		{fbvFormSection title="common.file" required=true}
 			{include file="controllers/fileUploadContainer.tpl" id="plupload"}
-Original file line number
+Diff line change
@@ Expand Up / @@ -112,7 +112,7 @@ public function newDataObject() @@
          */
         public function getLocaleFieldNames(): array
         {
-            return ['name'];
+            return ['name', 'description'];
         }
         /**
@@ Expand Down @@