Pluf_Text_Wiki_Renderer Class Reference

List of all members.

Public Member Functions
	__construct ($config=null)
	render ($text)
	getConfig ()
	getInlineParser ()
	getErrors ()
	getVersion ()
	_closeBloc ()
	_openBloc ()
Public Attributes
	$params = array()
	$inlineParser = null
	$errors
	$config = null
Private Attributes
	$_newtext
	$_isBlocOpen = false
	$_currentBloc
	$_blocList = array()

---

Detailed Description

Rendering engine.

Main class to convert a wiki text into XHTML.

Usage: $ctr = Pluf::factory('Pluf_Text_Wiki_Renderer'); $xhtml_text = $ctr->render($wiki_text);

---

Constructor & Destructor Documentation

Pluf_Text_Wiki_Renderer::__construct

(

$

config = null

)

Constructor of the renderer.

Create the needed objects for the rendering.

Parameters:

Configuration

Custom configuration object (null)

---

Member Function Documentation

Pluf_Text_Wiki_Renderer::render

(

$

text

)

Main method to convert the wiki text into XHTML.

Parameters:

string

Text to be converted.

Returns:

string Converted text into XHTML.

Pluf_Text_Wiki_Renderer::getConfig

(

)

Returns configuration object.

Returns:

WikiRendererConfig

Pluf_Text_Wiki_Renderer::getInlineParser

(

)

Retourne l'objet inlineParser (WikiInlineParser) utilisé dans le moteur public

See also:

WikiInlineParser

Returns:

WikiInlineParser

Pluf_Text_Wiki_Renderer::getErrors

(

)

renvoi la liste des erreurs detectées par le moteur public

Returns:

array

Pluf_Text_Wiki_Renderer::getVersion

(

)

renvoi la version de wikirenderer public

Returns:

string version

Pluf_Text_Wiki_Renderer::_closeBloc

(

)

ferme un bloc private

Pluf_Text_Wiki_Renderer::_openBloc

(

)

ouvre un bloc et le referme eventuellement suivant sa nature

Returns:

boolean indique si le bloc reste ouvert ou pas private

---

Member Data Documentation

Pluf_Text_Wiki_Renderer::$_newtext [private]

HTML version of analysed text.

Pluf_Text_Wiki_Renderer::$_isBlocOpen = false [private]

Pluf_Text_Wiki_Renderer::$_currentBloc [private]

Current opened block element.

Pluf_Text_Wiki_Renderer::$_blocList = array() [private]

List of available blocks.

Pluf_Text_Wiki_Renderer::$params = array()

List of parameters for the engine.

Pluf_Text_Wiki_Renderer::$inlineParser = null

Inline parser for the Wiki Inline tags.

Pluf_Text_Wiki_Renderer::$errors

List of lines with wiki errors.

Pluf_Text_Wiki_Renderer::$config = null

Config object to customized the renderer.

---

The documentation for this class was generated from the following file:

• pluf/src/Pluf/Text/Wiki/Renderer.php