Improved pagetools event in dokuwiki template

This moves the template name away from the hook name into the event data (as
the 'tpl' value). Therefore it moves the previous data items into the 'items' sub array.
A 'view' value has also been added to describe in which template file the
event was called ('main' or 'detail').

This way it will be much easier for plugins to consider default cases and
differentiate between main and other layouts.

2 files changed, 18 insertions, 20 deletions

diff --git a/lib/tpl/dokuwiki/detail.php b/lib/tpl/dokuwiki/detail.php
index c602830f7..2ee36a2a9 100644
--- a/lib/tpl/dokuwiki/detail.php
+++ b/lib/tpl/dokuwiki/detail.php
@@ -110,26 +110,24 @@ header('X-UA-Compatible: IE=edge,chrome=1');
                         <ul>
                             <?php
                                 $data = array();
+                                $data['tpl']  = $conf['template'];
+                                $data['view'] = 'detail';
 
                                 // View in media manager; @todo: transfer logic to backend
                                 $imgNS = getNS($IMG);
                                 $authNS = auth_quickaclcheck("$imgNS:*");
                                 if (($authNS >= AUTH_UPLOAD) && function_exists('media_managerURL')) {
                                     $mmURL = media_managerURL(array('ns' => $imgNS, 'image' => $IMG));
-                                    $data['mediaManager'] = '<li><a href="'.$mmURL.'" class="mediaManager"><span>'.$lang['img_manager'].'</span></a></li>';
+                                    $data['items']['mediaManager'] = '<li><a href="'.$mmURL.'" class="mediaManager"><span>'.$lang['img_manager'].'</span></a></li>';
                                 }
 
                                 // Back to [ID]; @todo: transfer logic to backend
-                                $data['img_backto'] = '<li><a href="'.wl($ID).'" class="back"><span>'.$lang['img_backto'].' '.$ID.'</span></a></li>';
+                                $data['items']['img_backto'] = '<li><a href="'.wl($ID).'" class="back"><span>'.$lang['img_backto'].' '.$ID.'</span></a></li>';
 
                                 // the page tools can be amended through a custom plugin hook
-                                // if you're deriving from this template and your design is close enough to
-                                // the dokuwiki template you might want to trigger a DOKUWIKI event instead
-                                // of using $conf['template'] here
-                                $hook = 'TEMPLATE_'.strtoupper($conf['template']).'_PAGETOOLS_DISPLAY';
-                                $evt = new Doku_Event($hook, $data);
+                                $evt = new Doku_Event('TEMPLATE_PAGETOOLS_DISPLAY', $data);
                                 if($evt->advise_before()){
-                                    foreach($evt->data as $k => $html) echo $html;
+                                    foreach($evt->data['items'] as $k => $html) echo $html;
                                 }
                                 $evt->advise_after();
                                 unset($data);
diff --git a/lib/tpl/dokuwiki/main.php b/lib/tpl/dokuwiki/main.php
index f6ca4ed86..0dbaa681b 100644
--- a/lib/tpl/dokuwiki/main.php
+++ b/lib/tpl/dokuwiki/main.php
@@ -75,22 +75,22 @@ $showSidebar = $hasSidebar && ($ACT=='show');
                     <ul>
                         <?php
                             $data = array(
-                                'edit'      => tpl_action('edit',      1, 'li', 1, '<span>', '</span>'),
-                                'revert'    => tpl_action('revert',    1, 'li', 1, '<span>', '</span>'),
-                                'revisions' => tpl_action('revisions', 1, 'li', 1, '<span>', '</span>'),
-                                'backlink'  => tpl_action('backlink',  1, 'li', 1, '<span>', '</span>'),
-                                'subscribe' => tpl_action('subscribe', 1, 'li', 1, '<span>', '</span>'),
-                                'top'       => tpl_action('top',       1, 'li', 1, '<span>', '</span>')
+                                'tpl'   => $conf['template'],
+                                'view'  => 'main',
+                                'items' => array(
+                                    'edit'      => tpl_action('edit',      1, 'li', 1, '<span>', '</span>'),
+                                    'revert'    => tpl_action('revert',    1, 'li', 1, '<span>', '</span>'),
+                                    'revisions' => tpl_action('revisions', 1, 'li', 1, '<span>', '</span>'),
+                                    'backlink'  => tpl_action('backlink',  1, 'li', 1, '<span>', '</span>'),
+                                    'subscribe' => tpl_action('subscribe', 1, 'li', 1, '<span>', '</span>'),
+                                    'top'       => tpl_action('top',       1, 'li', 1, '<span>', '</span>')
+                                )
                             );
 
                             // the page tools can be amended through a custom plugin hook
-                            // if you're deriving from this template and your design is close enough to
-                            // the dokuwiki template you might want to trigger a DOKUWIKI event instead
-                            // of using $conf['template'] here
-                            $hook = 'TEMPLATE_'.strtoupper($conf['template']).'_PAGETOOLS_DISPLAY';
-                            $evt = new Doku_Event($hook, $data);
+                            $evt = new Doku_Event('TEMPLATE_PAGETOOLS_DISPLAY', $data);
                             if($evt->advise_before()){
-                                foreach($evt->data as $k => $html) echo $html;
+                                foreach($evt->data['items'] as $k => $html) echo $html;
                             }
                             $evt->advise_after();
                             unset($data);