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