Merge pull request #1572 from creative-commoners/pulls/1.13/disable-h…

…elp-links ENH Allow disabling of help_links
silverstripe · Sep 4, 2023 · ec30bf3 · ec30bf3
2 parents 714c773 + 105b5ce
commit ec30bf3
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 6 deletions.
diff --git a/code/LeftAndMain.php b/code/LeftAndMain.php
@@ -1863,6 +1863,8 @@ public function SiteConfig()
     /**
      * The urls used for the links in the Help dropdown in the backend
      *
+     * Set this to `false` via yml config if you do not want to show any help links
+     *
      * @config
      * @var array
      */
@@ -1889,13 +1891,16 @@ public function getHelpLinks()
             }
         });
 
-        foreach ($helpLinks as $key => $value) {
-            $translationKey = str_replace(' ', '', $key ?? '');
+        // Setting the `help_links` config to `false` means no help links will show
+        if (is_array($helpLinks)) {
+            foreach ($helpLinks as $key => $value) {
+                $translationKey = str_replace(' ', '', $key ?? '');
 
-            $formattedLinks[] = [
-                'Title' => _t(__CLASS__ . '.' . $translationKey, $key),
-                'URL' => $value
-            ];
+                $formattedLinks[] = [
+                    'Title' => _t(__CLASS__ . '.' . $translationKey, $key),
+                    'URL' => $value
+                ];
+            }
         }
 
         return ArrayList::create($formattedLinks);

diff --git a/tests/php/LeftAndMainTest.php b/tests/php/LeftAndMainTest.php
@@ -215,6 +215,13 @@ public function testGetHelpLinks()
         $this->assertEquals('www.silverstripe.org', $silverstripeLink['URL']);
     }
 
+    public function testDisableHelpLinks()
+    {
+        Config::modify()->set(LeftAndMain::class, 'help_links', false);
+        $helpLinks = LeftAndMain::singleton()->getHelpLinks();
+        $this->assertCount(0, $helpLinks);
+    }
+
     /**
      * @dataProvider provideTestCMSVersionNumber
      */