|
|
|
File: c:/www/apache/doc2//renderer/html/PhpdocHTMLClassRenderer.php
PHPDOC 2000/12/03 - PHPDoc
PhpdocHTMLClassRenderer
PhpdocObject
|
+-- PhpdocRendererObject
|
+-- PhpdocHTMLRenderer
|
+-- PhpdocHTMLDocumentRenderer
|
+-- PhpdocHTMLClassRenderer
Renders classes.
|
Renders classes.
|
| |
|
Methods inherited from PhpdocHTMLDocumentRenderer |
| renderconstants, renderconstantsummary, renderconstantdetail, renderuses, renderusesdetail, renderusessummary, renderfunctions, renderfunctionsummary, renderfunctiondetail, renderparameterdetail, getparameter, rendersee, renderauthors, renderlinks, renderthrows, renderglobals, rendercommondocfields |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Private Field Summary |
| array |
$indentInternal array of " " strings to format HTML output. |
| array |
$variablesArray of variables found in the xml document. |
|
Public Method Details |
PhpdocHTMLClassRenderer |
|
public void PhpdocHTMLClassRenderer( string $path, string $templateRoot, string $application, [ string $extension ] )
|
| |
Sets the xml and template root directory.
|
| Parameter |
|
|
|
| string |
$templateRoot |
|
|
file path |
|
|
| string |
$application |
|
|
of the current application |
|
|
| string |
$extension |
= >>".html"<< |
|
extension |
|
| Returns |
void |
|
renderClass |
|
public void renderClass( string $xmlfile, [ string $htmlfile ] )
|
| |
Renders a class.
|
| Parameter |
|
| string |
$xmlfile |
|
|
source file |
|
|
| string |
$htmlfile |
= >>""<< |
|
of the HTML target file. |
|
| Returns |
void |
|
|
Private Method Details |
renderInherited |
|
private void renderInherited( )
|
| |
Renders a list of inherited elements.
|
| Returns |
void |
| See Also |
renderInheritedElements() |
|
renderInheritedElements |
|
private void renderInheritedElements( array $inherited, string $block, string $type )
|
| |
Renders a list of a certain inherited element.
|
| Parameter |
|
| array |
$inherited |
|
|
of inherited elements. |
|
|
|
|
| string |
$type |
|
|
type: function, variable... |
|
| Returns |
void |
| See Also |
renderInherited() |
|
renderSubclasses |
|
private void renderSubclasses( )
|
| |
Renders a list of direct known subclasses.
|
| Returns |
void |
|
renderVariables |
|
private void renderVariables( )
|
| |
Adds a summary and a detailed list of all variables to the template.
|
| Returns |
void |
| See Also |
renderVariableSummary(), renderVariableDetail() |
|
renderVariableSummary |
|
private void renderVariableSummary( )
|
| |
Adds a summary of all variables to the template.
The function assumes that there is a block named "variablesummary" andwithin it a block names "variablesummay_loop" in the template.
|
| Returns |
void |
| See Also |
renderVariableDetail() |
|
renderVariableDetail |
|
private void renderVariableDetail( )
|
| |
Adds a detailed list of all variables to the template.
The function assumes that there is a block named "variabledetails"and within it a block names "variablesdetails_loop" in the template.
|
| Returns |
void |
| See Also |
renderVariableSummary() |
|
getClasstree |
|
private string getClasstree( string $class )
|
| |
Returns a html string that shows the class tree.
|
| Parameter |
|
| string |
$class |
|
|
of the current class |
|
| Returns |
string HTML that shows the tree |
|
getIndent |
|
private string getIndent( int $level )
|
| |
Returns a certain number of " "s.
|
| Parameter |
|
| int |
$level |
|
|
of " " required. |
|
| Returns |
string A string with the requested number of nunbreakable html spaces |
| See Also |
$indent |
|
|
Private Field Details |
$indent |
|
private array $indent
>>array()<<
Internal array of " " strings to format HTML output.
|
|
$variables |
|
private array $variables
>>array()<<
Array of variables found in the xml document.
|
|
|
|
|
|
| PHPDoc 1.0beta |