mirror of
https://github.com/cosmocode/dokuwiki-plugin-struct.git
synced 2025-08-03 15:59:53 +00:00
7923cdacab
This refactors the cloud aggregation to make use of the SearchSQLBuilder, this in turn allows for reusing much but not all of the default parameter handling. By allowing joins (on pid) and setting filters we can output clouds based on the same data as a shown aggregation.
112 lines
3.1 KiB
PHP
112 lines
3.1 KiB
PHP
<?php
|
|
|
|
/**
|
|
* DokuWiki Plugin struct (Syntax Component)
|
|
*
|
|
* @license GPL 2 http://www.gnu.org/licenses/gpl-2.0.html
|
|
* @author Andreas Gohr, Michael Große <dokuwiki@cosmocode.de>
|
|
*/
|
|
|
|
use dokuwiki\Extension\SyntaxPlugin;
|
|
use dokuwiki\plugin\struct\meta\AggregationCloud;
|
|
use dokuwiki\plugin\struct\meta\ConfigParser;
|
|
use dokuwiki\plugin\struct\meta\SearchCloud;
|
|
use dokuwiki\plugin\struct\meta\StructException;
|
|
|
|
class syntax_plugin_struct_cloud extends SyntaxPlugin
|
|
{
|
|
/**
|
|
* @return string Syntax mode type
|
|
*/
|
|
public function getType()
|
|
{
|
|
return 'substition';
|
|
}
|
|
|
|
/**
|
|
* @return string Paragraph type
|
|
*/
|
|
public function getPType()
|
|
{
|
|
return 'block';
|
|
}
|
|
|
|
/**
|
|
* @return int Sort order - Low numbers go before high numbers
|
|
*/
|
|
public function getSort()
|
|
{
|
|
return 151;
|
|
}
|
|
|
|
/**
|
|
* Connect lookup pattern to lexer.
|
|
*
|
|
* @param string $mode Parser mode
|
|
*/
|
|
public function connectTo($mode)
|
|
{
|
|
$this->Lexer->addSpecialPattern('----+ *struct cloud *-+\n.*?\n----+', $mode, 'plugin_struct_cloud');
|
|
}
|
|
|
|
/**
|
|
* Handle matches of the struct 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 array Data for the renderer
|
|
*/
|
|
public function handle($match, $state, $pos, Doku_Handler $handler)
|
|
{
|
|
global $conf;
|
|
$lines = explode("\n", $match);
|
|
array_shift($lines);
|
|
array_pop($lines);
|
|
|
|
try {
|
|
$parser = new ConfigParser($lines);
|
|
$config = $parser->getConfig();
|
|
return $config;
|
|
} catch (StructException $e) {
|
|
msg($e->getMessage(), -1, $e->getLine(), $e->getFile());
|
|
if ($conf['allowdebug']) msg('<pre>' . hsc($e->getTraceAsString()) . '</pre>', -1);
|
|
return null;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Render xhtml output or metadata
|
|
*
|
|
* @param string $mode Renderer mode (supported modes: xhtml)
|
|
* @param Doku_Renderer $renderer The renderer
|
|
* @param array $data The data from the handler() function
|
|
* @return bool If rendering was successful.
|
|
*/
|
|
public function render($mode, Doku_Renderer $renderer, $data)
|
|
{
|
|
if ($mode != 'xhtml') return false;
|
|
if (!$data) return false;
|
|
global $INFO, $conf;
|
|
try {
|
|
$search = new SearchCloud($data);
|
|
$cloud = new AggregationCloud($INFO['id'], $mode, $renderer, $search);
|
|
$cloud->startScope();
|
|
$cloud->render();
|
|
$cloud->finishScope();
|
|
if ($mode == 'metadata') {
|
|
/** @var Doku_Renderer_metadata $renderer */
|
|
$renderer->meta['plugin']['struct']['hasaggregation'] = $search->getCacheFlag();
|
|
}
|
|
} catch (StructException $e) {
|
|
msg($e->getMessage(), -1, $e->getLine(), $e->getFile());
|
|
if ($conf['allowdebug']) msg('<pre>' . hsc($e->getTraceAsString()) . '</pre>', -1);
|
|
}
|
|
|
|
return true;
|
|
}
|
|
}
|
|
|
|
// vim:ts=4:sw=4:et:
|