When search service is provided by IiifSearch & ExtractOcr modules, we

can check if there is an XML in order to disable search for items that only contain images for example.
Daniel-KM · Oct 28, 2019 · facca51 · facca51
1 parent 4c196e4
commit facca51
Show file tree

Hide file tree

Showing 3 changed files with 39 additions and 6 deletions.
diff --git a/config/module.config.php b/config/module.config.php
@@ -386,6 +386,7 @@
             'iiifserver_image_tile_dir' => 'tile',
             'iiifserver_image_tile_type' => 'deepzoom',
             'iiifserver_manifest_service_iiifSearch' => '',
+            'iiifserver_manifest_service_iiifSearch_extractOcr' => false,
         ],
     ],
 ];
diff --git a/src/Form/ConfigForm.php b/src/Form/ConfigForm.php
@@ -222,6 +222,17 @@ public function init()
             ],
         ]);
 
+        $manifestFieldset->add([
+            'name' => 'iiifserver_manifest_service_iiifSearch_extractOcr',
+            'type' => Element\Checkbox::class,
+            'options' => [
+                'label' => 'IIIF Search provided by ExtractOcr module', // @translate
+                'info' => 'If you use IiifSearch & ExtractOcr modules to provide IiifSearch results, check this box to disable the search box when there is no OCR.',  // @translate
+            ],
+        ]);
+
+
+
         $this->add([
             'name' => 'iiifserver_image',
             'type' => Fieldset::class,
@@ -375,6 +386,11 @@ public function init()
             'name' => 'iiifserver_manifest_service_iiifSearch',
             'required' => false,
         ]);
+        $manifestFilter->add([
+            'name' => 'iiifserver_manifest_service_iiifSearch_extractOcr',
+            'required' => false,
+        ]);
+
 
         $imageFilter = $inputFilter->get('iiifserver_image');
         $imageFilter->add([

diff --git a/src/View/Helper/IiifManifest.php b/src/View/Helper/IiifManifest.php
@@ -30,6 +30,7 @@
 
 namespace IiifServer\View\Helper;
 
+use IiifSearch\View\Helper\IiifSearch;
 use IiifServer\Mvc\Controller\Plugin\TileInfo;
 use Omeka\Api\Representation\AbstractResourceEntityRepresentation;
 use Omeka\Api\Representation\ItemRepresentation;
@@ -160,12 +161,27 @@ protected function buildManifestItem(ItemRepresentation $item)
 
         $iiifSearch = $this->view->setting('iiifserver_manifest_service_iiifSearch');
         if ( $iiifSearch ) {
-            $manifest['service'] = [
-                '@context' =>'http://iiif.io/api/search/0/context.json',
-                '@id' => $iiifSearch . $item->id(),
-                "profile" => "http://iiif.io/api/search/0/search",
-                "label" => "Search within this manifest"
-            ];
+            $searchServiceAvailable = true;
+            $iiifSearchExtractOcr = $this->view->setting('iiifserver_manifest_service_iiifSearch_extractOcr');
+            if ($iiifSearchExtractOcr) {
+                // Checking if item has at least an XML file that will allow search
+                $searchServiceAvailable = false;
+                foreach ( $item->media() as $media ) {
+                    $mediaType = $media->mediaType();
+                    if (($mediaType == 'application/xml') || ($mediaType == 'text/xml')) {
+                        $searchServiceAvailable = true;
+                    }
+                }
+            }
+
+            if ($searchServiceAvailable) {
+                $manifest['service'] = [
+                    '@context' => 'http://iiif.io/api/search/0/context.json',
+                    '@id' => $iiifSearch . $item->id(),
+                    "profile" => "http://iiif.io/api/search/0/search",
+                    "label" => "Search within this manifest"
+                ];
+            }
         }