xref: /plugin/dwtimeline/syntax/milestone.php (revision adfdabd7bf1d07e505f4aef1b04dc0290dd26249)

<?php

/**
 * DokuWiki Plugin dwtimeline (Syntax Component)
 *
 * @license GPL 2 http://www.gnu.org/licenses/gpl-2.0.html
 * @author  saggi <saggi@gmx.de>
 */

class syntax_plugin_dwtimeline_milestone extends syntax_plugin_dwtimeline_dwtimeline
{
    /** @inheritDoc */
    public function getType()
    {
        return 'plugin_dwtimeline_milestone';
    }

    public function accepts($mode)
    {
        if ($mode == 'plugin_dwtimeline_timeline') {
            return true;
        }
        return parent::accepts($mode);
    }

    /**
     * @return array Things that may be inside the syntax
     */
    public function getAllowedTypes()
    {
        return ['container', 'formatting', 'substition', 'protected', 'disabled', 'paragraphs'];
    }

    /**
     * Set the EntryPattern
     * @param string $mode
     */
    public function connectTo($mode)
    {
        $pattern = '<milestone\b(?:[^>"\']+|"(?:[^"\\\\]|\\\\.)*"|\'(?:[^\'\\\\]|\\\\.)*\')*>(?=.*?\</milestone>)';
        $this->Lexer->addEntryPattern($pattern, $mode, 'plugin_dwtimeline_milestone');
    }

    /**
     * Set the ExitPattern
     */
    public function postConnect()
    {
        $this->Lexer->addExitPattern('</milestone\>', 'plugin_dwtimeline_milestone');
    }

    /**
     * Handle the match
     * @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 array Data for the renderer
     */
    public function handle($match, $state, $pos, Doku_Handler $handler)
    {
        switch ($state) {
            case DOKU_LEXER_ENTER:
                $match         = trim(substr($match, 10, -1));// returns match between <milestone(10) and >(-1)
                $data          = $this->getTitleMatches($match);
                $data['align'] = parent::$align;
                return [$state, $data];
            case DOKU_LEXER_UNMATCHED:
                return [$state, $match];
            case DOKU_LEXER_EXIT:
                return [$state, ''];
        }
        return [];
    }

    /**
     * Create output
     *
     * @param string        $mode     string     output format being rendered
     * @param Doku_Renderer $renderer the current renderer object
     * @param array         $data     data created by handler()
     * @return  bool                 rendered correctly?
     */
    public function render($mode, Doku_Renderer $renderer, $data)
    {
        if ($mode == 'xhtml') {
            if (!parent::$direction) {
                parent::$direction = $this->getDirection();
            }
            [$state, $indata] = $data;
            switch ($state) {
                case DOKU_LEXER_ENTER:
                    $renderer->doc .= '<div class="container-' . $indata['align'] . ' ';
                    $renderer->doc .= parent::$direction . '"' . $indata['data'] . $indata['style'] . '>' . DOKU_LF;
                    $renderer->doc .= '<div class="tlcontent">' . DOKU_LF;
                    if (isset($indata['title'])) {
                        if (!empty($indata['link'])) {
                            // get back raw title-value
                            $label = htmlspecialchars_decode($indata['title'], ENT_QUOTES);

                            // create link with label
                            $wikilink = '[[' . $indata['link'] . '|' . $label . ']]';

                            // render link
                            $info          = [];
                            $renderer->doc .= '<div class="mstitle">'
                                . p_render('xhtml', p_get_instructions($wikilink), $info)
                                . '</div>' . DOKU_LF;
                        } else {
                            $renderer->doc .= '<div class="mstitle">' . $indata['title'] . '</div>' . DOKU_LF;
                        }
                    }
                    if (isset($indata['description'])) {
                        $renderer->doc .= '<div class="msdesc">' . $indata['description'] . '</div>' . DOKU_LF;
                    }
                    break;
                case DOKU_LEXER_UNMATCHED:
                    $renderer->cdata($indata);
                    break;
                case DOKU_LEXER_EXIT:
                    $renderer->doc     .= '</div>' . DOKU_LF;
                    $renderer->doc     .= '</div>' . DOKU_LF;
                    parent::$direction = $this->changeDirection(parent::$direction);
                    break;
            }
            return true;
        }
        return false;
    }
}