xref: /plugin/structsection/action.php (revision 15756b070f99447f7dc7079da6634b56ef561cb2)
1<?php
2/**
3 * DokuWiki Plugin structsection (Action Component)
4 *
5 * @license GPL 2 http://www.gnu.org/licenses/gpl-2.0.html
6 * @author  Michael Große <mic.grosse@googlemail.com>
7 */
8
9class action_plugin_structsection extends DokuWiki_Action_Plugin
10{
11
12    /**
13     * Registers a callback function for a given event
14     *
15     * @param Doku_Event_Handler $controller DokuWiki's event controller object
16     * @return void
17     */
18    public function register(Doku_Event_Handler $controller)
19    {
20        $controller->register_hook('PARSER_HANDLER_DONE', 'AFTER', $this, 'appendPluginOutputToPage');
21        $controller->register_hook('PLUGIN_STRUCT_TYPECLASS_INIT', 'BEFORE', $this, 'registerTypeWithStructPlugin');
22    }
23
24    /**
25     * Event handler for PARSER_HANDLER_DONE
26     *
27     * @param Doku_Event $event event object by reference
28     * @param mixed $param [the parameters passed as fifth argument to register_hook() when this
29     *                           handler was registered]
30     * @return void
31     */
32    final public function appendPluginOutputToPage(Doku_Event $event, $param)
33    {
34        /** @var helper_plugin_struct $struct */
35        $struct = plugin_load('helper', 'struct');
36        if (!$struct) {
37            return;
38        }
39
40        global $ACT;
41
42        if (act_clean($ACT) != 'show') {
43            dbglog($ACT, __FILE__ .': '.__LINE__);
44            return;
45        }
46
47        $last = end($event->data->calls);
48        $pos = $last[2];
49
50        $event->data->calls[] = array(
51            'plugin',
52            array(
53                'structsection', array('pos' => $pos), DOKU_LEXER_SPECIAL, '',
54            ),
55            $pos,
56        );
57    }
58
59    /**
60     * Event handler for PLUGIN_STRUCT_TYPECLASS_INIT
61     *
62     * @param Doku_Event $event
63     * @param            $param
64     */
65    final public function registerTypeWithStructPlugin(Doku_Event $event, $param)
66    {
67        $event->data['Section'] = 'dokuwiki\\plugin\\structsection\\types\\Section';
68    }
69
70}
71
72// vim:ts=4:sw=4:et:
73