PHPDOC 2000/12/03 - PHPDoc

PhpdocHTMLRenderer

PhpdocObject
   |
  +-- PhpdocRendererObject
     |
    +-- PhpdocHTMLRenderer

Default HTML Renderer based on templates.

private class PhpdocHTMLRenderer extends PhpdocRendererObject

Default HTML Renderer based on templates.

Authors Ulf Wendel <ulf.wendel@phpdoc.de>

Version $Id: $

Direct known subclasses: PhpdocHTMLDocumentRenderer, PhpdocHTMLIndexRenderer, PhpdocHTMLWarningRenderer

Methods inherited from PhpdocObject

setflagoutput, out, nametourl, outl, introspection

Private Method Summary
void	setPath(string $path) Sets a directory path prefix.
void	setTemplateRoot(string $templateRoot) Sets the template directory.
string	encode(string $string) Encodes the given string.

Fields inherited from PhpdocRendererObject

$file_extension, $warn

Fields inherited from PhpdocObject

$err, $application, $warn, $flag_output

Private Field Summary
object IntegratedTemplates	$tpl Template object
object PhpdocAccessor	$accessor XML data accessor object.
string	$templateRoot Rootpath for Templatefiles.
string	$path Directory path prefix.

Private Method Details

setPath

private void setPath( string $path )

Sets a directory path prefix.

Parameter

string	$path

Returns

void

setTemplateRoot

private void setTemplateRoot( string $templateRoot )

Sets the template directory.

Parameter

string	$templateRoot

Returns

void

encode

private string encode( string $string )

Encodes the given string.
This function gets used to encode all userdependendelements of the phpdoc xml files. Use it tocustomize your rendering result: beware newlines (nl2br()),strip tags etc.

Parameter

string	$string
	to encode

Returns

string $string

Encoded string

Private Field Details
$tpl
private object IntegratedTemplates $tpl >><< Template object

$accessor
private object PhpdocAccessor $accessor >><< XML data accessor object.

$templateRoot
private string $templateRoot >>`""`<< Rootpath for Templatefiles.
See Also	setTemplateRoot()

$path
private string $path >>`""`<< Directory path prefix.