Packageindex Classtrees Modulegroups Elementlist Report XML Files

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

PhpdocSetupHandler

PhpdocObject
   |
  +-- PhpdocArgvHandler
     |
    +-- PhpdocSetupHandler

Handles the "setup".

 

private class PhpdocSetupHandler extends PhpdocArgvHandler

Handles the "setup".

This class provides all methods neccessary to "setup" Phpdoc and check the
current setup.

AuthorsUlf Wendel <ulf@redsys.de>
Version0.2alpha

 
Direct known subclasses: Phpdoc

Methods inherited from PhpdocArgvHandler

handleargv, getargvhelpmessage

Methods inherited from PhpdocObject

setflagoutput, out, nametourl, outl, introspection

Public Method Summary

void

setSourceDirectory( $sourcedir)

Sets the name of the directory with the source to scan.
void

setTemplateDirectory( $sourcedir)

Sets the name of the directory with the templates.
bool

setApplication(string $application)

Sets the name of your application.
bool

setTarget(string $target)

Sets the target where the generated files are saved.

Private Method Summary

bool

setTargetFileSuffix(string $suffix)

Suffix for all rendered files in the application (not for the xml files)
bool

setSourceFileSuffix(mixed $suffix)

Suffix of all source code files in the application
array

checkStatus([ string $errors ])

Checks the current status of the object. Are all necessary informations
string

getCheckedDirname(string $dirname)

Adds a slash at the end of the given filename if neccessary.

Fields inherited from PhpdocArgvHandler

$commands

Fields inherited from PhpdocObject

$err, $flag_output, $warn

Private Field Summary

string

$target

Name of the target directory.
string

$application

Name of the application parsed
string

$basedir

Basedir for all file operations
string

$targetFileSuffix

Suffix for all rendered files in the application (not for the xml files)
array

$sourceFileSuffix

Suffix of all source code files in the application
string

$sourceDirectory

Directory with the php sources to parse.

Public Method Details

setSourceDirectory

public void setSourceDirectory( $sourcedir )

  Sets the name of the directory with the source to scan.

Parameter
$sourcedir
Returns void


setTemplateDirectory

public void setTemplateDirectory( $sourcedir )

  Sets the name of the directory with the templates.

Parameter
$sourcedir
Returns void


setApplication

public bool setApplication( string $application )

  Sets the name of your application.

The application name gets used on many places in the default templates.

Parameter
string $application
name of the application
Returns bool $ok

Throws PhpdocError

setTarget

public bool setTarget( string $target )

  Sets the target where the generated files are saved.

Parameter
string $target
Returns bool $ok

Throws PhpdocError

Private Method Details

setTargetFileSuffix

private bool setTargetFileSuffix( string $suffix )

  Suffix for all rendered files in the application (not for the xml files)
By default the the suffix is set to ".html".

Parameter
string $suffix
string with the suffix
Returns bool $ok

See Also t::t
Author(s) Thomas Weinert <subjective@subjective.de>

setSourceFileSuffix

private bool setSourceFileSuffix( mixed $suffix )

  Suffix of all source code files in the application
By default only files with the suffix ".php" are recognized as
php source code files and parsed. If you used other
suffixes such as ".inc" you have to tell phpdoc to parse
them.

Parameter
mixed $suffix
string with one suffix or array of suffixes
Returns bool $ok

Throws PhpdocError
See Also s::s

checkStatus

private array checkStatus( [ string $errors ] )

  Checks the current status of the object. Are all necessary informations
to start parsing available?

Parameter
string $errors = >>""<<
Returns array $errors


getCheckedDirname

private string getCheckedDirname( string $dirname )

  Adds a slash at the end of the given filename if neccessary.

Parameter
string $dirname
Directoryname
Returns string

Directoryname


Private Field Details

$target

private string $target

>>""<<


$application

private string $application

>>"PHPDoc"<<

See Also setApplication()

$basedir

private string $basedir

>>""<<

See Also setApplication(), setBasedir()

$targetFileSuffix

private string $targetFileSuffix

>>".html"<<

See Also setTargetFileSuffix()

$sourceFileSuffix

private array $sourceFileSuffix

>>array ( "php" )<<

See Also setSourceFileSuffix()

$sourceDirectory

private string $sourceDirectory

>>""<<

See Also setSourceDir()


Packageindex Classtrees Modulegroups Elementlist Report XML Files
PHPDoc 1.0beta