| [ Index ] |
PHP Cross Reference of DokuWiki |
[Source view] [Print] [Project Stats]
Utilities for accessing the parser
| Author: | Harry Fuecks |
| Author: | Andreas Gohr |
| License: | GPL 2 (http://www.gnu.org/licenses/gpl.html) |
| File Size: | 829 lines (28 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 1 file inc/parser/parser.php |
| p_wiki_xhtml($id, $rev = '', $excuse = true, $date_at = '') X-Ref |
| Returns the parsed Wikitext in XHTML for the given id and revision. If $excuse is true an explanation is returned if the file wasn't found param: string $id page id param: string|int $rev revision timestamp or empty string param: bool $excuse param: string $date_at return: null|string author: Andreas Gohr <andi@splitbrain.org> |
| p_locale_xhtml($id) X-Ref |
| Returns the specified local text in parsed format param: string $id page id return: null|string author: Andreas Gohr <andi@splitbrain.org> |
| p_cached_output($file, $format = 'xhtml', $id = '') X-Ref |
| Returns the given file parsed into the requested output format param: string $file filename, path to file param: string $format param: string $id page id return: null|string author: Andreas Gohr <andi@splitbrain.org> author: Chris Smith <chris@jalakai.co.uk> |
| p_cached_instructions($file, $cacheonly = false, $id = '') X-Ref |
| Returns the render instructions for a file Uses and creates a serialized cache file param: string $file filename, path to file param: bool $cacheonly param: string $id page id return: array|null author: Andreas Gohr <andi@splitbrain.org> |
| p_get_instructions($text) X-Ref |
| turns a page into a list of instructions param: string $text raw wiki syntax text return: array a list of instruction arrays author: Harry Fuecks <hfuecks@gmail.com> author: Andreas Gohr <andi@splitbrain.org> |
| p_get_metadata($id, $key = '', $render = METADATA_RENDER_USING_CACHE) X-Ref |
| returns the metadata of a page param: string $id The id of the page the metadata should be returned from param: string $key The key of the metdata value that shall be read (by default everything) param: int $render If the page should be rendererd - possible values: return: mixed The requested metadata fields author: Esther Brunner <esther@kaffeehaus.ch> author: Michael Hamann <michael@content-space.de> |
| p_set_metadata($id, $data, $render = false, $persistent = true) X-Ref |
| sets metadata elements of a page see: http://www.dokuwiki.org/devel:metadata#functions_to_get_and_set_metadata param: string $id is the ID of a wiki page param: array $data is an array with key ⇒ value pairs to be set in the metadata param: boolean $render whether or not the page metadata should be generated with the renderer param: boolean $persistent indicates whether or not the particular metadata value will persist through return: boolean true on success author: Esther Brunner <esther@kaffeehaus.ch> author: Michael Hamann <michael@content-space.de> |
| p_purge_metadata($id) X-Ref |
| Purges the non-persistant part of the meta data used on page deletion param: string $id page id return: bool success / fail author: Michael Klier <chi@chimeric.de> |
| p_read_metadata($id, $cache = false) X-Ref |
| read the metadata from source/cache for $id (internal use only - called by p_get_metadata & p_set_metadata) param: string $id absolute wiki page id param: bool $cache whether or not to cache metadata in memory return: array metadata author: Christopher Smith <chris@jalakai.co.uk> |
| p_save_metadata($id, $meta) X-Ref |
| This is the backend function to save a metadata array to a file param: string $id absolute wiki page id param: array $meta metadata return: bool success / fail |
| p_render_metadata($id, $orig) X-Ref |
| renders the metadata of a page param: string $id page id param: array $orig the original metadata return: array|null array('current'=> array,'persistent'=> array); author: Esther Brunner <esther@kaffeehaus.ch> |
| p_get_parsermodes() X-Ref |
| returns all available parser syntax modes in correct order return: array[] with for each plugin the array('sort' => sortnumber, 'mode' => mode string, 'obj' => plugin object) author: Andreas Gohr <andi@splitbrain.org> |
| p_sort_modes($a, $b) X-Ref |
| Callback function for usort param: array $a param: array $b return: int $a is lower/equal/higher than $b author: Andreas Gohr <andi@splitbrain.org> |
| p_render($mode, $instructions, &$info, $date_at = '') X-Ref |
| Renders a list of instruction to the specified output mode In the $info array is information from the renderer returned param: string $mode param: array|null|false $instructions param: array $info returns render info like enabled toc and cache param: string $date_at return: null|string rendered output author: Andreas Gohr <andi@splitbrain.org> author: Harry Fuecks <hfuecks@gmail.com> |
| p_get_renderer($mode) X-Ref |
| Figure out the correct renderer class to use for $mode, instantiate and return it param: string $mode Mode of the renderer to get return: null|Doku_Renderer The renderer author: Christopher Smith <chris@jalakai.co.uk> |
| p_get_first_heading($id, $render = METADATA_RENDER_USING_SIMPLE_CACHE) X-Ref |
| Gets the first heading from a file param: string $id dokuwiki page id param: int $render rerender if first heading not known return: string|null The first heading author: Andreas Gohr <andi@splitbrain.org> author: Michael Hamann <michael@content-space.de> |
| p_xhtml_cached_geshi($code, $language, $wrapper = 'pre', array $options = null) X-Ref |
| Wrapper for GeSHi Code Highlighter, provides caching of its output param: string $code source code to be highlighted param: string $language language to provide highlighting param: string $wrapper html element to wrap the returned highlighted text return: string xhtml code author: Christopher Smith <chris@jalakai.co.uk> author: Andreas Gohr <andi@splitbrain.org> |