feat: psr-4 and psr-12 (#45)

* feat: psr-4 and psr-12

fix: restored ss5 compatible queued jobs

fix: restored ss5 compatibility

fix: removed duplicate class import

fix: imported new searchindex full class name

fix: imported new tntsearchhelper full class name

* fix: replaced non-existent param with return tag

.gitattributes

@@ -1,6 +1,8 @@
+/.github          export-ignore
 /tests            export-ignore
 /client/src       export-ignore
 /.gitattributes   export-ignore
 /.travis.yml      export-ignore
 /.scrutinizer.yml export-ignore
-/.github          export-ignore
+/doctum*          export-ignore
+

.gitignore

@@ -1 +1,6 @@
+composer.lock
+doctum_build
+doctum_cache
 gh-payload.json
+vendor
+

composer.json

@@ -12,6 +12,9 @@
     "ext-sqlite3": "*",
     "symbiote/silverstripe-queuedjobs": "^4.12 || ^5.1"
   },
+  "require-dev": {
+    "code-lts/doctum": "^5.5"
+  },
   "autoload": {
     "psr-4": {
       "Werkbot\\Search\\": "src/"

doctum.config.php

@@ -0,0 +1,8 @@
+<?php
+
+return new Doctum\Doctum(__DIR__ . '/src', [
+    'title' => 'Werkbot Search',
+    'build_dir' => __DIR__.'/doctum_build',
+    'cache_dir' => __DIR__.'/doctum_cache',
+]);
+

src/DatabaseAdminExtension.php

@@ -4,6 +4,7 @@
 
 use SilverStripe\Control\Controller;
 use SilverStripe\ORM\DataExtension;
+use Werkbot\Search\Tasks\SearchIndex;
 
 class DatabaseAdminExtension extends DataExtension
 {

src/Helpers/TNTSearchHelper.php

@@ -1,11 +1,10 @@
 <?php
 
-namespace Werkbot\Search;
+namespace Werkbot\Search\Helpers;
 
 use TeamTNT\TNTSearch\TNTSearch;
 use SilverStripe\Core\Environment;
 
-/**/
 class TNTSearchHelper
 {
   /*
@@ -58,3 +57,4 @@ public function getTNTSearchIndex($create = false)
       return $indexer;
   }
 }
+

src/Jobs/RemoveSearchQueriesJob.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Werkbot\Search;
+namespace Werkbot\Search\Jobs;
 
 use SilverStripe\Core\Config\Configurable;
 use Symbiote\QueuedJobs\Services\AbstractQueuedJob;
@@ -68,3 +68,4 @@ public function afterComplete()
     QueuedJobService::singleton()->queueJob(new RemoveSearchQueriesJob(), date('Y-m-d', strtotime($queueNextRun)));
   }
 }
+

src/SearchControllerExtension.php

@@ -2,21 +2,21 @@
 
 namespace Werkbot\Search;
 
-use SilverStripe\ORM\ArrayList;
+use SilverStripe\CMS\Search\SearchForm;
+use SilverStripe\Control\HTTPRequest;
 use SilverStripe\Core\ClassInfo;
 use SilverStripe\Forms\FieldList;
-use SilverStripe\Forms\TextField;
 use SilverStripe\Forms\FormAction;
+use SilverStripe\Forms\RequiredFields;
+use SilverStripe\Forms\TextField;
+use SilverStripe\ORM\ArrayList;
 use SilverStripe\ORM\DataExtension;
+use SilverStripe\ORM\FieldType\DBField;
 use SilverStripe\ORM\PaginatedList;
-use Werkbot\Search\TNTSearchHelper;
-use SilverStripe\Control\HTTPRequest;
-use SilverStripe\Forms\RequiredFields;
 use SilverStripe\ORM\ValidationResult;
-use SilverStripe\CMS\Search\SearchForm;
-use SilverStripe\ORM\FieldType\DBField;
 use SilverStripe\SiteConfig\SiteConfig;
 use TeamTNT\TNTSearch\Exceptions\IndexNotFoundException;
+use Werkbot\Search\Helpers\TNTSearchHelper;
 
 class SearchControllerExtension extends DataExtension
 {
@@ -66,9 +66,9 @@ public function SiteSearchForm()
   /**
    * Process and render search results.
    *
-   * @param array $data The raw request data submitted by user
+   * @param array $searchdata The raw request data submitted by user
    * @param SiteSearchForm $form The form instance that was submitted
-   * @param HTTPRequest $request Request generated for this action
+   * @return string - Rendered search results HTML
    **/
   public function SiteSearchFormResults($searchdata, $form)
   {

src/SearchQueries/CustomeSideReport_SearchQuery.php → src/SearchQueries/CustomSideReport_SearchQuery.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Werkbot\Search;
+namespace Werkbot\Search\SearchQueries;
 
 use SilverStripe\ORM\DB;
 use SilverStripe\ORM\ArrayList;
@@ -109,3 +109,4 @@ public function parameterFields()
     );
   }
 }
+

src/SearchQueries/SearchQuery.php

@@ -1,16 +1,17 @@
 <?php
 
-namespace Werkbot\Search;
+namespace Werkbot\Search\SearchQueries;
 
 use SilverStripe\ORM\DataObject;
 
-class SearchQuery extends DataObject 
+class SearchQuery extends DataObject
 {
   private static $singular_name = 'Search Query';
   private static $plural_name = 'Search Queries';
   private static $table_name = 'SearchQuery';
-  
+
   private static $db = [
     'Query' => 'Text',
   ];
 }
+

src/SearchableExtension.php

@@ -2,24 +2,25 @@
 
 namespace Werkbot\Search;
 
-use SilverStripe\Forms\Tab;
-use SilverStripe\Forms\TabSet;
 use SilverStripe\Core\ClassInfo;
-use SilverStripe\ORM\DataObject;
-use SilverStripe\Forms\FieldList;
-use SilverStripe\Forms\TextField;
-use SilverStripe\Forms\FieldGroup;
-use SilverStripe\ORM\DataExtension;
 use SilverStripe\Forms\CheckboxField;
-use SilverStripe\Versioned\Versioned;
+use SilverStripe\Forms\FieldGroup;
+use SilverStripe\Forms\FieldList;
 use SilverStripe\Forms\GridField\GridField;
-use SilverStripe\Forms\GridField\GridFieldConfig;
 use SilverStripe\Forms\GridField\GridFieldButtonRow;
+use SilverStripe\Forms\GridField\GridFieldConfig;
 use SilverStripe\Forms\GridField\GridFieldDeleteAction;
 use SilverStripe\Forms\GridField\GridFieldToolbarHeader;
-use Symbiote\GridFieldExtensions\GridFieldOrderableRows;
-use Symbiote\GridFieldExtensions\GridFieldEditableColumns;
+use SilverStripe\Forms\Tab;
+use SilverStripe\Forms\TabSet;
+use SilverStripe\Forms\TextField;
+use SilverStripe\ORM\DataExtension;
+use SilverStripe\ORM\DataObject;
+use SilverStripe\Versioned\Versioned;
 use Symbiote\GridFieldExtensions\GridFieldAddNewInlineButton;
+use Symbiote\GridFieldExtensions\GridFieldEditableColumns;
+use Symbiote\GridFieldExtensions\GridFieldOrderableRows;
+use Werkbot\Search\Helpers\TNTSearchHelper;
 
 class SearchableExtension extends DataExtension
 {
@@ -42,6 +43,7 @@ class SearchableExtension extends DataExtension
     "getSearchableTitle" => "Text",
     "getSearchableSummary" => 'HTMLText',
   ];
+
   /**
    * updateCMSFields
    * Adds the SearchTerms GridField to the CMS tab
@@ -113,7 +115,7 @@ public function addSearchSettingFields(FieldList &$fields)
    * getIndexQuery
    * This query is used when building the index
    *
-   * @return string/boolean - FALSE if not set
+   * @return string|boolean - FALSE if not set
    * Example:
       SELECT
         concat(\"Page_\", SiteTree.ID) AS ID,
@@ -148,6 +150,7 @@ public function getSearchableID()
   {
     return $this->owner->ClassName . "_" . $this->owner->ID;
   }
+
   /**
    * getSearchableTitle
    * Returns the title, to be used in search results
@@ -163,6 +166,7 @@ public function getSearchableTitle()
       return $this->owner->Title;
     }
   }
+
   /**
    * getSearchableTitleColumnName
    * Returns the name of the Title Column, "Title" is returned if the
@@ -177,6 +181,7 @@ public function getSearchableTitleColumnName()
       return "Title";
     }
   }
+
   /**
    * getSearchableSummary
    * Returns the content to be used in search results
@@ -197,6 +202,7 @@ public function getSearchableSummary()
 
     return $content;
   }
+
   /**
    * getSearchableContent
    * Returns the content to be used when indexing this record
@@ -221,6 +227,7 @@ public function getSearchableContent()
 
     return $content;
   }
+
   /**
    * getSearchableSummaryColumnName
    * Returns the name of the Summary Column, "Content" is returned if the
@@ -235,6 +242,7 @@ public function getSearchableSummaryColumnName()
       return "Content";
     }
   }
+
   /**
    * insertIndex
    *
@@ -255,6 +263,7 @@ public function insertIndex()
       'Content' => $content,
     ]);
   }
+
   /**
    * updateIndex
    *
@@ -278,6 +287,7 @@ public function updateIndex()
       ]
     );
   }
+
   /**
    * deleteIndex
    *
@@ -288,6 +298,7 @@ public function deleteIndex()
     $index = TNTSearchHelper::Instance()->getTNTSearchIndex();
     $index->delete(ClassInfo::shortName($this->owner->ClassName) . "_" . $this->owner->ID);
   }
+
   /**
    * onBeforeWrite
    *
@@ -302,6 +313,7 @@ public function onBeforeWrite()
     }
     parent::onBeforeWrite();
   }
+
   /**
    * onAfterWrite
    *
@@ -314,6 +326,7 @@ public function onAfterWrite()
     }
     parent::onAfterWrite();
   }
+
   /**
    * onBeforePublish
    *
@@ -325,6 +338,7 @@ public function onBeforePublish()
       $this->owner->insertIndex();
     }
   }
+
   /**
    * onAfterPublish
    *
@@ -334,6 +348,7 @@ public function onAfterPublish()
   {
     $this->owner->updateIndex();
   }
+
   /**
    * onAfterUnpublish
    *
@@ -343,13 +358,16 @@ public function onAfterUnpublish()
   {
     $this->owner->deleteIndex();
   }
+
   /**
    * onAfterDelete
    *
    * @return void
    **/
   public function onAfterDelete()
   {
-    $this->owner->deleteIndex();
+      $this->owner->deleteIndex();
   }
+
 }
+

src/Tasks/SearchIndex.php

@@ -1,11 +1,11 @@
 <?php
 
-namespace Werkbot\Search;
+namespace Werkbot\Search\Tasks;
 
 use SilverStripe\Core\ClassInfo;
 use SilverStripe\Dev\BuildTask;
 use SilverStripe\ORM\DB;
-use Werkbot\Search\TNTSearchHelper;
+use Werkbot\Search\Helpers\TNTSearchHelper;
 
 class SearchIndex extends BuildTask
 {