Upgrade to silverstripe 6 (#5)

* Upgrade to silverstripe 6

* 🐛 fix: don't scaffold MaxAge

Author: Cambis

composer.json

@@ -7,17 +7,29 @@
   ],
   "license": "BSD-3-Clause",
   "require": {
-    "silverstripe/framework": "^4.0 || ^5.0"
+    "php": "^8.3",
+    "silverstripe/framework": "^6.0"
   },
   "config": {
     "allow-plugins": {
       "composer/installers": true,
+      "phpstan/extension-installer": true,
       "silverstripe/vendor-plugin": true
-    }
+    },
+    "sort-packages": true
   },
   "autoload": {
     "psr-4": {
       "DNADesign\\HTTPCacheControl\\": "extensions"
     }
+  },
+  "require-dev": {
+    "cambis/silverstan": "^2.1",
+    "cambis/silverstripe-rector": "^2.1",
+    "phpstan/extension-installer": "^1.4",
+    "phpstan/phpstan": "^2.1",
+    "phpstan/phpstan-deprecation-rules": "^2.0",
+    "rector/rector": "^2.2",
+    "symplify/easy-coding-standard": "^12.6"
   }
 }

ecs.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+use PhpCsFixer\Fixer\Operator\NotOperatorWithSuccessorSpaceFixer;
+use Symplify\EasyCodingStandard\Config\ECSConfig;
+
+return ECSConfig::configure()
+    ->withPaths([
+        __DIR__ . '/extensions',
+    ])
+    ->withPreparedSets(common: true, psr12: true)
+    ->withSkip([
+        NotOperatorWithSuccessorSpaceFixer::class,
+    ]);

extensions/ControllerExtension.php

@@ -2,32 +2,34 @@
 
 namespace DNADesign\HTTPCacheControl;
 
+use SilverStripe\Control\Controller;
 use SilverStripe\Control\Middleware\HTTPCacheControlMiddleware;
-use SilverStripe\Core\Extension;
 use SilverStripe\Core\Config\Config;
+use SilverStripe\Core\Extension;
 
 /**
  * This extension uses the field data "max-age" and sets the max age.
  * This will be applied to the Controller::init function for the controller
  * you add this extension to.
+ *
+ * @extends Extension<Controller>
  */
 class ControllerExtension extends Extension
 {
-
     /**
-     * @var int $cacheAge Max-age seconds to cache for.
+     * Max-age seconds to cache for.
      */
-    private static $cacheAge_default = 120;
+    private static int $cacheAge_default = 120;
 
     /**
      * Called by ContentController::init();
      */
-    public function onBeforeInit()
+    public function onBeforeInit(): void
     {
         $cacheControl = HTTPCacheControlMiddleware::singleton();
 
         if ($this->getDisableCache()) {
-            $cacheControl->disableCache($force = true);
+            $cacheControl->disableCache(true);
         } else {
             $cacheControl
                 ->enableCache($this->getForceCache())
@@ -36,52 +38,52 @@ public function onBeforeInit()
         }
     }
 
-    public function getDisableCache()
+    public function getDisableCache(): bool
     {
-        if ($this->owner->Config()->get('http_cache_disable')) {
+        if ($this->getOwner()->Config()->get('http_cache_disable')) {
             return true;
         }
 
-        if ($this->owner->failover->Config()->get('http_cache_disable')) {
+        if ($this->getOwner()->getFailover()->Config()->get('http_cache_disable')) {
             return true;
         }
 
-        if ($this->owner->failover->MaxAge == '0') {
+        if ($this->getOwner()->getFailover()->MaxAge == '0') {
             return true;
         }
+
+        return false;
     }
 
-    public function getForceCache()
+    public function getForceCache(): bool
     {
-        if ($this->owner->failover->Config()->get('http_cache_force')) {
-            return true;
-        }
+        return $this->getOwner()->getFailover()->Config()->get('http_cache_force') === true;
     }
 
-    public function getCacheAge()
+    public function getCacheAge(): int
     {
-        if ($this->owner->Config()->get('http_cache_disable')) {
+        if ($this->getOwner()->Config()->get('http_cache_disable')) {
             return 0;
         }
 
         /* http_cache_disable can be used on subclasses to override the behaviour */
-        if ($this->owner->failover->Config()->get('http_cache_disable')) {
+        if ($this->getOwner()->getFailover()->Config()->get('http_cache_disable')) {
             return 0;
         }
 
         //any page with forms in its elements shouldnt be cached
-        if ($this->owner->failover->hasExtension('DNADesign\Elemental\Extensions\ElementalPageExtension')) {
-            $area = $this->owner->ElementalArea();
+        if ($this->getOwner()->getFailover()->hasExtension('DNADesign\Elemental\Extensions\ElementalPageExtension')) {
+            $area = $this->getOwner()->ElementalArea(); // @phpstan-ignore-line method.notFound
             $elements = $area->Elements();
 
             foreach ($elements as $element) {
-                /* http_cache_disable can be used on Elements to override the behaviour
-                    this is particularly useful for elements containing forms which
-                    contain a security ID specific to the user
+                // http_cache_disable can be used on Elements to override the behaviour
+                // this is particularly useful for elements containing forms which
+                // contain a security ID specific to the user
+
+                // Another way to approach this and still get decent caching on the page
+                // is to lazy load those elements after the initial page request
 
-                    Another way to approach this and still get decent caching on the page
-                    is to lazy load those elements after the initial page request
-                */
                 if ($element->Config()->get('http_cache_disable')) {
                     return 0;
                 } elseif ($element->ClassName == 'DNADesign\ElementalVirtual\Model\ElementVirtual') {
@@ -92,9 +94,9 @@ public function getCacheAge()
             }
         }
 
-        if ($this->owner->failover->MaxAge != '' && $this->owner->failover->MaxAge != '0') {
-            return (int) ($this->owner->failover->MaxAge * 60);
+        if ($this->getOwner()->getFailover()->MaxAge != '' && $this->getOwner()->getFailover()->MaxAge != '0') {
+            return (int) ($this->getOwner()->getFailover()->MaxAge * 60);
         }
-        return (int) Config::inst()->get('DNADesign\HTTPCacheControl\ControllerExtension', 'cacheAge_default');
+        return (int) Config::inst()->get(self::class, 'cacheAge_default');
     }
 }

extensions/PageExtension.php

@@ -6,39 +6,42 @@
 use SilverStripe\Core\Extension;
 use SilverStripe\Forms\FieldList;
 use SilverStripe\Forms\TextField;
-use SilverStripe\Security\Security;
+use SilverStripe\ORM\DataObject;
 use SilverStripe\Security\Permission;
+use SilverStripe\Security\Security;
 
 /**
  * This extension adds the ability to control the max-age per originator.
  * The configuration option is surfaced to the CMS UI. The extension needs to be added
  * to the object related to the policed controller.
+ *
+ * @property ?string $MaxAge
+ * @extends Extension<DataObject>
  */
 class PageExtension extends Extension
 {
+    private static array $db = [
+        'MaxAge' => 'Varchar(10)',
+    ];
+
+    private static array $scaffold_cms_fields_settings = [
+        'ignoreFields' => [
+            'MaxAge',
+        ],
+    ];
 
-    /**
-     * @var array
-     */
-    private static $db = array(
-        'MaxAge' => 'Varchar(10)'
-    );
-
-    /**
-     * @param  FieldList $fields
-     */
-    public function updateSettingsFields(FieldList $fields)
+    public function updateSettingsFields(FieldList $fields): void
     {
         // Only admins are allowed to modify this.
         $member = Security::getCurrentUser();
         if (!$member || !Permission::checkMember($member, 'ADMIN')) {
             return;
         }
 
-        $default = Config::inst()->get('DNADesign\HTTPCacheControl\ControllerExtension', 'cacheAge_default');
+        $default = Config::inst()->get(ControllerExtension::class, 'cacheAge_default');
 
         /* http_cache_disable can be used on subclasses to override the behaviour */
-        if ($this->owner->Config()->get('http_cache_disable')) {
+        if ($this->getOwner()->Config()->get('http_cache_disable')) {
             $maxAge = TextField::create('MaxAgeOverriden', 'Custom cache timeout [minutes]', 0);
             $maxAge->setDisabled(true);
 

phpstan.neon.dist

@@ -0,0 +1,7 @@
+includes:
+  - vendor/cambis/silverstan/bleedingEdge.neon
+parameters:
+  level: 4
+  paths:
+    - extensions
+  treatPhpDocTypesAsCertain: false

rector.php

@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+use Cambis\SilverstripeRector\Set\ValueObject\SilverstripeLevelSetList;
+use Cambis\SilverstripeRector\Set\ValueObject\SilverstripeSetList;
+use Cambis\SilverstripeRector\Silverstripe52\Rector\Class_\AddExtendsAnnotationToExtensionRector;
+use Rector\Config\RectorConfig;
+
+return RectorConfig::configure()
+    ->withImportNames()
+    ->withPaths([
+        __DIR__ . '/extensions',
+    ])
+    ->withPreparedSets(
+        deadCode: true,
+        typeDeclarations: true
+    )
+    ->withPhpSets()
+    ->withSets([
+        SilverstripeLevelSetList::UP_TO_SILVERSTRIPE_60,
+        SilverstripeSetList::CODE_QUALITY,
+    ])
+    ->withSkip([
+        AddExtendsAnnotationToExtensionRector::class,
+    ]);