Switch structureID to structureUid

Author: DowleyDeveloped

composer.json

@@ -2,7 +2,7 @@
 	"name": "dowleydeveloped/website-documentation",
 	"description": "Add Guides to your website to help both clients & agency",
 	"type": "craft-plugin",
-	"version": "1.5.0",
+	"version": "2.0.0",
 	"license": "MIT",
 	"authors": [
 		{

src/WebsiteDocumentation.php

@@ -259,7 +259,7 @@ public function createConfig()
 		$structure = Craft::$app->getStructures()->getStructureById($structure->id);
 
 		$settings = $this->getSettings()->getAttributes();
-		$settings["structure"] = $structure->id;
+		$settings['structureUid'] = $structure->uid;
 
 		// Save!
 		Craft::$app->getPlugins()->savePluginSettings($this, $settings);

src/elements/GuideEntry.php

@@ -43,7 +43,12 @@ class GuideEntry extends Element
 	public ?int $typeId = null;
 
 	/**
-	 * @var ?int The ID of the structure.
+	 * @var ?string The UID of the structure.
+	 */
+	public ?string $structureUid = null;
+
+	/**
+	 * @var ?string The ID of the structure.
 	 */
 	public ?int $structureId = null;
 
@@ -221,7 +226,12 @@ public function init(): void
 		$entryType = Craft::$app->getEntries()->getEntryTypeByHandle('websiteDocumentationContent');
 		$this->_entryType = Craft::$app->getEntries()->getEntryTypeByHandle('websiteDocumentationContent');
 		$this->typeId = $entryType->id;
-		$this->structureId = WebsiteDocumentation::$settings->structure;
+		$this->structureUid = WebsiteDocumentation::$settings->structureUid;
+
+		if ($this->structureUid) {
+			$structure = Craft::$app->structures->getStructureByUid($this->structureUid);
+   			$this->structureId = $structure?->id;
+		}
 	}
 
 	/**
@@ -620,14 +630,15 @@ protected static function defineSources(string $context): array
 		$sources = [];
 
 		$settings = WebsiteDocumentation::$plugin->getSettings();
+		$structureId = Craft::$app->structures->getStructureByUid($settings->structureUid)?->id;
 
 		$sources[] = [
 			'key' => 'guides',
 			'label' => Craft::t('site', 'CMS Guides'),
 			'data' => [
 				'type' => 'structure',
 			],
-			'structureId' => $settings->structure,
+			'structureId' => $structureId,
 			'structureEditable' => true,
 		];
 

src/migrations/m260202_132947_fix_structure.php

@@ -0,0 +1,72 @@
+<?php
+
+namespace dowleydeveloped\websitedocumentation\migrations;
+
+use Craft;
+use craft\db\Migration;
+use craft\db\Query;
+
+use dowleydeveloped\websitedocumentation\WebsiteDocumentation;
+
+/**
+ * m260202_132947_fix_structure migration.
+ */
+class m260202_132947_fix_structure extends Migration
+{
+    /**
+     * @inheritdoc
+     */
+    public function safeUp(): bool
+    {
+		$plugin = WebsiteDocumentation::getInstance();
+		$handle = $plugin->id;
+
+        $pc = Craft::$app->projectConfig;
+        $settingsPath = "plugins.$handle.settings";
+        $settings = $pc->get($settingsPath) ?? [];
+
+        // If already set, don’t touch it
+        if (!empty($settings['structureUid'])) {
+            return true;
+        }
+
+        // 1) Find structureId(s) used by guide entries
+        $structureIds = (new Query())
+            ->select(['structureId'])
+            ->from('{{%documentation_guide_entries}}')
+            ->where(['not', ['structureId' => null]])
+            ->distinct()
+            ->column();
+
+        if (empty($structureIds)) {
+            throw new \RuntimeException('No structureId found in documentation_guide_entries.');
+        }
+
+        // If there are multiple, choose deterministically.
+        // Most plugins will only ever have one.
+        sort($structureIds);
+        $structureId = (int)$structureIds[0];
+
+        // 2) Convert ID -> UID
+        $structure = Craft::$app->structures->getStructureById($structureId);
+        if (!$structure?->uid) {
+            throw new \RuntimeException("Structure $structureId not found.");
+        }
+
+        // 3) Save UID to Project Config
+        $settings['structureUid'] = $structure->uid;
+
+        $pc->set($settingsPath, $settings);
+
+        return true;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function safeDown(): bool
+    {
+        echo "m260202_132947_fix_structure cannot be reverted.\n";
+        return false;
+    }
+}

src/models/Settings.php

@@ -16,8 +16,7 @@ class Settings extends Model
 	 */
 
 	public $name = "Website Documentation";
-	public $structure;
-	public $structureExists;
+	public ?string $structureUid = null;
 	public $sites;
 
 	// Public Methods
@@ -29,8 +28,7 @@ class Settings extends Model
 	public function rules(): array
 	{
 		return [
-			["structure", "integer"],
-			["structureExists", "boolean"],
+			[['structureUid'], 'string'],
 		];
 	}
 }

src/resources/js/guide-index.js

@@ -11,16 +11,27 @@ if (typeof Craft.GuideEntries === typeof undefined) {
 Craft.GuideEntries.TemplateIndex = Craft.BaseElementIndex.extend({
 	$newTemplateBtnGroup: null,
 	$newTemplateBtn: null,
+
 	init(elements, main, controller) {
-		this.on("selectSource", this.createButton.bind(this));
-		this.on("selectSite", this.createButton.bind(this));
 		this.base(elements, main, controller);
 	},
+
+	updateElements: function () {
+		this.base();
+
+		// After Craft updates the view (including structure view),
+		// add/refresh our button.
+		this.createButton();
+	},
+
 	createButton: function () {
-		if (null === this.$source) return;
+		if (this.$source === null) return;
+
+		if (this.$newTemplateBtnGroup) {
+			this.$newTemplateBtnGroup.remove();
+		}
 
-		null !== this.$newTemplateBtnGroup && this.$newTemplateBtnGroup.remove(),
-			(this.$newTemplateBtnGroup = $('<div class="btngroup submit" data-wrapper/>'));
+		this.$newTemplateBtnGroup = $('<div class="btngroup submit" data-wrapper/>');
 
 		this.$newTemplateBtn = Craft.ui
 			.createButton({
@@ -36,23 +47,20 @@ Craft.GuideEntries.TemplateIndex = Craft.BaseElementIndex.extend({
 
 		this.addButton(this.$newTemplateBtnGroup);
 	},
-	_createTemplate: async function () {
-		const table = this.$source.data("handle");
 
+	_createTemplate: async function () {
 		Craft.sendActionRequest("POST", "websitedocumentation/templates/create", {
 			data: {
 				siteId: this.siteId,
 				entryType: "websiteDocumentationContent",
 			},
 		}).then(({ data: table }) => {
-			document.location.href = Craft.getUrl(table.cpEditUrl, {
-				fresh: 1,
-			});
+			document.location.href = Craft.getUrl(table.cpEditUrl, { fresh: 1 });
 		});
 	},
 });
 
 Craft.registerElementIndexClass(
 	"dowleydeveloped\\websitedocumentation\\elements\\GuideEntry",
-	Craft.GuideEntries.TemplateIndex,
+	Craft.GuideEntries.TemplateIndex
 );