From cfa2b40e6bb053ff32af7199e4177fbbb92b0a57 Mon Sep 17 00:00:00 2001
From: Andreas Gohr <andi@splitbrain.org>
Date: Sat, 24 May 2014 14:00:43 +0200
Subject: [PATCH] added doc blocks to all functions in renderer
---
inc/parser/renderer.php | 492 ++++++++++++++++++++++++++++++++++++----
1 file changed, 447 insertions(+), 45 deletions(-)
diff --git a/inc/parser/renderer.php b/inc/parser/renderer.php
index 71eeda952..a486ed106 100644
--- a/inc/parser/renderer.php
+++ b/inc/parser/renderer.php
@@ -13,52 +13,79 @@ if(!defined('DOKU_INC')) die('meh.');
* Inherits from DokuWiki_Plugin for giving additional functions to render plugins
*/
class Doku_Renderer extends DokuWiki_Plugin {
- var $info = array(
+ /** @var array Settings, control the behavior of the renderer */
+ public $info = array(
'cache' => true, // may the rendered result cached?
'toc' => true, // render the TOC?
);
- var $doc = '';
+ /** @var array contains the smiley configuration, set in p_render() */
+ public $smileys = array();
+ /** @var array contains the entity configuration, set in p_render() */
+ public $entities = array();
+ /** @var array contains the acronym configuration, set in p_render() */
+ public $acronyms = array();
+ /** @var array contains the interwiki configuration, set in p_render() */
+ public $interwiki = array();
- // keep some config options
- var $acronyms = array();
- var $smileys = array();
- var $badwords = array();
- var $entities = array();
- var $interwiki = array();
+ /**
+ * @var string the rendered document, this will be cached after the renderer ran through
+ */
+ public $doc = '';
- // allows renderer to be used again, clean out any per-use values
+ /**
+ * clean out any per-use values
+ *
+ * This is called before each use of the renderer object and should be used to
+ * completely reset the state of the renderer to be reused for a new document
+ */
function reset() {
}
- function nocache() {
- $this->info['cache'] = false;
- }
-
- function notoc() {
- $this->info['toc'] = false;
+ /**
+ * Allow the plugin to prevent DokuWiki from reusing an instance
+ *
+ * Since most renderer plugins fail to implement Doku_Renderer::reset() we default
+ * to reinstantiating the renderer here
+ *
+ * @return bool false if the plugin has to be instantiated
+ */
+ function isSingleton() {
+ return false;
}
/**
* Returns the format produced by this renderer.
*
- * Has to be overidden by decendend classes
+ * Has to be overidden by sub classes
+ *
+ * @return string
*/
function getFormat() {
trigger_error('getFormat() not implemented in '.get_class($this), E_USER_WARNING);
+ return '';
}
/**
- * Allow the plugin to prevent DokuWiki from reusing an instance
+ * Disable caching of this renderer's output
+ */
+ function nocache() {
+ $this->info['cache'] = false;
+ }
+
+ /**
+ * Disable TOC generation for this renderer's output
*
- * @return bool false if the plugin has to be instantiated
+ * This might not be used for certain sub renderer
*/
- function isSingleton() {
- return false;
+ function notoc() {
+ $this->info['toc'] = false;
}
/**
- * handle plugin rendering
+ * Handle plugin rendering
+ *
+ * Most likely this needs NOT to be overwritten by sub classes
*
* @param string $name Plugin name
* @param mixed $data custom data set by handler
@@ -66,6 +93,7 @@ class Doku_Renderer extends DokuWiki_Plugin {
* @param string $match raw matched syntax
*/
function plugin($name, $data, $state = '', $match = '') {
+ /** @var DokuWiki_Syntax_Plugin $plugin */
$plugin = plugin_load('syntax', $name);
if($plugin != null) {
$plugin->render($this->getFormat(), $this, $data);
@@ -75,9 +103,10 @@ class Doku_Renderer extends DokuWiki_Plugin {
/**
* handle nested render instructions
* this method (and nest_close method) should not be overloaded in actual renderer output classes
+ *
+ * @param array $instructions
*/
function nest($instructions) {
-
foreach($instructions as $instruction) {
// execute the callback against ourself
if(method_exists($this, $instruction[0])) {
@@ -86,267 +115,638 @@ class Doku_Renderer extends DokuWiki_Plugin {
}
}
- // dummy closing instruction issued by Doku_Handler_Nest, normally the syntax mode should
- // override this instruction when instantiating Doku_Handler_Nest - however plugins will not
- // be able to - as their instructions require data.
+ /**
+ * dummy closing instruction issued by Doku_Handler_Nest
+ *
+ * normally the syntax mode should override this instruction when instantiating Doku_Handler_Nest -
+ * however plugins will not be able to - as their instructions require data.
+ */
function nest_close() {
}
+ #region Syntax modes - sub classes will need to implement them to fill $doc
+
+ /**
+ * Initialize the document
+ */
function document_start() {
}
+ /**
+ * Finalize the document
+ */
function document_end() {
}
+ /**
+ * Render the Table of Contents
+ *
+ * @return string
+ */
function render_TOC() {
return '';
}
+ /**
+ * Add an item to the TOC
+ *
+ * @param string $id the hash link
+ * @param string $text the text to display
+ * @param int $level the nesting level
+ */
function toc_additem($id, $text, $level) {
}
+ /**
+ * Render a heading
+ *
+ * @param string $text the text to display
+ * @param int $level header level
+ * @param int $pos byte position in the original source
+ */
function header($text, $level, $pos) {
}
+ /**
+ * Open a new section
+ *
+ * @param int $level section level (as determined by the previous header)
+ */
function section_open($level) {
}
+ /**
+ * Close the current section
+ */
function section_close() {
}
+ /**
+ * Render plain text data
+ *
+ * @param $text
+ */
function cdata($text) {
}
+ /**
+ * Open a paragraph
+ */
function p_open() {
}
+ /**
+ * Close a paragraph
+ */
function p_close() {
}
+ /**
+ * Create a line breake
+ */
function linebreak() {
}
+ /**
+ * Create a horizontal line
+ */
function hr() {
}
+ /**
+ * Start strong (bold) formatting
+ */
function strong_open() {
}
+ /**
+ * Stop strong (bold) formatting
+ */
function strong_close() {
}
+ /**
+ * Start emphasis (italics) formatting
+ */
function emphasis_open() {
}
+ /**
+ * Stop emphasis (italics) formatting
+ */
function emphasis_close() {
}
+ /**
+ * Start underline formatting
+ */
function underline_open() {
}
+ /**
+ * Stop underline formatting
+ */
function underline_close() {
}
+ /**
+ * Start monospace formatting
+ */
function monospace_open() {
}
+ /**
+ * Stop monospace formatting
+ */
function monospace_close() {
}
+ /**
+ * Start a subscript
+ */
function subscript_open() {
}
+ /**
+ * Stop a subscript
+ */
function subscript_close() {
}
+ /**
+ * Start a superscript
+ */
function superscript_open() {
}
+ /**
+ * Stop a superscript
+ */
function superscript_close() {
}
+ /**
+ * Start deleted (strike-through) formatting
+ */
function deleted_open() {
}
+ /**
+ * Stop deleted (strike-through) formatting
+ */
function deleted_close() {
}
+ /**
+ * Start a footnote
+ */
function footnote_open() {
}
+ /**
+ * Stop a footnote
+ */
function footnote_close() {
}
+ /**
+ * Open an unordered list
+ */
function listu_open() {
}
+ /**
+ * Close an unordered list
+ */
function listu_close() {
}
+ /**
+ * Open an ordered list
+ */
function listo_open() {
}
+ /**
+ * Close an ordered list
+ */
function listo_close() {
}
+ /**
+ * Open a list item
+ *
+ * @param int $level the nesting level
+ */
function listitem_open($level) {
}
+ /**
+ * Close a list item
+ */
function listitem_close() {
}
+ /**
+ * Start the content of a list item
+ */
function listcontent_open() {
}
+ /**
+ * Stop the content of a list item
+ */
function listcontent_close() {
}
+ /**
+ * Output unformatted $text
+ *
+ * Defaults to $this->cdata()
+ *
+ * @param string $text
+ */
function unformatted($text) {
+ $this->cdata($text);
}
+ /**
+ * Output inline PHP code
+ *
+ * If $conf['phpok'] is true this should evaluate the given code and append the result
+ * to $doc
+ *
+ * @param string $text The PHP code
+ */
function php($text) {
}
+ /**
+ * Output block level PHP code
+ *
+ * If $conf['phpok'] is true this should evaluate the given code and append the result
+ * to $doc
+ *
+ * @param string $text The PHP code
+ */
function phpblock($text) {
}
+ /**
+ * Output raw inline HTML
+ *
+ * If $conf['htmlok'] is true this should add the code as is to $doc
+ *
+ * @param string $text The HTML
+ */
function html($text) {
}
+ /**
+ * Output raw block-level HTML
+ *
+ * If $conf['htmlok'] is true this should add the code as is to $doc
+ *
+ * @param string $text The HTML
+ */
function htmlblock($text) {
}
+ /**
+ * Output preformatted text
+ *
+ * @param string $text
+ */
function preformatted($text) {
}
+ /**
+ * Start a block quote
+ */
function quote_open() {
}
+ /**
+ * Stop a block quote
+ */
function quote_close() {
}
+ /**
+ * Display text as file content, optionally syntax highlighted
+ *
+ * @param string $text text to show
+ * @param string $lang programming language to use for syntax highlighting
+ * @param string $file file path label
+ */
function file($text, $lang = null, $file = null) {
}
+ /**
+ * Display text as code content, optionally syntax highlighted
+ *
+ * @param string $text text to show
+ * @param string $lang programming language to use for syntax highlighting
+ * @param string $file file path label
+ */
function code($text, $lang = null, $file = null) {
}
+ /**
+ * Format an acronym
+ *
+ * Uses $this->acronyms
+ *
+ * @param string $acronym
+ */
function acronym($acronym) {
}
+ /**
+ * Format a smiley
+ *
+ * Uses $this->smiley
+ *
+ * @param string $smiley
+ */
function smiley($smiley) {
}
- function wordblock($word) {
- }
-
+ /**
+ * Format an entity
+ *
+ * Entities are basically small text replacements
+ *
+ * Uses $this->entities
+ *
+ * @param string $entity
+ */
function entity($entity) {
}
- // 640x480 ($x=640, $y=480)
+ /**
+ * Typographically format a multiply sign
+ *
+ * Example: ($x=640, $y=480) should result in "640×480"
+ *
+ * @param string|int $x first value
+ * @param string|int $y second value
+ */
function multiplyentity($x, $y) {
}
+ /**
+ * Render an opening single quote char (language specific)
+ */
function singlequoteopening() {
}
+ /**
+ * Render a closing single quote char (language specific)
+ */
function singlequoteclosing() {
}
+ /**
+ * Render an apostrophe char (language specific)
+ */
function apostrophe() {
}
+ /**
+ * Render an opening double quote char (language specific)
+ */
function doublequoteopening() {
}
+ /**
+ * Render an closinging double quote char (language specific)
+ */
function doublequoteclosing() {
}
- // $link like 'SomePage'
+ /**
+ * Render a CamelCase link
+ *
+ * @param string $link The link name
+ * @see http://en.wikipedia.org/wiki/CamelCase
+ */
function camelcaselink($link) {
}
+ /**
+ * Render a page local link
+ *
+ * @param string $hash hash link identifier
+ * @param string $name name for the link
+ */
function locallink($hash, $name = null) {
}
- // $link like 'wiki:syntax', $title could be an array (media)
+ /**
+ * Render a wiki internal link
+ *
+ * @param string $link page ID to link to. eg. 'wiki:syntax'
+ * @param string|array $title name for the link, array for media file
+ */
function internallink($link, $title = null) {
}
- // $link is full URL with scheme, $title could be an array (media)
+ /**
+ * Render an external link
+ *
+ * @param string $link full URL with scheme
+ * @param string|array $title name for the link, array for media file
+ */
function externallink($link, $title = null) {
}
+ /**
+ * Render the output of an RSS feed
+ *
+ * @param string $url URL of the feed
+ * @param array $params Finetuning of the output
+ */
function rss($url, $params) {
}
- // $link is the original link - probably not much use
- // $wikiName is an indentifier for the wiki
- // $wikiUri is the URL fragment to append to some known URL
+ /**
+ * Render an interwiki link
+ *
+ * You may want to use $this->_resolveInterWiki() here
+ *
+ * @param string $link original link - probably not much use
+ * @param string|array $title name for the link, array for media file
+ * @param string $wikiName indentifier (shortcut) for the remote wiki
+ * @param string $wikiUri the fragment parsed from the original link
+ */
function interwikilink($link, $title = null, $wikiName, $wikiUri) {
}
- // Link to file on users OS, $title could be an array (media)
+ /**
+ * Link to file on users OS
+ *
+ * @param string $link the link
+ * @param string|array $title name for the link, array for media file
+ */
function filelink($link, $title = null) {
}
- // Link to a Windows share, , $title could be an array (media)
+ /**
+ * Link to windows share
+ *
+ * @param string $link the link
+ * @param string|array $title name for the link, array for media file
+ */
function windowssharelink($link, $title = null) {
}
-// function email($address, $title = null) {}
+ /**
+ * Render a linked E-Mail Address
+ *
+ * Should honor $conf['mailguard'] setting
+ *
+ * @param string $address Email-Address
+ * @param string $name Display name
+ */
function emaillink($address, $name = null) {
}
+ /**
+ * Render an internal media file
+ *
+ * @param string $src media ID
+ * @param string $title descriptive text
+ * @param string $align left|center|right
+ * @param int $width width of media in pixel
+ * @param int $height height of media in pixel
+ * @param string $cache cache|recache|nocache
+ * @param string $linking linkonly|detail|nolink
+ */
function internalmedia($src, $title = null, $align = null, $width = null,
$height = null, $cache = null, $linking = null) {
}
+ /**
+ * Render an external media file
+ *
+ * @param string $src full media URL
+ * @param string $title descriptive text
+ * @param string $align left|center|right
+ * @param int $width width of media in pixel
+ * @param int $height height of media in pixel
+ * @param string $cache cache|recache|nocache
+ * @param string $linking linkonly|detail|nolink
+ */
function externalmedia($src, $title = null, $align = null, $width = null,
$height = null, $cache = null, $linking = null) {
}
- function internalmedialink(
- $src, $title = null, $align = null, $width = null, $height = null, $cache = null
- ) {
+ /**
+ * Render a link to an internal media file
+ *
+ * @param string $src media ID
+ * @param string $title descriptive text
+ * @param string $align left|center|right
+ * @param int $width width of media in pixel
+ * @param int $height height of media in pixel
+ * @param string $cache cache|recache|nocache
+ */
+ function internalmedialink($src, $title = null, $align = null,
+ $width = null, $height = null, $cache = null) {
}
- function externalmedialink(
- $src, $title = null, $align = null, $width = null, $height = null, $cache = null
- ) {
+ /**
+ * Render a link to an external media file
+ *
+ * @param string $src media ID
+ * @param string $title descriptive text
+ * @param string $align left|center|right
+ * @param int $width width of media in pixel
+ * @param int $height height of media in pixel
+ * @param string $cache cache|recache|nocache
+ */
+ function externalmedialink($src, $title = null, $align = null,
+ $width = null, $height = null, $cache = null) {
}
+ /**
+ * Start a table
+ *
+ * @param int $maxcols maximum number of columns
+ * @param int $numrows NOT IMPLEMENTED
+ * @param int $pos byte position in the original source
+ */
function table_open($maxcols = null, $numrows = null, $pos = null) {
}
+ /**
+ * Close a table
+ *
+ * @param int $pos byte position in the original source
+ */
function table_close($pos = null) {
}
+ /**
+ * Open a table header
+ */
function tablethead_open() {
}
+ /**
+ * Close a table header
+ */
function tablethead_close() {
}
+ /**
+ * Open a table row
+ */
function tablerow_open() {
}
+ /**
+ * Close a table row
+ */
function tablerow_close() {
}
+ /**
+ * Open a table header cell
+ *
+ * @param int $colspan
+ * @param string $align left|center|right
+ * @param int $rowspan
+ */
function tableheader_open($colspan = 1, $align = null, $rowspan = 1) {
}
+ /**
+ * Close a table header cell
+ */
function tableheader_close() {
}
+ /**
+ * Open a table cell
+ *
+ * @param int $colspan
+ * @param string $align left|center|right
+ * @param int $rowspan
+ */
function tablecell_open($colspan = 1, $align = null, $rowspan = 1) {
}
+ /**
+ * Close a table cell
+ */
function tablecell_close() {
}
- // util functions follow, you probably won't need to reimplement them
+ #endregion
+
+ #region util functions, you probably won't need to reimplement them
/**
* Removes any Namespace from the given name but keeps
@@ -412,6 +812,8 @@ class Doku_Renderer extends DokuWiki_Plugin {
return $url;
}
+
+ #endregion
}
--
GitLab