Packageindex Classtrees Modulegroups Elementlist Report XML Files

File: c:/www/apache/doc2//core/PhpdocArgvHandler.php
PHPDOC 2000/12/03 - PHPDoc

PhpdocArgvHandler

PhpdocObject
   |
  +-- PhpdocArgvHandler

Handles command line arguments.

 

private class PhpdocArgvHandler extends PhpdocObject

Handles command line arguments.
Be careful the source has not been tested yet, it's probably very buggy.Any help and comments are welcome...

AuthorsUlf Wendel <ulf.wendel@phpdoc.de>
Version$Id: $

 
Direct known subclasses: PhpdocSetupHandler

Methods inherited from PhpdocObject

setflagoutput, out, nametourl, outl, introspection

Private Method Summary

void

handleArgv()

Handle the command line values
string

getArgvHelpMessage()

Returns the current help message of phpdoc

Fields inherited from PhpdocObject

$err, $application, $warn, $flag_output

Private Field Summary

array

$COMMANDS

Message explaining the usage of phpdoc on the command line.

Private Method Details

handleArgv

private void handleArgv( )

  Handle the command line values
handleArgv() looks for command line values andinterprets them. If there're unknown command it printsa message and calls die()

Returns void


getArgvHelpMessage

private string getArgvHelpMessage( )

  Returns the current help message of phpdoc
The message is not HTML formated, it could be shownon the command line.

Returns string $help_msg

Some instructions on available command line options

See Also handleArgv(), $COMMANDS

Private Field Details

$COMMANDS

private array $COMMANDS

>>array( "-f filename [, filename]" => "name of files to parse", "-d directory" => "name of a directory to parse", "-p path" => "path of the files", "-t target" => "path where to save the generated files, default is the current path", "-h" => "show this help message" )<<

Message explaining the usage of phpdoc on the command line.
Actually it's not the message itself but an array containingthe instructions. The array is indexed by the command line option e.g. "-h".The array values hold a short message describing the usage of the option.



Packageindex Classtrees Modulegroups Elementlist Report XML Files
PHPDoc 1.0beta