1549a0837SAndreas Gohr<?php 2549a0837SAndreas Gohr/** 3549a0837SAndreas Gohr * DokuWiki Plugin struct (Syntax Component) 4549a0837SAndreas Gohr * 5549a0837SAndreas Gohr * @license GPL 2 http://www.gnu.org/licenses/gpl-2.0.html 6549a0837SAndreas Gohr * @author Andreas Gohr, Michael Große <dokuwiki@cosmocode.de> 7549a0837SAndreas Gohr */ 8549a0837SAndreas Gohr 9ba766201SAndreas Gohruse dokuwiki\plugin\struct\meta\AggregationTable; 10ba766201SAndreas Gohruse dokuwiki\plugin\struct\meta\ConfigParser; 11ba766201SAndreas Gohruse dokuwiki\plugin\struct\meta\SearchConfig; 12ba766201SAndreas Gohruse dokuwiki\plugin\struct\meta\StructException; 1315929be2SAndreas Gohr 1407993756SAndreas Gohr// must be run within Dokuwiki 15549a0837SAndreas Gohrif(!defined('DOKU_INC')) die(); 16549a0837SAndreas Gohr 17549a0837SAndreas Gohrclass syntax_plugin_struct_table extends DokuWiki_Syntax_Plugin { 183f2a8309SAndreas Gohr 193f2a8309SAndreas Gohr /** @var string which class to use for output */ 203f2a8309SAndreas Gohr protected $tableclass = AggregationTable::class; 213f2a8309SAndreas Gohr 22549a0837SAndreas Gohr /** 23549a0837SAndreas Gohr * @return string Syntax mode type 24549a0837SAndreas Gohr */ 25549a0837SAndreas Gohr public function getType() { 2615929be2SAndreas Gohr return 'substition'; 27549a0837SAndreas Gohr } 283f2a8309SAndreas Gohr 29549a0837SAndreas Gohr /** 30549a0837SAndreas Gohr * @return string Paragraph type 31549a0837SAndreas Gohr */ 32549a0837SAndreas Gohr public function getPType() { 3315929be2SAndreas Gohr return 'block'; 34549a0837SAndreas Gohr } 353f2a8309SAndreas Gohr 36549a0837SAndreas Gohr /** 37549a0837SAndreas Gohr * @return int Sort order - Low numbers go before high numbers 38549a0837SAndreas Gohr */ 39549a0837SAndreas Gohr public function getSort() { 405511bd5bSAndreas Gohr return 155; 41549a0837SAndreas Gohr } 42549a0837SAndreas Gohr 43549a0837SAndreas Gohr /** 44549a0837SAndreas Gohr * Connect lookup pattern to lexer. 45549a0837SAndreas Gohr * 46549a0837SAndreas Gohr * @param string $mode Parser mode 47549a0837SAndreas Gohr */ 48549a0837SAndreas Gohr public function connectTo($mode) { 495511bd5bSAndreas Gohr $this->Lexer->addSpecialPattern('----+ *struct table *-+\n.*?\n----+', $mode, 'plugin_struct_table'); 50549a0837SAndreas Gohr } 51549a0837SAndreas Gohr 52549a0837SAndreas Gohr /** 53549a0837SAndreas Gohr * Handle matches of the struct syntax 54549a0837SAndreas Gohr * 55549a0837SAndreas Gohr * @param string $match The match of the syntax 56549a0837SAndreas Gohr * @param int $state The state of the handler 57549a0837SAndreas Gohr * @param int $pos The position in the document 58549a0837SAndreas Gohr * @param Doku_Handler $handler The handler 59549a0837SAndreas Gohr * @return array Data for the renderer 60549a0837SAndreas Gohr */ 61ab466032SAndreas Gohr public function handle($match, $state, $pos, Doku_Handler $handler) { 62bd363da9SAndreas Gohr global $conf; 63549a0837SAndreas Gohr 645511bd5bSAndreas Gohr $lines = explode("\n", $match); 655511bd5bSAndreas Gohr array_shift($lines); 665511bd5bSAndreas Gohr array_pop($lines); 675511bd5bSAndreas Gohr 685511bd5bSAndreas Gohr try { 695511bd5bSAndreas Gohr $parser = new ConfigParser($lines); 700659dc64SMichael Grosse $config = $parser->getConfig(); 710659dc64SMichael Grosse return $config; 725511bd5bSAndreas Gohr } catch(StructException $e) { 735511bd5bSAndreas Gohr msg($e->getMessage(), -1, $e->getLine(), $e->getFile()); 74bd363da9SAndreas Gohr if($conf['allowdebug']) msg('<pre>' . hsc($e->getTraceAsString()) . '</pre>', -1); 755511bd5bSAndreas Gohr return null; 765511bd5bSAndreas Gohr } 77549a0837SAndreas Gohr } 78549a0837SAndreas Gohr 79549a0837SAndreas Gohr /** 80549a0837SAndreas Gohr * Render xhtml output or metadata 81549a0837SAndreas Gohr * 82549a0837SAndreas Gohr * @param string $mode Renderer mode (supported modes: xhtml) 83549a0837SAndreas Gohr * @param Doku_Renderer $renderer The renderer 84549a0837SAndreas Gohr * @param array $data The data from the handler() function 85549a0837SAndreas Gohr * @return bool If rendering was successful. 86549a0837SAndreas Gohr */ 87ab466032SAndreas Gohr public function render($mode, Doku_Renderer $renderer, $data) { 885511bd5bSAndreas Gohr if(!$data) return false; 89*06fee43aSMichael Grosse global $INFO; 90bd363da9SAndreas Gohr global $conf; 9129877279SMichael Große 9215929be2SAndreas Gohr try { 935511bd5bSAndreas Gohr $search = new SearchConfig($data); 946ce83f43SAndreas Gohr if($mode == 'struct_csv') { 956ce83f43SAndreas Gohr // no pagination in export 966ce83f43SAndreas Gohr $search->setLimit(0); 976ce83f43SAndreas Gohr $search->setOffset(0); 986ce83f43SAndreas Gohr } 996ce83f43SAndreas Gohr 1003f2a8309SAndreas Gohr /** @var AggregationTable $table */ 101*06fee43aSMichael Grosse $table = new $this->tableclass($INFO['id'], $mode, $renderer, $search); 10207993756SAndreas Gohr $table->render(); 10316b7d914SAndreas Gohr 10416b7d914SAndreas Gohr if($mode == 'metadata') { 10516b7d914SAndreas Gohr /** @var Doku_Renderer_metadata $renderer */ 10616b7d914SAndreas Gohr $renderer->meta['plugin']['struct']['hasaggregation'] = $search->getCacheFlag(); 10716b7d914SAndreas Gohr } 10816b7d914SAndreas Gohr 1095511bd5bSAndreas Gohr } catch(StructException $e) { 11015929be2SAndreas Gohr msg($e->getMessage(), -1, $e->getLine(), $e->getFile()); 111bd363da9SAndreas Gohr if($conf['allowdebug']) msg('<pre>' . hsc($e->getTraceAsString()) . '</pre>', -1); 11215929be2SAndreas Gohr } 11315929be2SAndreas Gohr 114549a0837SAndreas Gohr return true; 115549a0837SAndreas Gohr } 116549a0837SAndreas Gohr} 117