AOS-295: Update the module to apply when FileExtension is applied

Author: HeyImPhil

README.md

@@ -110,10 +110,12 @@ SilverStripe\Forager\Service\IndexConfiguration:
 
 ### File attachments for content extraction
 
-Firstly, you will need to set this environment variable. This will apply an extension to the `File` class, and allow you to use the `_attachment` field (detailed below).
+Firstly, you will need to apply the FileExtension extension onto Files. This extension will allow you to use the `_attachment` field (detailed below).
 
 ```yaml
-SEARCH_INDEX_FILES=1
+SilverStripe\Assets\File:
+    extensions:
+        ForagerBifrostFileExtension: SilverStripe\ForagerBifrost\Extensions\FileExtension
 ```
 
 Silverstripe Search supports content extraction for many different file types. These can be attached to your Documents using an `_attachment` field of type `binary`.

_config/extensions.yml

@@ -1,10 +1,6 @@
 ---
 Name: forager-bifrost-extensions
 ---
-SilverStripe\Assets\File:
-  extensions:
-    ForagerBifrostFileExtension: SilverStripe\ForagerBifrost\Extensions\FileExtension
-
 SilverStripe\AssetAdmin\Forms\FileFormFactory:
   extensions:
     ForagerBifrostFileFormExtension: SilverStripe\ForagerBifrost\Extensions\FileFormExtension

src/Extensions/FileExtension.php

@@ -7,8 +7,6 @@
 use SilverStripe\Assets\Image;
 use SilverStripe\Core\Convert;
 use SilverStripe\Core\Extension;
-use SilverStripe\Core\Injector\Injector;
-use SilverStripe\Forager\Extensions\SearchServiceExtension;
 use SilverStripe\ForagerBifrost\Constants\SearchFile;
 
 /**
@@ -35,12 +33,6 @@ class FileExtension extends Extension
      */
     public function updateSearchAttributes(array &$attributes = []): void
     {
-        $fileClass = Injector::inst()->get(File::class);
-
-        if (!$fileClass->hasExtension(SearchServiceExtension::class)) {
-            return;
-        }
-
         if (!isset($attributes['_attachment'])) {
             return;
         }
@@ -68,12 +60,6 @@ public function getBase64String(): ?string
 
     public function onBeforeWrite(): void
     {
-        $fileClass = Injector::inst()->get(File::class);
-
-        if (!$fileClass->hasExtension(SearchServiceExtension::class)) {
-            return;
-        }
-
         $file = $this->getOwner();
 
         // Marks images and folders with zero content to exclude them from report generation

src/Extensions/FileFormExtension.php

@@ -7,7 +7,6 @@
 use SilverStripe\Control\RequestHandler;
 use SilverStripe\Core\Extension;
 use SilverStripe\Core\Injector\Injector;
-use SilverStripe\Forager\Extensions\SearchServiceExtension;
 use SilverStripe\ForagerBifrost\Constants\SearchFile;
 use SilverStripe\Forms\FieldList;
 use SilverStripe\Forms\Form;
@@ -31,7 +30,7 @@ public function updateForm(
     ): void {
         $fileClass = Injector::inst()->get(File::class);
 
-        if (!$fileClass->hasExtension(SearchServiceExtension::class)) {
+        if (!$fileClass->hasExtension(FileExtension::class)) {
             return;
         }
 

src/Reports/LargeDocumentReport.php

@@ -4,8 +4,8 @@
 
 use SilverStripe\Assets\File;
 use SilverStripe\Core\Injector\Injector;
-use SilverStripe\Forager\Extensions\SearchServiceExtension;
 use SilverStripe\ForagerBifrost\Constants\SearchFile;
+use SilverStripe\ForagerBifrost\Extensions\FileExtension;
 use SilverStripe\Model\List\SS_List;
 use SilverStripe\Reports\Report;
 
@@ -24,7 +24,7 @@ class LargeDocumentReport extends Report
     public function description(): string
     {
         if (!$this->isReportActive()) {
-            return 'This report requires the SearchServiceExtension being applied to Files.';
+            return 'This report requires the FileExtension being applied to Files.';
         }
 
         return sprintf(
@@ -65,7 +65,7 @@ private function isReportActive(): bool
     {
         $fileClass = Injector::inst()->get(File::class);
 
-        return $fileClass->has_extension(SearchServiceExtension::class);
+        return $fileClass->has_extension(FileExtension::class);
     }
 
 }

tests/Extensions/FileExtensionTest.php

@@ -5,7 +5,6 @@
 use SilverStripe\Assets\Dev\TestAssetStore;
 use SilverStripe\Assets\File;
 use SilverStripe\Assets\Folder;
-use SilverStripe\Core\Environment;
 use SilverStripe\Dev\SapphireTest;
 use SilverStripe\Forager\Extensions\SearchServiceExtension;
 use SilverStripe\ForagerBifrost\Extensions\FileExtension;

tests/Reports/LargeDocumentReportTest.php

@@ -4,7 +4,6 @@
 
 use SilverStripe\Assets\Dev\TestAssetStore;
 use SilverStripe\Assets\File;
-use SilverStripe\Core\Environment;
 use SilverStripe\Dev\SapphireTest;
 use SilverStripe\Forager\Extensions\SearchServiceExtension;
 use SilverStripe\ForagerBifrost\Extensions\FileExtension;
@@ -38,7 +37,7 @@ public function testDescription(): void
         // Removing extension should result in a new description
         $this->removeFileExtension();
         $this->assertEquals(
-            'This report requires the SearchServiceExtension being applied to Files.',
+            'This report requires the FileExtension being applied to Files.',
             $report->description()
         );
 
@@ -91,7 +90,7 @@ public function testSourceRecords(): void
 
     protected function removeFileExtension(): void
     {
-        File::remove_extension(SearchServiceExtension::class);
+        File::remove_extension(FileExtension::class);
     }
 
     protected function setUp(): void