|
|
|
File: c:/www/apache/doc2//core/PhpdocSetupHandler.php
PHPDOC 2000/12/03 - 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 thecurrent setup.
|
| |
|
Direct known subclasses: Phpdoc
|
|
|
|
|
|
|
|
|
|
Fields inherited from PhpdocArgvHandler |
| $commands |
|
|
|
Private Field Summary |
| string |
$targetName of the target directory. |
| string |
$applicationName of the application parsed |
| string |
$basedirBasedir for all file operations |
| string |
$targetFileSuffixSuffix for all rendered files in the application (except for the xml files). |
| array |
$sourceFileSuffixSuffix of all source code files in the application |
| string |
$sourceDirectoryDirectory with the php sources to parse. |
|
Public Method Details |
setSourceDirectory |
|
public void setSourceDirectory( string $sourcedir )
|
| |
Sets the name of the directory with the source to scan.
|
| Parameter |
|
|
| Returns |
void |
|
setTemplateDirectory |
|
public void setTemplateDirectory( string $sourcedir )
|
| |
Sets the name of the directory with the templates.
|
| Parameter |
|
|
| 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 |
|
|
| 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 |
$targetFileSuffix |
| 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 asphp source code files and parsed. If you used othersuffixes such as ".inc" you have to tell phpdoc to parsethem.
|
| Parameter |
|
| mixed |
$suffix |
|
|
string with one suffix or array of suffixes |
|
| Returns |
bool $ok |
| Throws |
PhpdocError |
| See Also |
$sourceFileSuffix |
|
checkStatus |
|
private array checkStatus( [ mixed $errors ] )
|
| |
Checks the current status of the object. Are all necessary informations to start parsing available?
|
| Parameter |
|
|
| Returns |
array $errors |
|
getCheckedDirname |
|
private string getCheckedDirname( string $dirname )
|
| |
Adds a slash at the end of the given filename if neccessary.
|
| Parameter |
|
|
| Returns |
string Directoryname |
|
|
Private Field Details |
$target |
|
private string $target
>>""<<
Name of the target directory.
|
|
$application |
|
private string $application
>>"PHPDoc"<<
Name of the application parsed
|
| See Also |
setApplication() |
|
$basedir |
|
private string $basedir
>>""<<
Basedir for all file operations
|
| See Also |
setApplication() |
|
$targetFileSuffix |
|
private string $targetFileSuffix
>>".html"<<
Suffix for all rendered files in the application (except for the xml files).
|
| See Also |
setTargetFileSuffix() |
|
$sourceFileSuffix |
|
private array $sourceFileSuffix
>>array ( "php" )<<
Suffix of all source code files in the application
If you used other file suffixes than ".php" in you have to override this.variable using setSourceFileSuffix()
|
| See Also |
setSourceFileSuffix() |
|
$sourceDirectory |
|
private string $sourceDirectory
>>""<<
Directory with the php sources to parse.
|
| See Also |
setSourceDirectory() |
|
|
|
|
|
| PHPDoc 1.0beta |