<?php

/**
 * DokuWiki Plugin structsection (Action Component)
 *
 * @license GPL 2 http://www.gnu.org/licenses/gpl-2.0.html
 * @author  Michael Große <mic.grosse@googlemail.com>
 */

class action_plugin_structsection extends \DokuWiki_Action_Plugin
{
    /**
     * Registers a callback function for a given event
     *
     * @param \Doku_Event_Handler $controller DokuWiki's event controller object
     * @return void
     */
    public function register(\Doku_Event_Handler $controller)
    {
        $controller->register_hook('DOKUWIKI_STARTED', 'AFTER', $this, 'addPageRevisionToJSINFO');
        $controller->register_hook('PARSER_HANDLER_DONE', 'AFTER', $this, 'appendPluginOutputToPage');
        $controller->register_hook('PLUGIN_STRUCT_TYPECLASS_INIT', 'BEFORE', $this, 'registerTypeWithStructPlugin');
    }

    public function addPageRevisionToJSINFO(\Doku_Event $event, $param)
    {
        global $ACT;

        if (act_clean($ACT) !== 'show') {
            return;
        }
        global $JSINFO, $INFO;
        $JSINFO['plugin_structsection'] = [
            'rev' => $INFO['currentrev'],
        ];
    }

    /**
     * Event handler for PARSER_HANDLER_DONE
     *
     * @param \Doku_Event $event event object by reference
     * @param mixed $param [the parameters passed as fifth argument to register_hook() when this
     *                           handler was registered]
     * @return void
     */
    final public function appendPluginOutputToPage(\Doku_Event $event, $param)
    {
        static $instructionsAdded = false;

        /** @var \helper_plugin_struct $struct */
        $struct = plugin_load('helper', 'struct');
        if (!$struct) {
            return;
        }

        global $ACT;

        if (act_clean($ACT) != 'show') {
            return;
        }

        if ($instructionsAdded) {
            return;
        }

        $instructionsAdded = true;

        $last = end($event->data->calls);

        $INSTRUCTION_POSITION_INDEX = 2;
        $pos = $last[$INSTRUCTION_POSITION_INDEX];

        $event->data->calls[] = array(
            'plugin',
            array(
                'structsection', array('pos' => $pos), DOKU_LEXER_SPECIAL, '',
            ),
            $pos,
        );
    }

    /**
     * Event handler for PLUGIN_STRUCT_TYPECLASS_INIT
     *
     * @param \Doku_Event $event
     * @param            $param
     */
    final public function registerTypeWithStructPlugin(\Doku_Event $event, $param)
    {
        $event->data['Section'] = 'dokuwiki\\plugin\\structsection\\types\\Section';
    }
}

// vim:ts=4:sw=4:et: