API Apply TopPage extensions by default.

_config/config.yml

@@ -24,6 +24,10 @@ SilverStripe\CMS\Controllers\CMSMain:
   extensions:
     - DNADesign\Elemental\Extensions\ElementalCMSMainExtension
 
+SilverStripe\CMS\Model\SiteTree:
+  extensions:
+    topPageSiteTreeExtension: DNADesign\Elemental\TopPage\SiteTreeExtension
+
 SilverStripe\Versioned\VersionedGridFieldItemRequest:
   extensions:
     - 'DNADesign\Elemental\Extensions\GridFieldDetailFormItemRequestExtension'
@@ -35,7 +39,3 @@ Symbiote\GridFieldExtensions\GridFieldAddNewMultiClassHandler:
 SilverStripe\Core\Injector\Injector:
   SilverStripe\CMS\Controllers\CMSSiteTreeFilter_Search:
     class: DNADesign\Elemental\Controllers\ElementSiteTreeFilterSearch
-  SilverStripe\Dev\State\SapphireTestState:
-    properties:
-      States:
-        topPageTestState: '%$DNADesign\Elemental\TopPage\TestState'

docs/en/advanced_setup.md

@@ -380,21 +380,8 @@ belongs to.
 
 When blocks are owned by a single ElementArea (and therefore a single Page), we can store a reference to the page
 directly on the block as a performance enhancement for this query. A set of extensions to manage this are provided out
-of the box, and can be enabled by applying the following configuration:
-
-```
-DNADesign\Elemental\Models\BaseElement:
-  extensions:
-    topPageDataExtension: DNADesign\Elemental\TopPage\DataExtension
-
-DNADesign\Elemental\Models\ElementalArea:
-  extensions:
-    topPageDataExtension: DNADesign\Elemental\TopPage\DataExtension
-
-Page:
-  extensions:
-    topPageSiteTreeExtension: DNADesign\Elemental\TopPage\SiteTreeExtension
-```
+of the box for elements on pages. You can use `$TopPage` in your template to get access to the page, which is more performant
+than using `$Page`.
 
 These extensions will be enabled by default in Elemental 5.
 

src/Models/BaseElement.php

@@ -5,6 +5,7 @@
 use DNADesign\Elemental\Controllers\ElementController;
 use DNADesign\Elemental\Forms\TextCheckboxGroupField;
 use DNADesign\Elemental\ORM\FieldType\DBObjectType;
+use DNADesign\Elemental\TopPage\DataExtension;
 use Exception;
 use SilverStripe\CMS\Controllers\CMSPageEditController;
 use SilverStripe\CMS\Model\SiteTree;
@@ -78,7 +79,8 @@ class BaseElement extends DataObject implements CMSPreviewable
     ];
 
     private static $extensions = [
-        Versioned::class
+        Versioned::class,
+        DataExtension::class,
     ];
 
     private static $casting = [

src/Models/ElementalArea.php

@@ -3,6 +3,7 @@
 namespace DNADesign\Elemental\Models;
 
 use DNADesign\Elemental\Extensions\ElementalAreasExtension;
+use DNADesign\Elemental\TopPage\DataExtension;
 use SilverStripe\Core\ClassInfo;
 use SilverStripe\Core\Injector\Injector;
 use SilverStripe\Dev\TestOnly;
@@ -35,6 +36,7 @@ class ElementalArea extends DataObject
 
     private static $extensions = [
         Versioned::class,
+        DataExtension::class,
     ];
 
     private static $owns = [

src/TopPage/DataExtension.php

@@ -42,14 +42,6 @@ class DataExtension extends BaseDataExtension
         'TopPageID' => true,
     ];
 
-    /**
-     * Global flag which indicates if this feature is enabled or not
-     *
-     * @see DataExtension::withTopPageUpdate()
-     * @var bool
-     */
-    private $topPageUpdate = true;
-
     /**
      * Global flag which indicates that automatic page determination is enabled or not
      * If this is set to a page ID it will be used instead of trying to determine the top page
@@ -155,10 +147,6 @@ public function getTopPage(): ?Page
      */
     public function setTopPage(?Page $page = null): void
     {
-        if (!$this->getTopPageUpdate()) {
-            return;
-        }
-
         /** @var BaseElement|ElementalArea|Versioned|DataExtension $owner */
         $owner = $this->owner;
 
@@ -188,49 +176,6 @@ public function setTopPage(?Page $page = null): void
         $this->saveChanges();
     }
 
-    public function getTopPageUpdate(): bool
-    {
-        return $this->topPageUpdate;
-    }
-
-    /**
-     * Global flag manipulation - enable automatic top page determination
-     * Useful for unit tests as you may want to enable / disable this feature based on need
-     */
-    public function enableTopPageUpdate(): void
-    {
-        $this->topPageUpdate = true;
-    }
-
-    /**
-     * Global flag manipulation - disable automatic top page determination
-     * Useful for unit tests as you may want to enable / disable this feature based on need
-     */
-    public function disableTopPageUpdate(): void
-    {
-        $this->topPageUpdate = false;
-    }
-
-    /**
-     * Use this to wrap any code which is supposed to run with desired top page update setting
-     * Useful for unit tests as you may want to enable / disable this feature based on need
-     *
-     * @param bool $update
-     * @param callable $callback
-     * @return mixed
-     */
-    public function withTopPageUpdate(bool $update, callable $callback)
-    {
-        $original = $this->topPageUpdate;
-        $this->topPageUpdate = $update;
-
-        try {
-            return $callback();
-        } finally {
-            $this->topPageUpdate = $original;
-        }
-    }
-
     /**
      * Use this to wrap any code which is supposed to run with fixed top page
      * Useful when top page is known upfront and doesn't need to be determined
@@ -271,10 +216,6 @@ protected function getFixedTopPageID(): int
      */
     protected function updateTopPage(): void
     {
-        if (!$this->getTopPageUpdate()) {
-            return;
-        }
-
         /** @var SiteTreeExtension $extension */
         $extension = singleton(SiteTreeExtension::class);
         $extension->addDuplicatedObject($this->owner);

src/TopPage/FluentExtension.php

@@ -13,7 +13,6 @@
  * Class FluentExtension
  *
  * Use in place of @see DataExtension if you use the Fluent module for page localisation.
- * Be sure to also update @see TestState to use this extension
  *
  * @link https://github.com/tractorcow-farm/silverstripe-fluent
  * @property string $TopPageLocale

src/TopPage/SiteTreeExtension.php

@@ -135,13 +135,6 @@ protected function getDuplicatedPageKey(): ?string
      */
     protected function initDuplication(Page $original): void
     {
-        /** @var DataExtension $extension */
-        $extension = singleton(DataExtension::class);
-
-        if (!$extension->getTopPageUpdate()) {
-            return;
-        }
-
         $key = $original->getDuplicationKey();
 
         if ($key === null) {
@@ -165,13 +158,6 @@ protected function initDuplication(Page $original): void
      */
     protected function processDuplication(Page $original, bool $written): void
     {
-        /** @var DataExtension $extension */
-        $extension = singleton(DataExtension::class);
-
-        if (!$extension->getTopPageUpdate()) {
-            return;
-        }
-
         if ($written) {
             $this->writeDuplication($original);
 
@@ -191,13 +177,7 @@ protected function processDuplication(Page $original, bool $written): void
      */
     protected function processDuplicationFromOriginal(): void
     {
-        /** @var DataExtension $extension */
-        $extension = singleton(DataExtension::class);
-
-        if (!$extension->getTopPageUpdate()) {
-            return;
-        }
-
+        /** @var Page|ElementalPageExtension $owner */
         $owner = $this->owner;
 
         if (!isset($owner->duplicationOriginal)) {
@@ -250,13 +230,6 @@ protected function writeDuplication(Page $original): void
      */
     protected function setTopPageForElementalArea(): void
     {
-        /** @var DataExtension $extension */
-        $extension = singleton(DataExtension::class);
-
-        if (!$extension->getTopPageUpdate()) {
-            return;
-        }
-
         /** @var Page|ElementalPageExtension $owner */
         $owner = $this->owner;