Add option to {en,dis}able widget display

SpeedJack · SpeedJack · commit 2b25a5c4f373 · 2020-10-23T00:38:04.000+02:00
diff --git a/Admin/Controller/Tile.php b/Admin/Controller/Tile.php
@@ -8,9 +8,11 @@ class Tile extends \XF\Admin\Controller\AbstractController
 {
 	public function actionIndex()
 	{
+		$options = $this->em()->findByIds('XF:Option', ['ifGsEnable']);
 		$repo = $this->getTileRepo();
 		$viewParams = [
-			'tiles' => $repo->getTiles()->fetch()
+			'tiles' => $repo->getTiles()->fetch(),
+			'options' => $options
 		];
 		return $this->view('Inforge\GridShow:TileList', 'if_gs_tile_list', $viewParams);
 	}
diff --git a/Setup.php b/Setup.php
@@ -33,7 +33,7 @@ public function installStep2()
 	{
 		$this->createWidget('if_gs_home_gridshow', 'if_gs_widget', [
 			'positions' => [ 'forum_list_above_nodes' => 5 ],
-			'display_condition' => '$xf.visitor->hasPermission("ifgs", "view")'
+			'display_condition' => '$xf.options.ifGsEnable AND $xf.visitor->hasPermission("ifgs", "view")'
 		], '[Inforge] GridShow Widget');
 	}
 
diff --git a/_output/option_groups/_metadata.json b/_output/option_groups/_metadata.json
@@ -0,0 +1,5 @@
+{
+    "ifGridShow.json": {
+        "hash": "55a128e9412fd3df3788e11ba7167339"
+    }
+}
diff --git a/_output/option_groups/ifGridShow.json b/_output/option_groups/ifGridShow.json
@@ -0,0 +1,6 @@
+{
+    "icon": "fas fa-plus-square",
+    "display_order": 3200,
+    "advanced": false,
+    "debug_only": false
+}
diff --git a/_output/options/_metadata.json b/_output/options/_metadata.json
@@ -0,0 +1,5 @@
+{
+    "ifGsEnable.json": {
+        "hash": "f1bb7d3770293f80a6e7b7d8d40ee73b"
+    }
+}
diff --git a/_output/options/ifGsEnable.json b/_output/options/ifGsEnable.json
@@ -0,0 +1,13 @@
+{
+    "edit_format": "onoff",
+    "edit_format_params": "",
+    "data_type": "boolean",
+    "sub_options": [],
+    "validation_class": "",
+    "validation_method": "",
+    "advanced": false,
+    "default_value": "1",
+    "relations": {
+        "ifGridShow": 5
+    }
+}
diff --git a/_output/phrases/_metadata.json b/_output/phrases/_metadata.json
@@ -41,6 +41,30 @@
         "version_string": "1.0.0",
         "hash": "491be8ac06c38c3531c162cb203c78b9"
     },
+    "option.ifGsEnable.txt": {
+        "global_cache": false,
+        "version_id": 1000070,
+        "version_string": "1.0.0",
+        "hash": "5b497c387f76e008cb46bfbe6545dbb9"
+    },
+    "option_explain.ifGsEnable.txt": {
+        "global_cache": false,
+        "version_id": 1000070,
+        "version_string": "1.0.0",
+        "hash": "848f2f516e91fc98f38b61454649f53e"
+    },
+    "option_group.ifGridShow.txt": {
+        "global_cache": false,
+        "version_id": 1000070,
+        "version_string": "1.0.0",
+        "hash": "cd5dea941073f5f7cee1d6b1917837eb"
+    },
+    "option_group_description.ifGridShow.txt": {
+        "global_cache": false,
+        "version_id": 1000070,
+        "version_string": "1.0.0",
+        "hash": "350283433d9f54cfd6bf0d076ec39247"
+    },
     "permission.ifgs_view.txt": {
         "global_cache": false,
         "version_id": 1000070,
diff --git a/_output/phrases/option.ifGsEnable.txt b/_output/phrases/option.ifGsEnable.txt
@@ -0,0 +1 @@
+Enable GridShow
diff --git a/_output/phrases/option_explain.ifGsEnable.txt b/_output/phrases/option_explain.ifGsEnable.txt
@@ -0,0 +1 @@
+If enabled, the GridShow widget will be displayed in the forum homepage to those users that have the permission to view it. If disable, the GridShow widget will be hidden.
diff --git a/_output/phrases/option_group.ifGridShow.txt b/_output/phrases/option_group.ifGridShow.txt
@@ -0,0 +1 @@
+[Inforge] GridShow
diff --git a/_output/phrases/option_group_description.ifGridShow.txt b/_output/phrases/option_group_description.ifGridShow.txt
@@ -0,0 +1 @@
+Options that control the GridShow add-on.
diff --git a/_output/templates/_metadata.json b/_output/templates/_metadata.json
@@ -7,7 +7,7 @@
     "admin/if_gs_tile_list.html": {
         "version_id": 1000070,
         "version_string": "1.0.0",
-        "hash": "b9f34fcd7b8a0b7e894e46dbf3dc093d"
+        "hash": "91c40ab5a4793fbff30525c346f3c113"
     },
     "public/if_gs_gridshow_widget.html": {
         "version_id": 1000070,
diff --git a/_output/templates/admin/if_gs_tile_list.html b/_output/templates/admin/if_gs_tile_list.html
@@ -32,4 +32,6 @@
 	</xf:form>
 <xf:else />
 	<div class="blockMessage">{{ phrase('no_items_to_display') }}</div>
-</xf:if>
+</xf:if>
+
+<xf:macro template="option_macros" name="option_form_block" arg-options="{$options}" />

Original file line number	Diff line number	Diff line change
`@@ -8,9 +8,11 @@ class Tile extends \XF\Admin\Controller\AbstractController`
`8`	`8`	`{`
`9`	`9`	`public function actionIndex()`
`10`	`10`	`{`
	`11`	`+ $options = $this->em()->findByIds('XF:Option', ['ifGsEnable']);`
`11`	`12`	`$repo = $this->getTileRepo();`
`12`	`13`	`$viewParams = [`
`13`		`- 'tiles' => $repo->getTiles()->fetch()`
	`14`	`+ 'tiles' => $repo->getTiles()->fetch(),`
	`15`	`+ 'options' => $options`
`14`	`16`	`];`
`15`	`17`	`return $this->view('Inforge\GridShow:TileList', 'if_gs_tile_list', $viewParams);`
`16`	`18`	`}`
Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@ public function installStep2()`
`33`	`33`	`{`
`34`	`34`	`$this->createWidget('if_gs_home_gridshow', 'if_gs_widget', [`
`35`	`35`	`'positions' => [ 'forum_list_above_nodes' => 5 ],`
`36`		`- 'display_condition' => '$xf.visitor->hasPermission("ifgs", "view")'`
	`36`	`+ 'display_condition' => '$xf.options.ifGsEnable AND $xf.visitor->hasPermission("ifgs", "view")'`
`37`	`37`	`], '[Inforge] GridShow Widget');`
`38`	`38`	`}`
`39`	`39`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +{
 +    "ifGridShow.json": {
 +        "hash": "55a128e9412fd3df3788e11ba7167339"
 +    }
 +}
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+If enabled, the GridShow widget will be displayed in the forum homepage to those users that have the permission to view it. If disable, the GridShow widget will be hidden.`