Move to Silverstripe 6 (#9)

* Move to Silverstripe 6

* Compatibility

* Compatibility

* ✨ feat: add further cms6 updates

---------

Co-authored-by: Julian Thomson <julian.thomson@Julian-M4.local>
Co-authored-by: Cameron Bryers <12287346+Cambis@users.noreply.github.com>

Author: 3 people

.gitattributes

@@ -0,0 +1,13 @@
+# IDE
+.editorconfig export-ignore
+
+# Git
+.gitattributes export-ignore
+.gitignore export-ignore
+.github export-ignore
+
+# Coding standards
+ecs.php export-ignore
+phpstan.neon.dist export-ignore
+phpstan-baseline.neon export-ignore
+rector.php export-ignore

.gitignore

@@ -0,0 +1,22 @@
+# OS
+.DS_Store
+
+# IDE
+.idea
+.vscode
+
+# Silverstripe
+public/
+app/
+
+# Dependencies
+node_modules/
+vendor/
+composer.lock
+yarn-error.log
+yarn.lock
+pnpm-lock.yaml
+
+# Tests
+.phpunit.result.cache
+coverage/

_config.php

@@ -4,4 +4,4 @@
 use SilverStripe\Taxonomy\TaxonomyAdmin;
 
 // Remove 
-CMSMenu::remove_menu_class(TaxonomyAdmin::class);
+CMSMenu::remove_menu_class(TaxonomyAdmin::class); // @phpstan-ignore class.notFound

composer.json

@@ -9,9 +9,17 @@
     ],
     "license": "MIT",
     "require": {
-        "silverstripe/framework": "^4.0 || ^5.0",
-        "silverstripe/vendor-plugin": "^1.0 || ^2.0",
-        "symbiote/silverstripe-gridfieldextensions": "^3.2 || ^4.0"
+        "php": "^8.3",
+        "silverstripe/admin": "^3.0",
+        "silverstripe/framework": "^6.0",
+        "symbiote/silverstripe-gridfieldextensions": "^5.0"
+    },
+    "require-dev": {
+        "cambis/silverstan": "^2.1",
+        "cambis/silverstripe-rector": "^2.1",
+        "phpstan/extension-installer": "^1.4",
+        "phpstan/phpstan": "^2.1",
+        "rector/rector": "^2.3"
     },
     "autoload": {
         "psr-4": {
@@ -20,5 +28,13 @@
     },
     "extra": {
         "installer-name": "silverstripe-tagurit"
+    },
+    "config": {
+        "allow-plugins": {
+            "composer/installers": true,
+            "phpstan/extension-installer": true,
+            "silverstripe/vendor-plugin": true
+        },
+        "sort-packages": true
     }
 }

phpstan.neon.dist

@@ -0,0 +1,8 @@
+includes:
+  - vendor/cambis/silverstan/bleedingEdge.neon
+parameters:
+  level: 5
+  treatPhpDocTypesAsCertain: false
+  paths:
+    - _config.php
+    - src

rector.php

@@ -0,0 +1,44 @@
+<?php
+
+declare(strict_types=1);
+
+use Cambis\SilverstripeRector\Set\ValueObject\SilverstripeLevelSetList;
+use Cambis\SilverstripeRector\Set\ValueObject\SilverstripeSetList;
+use Cambis\SilverstripeRector\Silverstripe413\Rector\Class_\AddBelongsToPropertyAndMethodAnnotationsToDataObjectRector;
+use Cambis\SilverstripeRector\Silverstripe413\Rector\Class_\AddDBFieldPropertyAnnotationsToDataObjectRector;
+use Cambis\SilverstripeRector\Silverstripe413\Rector\Class_\AddExtensionMixinAnnotationsToExtensibleRector;
+use Cambis\SilverstripeRector\Silverstripe413\Rector\Class_\AddHasOnePropertyAndMethodAnnotationsToDataObjectRector;
+use Cambis\SilverstripeRector\Silverstripe52\Rector\Class_\AddBelongsManyManyMethodAnnotationsToDataObjectRector;
+use Cambis\SilverstripeRector\Silverstripe52\Rector\Class_\AddExtendsAnnotationToContentControllerRector;
+use Cambis\SilverstripeRector\Silverstripe52\Rector\Class_\AddExtendsAnnotationToExtensionRector;
+use Cambis\SilverstripeRector\Silverstripe52\Rector\Class_\AddHasManyMethodAnnotationsToDataObjectRector;
+use Cambis\SilverstripeRector\Silverstripe52\Rector\Class_\AddManyManyMethodAnnotationsToDataObjectRector;
+use Rector\Config\RectorConfig;
+use Rector\Php74\Rector\Closure\ClosureToArrowFunctionRector;
+use Rector\Php83\Rector\ClassMethod\AddOverrideAttributeToOverriddenMethodsRector;
+
+return RectorConfig::configure()
+    ->withImportNames(removeUnusedImports: true)
+    ->withPaths([
+        __DIR__ . '/_config.php',
+        __DIR__ . '/src',
+    ])
+    ->withPhpSets()
+    ->withSets([
+        SilverstripeLevelSetList::UP_TO_SILVERSTRIPE_60,
+        SilverstripeSetList::CODE_QUALITY,
+    ])
+    ->withSkip([
+        AddOverrideAttributeToOverriddenMethodsRector::class,
+        ClosureToArrowFunctionRector::class,
+        // Skip the add annotation rectors
+        AddDBFieldPropertyAnnotationsToDataObjectRector::class,
+        AddBelongsToPropertyAndMethodAnnotationsToDataObjectRector::class,
+        AddHasOnePropertyAndMethodAnnotationsToDataObjectRector::class,
+        AddHasManyMethodAnnotationsToDataObjectRector::class,
+        AddBelongsManyManyMethodAnnotationsToDataObjectRector::class,
+        AddManyManyMethodAnnotationsToDataObjectRector::class,
+        AddExtensionMixinAnnotationsToExtensibleRector::class,
+        AddExtendsAnnotationToContentControllerRector::class,
+        AddExtendsAnnotationToExtensionRector::class,
+    ]);

src/Model/TaxonomyTerm.php

@@ -2,12 +2,24 @@
 
 namespace DNADesign\Tagurit\Model;
 
+use DNADesign\Tagurit\Traits\TaxonomyTrait;
+use Override;
+use SilverStripe\Forms\DropdownField;
+use SilverStripe\Forms\FieldList;
+use SilverStripe\Forms\FormField;
+use SilverStripe\Forms\GridField\GridField;
+use SilverStripe\Forms\GridField\GridFieldAddExistingAutocompleter;
+use SilverStripe\Forms\GridField\GridFieldConfig_RecordEditor;
+use SilverStripe\Forms\GridField\GridFieldDeleteAction;
+use SilverStripe\Forms\ListboxField;
 use SilverStripe\ORM\DataObject;
+use SilverStripe\Security\Permission;
 use SilverStripe\ORM\FieldType\DBField;
 use SilverStripe\ORM\FieldType\DBHTMLText;
-use SilverStripe\ORM\ValidationResult;
-use SilverStripe\Security\Permission;
 use SilverStripe\Security\PermissionProvider;
+use SilverStripe\Core\Validation\ValidationResult;
+use Symbiote\GridFieldExtensions\GridFieldOrderableRows;
+use Symfony\Component\String\Inflector\EnglishInflector;
 
 /**
  * Represents a single taxonomy term. Can be re-ordered in the CMS, and the default sorting is to use the order as
@@ -21,19 +33,21 @@
  */
 class TaxonomyTerm extends DataObject implements PermissionProvider
 {
+    use TaxonomyTrait;
+
     private static $singular_name = 'Term';
 
     private static $table_name = 'TaxonomyTerm';
 
-    private static $db = array(
+    private static $db = [
         'Name' => 'Varchar(255)',
         'Sort' => 'Int',
         'Protected' => 'Boolean'
-    );
+    ];
 
-    private static $has_one = array(
+    private static $has_one = [
         'Type' => TaxonomyType::class
-    );
+    ];
 
     private static $summary_fields = [
         'Title' => 'Title',
@@ -42,21 +56,23 @@ class TaxonomyTerm extends DataObject implements PermissionProvider
 
     private static $default_sort = 'Sort';
 
-    public function getCMSFields()
-    {
-        $fields = parent::getCMSFields();
-
-        $fields->removeByName([
-            'Protected',
+    private static array $scaffold_cms_fields_settings = [
+        'ignoreFields' => [
             'Sort',
-            'TypeID'
-        ]);
+            'Type',
+            'Protected',
+        ],
+    ];
 
-        if ($this->isInDB() && $this->Protected > 0) {
-            $fields->dataFieldByName('Name')->setReadonly(true);
-        }
+    public function getCMSFields(): FieldList
+    {
+        $this->beforeUpdateCMSFields(function (FieldList $fields): void {
+            if ($this->isInDB() && $this->Protected > 0) {
+                $fields->dataFieldByName('Name')?->setReadonly(true);
+            }
+        });
 
-        return $fields;
+        return parent::getCMSFields();
     }
 
     public function getIsProtected()
@@ -70,7 +86,7 @@ public function getIsProtected()
         return DBField::create_field(DBHTMLText::class, $label);
     }
 
-    public function validate()
+    public function validate(): ValidationResult
     {
         $result = ValidationResult::create();
 
@@ -119,7 +135,7 @@ public function canDelete($member = null)
         return Permission::check('TAXONOMYTERM_DELETE');
     }
 
-    public function canCreate($member = null, $context = array())
+    public function canCreate($member = null, $context = [])
     {
         $extended = $this->extendedCan(__FUNCTION__, $member);
         if ($extended !== null) {
@@ -131,37 +147,80 @@ public function canCreate($member = null, $context = array())
 
     public function providePermissions()
     {
-        return array(
-            'TAXONOMYTERM_EDIT' => array(
+        return [
+            'TAXONOMYTERM_EDIT' => [
                 'name' => _t(
-                    __CLASS__ . '.EditPermissionLabel',
+                    self::class . '.EditPermissionLabel',
                     'Edit a taxonomy term'
                 ),
                 'category' => _t(
-                    __CLASS__ . '.Category',
+                    self::class . '.Category',
                     'Taxonomy terms'
                 ),
-            ),
-            'TAXONOMYTERM_DELETE' => array(
+            ],
+            'TAXONOMYTERM_DELETE' => [
                 'name' => _t(
-                    __CLASS__ . '.DeletePermissionLabel',
+                    self::class . '.DeletePermissionLabel',
                     'Delete a taxonomy term and all nested terms'
                 ),
                 'category' => _t(
-                    __CLASS__ . '.Category',
+                    self::class . '.Category',
                     'Taxonomy terms'
                 ),
-            ),
-            'TAXONOMYTERM_CREATE' => array(
+            ],
+            'TAXONOMYTERM_CREATE' => [
                 'name' => _t(
-                    __CLASS__ . '.CreatePermissionLabel',
+                    self::class . '.CreatePermissionLabel',
                     'Create a taxonomy term'
                 ),
                 'category' => _t(
-                    __CLASS__ . '.Category',
+                    self::class . '.Category',
                     'Taxonomy terms'
                 ),
-            )
+            ]
+        ];
+    }
+
+    #[Override]
+    public function scaffoldFormFieldForHasOne(string $fieldName, ?string $fieldTitle, string $relationName, DataObject $ownerRecord): FormField
+    {
+        return DropdownField::create(
+            $relationName,
+            $fieldTitle,
+            $this->getTermsForType($fieldTitle ?? $fieldName)->map()
+        );
+    }
+
+    #[Override]
+    public function scaffoldFormFieldForHasMany(string $relationName, ?string $fieldTitle, DataObject $ownerRecord, bool &$includeInOwnTab): FormField
+    {
+        $includeInOwnTab = true;
+
+        return GridField::create(
+            $relationName,
+            $fieldTitle,
+            $ownerRecord->$relationName(),
+            GridFieldConfig_RecordEditor::create()
+                ->addComponent(GridFieldOrderableRows::create('Sort'))
+                ->removeComponentsByType([
+                    GridFieldDeleteAction::class,
+                    GridFieldAddExistingAutocompleter::class
+                ])
+        );
+    }
+
+    #[Override]
+    public function scaffoldFormFieldForManyMany(string $relationName, ?string $fieldTitle, DataObject $ownerRecord, bool &$includeInOwnTab): FormField
+    {
+        $includeInOwnTab = true;
+
+        // Term names are usually singular forms of the relation name
+        $termName = (new EnglishInflector())->singularize($fieldTitle ?? $relationName)[0];
+
+        return ListboxField::create(
+            $relationName,
+            $fieldTitle,
+            $this->getTermsForType($termName) // @phpstan-ignore argument.type
         );
     }
 }