Docs For Class Text_Wiki

Class: Text_Wiki_Default

Class Overview

Text_Wiki
   |
   --Text_Wiki_Default

This is the parser for the Default ruleset. For now, this simply extends Text_Wiki.

Author(s):

Justin Patrin <justinpatrin at php.net>

Version:

Release: @package_version@

Inherited Variables

Class: Text_Wiki

Text_Wiki::$delim
Text_Wiki::$disable
Text_Wiki::$formatConf
Text_Wiki::$parseConf
Text_Wiki::$renderConf
Text_Wiki::$rules

Inherited Methods

Class: Text_Wiki

Text_Wiki::Text_Wiki(): Constructor.
Text_Wiki::addPath(): Add a path to a path array.
Text_Wiki::addToken(): Add a token to the Text_Wiki tokens array, and return a delimited token number.
Text_Wiki::changeRule(): Change from one rule to another in-place.
Text_Wiki::deleteRule(): Delete (remove or unset) a rule from the $rules property.
Text_Wiki::disableRule(): Disables a rule so that it is not applied when parsing.
Text_Wiki::enableRule(): Enables a rule so that it is applied when parsing.
Text_Wiki::error(): Simple error-object generator.
Text_Wiki::factory(): Returns a Text_Wiki Parser class for the specified parser.
Text_Wiki::findFile(): Searches a series of paths for a given file.
Text_Wiki::getFormatConf(): Get configuration for a specific format and key.
Text_Wiki::getParseConf(): Get parser configuration for a specific rule and key.
Text_Wiki::getPath(): Get the current path array for a path-type.
Text_Wiki::getRenderConf(): Get renderer configuration for a specific format, rule, and key.
Text_Wiki::getSource(): Returns the parsed source text with delimited token placeholders.
Text_Wiki::getTokens(): Returns tokens that have been parsed out of the source text.
Text_Wiki::insertRule(): Inserts a rule into to the rule set.
Text_Wiki::isError(): Simple error checker.
Text_Wiki::loadFormatObj(): Load a format-render class file.
Text_Wiki::loadParseObj(): Load a rule parser class file.
Text_Wiki::loadRenderObj(): Load a rule-render class file.
Text_Wiki::parse(): Sets the $_source text property, then parses it in place and retains tokens in the $_tokens array property.
Text_Wiki::render(): Renders tokens back into the source text, based on the requested format.
Text_Wiki::setFormatConf(): Set format configuration for a specific rule and key.
Text_Wiki::setParseConf(): Set parser configuration for a specific rule and key.
Text_Wiki::setRenderConf(): Set renderer configuration for a specific format, rule, and key.
Text_Wiki::setToken(): Set or re-set a token with specific information, overwriting any previous rule name and rule options.
Text_Wiki::singleton(): Singleton.
Text_Wiki::transform(): Parses and renders the text passed to it, and returns the results.

Class Details

[line 26]
This is the parser for the Default ruleset. For now, this simply extends Text_Wiki.

Author: Justin Patrin <justinpatrin@php.net>
Version: Release: @package_version@