PHPDOC 2000/12/03 - PHPDoc

PhpdocObject

Common base class of all phpdoc classes

private class PhpdocObject

Common base class of all phpdoc classes
As a kind of common base class PhpdocObject holdsconfiguration values (e.g. error handling) and debuggingmethods (e.g. introspection()). It does not have a constructor,so you can always inheritig Phpdoc classes from thisclass without any trouble.

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

Version $Id: $

Direct known subclasses: PhpdocAccessor, PhpdocAnalyser, PhpdocArgvHandler, PhpdocFileHandler, PhpdocIndexer, PhpdocParserRegExp, PhpdocRendererObject, PhpdocHTMLRendererManager, PhpdocWarning, PhpdocXMLExporter, PhpdocXMLReader, PhpdocXMLWriter

Public Method Summary
void	setFlagOutput(boolean $flagOutput) Sets the output flag - if set to true out() and outl() print messages
void	introspection([ string $title, mixed $data, boolean $userfunction ]) Dumps objects and arrays.

Private Method Summary
void	out(string $message) Print a string and flushes the output buffer
string	nameToUrl(string $name) Encodes an element name so that it can be used as a file name.
void	outl(string $message) Print a string, the specified HTML line break sign and flushes the output buffer

Public Field Summary
array	$err Variable containing the latest exceptions.

Private Field Summary
string	$application Default applicationname for the generated HTML files.
array	$warn Use to save warnings.
boolean	$flag_output Flag determining wheter to print some status messages or not (default: false)

Public Method Details

setFlagOutput

public void setFlagOutput( boolean $flagOutput )

Sets the output flag - if set to true out() and outl() print messages

Parameter

boolean	$flagOutput

Returns

void

Since 0.3

introspection

public void introspection( [ string $title, mixed $data, boolean $userfunction ] )

Dumps objects and arrays.
Use this function to get an idea of the internal datastructures used.The function dumps arrays and objects. It renders the content inan HTML table. Play with it, you'll see it's very helpfulfor debugging.

Parameter

string	$title	`= >>""<<`
	Optional title used in the HTML Table

mixed	$data	`= >>""<<`
	Optional array or object that you want to dump. Fallback to $this.

boolean	$userfunction	`= >>true<<`
	Optional flag. If set to false userfunction in an object are not shown (default). If set to true, userfunctions are rendered

Returns

void

Version 0.2

Private Method Details

out

private void out( string $message )

Print a string and flushes the output buffer

Parameter

string	$message

Returns

void

nameToUrl

private string nameToUrl( string $name )

Encodes an element name so that it can be used as a file name.

Parameter

string	$name
	name

Returns

string

url name

outl

private void outl( string $message )

Print a string, the specified HTML line break sign and flushes the output buffer

Parameter

string	$message

Returns

void

Public Field Details
$err
public array $err >>`array()`<< Variable containing the latest exceptions. The way PHPDoc handles errors is a little different from theofficial PEAR way. PHPDoc methods do not returnerror objects but save them to the class variable $err and tryto return a value that indicates that an error occured.

Private Field Details
$application
private string $application >>`"PHPDoc"`<< Default applicationname for the generated HTML files.

$warn
private array $warn >><< Use to save warnings.

$flag_output
private boolean $flag_output >>`false`<< Flag determining wheter to print some status messages or not (default: false)
Since	0.3
See Also	setFlagOutput()