Merge pull request #66 from silverstripeltd/pulls/cms6-support

Add support for CMS 6

Author: wilr

.github/workflows/ci.yml

@@ -11,3 +11,4 @@ jobs:
     uses: silverstripe/gha-ci/.github/workflows/ci.yml@v1
     with:
       simple_matrix: true
+      endtoend: false

.gitignore

@@ -4,3 +4,4 @@ composer.lock
 /assets
 /public
 .phpunit.result.cache
+app/

composer.json

@@ -13,11 +13,11 @@
     "prefer-stable": true,
     "require": {
         "php": "^8.1",
-        "dnadesign/silverstripe-elemental": "^5",
-        "silverstripe/tagfield": "^3"
+        "dnadesign/silverstripe-elemental": "^6",
+        "silverstripe/tagfield": "^4"
     },
     "require-dev": {
-        "silverstripe/recipe-testing": "^3",
+        "silverstripe/recipe-testing": "^4",
         "squizlabs/php_codesniffer": "^3.0"
     },
     "extra": {

phpunit.xml.dist

@@ -1,14 +1,14 @@
 <?xml version="1.0"?>
-<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" bootstrap="vendor/silverstripe/framework/tests/bootstrap.php" colors="true" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd">
-    <coverage includeUncoveredFiles="true">
-        <include>
-            <directory suffix=".php">src/</directory>
-        </include>
-        <exclude>
-            <directory suffix=".php">tests/php</directory>
-        </exclude>
-    </coverage>
-    <testsuite name="Default">
-        <directory>tests/php</directory>
-    </testsuite>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" bootstrap="vendor/silverstripe/cms/tests/bootstrap.php" colors="true" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/11.5/phpunit.xsd">
+  <testsuite name="Default">
+    <directory>tests/php</directory>
+  </testsuite>
+  <source>
+    <include>
+      <directory suffix=".php">src/</directory>
+    </include>
+    <exclude>
+      <directory suffix=".php">tests/php</directory>
+    </exclude>
+  </source>
 </phpunit>

src/Extension/BaseElementExtension.php

@@ -16,13 +16,13 @@
 use SilverStripe\Forms\GridField\GridFieldDetailForm;
 use SilverStripe\Forms\LiteralField;
 use SilverStripe\Forms\ReadonlyField;
-use SilverStripe\ORM\ArrayList;
-use SilverStripe\ORM\DataExtension;
+use SilverStripe\Model\List\ArrayList;
+use SilverStripe\Core\Extension;
 use SilverStripe\ORM\DB;
 use SilverStripe\ORM\FieldType\DBHTMLText;
 use SilverStripe\Versioned\Versioned;
 
-class BaseElementExtension extends DataExtension
+class BaseElementExtension extends Extension
 {
     /**
      * @config
@@ -54,7 +54,7 @@ public function populateDefaults()
     }
 
 
-    public function requireDefaultRecords()
+    public function onRequireDefaultRecords(): void
     {
         $update = BaseElement::get()->filter([
             'VirtualLookupTitle' => [null, ''],
@@ -179,7 +179,7 @@ public function updateCMSFields(FieldList $fields)
 
                 if ($ownerPage = $this->owner->getPage()) {
                     if ($ownerPage->hasMethod('CMSEditLink')) {
-                        $link = $ownerPage->canEdit() ? $ownerPage->CMSEditLink() : $ownerPage->Link();
+                        $link = $ownerPage->canEdit() ? $ownerPage->getCMSEditLink() : $ownerPage->Link();
                     } else {
                         $link = $ownerPage->Link();
                     }
@@ -344,7 +344,7 @@ public function UsageSummary()
         $arr = [];
         foreach ($usage as $page) {
             $type = ($page->ElementType) ? sprintf("<em> - %s</em>", $page->ElementType) : null;
-            $arr[] = sprintf("<a href=\"%s\" target=\"blank\">%s</a> %s", $page->CMSEditLink(), $page->Title, $type);
+            $arr[] = sprintf("<a href=\"%s\" target=\"blank\">%s</a> %s", $page->getCMSEditLink(), $page->Title, $type);
         }
         $html = DBHTMLText::create('UsageSummary');
         $html->setValue(implode('<br>', $arr));

src/Model/ElementVirtual.php

@@ -26,7 +26,7 @@ class ElementVirtual extends BaseElement
     /**
      * @var string
      */
-    private static $description = 'Reused element';
+    private static $class_description = 'Reused element';
 
     private static $table_name = 'ElementVirtual';
 
@@ -166,15 +166,13 @@ public function getTitle()
 
     /**
      * Override to render template based on LinkedElement
-     *
-     * @return string|null HTML
      */
-    public function forTemplate($holder = true)
+    public function forTemplate($holder = true): string
     {
         if ($linked = $this->LinkedElement()) {
             return $linked->forTemplate($holder);
         }
-        return null;
+        return '';
     }
 
     protected function provideBlockSchema()

src/Tasks/ResetGloballyEnabledElements.php

@@ -7,14 +7,20 @@
 use SilverStripe\Core\ClassInfo;
 use SilverStripe\Core\Config\Config;
 use SilverStripe\ORM\DB;
+use SilverStripe\PolyExecution\PolyOutput;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
 
 class ResetGloballyEnabledElements extends BuildTask
 {
-    protected $title = 'Reset Globally Enabled elements';
+    protected static string $commandName = 'elemental:virtual:reset-globally-enabled';
 
-    protected $description = 'Reset individual elements \'AvailableGlobally\' setting via the YAML config';
+    protected string $title = 'Reset Globally Enabled elements';
 
-    public function run($request)
+    protected static string $description = "Reset individual elements 'AvailableGlobally' setting via the YAML config";
+
+    protected function execute(InputInterface $input, PolyOutput $output): int
     {
         // get all classes of BaseElement
         $elementClasses = ClassInfo::subclassesFor(BaseElement::class);
@@ -35,5 +41,7 @@ public function run($request)
                 DB::query("UPDATE Element_Versions SET AvailableGlobally = $isGlobal WHERE RecordID IN ('$idStr')");
             }
         }
+
+        return Command::SUCCESS;
     }
 }

tests/Src/TestElement.php

@@ -8,15 +8,13 @@
 
 class TestElement extends BaseElement implements TestOnly
 {
-    private static $table_name = 'TestElement';
+    private static string $table_name = 'VTestElement';
 
-    private static $db = [
+    private static array $db = [
         'TestValue' => 'Text',
     ];
 
-    private static $controller_class = TestElementController::class;
-
-    public function getType()
+    public function getType(): string
     {
         return 'A test element';
     }
@@ -29,4 +27,11 @@ public function canView($member = null)
         }
         return parent::canView($member);
     }
+
+    public function getRenderTemplates($suffix = '')
+    {
+        return [
+            __DIR__ . '/TestElement.ss'
+        ];
+    }
 }

tests/Src/TestElement.ss

@@ -0,0 +1 @@
+$Title ($TestValue)

tests/Src/TestPage.php

@@ -7,5 +7,5 @@
 
 class TestPage extends SiteTree implements TestOnly
 {
-    private static $table_name = 'TestElementalPage';
+    private static $table_name = 'VTestElementalPage';
 }