Merge pull request #11 from venveo/develop

4.0
venveo · Jul 25, 2022 · 8b9a089 · 8b9a089
2 parents 9008237 + 6459d3a
commit 8b9a089
Show file tree

Hide file tree

Showing 9 changed files with 312 additions and 103 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,14 @@
 # Document Search Changelog
 
+## 4.0.0 - 2022/07/24
+
+### Added
+- Added support for MS Office Documents. (.doc, .docx, .xlsx, .pptx, .txt)
+
+### Changed
+- Volume settings now store the volume uuid instead of ID - **ensure sure you update your settings**
+- Document Search now requires Craft 4
+
 ## 1.0.3 - 2020-10-27
 ### Fixed
 - Fix environment variable for pdftotext path not working (#5)

diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# Document Search plugin for Craft CMS 3.1
+# Document Search plugin for Craft CMS 4
 Extracts keywords and phrases from PDF documents and adds them to Craft CMS' native search index.
 
 **NOTE:** 

diff --git a/composer.json b/composer.json
@@ -2,7 +2,7 @@
     "name": "venveo/craft-documentsearch",
     "description": "Extract the contents of text documents and add to Craft's search index",
     "type": "craft-plugin",
-    "version": "1.0.3",
+    "version": "4.0.0",
     "keywords": [
         "craft",
         "cms",
@@ -22,7 +22,11 @@
         }
     ],
     "require": {
-        "craftcms/cms": "^3.1.0",
+        "php": "^8.0.2|^9.0",
+        "ext-zip": "*",
+        "ext-dom": "*",
+        "ext-libxml": "*",
+        "craftcms/cms": "^4.0.0",
         "spatie/pdf-to-text": "^1.1",
         "yooper/php-text-analysis": "^1.4",
         "voku/stop-words": "^2.0"

diff --git a/src/DocumentSearch.php b/src/DocumentSearch.php
@@ -16,6 +16,7 @@
 use craft\elements\Asset;
 use craft\events\DefineBehaviorsEvent;
 use craft\events\RegisterElementSearchableAttributesEvent;
+use craft\helpers\App;
 use venveo\documentsearch\behaviors\AssetContentBehavior;
 use venveo\documentsearch\models\Settings;
 use venveo\documentsearch\services\DocumentContentService;
@@ -34,18 +35,13 @@
  */
 class DocumentSearch extends Plugin
 {
-    /**
-     * @var DocumentSearch
-     */
-    public static $plugin;
 
     /**
      * @inheritdoc
      */
     public function init()
     {
         parent::init();
-        self::$plugin = $this;
 
         if (Craft::$app instanceof ConsoleApplication) {
             $this->controllerNamespace = 'venveo\documentsearch\console\controllers';
@@ -70,22 +66,22 @@ function(DefineBehaviorsEvent $event) {
     /**
      * @inheritdoc
      */
-    protected function createSettingsModel()
+    protected function createSettingsModel(): ?\craft\base\Model
     {
         return new Settings();
     }
 
     /**
      * @inheritdoc
      */
-    protected function settingsHtml(): string
+    protected function settingsHtml(): ?string
     {
         return Craft::$app->view->renderTemplate(
             'document-search/settings',
             [
                 'settings' => $this->getSettings(),
                 'binaries' => [
-                    'pdftotext' => is_file(Craft::parseEnv($this->getSettings()->pdfToTextExecutable))
+                    'pdftotext' => is_file(App::parseEnv($this->getSettings()->pdfToTextExecutable))
                 ]
             ]
         );

diff --git a/src/behaviors/AssetContentBehavior.php b/src/behaviors/AssetContentBehavior.php
@@ -22,6 +22,6 @@ public function getContentKeywords()
     {
         /** @var Asset $asset */
         $asset = $this->owner;
-        return Plugin::$plugin->documentContent->getAssetContentKeywords($asset);
+        return Plugin::getInstance()->documentContent->getAssetContentKeywords($asset);
     }
 }
diff --git a/src/console/controllers/ParseDocumentsController.php b/src/console/controllers/ParseDocumentsController.php
@@ -32,7 +32,7 @@ class ParseDocumentsController extends Controller
      */
     public function actionIndexAll()
     {
-        $volumes = Plugin::$plugin->getSettings()['indexVolumes'];
+        $volumes = Plugin::getInstance()->getSettings()['indexVolumes'];
 
         /** @var Asset $asset */
         $volumeCount = 0;
@@ -45,7 +45,7 @@ public function actionIndexAll()
             Console::startProgress(0, count($assets));
             foreach ($assets as $i => $asset) {
                 try {
-                    Plugin::$plugin->documentContent->getAssetContentKeywords($asset);
+                    Plugin::getInstance()->documentContent->getAssetContentKeywords($asset);
                 } catch (\Exception $e) {
 //                    $this->stdout('Skipped a file - error: '. $asset->id . PHP_EOL);
                     Craft::warning('Skipped a file - error: '.$asset->id, 'document-search');

diff --git a/src/models/Settings.php b/src/models/Settings.php
@@ -20,12 +20,12 @@
  */
 class Settings extends Model
 {
-    public $pdfToTextExecutable = '/usr/local/bin/pdftotext';
-    public $maximumDocumentSize = 1024 * 4;
-    public $indexVolumes = [];
+    public ?string $pdfToTextExecutable = '/usr/local/bin/pdftotext';
+    public int $maximumDocumentSize = 1024 * 4;
+    public array $indexVolumes = [];
 
 
-    public function behaviors()
+    public function behaviors(): array
     {
         $behaviors = parent::behaviors();
         $behaviors['parser'] = [
@@ -40,7 +40,7 @@ public function behaviors()
     /**
      * @inheritdoc
      */
-    public function rules()
+    public function rules(): array
     {
         return [
             ['pdfToTextExecutable', 'string'],