From 4165b7e5246d4d169c6faa16621bedbb84c1f431 Mon Sep 17 00:00:00 2001
From: Coleman Watts <coleman@civicrm.org>
Date: Sat, 28 Dec 2013 11:22:18 -0800
Subject: [PATCH] CRM-13997 CRM-13863 - Decouple TabHeader markup from scripts

---
 CRM/Campaign/Form/Survey/TabHeader.php        |  7 +++-
 CRM/Campaign/Page/DashBoard.php               |  9 +++--
 CRM/Campaign/Page/Vote.php                    |  9 +++--
 .../Form/ContributionPage/TabHeader.php       |  6 ++-
 CRM/Event/Form/ManageEvent/TabHeader.php      |  7 +++-
 templates/CRM/Campaign/Form/Survey/Main.tpl   |  4 +-
 templates/CRM/Campaign/Form/Survey/Tab.tpl    |  2 +-
 templates/CRM/Campaign/Page/DashBoard.tpl     |  2 +-
 templates/CRM/Campaign/Page/Vote.tpl          |  2 +-
 .../Contribute/Form/ContributionPage/Tab.tpl  |  2 +-
 templates/CRM/Event/Form/ManageEvent/Tab.tpl  |  2 +-
 templates/CRM/UF/Page/Group.tpl               |  9 ++---
 templates/CRM/common/TabHeader.js             | 23 +++++++++++
 templates/CRM/common/TabHeader.tpl            | 38 -------------------
 14 files changed, 59 insertions(+), 63 deletions(-)
 create mode 100644 templates/CRM/common/TabHeader.js

diff --git a/CRM/Campaign/Form/Survey/TabHeader.php b/CRM/Campaign/Form/Survey/TabHeader.php
index 779eb4e9be..77378a7893 100644
--- a/CRM/Campaign/Form/Survey/TabHeader.php
+++ b/CRM/Campaign/Form/Survey/TabHeader.php
@@ -45,8 +45,11 @@ class CRM_Campaign_Form_Survey_TabHeader {
       $form->set('tabHeader', $tabs);
     }
     $form->assign_by_ref('tabHeader', $tabs);
-    $selectedTab = self::getCurrentTab($tabs);
-    $form->assign_by_ref('selectedTab', $selectedTab);
+    CRM_Core_Resources::singleton()
+      ->addScriptFile('civicrm', 'templates/CRM/common/TabHeader.js')
+      ->addSetting(array('tabSettings' => array(
+        'active' => self::getCurrentTab($tabs),
+      )));
     return $tabs;
   }
 
diff --git a/CRM/Campaign/Page/DashBoard.php b/CRM/Campaign/Page/DashBoard.php
index e0ac0c32c5..a30603468b 100644
--- a/CRM/Campaign/Page/DashBoard.php
+++ b/CRM/Campaign/Page/DashBoard.php
@@ -439,10 +439,11 @@ class CRM_Campaign_Page_DashBoard extends CRM_Core_Page {
       //build the tabs.
       $this->buildTabs();
     }
-
-    //give focus to proper tab.
-    $selectedTabIndex = strtolower(CRM_Utils_Array::value('subPage', $_GET, 'campaign'));
-    $this->assign('selectedTab', $selectedTabIndex);
+    CRM_Core_Resources::singleton()
+      ->addScriptFile('civicrm', 'templates/CRM/common/TabHeader.js')
+      ->addSetting(array('tabSettings' => array(
+        'active' => strtolower(CRM_Utils_Array::value('subPage', $_GET, 'campaign')),
+      )));
   }
 
   function run() {
diff --git a/CRM/Campaign/Page/Vote.php b/CRM/Campaign/Page/Vote.php
index 143692d663..ed788a0e79 100644
--- a/CRM/Campaign/Page/Vote.php
+++ b/CRM/Campaign/Page/Vote.php
@@ -86,10 +86,11 @@ class CRM_Campaign_Page_Vote extends CRM_Core_Page {
     }
     $this->assign('subPageType', $subPageType);
 
-    //give focus to proper tab.
-    $this->assign('selectedTabIndex', array_search(CRM_Utils_Array::value('subPage', $_GET, 'reserve'),
-        array_keys($this->_tabs)
-      ));
+    CRM_Core_Resources::singleton()
+      ->addScriptFile('civicrm', 'templates/CRM/common/TabHeader.js')
+      ->addSetting(array('tabSettings' => array(
+        'active' => strtolower(CRM_Utils_Array::value('subPage', $_GET, 'reserve')),
+      )));
   }
 
   function run() {
diff --git a/CRM/Contribute/Form/ContributionPage/TabHeader.php b/CRM/Contribute/Form/ContributionPage/TabHeader.php
index 9385bb9994..12dfd39bea 100644
--- a/CRM/Contribute/Form/ContributionPage/TabHeader.php
+++ b/CRM/Contribute/Form/ContributionPage/TabHeader.php
@@ -44,7 +44,11 @@ class CRM_Contribute_Form_ContributionPage_TabHeader {
       $form->set('tabHeader', $tabs);
     }
     $form->assign_by_ref('tabHeader', $tabs);
-    $form->assign('selectedTab', self::getCurrentTab($tabs));
+    CRM_Core_Resources::singleton()
+      ->addScriptFile('civicrm', 'templates/CRM/common/TabHeader.js')
+      ->addSetting(array('tabSettings' => array(
+        'active' => self::getCurrentTab($tabs),
+      )));
     return $tabs;
   }
 
diff --git a/CRM/Event/Form/ManageEvent/TabHeader.php b/CRM/Event/Form/ManageEvent/TabHeader.php
index 7c071baf42..92756352fe 100644
--- a/CRM/Event/Form/ManageEvent/TabHeader.php
+++ b/CRM/Event/Form/ManageEvent/TabHeader.php
@@ -45,8 +45,11 @@ class CRM_Event_Form_ManageEvent_TabHeader {
       $form->set('tabHeader', $tabs);
     }
     $form->assign_by_ref('tabHeader', $tabs);
-    $selectedTab = self::getCurrentTab($tabs);
-    $form->assign_by_ref('selectedTab', $selectedTab);
+    CRM_Core_Resources::singleton()
+      ->addScriptFile('civicrm', 'templates/CRM/common/TabHeader.js')
+      ->addSetting(array('tabSettings' => array(
+        'active' => self::getCurrentTab($tabs),
+      )));
     return $tabs;
   }
 
diff --git a/templates/CRM/Campaign/Form/Survey/Main.tpl b/templates/CRM/Campaign/Form/Survey/Main.tpl
index c34b849876..66362f0f44 100644
--- a/templates/CRM/Campaign/Form/Survey/Main.tpl
+++ b/templates/CRM/Campaign/Form/Survey/Main.tpl
@@ -107,8 +107,8 @@
     });
 </script>
 {/literal}
-
-{include file="CRM/common/customData.tpl"}
+{* editor has already been included in TabHeader.tpl so set flag true *}
+{include file="CRM/common/customData.tpl" includeWysiwygEditor=true}
 {literal}
   <script type="text/javascript">
     cj(document).ready(function() {
diff --git a/templates/CRM/Campaign/Form/Survey/Tab.tpl b/templates/CRM/Campaign/Form/Survey/Tab.tpl
index a537f93d0e..3db967d021 100644
--- a/templates/CRM/Campaign/Form/Survey/Tab.tpl
+++ b/templates/CRM/Campaign/Form/Survey/Tab.tpl
@@ -24,4 +24,4 @@
  +--------------------------------------------------------------------+
 *}
 
-{include file="CRM/common/TabHeader.tpl" cache=true}
+{include file="CRM/common/TabHeader.tpl"}
diff --git a/templates/CRM/Campaign/Page/DashBoard.tpl b/templates/CRM/Campaign/Page/DashBoard.tpl
index 935ad4996a..bc9e73cb2e 100644
--- a/templates/CRM/Campaign/Page/DashBoard.tpl
+++ b/templates/CRM/Campaign/Page/DashBoard.tpl
@@ -30,7 +30,7 @@
   {* load campaign/survey/petition tab *}
   {include file="CRM/Campaign/Form/Search/$subPageType.tpl"}
 {else}
-  {include file="CRM/common/TabHeader.tpl" cache=true}
+  {include file="CRM/common/TabHeader.tpl"}
   <div class="clear"></div>
 {/if}
 
diff --git a/templates/CRM/Campaign/Page/Vote.tpl b/templates/CRM/Campaign/Page/Vote.tpl
index 5342003fb7..be6f87637b 100644
--- a/templates/CRM/Campaign/Page/Vote.tpl
+++ b/templates/CRM/Campaign/Page/Vote.tpl
@@ -31,7 +31,7 @@
    {* build the ajax search and voters reserve interface here *}
    {include file='CRM/Campaign/Form/Gotv.tpl'}
 {elseif $tabHeader}
-  {include file="CRM/common/TabHeader.tpl" cache=false}
+  {include file="CRM/common/TabHeader.tpl"}
 {else}
  <div class="messages status no-popup">
      <div class="icon inform-icon"></div>
diff --git a/templates/CRM/Contribute/Form/ContributionPage/Tab.tpl b/templates/CRM/Contribute/Form/ContributionPage/Tab.tpl
index 4ff476407b..f4ad3a6646 100644
--- a/templates/CRM/Contribute/Form/ContributionPage/Tab.tpl
+++ b/templates/CRM/Contribute/Form/ContributionPage/Tab.tpl
@@ -46,7 +46,7 @@
   </ul>
   <div class="clear"></div>
 </div>
-{include file="CRM/common/TabHeader.tpl" cache=true}
+{include file="CRM/common/TabHeader.tpl"}
 
 {literal}
 <script>
diff --git a/templates/CRM/Event/Form/ManageEvent/Tab.tpl b/templates/CRM/Event/Form/ManageEvent/Tab.tpl
index aca9a1e53b..4d659c0185 100644
--- a/templates/CRM/Event/Form/ManageEvent/Tab.tpl
+++ b/templates/CRM/Event/Form/ManageEvent/Tab.tpl
@@ -71,7 +71,7 @@
     </div>
 {/if}
 
-{include file="CRM/common/TabHeader.tpl" cache=true}
+{include file="CRM/common/TabHeader.tpl"}
 
 {literal}
 <script>
diff --git a/templates/CRM/UF/Page/Group.tpl b/templates/CRM/UF/Page/Group.tpl
index d1440f5457..df3985511d 100644
--- a/templates/CRM/UF/Page/Group.tpl
+++ b/templates/CRM/UF/Page/Group.tpl
@@ -155,11 +155,10 @@
 
   </div> {* maincontainer*}
   <script type='text/javascript'>
-    var selectedTab = 'user-profiles';
-    {if $selectedChild}selectedTab = '{$selectedChild}';{/if}
-    {literal}
-      cj( function() {
-        var tabIndex = cj('#tab_' + selectedTab).prevAll().length
+      cj( function() {ldelim}
+        var selectedTab = '{if $selectedChild}{$selectedChild}{else}user-profiles{/if}';
+        var tabIndex = cj('#tab_' + selectedTab).prevAll().length;
+        {literal}
         cj("#mainTabContainer").tabs( {active: tabIndex} );
       });
     {/literal}
diff --git a/templates/CRM/common/TabHeader.js b/templates/CRM/common/TabHeader.js
new file mode 100644
index 0000000000..a39b1b2d4c
--- /dev/null
+++ b/templates/CRM/common/TabHeader.js
@@ -0,0 +1,23 @@
+// https://civicrm.org/licensing
+cj(function($) {
+  var tabSettings = CRM.tabSettings || {};
+  tabSettings.active = tabSettings.active ? $('#tab_' + tabSettings.active).prevAll().length : 0;
+  $("#mainTabContainer")
+    .on('tabsbeforeactivate', function(e, ui) {
+      // Warn of unsaved changes - requires formNavigate.tpl to be included in each tab
+      if (!global_formNavigate) {
+        CRM.alert(ts('Your changes in the <em>%1</em> tab have not been saved.', {1: ui.oldTab.text()}), ts('Unsaved Changes'), 'warning');
+        global_formNavigate = true;
+      }
+    })
+    .on('tabsbeforeload', function(e, ui) {
+      // Use civicrm ajax wrappers rather than the default $.load
+      if (!ui.panel.data("civicrmCrmSnippet")) {
+        CRM.loadPage($('a', ui.tab).attr('href'), {
+          target: ui.panel
+        })
+      }
+      e.preventDefault();
+    })
+    .tabs(tabSettings);
+});
diff --git a/templates/CRM/common/TabHeader.tpl b/templates/CRM/common/TabHeader.tpl
index 93d9f898ec..2ff93a06e0 100644
--- a/templates/CRM/common/TabHeader.tpl
+++ b/templates/CRM/common/TabHeader.tpl
@@ -46,41 +46,3 @@
   {/if}
   <div class="clear"></div>
 </div> {* crm-content-block ends here *}
-
-<script type="text/javascript">
-{literal}
-  cj(function($) {
-    var tabSettings = {};
-    {/literal}{if $selectedTab}
-    var selectedTab = "{$selectedTab}";
-    tabSettings.active = $('#tab_' + selectedTab).prevAll().length;
-    {/if}{literal}
-    $("#mainTabContainer")
-      .on('tabsbeforeactivate',
-        function(e, ui) {
-          // Warn of unsaved changes - requires formNavigate.tpl to be included in each tab
-          if (!global_formNavigate) {
-            var message = '{/literal}{ts escape="js" 1='%1'}Your changes in the <em>%1</em> tab have not been saved.{/ts}{literal}';
-            CRM.alert(ts(message, {1: ui.oldTab.text()}), '{/literal}{ts escape="js"}Unsaved Changes{/ts}{literal}', 'warning');
-            global_formNavigate = true;
-          }
-        })
-      .on('tabsbeforeload',
-        function(e, ui) {
-          console.log(ui.panel.data())
-          // Use civicrm ajax wrappers rather than the default $.load
-          if (!ui.panel.data("civicrmCrmSnippet")) {
-            CRM.loadPage($('a', ui.tab).attr('href'), {
-              target: ui.panel
-            })
-          }
-          {/literal}{if empty($cache)}
-          else ui.panel.crmSnippet("refresh");
-          {/if}{literal}
-          e.preventDefault();
-        })
-      .tabs(tabSettings);
-});
-{/literal}
-</script>
-
-- 
2.25.1