RunCommand

Extends \phpDocumentor\Command\Command

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.

package

Default

Methods

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

configure() : void

Executes the business logic involved with this command.

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

Arguments

$input

\Symfony\Component\Console\Input\InputInterface

$output

\Symfony\Component\Console\Output\OutputInterface

Response

integer

Returns the Progress bar helper.

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

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

Arguments

$input

\Symfony\Component\Console\Input\InputInterface

Response

\Symfony\Component\Console\Helper\ProgressHelper

Registers the current command.

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

Arguments

$helperSet

\Symfony\Component\Console\Helper\HelperSet