xref: /plugin/struct/syntax/table.php (revision b2c109bd1e2ec6f37af93ffae58280d05785c6aa) 
1<?php
2/**
3 * DokuWiki Plugin struct (Syntax Component)
4 *
5 * @license GPL 2 http://www.gnu.org/licenses/gpl-2.0.html
6 * @author  Andreas Gohr, Michael Große <dokuwiki@cosmocode.de>
7 */
8
9
10use dokuwiki\plugin\struct\meta\AggregationTable;
11use dokuwiki\plugin\struct\meta\ConfigParser;
12use dokuwiki\plugin\struct\meta\SearchConfig;
13use dokuwiki\plugin\struct\meta\StructException;
14
15// must be run within Dokuwiki
16if (!defined('DOKU_INC')) die();
17
18class syntax_plugin_struct_table extends DokuWiki_Syntax_Plugin {
19    /**
20     * @return string Syntax mode type
21     */
22    public function getType() {
23        return 'substition';
24    }
25    /**
26     * @return string Paragraph type
27     */
28    public function getPType() {
29        return 'block';
30    }
31    /**
32     * @return int Sort order - Low numbers go before high numbers
33     */
34    public function getSort() {
35        return 155;
36    }
37
38    /**
39     * Connect lookup pattern to lexer.
40     *
41     * @param string $mode Parser mode
42     */
43    public function connectTo($mode) {
44        $this->Lexer->addSpecialPattern('----+ *struct table *-+\n.*?\n----+', $mode, 'plugin_struct_table');
45    }
46
47
48    /**
49     * Handle matches of the struct syntax
50     *
51     * @param string $match The match of the syntax
52     * @param int    $state The state of the handler
53     * @param int    $pos The position in the document
54     * @param Doku_Handler    $handler The handler
55     * @return array Data for the renderer
56     */
57    public function handle($match, $state, $pos, Doku_Handler $handler){
58        global $conf;
59
60        $lines = explode("\n", $match);
61        array_shift($lines);
62        array_pop($lines);
63
64        try {
65            $parser = new ConfigParser($lines);
66            $config = $parser->getConfig();
67            /** @var helper_plugin_struct $struct_helper */
68            $struct_helper = plugin_load('helper', 'struct');
69            foreach ($config['schemas'] as $schema) {
70                $result = $struct_helper->getSchema($schema[0]);
71                if (!$result[$schema[0]]->getId()) {
72                    throw new StructException(sprintf($this->getLang('error:schema missing'), $schema[0]));
73                }
74            }
75            return $config;
76        } catch (StructException $e) {
77            msg($e->getMessage(), -1, $e->getLine(), $e->getFile());
78            if($conf['allowdebug']) msg('<pre>'.hsc($e->getTraceAsString()).'</pre>', -1);
79            return null;
80        }
81    }
82
83    /**
84     * Render xhtml output or metadata
85     *
86     * @param string         $mode      Renderer mode (supported modes: xhtml)
87     * @param Doku_Renderer  $renderer  The renderer
88     * @param array          $data      The data from the handler() function
89     * @return bool If rendering was successful.
90     */
91    public function render($mode, Doku_Renderer $renderer, $data) {
92        if(!$data) return false;
93        global $ID;
94        global $conf;
95
96        try {
97            $search = new SearchConfig($data);
98            $table = new AggregationTable($ID, $mode, $renderer, $search);
99            $table->render();
100
101            if($mode == 'metadata') {
102                /** @var Doku_Renderer_metadata $renderer  */
103                $renderer->meta['plugin']['struct']['hasaggregation'] = $search->getCacheFlag();
104            }
105
106        } catch (StructException $e) {
107            msg($e->getMessage(), -1, $e->getLine(), $e->getFile());
108            if($conf['allowdebug']) msg('<pre>'.hsc($e->getTraceAsString()).'</pre>', -1);
109        }
110
111        return true;
112    }
113}
114
115// vim:ts=4:sw=4:et:
116