[ Index ]

PHP Cross Reference of DokuWiki

title

Body

[close]

/inc/ -> parserutils.php (summary)

Utilities for accessing the parser

Author: Harry Fuecks
Author: Andreas Gohr
License: GPL 2 (http://www.gnu.org/licenses/gpl.html)
File Size: 673 lines (20 kb)
Included or required: 8 times
Referenced: 0 times
Includes or requires: 7 files
 inc/pageutils.php
 inc/pluginutils.php
 inc/confutils.php
 inc/parser/parser.php
 inc/cache.php
 inc/geshi.php
 inc/parser/metadata.php

Defines 17 functions

  p_wiki_xhtml()
  p_wiki_xhtml_summary()
  p_locale_xhtml()
  p_cached_xhtml()
  p_cached_output()
  p_cached_instructions()
  p_get_instructions()
  p_get_metadata()
  p_set_metadata()
  p_purge_metadata()
  p_read_metadata()
  p_render_metadata()
  p_get_parsermodes()
  p_sort_modes()
  p_render()
  p_get_first_heading()
  p_xhtml_cached_geshi()

Functions
Functions that are not part of a class:

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=false, $render=false)   X-Ref
returns the metadata of a page

author: Esther Brunner <esther@kaffeehaus.ch>

p_set_metadata($id, $data, $render=false, $persistent=true)   X-Ref
sets metadata elements of a page

author: Esther Brunner <esther@kaffeehaus.ch>

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)

this function also converts the metadata from the original format to
the current format ('current' & 'persistent' arrays)

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_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 are informations from the renderer returned

author: Harry Fuecks <hfuecks@gmail.com>
author: Andreas Gohr <andi@splitbrain.org>

p_get_first_heading($id, $render=true)   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: Tue Dec 2 01:30:01 2008 Cross-referenced by PHPXref 0.7