Merge pull request #149 from Taitava/new-window

BetterButtonLink: Create a newWindow() method which prevents the CMS …
unclecheese · Jan 12, 2017 · 5aab654 · 5aab654
2 parents 04ff8bf + c8577f5
commit 5aab654
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 4 deletions.
diff --git a/code/actions/BetterButtonAction.php b/code/actions/BetterButtonAction.php
@@ -100,14 +100,29 @@ public function shouldDisplay() {
      */
     public function getButtonHTML() {
         return sprintf(
-            '<a class="%s %s" href="%s" %s>%s</a>',
-            $this->isGrouped() ? '' : 'ss-ui-button cms-panel-link',
-            $this->extraClass(),
+            '<a class="%s" href="%s" %s>%s</a>',
+            $this->getButtonClasses(),
             $this->getButtonLink(),
-            $this->getAttributesHTML(),
+            $this->getAttributesHTML('class'), //Prevent outputting the 'class' attribute twice by excluding it from other attributes
             $this->getButtonText()
         );
     }
+
+    /**
+     * Combines classes from $this->extraClass() with a couple of additional classes if they are applicable for this button.
+     * @return string
+     */
+    private function getButtonClasses() {
+        $classes = $this->extraClass();
+        if ($this->isGrouped()) return $classes; //Do not return the below additional classes
+        $classes .= ' ss-ui-button';
+        if ($this->getAttribute('target') != '_blank') {
+            //Only add this class if this link is targeted inside the CMS. Any links targeted to a new browser window/tab should not have this as the CMS JavaScript would hook to the 'onclick' event and load the content via AJAX to the CMS, which could cause problems.
+            $classes .= ' cms-panel-link';
+        }
+
+        return $classes;
+    }
 
 
     /**

diff --git a/code/actions/BetterButtonLink.php b/code/actions/BetterButtonLink.php
@@ -34,4 +34,15 @@ public function __construct($text, $link) {
     public function getButtonLink() {
         return $this->link;
     }
+
+    /**
+     * Makes the link to open to a new tab. If not used, the CMS will try to load the link via an AJAX request, which
+     * can cause problems if the link target is not a page inside the CMS.
+     *
+     * @param bool $enable True if omitted
+     */
+    public function newWindow($enable = true)
+    {
+        $this->setAttribute('target', $enable ? '_blank' : '');
+    }
 }