Packageindex Classtrees Modulegroups Elementlist Report XML Files

File: /home/cch/www/pear/PHPDoc/renderer/html/PhpdocHTMLRenderer.php
PEAR Repository - PHPDoc

PhpdocHTMLRenderer

PhpdocObject
   |
  +-- PhpdocRendererObject
     |
    +-- PhpdocHTMLRenderer

Default HTML Renderer based on templates.

 

private class PhpdocHTMLRenderer extends PhpdocRendererObject

Default HTML Renderer based on templates.

AuthorsUlf Wendel <ulf.wendel@phpdoc.de>
Version1.0beta

 
Direct known subclasses: PhpdocHTMLDocumentRenderer, PhpdocHTMLIndexRenderer, PhpdocHTMLWarningRenderer

Methods inherited from PhpdocObject

setflagoutput, out, nametourl, outl, introspection

Private Method Summary

void

setPath( $path)

Sets a directory path prefix.
void

setTemplateRoot( $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, $flag_output, $application, $warn

Private Field Summary

unknown

$tpl

Template object
unknown

$accessor

XML data accessor object.
string

$templateRoot

Rootpath for Templatefiles.
string

$path

Directory path prefix.

Private Method Details

setPath

private void setPath( $path )

  Sets a directory path prefix.

Parameter
$path
Returns void


setTemplateRoot

private void setTemplateRoot( $templateRoot )

  Sets the template directory.

Parameter
$templateRoot
Returns void


encode

private string encode( string $string )

  Encodes the given string.

This function gets used to encode all userdependend
elements of the phpdoc xml files. Use it to
customize your rendering result: beware newlines (nl2br()),
strip tags etc.

Parameter
string $string
String to encode
Returns string $string

Encoded string


Private Field Details

$tpl

private unknown $tpl

>>unknown<<


$accessor

private unknown $accessor

>>unknown<<


$templateRoot

private string $templateRoot

>>""<<

See Also setTemplateRoot()

$path

private string $path

>>""<<



Packageindex Classtrees Modulegroups Elementlist Report XML Files
PHPDoc 1.0beta