#10680 Add description field to library files (#10708)

pkp · Jan 14, 2025 · 45d3f11 · 45d3f11
1 parent a3cf578
commit 45d3f11
Show file tree

Hide file tree

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

diff --git a/controllers/grid/files/form/LibraryFileForm.inc.php b/controllers/grid/files/form/LibraryFileForm.inc.php
@@ -65,7 +65,7 @@ function fetch($request, $template = null, $display = false) {
 	 * @see Form::readInputData()
 	 */
 	function readInputData() {
-		$this->readUserVars(array('libraryFileName', 'fileType', 'publicAccess'));
+		$this->readUserVars(array('libraryFileName', 'description', 'fileType', 'publicAccess'));
 	}
 }
 

diff --git a/controllers/grid/files/submissionDocuments/form/EditLibraryFileForm.inc.php b/controllers/grid/files/submissionDocuments/form/EditLibraryFileForm.inc.php
@@ -47,6 +47,7 @@ function initData() {
 		$this->_data = array(
 			'submissionId' => $this->libraryFile->getSubmissionId(),
 			'libraryFileName' => $this->libraryFile->getName(null), // Localized
+			'description' => $this->libraryFile->getData('description'), // Localized
 			'libraryFile' => $this->libraryFile // For read-only info
 		);
 	}
@@ -56,6 +57,7 @@ function initData() {
 	 */
 	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.inc.php b/controllers/grid/files/submissionDocuments/form/NewLibraryFileForm.inc.php
@@ -69,6 +69,7 @@ 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.inc.php b/controllers/grid/settings/library/form/EditLibraryFileForm.inc.php
@@ -53,6 +53,7 @@ function readInputData() {
 	function initData() {
 		$this->_data = array(
 			'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,
@@ -84,6 +85,7 @@ 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'));
 		$this->libraryFile->setPublicAccess($this->getData('publicAccess'));
 

diff --git a/controllers/grid/settings/library/form/NewLibraryFileForm.inc.php b/controllers/grid/settings/library/form/NewLibraryFileForm.inc.php
@@ -56,6 +56,7 @@ 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"}