Changeset 3333:11107ba2fc59 for inc

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:

inc

Files:

• admin/lib.moduleslist.php (modified) (4 diffs)
• core/class.dc.modules.php (modified) (2 diffs)

inc/admin/lib.moduleslist.php

@@ -466 +466 @@
                     'sshot'             => '',
                     'score'                  => 0,
-                    'type'                   => null
+                    'type'                   => null,
+                    'require'           => array(),
+                    'settings'               => array()
                ),
                # Module's values
@@ -744 +746 @@
                          if (!empty($more)) {
                               echo
-                              '<li>'.implode(' - ', $more).'</li>';
+                              '<li>'.implode(' - ',$more).'</li>';
                          }
 
@@ -753 +755 @@
                     $config = !empty($module['root']) && file_exists(path::real($module['root'].'/_config.php'));
 
-                    if ($config || !empty($module['section']) || !empty($module['tags'])) {
+                    if ($config || !empty($module['section']) || !empty($module['tags']) || !empty($module['settings'])) {
                          echo
                          '<div><ul class="mod-more">';
 
-                         if ($config) {
-                              echo
-                              '<li><a class="module-config" href="'.$this->getURL('module='.$id.'&amp;conf=1').'">'.__('Configure plugin').'</a></li>';
+                         $settings = $this->getSettingsUrls($this->core,$id);
+                         if (!empty($settings)) {
+                              echo '<li>'.implode(' - ',$settings).'</li>';
                          }
 
@@ -806 +808 @@
 
           return $this;
+     }
+
+     /**
+      * Get settings URLs if any
+      *
+      * @param object $core
+      * @param string $id module ID
+      * @param boolean $check check permission
+      * @param boolean $self include self URL (→ plugin index.php URL)
+      * @return Array of settings URLs
+      */
+     public static function getSettingsUrls($core,$id,$check=false,$self=true)
+     {
+          $st = array();
+
+          $config = !empty($core->plugins->moduleRoot($id)) &&
+               file_exists(path::real($core->plugins->moduleRoot($id).'/_config.php'));
+          $settings = $core->plugins->moduleInfo($id,'settings');
+          if ($config || !empty($settings)) {
+               if ($config) {
+                    $st[] = '<a class="module-config" href="'.
+                         $core->adminurl->get('admin.plugins',array('module' => $id,'conf' => '1')).
+                         '">'.__('Configure plugin').'</a>';
+               }
+               if (is_array($settings)) {
+                    foreach ($settings as $sk => $sv) {
+                         switch ($sk) {
+                              case 'blog':
+                                   if ((!$check) ||
+                                        ($check && $core->auth->check('admin',$core->blog->id))) {
+                                        $st[] = '<a class="module-config" href="'.
+                                             $core->adminurl->get('admin.blog.pref').$sv.
+                                             '">'.__('Plugin settings (in blog parameters)').'</a>';
+                                   }
+                                   break;
+                              case 'pref':
+                                   if ((!$check) ||
+                                        ($check && $core->auth->check('usage,contentadmin',$core->blog->id))) {
+                                        $st[] = '<a class="module-config" href="'.
+                                             $core->adminurl->get('admin.user.preferences').$sv.
+                                             '">'.__('Plugin settings (in user preferences)').'</a>';
+                                   }
+                                   break;
+                              case 'self':
+                                   if ($self) {
+                                        if ((!$check) ||
+                                             ($check && $core->auth->check($core->plugins->moduleInfo($id,'permissions'),$core->blog->id))) {
+                                             $st[] = '<a class="module-config" href="'.
+                                                  $core->adminurl->get('admin.plugin.'.$id).$sv.
+                                                  '">'.__('Plugin settings').'</a>';
+                                        }
+                                   }
+                                   break;
+                         }
+                    }
+               }
+          }
+
+          return $st;
      }
 

inc/core/class.dc.modules.php

@@ -283 +283 @@
      (currently available keys : permissions, priority, type)
      */
-     public function registerModule($name,$desc,$author,$version, $properties = array())
+     public function registerModule($name,$desc,$author,$version,$properties = array())
      {
           if ($this->disabled_mode) {
@@ -320 +320 @@
                     'type' => null,
                     'enabled' => true,
-                    'requires' => array()
+                    'requires' => array(),
+                    'settings' => array()
                ), $properties
           );