DocumentElement Klassenreferenz

Klassendiagramm für DocumentElement:

Aufstellung aller Elemente

Öffentliche Methoden
	parse ($text, $type='wiki')
	render ($mimeType)
Öffentliche Attribute
	$linkedObjectIds = array()
	$footnotes = array()
	$encodeHtml = false

---

Ausführliche Beschreibung

Definiert in Zeile 13 der Datei DocumentElement.class.php.

---

Dokumentation der Elementfunktionen

DocumentElement::parse	(	$	text,
		$	type = 'wiki'
	)

Ein Text wird geparst.

Zerlegt den Text zeilenweise und erzeugt die Unterobjekte.

Parameter:

	Ein-	oder mehrzeiliger roher Text
	Art	des Parsens, Default=Wiki

Definiert in Zeile 34 der Datei DocumentElement.class.php.

     {
          $parserClass = ucfirst(strtolower($type)).'Parser';
          $parser = new $parserClass();
          
          $this->children = $parser->parse( $text );
          $this->linkedObjectIds = $parser->linkedObjectIds;
     }

DocumentElement::render

(

$

mimeType

)

Rendering des Dokumentes.
Die Art und Weise des Renderns ist in Abh�ngigkeit zum �bergebenen Mime-Type.

Parameter:

String

$mimeType Mime-Type, z.B. "text/html"

Rückgabe:

String

Definiert in Zeile 55 der Datei DocumentElement.class.php.

Benutzt encodeHtml().

     {
          
          switch( $mimeType )
          {
               case 'text/html':
                    $this->type = 'html';
                    break;
               case 'text/plain':
                    $this->type = 'text';
                    break;
               case 'application/pdf':
                    $this->type = 'pdf';
                    break;
               case 'application/html-dom':
                    $this->type = 'htmlDom';
                    break;
               case 'application/x-latex':
                    $this->type = 'latex';
                    break;
               case 'text/xhtml':
                    $this->type = 'xhtml';
                    break;
               case 'application/docbook+xml':
                    $this->type = 'docBook';
                    break;
               default:
                    $this->type = 'html';
          }
          
          $rendererClass = ucfirst($this->type).'Renderer';
          
          $renderer = new $rendererClass();
          $renderer->children        = $this->children;
          $renderer->linkedObjectIds = $this->linkedObjectIds;
          $renderer->encodeHtml      = $this->encodeHtml;
               
          return $renderer->render();
     }

---

Dokumentation der Datenelemente

DocumentElement::$encodeHtml = false

Definiert in Zeile 24 der Datei DocumentElement.class.php.

DocumentElement::$footnotes = array()

Definiert in Zeile 22 der Datei DocumentElement.class.php.

DocumentElement::$linkedObjectIds = array()

Definiert in Zeile 15 der Datei DocumentElement.class.php.

---

Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei:

• textClasses/DocumentElement.class.php