\phpDocumentor\Command\ProjectRunCommand

Parse and transform the given directory (-d|-f) to the given location (-t).

phpDocumentor creates documentation from PHP source files. The simplest way to use it is:

$ phpdoc run -d <directory to parse> -t <output directory>

This will parse every file ending with .php, .php3 and .phtml in <directory to parse> and then output a HTML site containing easily readable documentation in .

phpDocumentor will try to look for a phpdoc.dist.xml or phpdoc.xml file in your current working directory and use that to override the default settings if present. In the configuration file can you specify the same settings (and more) as the command line provides.

Summary

Methods
Properties
Constants
setHelperSet()
No public properties found
No constants found
getProgressBar()
configure()
execute()
No protected properties found
N/A
No private methods found
No private properties found
N/A

Methods

setHelperSet()

setHelperSet(\Symfony\Component\Console\Helper\HelperSet  $helperSet) 

Registers the current command.

Parameters

\Symfony\Component\Console\Helper\HelperSet $helperSet

getProgressBar()

getProgressBar(\Symfony\Component\Console\Input\InputInterface  $input) : \Symfony\Component\Console\Helper\ProgressHelper

Returns the Progress bar helper.

With this helper it is possible to display a progress bar and make it fill.

Parameters

\Symfony\Component\Console\Input\InputInterface $input

Returns

\Symfony\Component\Console\Helper\ProgressHelper

configure()

configure() : void

Initializes this command and sets the name, description, options and arguments.

execute()

execute(\Symfony\Component\Console\Input\InputInterface  $input, \Symfony\Component\Console\Output\OutputInterface  $output) : integer

Executes the business logic involved with this command.

Parameters

\Symfony\Component\Console\Input\InputInterface $input
\Symfony\Component\Console\Output\OutputInterface $output

Returns

integer