Changeset 3333:11107ba2fc59 for admin

Timestamp:

09/01/16 12:21:43 (9 years ago)

Author:

franck <carnet.franck.paul@…>

Branch:

default

Message:

Cope with settings URLs for modules (defined in _define.php).
The settings URLs are displayed on the plugins maganement page, and at the bottom of each plugin main page if any (index.php).

The URLs are set in _define.php, as a new property using this schema:

'settings' => array( <list of URLs> )

With:

<list of URLs> = '<type>' => '<location>', …
<type> = 'self' (own plugin page), 'blog' (in blog parameters page) or 'pref' (in user preferences page)
<location> = (empty) or #<tab>[.<id>] with <tab> = id of the corresponding tab, and <id> = id of fieldset, h4, h5, field, … of first corresponding field

The list of URLs are displayed in the order defined in the array above.

Examples:

Antispam plugin:

'settings' => array(

'self' => ,
'blog' => '#params.antispam_params'

)

self → for main settings of the plugin on its own page (index.php)
blog → for secondary settings in the blog parameters

Tags plugin:

'settings' => array(

'pref' => '#user-options.tags_prefs'

)

pref → for tags list format in user preferences

Maintenance plugin:

'settings' => array(

'self' => '#settings'

)

self → "settings" tab of its own page (index.php)

Location:

admin

Files:

• js/jquery/jquery.pageTabs.js (modified) (8 diffs)
• plugin.php (modified) (1 diff)
• preferences.php (modified) (3 diffs)

admin/js/jquery/jquery.pageTabs.js

@@ -1 +1 @@
 (function($) {
      'use strict';
-    
+
      $.pageTabs = function(start_tab, opts) {
           var defaults = {
@@ -10 +10 @@
                idTabPrefix: 'part-tabs-'
           };
-          
+
           $.pageTabs.options = $.extend({}, defaults, opts);
           var active_tab = start_tab || '';
           var hash = $.pageTabs.getLocationHash();
+          var subhash = $.pageTabs.getLocationSubhash();
 
           if (hash !== undefined && hash) {
@@ -23 +24 @@
 
           createTabs();
-          
+
           $('ul li', '.'+$.pageTabs.options.containerClass).click(function(e) {
                if ($(this).hasClass($.pageTabs.options.activeClass)) {
@@ -40 +41 @@
                     part_to_activate.addClass('loaded');
                }
-               
+
                part_to_activate.tabload();
           });
@@ -49 +50 @@
 
           $.pageTabs.clickTab(active_tab);
-          
+
+          if (subhash !== undefined) {
+               // Tab displayed, now scroll to the sub-part if defined in original document.location (#tab.sub-part)
+               document.getElementById(subhash).scrollIntoView();
+          }
+
           return this;
      };
-     
+
      var createTabs = function createTabs() {
           var lis = [], li_class = '';
-          
+
           $('.'+$.pageTabs.options.contentClass).each(function() {
                $(this).hide();
@@ -62 +68 @@
                $(this).attr('id', $.pageTabs.options.partPrefix + $(this).attr('id')).prop('title','');
           });
-          
+
           $('<div class="'+$.pageTabs.options.containerClass+'"><ul>'+lis.join('')+'</ul></div>')
                .insertBefore($('.'+$.pageTabs.options.contentClass).get(0));
      };
-     
+
      var getHash = function getHash(href) {
           var href = href || '';
@@ -72 +78 @@
           return href.replace(/.*#/, '');
      };
-     
+
      $.pageTabs.clickTab = function(tab) {
           if (tab=='') {
@@ -96 +102 @@
 
      $.pageTabs.getLocationHash = function() {
-          return getHash(document.location.hash);
+          // Return the URL hash (without subhash — #hash[.subhash])
+          var h = getHash(document.location.hash).split('.');
+          return h[0];
+     };
+     $.pageTabs.getLocationSubhash = function() {
+          // Return the URL subhash if present (without hash — #hash[.subhash])
+          var sh = getHash(document.location.hash).split('.');
+          return sh[1];
      };
 })(jQuery);

admin/plugin.php

@@ -78 +78 @@
      call_user_func($open_f,$p_title,$p_head);
      echo $p_content;
+     if (!$popup) {
+          // Add direct links to plugin settings if any
+          $settings = adminModulesList::getSettingsUrls($core,$p,true,false);
+          if (!empty($settings)) {
+               echo '<hr class="clear"/><p class="right modules">'.implode(' - ',$settings).'</p>';
+          }
+     }
      call_user_func($close_f);
 }

admin/preferences.php

@@ -490 +490 @@
 echo
 '<div class="fieldset">'.
-'<h4>'.__('Interface').'</h4>'.
+'<h4 id="user_options_interface">'.__('Interface').'</h4>'.
 
 '<p><label for="user_ui_enhanceduploader" class="classic">'.
@@ -524 +524 @@
 echo
 '<div class="fieldset">'.
-'<h4>'.__('Optional columns displayed in lists').'</h4>';
+'<h4 id="user_options_columns">'.__('Optional columns displayed in lists').'</h4>';
 $odd = true;
 foreach ($cols as $col_type => $col_list) {
@@ -541 +541 @@
 echo
 '<div class="fieldset">'.
-'<h4>'.__('Edition').'</h4>';
+'<h4 id="user_options_edition">'.__('Edition').'</h4>';
 
 echo '<div class="two-boxes odd">';