Packageindex Classtrees Modulegroups Elementlist Report XML Files

File: /home/cch/www/pear/PHPDoc/core/PhpdocObject.php
PEAR Repository - PHPDoc

PhpdocObject

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 holds
configuration values (e.g. error handling) and debugging
methods (e.g. introspection()). It does not have a constructor,
so you can always inheritig Phpdoc classes from this
class without any trouble.

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

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

Public Method Summary

void

setFlagOutput(bool $flagOutput)

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

introspection([ string $title, string $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 exception object

Private Field Summary

boolean

$flag_output

Flag determining wheter to print some status messages or not (default: false)
string

$application

unknown

$warn

Public Method Details

setFlagOutput

public void setFlagOutput( bool $flagOutput )

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

Parameter
bool $flagOutput
Returns void

Since 0.3
See Also f::f, out(), outl()

introspection

public void introspection( [ string $title, string $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 in
an HTML table. Play with it, you'll see it's very helpful
for debugging.

Parameter
string $title = >>""<<
Optional title used in the HTML Table
string $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
element 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()<<


Private Field Details

$flag_output

private boolean $flag_output

>>false<<

Since 0.3
See Also setFlagOutput()

$application

private string $application

>>"PHPDoc"<<


$warn

private unknown $warn

>>unknown<<



Packageindex Classtrees Modulegroups Elementlist Report XML Files
PHPDoc 1.0beta