1<?php 2/** 3 * Syntax Plugin Prototype 4 * 5 * @license GPL 2 (http://www.gnu.org/licenses/gpl.html) 6 * @author Andreas Gohr <andi@splitbrain.org> 7 */ 8// must be run within Dokuwiki 9if(!defined('DOKU_INC')) die(); 10 11/** 12 * All DokuWiki plugins to extend the parser/rendering mechanism 13 * need to inherit from this class 14 */ 15class DokuWiki_Syntax_Plugin extends Doku_Parser_Mode_Plugin { 16 17 var $allowedModesSetup = false; 18 19 /** 20 * Syntax Type 21 * 22 * Needs to return one of the mode types defined in $PARSER_MODES in parser.php 23 * 24 * @return string 25 */ 26 function getType(){ 27 trigger_error('getType() not implemented in '.get_class($this), E_USER_WARNING); 28 return ''; 29 } 30 31 /** 32 * Allowed Mode Types 33 * 34 * Defines the mode types for other dokuwiki markup that maybe nested within the 35 * plugin's own markup. Needs to return an array of one or more of the mode types 36 * defined in $PARSER_MODES in parser.php 37 * 38 * @return array 39 */ 40 function getAllowedTypes() { 41 return array(); 42 } 43 44 /** 45 * Paragraph Type 46 * 47 * Defines how this syntax is handled regarding paragraphs. This is important 48 * for correct XHTML nesting. Should return one of the following: 49 * 50 * 'normal' - The plugin can be used inside paragraphs 51 * 'block' - Open paragraphs need to be closed before plugin output 52 * 'stack' - Special case. Plugin wraps other paragraphs. 53 * 54 * @see Doku_Handler_Block 55 * @return string 56 */ 57 function getPType(){ 58 return 'normal'; 59 } 60 61 /** 62 * Handler to prepare matched data for the rendering process 63 * 64 * This function can only pass data to render() via its return value - render() 65 * may be not be run during the object's current life. 66 * 67 * Usually you should only need the $match param. 68 * 69 * @param string $match The text matched by the patterns 70 * @param int $state The lexer state for the match 71 * @param int $pos The character position of the matched text 72 * @param Doku_Handler $handler The Doku_Handler object 73 * @return array Return an array with all data you want to use in render 74 */ 75 function handle($match, $state, $pos, Doku_Handler $handler){ 76 trigger_error('handle() not implemented in '.get_class($this), E_USER_WARNING); 77 } 78 79 /** 80 * Handles the actual output creation. 81 * 82 * The function must not assume any other of the classes methods have been run 83 * during the object's current life. The only reliable data it receives are its 84 * parameters. 85 * 86 * The function should always check for the given output format and return false 87 * when a format isn't supported. 88 * 89 * $renderer contains a reference to the renderer object which is 90 * currently handling the rendering. You need to use it for writing 91 * the output. How this is done depends on the renderer used (specified 92 * by $format 93 * 94 * The contents of the $data array depends on what the handler() function above 95 * created 96 * 97 * @param $format string output format being rendered 98 * @param $renderer Doku_Renderer the current renderer object 99 * @param $data array data created by handler() 100 * @return boolean rendered correctly? 101 */ 102 function render($format, Doku_Renderer $renderer, $data) { 103 trigger_error('render() not implemented in '.get_class($this), E_USER_WARNING); 104 105 } 106 107 /** 108 * There should be no need to override this function 109 * 110 * @param string $mode 111 * @return bool 112 */ 113 function accepts($mode) { 114 115 if (!$this->allowedModesSetup) { 116 global $PARSER_MODES; 117 118 $allowedModeTypes = $this->getAllowedTypes(); 119 foreach($allowedModeTypes as $mt) { 120 $this->allowedModes = array_merge($this->allowedModes, $PARSER_MODES[$mt]); 121 } 122 123 $idx = array_search(substr(get_class($this), 7), (array) $this->allowedModes); 124 if ($idx !== false) { 125 unset($this->allowedModes[$idx]); 126 } 127 $this->allowedModesSetup = true; 128 } 129 130 return parent::accepts($mode); 131 } 132} 133//Setup VIM: ex: et ts=4 : 134