Merge pull request #187 from AlexanderBlanchardAC/DIS-314-Remove-Results-From-Summon-Search

Dis 314 remove results from summon search

Author: AlexanderBlanchardAC

code/web/release_notes/25.03.00.MD

@@ -64,6 +64,7 @@
 // alexander
 ### Summon Updates
 - Update the Summon Search Indexes to match those found in Summon Serials Solutions. (DIS-232) (*AB*)
+- Add a setting in Summon Settings that gives the option of filtering out results from the library catalog when searching using Summon. (DIS-314) (*AB*)
 
 // chloe
 

code/web/sys/DBMaintenance/version_updates/25.03.00.php

@@ -167,6 +167,13 @@ function getUpdates25_03_00(): array {
 		// Leo Stoyanov - BWS
 
 		//alexander - PTFS-Europe
+		'filter_books_from_summon_results' => [
+			'title' => 'Filter Books From Summon Results',
+			'description' => 'Add the option of filtering out records with the content type of book or ebook from Summon results',
+			'sql' => [
+				"ALTER TABLE summon_settings ADD COLUMN filterOutBooksAndEbooks TINYINT(1) NOT NULL DEFAULT 0",
+			],
+		],
 
 		//chloe - PTFS-Europe
 

code/web/sys/SearchObject/SummonSearcher.php

@@ -291,6 +291,19 @@ public function processData($recordData, $textQuery = null) {
 				$splitFacets = $this->splitFacets($recordData['facetFields']);
 				$this->facetFields = $splitFacets['facetFields'];
 				$this->limitFields = $splitFacets['limitFields'];
+
+				$summonSettings = $this->getSettings();
+				if ($summonSettings && !empty($summonSettings->filterOutBooksAndEbooks)) {
+					foreach ($this->facetFields as $key => $facet) {
+						if ($facet['displayName'] === 'ContentType') {
+							foreach ($facet['counts'] as $index => $count) {
+								if (isset($count['value']) && ($count['value'] === 'Book / eBook' || $count['value'] === 'Book%20%2F%20eBook')) {
+									unset($this->facetFields[$key]['counts'][$index]);
+								}
+							}
+						}
+					}
+				}
 			}
 			return $recordData;
 	}
@@ -572,6 +585,12 @@ public function getSummonFilters() {
 				$this->filters[] = urlencode($key) . ',' . $encodedValue . ',';
 			}
 		}
+
+		$summonSettings = $this->getSettings();
+
+		if ($summonSettings && !empty($summonSettings->filterOutBooksAndEbooks)) {
+			$this->filters[] = 'ContentType,Book%20%2F%20eBook,t';
+		}
 		return $this->filters;
 	}
 

code/web/sys/Summon/SummonSettings.php

@@ -8,6 +8,7 @@ class SummonSettings extends DataObject {
 	public $summonApiId;
 	public $summonApiPassword;
 	public $summonBaseApi;
+	public $filterOutBooksAndEbooks;
 
 	function getEncryptedFieldNames(): array {
 		return ['summonApiPassword'];
@@ -50,6 +51,14 @@ public static function getObjectStructure($context = ''): array {
 				'description' => 'The password to use when connecting to the Summon API',
 				'hideInLists' => true,
 			],
+			'filterOutBooksAndEbooks' => [
+				'property' => 'filterOutBooksAndEbooks',
+				'type' => 'checkbox',
+				'default' => false,
+				'label' => 'Filter Out Books And eBooks',
+				'description' => 'Whether or not to include books and ebooks in the summon search results',
+				'hideInLists' => true,
+			],
 		];
 	}
 }