action.php

<?php
/**
 * DokuWiki Plugin DocNavigation (Action Component)
 *
 * @license GPL 2 http://www.gnu.org/licenses/gpl-2.0.html
 * @author  Gerrit Uitslag <klapinklapin@gmail.com>
 */

use dokuwiki\Extension\ActionPlugin;
use dokuwiki\Extension\Event;
use dokuwiki\Extension\EventHandler;

/**
 * Add documentation navigation elements around page
 */
class action_plugin_docnavigation extends ActionPlugin
{

    /**
     * Register the events
     *
     * @param EventHandler $controller
     */
    public function register(EventHandler $controller)
    {
        $controller->register_hook('RENDERER_CONTENT_POSTPROCESS', 'AFTER', $this, 'addtopnavigation');
    }

    /**
     * Add navigation bar to top of content
     *
     * @param Event $event
     */
    public function addtopnavigation(Event $event)
    {
        global $ACT;

        if ($event->data[0] != 'xhtml' || !in_array($ACT, ['show', 'preview'])) return;

        $event->data[1] = $this->htmlNavigationbar(false)
            . $event->data[1]
            . $this->htmlNavigationbar(true);
    }

    /**
     * Return html of navigation elements
     *
     * @param bool $linktoToC if true, add referer to ToC
     * @return string
     */
    private function htmlNavigationbar($linktoToC)
    {
        global $ID;
        global $ACT;
        $data = null;
        if ($ACT == 'preview') {
            // the RENDERER_CONTENT_POSTPROCESS event is triggered just after rendering the instruction,
            // so syntax instance will exists
            /** @var syntax_plugin_docnavigation_pagenav $pagenav */
            $pagenav = plugin_load('syntax', 'docnavigation_pagenav');
            if ($pagenav instanceof syntax_plugin_docnavigation_pagenav) {
                $data = $pagenav->getPageData($ID);
            }
        } else {
            $data = p_get_metadata($ID, 'docnavigation');
        }

        $out = '';
        if (!empty($data)) {
            if ($linktoToC) {
                $out .= '<div class="clearer"></div>';
            }

            $out .= '<div class="docnavbar' . ($linktoToC ? ' showtoc' : '') . '"><div class="leftnav">';
            if ($data['previous']['link']) {
                $out .= '← ' . $this->htmlLink($data['previous']);
            }
            $out .= '&nbsp;</div>';

            if ($linktoToC) {
                $out .= '<div class="centernav">';
                if ($data['toc']['link']) {
                    $out .= $this->htmlLink($data['toc']);
                }
                $out .= '&nbsp;</div>';
            }

            $out .= '<div class="rightnav">&nbsp;';
            if ($data['next']['link']) {
                $out .= $this->htmlLink($data['next']) . ' →';
            }
            $out .= '</div></div>';
        }
        return $out;
    }

    /**
     * Build nice url title, if no title given use original link with original not cleaned id
     *
     * @param array $link with: 'link' => string full page id, 'title' => null|string, 'rawlink' => string original not cleaned id, 'hash' => string
     * @return string
     */
    protected function htmlLink($link) {
        /** @var Doku_Renderer_xhtml $Renderer */
        static $Renderer = null;
        if (is_null($Renderer)) {
            $Renderer = p_get_renderer('xhtml');
        }

        $title = $this->getTitle($link, $Renderer);
        $id = ':' . $link['link'] . '#' . $link['hash'];
        return $Renderer->internallink($id, $title, null, true);
    }

    /**
     * Build nice url title, if no title given use original link with original not cleaned id
     *
     * @param array $link with: 'link' => string full page id, 'title' => null|string, 'rawlink' => string original not cleaned id, 'hash' => string
     * @param Doku_Renderer_xhtml $Renderer
     * @return string
     */
    protected function getTitle($link, $Renderer)
    {
        if ($link['title'] === null) {
            $defaulttitle = $Renderer->_simpleTitle($link['rawlink']);
            return $Renderer->_getLinkTitle(null, $defaulttitle, $isImage, $link['link']);
        }
        return $link['title'];
    }
}