xref: /plugin/combo/syntax/header.php (revision 21913ab3235d516e2fa19c7e3929b555b3a2bda1)
1007225e5Sgerardnico<?php
2007225e5Sgerardnico
3007225e5Sgerardnico
4007225e5Sgerardnicouse ComboStrap\HeaderUtility;
5007225e5Sgerardnicouse ComboStrap\PluginUtility;
6007225e5Sgerardnicouse ComboStrap\StringUtility;
7007225e5Sgerardnicouse ComboStrap\Tag;
8*21913ab3SNickeauuse ComboStrap\TagAttributes;
9007225e5Sgerardnico
10007225e5Sgerardnicorequire_once(__DIR__ . '/../class/HeaderUtility.php');
11007225e5Sgerardnico
12007225e5Sgerardnicoif (!defined('DOKU_INC')) die();
13007225e5Sgerardnico
14007225e5Sgerardnico
15007225e5Sgerardnicoclass syntax_plugin_combo_header extends DokuWiki_Syntax_Plugin
16007225e5Sgerardnico{
17007225e5Sgerardnico
18007225e5Sgerardnico
19*21913ab3SNickeau    const TAG = "header";
20*21913ab3SNickeau
21007225e5Sgerardnico    function getType()
22007225e5Sgerardnico    {
23007225e5Sgerardnico        return 'formatting';
24007225e5Sgerardnico    }
25007225e5Sgerardnico
26007225e5Sgerardnico    /**
27007225e5Sgerardnico     * How Dokuwiki will add P element
28007225e5Sgerardnico     *
29007225e5Sgerardnico     *  * 'normal' - The plugin can be used inside paragraphs (inline)
30007225e5Sgerardnico     *  * 'block'  - Open paragraphs need to be closed before plugin output - block should not be inside paragraphs
31007225e5Sgerardnico     *  * 'stack'  - Special case. Plugin wraps other paragraphs. - Stacks can contain paragraphs
32007225e5Sgerardnico     *
33007225e5Sgerardnico     * @see DokuWiki_Syntax_Plugin::getPType()
34007225e5Sgerardnico     */
35007225e5Sgerardnico    function getPType()
36007225e5Sgerardnico    {
37*21913ab3SNickeau        return 'block';
38007225e5Sgerardnico    }
39007225e5Sgerardnico
40007225e5Sgerardnico    function getAllowedTypes()
41007225e5Sgerardnico    {
42007225e5Sgerardnico        return array('substition', 'formatting', 'disabled');
43007225e5Sgerardnico    }
44007225e5Sgerardnico
45007225e5Sgerardnico    function getSort()
46007225e5Sgerardnico    {
47007225e5Sgerardnico        return 201;
48007225e5Sgerardnico    }
49007225e5Sgerardnico
50007225e5Sgerardnico
51007225e5Sgerardnico    function connectTo($mode)
52007225e5Sgerardnico    {
53007225e5Sgerardnico
54007225e5Sgerardnico        $this->Lexer->addEntryPattern(PluginUtility::getContainerTagPattern(HeaderUtility::HEADER), $mode, PluginUtility::getModeForComponent($this->getPluginComponent()));
55007225e5Sgerardnico    }
56007225e5Sgerardnico
57007225e5Sgerardnico    public function postConnect()
58007225e5Sgerardnico    {
59007225e5Sgerardnico        $this->Lexer->addExitPattern('</' . HeaderUtility::HEADER . '>', PluginUtility::getModeForComponent($this->getPluginComponent()));
60007225e5Sgerardnico    }
61007225e5Sgerardnico
62007225e5Sgerardnico    function handle($match, $state, $pos, Doku_Handler $handler)
63007225e5Sgerardnico    {
64007225e5Sgerardnico
65007225e5Sgerardnico        switch ($state) {
66007225e5Sgerardnico
67007225e5Sgerardnico            case DOKU_LEXER_ENTER:
68007225e5Sgerardnico                $tagAttributes = PluginUtility::getTagAttributes($match);
695f891b7eSNickeau                $tag = new Tag(HeaderUtility::HEADER, $tagAttributes, $state, $handler);
70007225e5Sgerardnico                $parent = $tag->getParent();
71007225e5Sgerardnico                $parentName = "";
72007225e5Sgerardnico                if ($parent != null) {
73007225e5Sgerardnico                    $parentName = $parent->getName();
74007225e5Sgerardnico                }
75007225e5Sgerardnico                return array(
76007225e5Sgerardnico                    PluginUtility::STATE => $state,
77007225e5Sgerardnico                    PluginUtility::ATTRIBUTES => $tagAttributes,
785f891b7eSNickeau                    PluginUtility::CONTEXT => $parentName
79007225e5Sgerardnico                );
80007225e5Sgerardnico
81007225e5Sgerardnico            case DOKU_LEXER_UNMATCHED :
82007225e5Sgerardnico                return array(
83007225e5Sgerardnico                    PluginUtility::STATE => $state,
84007225e5Sgerardnico                    PluginUtility::PAYLOAD => $match);
85007225e5Sgerardnico
86007225e5Sgerardnico            case DOKU_LEXER_EXIT :
87007225e5Sgerardnico                return array(
88*21913ab3SNickeau                    PluginUtility::STATE => $state
89007225e5Sgerardnico                );
90007225e5Sgerardnico
91007225e5Sgerardnico
92007225e5Sgerardnico        }
93007225e5Sgerardnico        return array();
94007225e5Sgerardnico
95007225e5Sgerardnico    }
96007225e5Sgerardnico
97007225e5Sgerardnico    /**
98007225e5Sgerardnico     * Render the output
99007225e5Sgerardnico     * @param string $format
100007225e5Sgerardnico     * @param Doku_Renderer $renderer
101007225e5Sgerardnico     * @param array $data - what the function handle() return'ed
102007225e5Sgerardnico     * @return boolean - rendered correctly? (however, returned value is not used at the moment)
103007225e5Sgerardnico     * @see DokuWiki_Syntax_Plugin::render()
104007225e5Sgerardnico     *
105007225e5Sgerardnico     *
106007225e5Sgerardnico     */
107007225e5Sgerardnico    function render($format, Doku_Renderer $renderer, $data)
108007225e5Sgerardnico    {
109007225e5Sgerardnico
110007225e5Sgerardnico        if ($format == 'xhtml') {
111007225e5Sgerardnico
112007225e5Sgerardnico            /** @var Doku_Renderer_xhtml $renderer */
113007225e5Sgerardnico            $state = $data[PluginUtility::STATE];
114007225e5Sgerardnico            switch ($state) {
115007225e5Sgerardnico
116007225e5Sgerardnico                case DOKU_LEXER_ENTER:
1175f891b7eSNickeau                    $parent = $data[PluginUtility::CONTEXT];
118007225e5Sgerardnico                    switch ($parent) {
119007225e5Sgerardnico                        case syntax_plugin_combo_blockquote::TAG:
120007225e5Sgerardnico                        case syntax_plugin_combo_card::TAG:
121*21913ab3SNickeau                        default:
122*21913ab3SNickeau                            $tagAttributes = TagAttributes::createFromCallStackArray($data[PluginUtility::ATTRIBUTES]);
123*21913ab3SNickeau                            $tagAttributes->addClassName("card-header");
124*21913ab3SNickeau                            $renderer->doc .= $tagAttributes->toHtmlEnterTag("div");
125007225e5Sgerardnico                            break;
126007225e5Sgerardnico                    }
127007225e5Sgerardnico                    break;
128007225e5Sgerardnico
129007225e5Sgerardnico                case DOKU_LEXER_UNMATCHED :
13032b85071SNickeau                    $renderer->doc .= PluginUtility::renderUnmatched($data);
131007225e5Sgerardnico                    break;
132007225e5Sgerardnico
133007225e5Sgerardnico                case DOKU_LEXER_EXIT:
134*21913ab3SNickeau                    $renderer->doc .= "</div>". DOKU_LF;
135007225e5Sgerardnico                    break;
136007225e5Sgerardnico
137007225e5Sgerardnico
138007225e5Sgerardnico            }
139007225e5Sgerardnico        }
140007225e5Sgerardnico        // unsupported $mode
141007225e5Sgerardnico        return false;
142007225e5Sgerardnico    }
143007225e5Sgerardnico
144007225e5Sgerardnico
145007225e5Sgerardnico}
146007225e5Sgerardnico
147