| [ 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: | 777 lines (26 kb) |
| Included or required: | 2 times |
| Referenced: | 0 times |
| Includes or requires: | 2 files inc/parser/parser.php inc/parser/metadata.php |
| p_wiki_xhtml($id, $rev='', $excuse=true) 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 author: Andreas Gohr <andi@splitbrain.org> |
| p_wiki_xhtml_summary($id, &$title, $rev='', $excuse=true) X-Ref |
| Returns starting summary for a page (e.g. the first few paragraphs), marked up in XHTML. If $excuse is true an explanation is returned if the file wasn't found author: Harry Fuecks <hfuecks@gmail.com> param: string wiki page id param: reference populated with page title from heading or page id |
| p_locale_xhtml($id) X-Ref |
| Returns the specified local text in parsed format author: Andreas Gohr <andi@splitbrain.org> |
| p_cached_xhtml($file) X-Ref |
| *** DEPRECATED *** use p_cached_output() Returns the given file parsed to XHTML Uses and creates a cachefile 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 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 author: Andreas Gohr <andi@splitbrain.org> |
| p_get_instructions($text) X-Ref |
| turns a page into a list of instructions 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 author: Esther Brunner <esther@kaffeehaus.ch> author: Michael Hamann <michael@content-space.de> 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) - separate hierarchies by " " like "date created" param: int $render If the page should be rendererd - possible values: return: mixed The requested metadata fields |
| p_set_metadata($id, $data, $render=false, $persistent=true) X-Ref |
| sets metadata elements of a page author: Esther Brunner <esther@kaffeehaus.ch> author: Michael Hamann <michael@content-space.de> 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 see: http://www.dokuwiki.org/devel:metadata#functions_to_get_and_set_metadata return: boolean true on success |
| p_purge_metadata($id) X-Ref |
| Purges the non-persistant part of the meta data used on page deletion 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) author: Christopher Smith <chris@jalakai.co.uk> param: string $id absolute wiki page id param: bool $cache whether or not to cache metadata in memory return: array metadata |
| 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 author: Esther Brunner <esther@kaffeehaus.ch> |
| p_get_parsermodes() X-Ref |
| returns all available parser syntax modes in correct order author: Andreas Gohr <andi@splitbrain.org> |
| p_sort_modes($a, $b) X-Ref |
| Callback function for usort author: Andreas Gohr <andi@splitbrain.org> |
| p_render($mode,$instructions,&$info) X-Ref |
| Renders a list of instruction to the specified output mode In the $info array is information from the renderer returned author: Harry Fuecks <hfuecks@gmail.com> author: Andreas Gohr <andi@splitbrain.org> |
| p_get_first_heading($id, $render=METADATA_RENDER_USING_SIMPLE_CACHE) X-Ref |
| No description |
| p_xhtml_cached_geshi($code, $language, $wrapper='pre') X-Ref |
| Wrapper for GeSHi Code Highlighter, provides caching of its output author: Christopher Smith <chris@jalakai.co.uk> author: Andreas Gohr <andi@splitbrain.org> 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 |
| Generated: Wed May 23 03:00:10 2012 | Cross-referenced by PHPXref 0.7 |