<?php
/**
 * Plugin imagereference
 *
 * Syntax: <imgref linkname> - creates a figure link to an image
 *         <tabref linkname> - creates a table link to a table
 *
 * @license    GPL 2 (http://www.gnu.org/licenses/gpl.html)
 * @author     Martin Heinemann <info@martinheinemann.net>
 * @author     Gerrit Uitslag <klapinklapin@gmail.com>
 * @author     Philipp Imhof <dev@imhof.cc>
 */


/**
 * All DokuWiki plugins to extend the parser/rendering mechanism
 * need to inherit from this class
 */
class syntax_plugin_imagereference_imgref extends DokuWiki_Syntax_Plugin {

    /**
     * @return string Syntax type
     */
    function getType() {
        return 'substition';
    }
    /**
     * @return string Paragraph type
     */
    function getPType() {
        return 'normal';
    }
    /**
     * @return int Sort order
     */
    function getSort() {
        return 197;
    }

    /**
     * Connect lookup pattern to lexer.
     *
     * @param string $mode Parser mode
     */
    function connectTo($mode) {
        $this->Lexer->addSpecialPattern('<imgref.*?>', $mode, 'plugin_imagereference_imgref');
        $this->Lexer->addSpecialPattern('<tabref.*?>', $mode, 'plugin_imagereference_imgref');
        $this->Lexer->addSpecialPattern('<ggbref.*?>', $mode, 'plugin_imagereference_imgref');
    }
    /**
     * Handle matches of the imgref syntax
     *
     * @param string $match The match of the syntax
     * @param int    $state The state of the handler
     * @param int    $pos The position in the document
     * @param Doku_Handler    $handler The handler
     * @return false|array Data for the renderer
     */
    function handle($match, $state, $pos, Doku_Handler $handler) {
        $reftype = substr($match, 1, 3);
        $ref = substr($match, 7, -1);

        $parts = explode('#', $ref, 2);
        if(count($parts) == 1) {
            $page = '';
            $ref = $parts[0];
        } else {
            $page = $parts[0];
            $ref = $parts[1];
        }

        if($ref != '') {
            return array(
                'page' => trim($page),
                'caprefname' => trim($ref),
                'type'    => $reftype
            );
        }
        return false;
    }
    /**
     * Render xhtml output or metadata
     *
     * @param string         $mode      Renderer mode (supported modes: xhtml and metadata)
     * @param Doku_Renderer  $renderer  The renderer
     * @param array          $data      The data from the handler function
     * @return bool If rendering was successful.
     */
    function render($mode, Doku_Renderer $renderer, $data) {
        global $ID, $ACT;
        if($data === false) return false;

        switch($mode) {
            case 'xhtml' :
                /** @var Doku_Renderer_xhtml $renderer */

                if($data['page'] == '') {
                    $data['page'] = $ID;
                }
                resolve_pageid(getNS($ID), $data['page'], $exists);

                //determine referencenumber
                if($ACT == 'preview' && $data['page'] == $ID) {
                    $caprefs = syntax_plugin_imagereference_imgcaption::getCaptionreferences($ID, $data['type']);
                } else {
                    $caprefs = p_get_metadata($data['page'], 'captionreferences '.$data['type']);
                }
                if(is_array($caprefs)) {
                    $refNumber = array_search($data['caprefname'], $caprefs);
                } else {
                    $refNumber = false;
                }

                if(!$refNumber) {
                    $refNumber = "##";
                }

                $renderer->doc .= '<a href="'.wl($data['page']).'#'.$data['type'].'_'.cleanID($data['caprefname']).'">'.$this->getLang($data['type'].'full').'&nbsp;'.$refNumber.'</a>';
                return true;

            case 'latex' :
                $renderer->doc .= $this->getLang($data['type'].'full')." \\ref{".$data['caprefname']."}";
                return true;
        }
        return false;
    }
}
//Setup VIM: ex: et ts=4 enc=utf-8 :